Template:Rank/doc View history

(→‎Parameters: temp disable new table)
(Instruction updates for new template suite)
Line 1: Line 1:
{{doc subpage}}
{{doc subpage}}
<!-- ADD DOCUMENTATION BELOW THIS LINE -->
<!-- ADD DOCUMENTATION BELOW THIS LINE -->
This template is built to maintain all the key minimum rank numbers for the various object types and permissions.
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.


== Usage ==
== Usage ==
Line 43: Line 43:
**********************************************************************
**********************************************************************
**********************************************************************
**********************************************************************
When adding new parameters to this table, be sure to update the table at
When adding new parameters to this table, be sure to update the table
[[Editing_restrictions#Rank_table]]
in the main template {{Rank}}.
**********************************************************************
**********************************************************************
**********************************************************************-->
**********************************************************************-->
{| Class="wikitable sortable"
{{Rank/Table1}}
|-
! Parameter<br />{{small|(case insensitive)}}
! Result
! Description
|-
| AM<br />Area&nbsp;Manager
| style="text-align: center;" | {{Rank|am}}
| Minimum editor rank (typically) required to receive area manager status.
|-
| City
| style="text-align: center;" | {{Rank|city}}
| Minimum editor rank to create a new city (not add an existing city to an object).
|-
| CityRename
| style="text-align: center;" | {{Rank|cityrename}}
| 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&nbsp;UR
| style="text-align: center;" | {{Rank|urclose}}
| Minimum editor rank required to close a UR not created by self.
|-
| Closure
| style="text-align: center;" | {{Rank|closure}}
| Minimum [[editor rank]] to create or edit a real time closure (RTC) including adding it to an MTE.
|-
| Delete&nbsp;Segment
| style="text-align: center;" | {{Rank|segmentdelete}}
| Minimum [[editor rank]] to delete a segment not created by self.
|-
| Delete&nbsp;Segment&nbsp;Daily
| style="text-align: center;" | {{Rank|delete segment daily}}
| Number of segments that can be deleted per day when editor rank is less than {{Rank|Delete Segment Unlimited}}.
|-
| Delete&nbsp;Segment&nbsp;Unlimited
| style="text-align: center;" | {{Rank|delete segment unlimited}}
| Minimum editor rank to delete an unlimited number of segments not created by self.
|-
| DT<br />Difficult Turn
| style="text-align: center;" | {{Rank|difficultturn}}
| Minimum [[editor rank]] to set a difficult turn.
|-
| Headlights&nbsp;Required
| style="text-align: center;" | {{Rank|headlights required}}
| Minimum editor rank to edit the headlights required attribute of a segment.
|-
| HN<br />House Number Force
| style="text-align: center;" | {{Rank|force}}
| Minimum editor rank to be able to [[House_Numbers_in_WME#Errors_you_can_force|force house numbers]] to save.
|-
| JB<br />Junction Box
| style="text-align: center;" | {{Rank|jb}}
| Minimum editor rank to create or edit a junction box.
|-
| Lanes
| style="text-align: center;" | {{Rank|lanes}}
| Minimum editor rank to add or edit lane guidance.
|-
| MTE
| style="text-align: center;" | {{Rank|mte}}
| Minimum editor rank to create or edit a Major Traffic Event (MTE).
|-
| PlaceAutoTrust
| style="text-align: center;" | {{Rank|placeautotrust}}
| Minimum editor rank not requiring multiple edits to become trusted.
|-
| PlaceEdits
| style="text-align: center;" | {{Rank|placeedits}}
| Number of approved place edits required before being trusted.
|-
| PlaceExternal
| style="text-align: center;" | {{Rank|placeexternal}}
| Minimum editor rank to add an external provider to a place.
|-
| PlaceFlag<br />PlaceFlagApproval
| style="text-align: center;" | {{Rank|placeflagapproval}}
| Minimum editor rank required to approve flagged content.
|-
| Routing
| style="text-align: center;" | {{Rank|routing}}
| Minimum editor rank to change preferred or unpreferred routing on a segment.
|-
| RRC<br />Railroad Crossing
| style="text-align: center;" | {{Rank|rrc}}
| Minimum rank to add a [[Railroad crossing]].
|-
| Shield
| style="text-align: center;" | {{Rank|shield}}
| Minimum editor rank to add or edit a shield image assigned to a street ID (name/city pair).
|-
| Turn Instruction
| style="text-align: center;" | {{Rank|turn instruction}}
| Minimum editor rank to add or edit a custom turn instruction on a turn.
|}


<!--
== Maintenance ==
New table
Updates to the Editor Rank dataset is done directly in the {{tl|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.
 
{{Expand|{{Rank/Table2}}}}


{{Rank/Table1}}
== Related templates ==
-->
This template suite includes the following templates:
* {{tl|Rank}} - The primary template used to return values from the editor Rank database
* {{tl|Rank/Core}} - Translates the fields of the Rank dataset into variables used in the templates
* {{tl|Rank/Table1}} - View of parameters for Wiki editors
* {{tl|Rank/Table1Row}} - Simplification for creating table1
* {{tl|Rank/Table2}} - View of parameters for end users
* {{tl|Rank/Table2Row}} - Simplification for creating table2
* {{tl|Rank/Table2Description}} - Simplification for creating table2 descriptions


== See also ==
== See also ==

Revision as of 15:18, 12 August 2022

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

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.

Usage

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.


Parameters

The table below indicates the accepted parameters and the resulting returns. The parameters are case insensitive. They are listed here with variable case only to help clarify the terms used.

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.
Far Lanes
FL
4 The minimum editor rank to edit lane guidance on a far 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).
Path 4 The minimum editor rank to create or edit a path.
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.


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 Expand for details on


{{

Category Description
Area Manager (AM)
The minimum editor rank (typically) required to receive area manager status is 3.
City - Add new
The minimum editor rank to create a new city (not add an existing city to an object) is 4.
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 is a CM.
Update Request (UR)
The minimum editor rank required to close an Update Request not created by oneself is 2.
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) is 3.
Segment - Delete
The minimum editor rank to delete a segment not created by oneself is 2.
Segment - Delete daily
When the editor rank is less than 3, the number of segments that can be deleted per day is 10.
Segment - Delete unlimited
The minimum editor rank to delete an unlimited number of segments not created by oneself is 3.
Difficult turn
The minimum editor rank to set a difficult turn is 3.
Far lanes
The minimum editor rank to edit lane guidance on a far turn is 4.
Headlights required
The minimum editor rank to edit the segment attribute for headlights required is 4.
House Number - Force
The minimum editor rank to be able to force house numbers to save is 2.
Junction Box
The minimum editor rank to create or edit a junction box is 4.
Lane guidance
The minimum editor rank to add or edit lane guidance is 3.
MTE - Create or edit
The minimum editor rank to create or edit a Major Traffic Event (MTE) is 2.
Path
The minimum editor rank to create or edit a path is 4.
Place - Automatically trusted rank
The minimum editor rank not requiring multiple edits to become trusted is 2.
Place - Approved edits to be trusted
The minimum number of approved edits required before being trusted is currently unpublished.
Place - Add external provider
The minimum editor rank to add an external provider to a place is 2.
Place - Flagged content needing approval
The minimum editor rank required to approve flagged content is 2.
Routing - Preferred or unpreferred
The minimum editor rank to change preferred or unpreferred routing on a segment is 4.
Railroad crossing (RC)
The minimum rank to add a Railroad crossing is 4.
Shield
The minimum editor rank to add or edit a shield image assigned to a street ID (name/city pair) is 4.
Street Name - Daily changes
When the editor rank is less than 2, the number of street name changes that can be completed per day is 30.
Street Name - Daily unlimited
The minimum editor rank to change an unlimited number of street names per day is 2.
Turn instruction
The minimum editor rank to add or edit a custom turn instruction on a turn is 4.
}}

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 end users
  • {{Rank/Table2Row}} - Simplification for creating table2
  • {{Rank/Table2Description}} - Simplification for creating table2 descriptions

See also

  • {{Drive expiration}} - Identifies the number of days before a drive expires from a user's editable area.