Template:AM/doc View history

m (decomplexifying)
(→‎AM/Editor: added documentation fir gho and pic parameters)
Line 33: Line 33:


Any field (besides the Editor name) can be skipped, but the pipe character must be present.
Any field (besides the Editor name) can be skipped, but the pipe character must be present.
There are two '''optional''' named parameters for displaying a Google Hangout avatar, and nickname.
* {{Para|gho|GHO DISPLAY NAME}} - When used it will display this name in gray on a new line below the username. It can be placed after the comments or badge parameters.
* {{Para|pic|File:Avatar USERNAME.png}} - When used will display the image you provide to the left of your GHO name. If not used a default Google style color tile with your initial will be shown instead.


Example:
Example:

Revision as of 23:13, 17 September 2015

This is a documentation subpage for Template:AM.
It contains usage information, categories and other content that is not part of the original template page.

This template is a suite of subpage templates that build an Area Manager table.

Subpages

The following subpages are used to build an Area Manager table.

  • {{AM/Top}} - Top of the template: controls column headings/widths and top colors; also automatically includes the Regional Coordinators.
  • {{AM/Country}} - Country Managers heading with optional State Name as first parameter
  • {{AM/State}} - Statewide Area Managers heading with optional State Name as first parameter
  • {{AM/Area}} - Area Managers heading
  • {{AM/AreaLink}} - Area Managers heading w/link to edit {{{{RootPage}}/AM/Editor/Area}}
  • {{AM/Area2Link}} - Other Area manager table heading w/link to edit {{{{RootPage}}/AM/Editor/Area2}}
  • {{AM/Bottom}} - Bottom the the template
  • {{AM/Colspan}} - Variable used to span columns for headers
  • {{AM/Editor}} - Area/Country Manager template
  • {{AM/Badge}} - Badges for Area Manager table with color coding; details below

The automatic pagename elements in the table uses {{RootPage2}} to ensure the correct pagename is determined, so the template must be built on a page that has a valid state or territory (or USA) as the base pagename.

Valid examples:

  • USA/CommonState
  • Arizona
  • Arizona/Test
  • Puerto Rico

AM/Editor

The {{AM/Editor}} has four unnamed parameters in the following order:

  • Editor name
  • Editor rank
  • Area Managed
  • Comments

Any field (besides the Editor name) can be skipped, but the pipe character must be present.

There are two optional named parameters for displaying a Google Hangout avatar, and nickname.

  • |gho=GHO DISPLAY NAME - When used it will display this name in gray on a new line below the username. It can be placed after the comments or badge parameters.
  • |pic=File:Avatar USERNAME.png - When used will display the image you provide to the left of your GHO name. If not used a default Google style color tile with your initial will be shown instead.

Example:

{{AM/Editor|WazingTime||Statewide|}}

Produces:

Username Area Managed Comments
WazingTime [PM]  Statewide


AM/Badge

The {{AM/Badge}} templates are added to the {{AM/Editor}} template lines. A senior editor can also display one of the following forum badges in the comments section (up to three) with the first badge providing the color background for the editor's entry. The named parameters (|badge1= |badge2= |badge3= |badge4= |badge5=) should follow the unnamed parameters (e.g. user name, rank, area managed, comment). Make the first badge that of the desired color for the user's background color.

GC or Global Champ
LC or Local Champ
RC or Regional Coordinator
CM or Country Manager
SM or State Manager
MGC or Mentor Global Champ
MLC or Mentor Local Champ
M or Mentor
AM or Area Manager


MR or Map Raider - Note: this badge is not to be used in the AM tables, it is added to this template to support off-label use of this template suite for MapRaid! team list tables


Example:

{{AM/Editor|WazingTime|6|Statewide|Mostly Northern California|badge1=gc}}
{{AM/Editor|Wazzzzzz|6|Statewide|Mostly Southern California|badge1=mgc|badge2=gc}}
{{AM/Editor|BigCheeze|5|Statewide|Mostly Central California|badge1=rc|badge2=mlc|badge3=lc}}
{{AM/Editor|CountryGuru|5|Country Manager|East coast|badge1=cm}}
{{AM/Editor|StateMan|5|State Manager|Southern California|badge1=sm}}

Produces:

Username Area Managed Comments
WazingTime(6) [PM]  Statewide
Mostly Northern California
Wazzzzzz(6) [PM]  Statewide
Mostly Southern California
BigCheeze(5) [PM]  Statewide
Mostly Central California
CountryGuru(5) [PM]  Country Manager
East coast
StateMan(5) [PM]  State Manager
Southern California


Usage

Place the various templates in order using them like building blocks on the page.

{{AM/Top}}
{{AM/Country}}
{{AM/Editor|kentsmith9|6|California|Bay Area resident|badge1=gc}}

{{AM/State}}
{{AM/Editor|FastWazer|5|Bay Area|Live in Bay Area}}

{{AM/Area}}
{{AM/Editor|OtherWazer1|4|Fremont|}}
{{AM/Editor|NewWazer|3|San Jose|Some travel to Hawaii}}
{{AM/Editor|AnotherWazer|3|San Francisco|Also Eureka}}
{{AM/Bottom}}

(Note: The extra line breaks will appear in the table as blank extra whitespace rows in the row above the blank line. They are here for simplifying the table visually.)

Parameters

The {{AM/Country}} and {{AM/State}} templates will automatically detect the page name and use that as the state to decide what region should be displayed. If the Area Manager template suite is used on a page with a name not covered in {{RC/Data}}, a parameter can be sent with the State name (spelled out or abbreviated) as in {{AM/State|California}}.


Example table

MA — Area, State and Country Managers
Regional Coordinator(s): orbitc (PM) and Banished (PM)
Username Area Managed Comments
Country Managers (New England region)
(Click here to create initial Country and State sections of table)
Rank6Example(6) [PM]  Statewide
Resident of state
Rank6Too(6) [PM]  Statewide
Longtime resident of state
State Managers (New England region)
Rank5Example(5) [PM]  Statewide
Resident of state
Rank5Too(5) [PM]  Statewide
Working in state now
CountryGuru(5) [PM]  Vacation here
Country Manager
Area Managers
OtherWazer1(4) [PM]  Named County
I also cover CityName
WazerHolic(4) [PM]  Another County I don't got to show no stinking badges!
AnotherWazer(3) [PM]  San Francisco Also Eureka
NewWazer(3) [PM]  San Jose Some travel to Hawaii
UserName [PM]