View source for Help:Extension:TemplateWizard

<languages/>
<translate>
== What is TemplateWizard? == <!--T:1-->

<!--T:2-->
[[<tvar name=1>Special:MyLanguage/Extension:TemplateWizard</tvar>|TemplateWizard]] is a MediaWiki {{<tvar name=2>ll|Manual:extensions</tvar>|extension}} that provides a popup window for the [[<tvar name=3>Special:MyLanguage/Extension:WikiEditor</tvar>|WikiEditor]] toolbar to insert templates into <tvar name=4>{{ll|wikitext}}</tvar>.

== How do I use TemplateWizard? == <!--T:5-->

<!--T:6-->
* To use TemplateWizard, open a wiki page for editing using the Wikitext editor (not the 2017 Wikitext editor)
* Place the cursor in the location that you want the template to be inserted. Then click on the puzzle icon <tvar name=icon>[[File:OOjs UI icon puzzle-ltr.svg|20px]]</tvar> in the toolbar - <tvar name=toolbarimage>[[File:TemplateWizard icon.png|400px]]</tvar>
* A dialog window will pop-up

=== How do I find a template? === <!--T:7-->

<!--T:8-->
* Start typing a template's name, and you will be presented with a list of templates to choose from.<br><tvar name=autocomplete>[[File:TemplateWizard help search en.png|400px]]</tvar>
:* Note: Only templates which have TemplateData will have descriptions. You are encouraged to add [[<tvar name=templatedata>Special:MyLanguage/Help:TemplateData</tvar>|TemplateData]] to templates.
* When you find the template you're looking for, click on it (or navigate to it with your arrow keys) and press {{key press|Enter}}. This will take you to the data-entry form.

=== How do I add data for my chosen template? === <!--T:9-->

<!--T:10-->
* The top bar you see now contains the template title, description, a link <tvar name=linkicon>[[File:OOjs UI icon link-ltr-progressive.svg|20px]]</tvar> to the template's wiki page, and a close button <tvar name=closeicon>[[File:OOjs UI icon trash-destructive.svg|20px]]</tvar> to close the template form and return to search.</translate>
<translate>
<!--T:52-->
* The left-side list of parameters, divided into up to three parts for required, suggested, and optional parameters. This area also has a button at the bottom with which to add or remove all non-required fields at once. Note that some templates have no parameters, and in these cases nothing will be listed here. '''When you click on a template parameter, it gets added to the right side.'''</translate>
<translate>
<!--T:49-->
* The right-side form containing the actual data-entry fields into which you put the values that will be added to the wikitext. Only those parameters that are listed here will be inserted into the editing area (including those that contain no value, as templates can treat this differently from the parameter not being present at all).</translate>
<translate>
<!--T:50-->
* You can click on the info icons above the template fields to read more information about them.
</translate>
[[File:TemplateWizard help template en.png|542px]]
<translate>
<!--T:51-->
* TemplateWizard works most effectively with templates that have TemplateData defined: i.e. their parameters have been documented in a detailed and structured way, including default values etc. (information about how to do that is in the [[<tvar name=templatedatahelp>Special:MyLanguage/Help:Extension:TemplateData</tvar>|TemplateData help pages]]). It also works ''without'' TemplateData definitions, although with some reduced functionality. These two modes are described in the next two sections.
</translate>

<div><ul>
<li style="display: inline-block;">[[File:TemplateWizard screenshot 01.png|thumb|<translate><!--T:11--> Only required fields are added by default</translate>]]</li>
<li style="display: inline-block;">[[File:TemplateWizard screenshot 02.png|thumb|<translate><!--T:12--> Popups for field information</translate>]]</li>
<li style="display: inline-block;">[[File:TemplateWizard screenshot 03.png|thumb|<translate><!--T:13--> Auto-complete for page names on the wiki</translate>]]</li>
<li style="display: inline-block;">[[File:TemplateWizard screenshot 04.png|thumb|<translate><!--T:14--> Auto-complete for files from Commons</translate>]]</li>
<li style="display: inline-block;">[[File:TemplateWizard screenshot 05.png|thumb|<translate><!--T:15--> Custom field inputs for dates, long-form text fields, numbers etc.</translate>]]</li>
</ul></div>

