Difference between revisions of "Template:War diary AWM/doc"
m (GavinRobinson moved page Template:WarDiaryAWM/doc to Template:War diary AWM/doc) |
(adding new parameter) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
== Usage == | == 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 Australian War Memorial. It will automatically generate a link based on the catalogue reference entered in the parameters. | + | 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 Australian War Memorial. It will automatically generate a link based on the catalogue reference entered in the parameters. Many non-Australian units have copies of their war diaries at the Australian War Memorial. This template can be used for all of them in addition to templates for other copies of the same diaries held elsewhere. |
<pre> | <pre> | ||
| − | {{ | + | {{War diary AWM |
| class = | | class = | ||
| subclass = | | subclass = | ||
| start_date = | | start_date = | ||
| end_date = | | end_date = | ||
| + | | sub = | ||
}} | }} | ||
</pre> | </pre> | ||
| − | Parameter names can be omitted if the values are entered in this order. All parameters are required. There is no need to enter AWM4 as part of the catalogue reference as this will be added automatically. | + | Parameter names can be omitted if the values are entered in this order. All parameters except '''subunit''' are required. There is no need to enter AWM4 as part of the catalogue reference as this will be added automatically. |
*'''class''' – the class number of the war diary. This is the number that comes after AWM4 but before a / in the catalogue reference. It corresponds to a class of units of a certain type. For example, 23 is infantry. You should only enter the number here, not the /. | *'''class''' – the class number of the war diary. This is the number that comes after AWM4 but before a / in the catalogue reference. It corresponds to a class of units of a certain type. For example, 23 is infantry. You should only enter the number here, not the /. | ||
| Line 18: | Line 19: | ||
*'''start_date''' – earliest date covered by the diaries with the specified catalogue reference. | *'''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. | *'''end_date''' – latest date covered by the diaries with the specified catalogue reference. | ||
| + | *'''subunit''' – ''optional'' – allows you to specifiy the name of a sub-unit or staff department that has a war diary but not its own page, for example "General Staff". | ||
| − | + | Examples: | |
| − | <nowiki>{{ | + | <nowiki>{{War diary AWM|26|51|January 1916|March 1919}}</nowiki> |
This gives a reference to class 26 (medical, dental and nursing units) and subclass 51 (8th Australian Field Ambulance). | This gives a reference to class 26 (medical, dental and nursing units) and subclass 51 (8th Australian Field Ambulance). | ||
| + | |||
| + | <nowiki>{{War diary AWM|1|28|January 1916|March 1919|Administrative Staff}}</nowiki> | ||
| + | |||
| + | This gives a reference to class 1 (formation headquarters) and subclass 51 (Administrative Staff, [[Australian and New Zealand Army Corps]]). | ||
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]] and [[:Category:Units with free war diary images]]. | 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]] and [[:Category:Units with free war diary images]]. | ||
[[Category:War diary templates]] | [[Category:War diary templates]] | ||
Latest revision as of 01:29, 24 July 2015
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 Australian War Memorial. It will automatically generate a link based on the catalogue reference entered in the parameters. Many non-Australian units have copies of their war diaries at the Australian War Memorial. This template can be used for all of them in addition to templates for other copies of the same diaries held elsewhere.
{{War diary AWM
| class =
| subclass =
| start_date =
| end_date =
| sub =
}}
Parameter names can be omitted if the values are entered in this order. All parameters except subunit are required. There is no need to enter AWM4 as part of the catalogue reference as this will be added automatically.
- class – the class number of the war diary. This is the number that comes after AWM4 but before a / in the catalogue reference. It corresponds to a class of units of a certain type. For example, 23 is infantry. You should only enter the number here, not the /.
- subclass – the subclass number of the war diary. This comes after a / in the catalogue reference, and corresponds to a particular unit. You should only enter the number here, not the /.
- 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.
- subunit – optional – allows you to specifiy the name of a sub-unit or staff department that has a war diary but not its own page, for example "General Staff".
Examples:
{{War diary AWM|26|51|January 1916|March 1919}}
This gives a reference to class 26 (medical, dental and nursing units) and subclass 51 (8th Australian Field Ambulance).
{{War diary AWM|1|28|January 1916|March 1919|Administrative Staff}}
This gives a reference to class 1 (formation headquarters) and subclass 51 (Administrative Staff, Australian and New Zealand Army Corps).
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 and Category:Units with free war diary images.
