Difference between revisions of "Template:War diary TNA/doc"

From Linking experiences of World War One
Jump to: navigation, search
(Created page with "==Usage== This template should be used under the War Diary heading in the body of a page if a unit or formation has official war diaries at the UK National Archives. <pre> {...")
 
m (tidying up)
Line 12: Line 12:
 
</pre>
 
</pre>
  
Parameter names can be omitted if they are entered in this order.
+
Parameter names can be omitted if the values are entered in this order.
  
#'''ref''': full catalogue reference, including series. This will usually be WO 95 but can also be WO 154. You can refer to a single item, a single piece, or a sub-series covering a range of pieces, as long as there is a Discovery URL for the reference. Examples:
+
*'''ref''' &ndash; full catalogue reference, including series. This will usually be WO 95 but can also be WO 154. You can refer to a single item, a single piece, or a sub-series covering a range of pieces, as long as there is a Discovery URL for the reference. Examples:
##WO 95/2691/2
+
**WO 95/2691/2
##WO 95/2686
+
**WO 95/2686
##WO 95/2662-2695
+
**WO 95/2662-2695
##WO 154/59
+
**WO 154/59
#'''url''': full URL of a Discovery resource corresponding to the catalogue reference. For example: <nowiki>http://discovery.nationalarchives.gov.uk/details/r/C1787810</nowiki>
+
*'''url''' &ndash; full URL of a Discovery resource corresponding to the catalogue reference. For example: <nowiki>http://discovery.nationalarchives.gov.uk/details/r/C1787810</nowiki>
#'''start_date''': earliest date covered by the diaries with the specified catalogue reference.
+
*'''start_date''' &ndash; earliest date covered by the diaries with the specified catalogue reference.
#'''end_date''': latest date covered by the diaries with the specified catalogue reference.
+
*'''end_date''' &ndash; latest date covered by the diaries with the specified catalogue reference.
  
This template can be used more than once on the same page if the unit has diaries under several different references. It automatically adds the category "Units with official war diaries".
+
This template can be used more than once on the same page if the unit has diaries under several different references. It automatically adds [[:Category:Units with official war diaries]].
  
 
[[Category:War diary templates]]
 
[[Category:War diary templates]]

Revision as of 06:26, 22 December 2014

Usage

This template should be used under the War Diary heading in the body of a page if a unit or formation has official war diaries at the UK National Archives.

{{WarDiaryTNA
| ref =
| url =
| start_date =
| end_date =
}}

Parameter names can be omitted if the values are entered in this order.

  • ref – full catalogue reference, including series. This will usually be WO 95 but can also be WO 154. You can refer to a single item, a single piece, or a sub-series covering a range of pieces, as long as there is a Discovery URL for the reference. Examples:
    • WO 95/2691/2
    • WO 95/2686
    • WO 95/2662-2695
    • WO 154/59
  • url – full URL of a Discovery resource corresponding to the catalogue reference. For example: http://discovery.nationalarchives.gov.uk/details/r/C1787810
  • start_date – earliest date covered by the diaries with the specified catalogue reference.
  • end_date – latest date covered by the diaries with the specified catalogue reference.

This template can be used more than once on the same page if the unit has diaries under several different references. It automatically adds Category:Units with official war diaries.