<translate>
=== Using TemplateWizard with TemplateData === <!--T:16-->

<!--T:17-->
There are seven different types of field used in TemplateWizard, based on the parameter type defined in the TemplateData.
</translate>

{| class="wikitable"
!
! <translate><!--T:18--> Name<ref group="fn">The name as used in the TemplateData form.</ref></translate>
! <translate><!--T:19--> Type<ref group="fn">The type as used in the TemplateData JSON.</ref></translate>
! <translate><!--T:20--> Field used</translate>
! <translate><!--T:21--> Notes</translate>
|-
| <translate><!--T:22--> 1.</translate> || <translate><!--T:23--> Number</translate> || <code>number</code> || NumberInputWidget || 
|-
| <translate><!--T:24--> 2.</translate> || <translate><!--T:25--> Date</translate> || <code>date</code> || DateInputWidget || 
|-
| <translate><!--T:26--> 3.</translate> || <translate><!--T:27--> User</translate> || <code>wiki-user-name</code> || UserInputWidget || 
|-
| <translate><!--T:28--> 4.</translate> || <translate><!--T:29--> Page</translate> || <code>wiki-page-name</code> || TitleInputWidget || <translate><!--T:30--> For any page name (including files).</translate>
|-
| <translate><!--T:31--> 5.</translate> || <translate><!--T:32--> File</translate> || <code>wiki-file-name</code> || TitleInputWidget || <translate><!--T:33--> Limited to titles in the File namespace, and displayed with thumbnail images.</translate>
|-
| <translate><!--T:34--> 6.</translate> || <translate><!--T:35--> Template</translate> || <code>wiki-template-name</code> || TitleInputWidget || <translate><!--T:36--> Limited to titles in the Template namespace.</translate>
|-
| <translate><!--T:37--> 7.</translate> || <translate><!--T:38--> ''Anything else''</translate> || || TextInputWidget || <translate><!--T:39--> All other types will be displayed as standard text-entry inputs, and will accept any text.</translate>
|-
|colspan="5"|{{reflist|group=fn}}
|}

<translate>
<!--T:40-->
TemplateData itself supports more field types than are listed above. Some of these may be added in <tvar name=phab>{{phab|200664}}</tvar>.

=== Using TemplateWizard without TemplateData === <!--T:41-->

<!--T:42-->
If a template does ''not'' have any TemplateData, then an attempt will be made to guess the names of its parameters, and these will be presented as standard text entry form fields with labels as they are guessed.
</translate>

<translate><!--T:43--> Note that it is likely that there will be duplicated, deprecated, or missing parameters in this list, because template authors will do things such as the following to allow different forms of a parameter name: {{nowrap|<code><nowiki>{{{full name|{{{Full Name}}}}}}</nowiki></code>}} (note the difference in letter case).</translate>
<translate><!--T:53--> It is common for there to be a prefered form for a parameter, and this can only be found by viewing the template documentation (and, while you're there, maybe adding TemplateData, so other people aren't confused in the future!).</translate>

<translate>
== How do I insert the template? == <!--T:44-->

<!--T:45-->
When you've added all desired parameters to the template form and given them their values (including no value at all if you need an empty parameter), click the 'Submit' button at the top right of the dialog window and the template wikitext will be inserted at the cursor's current location in the main page editing box.

<!--T:46-->
Template text will be inserted according to the [[<tvar name=tdformat>Special:MyLanguage/Help:TemplateData#Custom_formats</tvar>|format]] defined in TemplateData; if none is given then the 'inline' format will be used. It is not possible to have a different custom format for one template (but of course the template wikitext can always be edited after insertion).

== See also == <!--T:47-->
</translate>
* [[Help talk:Extension:TemplateWizard]] – <translate><!--T:48--> end-user help forum for the extension.</translate>
* {{ll|Extension:TemplateWizard}} – <translate><!--T:54--> the extension's home page, aimed at system administrators and developers.</translate>
* [[Phabricator:tag/TemplateWizard]] – <translate><!--T:55--> issue tracking system for bugs and missing features.</translate>

[[Category:Extension help{{#translation:}}|TemplateWizard]]