Module:Documentation/doc - Revision history

Scyu: 1 revision imported

2024-10-11T13:38:29Z

1 revision imported

← Older revision		Revision as of 13:38, 11 October 2024
(No difference)

Scyu: 1 revision imported

2024-10-11T12:49:19Z

1 revision imported

← Older revision		Revision as of 12:49, 11 October 2024
(No difference)

minecraft>MarkusRost at 23:33, 18 September 2024

2024-09-18T23:33:12Z

← Older revision		Revision as of 23:33, 18 September 2024
Line 1:		Line 1:
	{{~~Module rating\|release~~}}		{{documentation header}}
	<!-- ~~Add categories where indicated at the bottom of this page and interwikis at Wikidata~~ -->		<!-- Documentation here -->
	~~{{Lua\|Module:Documentation/config\|Module:Documentation/i18n\|Module:Arguments\|Module:Message box\|Module:Module wikitext\|Module:TNT}}~~		This module implements {{tl\|Documentation}}.
	~~{{Uses TemplateStyles\|Module:Documentation/styles.css}}~~
	This [[module~~]] displays a blue box containing documentation for [[Special:MyLanguage/Help:templates\|templates]], [[Special:MyLanguage/Lua scripting\|Lua modules]], or other pages. The~~ {{~~tlx~~\|~~documentation~~}} ~~template invokes it~~.

	== ~~Normal usage~~ ==		== Dependencies ==
			* [[Module:ProcessArgs]]
			* [[Module:Static]]
			* [[Module:TSLoader]]
			* [[mw:extension:TemplateStyles]]: [[Module:Documentation/styles.css]]

	~~For most uses, you should use the {{tlx\|documentation}} template; please see that template's page for its usage instructions and parameters.~~		<includeonly>
			<!-- Template categories/interwiki here-->
	~~== Use in other modules ==~~		[[cs:Modul:Documentation]]
			[[de:Modul:Dokumentation]]
	~~To use this module from another Lua module, first load~~ it ~~with <code>require</code>~~:		[[es:Módulo:Documentation]]
			[[fr:Module:Documentation]]
	~~<syntaxhighlight lang="lua">~~		[[it:Modulo:Documentazione]]
	~~local documentation = require('~~Module:Documentation~~').main~~		[[ja:モジュール:Documentation]]
	</~~syntaxhighlight~~>		[[ko:모듈:Documentation]]
			[[lzh:模組:Documentation]]
	~~Then you can simply call it using a table of arguments.~~		[[nl:Module:Documentatie]]
	<~~syntaxhighlight lang="lua"~~>		[[pl:Moduł:Dokumentacja]]
	~~documentation{content = 'Some documentation',~~ [~~'link box'~~] ~~= 'My custom link box'}~~		[[pt:Módulo:Documentation]]
	</~~syntaxhighlight>~~		[[ru:Модуль:Документация]]
			[[th:มอดูล:Documentation]]
	~~Please refer to the~~ [[~~Template~~:Documentation/doc~~\|template documentation~~]] ~~for usage instructions and a list of parameters.~~		[[uk:Модуль:Документація]]
			[[zh:模块:Documentation]]
	~~== Porting to other wikis ==~~		</includeonly>
			<noinclude>
	~~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.~~		<!-- Documentation categories/interwiki here-->
			[[cs:Modul:Documentation/doc]]
	~~<includeonly>{{Sandbox other\|\|~~		[[de:Modul:Dokumentation/Dokumentation]]
	~~<!-- Categories below this line; interwikis at Wikidata -->~~		[[es:Módulo:Documentation/doc]]
	[[~~Category~~:~~Modules{{#translation~~:}}]]		[[fr:Module:Documentation/doc]]
	~~}}<~~/~~includeonly><noinclude>~~		[[it:Modulo:Documentazione/doc]]
	[[~~Category~~:~~Module documentation pages{{#translation~~:}}]]		[[ja:モジュール:Documentation/doc]]
			[[ko:모듈:Documentation/doc]]
			[[lzh:模組:Documentation/doc]]
			[[nl:Module:Documentatie/doc]]
			[[pl:Moduł:Dokumentacja/opis]]
			[[pt:Módulo:Documentation/doc]]
			[[ru:Модуль:Документация/док]]
			[[th:มอดูล:Documentation/doc]]
			[[uk:Модуль:Документація/док]]
			[[zh:模块:Documentation/doc]]
	</noinclude>		</noinclude>

minecraft>BoldLuis at 07:58, 4 August 2023

2023-08-04T07:58:44Z

New page

{{Module rating|release}}

{{Lua|Module:Documentation/config|Module:Documentation/i18n|Module:Arguments|Module:Message box|Module:Module wikitext|Module:TNT}}
{{Uses TemplateStyles|Module:Documentation/styles.css}}
This [[module]] displays a blue box containing documentation for [[Special:MyLanguage/Help:templates|templates]], [[Special:MyLanguage/Lua scripting|Lua modules]], or other pages. The {{tlx|documentation}} template invokes it.

== Normal usage ==

For most uses, you should use the {{tlx|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 <code>require</code>:

<syntaxhighlight lang="lua">
local documentation = require('Module:Documentation').main
</syntaxhighlight>

Then you can simply call it using a table of arguments.
<syntaxhighlight lang="lua">
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 [[Template talk:Documentation]] to get the attention of a developer.

<includeonly>{{Sandbox other||

[[Category:Modules{{#translation:}}]]
}}</includeonly><noinclude>
[[Category:Module documentation pages{{#translation:}}]]
</noinclude>