Module:Gapnum/doc - Revision history

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

2024-08-29T21:32:32Z

Added the page to Category:Module documentation pages

← Previous revision		Revision as of 21:32, 29 August 2024
Line 83:		Line 83:
	local n4a,n4b = groups(123.4567,8)		local n4a,n4b = groups(123.4567,8)
	end		end
	</syntaxhighlight>		</syntaxhighlight><noinclude>
			[[Category:Module documentation pages]]
			</noinclude>

WOSlinker: change source to syntaxhighlight

2020-07-07T16:27:41Z

change source to syntaxhighlight

← Previous revision		Revision as of 16:27, 7 July 2020
Line 5:		Line 5:
	The <code>gaps</code> function can be useful for [[MOS:DIGITS\|formatting]] in other modules that work with displaying large numbers.		The <code>gaps</code> function can be useful for [[MOS:DIGITS\|formatting]] in other modules that work with displaying large numbers.

	<~~source~~ lang="lua">		<syntaxhighlight lang="lua">
	local gaps = require('Module:Gapnum').gaps		local gaps = require('Module:Gapnum').gaps
			</syntaxhighlight>
	</source>

	Using the <code>gaps</code> function, the first argument is the number to format. The second argument can be a table with keys that tell the module how to format. The table keys that can be used are:		Using the <code>gaps</code> function, the first argument is the number to format. The second argument can be a table with keys that tell the module how to format. The table keys that can be used are:
Line 15:		Line 15:
	Note that the return statement is a table. This means more styling or text can be added to the wrapper span tag, but it may also mean that <code>tostring()</code> may be required when used in other modules.		Note that the return statement is a table. This means more styling or text can be added to the wrapper span tag, but it may also mean that <code>tostring()</code> may be required when used in other modules.

	<~~source~~ lang="lua">		<syntaxhighlight lang="lua">
	local gaps = require('Module:Gapnum').gaps		local gaps = require('Module:Gapnum').gaps

Line 47:		Line 47:
	local n_small_10 = gaps(n, {gap='1px', prec=10})		local n_small_10 = gaps(n, {gap='1px', prec=10})
	end		end
			</syntaxhighlight>
	</source>

	===groups===		===groups===
	The <code>groups</code> function can be used in other modules to separate a number into groups as <code>gaps</code> does, but instead of a formatted <code>string</code>, the function will return tables whose elements are the separated groups.		The <code>groups</code> function can be used in other modules to separate a number into groups as <code>gaps</code> does, but instead of a formatted <code>string</code>, the function will return tables whose elements are the separated groups.

	<~~source~~ lang="lua">		<syntaxhighlight lang="lua">
	local groups = require('Module:Gapnum').groups		local groups = require('Module:Gapnum').groups

Line 83:		Line 83:
	local n4a,n4b = groups(123.4567,8)		local n4a,n4b = groups(123.4567,8)
	end		end
			</syntaxhighlight>
	</source>

Jimp at 16:05, 29 April 2015

2015-04-29T16:05:00Z

← Previous revision		Revision as of 16:05, 29 April 2015
Line 1:		Line 1:
			This module is used by {{tl\|val}}.
	Implements [[Template:Gapnum]]

	== Use in other modules ==		== Use in other modules ==

The Mol Man at 18:09, 10 January 2015

2015-01-10T18:09:34Z

@@ Line 2: / Line 2: @@
 == Use in other modules ==
 The <code>gaps</code> function can be useful for [[MOS:DIGITS|formatting]] in other modules that work with displaying large numbers.
@@ Line 45: / Line 46: @@
 	local n_big_5 = gaps(n, {gap='1em', prec=5})
 	local n_small_10 = gaps(n, {gap='1px', prec=10})
 end
 </source>

The Mol Man at 18:53, 7 January 2015

2015-01-07T18:53:36Z

