Модуль:documentation/doc
This is the documentation page for Модуль:documentation
Serves {{documentation}} and {{translit module documentation}}. {{documentation}} is added to modules automatically (through MediaWiki:Scribunto-doc-page-show if the doc page exists, otherwise through MediaWiki:Scribunto-doc-page-does-not-exist); added to user JavaScript pages automatically (through MediaWiki:Clearyourcache); and manually added to template pages. It automatically adds categories, or categories and documentation, to some modules based on their titles.
More specifically, for modules:
- When there is no doc page for the module, Module:documentation checks for various sorts of special modules (based on the module title) and autogenerates the documentation and categories of those modules. If this check fails, the module is added to Category:Templates and modules needing documentation, and Module:module categorization is called to autogenerate the categories for lang-specific modules of the form
LANGCODE-TYPE, optionally with a subpage (e.g.LANGCODE-TYPE/data,LANGCODE-TYPE/testcases,LANGCODE-TYPE/data/testcases, or any other subpage). If this check also fails, the module is added to Category:Uncategorized modules. - When there is a doc page for the module, the contents of that page take precedence over any autogenerated content. However, if that page does not have an
<includeonly>...</includeonly>section and does not have an invocation of {{module cat}}, the same checks are done as when no doc page exists (including checks for specially-titled modules and falling back to calling Module:module categorization), but only for the purposes of autogenerating categories. If no such categories could be determined, the module is added to Category:Uncategorized modules.
More specifically, for templates:
- ... (DOCUMENT ME)
Ideas:
- Make more usable on other Wiktionaries by creating data module with translations of text, and moving module regex to separate module.
Automatic module documentation generators
түзөтүү| Regex | Category | Handling modules |
|---|---|---|
^Module:languages/data/(3/./extra)$ |
(unspecified) | (handled internally) |
^Module:languages/data/(3/.)$ |
(unspecified) | (handled internally) |
^Module:languages/data/(2/extra)$ |
(unspecified) | (handled internally) |
^Module:languages/data/(2)$ |
(unspecified) | (handled internally) |
^Module:languages/data/(exceptional/extra)$ |
(unspecified) | (handled internally) |
^Module:languages/data/(exceptional)$ |
(unspecified) | (handled internally) |
^Module:languages/.+$ |
Language and script modules |
(no documentation generator) |
^Module:scripts/.+$ |
Language and script modules |
(no documentation generator) |
^Module:data tables/data..?.?.?$ |
Reference module sharded data tables |
(no documentation generator) |
^Module:zh/data/dial%-pron/.+$ |
Chinese dialectal pronunciation data modules |
Module:documentation/functions/zh dial or syn |
^Module:zh/data/dial%-syn/.+$ |
Chinese dialect synonyms data modules |
Module:documentation/functions/zh dial or syn |
^Module:zh/data/glyph%-data/.+$ |
Chinese historical character forms data modules |
(handled internally) |
^Module:zh/data/ltc%-pron/(.+)$ |
Middle Chinese pronunciation data modules|%1 |
Module:documentation/functions/zh data |
^Module:zh/data/och%-pron%-BS/(.+)$ |
Old Chinese (Baxter-Sagart) pronunciation data modules|%1 |
Module:documentation/functions/zh data |
^Module:zh/data/och%-pron%-ZS/(.+)$ |
Old Chinese (Zhengzhang) pronunciation data modules|%1 |
Module:documentation/functions/zh data |
^Module:zh/data/(.+)$ |
Chinese data modules|%1 |
(no documentation generator) |
^Module:mul/guoxue%-data/cjk%-?(.*)$ |
(unspecified) | Module:documentation/functions/guoxue-data |
^Module:Unicode data/(.+)$ |
Unicode data modules|%1 |
(handled internally) |
^Module:number list/data/(.+)$ |
(unspecified) | (handled internally) |
^Module:accel/(.+)$ |
(unspecified) | (handled internally) |
^Module:inc%-ash/dial/data/(.+)$ |
Ashokan Prakrit modules|%1 |
(handled internally) |
^.+%-translit$ |
(unspecified) | Module:documentation/functions/translit |
^Module:form of/lang%-data/(.+)$ |
(unspecified) | (handled internally) |
^Module:labels/data/lang/(.+)$ |
(unspecified) | (handled internally) |
^Module:category tree/poscatboiler/data/lang%-specific/(.+)$ |
(unspecified) | (handled internally) |
^Module:category tree/poscatboiler/data/(.+)$ |
(unspecified) | (handled internally) |
^Module:category tree/topic cat/data/(.+)$ |
(unspecified) | (handled internally) |
^Module:ja/data/(.+)$ |
Japanese data modules|%1 |
(no documentation generator) |
^Module:fi%-dialects/data/feature/Kettunen1940 ([0-9]+)$ |
Finnish dialectal data atlas modules|%1 |
(handled internally) |
^Module:fi%-dialects/data/feature/(.+) |
Finnish dialectal data modules|%1 |
(no documentation generator) |
^Module:fi%-dialects/data/word/(.+) |
Finnish dialectal data modules|%1 |
(no documentation generator) |
^Module:Swadesh/data/([a-z-]+)$ |
(unspecified) | (handled internally) |
^Module:Swadesh/data/([a-z-]+)/([^/]*)$ |
(unspecified) | (handled internally) |
^Module:typing%-aids |
(unspecified) | (handled internally) |
^Module:R:([a-z%-]+):(.+)$ |
(unspecified) | (handled internally) |
^Module:Quotations/([a-z-]+)/?(.*) |
(unspecified) | Module:documentation/functions/Quotation |
^Module:affix/lang%-data/([a-z-]+) |
(unspecified) | Module:documentation/functions/affix lang-data |
^Module:dialect synonyms/([a-z-]+)$ |
(unspecified) | (handled internally) |
^Module:dialect synonyms/([a-z-]+)/(.+)$ |
(unspecified) | (handled internally) |