Module:Buffer/doc - Revision history

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

2024-08-29T20:28:31Z

Added the page to Category:Module documentation pages

← Previous revision		Revision as of 20:28, 29 August 2024
Line 842:		Line 842:
	[[Category:Lua metamodules]]		[[Category:Lua metamodules]]
	}}</includeonly>		}}</includeonly>
			<noinclude>
			[[Category:Module documentation pages]]
			</noinclude>

Frietjes: /* Buffer:_G */

2023-01-16T15:37:15Z

Buffer:_G

← Previous revision		Revision as of 15:37, 16 January 2023
Line 464:		Line 464:
	{{anchor\|metaglobal}}		{{anchor\|metaglobal}}

	If the named global already exists, this "backs up" the old value by moving it to the meta __index of the global table, setting a new metatable if none exists.<ref group="note">If the meta global has an __index which is a function ~~(as is the case after requiring [[Module:No globals]])~~, the back-up op aborts without throwing an error.</ref> Retrieving the old value requires unsetting the new one via {{luaself\|:_R}} (more details in that section). If overwritten a third time, the first value is discarded and the second takes its place in the back up.		If the named global already exists, this "backs up" the old value by moving it to the meta __index of the global table, setting a new metatable if none exists.<ref group="note">If the meta global has an __index which is a function, the back-up op aborts without throwing an error.</ref> Retrieving the old value requires unsetting the new one via {{luaself\|:_R}} (more details in that section). If overwritten a third time, the first value is discarded and the second takes its place in the back up.

	If a metaglobal variable exists but the global is nil, this sets the global without unsetting the metaglobal (i.e. does not back up a nil global). An exception is when this is given an explicit nil as ''save'' and only the metaglobal exists; thus, passing nil twice for the same ''name'', unsets the key in both the global table and its metaindex.		If a metaglobal variable exists but the global is nil, this sets the global without unsetting the metaglobal (i.e. does not back up a nil global). An exception is when this is given an explicit nil as ''save'' and only the metaglobal exists; thus, passing nil twice for the same ''name'', unsets the key in both the global table and its metaindex.

Izno: a six item list doesn't need columns, remove unnecessary indents (especially the ones using tables) and
s

2022-11-02T18:02:22Z

a six item list doesn't need columns, remove unnecessary indents (especially the ones using tables) and <br>s

Show changes

John of Reading: Typo fixing, replaced: demonstates → demonstrates

2020-08-31T07:19:38Z

Typo fixing, replaced: demonstates → demonstrates

← Previous revision		Revision as of 07:19, 31 August 2020
Line 476:		Line 476:
	{{luaself\|:_R\|args=name, save\|args2='new_G', var, metaindex}}		{{luaself\|:_R\|args=name, save\|args2='new_G', var, metaindex}}

	This {{luaref\|rawset\|\|y}} with the global table as the first argument and <code>name</code> and <code>save</code> as the second and third, respectively, returning the Buffer object for call chaining.<ref group="example">The following ~~demonstates~~ how, by combining Buffer:_R and Buffer:_G, the global variable ''v'' can be declared, backed-up and replaced, replaced without back-up, restored from back-up, and removed completely:		This {{luaref\|rawset\|\|y}} with the global table as the first argument and <code>name</code> and <code>save</code> as the second and third, respectively, returning the Buffer object for call chaining.<ref group="example">The following demonstrates how, by combining Buffer:_R and Buffer:_G, the global variable ''v'' can be declared, backed-up and replaced, replaced without back-up, restored from back-up, and removed completely:
	:{\|		:{\|
	\|{{#tag:syntaxhighlight\|require'Module:Buffer'		\|{{#tag:syntaxhighlight\|require'Module:Buffer'

Anomalocaris: properly close template (}}); properly close italics ('')

2019-08-26T07:59:44Z

properly close template (}}); properly close italics ('')

