Template:Rank View history

m (fixed typo)
(reword headlights required entry to flow better.)
 
(35 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{#switch: {{lc:{{{1|}}} }}
<!-- The values in the table are laid out as follows:
| closure = 3<!-- Minimum rank to create or edit a road closure including adding it to an MTE.-->
----
| jb
---- parameter (to select row) = rank or value | all parameters that can select the row | category | description
| junction box = 5<!--Minimum rank to create or edit a junction box.-->
----
| placeautotrust = 2<!-- Minimum rank to not require multiple edits to become trusted-->
---- The entries left of the "=" are the parameter names accepted by the template to select a Rank entry row.
| Placeedits - unpublished<!-- Number of place edits required to be trusted-->
---- Separate each parameter name that can select the row with the vertical bar.
| Placeexternal - 3<!-- Minimum rank to add an external provider to a place-->
---- Keep them in lower case only.
| mte - 1<!--Minimum rank to create or edit an MTE-->
---- Include spellings with and without spaces.
| routing - 4<!--Minimum rank to change preferred or unpreferred routing on a segment.-->
----    It is not necessary to show the non-spaced versions on the right (in parameters field),
| city - 4<!--Minimum rank to create a new city (not add an existing city to an object).-->
----        but can be listed if in high demand.
| snapshot - 4<!--Minimum rank to enter snapshot mode.-->
----    It is easier to follow the code in "general use pages" for new editors when spelled out.
| server - 4<!--Minimum rank to see the server selector on the main WME display.-->
----
| {{red|Select a rank parameter listed on the template doc page}}
---- The values after the "=" are the variables available to be returned from Rank/Core.
}}<noinclude>
---- Use one of the following names as the second parameter in {{Rank}} to get that data from the table.
 
---- "value" is the editor rank or value related to that parameter.
<!-- This category is only for the template itself -->
---- "parameters" is the list of one or more parameters that can be used as the first parameter passed in {{Rank}}.
[[Category:Templates]]
----    Include the &nbsp; (no break space) character for spaces in this field only and not in the others.
 
