Module:Documentation/doc - Revision history

2604:3D08:9476:BE00:190E:ABE1:77B4:9F05 at 22:24, 3 September 2024

2024-09-03T22:24:55Z

← Previous revision		Revision as of 22:24, 3 September 2024
Line 1:		Line 1:
	{{Used in system\|in [[MediaWiki:Scribunto-doc-page-show]] ~~and~~ [[MediaWiki:Scribunto-doc-page-does-not-exist]]}}		{{Used in system\|in [[MediaWiki:Scribunto-doc-page-show]], in [[MediaWiki:Scribunto-doc-page-does-not-exist]]}}
	{{Module rating\|protected}}		{{Module rating\|protected}}
	{{Lua\|Module:Documentation/config\|Module:Arguments\|Module:Message box\|Module:Module wikitext\|Module:Protection banner}}		{{Lua\|Module:Documentation/config\|Module:Arguments\|Module:Message box\|Module:Module wikitext\|Module:Protection banner}}

Warudo: Added the page to :Category:Module documentation pages

2024-08-29T21:09:27Z

Added the page to Category:Module documentation pages

← Previous revision		Revision as of 21:09, 29 August 2024
Line 28:		Line 28:
	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 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]].		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]].<noinclude>
			[[Category:Module documentation pages]]
			</noinclude>

Kingdom of Baustralia: Inspection w/ Inspect Element shows colour as a green hue, not blue.

2024-06-19T01:06:22Z

Inspection w/ Inspect Element shows colour as a green hue, not blue.