← Previous revision		Revision as of 18:53, 7 January 2015
Line 11:		Line 11:
	* <code>gap</code> - a number with CSS units (px, em, en, etc) that define the size of the gap between numbers. If blank, the module will use <code>0.25em</code>.		* <code>gap</code> - a number with CSS units (px, em, en, etc) that define the size of the gap between numbers. If blank, the module will use <code>0.25em</code>.
	* <code>prec</code> - a number that determines the precision of the decimal part of the number. If the precision is less than the number of digits, extra digits will be removed without rounding; if it is more, zeroes will be added to the end to create the desired precision. If blank, the module will use <code>-1</code>, which means the precision will be the same as the number given; no digits added or removed.		* <code>prec</code> - a number that determines the precision of the decimal part of the number. If the precision is less than the number of digits, extra digits will be removed without rounding; if it is more, zeroes will be added to the end to create the desired precision. If blank, the module will use <code>-1</code>, which means the precision will be the same as the number given; no digits added or removed.

			Note that the return statement is a table. This means more styling or text can be added to the wrapper span tag, but it may also mean that <code>tostring()</code> may be required when used in other modules.

	<source lang="lua">		<source lang="lua">

The Mol Man at 16:05, 7 January 2015

2015-01-07T16:05:37Z

← Previous revision		Revision as of 16:05, 7 January 2015
Line 24:		Line 24:
	local n_gaps = gaps(n)		local n_gaps = gaps(n)

	-- ~~Defining~~ a size ~~of gaps~~		-- Different gap size
			-- These will format n into the same groups as above
			-- But the spaces between the groups will be larger and smaller, respectively
	local n_big_gaps = gaps(n, {gap='1em'})		local n_big_gaps = gaps(n, {gap='1em'})
	local n_small_gaps = gaps(n, {gap='1px'})		local n_small_gaps = gaps(n, {gap='1px'})

The Mol Man at 16:02, 7 January 2015

2015-01-07T16:02:05Z

← Previous revision		Revision as of 16:02, 7 January 2015
Line 1:		Line 1:
	Implements [[Template:Gapnum]]		Implements [[Template:Gapnum]]

			== Use in other modules ==
			The <code>gaps</code> function can be useful for [[MOS:DIGITS\|formatting]] in other modules that work with displaying large numbers.

			<source lang="lua">
			local gaps = require('Module:Gapnum').gaps
			</source>

			Using the <code>gaps</code> function, the first argument is the number to format. The second argument can be a table with keys that tell the module how to format. The table keys that can be used are:
			* <code>gap</code> - a number with CSS units (px, em, en, etc) that define the size of the gap between numbers. If blank, the module will use <code>0.25em</code>.
			* <code>prec</code> - a number that determines the precision of the decimal part of the number. If the precision is less than the number of digits, extra digits will be removed without rounding; if it is more, zeroes will be added to the end to create the desired precision. If blank, the module will use <code>-1</code>, which means the precision will be the same as the number given; no digits added or removed.

			<source lang="lua">
			local gaps = require('Module:Gapnum').gaps

			function example()
			local n = 123456.78900011
			-- Example for just simple formatting of a number
			-- n_gaps will use the default, .25em gaps and no change in precision
			-- The result will have its gaps created with inline css
			-- But the result would look like:
			-- 123 456.789 000 11
			local n_gaps = gaps(n)

			-- Defining a size of gaps
			local n_big_gaps = gaps(n, {gap='1em'})
			local n_small_gaps = gaps(n, {gap='1px'})

			-- Different precision
			-- n_prec_5 will use the number 123456.78900
			-- The result would look like:
			-- 123 456.789 00
			local n_prec_5 = gaps(n, {prec=5})
			-- n_prec_10 will use the number 123456.7890001100
			-- The result would look like:
			-- 123 456.789 000 1100
			local n_prec_10 = gaps(n, {prec=10})

			-- Both different gaps and precision can be used:
			local n_big_5 = gaps(n, {gap='1em', prec=5})
			local n_small_10 = gaps(n, {gap='1px', prec=10})
			end
			</source>

The Mol Man: ←Created page with 'Implements Template:Gapnum'

2014-07-05T15:25:10Z

←Created page with 'Implements Template:Gapnum'

New page

Implements [[Template:Gapnum]]