Template:DomEnc/doc

Purpose

This template is for headers of articles from the Domestic Encyclopædia.

Usage

Abbreviated list

{{DomEnc
 | year           =
 | volume         =
 | previous       =
 | next           =
 | wikipedia      =
}}

Full parameter set

{{DomEnc
 | year           =
 | volume         =
 | previous       =
 | next           =
 | wikipedia      =
 | wikipedia2     =
 | portal         = 
 | commonscat     =
 | wikiquote      =
 | wikispecies    =
 | wiktionary     =
 | wikibooks      =
 | wikinews       =
 | extra_notes    =
 | override_notes =
 | other_projects =
 | section        =
 | override_previous =
 | override_next  =
}}

The template goes at the top of an article. This template is to be used at the top of every entry in the Encyclopædia (of any edition of it).

• | year =
  • This is for noting the year of publication for the edition from which the article was obtained. This parameter is mandatory, because there are at least three editions of the Domestic Encyclopædia, of 1802, 1803 and 1821 years, and for each edition this template may be used, so it is obligatory to clearly state in the template call, of which year the edition is. The value of the parameter is, for example, utilised to create at the top of the page the link to the main (root) encyclopedia's page, in the shape of: Domestic Encyclopædia ({{{year}}}).
• | volume =
  • Type in the number of volume to which belongs the article. It will create link to the volume at the top of the page, straight after link to the main encyclopedia page. Leave this parameter empty or remove it when this link to a volume is not desired (for example, on the main pages of the volumes themselves).
• | previous =
  • Type in the name of the previous entry. It will create a link to it, formatted by the shape: Domestic Encyclopædia ({{{year}}})/{{{previous}}}. That is, this way of creating of 'previous' link may be used when the entry being linked is a direct subpage of the main (root) page of the encyclopedia edition to which the entry belongs. N. B. If the linked page is not a direct subpage of the main page, then try to use parameter override_previous instead (see its description below at the end of the parameters list).
• | next =
  • Same as above but goes to next entry. The link will be formatted by the shape: Domestic Encyclopædia ({{{year}}})/{{{next}}}. And the same remark works to this parameter too: if another shape of the 'next' link is desired, then try to use parameter override_next (see below at the end of the parameters list) instead.
• | wikipedia =
  • Link to wikipedia article. Fill in the name of the article for this parameter. If there is no wikipedia article, leave it blank or remove it.
• | wikipedia2 =
  • Parameter for a second, relevant wikipedia article. N. B. It is expected to be used only when the previous parameter (wikipedia) is filled. Also, if more than two wikipedia articles should be linked, then parameter other_projects (see below) may be used for this.
• | portal = portal on wikisource
• | commonscat = category at Commons
• | wikiquote = page at wikiquote
• | wikispecies = taxonomy page at wikispecies
• | wiktionary = definition at wiktionary
• | wikibooks = page at wikibooks
• | wikinews = news page at wikinews
• | extra_notes =
  • This is useful for notifying the reader of useful information about the article not appropriate to the other parameters.
• | override_notes =
  • This is useful when this template is used as a header for pages in this project which are not articles from the Encyclopedia. Its use should be restricted to such contexts. If set to nothing, the usual default notes will not be displayed. If set to some text, that text will be displayed instead of the default notes.
• | other_projects =
  • Links to wikimedia projects which are not listed in other parameters. It can also be used for Wikisource links and when more than two Wikipedia links are desired. Please format it to include the name of the project referred to (if not Wikisource): [[Project Name:Article Name|Article Name]] at [[Project Name:Main_Page|Project Name]]. Only include links to Wikimedia projects.
• | section =
  • This is useful in extraordinary situations where the normal display of the SUBPAGENAME is not desired. For example, it is used to implement the examples below since otherwise the SUBPAGENAME of this documentation page (doc) would be displayed instead of the SUBPAGENAME of the article (Almanack) for which the header would be used.
• | override_previous =
  • This parameter serves as a substitution of the parameter previous when "normal" shape of the entry name is not desired. For example, parameter override_previous must be used in articles belonging to the "Supplement" section of the Domestic Encyclopædia (1802) included in the Vol. 4, because their names must have shape of: Domestic Encyclopædia (1802)/Supplement/article_name.
• | override_next =
  • Same as above but goes to next entry. Use this instead of next when the 'next' entry is not a direct subpage of the root encyclopedia page.

Examples

Typical

{{DomEnc
 | year      = 1802
 | volume    = 1
 | previous  = Allspice
 | next      = Almond
 | wikipedia = Almanac
}}

Using for 'Supplement' articles

{{DomEnc
 | year              = 1802
 | volume            = 4
 | override_previous = [[../Acacia, the False/]]
 | override_next     = [[../Acre/]]
}}

Don't display notes

{{DomEnc|year=1802|override_notes=}}