View source for Help:Step-by-step guide to using the populace template

== Step-by-step guide to using the populace template ==

This is a guide to using the [[Template:populace|populace template]] in it's intended way. That is to say, passing the template parameters as opposed to copying the template / substituting the template into your page.  

First, we'll discuss how to use the template via ''passing parameters'', which is a fancy way to say handing off all the data the template wants, piece by piece. After, we'll discuss how copying or substituting the template differs, and advantages/disadvantages to each method. 

== Standard method of using the Populace template ==
(this is as of February 2025)

As you might observe if you visit the [[Template:populace|populace template]] page, is has it's instructions built in to the template. I'll put them here:

<pre>
To use this template, you have the template name, and then a series of vertical pipes "|" separating each parameter name, with an equals sign, followed by what you want to pass to that parameter. All of that should be enclosed in double curly brackets. For example:

{{Populace 
| photo = [[File:Your_File_Name_Here.jpg|300px]] 
| photocaption = Your caption for your photo 
| location = where you are located 
| pronouns = your pronuns 
| status = Date you first joined the SCA 
| oplink = url to your OP entry 
| title = Your preferred title(s) 
| offices = Any offices you hold, if none leave blank 
| device = [[File:Your_Devce_File_Name.gif|300px]] 
| devicecaption = Heraldric blazon for your device 
}}
</pre>


Each part of the template has a keyword, such as "photo", "photocaption", or "location", that tells the template just what part of the template you are about to give ("pass") data to. These keywords must be spelled exactly as used by the template to work. 

