Template:Documentation/doc: Difference between revisions
No edit summary |
m Text replacement - "Category:([A-Za-z]+)\s*(.*)" to "Category:$1 {{lc:$2}}" |
||
| Line 7: | Line 7: | ||
Clicking "Create" at the top of the page will open the documentation page with some [[Template:Documentation/preload|preformatted]] content. You can also use <code><nowiki>{{subst:doc}}</nowiki></code> on the documentation page to create this format. | Clicking "Create" at the top of the page will open the documentation page with some [[Template:Documentation/preload|preformatted]] content. You can also use <code><nowiki>{{subst:doc}}</nowiki></code> on the documentation page to create this format. | ||
Documentation pages will be automatically added to [[:Category: | Documentation pages will be automatically added to [[:Category:D {{lc:}}ocumentation Pages]]. Using {{t|doc}} without <code>subst:</code> will add the page to [[:Category:P {{lc:}}ages Needing Template Substitution]]. | ||
== Optional Parameters == | == Optional Parameters == | ||
| Line 26: | Line 26: | ||
If the template has no documentation and you don't know how to use it, add nodoc=1 to the documentation template on the documentation page. The background of the documentation will turn red to draw attention, and the page will be added to the category. | If the template has no documentation and you don't know how to use it, add nodoc=1 to the documentation template on the documentation page. The background of the documentation will turn red to draw attention, and the page will be added to the category. | ||
* [[:Category: | * [[:Category:T {{lc:}}emplates Without Documentation]] | ||
* [[:Category: | * [[:Category:M {{lc:}}odules Without Documentation]] | ||
If the documentation page doesn't exist or is empty, it's automatically set, so it usually doesn't need to be set. | If the documentation page doesn't exist or is empty, it's automatically set, so it usually doesn't need to be set. | ||
| Line 34: | Line 34: | ||
Similar to nodoc, it's used to mark templates that '''do''' have documentation, but it's not very good. This might mean it lacks enough examples, doesn't properly explain all features, or doesn't correctly explain the template's main points. The background of the documentation will turn yellow to stand out, and the page will be added to the category. | Similar to nodoc, it's used to mark templates that '''do''' have documentation, but it's not very good. This might mean it lacks enough examples, doesn't properly explain all features, or doesn't correctly explain the template's main points. The background of the documentation will turn yellow to stand out, and the page will be added to the category. | ||
* [[:Category: | * [[:Category:T {{lc:}}emplates with Poor Documentation Quality]] | ||
* [[:Category: | * [[:Category:M {{lc:}}odules with Poor Documentation Quality]] | ||