Template:Custom edit/doc: Difference between revisions

Revision as of 19:47, 31 January 2022

This subpage contains documentation, categories, or other content that is not part of the template.
To view the template page itself, see Template:Custom edit.

العربية ∙ asturianu ∙ Boarisch ∙ беларуская (тарашкевіца) ∙ български ∙ বাংলা ∙ català ∙ čeština ∙ dansk ∙ Deutsch ∙ Zazaki ∙ Ελληνικά ∙ English ∙ Esperanto ∙ español ∙ eesti ∙ euskara ∙ فارسی ∙ suomi ∙ français ∙ galego ∙ עברית ∙ हिन्दी ∙ hrvatski ∙ magyar ∙ Bahasa Indonesia ∙ italiano ∙ 日本語 ∙ ქართული ∙ 한국어 ∙ кыргызча ∙ Lëtzebuergesch ∙ македонски ∙ മലയാളം ∙ ဘာသာမန် ∙ Bahasa Melayu ∙ Mirandés ∙ မြန်မာဘာသာ ∙ norsk bokmål ∙ Plattdüütsch ∙ Nederlands ∙ norsk ∙ polski ∙ português ∙ português do Brasil ∙ русский ∙ sicilianu ∙ Scots ∙ slovenščina ∙ српски / srpski ∙ svenska ∙ ไทย ∙ Türkçe ∙ українська ∙ اردو ∙ oʻzbekcha / ўзбекча ∙ Tiếng Việt ∙ 中文 ∙ 中文（简体） ∙ 中文（繁體） ∙ 中文（臺灣） ∙ +/−

Provides a custom link for editing a page

Usage

Example: {{custom edit|Commons:Sandbox|'''Play in the sandbox'''}} gives Play in the sandbox.

Note you can use an internationalised text template like {{Support}}:

{{Custom edit|Commons:Sandbox|{{Support}}}}

gives Template:Support.

Template parameters

Parameter	Description		Default	Status
`1`	page	Full pagename of the page to be edited.	{{FULLPAGENAME}}	optional
`text` 2	text	Text to display in the edit link.	edit	optional
`oldid`	old id	Unique identifier number of the page version in its history. Note that this also overrides its current pagename, if that page was moved or if this refers to a version of another page on the same wiki. If that parameter is used, the user will see an additional a warning at top of the edit form, because publishing changes made by the user in this edit session this will revert existing changes already published in the target page after that historic version.	empty	optional
`section`	section	Section name on target page to edit.	empty	optional
`editintro`	edit intro	Full name of a page to render as an introduction or guide just above the edit form.	empty	optional
`preloadtitle`	preload title	Section heading title to preload in the edit form when creating a new section in the target page.	empty	optional
`preload`	preload page	Full name of a page (usually a dedicated template) to transclude into the content edit form when creating a new page or section.	empty	optional

Template data

Parameter text is empty

TemplateData

TemplateData is a way to store information about template parameters (the description of those and of the whole template) for both humans and machines. It is used by VisualEditor and possibly other tools like Upload Wizard.

Existing template documentation
At Wikimedia Commons, it is recommended to use {{TemplateBox}} with either ‎useTemplateData=1 or ‎useTemplateData=only on the ‎/doc subpage and transcluding it with {{Documentation}} into the template. ‎<nowiki>-tags can be wrapped around the arguments, if required, to avoid templates being expanded.

Newly created template documentation and imports
Another option, especially for imported templates, or for users with JSON experience, is placing raw ‎<templatedata>-tags into the Wikitext of the template, as described in various Wikipediae.

Wikipedia's help about TemplateData • Commons-specific information

Provides a custom link for editing a page

Template parameters
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
page	`1`	Full pagename of the page to be edited. Default {{FULLPAGENAME}}	Page name	optional
edit intro	`editintro`	Full name of a page to render as an introduction or guide just above the edit form.	Page name	optional
old id	`oldid`	Unique identifier number of the page version in its history. Note that this also overrides its current pagename, if that page was moved or if this refers to a version of another page on the same wiki. If that parameter is used, the user will see an additional a warning at top of the edit form, because publishing changes made by the user in this edit session this will revert existing changes already published in the target page after that historic version.	Number	optional
preload page	`preload`	Full name of a page (usually a dedicated template) to transclude into the content edit form when creating a new page or section.	Page name	optional
preload title	`preloadtitle`	Section heading title to preload in the edit form when creating a new section in the target page.	Line	optional
section	`section`	Section name on target page to edit.	Line	optional
text	`text` `2`	Text to display in the edit link. Default edit	Page name	optional

Additional information

The template is intended to be used in the following namespaces: all namespaces

The template is intended to be used by the following user groups: all users