Next, you will have an equals sign ("=") followed by the data you want to pass to the template. To fill out all the fields, you'll need the following:
Your information about yourself / your persona - pronouns, date you started in the SCA, where you play, your titles (if any), names of any offices you hold. You will also need the URL (web link) to your Order of Precedence entry, if you have one. That can be found by searching the [https://op.antirheralds.org/ online OP]. 

Note: Ideally you'll want to use4 the direct "clean" link to your OP entry, which you can get by searching for yourself, then clicking in your name to see your individual entry. It should just contain a URL that ends in "who=XXXX", where XXXX is your entry number in the OP database. So, for example, "https://op.antirheralds.org/index.php?with=Start&name=Michelino&chosen=&GO=GO" is the URL I get searching for Michelino, but after I click on my name, I get "https://op.antirheralds.org/index.php?who=6169", which is the direct link to my individual OP entry.

Finally, you will want to have previously uploaded and have the file names to your profile picture, and your registered device (along with it's blazon - heraldic description). Information on how to upload images can be found [[Help:Uploading_images_step-by-step|here.]] If you have a passed device (arms / heraldry), you can find it, and its blazon, on the [https://rollofarms.antirheralds.org/ An Tir Roll of Arms] online.

=== Filling in the text data ===
{{Populace 
| photo = [[File:Your_File_Name_Here.jpg|300px]] 
| photocaption = Your caption for your photo 
| location = Barony of [[Aquaterra]]
| pronouns = he/him 
| status = AS XV or AS XXXIV 
| oplink = url to your OP entry 
| title = Lord/Signore 
| offices = Aquaterra Great Book, An Tir Wiki Admin 
| device = [[File:Your_Devce_File_Name.gif|300px]] 
| devicecaption = Heraldric blazon for your device
}}
The first and easiest step is to just replace the text in the template fields with the text you actually want to appear. For example:

<pre>
{{Populace 
| photo = [[File:Your_File_Name_Here.jpg|300px]] 
| photocaption = It's-a me, Michelino! 
| location = Barony of [[Aquaterra]]
| pronouns = he/him 
| status = AS XV or AS XXXIV 
| oplink = url to your OP entry 
| title = Lord/Signore 
| offices = Aquaterra Great Book, An Tir Wiki Admin 
| device = [[File:Your_Devce_File_Name.gif|300px]] 
| devicecaption = Heraldric blazon for your device 
}}
</pre>

This looks like the example to the right. 

Note I added a wiki link in my location field. You don't have to do this, but it's a nice addition so folks can click on the link directly do find out more about where you are located.
<br> <br> <br> <br>

=== Filling in the OP URL===
<br><br>
{{Populace 
| photo = [[File:Your_File_Name_Here.jpg|300px]] 
| photocaption = Your caption for your photo 
| location = Barony of [[Aquaterra]]
| pronouns = he/him 
| status = AS XV or AS XXXIV 
| oplink = http://op.antirheralds.org/index.php?who=6169 
| title = Lord/Signore 
| offices = Aquaterra Great Book, An Tir Wiki Admin 
| device = [[File:Your_Devce_File_Name.gif|300px]] 
| devicecaption = Heraldric blazon for your device 
}}
Find the URL (web address) to the individual link to your OP entry, and paste it in here. Just the text of the URL, the template adds the needed square brackets ("[" and "]") automatically so the link will work. 

<pre>
{{Populace 
| photo = [[File:Your_File_Name_Here.jpg|300px]] 
| photocaption = It's-a me, Michelino! 
| location = Barony of [[Aquaterra]]
| pronouns = he/him 
| status = AS XV or AS XXXIV 
| oplink = http://op.antirheralds.org/index.php?who=6169 
| title = Lord/Signore 
| offices = Aquaterra Great Book, An Tir Wiki Admin 
| device = [[File:Your_Devce_File_Name.gif|300px]] 
| devicecaption = Heraldric blazon for your device 
}}
</pre>

So now we should get the link added in on the right.
<br> <br> <br> <br>

=== Adding the images ===
<br><br>
{{Populace 
| photo = [[File:Michelino di Gino Martini1.jpg|300px]] 
| photocaption = It's-a me, Michelino! 
| location = Barony of [[Aquaterra]]
| pronouns = he/him 
| status = AS XV or AS XXXIV 
| oplink = http://op.antirheralds.org/index.php?who=6169 
| title = Lord/Signore 
| offices = Aquaterra Great Book, An Tir Wiki Admin 
| device = [[File:MichelinodiGinoMartini.gif|300px]] 
| devicecaption = Per pale wavy Purpure and Or, two chalices in bend countercharged 
}}
Find the filenames for your previously uploaded image and device. Remember, you'll want to include the "File:" or "Image:" part of the name as well. Replace the text for the file name inside the double square brackets (<nowiki>"[[" and "]]"</nowiki>), but leave the vertical pipe and image size instructions at the end (the "|300px" part). 

Don't forget to also add a caption for your image (typically, your SCA name), and the [[blazon]] (heraldic description) of your arms for "photocaption" and "devicecaption" respectively. 

<pre>
{{Populace 
| photo = [[File:Michelino di Gino Martini1.jpg|300px]] 
| photocaption = It's-a me, Michelino! 
| location = Barony of [[Aquaterra]]
| pronouns = he/him 
| status = AS XV or AS XXXIV 
| oplink = http://op.antirheralds.org/index.php?who=6169 
| title = Lord/Signore 
| offices = Aquaterra Great Book, An Tir Wiki Admin 
| device = [[File:MichelinodiGinoMartini.gif|300px]] 
| devicecaption = Per pale wavy Purpure and Or, two chalices in bend countercharged 
}}
</pre>

If everything worked, you should now have a completed Populace template. If not, feel free to ask for assistance!
<br> <br> <br> <br>
<br> <br> <br> <br><br> <br> <br> <br><br> <br> <br> <br><br> <br> <br> <br><br> <br> <br> <br><br> <br> <br> <br>

== Alternate method of using the Populace template ==

If you know what you are doing, it's possible to add in the wiki code of the template directly into a page via copy/paste, or using the SUBST (substitute) command. However, as you can see, it's a little bit more messy:

<nowiki>
<div>
{| width=280 style="margin: 0 0 0.5em 1em; border-collapse:collapse; float:right; clear:right; background: #F9F9F9;" border="1" cellpadding="0"
|- style="text-align:center;"
! style="background: #ffcc00; color: #000000;" | '''Photo'''
|-
| style="text-align:center; background: #ffffff;" | {{{photo |No photo added}}}<br><small>''{{{photocaption| No photo caption added}}}''</small>
|- style="text-align:center;"
! style="background: #ffcc00; color: #000000;" | '''Information'''
|- style="text-align:center;"
|
{| style="margin:0 auto; text-align:left; background: #ffffff;"  cellpadding="2"
|- valign=top
|Resides:||{{{location|Not specified}}}
|- valign=top
|Pronouns:||{{{pronouns|Not specified}}}
|- valign=top
|Date Started:||{{{status|Not specified}}}
|- valign=top
|Awards:||[{{{oplink|No link added to}}} Order of Precedence]
|- valign=top
|Prefered Title:||{{{title|Not specified}}}
|- valign=top
|Offices:||{{{offices|Not specified}}}
|}
|- style="text-align:center;"
! style="background: #ffcc00; color: #000000;" | '''Heraldry'''
|-
| style="text-align:center; background: #ffffff;" | {{{device | No device image added}}}<br><small>''{{{devicecaption|No device description}}}''</small>
|}
</div>
[[Category:People]]
<noinclude>
<pre>
== Usage ==
To use this template, you have the template name, and then a series of vertical pipes "|" separating each parameter name, with an equals sign, followed by what you want to pass to that parameter. All of that should be enclosed in double curly brackets. For example:

{{Populace 
| photo = [[File:Your_File_Name_Here.jpg|300px]] 
| photocaption = Your caption for your photo 
| location = where you are located 
| pronouns = your pronuns 
| status = Date you first joined the SCA 
| oplink = url to your OP entry 
| title = Your preferred title(s) 
| offices = Any offices you hold, if none leave blank 
| device = [[File:Your_Devce_File_Name.gif|300px]] 
| devicecaption = Heraldric blazon for your device 
}}
</pre>
</noinclude>

</nowiki>


The advantage of using the Standard method is it's much simpler, and if the template is updated later, it will be auto-updated on pages that the template is used. We try not to modify the template frequently, but it does happen (the last modification added in pronouns). 

It's also nice if the populace templates remain standardized, as then folks quickly learn where to look on them for expected information. 

The advantages of the alternate method is that it allows for customization. You can modify the fields, colors, and so on. It will also remain static on your page even if the template is later modified, which can be both an advantage or a disadvantage.