Templeeti:Documentation
Lua error in package.lua at line 80: module 'Module:Format link' not found.
| This template is used on approximately 137,000 pages. To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. |
| This template uses Lua: |
A na-eji template {{documentation}} echekwa ozi edere na ntuziaka nke template ụfọdụ, nke a na-ahụkarị na ibe nkwado /doc. Enwekwara ike hazie ya ka ọ bulite ọdịnaya si na ibe ndị ọzọ ma ọ bụ ka e nye ya ederede ozugbo.
Maka ntuziaka zuru ezu banyere otu esi na mgbe eji template a, lee en:Wikipedia:Template documentation (mkpụmkpụ: en:WP:TDOC).
Nlereanya a nwere akụkụ abụọ: igbe akwụkwọ nnukwu nke nwere akwụkwọ n'ime ya yana ogwe ngwá ọrụ (njikọ [Lee][dezie][akụkọ ihe mere eme][Hichaa]), na igbe njikọ nta nke na-egosi metadata gbasara akwụkwọ ahụ yana njikọ sandbox na testcases.
Iji template a na-enye ohere ka a chebe templates mgbe ọ dị mkpa, ma na-enye onye ọ bụla ohere dezie akwụkwọ ndekọ na ụdị.
Usoro okwu izugbe
[dezie ebe o si]Na-emekarị, a na-eji template ahụ na-enweghị paramita ma etinye ya n'ime <noinclude>...</noinclude> n'ala ibe template ahụ (lee Script error: No such module "Section link". maka ozi ndị ọzọ):
<!--Last line of your template code-->[[:Templeeti:Doc-code]]
Inyefe ibe dị iche
[dezie ebe o si]Iji tinye ibe ọzọ kama ibe ntinye /doc, nye nanị |1= dịka nke a:
<!--Ahịrị ikpeazụ nke koodu nlereanya gị--><noinclude>
{{Documentation|Template:Other page/doc}}
</noinclude>
Rịba ama na mgbe ị na-ebudata akwụkwọ ndu site na ibe ọ bụla ọzọ kama sub-ibe /doc nke mpaghara, ọ na-esiri ike ijikwa ụdị.
Iji paramita |content=
[dezie ebe o si]Enwere ike itinye akwụkwọ ntuziaka ozugbo dị ka ederede site n'iji parameta |content=:
<!--Last line of your template code--><noinclude>
{{Documentation
| content =
<!-- template documentation -->
}}</noinclude>
Mgbe ị na-eji paramita a, ogwe ngwá ọrụ agaghị apụta. Mara na ibe nta /doc dị na igbe njikọ ga-apụta ma ọ bụrụ na ọ dị.
Kwadokwa na mgbe e depụtara |1= na |content=, |content= ka nwere ihe karịrị ma na-egosi mgbe niile na igbe akwụkwọ ntuziaka.
Usoro edemede dị elu
[dezie ebe o si]Ịhazigharị isiokwu
[dezie ebe o si]Aha dị na igbe ndekọ na-agbanwe dabere na namespace. Lee ndepụta dị n'okpuru maka ederede ndabara n'ime namespace ọ bụla:
- Nha aha nlele:
Akwụkwọ ntuziaka nlele - Nha aha modul:
Akwụkwọ ntuziaka modul - Oghere aha ndị ọzọ: Nkọwa akwụkwọ
Iji hazie aha isiokwu, tinye parameta |heading= ihe ọ bụla ịchọrọ, dịka ọmụmaatụ |heading=Nkọwa akwụkwọ Infobox.
Rịba ama na ọ bụrụ na parameta heading dị efu ma kọwara (dịka |heading=), isi edemede dị n'akụkụ ngwá ọrụ agaghị apụta.
The |heading-style= parameter can be fed optional CSS values, like |heading-style=font-size:150%;color:red;. Not that you should omit quotation marks " " and add the ending semicolon ;.
Ịhazigharị igbe njikọ
[dezie ebe o si]Iji hazie igbe njikọ, tọọ |link box= ka ọ bụrụ ihe ọzọ, dịka |link box=Akwụkwọ ntuziaka dị n'elu a na-emepụta akpaghị aka site na Template:Foo.
Iji zoo igbe njikọ, tinye nanị |link box= ka ọ bụrụ off.
Nnwale
[dezie ebe o si]You can simulate the output for a given page by using the |page= parameter. For example, if you use the code |page=Template:Edit protected, the template will behave exactly as if it were on the page Template:Edit protected, including showing the documentation from Template:Edit protected/doc, linking to Template:Edit protected/sandbox, etc. This parameter is useful for testing and is used extensively on the module testcases page.
Ntinye na mkpado
[dezie ebe o si]A ga-etinye koodu a n'ala ibe koodu nlereanya, na-enweghị oghere ọ bụla tupu <noinclude> (nke na-eme ka oghere efu pụta na ibe ebe a na-etinye nlereanya ahụ):
<!--Last line of your template code-->[[:Templeeti:Doc-code]]
Iji tinye ederede dị n'elu na-akpaghị aka, ị nwekwara ike iji mkpirisi koodu substitution {{subst:doc-code}}:
<!--Last line of your template code-->{{subst:doc-code}}
Ụdị na njikọ n'etiti wikis
[dezie ebe o si]Dabere na ebe e debere akwụkwọ ntuziaka, ọ nwere ike ịdị mgbagwoju anya ijikwa ụdị na njikọ interwiki. Lee Script error: No such module "Section link". maka ozi gbasara itinye ha.
Nkọwa teknụzụ
[dezie ebe o si]Ntụziaka mbubata
[dezie ebe o si]Template:Documentation/preload contains the default wikitext that appears when an editor clicks "create" to begin creating a new template documentation page.
Ọrụ akpaghị aka
[dezie ebe o si]If the documentation page does not exist, the toolbar is replaced with a [create][purge] link. The [create] link automatically creates the page with preloaded text with the basic documentation syntax. Preload text is also used for the /sandbox and /testcases [create] links.
The preload page for the /doc [create] link is Template:Documentation/preload. The preload pages for the /sandbox and /testcases links are Template:Documentation/preload-sandbox and Template:Documentation/preload-testcases. The preload page for the /sandbox [mirror] link is Template:Documentation/mirror.
This template also automatically adds {{pp-template}} to a protected template page. When this template is on a /sandbox subpage, it also adds the {{Template sandbox notice}} template.
Atụmatụ igbe njikọ
[dezie ebe o si]Dabere na namespace, igbe njikọ nwere ike inwe atụmatụ ole na ole, ma ọ bụ ọ gaghị apụta kpamkpam. Teebụl dị n'okpuru a na-egosi nke a:
| Oghere aha | Omume |
|---|---|
| Template | Full behavior |
| Module | Full behavior, with the addition of a "create documentation" link when the page does not exist |
| User | Full behavior |
| Other namespaces | Hidden, unless |1= is specified (which will show "The above documentation is transcluded from {{{1}}}") |
Na mgbakwunye, ma ọ bụrụ na e depụtara |1= ma ọ bụ |content=, ederede "Tinye ụdị na ibe ntinye /doc" agaghị apụta.
Oghere aha isiokwu megide oghere aha mkparịta ụka
[dezie ebe o si]This template is usually placed in the subject namespace. But in some cases this template needs to be on the Talk namespace:
- In the MediaWiki namespace, since
<noinclude>often does not work in system messages, and since the MediaWiki namespace needs to be kept clean for performance reasons.
When placed on talk pages, this template usually is placed near the top of the page and without <noinclude>...</noinclude> tags.
The /doc, /sandbox and /testcases pages should normally be in the subject namespace, except in the namespaces that do not have the MediaWiki subpage feature enabled: Main, File, and MediaWiki. (Categories can have subpages, but documentation is created in the Category talk namespace to prevent creating empty categories. There are also a whole bunch of other technical reasons why the /doc page must be stored under the talk page for those (but only those) namespaces.
This template automatically points its [create] links for the /doc, /sandbox and /testcases to the right namespace.
Usoro agba
[dezie ebe o si]| RGB | HSV | Color | General usage | Note | |
|---|---|---|---|---|---|
| A | #ECFCF4 | 150°, 6%, 99% | Sample | Current documentation background | |
| B | #00FF80 | Hue=150° (41.7%; 106/255dec) 100%, 100% | Basic hue | What we'd call the color | |
| 1 | #A3BFB1 | 150°, 15%, 75% | Header border only | ||
| 2 | #CEF2E0 | 150°, 15%, 95% | Main border; header background | ||
| 3 | #E6FFF2 | 150°, 10%, 100% | 2nd header, accent colour | ||
| 4 | #F5FFFA | 150°, 4%, 100% | Main background | So saturation in A is a bit off | |
Agba maka igbe nduzi akwụkwọ |
|---|
|
Dị ka aro, lee agba ndị a maka igbe ntuziaka e mere maka ibe akwụkwọ nduzi naanị. Ha na-eso agba ndò nke igbe ntuziaka anụnụ anụnụ nkịtị. | titlestyle = background:#ccffe5;color:inherit;
| basestyle = background:#ddffee;color:inherit;
<!-- basestyle= sets groupstyle, abovestyle, belowstyle together -->
For subgroups, in child navboxes: {{Navbox|child
| groupstyle = background:#e6fff2;color:inherit;
...
Example: |
Usoro okwu zuru ezu
[dezie ebe o si]{{Documentation}}
or
{{Documentation
| [path to documentation page]
}}
{{Documentation
| content =
}}
or
{{Documentation
| [path to documentation page]
| heading-style =
| heading =
| link box =
}}
or
{{Documentation
| [path to documentation page]
| content =
| heading-style =
| heading =
| link box =
| page =
}}
Lee kwa
[dezie ebe o si]- {{Documentation subpage}}, a notice placed at the top of a /doc subpage explaining its role and including a link to the page it documents.
- {{Barnstar documentation}}, a variant of {{Documentation}} for use with barnstar templates.
- {{Navbox documentation}}, a variant of {{Documentation}} for use with navigation templates.
- Wikipedia:Template documentation is a how-to guide to template documentation.
- Wikipedia:Template sandbox and test cases explains the use of /sandbox and /testcases subpages and includes more information about template testing.