Template:Collective work header/doc
This is a documentation subpage for Template:Collective work header. It contains usage information, categories and other content that is not part of the original template page. |
Usage[edit]
This template provides a standardised format for collective work header templates. It is not intended to be used directly on pages, rather a template using it is made for each collective work. For example, {{EAm06}}.
Parameters[edit]
Parameter to use from the calling template[edit]
The following parameters can be used from templates using this template (e.g. {{EAm06}}:
- basename: main page of the collective work, e.g. "The Encyclopedia Americana (1906)"
- displayname: the title of the collective work that will be shown: e.g. "The Encyclopedia Americana" (optional)
- author: author of the collective work (optional)
- editor: editor of the collective work (optional)
- translator: translator of the collective work (optional)
- override_author, override_translator (both optional), function as in normal headers
- disclaimer: disclaimer for the collective work (optional). This will give a link to [[{{{basename}}}/Project Disclaimer]], which is the standard location for a disclaimer. Enter the display text of the link, e.g. "the 1906 Encyclopedia Americana disclaimer". If this is not given, nothing will be shown.
- contributor: name of the author of this section, if not the same as author the overall work. Not wikilinked.
Parameters to use for the end page[edit]
Other parameters in the template are designed to be used from the end page:
- previous, next: previous and next articles in the work.
- noarticle: enter "True" to flag an article as having no text - this will cause it to be categorised into [[Category:{{{Basename}}} articles without text]] (optional)
- notes: additional notes on the article (optional)
- Sister wiki links (all optional): wikipedia, commons, commonscat, wikiquote, wikinews, wiktionary, wikibooks, wikiversity, wikispecies, meta
- Internal links (all optional): related_author, portal
Categorisation[edit]
This template will categorise templates using it into Category:Standardised collective work headers.
This template will categorise articles into [[Category:{{{basename}}} articles]] or [[Category:{{{Basename}}} articles without text]], depending on whether the {{{noarticle}}} parameter is given in that article.
Copy-paste example[edit]
Use the following code to make new collective work headers:
{{Collective work header | basename = The Encyclopedia Americana (1906) | displayname = The Encyclopedia Americana | author = | translator = | disclaimer = the 1906 Encyclopedia Americana disclaimer <!-- Below this point are "pass-though" parameters that shouldn't be edited here --> | previous = {{{previous|}}} | next = {{{next|}}} | wikipedia = {{{wikipedia|}}} | commons = {{{commons|}}} | commonscat = {{{commonscat|}}} | wikiquote = {{{wikiquote|}}} | wikinews = {{{wikinews|}}} | wiktionary = {{{wiktionary|}}} | wikibooks = {{{wikibooks|}}} | wikiversity = {{{wikiversity|}}} | wikispecies = {{{wikispecies|}}} | meta = {{{meta|}}} | portal = {{{portal|}}} | related_author = {{{related_author|}}} | notes = {{{notes|}}} | noarticle = {{{noarticle|}}} }}
Blank template[edit]
{{Collective work header | basename = | author = <!-- optional parameters; can also be used as pass through if required --> | displayname = | override_author = | translator = | override_translator = | disclaimer = <!-- required for pass through; paste into your template "as is" --> | previous = {{{previous|}}} | next = {{{next|}}} | wikipedia = {{{wikipedia|}}} | commons = {{{commons|}}} | commonscat = {{{commonscat|}}} | wikiquote = {{{wikiquote|}}} | wikinews = {{{wikinews|}}} | wiktionary = {{{wiktionary|}}} | wikibooks = {{{wikibooks|}}} | wikiversity = {{{wikiversity|}}} | wikispecies = {{{wikispecies|}}} | meta = {{{meta|}}} | portal = {{{portal|}}} | related_author = {{{related_author|}}} | notes = {{{notes|}}} | noarticle = {{{noarticle|}}} <!-- optional pass through; paste into your template if you wish a volume note --> | volume = {{{volume|}}} }}