← Previous revision		Revision as of 07:59, 26 August 2019
Line 408:		Line 408:
	Because {{luaself\|:_B}} takes only one argument, args._B only unpacks the first index and starts the iteration after that key.		Because {{luaself\|:_B}} takes only one argument, args._B only unpacks the first index and starts the iteration after that key.

	If neither of the first two keys evaluate true, this assumes the paired value is a string for use as the ''name'' argument for the function matching its key.<ref group="note">A caveat of this unconventional type checking is that pairing an args.globalFunction with a number value will throw an error (which shouldn't be a problem since numbers make poor names for global variables).</ref> In that case, the current call stack's ''self'' (an Element-Buffer or [[#args.tag\|tag.nodes]] if this was called indirectly) is ''self' for the global function.		If neither of the first two keys evaluate true, this assumes the paired value is a string for use as the ''name'' argument for the function matching its key.<ref group="note">A caveat of this unconventional type checking is that pairing an args.globalFunction with a number value will throw an error (which shouldn't be a problem since numbers make poor names for global variables).</ref> In that case, the current call stack's ''self'' (an Element-Buffer or [[#args.tag\|tag.nodes]] if this was called indirectly) is ''self'' for the global function.

	======args.''htmlFunction''======		======args.''htmlFunction''======
Line 431:		Line 431:
	<div style='font-size:smaller;'>		<div style='font-size:smaller;'>
	----		----
	{{note label\|skip1\|†\|\| Unlike with tables passed directly, [[Recursion (computer science)\|recursive]] iterations for functions marked with <sup>†</sup> start at the smallest number greater than {{code\|lang=lua\|1}} instead of negative infinity.		{{note label\|skip1\|†\|\| Unlike with tables passed directly, [[Recursion (computer science)\|recursive]] iterations for functions marked with <sup>†</sup> start at the smallest number greater than {{code\|lang=lua\|1}} instead of negative infinity.}}

	{{note label\|skip2\|‡\|\| The iteration may start after {{code\|lang=lua\|2}} for some global functions.}}		{{note label\|skip2\|‡\|\| The iteration may start after {{code\|lang=lua\|2}} for some global functions.}}

AnomieBOT: Substing templates: {{Incomplete}}. See User:AnomieBOT/docs/TemplateSubster for info.

2018-10-12T02:02:46Z

Substing templates: {{Incomplete}}. See User:AnomieBOT/docs/TemplateSubster for info.

← Previous revision		Revision as of 02:02, 12 October 2018
Line 812:		Line 812:
	{{anchor\|tips\|Tips}}		{{anchor\|tips\|Tips}}
	===Tips and style recommendations===		===Tips and style recommendations===
	{{incomplete\|section}}

	* If [[#Buffer\|joining Buffer]] with a string immediately after <code>:_'<i>text</i>'</code>, place a space between 'string' and the [[#Buffer\|separator]] and use double/single quote marks to . (i.e. <code>:_'<i>text</i>' " "</code> instead of <code>:_'<i>text</i>'{{`}} '</code> or <code>:_'<i>text</i>'(' ')</code>)		* If [[#Buffer\|joining Buffer]] with a string immediately after <code>:_'<i>text</i>'</code>, place a space between 'string' and the [[#Buffer\|separator]] and use double/single quote marks to . (i.e. <code>:_'<i>text</i>' " "</code> instead of <code>:_'<i>text</i>'{{`}} '</code> or <code>:_'<i>text</i>'(' ')</code>)

Jonesey95: Fix unsupported parameter in Template:Columns-list or Template:Div col using AutoEd

2018-07-22T16:53:14Z

Fix unsupported parameter in Template:Columns-list or Template:Div col using AutoEd

← Previous revision		Revision as of 16:53, 22 July 2018
Line 639:		Line 639:
	You may directly chain any function from the following libraries on Buffer objects:		You may directly chain any function from the following libraries on Buffer objects:
	:{\|		:{\|
	\|{{collist\|3\|colwidth=15em\|style=width:49em\|		\|{{collist\|colwidth=15em\|style=width:49em\|
	* {{luaref\|String library\|string\|y}}		* {{luaref\|String library\|string\|y}}
	* {{luaref\|Text library\|mw.text\|y}}		* {{luaref\|Text library\|mw.text\|y}}

PrimeBOT: Task 24 - replace template usage following a TFD

2018-05-10T20:51:45Z

Task 24 - replace template usage following a TFD

← Previous revision		Revision as of 20:51, 10 May 2018
Line 460:		Line 460:
	====Buffer:_G====		====Buffer:_G====
	{{luaself\|:_G\|args=name, save}}		{{luaself\|:_G\|args=name, save}}
	{{~~Distinguish2~~\|the [[#G object\|§ _G object]], which chain call looks the same but may behave differently.}}		{{distinguish\|text=the [[#G object\|§ _G object]], which chain call looks the same but may behave differently.}}

	Pass <code>name</code> and <code>save</code> to assign the object passed as ''save'' to a global variable via {{luaref\|rawset\|args=_G, name, save}}.<ref group="note">Actually, the first argument to rawset is a local variable <code>[[#new_G\|new_G]]</code> which generally equals _G but not always, to be detailed in a later section.</ref>		Pass <code>name</code> and <code>save</code> to assign the object passed as ''save'' to a global variable via {{luaref\|rawset\|args=_G, name, save}}.<ref group="note">Actually, the first argument to rawset is a local variable <code>[[#new_G\|new_G]]</code> which generally equals _G but not always, to be detailed in a later section.</ref>
Line 583:		Line 583:
	<code>chained-object:_G'string'</code>		<code>chained-object:_G'string'</code>

	{{~~Distinguish2~~\|[[#Buffer:_G\|§ Buffer:_G]], the Buffer object function, which differences are noted in the final paragraph of this section.}}		{{distinguish\|text=[[#Buffer:_G\|§ Buffer:_G]], the Buffer object function, which differences are noted in the final paragraph of this section.}}

	When used in a call chain, this rawsets the ''k''ey-''v''alue pair in the chained object and returns that object. The _G object may chain itself when returning _G is desired for another op instead of ''v''.		When used in a call chain, this rawsets the ''k''ey-''v''alue pair in the chained object and returns that object. The _G object may chain itself when returning _G is desired for another op instead of ''v''.

Ludwig20 at 14:49, 20 April 2017

2017-04-20T14:49:16Z

← Previous revision		Revision as of 14:49, 20 April 2017
Line 3:		Line 3:
	{{High-risk\|2,000,000+}}		{{High-risk\|2,000,000+}}
	{{TOC right}}		{{TOC right}}
			{{Module rating\|protected}}
	This was originally developed to optimize string concatenation as a helper method within [[Module:Asbox]], but has been generalized for all modules.		This was originally developed to optimize string concatenation as a helper method within [[Module:Asbox]], but has been generalized for all modules.

Dinoguy1000: newline/whitespace cleanup (though a lot of this feels like it just needs rewritten)

2016-09-09T12:00:01Z

newline/whitespace cleanup (though a lot of this feels like it just needs rewritten)