Template:Rank/doc View history

(Updated instructions)
(Added content)
Line 4: Line 4:


== Usage ==
== 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 documentation as needed. Those advanced parameters and usage are covered later in this document.
Usage example:
Usage example:


Line 39: Line 41:
== Parameters ==
== 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. Some entries have multiple parameters possible for the same entry. Only use one parameter; don't make the mistake to combine them in the template.
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.
<!--
<!--
---- **********************************************************************
**********************************************************************
---- **********************************************************************
**********************************************************************
---- When changing or adding new parameters to this table, only make the
When adding new parameters to this table, it must be done in the main
---- changes in the main template {{Rank}}. That will drive the changes
{{Rank}} template. The parameters, values and descriptions are all
---- in the separate tables.
edited in that same template.
----
**********************************************************************
---- It may be necessary to purge the two template (edit and save with
**********************************************************************-->
---- no changes) tables after editing the main template data.
---- **********************************************************************
---- **********************************************************************-->
{{Rank/Table1}}
{{Rank/Table1}}
== Other template parameters ==
(coming)


== Maintenance ==
== Maintenance ==
Any updates to the editor rank dataset (values or table text) is done directly in the {{tl|Rank}} template. That one location feeds all sources of that information (including associated tables), so Wiki editors don't need to update multiple locations. This ensures synchronization.
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 ==
== 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 embedded in the sentence. For those reasons, a second table was created for use on [[Editing restrictions#Rank table]]. Expand the table below to see the public 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.
<!--
 
---- **********************************************************************
---- **********************************************************************
---- When changing or adding new parameters to this table, only make the
---- changes in the main template {{Rank}}. That will drive the changes
---- in the separate tables.
----
---- It may be necessary to purge the two template (edit and save with
---- no changes) tables after editing the main template data.
---- **********************************************************************
---- **********************************************************************-->
{{Collapse top | title=Editor Rank Restriction List}}{{Rank/Table2}}{{Collapse bottom}}
{{Collapse top | title=Editor Rank Restriction List}}{{Rank/Table2}}{{Collapse bottom}}


Line 80: Line 72:
* {{tl|Rank/Table2Row}} - Simplification for creating table2
* {{tl|Rank/Table2Row}} - Simplification for creating table2
* {{tl|Rank/Table2Description}} - Simplification for creating table2 descriptions
* {{tl|Rank/Table2Description}} - Simplification for creating table2 descriptions
<br />
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 {{tl|Rank}} template, there are instructions for the editor about these two entries.
* {{tl|Rank/dsu}} - Special template holding the "Delete Segment Unlimited" value used inside the template suite
* {{tl|Rank/csnu}} - Special template holding the "Change Street Name Unlimited" value used inside the template suite


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

Revision as of 01:21, 13 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

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 documentation 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.


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.

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.


Other template parameters

(coming)

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.

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.