வார்ப்புரு:Documentation/doc

This is a documentation subpage for வார்ப்புரு:Documentation.
It may contain usage information, பகுப்புகள் and other content that is not part of the original வார்ப்புரு page.

இவ்வார்ப்புரு தானியக்கமாக, இப்பொழுது காணும் ஆவணப்பெட்டியில் தெரியும் குறிப்புகளைப் போன்று, மாறுநிலைத் தொகுப்பாகக்(Transclusion) காட்டுகிறது. இதனின் உள்நோக்கம், மற்ற பக்கங்களின் வார்ப்புருகளையும் (மாறுநிலையானத் தொகுப்பாகக் ) காட்டும்படி அமையப்பட்டுள்ளது.

பயன்பாடுத்தும் விதம்

பொதுவான /doc

<noinclude>{{Documentation}}</noinclude>

எந்த குறித்த பக்கத்தையும் இணைக்க/doc page

<noinclude>{{Documentation|Template:any page/doc}}</noinclude>

In-line content

<noinclude>{{Documentation|content=This is documentation.}}</noinclude>

In-line content with [view][edit] links

<noinclude>{{Documentation
|1 = Template:any page/doc
|content ={{Template:any page/doc|parameters}}
}}</noinclude>

Best practice

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> </includeonly> tags.

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

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.

Functions

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

Use of this template allows templates to be protected where necessary, while allowing anyone to edit the documentation, categories, and interwiki links.