Editing Help:Templates
From Guild of Archivists
The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.
Latest revision | Your text | ||
Line 50: | Line 50: | ||
<pre>Template wiki code<noinclude>Text that will not be included</noinclude></pre> | <pre>Template wiki code<noinclude>Text that will not be included</noinclude></pre> | ||
== | == Formatting a template page == | ||
If your template has multiple parameters or is complicated to use, you are encouraged to include documentation on how to use it. It is also good practice to include documentation describing when to use your template, regardless of its complexity. To add documentation to a template, add the following to the bottom of the template page: | If your template has multiple parameters or is complicated to use, you are encouraged to include documentation on how to use it. It is also good practice to include documentation describing when to use your template, regardless of its complexity. To add documentation to a template, add the following to the bottom of the template page: | ||
Line 60: | Line 60: | ||
</pre> | </pre> | ||
This will add the documentation template to the page, which transcludes any material found at | This will add the documentation template to the page, which transcludes any material found at <pre>Template:Template name/doc</pre>. | ||
<pre>Template:Template name/doc</pre> | |||
There are no strict formatting guidelines for template documentation, just try to outline everything that the template does and the available parameters. However, the suggested headings for template page are given below. You can also use the "'''Manage TemplateData'''" button above the editor when creating your documentation to expedite the process of documenting the template's parameters. | There are no strict formatting guidelines for template documentation, just try to outline everything that the template does and the available parameters. However, the suggested headings for template page are given below. You can also use the "'''Manage TemplateData'''" button above the editor when creating your documentation to expedite the process of documenting the template's parameters. | ||