ഫലകം:വിവരണം/വിവരണം

ഇത് ഫലകം:വിവരണം എന്ന ഫലകത്തിന്റെ വിവരണ-ഉപതാൾ ആണ്‌ (ഫലകത്തിനായി ആ താൾ കാണുക).
ഇതിൽ യഥാർത്ഥ ഫലകം ഉപയോഗിക്കേണ്ട രീതി, വർഗ്ഗങ്ങൾ, ബഹുഭാഷാകണ്ണികൾ തുടങ്ങിയ ഫലകത്തിന്റെ ഭാഗമല്ലാത്ത കാര്യങ്ങളാണ്‌ ഉള്ളത്..

{{documentation}} ഇവിടേക്കണ്‌ തിരിച്ചുവിട്ടിരിക്കുന്നത്. {{വിവരണം}} എന്നതിനു പകരം {{documentation}} എന്നുപയോഗിച്ചാലും മതിയാകും.

ഇത് {{വിവരണം}} എന്ന ഫലകമാണ്‌.

For most of the instructions about how and when to use this template, see Wikipedia:Template documentation.

ഈ ഫലകം ഇപ്പോൾ കാണുന്നത് പോലുള്ള ഒരു പച്ച പെട്ടി ഫലകങ്ങളുടെ താളുകളിൽ കാണിക്കും. അതിലെ വിവരങ്ങൾ /വിവരണം എന്ന ഉപതാളിൽ നിന്നുള്ളതാണ്‌. നിർദ്ദേശം നൽകിയിട്ടുണ്ടെങ്കിൽ മറ്റു താളുകളിൽ നിന്നും വിവരങ്ങൾ കാണിക്കാൻ കഴിയും.

ഈ ഫലകം ഉപയോഗിക്കുന്നത് കൊണ്ട് സംരക്ഷിക്കപ്പെട്ട ഫലകങ്ങളിലെ വർഗ്ഗങ്ങളും ബഹുഭാഷാകണ്ണികളും തിരുത്താൻ സാധിക്കും.

ഉപയോഗം

സാധാരണ ഈ ഫലകം <noinclude> ഉപയോഗിച്ച് വിവരണം നൽകേണ്ട ഫലകത്തിന്റെ താഴെ ഉപയോഗിക്കുകയാണ് ചെയ്യുന്നത്. ഇതുപോലെ:

<!--ഫലകതിന്റെ അവസാന വരി--><noinclude>

{{വിവരണം}}
<!-- വർഗ്ഗങ്ങളും ബഹുഭാഷാകണ്ണികളും /വിവരണം താളിലാണ്‌ നൽകേണ്ടത്. ഇവിടെയല്ല. -->
</noinclude>

അപ്പോൾ ഈ ഫലകം ഉപയോഗിച്ച ഫലകത്തിന്റെ /വിവരണം എന്ന ഉപതാളിൽ നിന്നും വിവരങ്ങൾ കാണിക്കും.

ഈ ഫലകത്തിനു മറ്റു താളുകളിൽ നിന്നും വിവരങ്ങൾ കാണിക്കാൻ കഴിയും. ഇതുപോലെ:

<!--ഫലകതിന്റെ അവസാന വരി--><noinclude>

{{വിവരണം|ഫലകം:മറ്റു താൾ/വിവരണം}}
</noinclude>

ശ്രദ്ധിക്കുക, ഇങ്ങനെ മറ്റു താളുകളിൽ നിന്നും വിവരങ്ങൾ കാണിക്കുമ്പോൾ വർഗ്ഗങ്ങളും ബഹുഭാഷാകണ്ണികളും ഉപയോഗിക്കാൻ തടസങ്ങൾ നേരിടാൻ സാധ്യത ഉണ്ട്.

വിവരണം നേരിട്ടും എഴുതാം. ഇതുപോലെ:

<!--ഫലകതിന്റെ അവസാന വരി--><noinclude>

{{വിവരണം
| content = എന്തെങ്കിലും വിവരണം
}}
</noinclude>

