模板:Documentation/doc：修订间差异

2024年1月17日 (三) 12:49的最新版本

This template is used in system messages.
Changes to it can cause immediate changes to the Wikipedia user interface.
To avoid major disruption, 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. Please discuss changes on the talk page before implementing them.

This template uses Lua:

Lua错误在模块:TNT的第167行：Missing Commons dataset I18n/Module:TNT.tab This module displays a blue box containing documentation for templates, Lua modules, or other pages. The {{documentation}} template invokes it.

Normal usage

For most uses, you should use the {{documentation}} template; please see that template's page for its usage instructions and parameters.

Use in other modules

To use this module from another Lua module, first load it with require:

local documentation = require('Module:Documentation').main

Then you can simply call it using a table of arguments.

documentation{content = 'Some documentation', ['link box'] = 'My custom link box'}

Please refer to the template documentation for usage instructions and a list of parameters.

Porting to other wikis

The module has a configuration file at Module:Documentation/config which is intended to allow easy translation and porting to other wikis. Please see the code comments in the config page for instructions. If you have any questions, or you need a feature which is not currently implemented, please leave a message at Template talk:Documentation to get the attention of a developer.

The messages that need to be customized to display a documentation template/module at the top of module pages are MediaWiki:Scribunto-doc-page-show and MediaWiki:Scribunto-doc-page-does-not-exist.

@@ 第1行： / 第1行： @@
-{{Documentation}}
+{{used in system}}
-The '''documentation''' template is transcluded in the template/module documentation. This template should only be used on subpages titled "doc".
+{{Module rating|protected}}
+{{Lua|Module:Documentation/config|Module:Arguments|Module:Message box|Module:Module wikitext|Module:Protection banner}}
+{{Uses TemplateStyles|Module:Documentation/styles.css}}
+This module displays a blue box containing documentation for [[Help:Template|templates]], [[Wikipedia:Lua|Lua modules]], or other pages. The {{tl|documentation}} template invokes it.
-==Usage==
+== Normal usage ==
-Place {{t|documentation}} at the top of the documentation page.
-If the page to be documented is a subpage, use {{t|documentation|pagename of page to be documented}} at the top of the documentation page. For example, Template:Foo/bar's documentation page would use {{t|documentation|Template:Foo/bar}}.
+For most uses, you should use the {{tl|documentation}} template; please see that template's page for its usage instructions and parameters.
-The template will attempt to auto detect and link <code><nowiki>{{#Invoke:}}</nowiki></code> calls on template documentations or the <code>require()</code>/<code>mw.loadData()</code> depedency list on module documentations. If you want to supress the auto generated dependency list, use {{t|documentation|DependencyList=no}}
+== Use in other modules ==
-==Note==
+To use this module from another Lua module, first load it with <code>require</code>:
-This template links to a /doc that may appear useless, however, it exists in order to link navboxes and userboxes to their base template's documentation.
-<includeonly></includeonly>
-==TemplateData==
+<syntaxhighlight lang="lua">
-<templatedata>
+local documentation = require('Module:Documentation').main
-{
+</syntaxhighlight>
-	"params": {},
-	"description": "The documentation template is transcluded in the template/module documentation. This template should only be used on subpages titled \"doc\"."
+Then you can simply call it using a table of arguments.
-}
+<syntaxhighlight lang="lua">
-</templatedata>
+documentation{content = 'Some documentation', ['link box'] = 'My custom link box'}
+</syntaxhighlight>
+Please refer to the [[Template:Documentation/doc|template documentation]] for usage instructions and a list of parameters.
+== Porting to other wikis ==
+The module has a configuration file at [[Module:Documentation/config]] which is intended to allow easy translation and porting to other wikis. Please see the code comments in the config page for instructions. If you have any questions, or you need a feature which is not currently implemented, please leave a message at <span class="plainlinks">[https://en.wikipedia.org/wiki/Template_talk:Documentation Template talk:Documentation]</span><!-- this link uses external link syntax because it is intended to direct users from third-party wikis to the Wikipedia template talk page; in this situation, an internal link would unhelpfully just point to their local template talk page, and the existence of any given interwiki prefix cannot be assumed --> to get the attention of a developer.
+The messages that need to be customized to display a documentation template/module at the top of module pages are [[MediaWiki:Scribunto-doc-page-show]] and [[MediaWiki:Scribunto-doc-page-does-not-exist]].