Difference between revisions of "Template:Documentation/doc"

From PC-BSD Wiki
Jump to: navigation, search
m (Created page with "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 [[Wiki...")
 
m
 
(One intermediate revision by one user not shown)
Line 1: Line 1:
 
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 [[Wikipedia:Transclusion|transcluded]] in other pages, i.e. templates, whether in the template namespace or not.   
 
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 [[Wikipedia:Transclusion|transcluded]] in other pages, i.e. templates, whether in the template namespace or not.   
  
==Usage==
+
== Usage ==
===Normal===
+
 
 +
=== Normal ===
 +
 
 
<pre>
 
<pre>
 
&lt;noinclude&gt;{{documentation}}&lt;/noinclude&gt;
 
&lt;noinclude&gt;{{documentation}}&lt;/noinclude&gt;
Line 14: Line 16:
 
If the documentation page contains includeonly or noinclude tags as part of the documentation, replace the "<" with "&amp;lt;".
 
If the documentation page contains includeonly or noinclude tags as part of the documentation, replace the "<" with "&amp;lt;".
  
===Customizing display===
+
=== Customizing display ===
 +
 
 
Overrides exist to customize the output in special cases:
 
Overrides exist to customize the output in special cases:
 
* <nowiki>{{</nowiki>documentation|'''heading'''=}}: change the text of the "documentation" heading. If this is set to blank, the entire heading line (including the first [edit] link) will also disappear.
 
* <nowiki>{{</nowiki>documentation|'''heading'''=}}: change the text of the "documentation" heading. If this is set to blank, the entire heading line (including the first [edit] link) will also disappear.
  
==Functions==
+
== Functions ==
If the documentation page doesn't exist, the "edit" link includes a [[mw:Manual:Creating pages with preloaded text|preload]] parameter so that clicking it will pre-fill the edit form with the basic documentation page format.
+
 
 +
If the documentation page does not exist, the "edit" link includes a [[mw:Manual:Creating pages with preloaded text|preload]] parameter so that clicking it will pre-fill the edit form with the basic documentation page format.
 +
 
 +
== Advantages ==
  
==Advantages==
 
 
Transclusion of a documentation page makes it possible to protect the page of the template itself while allowing anyone to edit the template's documentation, categories, and interwiki links.
 
Transclusion of a documentation page makes it possible to protect the page of the template itself while allowing anyone to edit the template's documentation, categories, and interwiki links.
  
 
Use of msgnw to show the content of a template is less cluttered with wikitext from the noinclude-part.
 
Use of msgnw to show the content of a template is less cluttered with wikitext from the noinclude-part.
  
==Disadvantages, substitution as alternative==
+
== Disadvantages, substitution as alternative ==
 +
 
 
Transclusion of a documentation page increases its [[Help:Expansion#Expansion_depth_limit|expansion depth]], for which a limit applies. In particular a demo showing an example within the limits and one exceeding them should itself not be transcluded.  
 
Transclusion of a documentation page increases its [[Help:Expansion#Expansion_depth_limit|expansion depth]], for which a limit applies. In particular a demo showing an example within the limits and one exceeding them should itself not be transcluded.  
  
Line 33: Line 39:
 
To avoid the disadvantages, yet get the same lay-out for the resulting template page, substitute [[Template:Docsubst]] by putting <code><nowiki>{{subst:docsubst}}</nowiki></code> inside <code><nowiki><noinclude></nowiki></code> tags. If the documentation page already exists, subsititute it and remove the text and links which are no longer applicable, or do like above, and copy the relevant content from the existing documentation page to the noinclude part of the template page.
 
To avoid the disadvantages, yet get the same lay-out for the resulting template page, substitute [[Template:Docsubst]] by putting <code><nowiki>{{subst:docsubst}}</nowiki></code> inside <code><nowiki><noinclude></nowiki></code> tags. If the documentation page already exists, subsititute it and remove the text and links which are no longer applicable, or do like above, and copy the relevant content from the existing documentation page to the noinclude part of the template page.
  
==See also==
+
== See also ==
 
* {{links-small|template|documentation subpage}}
 
* {{links-small|template|documentation subpage}}
 
* {{links-small|w|template|documentation}}
 
* {{links-small|w|template|documentation}}
Line 47: Line 53:
 
[[Category:Formatting templates|Template documentation]]
 
[[Category:Formatting templates|Template documentation]]
 
</includeonly>
 
</includeonly>
 +
<noinclude>[[category:templates]]</noinclude>
 +
<noinclude>[[category:found ideas]]</noinclude>

Latest revision as of 10:33, 10 October 2012

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.

Contents

[edit] Usage

[edit] Normal

<noinclude>{{documentation}}</noinclude>
or <noinclude>{{documentation|template:any page/doc}}</noinclude>

This code should be added at the bottom of the template code, with no extra space before "<noinclude>" (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.

Add categories and interwiki links to the documentation page inside includeonly tags.

If the documentation page contains includeonly or noinclude tags as part of the documentation, replace the "<" with "&lt;".

[edit] Customizing display

Overrides exist to customize the output in special cases:

  • {{documentation|heading=}}: change the text of the "documentation" heading. If this is set to blank, the entire heading line (including the first [edit] link) will also disappear.

[edit] Functions

If the documentation page does not exist, the "edit" link includes a preload parameter so that clicking it will pre-fill the edit form with the basic documentation page format.

[edit] Advantages

Transclusion of a documentation page makes it possible to protect the page of the template itself while allowing anyone to edit the template's documentation, categories, and interwiki links.

Use of msgnw to show the content of a template is less cluttered with wikitext from the noinclude-part.

[edit] Disadvantages, substitution as alternative

Transclusion of a documentation page increases its expansion depth, for which a limit applies. In particular a demo showing an example within the limits and one exceeding them should itself not be transcluded.

Another disadvantage is that when applying WhatLinksHere to a page the documentation links to, both the template page and the documentation page is listed, which clutters the list somewhat.

To avoid the disadvantages, yet get the same lay-out for the resulting template page, substitute Template:Docsubst by putting {{subst:docsubst}} inside <noinclude> tags. If the documentation page already exists, subsititute it and remove the text and links which are no longer applicable, or do like above, and copy the relevant content from the existing documentation page to the noinclude part of the template page.

[edit] See also