User:Phantomsteve/user-box/ww1-in-memoriam/doc
This is a documentation subpage for User:Phantomsteve/user-box/ww1-in-memoriam. It may contain usage information, categories and other content that is not part of the original userbox page. |
Overview
[edit]This user lost a member of their family in the First World War.
In Memory of: _regnum_ _rank_ _name_ (_regiment_) , killed _dateofdeath_ at _battle_ |
This user box is expected to be used by those interested in Genealogy and Family history.
On the right-hand side of the user box are the ribbons for (top) the British War Medal and (bottom) the Victory Medal.
The text will always include the words
- This user lost a member of their family in the First World War..
If any of the variables are used, the text below this will read:
- In Memory of: regiment-number rank name (regiment) [, killed date-of-death at battle]
Please note that for 'In Memory of:' to appear, the variable name must be non-blank. For ', killed' to appear, the variable killed must be non-blank.
All the variables are optional.
No checks are made on the variables other than their existance.
Syntax
[edit]Syntax:
{{User:Phantomsteve/user-box/ww1-in-memoriam|variable-1...|variable-n}}
Variables
Name | Details |
---|---|
reg-num | Soldier's regimental number |
rank | Soldier's rank |
name | Soldier's name |
regiment | Soldier's regiment |
killed | non-blank( if date of death and/or battle are to be listed, in which case ", killed " will be added to the output) |
date-of-death | Soldier's date of death |
battle | Battle soldier died in |
Examples
[edit]Example | Coding | Notes | ||
---|---|---|---|---|
CORRECT USE | ||||
|
{{User:Phantomsteve/user-box/ww1-in-memoriam}}
|
No variables used. | ||
|
{{User:Phantomsteve/user-box/ww1-in-memoriam|reg-num=1234|rank=Private|name=Frederick J. Bloggs|regiment=The Phantom Regiment (6th Bn)|killed=true|date-of-death=16th July 1916|battle=The Battle of the Somme}}
|
All fields used | ||
|
{{User:Phantomsteve/user-box/ww1-in-memoriam|reg-num=PO/5678|rank=Lance-Corporal|name=James F. Bloggs|regiment=The Royal Marine Light Infantry|killed=true|battle=The Battle of Coronel}}
|
All fields used except date-of-death | ||
|
{{User:Phantomsteve/user-box/ww1-in-memoriam|name=John E. Beegud|regiment=The Royal Marine Artillery|killed=true|battle=The Battle of Coronel}}
|
All fields used except reg-num, rank and date-of-death | ||
INCORRECT USE | ||||
|
{{User:Phantomsteve/user-box/ww1-in-memoriam|reg-num=1234|rank=Private|name=Frederick J. Bloggs|regiment=The Phantom Regiment (6th Bn)|killed=true}}
|
All fields used except date-of-death and battle, killed=true left in - this will produce incorrect output | ||
|
{{User:Phantomsteve/user-box/ww1-in-memoriam|reg-num=1234|rank=Private|name=Frederick J. Bloggs|regiment=The Phantom Regiment (6th Bn)|date-of-death=16th July 1916|battle=The Battle of the Somme}}
|
All fields used, but "killed=true" missed out! |