Difference between revisions of "Template:AuthorHeader/Doc"

From ISFDB
Jump to navigation Jump to search
Line 29: Line 29:
 
There are two optional parameters:
 
There are two optional parameters:
  
'''name''' This is the text used for the link display. It defaults to the page name or the altName parameter, if specifeid. If altName is specifed, name should probably be specified as well.
+
'''name''' This is the text used for the link display. It defaults to the page name or the altName parameter, if specified. If altName is specified, name should probably be specified as well.
  
'''altName''' This is the name of the author with underscores instead of spaces. It  need only be used if  the author's name contains special characters which would be transformed by the ANCHORENCODE process (whioh is used by {{tl|A}} to auto-convert spaces to underscores by default, but also converts other non-alphanumeric characters) or in the very rare case where the wiki page has a different name that the suthor page in the db to which a link is desired.
+
'''altName''' This is the name of the author with underscores instead of spaces. It  need only be used if  the author's name contains special characters which would be transformed by the ANCHORENCODE process (which is used by {{tl|A}} to auto-convert spaces to underscores by default, but also converts other non-alphanumeric characters) or in the very rare case where the wiki page has a different name that the author page in the db to which a link is desired.
  
 
==Documentation source==
 
==Documentation source==
 
This is documentation for the template '''[[:Template:AuthorHeader|AuthorHeader]]''', transcluded from [[Template:AuthorHeader/Doc|AuthorHeader/Doc]].
 
This is documentation for the template '''[[:Template:AuthorHeader|AuthorHeader]]''', transcluded from [[Template:AuthorHeader/Doc|AuthorHeader/Doc]].

Revision as of 10:56, 25 June 2009


Purpose

This template is to put a standard header on a page in the Author namespace. The header will contain a link to the database record for the author, using {{A}}.

Usage

Please this template at the top of an author page.

It may be called as:

{{AuthorHeader}}

(which will display the link with the tag taken from the page name) This format should be used in almost every case

or as

{{AuthorHeader|name=<Author Name>}}

(which will display the link with the name specified in the parameter. This might be useful when there are different forms of the author name in use.)

In the very very unusual case that the wiki page has a name that is NOT the name of the auhtor to be linked to in the DB, or when the name includes special characters such as ( or ) or ', call this template as

{{AuthorHeader|altName=<URLname>}}

or as

{{AuthorHeader|altName=<URLname>|name=<name>}}

Parameters

There are two optional parameters:

name This is the text used for the link display. It defaults to the page name or the altName parameter, if specified. If altName is specified, name should probably be specified as well.

altName This is the name of the author with underscores instead of spaces. It need only be used if the author's name contains special characters which would be transformed by the ANCHORENCODE process (which is used by {{A}} to auto-convert spaces to underscores by default, but also converts other non-alphanumeric characters) or in the very rare case where the wiki page has a different name that the author page in the db to which a link is desired.

Documentation source

This is documentation for the template AuthorHeader, transcluded from AuthorHeader/Doc.