Template:Documentation/it/doc

From Gentoo Wiki
Jump to: navigation, search
Note
This page is a template. It contains some standardized, often used text, which can be transcluded inside other pages.

As this template is widely used in our wiki, it may be protected in which case only staff members can change it. Use the discussion page to propose enhancements or fixes, or to voice your opinion.

Questo template fornisce un meccanismo per documentare altre pagine (di solito un altro template, ma tecnicamente può essere usato in altri namespace — le informazioni di seguito presumono che venga usato in un'altra pagina di template).

La vera documentazione è contenuta in una sotto-pagina il cui titolo è il titolo della pagina attuale più il suffisso /doc. (Per esempio, se viene chiamata {{Documentation}} sulla pagina Template:C, la documentazione verrà transclusa dalla pagina Template:C/doc.)

Per ulteriori dettagli su come documentare correttamente i template, consultare le pagine Aggiungere la documentazione e le categorie and Sandbox e test case dei template.

Parametri

Nessuno nell'uso tipico (vedere la prossima sezione). Tuttavia, questo template passa in realtà i seguenti parametri (con valori predefiniti vuoti) a {{Documentation/core2}}, quindi alcune impostazioni predefinite possono essere sovrascritte.

Parameter name Required? Default value Description
heading No (n/a) Section heading shown at top of documentation.
heading-style No (n/a) Currently unused.
content No (n/a) If provided, will be shown instead of the /doc subpage.
link box No (n/a) If provided, will be shown instead of the standard "The above documentation is transcluded…" message. Special value off suppresses the message completely.

Do not override any of these unless you have a really good reason.

Utilizzo

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

The <noinclude> element is necessary to ensure that the template documentation (say, Template:C/doc) appears when viewing the template it's documenting (Template:C) but not any other page where the template is called (e.g., Gentoo Wiki:Guidelines, which contains {{C}} template calls).

(As the standard usage of this template is so simple, no test cases are shown here.)

See also