Difference between revisions of "Template:Header"

From ArchiveWiki
Jump to navigationJump to search
(Add owner field)
 
(10 intermediate revisions by the same user not shown)
Line 1: Line 1:
==={{{title}}}===
<includeonly>==={{{title}}}===
<table class="toc colour" style="background: #EEEEEE;"><!--
<table style="background: #EEEEEE;"><!--


Insert date range field if one has been given
Insert date range field if one has been given
Line 8: Line 8:
-->{{#if: {{{owner|}}} | <tr><td>'''Owner'''</td><td>[[User:{{{owner}}}|{{{owner}}}]]</td></tr>}}<!--
-->{{#if: {{{owner|}}} | <tr><td>'''Owner'''</td><td>[[User:{{{owner}}}|{{{owner}}}]]</td></tr>}}<!--


Insert link to catalogue for National Archives listing
Old link to TNA catalogue, no longer in use
-->{{#if: {{{nacatref|}}} | <tr><td>'''Location'''</td><td>[[National Archives]] <span class="small">(see [[:Category:National Archives|all files stored here]])</span></td></tr><tr><td>'''Catalogue'''</td><td>[http://www.nationalarchives.gov.uk/catalogue/displaycataloguedetails.asp?CATLN=6&CATID={{{nacatref}}} See entry]</td></tr>}}<!--
{{#if: {{{nacatref|}}} | <tr><td>'''Location'''</td><td>[[National Archives]] <span class="small">(see [[:Category:National Archives|all files stored here]])</span></td></tr><tr><td>'''Catalogue'''</td><td>[http://www.nationalarchives.gov.uk/catalogue/displaycataloguedetails.asp?CATLN=6&CATID={{{nacatref}}} See entry]</td></tr>}}
 
Insert link to catalogue for National Archives listing (using page title, not NACATREF property)
-->{{#if: {{{nacatref|}}} | <tr><td>'''Location'''</td><td>[[National Archives]] <span class="small">(see [[:Category:National Archives|all files stored here]])</span></td></tr><tr><td>'''Catalogue'''</td><td>[http://archive.cbrd.co.uk/link.php?nacatref={{PAGENAMEE}} See entry]</td></tr>}}<!--


If not at NA, use manual 'location' field instead
If not at NA, use manual 'location' field instead
Line 15: Line 18:


If it has series and subseries, insert them
If it has series and subseries, insert them
-->{{#if: {{{series|}}} | <tr><td>'''File base'''</td><td>[[:Category:Series {{{series}}}|Series {{{series}}}]]{{#if: {{{subseries|}}} | , [[:Category:Subseries {{{series}}} {{{subseries}}}|subseries {{{series}}} {{{subseries}}}]]}}</td></tr>}}
-->{{#if: {{{series|}}} | <tr><td>'''File base'''</td><td>[[:Category:Series {{{series}}}|Series {{{series}}}]]{{#if: {{{subseries|}}} | , [[:Category:Subseries {{{series}}} {{{subseries}}}|subseries {{{series}}} {{{subseries}}}]]}}</td></tr>}}<!--
 
If it's poncey LMA fond and subfond, insert them
-->{{#if: {{{fond|}}} | <tr><td>'''File base'''</td><td>[[:Category:Fond {{{fond}}}|Fond {{{fond}}}]]{{#if: {{{subfond|}}} | , [[:Category:Subfond {{{subfond}}}|subfond {{{subfond}}}]]}}</td></tr>}}
 
</table>__NOTOC__</includeonly><noinclude>This template allows you to insert a standardised table of information at the top of a file listing page, including the file title in big letters.
 
==How to use it==
For '''files at the National Archives''' use these parameters:
 
<pre>{{Header
| title    =
| daterange =
| series    =
| subseries =
| nacatref  = y
}}</pre>
 
For '''files held anywhere else''' use these:
 
<pre>{{Header
| title    =
| daterange =
| location  =
| catlink  =
}}</pre>
 
For '''files owned by you''' use these:
 
<pre>{{Header
| title    =
| daterange =
| owner    =
}}</pre>
 
==Those parameters in full==


</table><noinclude>This template allows you to insert a standardised table of information at the top of a file listing page, including the file title in big sexy letters.</noinclude>
{|
__NOTOC__
|'''title'''
|The title of the file, exactly as the archive publishes it. Use for all files.
|-
|'''daterange'''
|The dates the file refers to, as the archive publishes them. Use for all files. ''Optional.''
|-
|'''location'''
|The host organisation, with name exactly as written for its category. This field is filled in automatically for National Archives files.
|-
|'''catlink'''
|The complete URL of the file's page on the archive's website. For non-National Archives files only. ''Optional.''
|-
|'''nacatref'''
|You no longer need to put a reference here to create a link, as the National Archives catalogue has changed and the template will now make a link for you automatically using the file reference. But you do need to put something here to make it do that - anything will do. Perhaps the letter "Y", to indicate how positive you are that it does have a catalogue reference.
<!--|The National Archives has a 5, 6 or 7-digit number referring to each file on its online catalogue. Copy this number (after "&CATREF=" in the URL) and use it here. The rest of the link is automatically generated.-->
|-
|'''series'''
|The file series - usually at the National Archives but can be used anywhere. Use only the opening part. For [[:Category:Series MT]] at the National Archives, you only need to write ''MT'' here. ''Optional.''
|-
|'''subseries'''
|The file subseries, in the same way as above. For [[:Category:Subseries MT 95]] at the National Archives, you only need to write ''95'' here. This field will not appear unless a '''series''' is also given. ''Optional.''
|-
|'''fond'''
|The fond, if you're dealing with the London Metropolitan Archives. Use only the opening part. For [[:Category:Fond GLC]] at the LMA, you only need to write ''GLC'' here. ''Optional.''
|-
|'''subfond'''
|The subfond, in the same way as above. For [[:Category:Subfond TD/PM]], you only need to write ''TD/PM'' here. This field will not appear unless a '''fond''' is also given. ''Optional.''
|-
|'''owner'''
|The username of the file's owner. It will be automatically turned into a link to the user's page. ''Optional.''
</noinclude>

Latest revision as of 05:43, 27 April 2015

This template allows you to insert a standardised table of information at the top of a file listing page, including the file title in big letters.

How to use it

For files at the National Archives use these parameters:

{{Header
| title     = 
| daterange = 
| series    = 
| subseries = 
| nacatref  = y
}}

For files held anywhere else use these:

{{Header
| title     = 
| daterange = 
| location  = 
| catlink   = 
}}

For files owned by you use these:

{{Header
| title     = 
| daterange = 
| owner     = 
}}

Those parameters in full

title The title of the file, exactly as the archive publishes it. Use for all files.
daterange The dates the file refers to, as the archive publishes them. Use for all files. Optional.
location The host organisation, with name exactly as written for its category. This field is filled in automatically for National Archives files.
catlink The complete URL of the file's page on the archive's website. For non-National Archives files only. Optional.
nacatref You no longer need to put a reference here to create a link, as the National Archives catalogue has changed and the template will now make a link for you automatically using the file reference. But you do need to put something here to make it do that - anything will do. Perhaps the letter "Y", to indicate how positive you are that it does have a catalogue reference.
series The file series - usually at the National Archives but can be used anywhere. Use only the opening part. For Category:Series MT at the National Archives, you only need to write MT here. Optional.
subseries The file subseries, in the same way as above. For Category:Subseries MT 95 at the National Archives, you only need to write 95 here. This field will not appear unless a series is also given. Optional.
fond The fond, if you're dealing with the London Metropolitan Archives. Use only the opening part. For Category:Fond GLC at the LMA, you only need to write GLC here. Optional.
subfond The subfond, in the same way as above. For Category:Subfond TD/PM, you only need to write TD/PM here. This field will not appear unless a fond is also given. Optional.
owner The username of the file's owner. It will be automatically turned into a link to the user's page. Optional.