Difference between revisions of "Template:Cite war diary/doc"
(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 |
||
(4 intermediate revisions by the same user not shown) | |||
Line 4: | Line 4: | ||
<pre> | <pre> | ||
− | {{ | + | {{Cite war diary |
| start_date = | | start_date = | ||
| end_date = | | end_date = | ||
| unitpage = | | unitpage = | ||
+ | | subunit = | ||
+ | | page_image = | ||
}} | }} | ||
</pre> | </pre> | ||
Line 13: | Line 15: | ||
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''' | + | *'''start_date''' – the first date referenced. If you are only referencing one date, put it here and leave out end_date |
− | *'''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. |
− | *'''unitpage''' | + | *'''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. |
+ | *'''subunit''' – ''optional'' – you can use this to specify a subunit or staff department that has a separate diary but not its own page. For example, "General Staff". | ||
+ | *'''page_image''' – ''optional'' – if the diary is available free to view online with no login required, and if there are permalinks to specific pages, you can use this for the full URL of the page you are citing. It will automatically generate a link as part of the citation. | ||
− | 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 | + | 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. |
There is no need to include the archival reference of the diary as this will be given at the target of the link. | There is no need to include the archival reference of the diary as this will be given at the target of the link. | ||
Line 25: | Line 29: | ||
To reference one date for the current unit: | To reference one date for the current unit: | ||
− | <nowiki>{{ | + | <nowiki>{{Cite war diary|1/7/1916}}</nowiki> |
To reference a range of dates for the current unit: | To reference a range of dates for the current unit: | ||
− | <nowiki>{{ | + | <nowiki>{{Cite war diary|1/7/1916|31/7/1916}}</nowiki> |
To reference one date for a different unit: | To reference one date for a different unit: | ||
− | <nowiki>{{ | + | <nowiki>{{Cite war diary|1/7/1916||1st Battalion Rifle Brigade, UK}}</nowiki> |
To reference a range of dates for a different unit: | To reference a range of dates for a different unit: | ||
− | <nowiki>{{ | + | <nowiki>{{Cite war diary|1/7/1916|31/7/1916|1st Battalion Rifle Brigade, UK}}</nowiki> |
− | [[Category:War diary templates]] | + | To reference one date for a staff department of a different unit: |
− | [[Category:Citation templates]] | + | |
+ | <nowiki>{{Cite war diary|15/2/1916||I ANZAC Corps|General Staff}}</nowiki> | ||
+ | |||
+ | <includeonly>[[Category:War diary templates]] | ||
+ | [[Category:Citation templates]]</includeonly> |
Latest revision as of 08:17, 28 April 2016
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.
{{Cite war diary | start_date = | end_date = | unitpage = | subunit = | page_image = }}
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_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.
- 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.
- subunit – optional – you can use this to specify a subunit or staff department that has a separate diary but not its own page. For example, "General Staff".
- page_image – optional – if the diary is available free to view online with no login required, and if there are permalinks to specific pages, you can use this for the full URL of the page you are citing. It will automatically generate a link as part of the citation.
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.
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:
{{Cite war diary|1/7/1916}}
To reference a range of dates for the current unit:
{{Cite war diary|1/7/1916|31/7/1916}}
To reference one date for a different unit:
{{Cite war diary|1/7/1916||1st Battalion Rifle Brigade, UK}}
To reference a range of dates for a different unit:
{{Cite war diary|1/7/1916|31/7/1916|1st Battalion Rifle Brigade, UK}}
To reference one date for a staff department of a different unit:
{{Cite war diary|15/2/1916||I ANZAC Corps|General Staff}}