← Previous revision		Revision as of 01:06, 19 June 2024
Line 3:		Line 3:
	{{Lua\|Module:Documentation/config\|Module:Arguments\|Module:Message box\|Module:Module wikitext\|Module:Protection banner}}		{{Lua\|Module:Documentation/config\|Module:Arguments\|Module:Message box\|Module:Module wikitext\|Module:Protection banner}}
	{{Uses TemplateStyles\|Module:Documentation/styles.css}}		{{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.		This module displays a green box containing documentation for [[Help:Template\|templates]], [[Wikipedia:Lua\|Lua modules]], or other pages. The {{tl\|documentation}} template invokes it.

	== Normal usage ==		== Normal usage ==

Annh07: Reverted edit by 172.56.200.177 (talk) to last version by Awesome Aasim

2024-06-14T14:00:09Z

Reverted edit by 172.56.200.177 (talk) to last version by Awesome Aasim

← Previous revision		Revision as of 14:00, 14 June 2024
Line 1:		Line 1:
	{{Used in system\|in [[MediaWiki:Scribunto-doc-page-show]] and [[MediaWiki:Scribunto-doc-page-~~snake ass bitch ass lame disloyal scum t~~]]}}		{{Used in system\|in [[MediaWiki:Scribunto-doc-page-show]] and [[MediaWiki:Scribunto-doc-page-does-not-exist]]}}
	{{Module \|protected}}		{{Module rating\|protected}}
	{{Lua\|Module:Documentation/config\|~~Modu~~\|Module:Protection banner}}		{{Lua\|Module:Documentation/config\|Module:Arguments\|Module:Message box\|Module:Module wikitext\|Module:Protection banner}}
	{{Uses TemplateStyles\|Module:Documentation/styles.css}}		{{Uses TemplateStyles\|Module:Documentation/styles.css}}
	This module displays a blue box containing documentation for [[Help:Template\|templates]], [[Wikipedia:\| modules]], or other pages. The {{tl\|documentation}} template invokes it.		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.

	== Normal usage ==		== Normal usage ==
Line 13:		Line 13:
	To use this module from another Lua module, first load it with <code>require</code>:		To use this module from another Lua module, first load it with <code>require</code>:

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

	Then you can simply call it using a table of arguments.		Then you can simply call it using a table of arguments.
	<syntaxhighlight ~~lag~~="">		<syntaxhighlight lang="lua">
	documentation{content = 'Some documentation', ['link box'] = 'My custom link box'}		documentation{content = 'Some documentation', ['link box'] = 'My custom link box'}
			</syntaxhighlight>
	</syntax highlight>

	Please refer to the [[Template:Documentation/doc\|template documentation]] for usage instructions and a list of parameters.		Please refer to the [[Template:Documentation/doc\|template documentation]] for usage instructions and a list of parameters.
Line 26:		Line 26:
	== Porting to other wikis ==		== 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="~~plaid links~~">[https://en.wikipedia.org/wiki/Template_talk:Documentation Template talk:Documentation]</~~san~~><!-- 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 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]].

172.56.200.177 at 12:20, 14 June 2024

2024-06-14T12:20:07Z

← Previous revision		Revision as of 12:20, 14 June 2024
Line 1:		Line 1:
	{{Used in system\|in [[MediaWiki:Scribunto-doc-page-show]] and [[MediaWiki:Scribunto-doc-page-~~does-not-exist~~]]}}		{{Used in system\|in [[MediaWiki:Scribunto-doc-page-show]] and [[MediaWiki:Scribunto-doc-page-snake ass bitch ass lame disloyal scum t]]}}
	{{Module ~~rating~~\|protected}}		{{Module \|protected}}
	{{Lua\|Module:Documentation/config\|~~Module:Arguments\|Module:Message box\|Module:Module wikitext~~\|Module:Protection banner}}		{{Lua\|Module:Documentation/config\|Modu\|Module:Protection banner}}
	{{Uses TemplateStyles\|Module:Documentation/styles.css}}		{{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.		This module displays a blue box containing documentation for [[Help:Template\|templates]], [[Wikipedia:\| modules]], or other pages. The {{tl\|documentation}} template invokes it.

	== Normal usage ==		== Normal usage ==
Line 13:		Line 13:
	To use this module from another Lua module, first load it with <code>require</code>:		To use this module from another Lua module, first load it with <code>require</code>:

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

	Then you can simply call it using a table of arguments.		Then you can simply call it using a table of arguments.
	<syntaxhighlight ~~lang~~="~~lua~~">		<syntaxhighlight lag="">
	documentation{content = 'Some documentation', ['link box'] = 'My custom link box'}		documentation{content = 'Some documentation', ['link box'] = 'My custom link box'}
			</syntax highlight>
	</syntaxhighlight>

	Please refer to the [[Template:Documentation/doc\|template documentation]] for usage instructions and a list of parameters.		Please refer to the [[Template:Documentation/doc\|template documentation]] for usage instructions and a list of parameters.
Line 26:		Line 26:
	== Porting to other wikis ==		== 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 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="plaid links">[https://en.wikipedia.org/wiki/Template_talk:Documentation Template talk:Documentation]</san><!-- 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]].

Awesome Aasim at 00:29, 1 March 2024

2024-03-01T00:29:10Z

← Previous revision		Revision as of 00:29, 1 March 2024
Line 1:		Line 1:
			{{Used in system\|in [[MediaWiki:Scribunto-doc-page-show]] and [[MediaWiki:Scribunto-doc-page-does-not-exist]]}}
	{{used in system}}
	{{Module rating\|protected}}		{{Module rating\|protected}}
	{{Lua\|Module:Documentation/config\|Module:Arguments\|Module:Message box\|Module:Module wikitext\|Module:Protection banner}}		{{Lua\|Module:Documentation/config\|Module:Arguments\|Module:Message box\|Module:Module wikitext\|Module:Protection banner}}

Pppery: Rv blanking

2022-09-11T15:13:25Z

Rv blanking

← Previous revision	Revision as of 15:13, 11 September 2022
Line 1:	Line 1:
		{{used in system}}
		{{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.

		== Normal usage ==

		For most uses, you should use the {{tl\|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 <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]].

2600:6C48:4E7F:B2B9:9D0F:B2D6:9BCF:C7F9: {{used in system}} {{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 templates, Lua modules, or other pages. The {{tl|documentation}} template invokes it. == Normal usage == For most uses, you should use the {{tl|documentation}} template; pleas...

2022-09-10T17:28:07Z

{{used in system}} {{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 templates, Lua modules, or other pages. The {{tl|documentation}} template invokes it. == Normal usage == For most uses, you should use the {{tl|documentation}} template; pleas...

← Previous revision		Revision as of 17:28, 10 September 2022
Line 1:		Line 1:
	{{used in system}}
	{{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.

	== Normal usage ==

	For most uses, you should use the {{tl\|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 <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]].

JrandWP: mediawiki page of lua documentation

2021-10-20T12:26:56Z

mediawiki page of lua documentation

← Previous revision		Revision as of 12:26, 20 October 2021
Line 1:		Line 1:
	{{~~High-use\|115172~~}}		{{used in system}}
	{{Module rating\|protected}}		{{Module rating\|protected}}
	{{Lua\|Module:Documentation/config\|Module:Arguments\|Module:Message box\|Module:Module wikitext\|Module:Protection banner}}		{{Lua\|Module:Documentation/config\|Module:Arguments\|Module:Message box\|Module:Module wikitext\|Module:Protection banner}}

Izno: /* Porting to other wikis */ add message keys for customizing

2021-08-01T15:33:19Z

Porting to other wikis: add message keys for customizing

← Previous revision		Revision as of 15:33, 1 August 2021
Line 27:		Line 27:

	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 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]].