You are viewing the MafiaScum.net Wiki. To play the game, visit the forum.

Template:Role: Difference between revisions

From MafiaWiki
Jump to navigation Jump to search
(make it possible to switch the categories off, e.g. for tests)
(use the doc page rather than having the docs hardcoded)
Line 29: Line 29:
|}  
|}  
|}
|}
{{#ifeq:{{{demopage|{{FULLPAGENAME}}}}}|Template:Role||{{{via_rolepage|[[Category:Roles]][[Category:All roles and modifiers]][[Category:Role pages that don't use RolePage]]}}} {{#if:{{{type|}}}|[[Category: {{{type|}}} roles]] }}{{#if:{{{type2|}}}|[[Category: {{{type2|}}} roles]] }}{{#if:{{{type3|}}}|[[Category: {{{type3|}}} roles]] }}{{#if:{{{type4|}}}|[[Category: {{{type4|}}} roles]] }}}}</includeonly><noinclude>{{TOCright}}
{{#ifeq:{{{demopage|{{FULLPAGENAME}}}}}|Template:Role||{{{via_rolepage|[[Category:Roles]][[Category:All roles and modifiers]][[Category:Role pages that don't use RolePage]]}}} {{#if:{{{type|}}}|[[Category: {{{type|}}} roles]] }}{{#if:{{{type2|}}}|[[Category: {{{type2|}}} roles]] }}{{#if:{{{type3|}}}|[[Category: {{{type3|}}} roles]] }}{{#if:{{{type4|}}}|[[Category: {{{type4|}}} roles]] }}}}</includeonly><noinclude>{{role/doc}}</noinclude>
== Summary ==
This [[:Category:Templates|template]] is used to place a box on the right side of role pages with information pertaining to the role.  The box displays the following information:
*the [[alias]]es the role may have
*the [[alignment]](s) of the role
*the [[Template:RolesNav|type]] of the role
*the [[phase]] the role submits their choice, if any
 
== Syntax ==
<pre>
{{role
|name_override=
|image=
|alias=
|align=
|color=
|type=
|choice=
|notes=
}}
</pre>
 
== Parameters ==
=== {{{name_override}}} ===
:'''the name of the role, if it differs from the page name'''
::''note: this parameter is optional''
 
=== {{{image}}} ===
:'''the image for this role'''
::''note: this parameter is optional''
 
=== {{{color}}} ===
:'''the background color for this role'''
::''note: this parameter is not finalized. Accepts either a hex code or use one of the following: <nowiki>{{rgb|town}}, {{rgb|mafia}}, {{rgb|werewolf}}, {{rgb|cult}}, {{rgb|self}}.</nowiki>
 
=== {{{alias}}} ===
:'''other names commonly used for this role'''
::''roles which have more than one alias should list those aliases using the <code>{{{alias2}}}, {{{alias3}}}</code> parameter(s)''
 
=== {{{align}}} ===
:'''the faction in which this role is commonly used'''
::''roles which can be used in more than one faction should list those factions using the <code>{{{align2}}}, {{{align3}}}</code> parameter(s)''
 
=== {{{type}}} ===
:'''the most common attributes assigned to this role'''
::''roles which can be assigned multiple/dual 'types' should list those types using the <code>{{{type2}}}</code> parameter''
 
=== {{{choice}}} ===
:'''the [[phase]] the role commonly submits their [[action]], if any'''
:''roles which can submit their action in multiple/dual phases should list those phases using the <code>{{{choice2}}}</code> parameter''
 
=== {{{notes}}} ===
:'''this parameter can be used to note anything else that is ''key to the role'' which is ''not covered'' in the previous parameters'''
::''note: this parameter is optional, and should only be used if necessary; the notes section is not used to describe the role, as this information should be included in the wiki page''
 
=== {{{via_rolepage}}} ===
:'''should be omitted entirely when <nowiki>{{role}}</nowiki> is used directly; used by <nowiki>{{RolePage}}</nowiki> to track the usage of role templates'''
 
== Examples ==
{| cellpadding="5" cellspacing="5" style="margin: 1em 1em 1em 0; background: #f9f9f9; border: 1px #aaa solid; border-collapse: collapse;" border="1"
|- style="background: #f2f2f2; text-align: center;"
! What you type
! What it looks like
|-
|
<pre>
{{role
|image=
|alias=
|color=
|align=
|type=
|choice=
|notes=
}}
</pre>
|
{{role
|image=
|alias=
|align=
|type=
|choice=
|notes=
}}
|-
|
<pre>
{{role
|image= T-vanilla.png
|alias= Seer
|color= {{rgb|town}}
|align= Pro-town
|type= Informative
|choice= Night
|notes=
}}
</pre>
|
{{role
|image= T-vanilla.png
|alias= Seer
|color= {{rgb|town}}
|align= Pro-town
|type= Informative
|choice= Night
|notes=
}}
|-
|
<pre>
{{role
|image= M-fallenangel.png
|color= {{rgb|mafia}}
|alias= Archangel
|alias2= Sorceror
|align= Pro-town
|align2= Anti-town
|type=  Protective
|type2= Informative
|type3= Killing
|choice= Night
|choice2= Day
|notes= this is an example of notes
}}
</pre>
|
{{role
|image= M-fallenangel.png
|color= {{rgb|mafia}}
|alias= Archangel
|alias2= Sorceror
|align= Pro-town
|align2= Anti-town
|type=  Protective
|type2= Investigative
|type3= Killing
|choice= Night
|choice2= Day
|notes= this is an example of notes
}}
</noinclude>

Revision as of 02:10, 24 July 2022

Summary

This template is used to place a box on the right side of role pages with information pertaining to the role. The box displays the following information:

  • the aliases the role may have
  • the alignment(s) of the role
  • the type of the role
  • the phase the role submits their choice, if any

If writing a page about a new role, consider using {{RolePage}}, to generate the entire page rather than just the infobox.

Syntax

{{role
|name_override=
|image=
|alias= 
|align= 
|color=
|type= 
|choice= 
|status= 
|notes= 
}}

Parameters

{{{name_override}}}

the name of the role, if it differs from the page name
note: this parameter is optional

{{{image}}}

the image for this role
note: this parameter is optional

{{{color}}}

the background color for this role
note: this parameter is not finalized. Accepts either a hex code or use one of the following: {{rgb|town}}, {{rgb|mafia}}, {{rgb|werewolf}}, {{rgb|cult}}, {{rgb|self}}.

{{{alias}}}

other names commonly used for this role
roles which have more than one alias should list those aliases using the {{{alias2}}}, {{{alias3}}} parameter(s)

{{{align}}}

the faction in which this role is commonly used
roles which can be used in more than one faction should list those factions using the {{{align2}}}, {{{align3}}} parameter(s)

{{{type}}}

the most common attributes assigned to this role
roles which can be assigned multiple/dual 'types' should list those types using the {{{type2}}} parameter

{{{choice}}}

the phase the role commonly submits their action, if any
roles which can submit their action in multiple/dual phases should list those phases using the {{{choice2}}} parameter

{{{status}}}

what normalcy or notability status a role has.
this should be filled in via {{RolePage}} to add the relevant categories.

{{{notes}}}

this parameter can be used to note anything else that is key to the role which is not covered in the previous parameters
note: this parameter is optional, and should only be used if necessary; the notes section is not used to describe the role, as this information should be included in the wiki page

{{{via_rolepage}}}

should be omitted entirely when {{role}} is used directly; used by {{RolePage}} to track the usage of role templates

{{{demopage}}}

should normally be omitted; setting to Template:Role suppresses all categories
this parameter is used to prevent the template generating categories on things that are not rolepages, e.g. the examples on this page use {{role}} but shouldn't put the page into the role categories as a consequence

Examples

What you type What it looks like
{{role
|image=
|alias=
|color= 
|align= 
|type= 
|choice= 
|notes= 
}}
Role
Alias: none
Alignment: any
Role type: not defined
Choice: none
{{role
|image= T-vanilla.png
|alias= Seer
|color= {{rgb|town}}
|align= Pro-town
|type= Investigative
|choice= Night
|notes= 
}}
Role
T-vanilla.png
Alias:
  • Seer
Alignment:
Role type:
  • Investigative
Choice:
  • Night
{{role
|image= M-fallenangel.png
|color= {{rgb|mafia}}
|alias= Archangel
|alias2= Sorceror
|align= Pro-town
|align2= Anti-town
|type=  Protective
|type2= Investigative
|type3= Killing
|choice= Night
|choice2= Day
|notes= this is an example of notes
}}
Role
M-fallenangel.png
Aliases:
  • Archangel
  • Sorceror
Alignment:
Role type:
  • Protective
  • Investigative
  • Killing
Choice:
  • Night
  • Day
Notes: this is an example of notes