Difference between revisions of "Template:Cite war diary/doc"

From Linking experiences of World War One
Jump to: navigation, search
(Created page with "==Usage== Please use this template in footnotes to reference official war diaries. It automatically generates a link to the war diary section of the relevant page. <pre> {{R...")
 
m (tidying up)
Line 13: Line 13:
 
Parameter names can be omitted if the values are entered in this order.
 
Parameter names can be omitted if the values are entered in this order.
  
*'''start_date''': the first date referenced. If you are only referencing one date, put it here and leave out end_date
+
*'''start_date''' &ndash; the first date referenced. If you are only referencing one date, put it here and leave out end_date
*'''end_date''': Optional. The last date referenced if you are referencing a range of consecutive dates. For non-consecutive dates, you will need to call the template again for each date.
+
*'''end_date''' &ndash; ''optional'' ndash; The last date referenced if you are referencing a range of consecutive dates. For non-consecutive dates, you will need to call the template again for each date.
*'''unitpage''': Optional. If you are referencing the war diary of the unit whose page you are on, leave this out and the link will point to this page by default. If you are referencing the diary of a different unit, put its page name here.
+
*'''unitpage''' &ndash; ''optional'' ndash; if you are referencing the war diary of the unit whose page you are on, leave this out and the link will point to this page by default. If you are referencing the diary of a different unit, put its page name here.
  
 
Any additional information can be entered as free text outside the template but inside the footnote. This might include file name and page number for diaries digitised as PDF files, or a direct link to a page image on the web.
 
Any additional information can be entered as free text outside the template but inside the footnote. This might include file name and page number for diaries digitised as PDF files, or a direct link to a page image on the web.

Revision as of 07:20, 22 December 2014

Usage

Please use this template in footnotes to reference official war diaries. It automatically generates a link to the war diary section of the relevant page.

{{RefWarDiary
| start_date =
| end_date =
| unitpage =
}}

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

  • start_date – the first date referenced. If you are only referencing one date, put it here and leave out end_date
  • end_dateoptional ndash; The last date referenced if you are referencing a range of consecutive dates. For non-consecutive dates, you will need to call the template again for each date.
  • unitpageoptional ndash; if you are referencing the war diary of the unit whose page you are on, leave this out and the link will point to this page by default. If you are referencing the diary of a different unit, put its page name here.

Any additional information can be entered as free text outside the template but inside the footnote. This might include file name and page number for diaries digitised as PDF files, or a direct link to a page image on the web.

There is no need to include the archival reference of the diary as this will be given at the target of the link.

Examples:

To reference one date for the current unit:

{{RefWarDiary|1/7/1916}}

To reference a range of dates for the current unit:

{{RefWarDiary|1/7/1916|31/7/1916}}

To reference one date for a different unit:

{{RefWarDiary|1/7/1916||1st Battalion Rifle Brigade, UK}}

To reference a range of dates for a different unit:

{{RefWarDiary|1/7/1916|31/7/1916|1st Battalion Rifle Brigade, UK}}