|
|
| Line 1: |
Line 1: |
| == Step-by-step guide to using the populace template ==
| | <div> |
| | | {| width=280 style="margin: 0 0 0.5em 1em; border-collapse:collapse; float:right; clear:right; background: #F9F9F9;" border="1" cellpadding="0" |
| 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.
| | |- style="text-align:center;" |
| | | ! style="background: #ffcc00; color: #000000;" | '''Photo''' |
| 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.
| | |- |
| | | | style="text-align:center; background: #ffffff;" | {{{photo}}}<br><small>''{{{photocaption}}}''</small> |
| == Standard method of using the Populace template ==
| | |- style="text-align:center;" |
| (this is as of July 2026)
| | ! style="background: #ffcc00; color: #000000;" | '''Information''' |
| | | |- style="text-align:center;" |
| 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:
| | | |
| | | {| style="margin:0 auto; text-align:left; background: #ffffff;" cellpadding="2" |
| <pre> | | |- valign=top |
| == Usage ==
| | |Resides:||{{{location}}} |
| 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.
| | |- valign=top |
| | | |Date Started:||{{{status}}} |
| === Color Customization === | | |- valign=top |
| You can optionally customize the look of your infobox by using names (like "navy", "darkred", "purple") or hex codes (like "#4B0082"). If you leave these out, it defaults to the standard An Tir gold and black.
| | |Awards:||<small>Visit the [[Order of Precedence]] to access a list of this person's awards.</small> |
| * headerbg = Background color of the main headers (Photo, Information, Heraldry)
| | |} |
| * headertext = Font color of the main headers
| | |- style="text-align:center;" |
| * boxbg = Background color of the outer frame line
| | ! style="background: #ffcc00; color: #000000;" | '''Heraldry''' |
| * contentbg = Background color of the interior fields behind text/images
| | |- |
| * contenttext = Font color of the interior text
| | | style="text-align:center; background: #ffffff;" | {{{device}}}<br><small>''{{{devicecaption}}}''</small> |
| | | |} |
| === Example ===
| | </div> |
| {{Populace
| | [[Category:People]] |
| | headerbg = #003366
| |
| | headertext = white
| |
| | contentbg = #f0f8ff
| |
| | contenttext = #111111
| |
| | |
| | photo = [[File:Your_File_Name_Here.jpg|300px]]
| |
| | photocaption = Your caption for your photo
| |
| | location = where you are located
| |
| | pronouns = your pronouns
| |
| | status = Date you first joined the SCA
| |
| | oplink = url to your OP entry
| |
| | awardprefs = Awards recognition prefs (Court, Roving, No Thank You)
| |
| | namepronunciation = Record a file or write it out
| |
| | title = Your preferred title(s)
| |
| | offices = Any offices you hold, if none leave blank
| |
| | |
| | device = [[File:Your_Device_File_Name.gif|300px]]
| |
| | devicecaption = Heraldic blazon for your device
| |
| | |
| | badge1 = [[File:Your_File_Name_Here.jpg|300px]]
| |
| | badge1caption = Your caption for your badge
| |
| }}
| |
| | |
| You can remove anything after the equals on a line to blank it out, or remove the whole line if unneeded. This will either leave the title with no text, or in some cases (such as badges), omit the entire line.
| |
| | |
| Award Preference refers to if you would like to be called into Court to receive awards. Pick one of "In Formal Court, Outside Formal Court (Roaming Court or In Camp), No Thank You (Just A Thank You Note Please or No Contact Please)", or leave blank to omit.
| |
| | |
| Name Pronunciation can just be text describing how to pronounce your name, an MP3 recording of it, or leave blank to omit.
| |
| | |
| Note: The "|300px" portion of the image links is to scale the images to 300 pixels, the size of the template.
| |
| </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 (possibly twice), 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 = It's-a me, Michelino! | |
| | location = Barony of [[Aquaterra]]
| |
| | pronouns = he/him
| |
| | status = AS XV or AS XXXIV
| |
| | oplink = url to your OP entry
| |
| | awardprefs = Court is fine.
| |
| | 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
| |
| | awardprefs = Court is fine.
| |
| | 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.
| |
| | |
| {{clear}} | |
| === Filling in the OP URL===
| |
| <br><br> | |
| {{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
| |
| | awardprefs = Court is fine.
| |
| | 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
| |
| | awardprefs = Court is fine. | |
| | 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.
| |
| {{clear}} | |
| | |
| === 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
| |
| | awardprefs = Court is fine. | |
| | 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
| |
| | awardprefs = Court is fine.
| |
| | 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!
| |
| {{clear}}
| |
| | |
| === Adding Badges and Name Pronunciation ===
| |
| {{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
| |
| | awardprefs = Formal or roving court
| |
| | namepronunciation = <div class="mw-ext-score" style="width: 180px; overflow: hidden;">[[File:Michelino di Gino Martini.mp3]]</div>
| |
| | title = Lord/Signore (eventually - Maestro/Magnifico) | |
| | offices = An Tir Wiki Admin, Aquaterra Great Book, Wyewood Social Media officer
| |
| | device = [[File:MichelinodiGinoMartini.gif|300px]]
| |
| | devicecaption = Per pale wavy Purpure and Or, two chalices in bend countercharged
| |
| | badge1 = [[File:Michelino di Gino Martino Badge color Cropped.jpg|300px]]
| |
| | badge1caption= (Fieldless) A sword fesswise argent transfixing an olive vert
| |
| | badge2 = [[File:Michelino_di_Gino_Martini_Badge2.jpg|300px]]
| |
| | badge2caption= (Fieldless) The rear half of a demi-cock purpure.
| |
| }}
| |
| | |
| Remember those badge lines (and the namepronunciation line) in the full template at the start? Because I had removed them, and the way the template is formatted, they are just dropped if not included. I do have a couple of badges, and like to use all the fields, so let's add them back in.
| |
| | |
| For namepronunciation, you can either just put in text (like — "mee-keh-LEE-noh dee DJEE-noh mar-TEE-nee"). Or, if you want to be very clear, you can [[Help:MP3 tutorial|follow this tutorial on how to record an MP3]] of you pronouncing your name. Then upload the MP3, and link it. I chose the latter, as I already have the text in my article.
| |
| | |
| Note that default MP3 player is a bit wide, and will add white space around the 300px images. You can either 1) accept it, 2) scale up your images to fill the space — say, 400px, or 3) add it some HTML trickery to force the MP3 player to truncate how it displays. I ended up doing the third option.
| |
| | |
| For the badges, add in the pairs of lines (badge1, badgecaption1, etc.) for each badge, and link the images and add the heraldic description for the caption. This should cause the badge section to automatically appear.
| |
| | |
| <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
| |
| | awardprefs = Formal or roving court
| |
| | namepronunciation = <div class="mw-ext-score" style="width: 180px; overflow: hidden;">[[File:Michelino di Gino Martini.mp3]]</div>
| |
| | title = Lord/Signore (eventually - Maestro/Magnifico)
| |
| | offices = An Tir Wiki Admin, Aquaterra Great Book, Wyewood Social Media officer
| |
| | device = [[File:MichelinodiGinoMartini.gif|300px]] | |
| | devicecaption = Per pale wavy Purpure and Or, two chalices in bend countercharged
| |
| | badge1 = [[File:Michelino di Gino Martino Badge color Cropped.jpg|300px]]
| |
| | badge1caption= (Fieldless) A sword fesswise argent transfixing an olive vert
| |
| | badge2 = [[File:Michelino_di_Gino_Martini_Badge2.jpg|300px]]
| |
| | badge2caption= (Fieldless) The rear half of a demi-cock purpure.
| |
| }} | |
| </pre> | |
| {{Clear}}
| |
| | |
| === Adjusting Colors (Optional) ===
| |
| | |
| {{Populace | |
| | headerbg = #003366
| |
| | headertext = white
| |
| | contentbg = #f0f8ff
| |
| | contenttext = #111111
| |
| | 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
| |
| | awardprefs =
| |
| | namepronunciation =
| |
| | title = Lord/Signore (eventually - Maestro/Magnifico)
| |
| | offices =
| |
| | device =
| |
| | devicecaption = Per pale wavy Purpure and Or, two chalices in bend countercharged
| |
| }} | |
| | |
| <pre> | |
| {{Populace
| |
| | headerbg = #003366
| |
| | headertext = white
| |
| | contentbg = #f0f8ff
| |
| | contenttext = #111111
| |
| | 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
| |
| | awardprefs =
| |
| | namepronunciation =
| |
| | title = Lord/Signore (eventually - Maestro/Magnifico)
| |
| | offices =
| |
| | device =
| |
| | devicecaption = Per pale wavy Purpure and Or, two chalices in bend countercharged | |
| }}
| |
| </pre> | |
| | |
| Again, the full template at the start had four odd looking lines right at the beginning. These are where you can customize your colors of the template, if you want to make it different from the default An Tir colors. Note that to make it more compact for display purposes, I omitted by badges, and left my office, device, awardprefs, and namepronunciation blank — this causes them to either entirely not display, or just have a blank space.
| |
| | |
| You can optionally customize the look of your infobox by using names (like "navy", "darkred", "purple") or hex codes (like "#4B0082"). If you leave these out, it defaults to the standard An Tir gold and black.
| |
| * headerbg = Background color of the main headers (Photo, Information, Heraldry)
| |
| * headertext = Font color of the main headers
| |
| * boxbg = Background color of the outer frame line
| |
| * contentbg = Background color of the interior fields behind text/images
| |
| * contenttext = Font color of the interior text
| |
| | |
| For the full spectrum of colors, see this Wikipedia article on [https://en.wikipedia.org/wiki/Web_colors Web Colors]. You'll want the Name (if it has one) or the Hex code for any you'd like to use.
| |
| {{clear}}
| |
| | |
| == 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, it's quite bit more messy, and relies on you knowing HTML and wikimarkup code. This is no longer recommended (unless you really, really know what you are doing. If that's the case, come work for me as a deputy).
| |
| | |
| One of the main reasons for editing the code directly was to be able to modify the colors, which is now possible in the standard template.
| |
| | |
| 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 awardprefs, badges, color customization, and hiding some sections if they are specified).
| |
| | |
| 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, 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.
| |