ഇതുപോലെ ഉപയോഗിച്ചാൽ പെട്ടിയുടെ മുകളിൽ സാധാരണ കാണിക്കുന്നതു പോലെ [തിരുത്തുക] [പുതുക്കുക] എന്ന കണ്ണികൾ കാണില്ല. /വിവരണം താൾ നിലവിൽ ഉണ്ടെങ്കിൽ പ്രസ്തുത താളിലേക്കുള്ള കണ്ണി താഴെയുള്ള പെട്ടിയിൽ കാണിക്കും.

But parameter 1 and the content parameter can also be combined, like this:

<!--Last line of your template code--><noinclude>

{{documentation
| 1 = Template:Any page/doc
| content = {{Template:Any page/doc|parameters}}
}}
</noinclude>

Then the pagename fed as parameter 1 is used for the [edit] [purge] links and for the /doc link in the link box below the doc box. But the content parameter is used for the content shown in the doc box. The above code means that the content is transcluded as "{{Template:Any page/doc|parameters}}". In this example a parameter is also fed to the /doc page being loaded.

Best practice

The code should be added at the bottom of the template code, with no space before "<noinclude>" (which would cause extra space on pages where the template is used).

Categories and interwiki links that apply to the template itself should be added to the bottom of the /doc subpage, inside <includeonly></includeonly> tags. For more complex cases, see Wikipedia:Template documentation#Categories and interwiki links.

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

തലക്കെട്ട്

When in Template space this template shows this heading:

ഫലകത്തിന്റെ വിവരണം

In most other namespaces, such as "Wikipedia:", it shows this heading:

Documentation

But when on File (image) pages it shows this heading:

Summary

The heading parameter can be used to set the heading to something else. Like this:

{{documentation| heading = Infobox documentation }}

If the heading parameter is empty but defined, no heading is shown and no [edit] [purge] links are shown. Like this:

{{documentation| heading = }}

The heading-style parameter can be fed optional CSS values. Without quotation marks " " but with the ending semicolons ;. For example:

heading-style = color: red; font-size: 150%;

The link box

Below the big doc box is a small link box that shows some meta-data about the documentation. The link box shows different things depending on what parameters are fed to this template, and in which namespace it is used. In some cases the link box is not shown at all.

To hide the link box, add the parameter "|link box=off".

You can also insert customised text in the link box, by defining the |link box= parameter. For example:

|link box=This documentation is automatically generated by [[Template:Country showdata]]

Automatic functions

If the documentation page doesn't exist, the [create] link includes a preload page so that clicking it will pre-fill the edit form with the basic documentation page format. Preload text is also used for the /sandbox and /testcases (create) links.

When this template is on a protected template page it now automatically adds {{pp-template}} which shows the grey or red padlock in the top right corner. So no need to manually add {{pp-template}} to templates that use {{documentation}}.

When this template is on a /sandbox subpage it automatically adds the {{template sandbox notice}}.

Subject space vs talk space

Terminology: Subject space is the opposite of talk space. For instance "Template:" is the subject space of "Template talk:".

This template is usually placed in subject space, within <noinclude> tags. But in some cases this template needs to be on the talkpage:

For preload pages (usually in Template or Wikipedia space), since they can't use <noinclude>. See for instance Template talk:AfC preload and Template talk:RfD subpage starter. Such talkpages can be marked with {{talkdoc}}.

In MediaWiki space, since <noinclude> often doesn't work in system messages and since MediaWiki space needs to be kept clean for performance reasons.

When placed on talkpages this template usually is placed near the top of the page and without <noinclude> tags.

The /doc, /sandbox and /testcases pages should normally be in subject space, except in the namespaces that don't have the MediaWiki subpage feature enabled: Main, File, MediaWiki and Category. (But currently we only show the /sandbox and /testcases links from User, User talk, Template and Template talk space.) There are also a whole bunch of other technical reasons why the /doc page must be stored under the talkpage for those namespaces.

This template automatically points its create links for the /doc, /sandbox and /testcases to the right namespace.

Technical details

This template calls {{documentation/core2}} which in turn calls {{documentation/core}}. /core holds most of the code, while this template and /core2 do parameter preprocessing.

The preload page for the /doc [create] link is Template:Documentation/preload, but in File space it is Template:Documentation/preload-filespace. The preload pages for the /sandbox and /testcases (create) links are Template:Documentation/preload-sandbox and Template:Documentation/preload-testcases.

For more technical details see the talk page.