Template:Edit/doc
This is a Template documentation subpage for Template:Edit. It contains usage information, categories and other content that is not part of the original Template page. |
This template is used on many pages. To avoid large-scale disruption and unnecessary server load, any changes to this template should first be tested in its /sandbox or /testcases subpages or in your own user subpage. The tested changes can then be added to this page in one single edit. Please consider discussing any changes on the talk page before implementing them. |
It provides a clickable link to edit a page, or a section of the page.
Usage
{{Edit |1= |2= |section= |editintro= |preload= |preloadtitle= |tooltip= }}
- 1: the page to edit. If omitted, it will be the current page.
- 2: the label text of the edit link. If omitted, it is "edit" by default.
- section: the section to edit, in which
0
for the top (i.e. lead section),1
for the first (sub-)section, andnew
for adding a new section. - editintro: the content of a page/template that will be transcluded above the edit box when you edit the page. Usually used to load template messages.
- preload: the content of a page/template that will be preloaded into the text area of the edit form. It works only if the page to be edited does not exist.
- preloadtitle: if making a new section (i.e.
|section=new
), the title to be preloaded into the title box of the edit form. - tooltip: the text to display when you hover over the link.
Notes:
- All parameters are optional.
- The parameter names must be in lowercase or they will fail.
Examples
Code | Output | Notes |
---|---|---|
{{edit}} | Edit current page | |
{{edit| |edit template doc}} | ||
{{edit|1=Infobox foo|2=E}} | ||
{{edit|2=edit template doc}} | ||
{{edit|friendship}} | Edit the article friendship | |
{{edit|friendship|section=3}} | Edit the third order of a (sub-)section of the article friendship, which is 1.2 Adolescence as of 10 Jan 2020 | |
{{edit|Draft:Sandbox|editintro=Template:Disambig editintro}} | Load {{Disambig editintro}} when you edit | |
{{edit|Template:Some new template|preload=Template:Documentation/preload}} | Preload the whoole content of {{Documentation/preload}} when you create a new template | |
{{edit|Wikipedia talk:Sandbox|section=new||preloadtitle=Custom title of the new section}} | Create a new section of a custom title | |
{{edit|2=link with tooltip|tooltip=This is a tooltip}} | Hover over the link to see the tooltip |
TemplateData
This is the TemplateData documentation for this template used by VisualEditor and other tools.
Edit
Displays a link to edit a page.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Page | 1 | The page to edit
| Page name | suggested |
Label | 2 | The link label
| String | optional |
Section | section | The section to edit; 0 for the top section; new for a new section
| String | optional |
Edit Intro | editintro | Content that will be rendered above the edit box
| Unknown | optional |
Preload | preload | Content to preload in the edit form when creating a new page or section | Unknown | optional |
Preload title | preloadtitle | If making a new section, preload text into the title box | Unknown | optional |
Tooltip | tooltip | Text to display on mouseover
| String | optional |
Comparison
See also
- {{Navbox}}