Template:Rank/doc

This is a documentation subpage for . 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 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.
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.

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 are 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 as rank values change. This ensures synchronization. However, if a new row corresponding to a new WME feature is added to the rank table, a new row should also be added to

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.

and {Rank/Table2}} in order for this feature to appear in the rank template's documentation.

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

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.

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.