131
edits
Template:Documentation/doc: Difference between revisions
From ScoutWiki, For Everyone, Everywhere involved with Scouting and Guiding...
cleanup
(rem cat) |
(cleanup) |
||
| Line 1: | Line 1: | ||
{{documentation subpage}} | {{documentation subpage}} | ||
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE --> | <!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE --> | ||
__NOTOC__ | __NOTOC__ | ||
This template automatically displays a documentation box like you are seeing now, of which the content is transcluded from another page. It is intended for pages which are | This template automatically displays a documentation box like you are seeing now, of which the content is transcluded from another page. It is intended for pages which are transcluded in other pages, i.e. templates, whether in the template namespace or not. | ||
== Usage == | == Usage == | ||
| Line 26: | Line 26: | ||
This code should be added at the bottom of the template code, with no extra space before "<code><noinclude></code>" (which would cause extra space on pages where the template is used). The parameter can be used as shown above to transclude an arbitrary documentation page. | This code should be added at the bottom of the template code, with no extra space before "<code><noinclude></code>" (which would cause extra space on pages where the template is used). The parameter can be used as shown above to transclude an arbitrary documentation page. | ||
Categories and interwiki links that apply to the template itself should be added to the documentation page, inside <code><includeonly> </includeonly></code> tags | Categories and interwiki links that apply to the template itself should be added to the documentation page, inside <code><includeonly> </includeonly></code> tags. | ||
If the documentation page contains includeonly or noinclude tags as part of the documentation, replace the "<" with "&lt;". | If the documentation page contains includeonly or noinclude tags as part of the documentation, replace the "<" with "&lt;". | ||
| Line 37: | Line 37: | ||
== Functions == | == Functions == | ||
If the documentation page doesn't exist, the "edit" link includes a | If the documentation page doesn't exist, the "edit" link includes a preload parameter so that clicking it will pre-fill the edit form with the basic documentation page format. | ||
== Rationale == | == Rationale == | ||
Use of this template allows templates to be | Use of this template allows templates to be protected where necessary, while allowing anyone to edit the documentation, categories, and interwiki links. | ||
{{Wikipedia|Template:Documentation}} | |||
<includeonly><!-- CATEGORIES AND INTERWIKIS HERE, THANKS --> | <includeonly><!-- CATEGORIES AND INTERWIKIS HERE, THANKS --> | ||