---- "category" is the name used for readers of the wiki to define the area of the rank related entry.
</noinclude><noinclude>{{documentation}}</noinclude>
---- "description" is the common text field to be used in the two different wiki user and wiki editor table views.
----    It should be worded to be consistent with the other descriptions.
----    Do not include punctuation as the two subpage template tables take care of what is necessary.
----    {{Rank/Table1}} just adds a period at the end.
----    {{Rank/Table2}} adds the editor rank or value to the end of the sentence and adds a period.
----
----
--><includeonly><!--includeonly here prevents error display on the template page when viewed directly
-->{{#switch: {{lc:{{{1|}}} }}<!--
------ lc template forces the sent parameter to lower case, so be sure to create the left entries as lc.
------ The "parameters" entered in the table can be any case as desired since it will be forced to lower case.
------
-->
| area manager | areamanager | am = {{Rank/Core|{{{2|value}}}|3|[[Area&nbsp;Manager]]<br />AM|Area Manager (AM)|The minimum editor rank (typically) required to receive area manager status}}<!--
-->
| change street name daily | changestreetnamedaily = {{Rank/Core|{{{2|value}}}|30|Change&nbsp;Street&nbsp;Name&nbsp;Daily|Street Name - Daily changes|When the editor rank is less than {{Rank/csnu}}, the number of street name changes that can be completed per day}}<!--
---- ***************************************************
---- For value changes on "Change Street Name Unlimited"
---- change the {{Rank/csnu}} template value.
---- *************************************************** -->
| change street name unlimited | changestreetnameunlimited = {{Rank/Core|{{{2|value}}}|{{Rank/csnu}}|Change&nbsp;Street&nbsp;Name&nbsp;Unlimited|Street Name - Daily unlimited|The minimum editor rank to change an unlimited number of street names per day}}<!--
-->
| city | city new | citynew = {{Rank/Core|{{{2|value}}}|4|City<br />City&nbsp;New|City - Add new|The minimum editor rank to create a [[Editing_restrictions#New_city_name_lock|new city]] (not add an existing city to an object)}}<!--
-->
| city rename | cityrename = {{Rank/Core|{{{2|value}}}|a [[CM]]|City&nbsp;Rename|City - Rename|The minimum editor rank to change the name of a city, and thus the name displayed in the address of every segment and venue that uses it}}<!--
-->
| close ur | closeur | ur close | urclose = {{Rank/Core|{{{2|value}}}|2|Close&nbsp;UR<br />UR Close|Update Request (UR)|The minimum editor rank required to close an [[Update Request]] not created by oneself}}<!--
-->
| closure | rtc = {{Rank/Core|{{{2|value}}}|3|Closure<br />RTC|Real Time Closure (RTC)|The minimum editor rank to create or edit a [[Real Time Closure]] (RTC) including adding it to a [[Major Traffic Event]] (MTE)}}<!--
-->
| delete segment | deletesegment | segmentdelete | segment delete = {{Rank/Core|{{{2|value}}}|2|Delete&nbsp;Segment|Segment - Delete|The minimum editor rank to delete a segment not created by oneself}}<!--
-->
| delete segment daily | deletesegmentdaily = {{Rank/Core|{{{2|value}}}|10|Delete&nbsp;Segment&nbsp;Daily|Segment - Delete daily|When the editor rank is less than {{Rank/dsu}}, the number of segments that can be deleted per day}}<!--
---- ***************************************************
---- For value changes to "Delete Segment Unlimited"
---- change the {{Rank/dsu}} template value.
---- *************************************************** -->
| delete segment unlimited | deletesegmentunlimited = {{Rank/Core|{{{2|value}}}|{{Rank/dsu}}|Delete&nbsp;Segment&nbsp;Unlimited|Segment - Delete unlimited|The minimum editor rank to delete an unlimited number of segments not created by oneself}}<!--
-->
| difficult turn | dt | difficultturn = {{Rank/Core|{{{2|value}}}|3|Difficult&nbsp;Turn<br />DT|Difficult turn|The minimum editor rank to set a difficult turn}}<!--
-->
| headlights required | headlightsrequired | headlights = {{Rank/Core|{{{2|value}}}|4|Headlights&nbsp;Required<br />Headlights|Headlights required|The minimum editor rank to edit the segment attribute for headlights required}}<!--
-->
| hn | hnf | force | house number force = {{Rank/Core|{{{2|value}}}|2|House&nbsp;Number&nbsp;Force<br />Force<br />HN<br />HNF|House Number - Force|The minimum editor rank to be able to force house numbers to save}}<!--
-->
| jb | junction box | junctionbox = {{Rank/Core|{{{2|value}}}|4|Junction&nbsp;Box<br />JB|Junction Box|The minimum editor rank to create or edit a junction box}}<!--
-->
| lanes = {{Rank/Core|{{{2|value}}}|3|Lanes|Lane guidance|The minimum editor rank to add or edit lane guidance}}<!--
-->
| mte = {{Rank/Core|{{{2|value}}}|2|MTE|MTE - Create or edit|The minimum editor rank to create or edit a [[Major Traffic Event]] (MTE)}}<!--
-->
| place auto trust | placeautotrust = {{Rank/Core|{{{2|value}}}|2|Place&nbsp;Auto&nbsp;Trust|Place - Automatically trusted rank|The minimum editor rank not requiring multiple edits to become trusted}}<!--
-->
| place edits | placeedits = {{Rank/Core|{{{2|value}}}|currently unpublished|Place&nbsp;Edits|Place - Approved edits to be trusted|The minimum number of approved edits required before being trusted}}<!--
-->
| place external | placeexternal = {{Rank/Core|{{{2|value}}}|2|Place&nbsp;External|Place - Add external provider|The minimum editor rank to add an external provider to a place}}<!--
-->
| placeflag | place flag | placeflagapproval | place flag approval = {{Rank/Core|{{{2|value}}}|2|Place&nbsp;Flag<br />Place&nbsp;Flag&nbsp;Approval|Place - Flagged content needing approval|The minimum editor rank required to approve flagged content}}<!--
-->
| routing = {{Rank/Core|{{{2|value}}}|4|Routing|Routing - Preferred or unpreferred|The minimum editor rank to change preferred or unpreferred routing on a segment}}<!--
-->
| rrc | railroad crossing | railroadcrossing = {{Rank/Core|{{{2|value}}}|4|Railroad&nbsp;Crossing<br />RRC|Railroad crossing (RC)|The minimum rank to add a [[Railroad crossing]]}}<!--
-->
| shield = {{Rank/Core|{{{2|value}}}|4|Shield|Shield|The minimum editor rank to add or edit a shield image assigned to a street ID (name/city pair)}}<!--
-->
| turn instruction | turninstruction| turn instructions | turninstructions = {{Rank/Core|{{{2|value}}}|4|Turn&nbsp;Instruction|Turn instruction|The minimum editor rank to add or edit a custom turn instruction on a turn}}<!--
-->
| #default = An invalid parameter was passed to the {{tl|Rank}} template.
<!---->
}}</includeonly><noinclude>{{documentation|Template:Rank/doc}}<!--
Add categories and interwikis to the /doc subpage, not here!
--></noinclude>

Latest revision as of 20:08, 29 August 2022

Documentation icon Template documentation[view] [edit] [history] [purge]

This template is a part of a suite of subpage templates (listed below) used to manage and maintain all the key minimum editor rank numbers for the various object types and permissions used in WME to control editing restrictions.

Usage

The primary use of this template is to provide the editor rank or value associated with a restricted feature. The simple use of this template is described here. The template has additional parameters intended for the use in the documentation management, but can be used in the rest of the Wazeopedia as needed. Those advanced parameters and usage are covered later in this document.

Usage example:

{{rank | closure}}

Returns:

3


And would be used in a statement like:

Usage example:

The minimum rank to create or edit a road closure is {{rank | closure}}.

Returns:

The minimum rank to create or edit a road closure is 3.


To describe a range using the template, simply change the phrase around the number.

Usage example:

The editor must be rank {{rank | closure}} or higher to create or edit a road closure.

Returns:

The editor must be rank 3 or higher to create or edit a road closure.


Basic parameters

The table below indicates the basic parameters and the resulting returns. The parameters are case insensitive meaning you can enter any case in the template itself. They are listed here with variable case only to help clarify the terms used. In some cases there are multiple parameters available for the same editor rank restriction. Click the black arrows in the header to change the sort order of any column.

Parameter(s)
(case insensitive)
Result Description
Area Manager
AM
3 The minimum editor rank (typically) required to receive area manager status.
Change Street Name Daily 30 When the editor rank is less than 2, the number of street name changes that can be completed per day.
Change Street Name Unlimited 2 The minimum editor rank to change an unlimited number of street names per day.
City
City New
4 The minimum editor rank to create a new city (not add an existing city to an object).
City Rename a CM The minimum editor rank to change the name of a city, and thus the name displayed in the address of every segment and venue that uses it.
Close UR
UR Close
2 The minimum editor rank required to close an Update Request not created by oneself.
Closure
RTC
3 The minimum editor rank to create or edit a Real Time Closure (RTC) including adding it to a Major Traffic Event (MTE).
Delete Segment 2 The minimum editor rank to delete a segment not created by oneself.
Delete Segment Daily 10 When the editor rank is less than 3, the number of segments that can be deleted per day.
Delete Segment Unlimited 3 The minimum editor rank to delete an unlimited number of segments not created by oneself.
Difficult Turn
DT
3 The minimum editor rank to set a difficult turn.
Headlights Required
Headlights
4 The minimum editor rank to edit the segment attribute for headlights required.
House Number Force
Force
HN
HNF
2 The minimum editor rank to be able to force house numbers to save.
Junction Box
JB
4 The minimum editor rank to create or edit a junction box.
Lanes 3 The minimum editor rank to add or edit lane guidance.
MTE 2 The minimum editor rank to create or edit a Major Traffic Event (MTE).
Place Auto Trust 2 The minimum editor rank not requiring multiple edits to become trusted.
Place Edits currently unpublished The minimum number of approved edits required before being trusted.
Place External 2 The minimum editor rank to add an external provider to a place.
Place Flag
Place Flag Approval
2 The minimum editor rank required to approve flagged content.
Routing 4 The minimum editor rank to change preferred or unpreferred routing on a segment.
Railroad Crossing
RRC
4 The minimum rank to add a Railroad crossing.
Shield 4 The minimum editor rank to add or edit a shield image assigned to a street ID (name/city pair).
Turn Instruction 4 The minimum editor rank to add or edit a custom turn instruction on a turn.


Advanced template parameters

The {{Rank}} template uses the following unnamed parameters:

  • Parameter 1 = One of the "Rank" parameters from the first table like city.
  • Parameter 2 = One of the following values:
    • |value or no parameter returns the value of the rank parameter from the table, typically a rank number like 4.
    • |parameters returns the list of all valid parameters for that entry, like city and city new.
    • |category returns the category description of the Rank entry used in the Map editor table, like City - Add new.
    • |description returns the description of the entry without punctuation or the value, like The minimum editor rank to create a new city (not add an existing city to an object)

Usage example:

{{rank | city | description}}

Returns:

The minimum editor rank to create a new city (not add an existing city to an object)

Maintenance

Updates to the Editor Rank dataset is done directly in the {{Rank}} template. That one location feeds all sources of that information, so Wiki editors don't need to update multiple locations. This ensures synchronization.

Public table view

The list of parameters is useful for Wiki editors, but mostly useless for end users. For that reason, the public view of these parameters is better presented as categories with the descriptions including the value of the parameter. For those reasons, a second table was created for use on Editing restrictions#Rank table. Expand the table below to see the public view. Click on the black arrows in the header to change the sort order.

Rank Image feature

This template suite includes a shortcut to displaying the Rank icon associated with a feature restriction. The only required (unnamed) parameter is the editing restriction name from the Rank table. Optional parameters include:

  • |image= - The two image types available as |image=big (the default with background) or |image=small (no background).
  • |pixels= - Size of the image in pixels (do not include the px unit name). It will default to 60px.
  • |alt= - The alternate hover-over text to be displayed.

Usage example:

{{Rank/Image | headlights}}

Returns:

Usage example:

{{Rank/Image | headlights| image = small | pixels = 40 | alt = Rank {{Rank|headlights}} editor}}

Returns:

Rank 4 editor

Rank message box feature

This template suite includes an associated "important" message box for displaying the description of the rank restriction in a Wazeopedia page that is discussing that feature where it would be helpful for an editor to know in advance that they can or cannot modify that feature. It would typically be used on a page that talks about the feature, but does not get into the details of the rank restrictions. The icon in the box is associated with the rank of the restriction.

The only required (unnamed) parameter is the editing restriction name from the Rank table. One optional parameter is:

  • |As of = Date - Uses the {{As of}} template to add a date to the beginning of the message.

Usage example:

{{Rank/Mbox | headlights}}

Returns:

The minimum editor rank to edit the segment attribute for headlights required is 4.
Rank 4 Wazer

Usage example:

{{Rank/Mbox | house number force | As of = November 2021}}

Returns:

As of November 2021: The minimum editor rank to be able to force house numbers to save is 2.
Rank 4 Wazer

Features without a minimum rank

The following features previously had a minimum rank associated with them, but do not anymore:

  • Cameras

Related templates

This template suite includes the following templates:

  • {{Rank}} - The primary template used to return values from the editor Rank database
  • {{Rank/Core}} - Translates the fields of the Rank dataset into variables used in the templates
  • {{Rank/Table1}} - View of parameters for Wiki editors
  • {{Rank/Table1Row}} - Simplification for creating table1
  • {{Rank/Table2}} - View of parameters for Map editors, as used in the editing restrictions page
  • {{Rank/Table2Row}} - Simplification for creating table2
  • {{Rank/Table2Description}} - Simplification for creating table2 descriptions
  • {{Rank/Image}} - Shortcut to producing associated Wazer images
  • {{Rank/Mbox}} - Creates an "important" message box noting the restriction to the rank for the named feature


These two templates were created to avoid recursive template loops in the template suite where the value inside the template is used for another entry in the template. When making updates to values in the {{Rank}} template, there are instructions for the editor about these two entries. These templates should not be called directly outside of the {{Rank}} template. Instead, just call the main template with {{Rank| delete segment unlimited}} or {{Rank| change street name unlimited}}.

  • {{Rank/dsu}} - Special template holding the "Delete Segment Unlimited" value used inside the template suite
  • {{Rank/csnu}} - Special template holding the "Change Street Name Unlimited" value used inside the template suite

See also

  • {{Drive expiration}} - Identifies the number of days before a drive expires from a user's editable area.
  • Minimum (disambiguation) - Lists all the elements that have a minimum value associated with them. It can be a distance or a rank.
The above documentation is transcluded from Template:Rank/doc.
Subpages of this template.