Module:OutputBuffer/doc - Revision history

Mr. Stradivarius: /* printf */ fix string.format link

2024-10-27T12:18:42Z

printf: fix string.format link

← Previous revision		Revision as of 12:18, 27 October 2024
Line 37:		Line 37:
	</syntaxhighlight>		</syntaxhighlight>

	Adds the string <var>s</var> to the buffer. The string is formatted with any subsequent arguments, following the rules used for [[mw:Extension:Scribunto/Lua reference manual#~~String~~.format\|string.format]].		Adds the string <var>s</var> to the buffer. The string is formatted with any subsequent arguments, following the rules used for [[mw:Extension:Scribunto/Lua reference manual#string.format\|string.format]].

	== Example ==		== Example ==

WOSlinker: change source to syntaxhighlight

2020-07-07T16:26:01Z

change source to syntaxhighlight

← Previous revision		Revision as of 16:26, 7 July 2020
Line 5:		Line 5:
	First, load the module.		First, load the module.

	<~~source~~ lang="lua">		<syntaxhighlight lang="lua">
	local newBuffer = require('Module:OutputBuffer')		local newBuffer = require('Module:OutputBuffer')
			</syntaxhighlight>
	</source>

	Then, create the buffer and the functions that act on it.		Then, create the buffer and the functions that act on it.

	<~~source~~ lang="lua">		<syntaxhighlight lang="lua">
	local getBuffer, print, printf = newBuffer()		local getBuffer, print, printf = newBuffer()
			</syntaxhighlight>
	</source>

	=== getBuffer ===		=== getBuffer ===

	<~~source~~ lang="lua">		<syntaxhighlight lang="lua">
	local text = getBuffer(sep)		local text = getBuffer(sep)
			</syntaxhighlight>
	</source>

	Returns the contents of the buffer, with an optional separator string <var>sep</var>.		Returns the contents of the buffer, with an optional separator string <var>sep</var>.
Line 25:		Line 25:
	=== print ===		=== print ===

	<~~source~~ lang="lua">		<syntaxhighlight lang="lua">
	print(s)		print(s)
			</syntaxhighlight>
	</source>

	Adds the string <var>s</var> to the buffer.		Adds the string <var>s</var> to the buffer.
Line 33:		Line 33:
	=== printf ===		=== printf ===

	<~~source~~ lang="lua">		<syntaxhighlight lang="lua">
	printf(s, ...)		printf(s, ...)
			</syntaxhighlight>
	</source>

	Adds the string <var>s</var> to the buffer. The string is formatted with any subsequent arguments, following the rules used for [[mw:Extension:Scribunto/Lua reference manual#String.format\|string.format]].		Adds the string <var>s</var> to the buffer. The string is formatted with any subsequent arguments, following the rules used for [[mw:Extension:Scribunto/Lua reference manual#String.format\|string.format]].
Line 41:		Line 41:
	== Example ==		== Example ==

	<~~source~~ lang="lua">		<syntaxhighlight lang="lua">
	local newBuffer = require('Module:OutputBuffer')		local newBuffer = require('Module:OutputBuffer')
	local p = {}		local p = {}
Line 57:		Line 57:
	-- {{#invoke:TestModule\|main}} would output:		-- {{#invoke:TestModule\|main}} would output:
	-- "Welcome to the English Wikipedia. There are currently 4500000 articles on this site."		-- "Welcome to the English Wikipedia. There are currently 4500000 articles on this site."
			</syntaxhighlight>
	</source>

	<includeonly>{{#ifeq:{{SUBPAGENAME}}\|sandbox \| \|		<includeonly>{{#ifeq:{{SUBPAGENAME}}\|sandbox \| \|

Eric Wieser at 11:48, 7 June 2015

2015-06-07T11:48:12Z

← Previous revision		Revision as of 11:48, 7 June 2015
Line 61:		Line 61:
	<includeonly>{{#ifeq:{{SUBPAGENAME}}\|sandbox \| \|		<includeonly>{{#ifeq:{{SUBPAGENAME}}\|sandbox \| \|
	<!-- Categories below this line, please; interwikis at Wikidata -->		<!-- Categories below this line, please; interwikis at Wikidata -->
			[[Category:Lua metamodules]]

	}}</includeonly>		}}</includeonly>

Mr. Stradivarius: create

2014-12-24T06:28:19Z

create

New page

This module provides an easy and efficient way to generate lengthy strings.

== Usage ==

First, load the module.

<source lang="lua">
local newBuffer = require('Module:OutputBuffer')
</source>

Then, create the buffer and the functions that act on it.

<source lang="lua">
local getBuffer, print, printf = newBuffer()
</source>

=== getBuffer ===

<source lang="lua">
local text = getBuffer(sep)
</source>

Returns the contents of the buffer, with an optional separator string <var>sep</var>.

=== print ===

<source lang="lua">
print(s)
</source>

Adds the string <var>s</var> to the buffer.

=== printf ===

<source lang="lua">
printf(s, ...)
</source>

Adds the string <var>s</var> to the buffer. The string is formatted with any subsequent arguments, following the rules used for [[mw:Extension:Scribunto/Lua reference manual#String.format|string.format]].

== Example ==

<source lang="lua">
local newBuffer = require('Module:OutputBuffer')
local p = {}

function p.main()
local getBuffer, print, printf = newBuffer()
print('Welcome to the English Wikipedia.')
printf('There are currently %d articles on this site.', mw.site.stats.articles)
return getBuffer(' ')
end

return p

-- Assuming this module's name is "TestModule", and that mw.site.stats.articles returns 4500000,
-- {{#invoke:TestModule|main}} would output:
-- "Welcome to the English Wikipedia. There are currently 4500000 articles on this site."
</source>

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |


}}</includeonly>