විකිපීඩියා:සැකිලි ප්‍රලේඛනය
සැකිලි වනාහී මාධ්‍යවිකියෙහි අතිශයින් ප්‍රබල විශේෂාංගයක් වන මුත්, නව පරිශීලකයන්ට මෙය ව්‍යකූලත්වය ඇතිකරලන්නක් විය හැකි අතර වඩාත් සංකීර්ණ ඒවා ග්‍රහණය කර ගැනුමට පළපුරුදු සහිත පරිශීලකයන් හට පවා අපහසුතා ඇතිකරලිය හැක. එබැවින් ඒවායේ භාවිත පහසුව දියුණුකෙරුම සඳහා සැකිලි හා සමගින් ඒවායේ ප්‍රලේඛනය පැවතිය යුතුය. සැකිල්ලක් විසින් කුමක් කරන්නේද යන්න සහ එය භාවිතා කරන්නේ කෙසේද යන්න සැකිලි ප්‍රලේඛනයක් විසින් පැහැදිලි කල යුතු වෙයි. It should be simple enough that a user without complete knowledge of the intricacies of template syntax – which includes many experienced contributors who focus their attention elsewhere – can use it correctly. This is especially true in the case of very widely-used templates. ඇතුළත් කළ යුතු දේTemplate documentation should cover:
Template documentation is often placed in a subpage of the template itself, which is then transcluded at the end of the template page. This separates the often complex template code from the documentation, making the documentation easier to edit. It also allows templates to be protected where necessary, while allowing anyone to edit the documentation. This method is sometimes referred to as the “template doc page pattern”. Documentation of any sort on a template page should always be enclosed by a How to create a documentation subpageTemplate documentation subpages should be named and formatted using the following general pattern, for consistency. Suppose your template is named {{Documentation subpage}}
<!-- Categories and interwikis go at the bottom of this page. -->
== Usage ==
== See also ==
<includeonly>
<!-- Categories and interwikis go here: -->
</includeonly>
The top line will display a message explaining the current page and a link to the template page. Insert the documentation after the top line and categories and interwikis under the appropriate comment line – leaving the comment in place, so that the layout is preserved when the page is edited in future. The subpage template sets a {{DEFAULTSORT:{{PAGENAME}}}}, ensuring that a Save the subpage and return to the template itself, [--last line of your template code--]<noinclude>
{{Documentation}}
<!-- PLEASE ADD THIS TEMPLATE'S CATEGORIES AND INTERWIKIS TO THE /doc SUBPAGE, THANKS -->
</noinclude>
This will transclude {{Documentation}} at the bottom of the template page. වැදගත්: Make sure the opening If the template is already protected, ask an administrator to do this or request an edit by using an {{Editprotected}} on the template's talk page. If documentation, categories and interwiki links already exist in a section, enclosed within a If the code is put on the template page first, one can benefit from the preload feature to get a pre-filled doc page skeleton; if the documentation page does not exist yet, clicking the edit link on the template page will preload the contents of Template:Documentation/preload into the editbox of the /doc subpage creation. You may wish to redirect the talk page of the /doc subpage to the talk page of the template itself. Then all talk relating to the template and its documentation will end up on the same talkpage. For example, redirect Categories and interwiki links
උදාහරණයක්See the heavily-used Template:cite web for an example of detailed template documentation. Note that the template itself is protected, but the documentation subpage, Template:cite web/doc is unprotected and can still be edited. /sandbox and /testcasesBefore doing changes to a template it can be good to first copy the template code to a sandbox and run some testcases, since the template might be visible on thousands of pages. If you create subpages named exactly "/sandbox" and "/testcases" to a template then the green Several templates, one documentation pageWhen several templates work together or are very similar then it is often clearer and easier to maintain one single documentation page that documents them together. The simplest way to do this is to make a full documentation page at one of the templates, and then make "soft redirects" from the other templates. That is, to make very short documentation pages at the other templates that have only one or two sentences that states where the full documentation can be found and link to it. See for instance {{wrap}}. Stub templatesStub templates are one of the very rare forms of template that do not generally have documentation. As all stub templates operate in identical ways, they could theoretically be linked to one documentation page giving instruction for their use. This is, however, regarded as superfluous, since all stub templates already contain a link to Wikipedia:Stub, which more thoroughly covers all the information that would normally be covered by a documentation page. See also
|
Portal di Ensiklopedia Dunia