Localization

This template is localized by utilizing MediaWiki namespace messages. These can be translated at translatewiki.net (current translations).

@@ Line 1: / Line 1: @@
 {{TemplateBox
+|name=Custom edit
+|shorthand=
+|desc={{LangSwitch
+  | en = Provides a custom link for editing a page
+  | fr = Produit un lien personnalisé pour modifier une page
+  }}
+|usage-notes=
+Example: {{tlx|custom edit|Commons:Sandbox|<nowiki>'''Play in the sandbox'''</nowiki>}} gives {{custom edit|Commons:Sandbox|'''Play in the sandbox'''}}.
+Note you ''can'' use an internationalised text template like {{Tl|Support}}:
+: {{Tlx|Custom edit|Commons:Sandbox|<nowiki>{{Support}}</nowiki>}}
+gives {{Custom edit|Commons:Sandbox|{{Support}}}}.
 |1=1
-|1d=wikilink of page to be edited
+|1type=wiki-page-name
-|1def=
+|1stat=optional
-|1stat=required
+|1label-en=page
-|2=section
+|1d-en=Full pagename of the page to be edited.
-|2d=section name on target page
+|1d-fr=Nom complet de la page à modifier.
-|2def=
+|1def-en=<nowiki>{{FULLPAGENAME}}</nowiki>
+|2=text
+|2aliases=2
+|2type=wiki-page-name
 |2stat=optional
-|3=text
+|2label-en=text
-|3d=text of edit link
+|2d-en=Text to display in the edit link.
+|2d-fr=Texte à afficher dans le lien de modification.
+|2def-en={{lcfirst:{{int:Edit}}}}
+|3=oldid
+|3type=number
+|3stat=optional-
+|3label-en=old id
+|3d-en=Unique identifier number of the page version in its history. Note that this also overrides its current pagename, if that page was moved or if this refers to a version of another page on the same wiki. If that parameter is used, the user will see an additional a warning at top of the edit form, because publishing changes made by the user in this edit session this will revert existing changes already published in the target page after that historic version.
+|3d-fr=Numéro identifiant unique de la version de la page dans son historique. Noter que cela ne tient pas compte de son nom de page actuel ou si cela ce réfère à une version d'une autre page sur le même wiki. Si ce paramètre est utilisé, l'utilisateur verra un avertissement supplémentaire en haut du formulaire de modification, parce que la publication de modifications réalisées par l'utilisateur dans cette session de modification annulera les modifications déjà publiées dans la page cible après cette version historique.
 |3def=
-|3stat=optional
-|name=
+|4=section
-|desc=
+|4type=line
+|4stat=optional-
+|4label-en=section
+|4label-fr=section
+|4d-en=Section name on target page to edit.
+|4d-fr=Nom de la section à modifier dans la page cible.
+|4def=
+|5=editintro
+|5type=wiki-page-name
+|5stat=optional-
+|5label-en=edit intro
+|5label-fr=intro de modif
+|5d=Full name of a page to render as an introduction or guide just above the edit form.
+|5d-fr=Nom complet d'une page à afficher en introduction ou comme guide juste au dessus du formulaire de modification.
+|5def=
+|6=preloadtitle
+|6type=line
+|6stat=optional-
+|6label-en=preload title
+|6label-fr=titre préchargé
+|6d-en=Section heading title to preload in the edit form when creating a new section in the target page.
+|6d-fr=Titre de l'entête de section à précharger dans le formulaire lors de la création d'une nouvelle section dans la page cible.
+|6def=
+|7=preload
+|7type=wiki-page-name
+|7stat=optional-
+|7label-en=preload page
+|7label-fr=page préchargée
+|7d-en=Full name of a page (usually a dedicated template) to transclude into the content edit form when creating a new page or section.
+|7d-fr=Nom complet d'une page (habituellement un modèle dédié) à transclure dans le formulaire de modification du contenu lors de la création d'une nouvelle page ou d'une section.
+|7def=
 |namespace=all
 |usergroup=all
 |placement=
-|usage-notes=Example: {{tlx|1=custom edit|2=Commons:Sandbox|3=text=<nowiki>'''Play in the sandbox'''</nowiki>}} gives {{custom edit|Commons:Sandbox|text={{support}}}}
 |type=
-|example=
-|i18n-method=-
-|i18n-desc=
-|seealso=
 |setscats=
 |lines=one
-|shorthand=
 |relieson=
-}}
+|example=
+|seealso=
+* {{Tl|edit}}
+|i18n-method=mediawiki-msg
+|i18n-mediawiki-msg=Edit
+|i18n-desc=
+|useTemplateData=true
+}}<includeonly>
+[[Category:Internal link templates]]
+<includeonly>