Difference between revisions of "Template:AuthorHeader/Doc"

Latest revision as of 10:31, 12 March 2011

Purpose

This template provides a standard header for bibliography & comment pages in the ISFDB (normally found in the "Author:" namespace). It provides a link to the author or artist's summery bibliography in the ISFDB database, using {{A}}.

Usage

Please place this template at the top (first line) of an author page.

It may be called as:

{{AuthorHeader}}

(which will take the author name from the page name, and form the link accordingly). 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 name 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 author 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. It can be used to directly link to the author via <author_id>, in case the author's name contains special characters (which would be transformed by the URLENCODE process used by {{A}} to auto-convert URL encodings, but also converts other non-alphanumeric characters to UTF-8) 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.

Aliases

The following alternate names redirect to this template, and may be used in place of this template.

Documentation source

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

@@ Line 10: / Line 10: @@
 <code><nowiki>{{AuthorHeader}}</nowiki></code>
-(which will display the link with the tag taken from the page name) This format should be used in almost every case
+(which will take the author name from the page name, and form the link accordingly). ''This format should be used in almost every case.''
 or as
@@ Line 16: / Line 16: @@
 <code><nowiki>{{AuthorHeader|name=<Author Name>}}</nowiki></code>
-(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.)
+(which will display the link with the name specified in the '''name''' 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
+In the very very unusual case that the wiki page has a name that is NOT the name of the author to be linked to in the DB, or when the name includes special characters such as ( or ) or ', call this template as
 <code><nowiki>{{AuthorHeader|altName=<URLname>}}</nowiki></code>
@@ Line 31: / Line 31: @@
 '''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 {{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.
+'''altName''' This is the name of the author. It can be used to directly link to the author via <author_id>, in case the author's name contains special characters (which would be transformed by the URLENCODE process used by {{tl|A}} to auto-convert URL encodings, but also converts other non-alphanumeric characters to UTF-8) 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.
+==Aliases==
+The following alternate names redirect to this template, and may be used in place of this template.
+* {{tl|BibHeader}}
+* {{tl|Author Header}}
+* {{tl|BibliographyHeader}}
+* {{tl|BibliographicCommentsHeader}}
 ==Documentation source==
 This is documentation for the template '''[[:Template:AuthorHeader|AuthorHeader]]''', transcluded from [[Template:AuthorHeader/Doc|AuthorHeader/Doc]].