?????????? : TemplateData

?????????? ??

What is TemplateData? [ ?????? ???? ]

TemplateData is the standardized description of a template, used by VisualEditor to improve the template-editing experience for the user. VisualEditor includes a wizard to edit templates, but for the wizard to be most useful, it needs to present specific information to the user about each template, such as a short description of the template's purpose and its parameters. This information is codified formally (by any wiki editor) using TemplateData.

Editing without TemplateData [ ?????? ???? ]

Without TemplateData, each parameter needs to be added manually when inserting a new template.

No information is provided about what the value of the parameter should be.

Editing with TemplateData [ ?????? ???? ]

With TemplateData, a list of supported parameters (and their description) is provided for the template.

TemplateData provides context for each parameter, and makes it much easier for users to modify templates.

Adding TemplateData [ ?????? ???? ]

Anyone can help by adding TemplateData to templates (particularly high-profile ones, such as infoboxes ) so that they are easier to edit in VisualEditor. The following is a minimal example, placed on a template's documentation page:

<
templatedata
>
{

  "description"
:
 "insert description here"
,

  "params"
:
 {

    "first parameter"
:
 {

      "label"
:
 "x"
,

      "description"
:
 "x"
,

      "type"
:
 "string"
,

      "default"
:
 "default value"
,

      "required"
:
 false

    }

  }

}
<
/templatedata>

You can also add or edit TemplateData using a GUI, by pressing the following button which appears at the top of the edit page: Manage TemplateData

The TemplateData tutorial explains in detail how to add TemplateData information to a template.

Commonly used templates [ ?????? ???? ]

Here is a list of the most commonly-used templates. When you've added TemplateData to one, add a {{ tick }} mark next to it; we'll update the list with new additions as we go. It's advisable to do a null edit on the main template page to force the system to update the database.

For completed items , consult the bot-generated logging page ??????????:VisualEditor/TemplateData/List .

If you complete an item , mark it here with {{tick}} until the item appears on the logging page .

If you partly complete an item (suggested action), mark the entry with {{yellow tick}} and replace its <!--note--> field with a brief description of what has and/or remains to be done. Partly-done items will appear on the logging page as if they were completed, but do not remove them from this list until they are completed.

Legend
checkY : Completed
YesY : Partly completed
N : Done with structural faults; as good as not done

Over 5,000 uses in mainspace [ ?????? ???? ]

  • checkY
  • 961,481
  • Coord
  • VE does not allow overloaded templates

Infobox template (>5,000 uses) [ ?????? ???? ]

250 to 5,000 uses in mainspace [ ?????? ???? ]

Userspace (high-priority) [ ?????? ???? ]

Used as meta-templates [ ?????? ???? ]

Used in other namespaces [ ?????? ???? ]

Low-use templates [ ?????? ???? ]

Main-space templates [ ?????? ???? ]

Following are templates which taking parameters but are used <250 times. There are thousands of templates which contain only content for transclusion and which take no parameters. These are not considered here.

Orphans [ ?????? ???? ]

Following have no instances of use:

??? ???? ??? [ ?????? ???? ]