Print (Stringlist function) - Revision history

JAL: /* Usage notes */

2012-10-31T19:34:28Z

Usage notes

← Older revision		Revision as of 19:34, 31 October 2012
Line 25:		Line 25:
	<li>The parameter names were introduced in <var class="product">Sirius Mods</var> Version 7.0; for versions prior to that, the parameters can only be specified positionally.		<li>The parameter names were introduced in <var class="product">Sirius Mods</var> Version 7.0; for versions prior to that, the parameters can only be specified positionally.
	For example, to display the contents of a <var>Stringlist</var> with 6 bytes to be used for the column containing the item width, and limiting the display to 20 items, you can use positional parameters:		For example, to display the contents of a <var>Stringlist</var> with 6 bytes to be used for the column containing the item width, and limiting the display to 20 items, you can use positional parameters:

	<p class="code">%listrint(,6,,20)		<p class="code">%listrint(,6,,20)
	</p>		</p>
	~~<li>Under <var class="product">Sirius Mods</var> 7.0 and later, you can do the same thing with named parameters:~~

			Under <var class="product">Sirius Mods</var> 7.0 and later, you can do the same thing with named parameters:
	<p class="code">%listrint(lenWidth=6, maxItems=20)		<p class="code">%listrint(lenWidth=6, maxItems=20)
	</p>		</p>

JALWiccan: 1 revision

2011-07-14T19:40:25Z

1 revision

← Older revision	Revision as of 19:40, 14 July 2011
(No difference)

JALWiccan: 1 revision

2011-07-14T19:40:22Z

1 revision

← Older revision		Revision as of 19:40, 14 July 2011
Line 1:		Line 1:
	{{Template:Stringlist:Print subtitle}}		{{Template:Stringlist:Print subtitle}}

	This [[Notation conventions for methods#Callable ~~methods~~\|callable]] method displays the contents of a <var>Stringlist</var> on the user's standard output device, typically a terminal.		This [[Notation conventions for methods#Callable functions\|callable]] method displays the contents of a <var>Stringlist</var> on the user's standard output device, typically a terminal.

	==Syntax==		==Syntax==

JALWiccan: 1 revision

2011-04-13T22:33:40Z

1 revision

← Older revision	Revision as of 22:33, 13 April 2011
(No difference)

JAL2: /* Syntax terms */

2011-04-13T22:33:38Z

Syntax terms

← Older revision		Revision as of 22:33, 13 April 2011
Line 11:		Line 11:
	<tr><th>sl</th>		<tr><th>sl</th>
	<td>The <var>Stringlist</var> object. </td></tr>		<td>The <var>Stringlist</var> object. </td></tr>
	<tr><th>NumWidth</th>		<tr><th><var>NumWidth</var></th>
	<td>The number of bytes in the display of each line to use for the item number. The parameter name, <var>NumWidth</var>, is optional. The length must be a number between 0 and 10 inclusive; if it is greater than 0, a blank is placed after the item number. Item numbers are right-justified within the indicated number of bytes, and they are truncated on the left if the length of the item number exceeds the space allocated for it. <p>This is an optional argument; it defaults to zero, which means the item numbers are not displayed. </p></td></tr>		<td>The number of bytes in the display of each line to use for the item number. The parameter name, <var>NumWidth</var>, is optional. The length must be a number between 0 and 10 inclusive; if it is greater than 0, a blank is placed after the item number. Item numbers are right-justified within the indicated number of bytes, and they are truncated on the left if the length of the item number exceeds the space allocated for it. <p>This is an optional argument; it defaults to zero, which means the item numbers are not displayed. </p></td></tr>
	<tr><th>LenWidth</th>		<tr><th><var>LenWidth</var></th>
	<td>The number of bytes in the display of each line to use for the item length. The parameter name, <var>LenWidth</var>, is optional. The length must be a number between 0 and 4 inclusive; if it is greater than 0, a blank is placed after the item length. Item lengths are right-justified within the indicated number of bytes, and they are truncated on the left if the length of the item length exceeds the space allocated for it. <p>This is an optional argument; it defaults to zero, which means the item lengths are not displayed. </p></td></tr>		<td>The number of bytes in the display of each line to use for the item length. The parameter name, <var>LenWidth</var>, is optional. The length must be a number between 0 and 4 inclusive; if it is greater than 0, a blank is placed after the item length. Item lengths are right-justified within the indicated number of bytes, and they are truncated on the left if the length of the item length exceeds the space allocated for it. <p>This is an optional argument; it defaults to zero, which means the item lengths are not displayed. </p></td></tr>
	<tr><th>Start</th>		<tr><th><var>Start</var></th>
	<td>The number of the initial item to display. The parameter name, <var>Start</var>, is optional. <p>This is an optional argument, and it defaults to 1. </p></td></tr>		<td>The number of the initial item to display. The parameter name, <var>Start</var>, is optional. <p>This is an optional argument, and it defaults to 1. </p></td></tr>
	<tr><th>MaxItems</th>		<tr><th><var>MaxItems</var></th>
	<td>The maximum number of items to display. The parameter name, <var>MaxItems</var>, is optional. A zero or negative value means to display all the <var class="term">sl</var> items. <p>This is an optional argument; it defaults to zero, which means display to the end of <var class="term">sl</var>.</p></td></tr>		<td>The maximum number of items to display. The parameter name, <var>MaxItems</var>, is optional. A zero or negative value means to display all the <var class="term">sl</var> items. <p>This is an optional argument; it defaults to zero, which means display to the end of <var class="term">sl</var>.</p></td></tr>
	</table>		</table>

JAL2: /* Syntax terms */

2011-04-13T21:00:40Z

Syntax terms

← Older revision		Revision as of 21:00, 13 April 2011
Line 12:		Line 12:
	<td>The <var>Stringlist</var> object. </td></tr>		<td>The <var>Stringlist</var> object. </td></tr>
	<tr><th>NumWidth</th>		<tr><th>NumWidth</th>
	<td>The number of bytes in the display of each line to use for the item number. The parameter name, <var ~~class="term"~~>NumWidth</var>, is optional. The length must be a number between 0 and 10 inclusive; if it is greater than 0, a blank is placed after the item number. Item numbers are right-justified within the indicated number of bytes, and they are truncated on the left if the length of the item number exceeds the space allocated for it. <p>This is an optional argument; it defaults to zero, which means the item numbers are not displayed. </p></td></tr>		<td>The number of bytes in the display of each line to use for the item number. The parameter name, <var>NumWidth</var>, is optional. The length must be a number between 0 and 10 inclusive; if it is greater than 0, a blank is placed after the item number. Item numbers are right-justified within the indicated number of bytes, and they are truncated on the left if the length of the item number exceeds the space allocated for it. <p>This is an optional argument; it defaults to zero, which means the item numbers are not displayed. </p></td></tr>
	<tr><th>LenWidth</th>		<tr><th>LenWidth</th>
	<td>The number of bytes in the display of each line to use for the item length. The parameter name, <var ~~class="term"~~>LenWidth</var>, is optional. The length must be a number between 0 and 4 inclusive; if it is greater than 0, a blank is placed after the item length. Item lengths are right-justified within the indicated number of bytes, and they are truncated on the left if the length of the item length exceeds the space allocated for it. <p>This is an optional argument; it defaults to zero, which means the item lengths are not displayed. </p></td></tr>		<td>The number of bytes in the display of each line to use for the item length. The parameter name, <var>LenWidth</var>, is optional. The length must be a number between 0 and 4 inclusive; if it is greater than 0, a blank is placed after the item length. Item lengths are right-justified within the indicated number of bytes, and they are truncated on the left if the length of the item length exceeds the space allocated for it. <p>This is an optional argument; it defaults to zero, which means the item lengths are not displayed. </p></td></tr>
	<tr><th>Start</th>		<tr><th>Start</th>
	<td>The number of the initial item to display. The parameter name, <var ~~class="term"~~>Start</var>, is optional. <p>This is an optional argument, and it defaults to 1. </p></td></tr>		<td>The number of the initial item to display. The parameter name, <var>Start</var>, is optional. <p>This is an optional argument, and it defaults to 1. </p></td></tr>
	<tr><th>MaxItems</th>		<tr><th>MaxItems</th>
	<td>The maximum number of items to display. The parameter name, <var ~~class="term"~~>MaxItems</var>, is optional. A zero or negative value means to display all the <var class="term">sl</var> items. <p>This is an optional argument; it defaults to zero, which means display to the end of <var class="term">sl</var>.</p></td></tr>		<td>The maximum number of items to display. The parameter name, <var>MaxItems</var>, is optional. A zero or negative value means to display all the <var class="term">sl</var> items. <p>This is an optional argument; it defaults to zero, which means display to the end of <var class="term">sl</var>.</p></td></tr>
	</table>		</table>

JAL at 02:06, 9 March 2011

2011-03-09T02:06:42Z

← Older revision		Revision as of 02:06, 9 March 2011
Line 1:		Line 1:
	{{Template:Stringlist:Print subtitle}}		{{Template:Stringlist:Print subtitle}}

	This callable method displays the contents of a <var>Stringlist</var> on the user's standard output device, typically a terminal.		This [[Notation conventions for methods#Callable methods\|callable]] method displays the contents of a <var>Stringlist</var> on the user's standard output device, typically a terminal.

	==Syntax==		==Syntax==

JAL at 19:38, 28 January 2011

2011-01-28T19:38:02Z

← Older revision		Revision as of 19:38, 28 January 2011
Line 12:		Line 12:
	<td>The <var>Stringlist</var> object. </td></tr>		<td>The <var>Stringlist</var> object. </td></tr>
	<tr><th>NumWidth</th>		<tr><th>NumWidth</th>
	<td>The number of bytes in the display of each line to use for the item number. The parameter name, <var class="term">NumWidth</var>, is optional. The length must be a number between 0 and 10 inclusive; if it is greater than 0, a blank is placed after the item number. Item numbers are right-justified within the indicated number of bytes, and they are truncated on the left if the length of the item number exceeds the space allocated for it. This is an optional argument; it defaults to zero, which means the item numbers are not displayed. </td></tr>		<td>The number of bytes in the display of each line to use for the item number. The parameter name, <var class="term">NumWidth</var>, is optional. The length must be a number between 0 and 10 inclusive; if it is greater than 0, a blank is placed after the item number. Item numbers are right-justified within the indicated number of bytes, and they are truncated on the left if the length of the item number exceeds the space allocated for it. <p>This is an optional argument; it defaults to zero, which means the item numbers are not displayed. </p></td></tr>
	<tr><th>LenWidth</th>		<tr><th>LenWidth</th>
	<td>The number of bytes in the display of each line to use for the item length. The parameter name, <var class="term">LenWidth</var>, is optional. The length must be a number between 0 and 4 inclusive; if it is greater than 0, a blank is placed after the item length. Item lengths are right-justified within the indicated number of bytes, and they are truncated on the left if the length of the item length exceeds the space allocated for it. This is an optional argument; it defaults to zero, which means the item lengths are not displayed. </td></tr>		<td>The number of bytes in the display of each line to use for the item length. The parameter name, <var class="term">LenWidth</var>, is optional. The length must be a number between 0 and 4 inclusive; if it is greater than 0, a blank is placed after the item length. Item lengths are right-justified within the indicated number of bytes, and they are truncated on the left if the length of the item length exceeds the space allocated for it. <p>This is an optional argument; it defaults to zero, which means the item lengths are not displayed. </p></td></tr>
	<tr><th>Start</th>		<tr><th>Start</th>
	<td>~~This is the~~ number of the initial item to display. This is an optional argument, and it defaults to 1. </td></tr>		<td>The number of the initial item to display. The parameter name, <var class="term">Start</var>, is optional. <p>This is an optional argument, and it defaults to 1. </p></td></tr>
	<tr><th>MaxItems</th>		<tr><th>MaxItems</th>
	<td>~~This is the~~ maximum number of items to display. A zero or negative value means to display all the <var class="term">sl</var> items. This is an optional argument; it defaults to zero, which means display to the end of <var class="term">sl</var>.</td></tr>		<td>The maximum number of items to display. The parameter name, <var class="term">MaxItems</var>, is optional. A zero or negative value means to display all the <var class="term">sl</var> items. <p>This is an optional argument; it defaults to zero, which means display to the end of <var class="term">sl</var>.</p></td></tr>
	</table>		</table>

JAL: typos

2011-01-28T00:16:23Z

typos

← Older revision		Revision as of 00:16, 28 January 2011
Line 8:		Line 8:
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%count</th>		<tr><th>%count</th>
	<td>~~An, optional,~~ numeric variable that is set to the number of <var>Stringlist</var> items displayed. </td></tr>		<td>A numeric variable that is set to the number of <var>Stringlist</var> items displayed. </td></tr>
	<tr><th>sl</th>		<tr><th>sl</th>
	<td>The <var>Stringlist</var> object. </td></tr>		<td>The <var>Stringlist</var> object. </td></tr>
	<tr><th>NumWidth</th>		<tr><th>NumWidth</th>
	<td>The~~, optional,~~ number of bytes in the display of each line to use for the item number. The parameter name <var class="term">NumWidth</var> is optional. The length must be a number between 0 and 10 inclusive; if it is greater than 0, a blank is placed after the item number. Item numbers are right-justified within the indicated number of bytes, and they are truncated on the left if the length of the item number exceeds the space allocated for it. This is an optional argument; it defaults to zero, which means the item numbers are not displayed. </td></tr>		<td>The number of bytes in the display of each line to use for the item number. The parameter name, <var class="term">NumWidth</var>, is optional. The length must be a number between 0 and 10 inclusive; if it is greater than 0, a blank is placed after the item number. Item numbers are right-justified within the indicated number of bytes, and they are truncated on the left if the length of the item number exceeds the space allocated for it. This is an optional argument; it defaults to zero, which means the item numbers are not displayed. </td></tr>
	<tr><th>LenWidth</th>		<tr><th>LenWidth</th>
	<td>The number of bytes in the display of each line to use for the item length. The parameter name <var class="term">LenWidth</var> is optional. The length must be a number between 0 and 4 inclusive; if it is greater than 0, a blank is placed after the item length. Item lengths are right-justified within the indicated number of bytes, and they are truncated on the left if the length of the item length exceeds the space allocated for it. This is an optional argument; it defaults to zero, which means the item lengths are not displayed. </td></tr>		<td>The number of bytes in the display of each line to use for the item length. The parameter name, <var class="term">LenWidth</var>, is optional. The length must be a number between 0 and 4 inclusive; if it is greater than 0, a blank is placed after the item length. Item lengths are right-justified within the indicated number of bytes, and they are truncated on the left if the length of the item length exceeds the space allocated for it. This is an optional argument; it defaults to zero, which means the item lengths are not displayed. </td></tr>
	<tr><th>Start</th>		<tr><th>Start</th>
	<td>This is the number of the initial item to display. This is an optional argument, and it defaults to 1. </td></tr>		<td>This is the number of the initial item to display. This is an optional argument, and it defaults to 1. </td></tr>
	<tr><th>MaxItems</th>		<tr><th>MaxItems</th>
	<td>This is the maximum number of items to display. A zero or negative value means to display all the <var class="term">sl</var> items. This is an optional argument; it defaults to zero, which means display to the end of ~~the~~ <var class="term">sl</var>.</td></tr>		<td>This is the maximum number of items to display. A zero or negative value means to display all the <var class="term">sl</var> items. This is an optional argument; it defaults to zero, which means display to the end of <var class="term">sl</var>.</td></tr>
	</table>		</table>

Goff: syntax digram, tags and links

2011-01-27T05:22:44Z

syntax digram, tags and links

← Older revision		Revision as of 05:22, 27 January 2011
Line 7:		Line 7:
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%rc</th>		<tr><th>%count</th>
	<td>A numeric variable that is set to the number of <var>Stringlist</var> items displayed. </td></tr>		<td>An, optional, numeric variable that is set to the number of <var>Stringlist</var> items displayed. </td></tr>
	<tr><th>sl</th>		<tr><th>sl</th>
	<td>A <var>Stringlist</var> object. </td></tr>		<td>The <var>Stringlist</var> object. </td></tr>
	<tr><th>NumWidth~~=itemnumlen~~</th>		<tr><th>NumWidth</th>
	<td>The number of bytes in the display of each line to use for the item number. The parameter name <tt>.NumWidth</tt> is optional. The length must be a number between 0 and 10 inclusive; if it is greater than 0, a blank is placed after the item number. Item numbers are right-justified within the indicated number of bytes, and they are truncated on the left if the length of the item number exceeds the space allocated for it. This is an optional argument; it defaults to zero, which means the item numbers are not displayed. </td></tr>		<td>The, optional, number of bytes in the display of each line to use for the item number. The parameter name <var class="term">NumWidth</var> is optional. The length must be a number between 0 and 10 inclusive; if it is greater than 0, a blank is placed after the item number. Item numbers are right-justified within the indicated number of bytes, and they are truncated on the left if the length of the item number exceeds the space allocated for it. This is an optional argument; it defaults to zero, which means the item numbers are not displayed. </td></tr>
	<tr><th>LenWidth~~=itemlen~~</th>		<tr><th>LenWidth</th>
	<td>The number of bytes in the display of each line to use for the item length. The parameter name <tt>.LenWidth</tt> is optional. The length must be a number between 0 and 4 inclusive; if it is greater than 0, a blank is placed after the item length. Item lengths are right-justified within the indicated number of bytes, and they are truncated on the left if the length of the item length exceeds the space allocated for it. This is an optional argument; it defaults to zero, which means the item lengths are not displayed. </td></tr>		<td>The number of bytes in the display of each line to use for the item length. The parameter name <var class="term">LenWidth</var> is optional. The length must be a number between 0 and 4 inclusive; if it is greater than 0, a blank is placed after the item length. Item lengths are right-justified within the indicated number of bytes, and they are truncated on the left if the length of the item length exceeds the space allocated for it. This is an optional argument; it defaults to zero, which means the item lengths are not displayed. </td></tr>
	<tr><th>Start~~=firstitem~~</th>		<tr><th>Start</th>
	<td>~~Alternatively named <tt>.Start</tt>, this~~ is the number of the initial item to display. This is an optional argument, and it defaults to 1. </td></tr>		<td>This is the number of the initial item to display. This is an optional argument, and it defaults to 1. </td></tr>
	<tr><th>MaxItems~~=maxitems~~</th>		<tr><th>MaxItems</th>
	<td>~~Alternatively named <tt>.MaxItems</tt>, this~~ is the maximum number of items to display. A zero or negative value means to display all the <var>~~Stringlist~~</var> items. This is an optional argument; it defaults to zero, which means display to the end of the <var>~~Stringlist~~</var>.</td></tr>		<td>This is the maximum number of items to display. A zero or negative value means to display all the <var class="term">sl</var> items. This is an optional argument; it defaults to zero, which means display to the end of the <var class="term">sl</var>.</td></tr>
	</table>		</table>

	==Usage notes==		==Usage notes==
	<ul>		<ul><li>All errors in <var>Print</var> result in request cancellation.
	<li>The parameter names were introduced in <var class=product>Sirius Mods</var> Version 7.0; for versions prior to that, the parameters can only be specified positionally.		<li>The parameter names were introduced in <var class="product">Sirius Mods</var> Version 7.0; for versions prior to that, the parameters can only be specified positionally.
	For example, to display the contents of a <var>Stringlist</var> with 6 bytes to be used for the column containing the item width, and limiting the display to 20 items, you can use positional parameters:		For example, to display the contents of a <var>Stringlist</var> with 6 bytes to be used for the column containing the item width, and limiting the display to 20 items, you can use positional parameters:

	<p class="code">%listrint(,6,,20)		<p class="code">%listrint(,6,,20)
	</p>		</p>
			<li>Under <var class="product">Sirius Mods</var> 7.0 and later, you can do the same thing with named parameters:
	Under <var class=product>Sirius Mods</var> 7.0 and later, you can do the same thing with named parameters:

	<p class="code">%listrint(lenWidth=6, maxItems=20)		<p class="code">%listrint(lenWidth=6, maxItems=20)
	</p>		</p>

	~~<li>All errors in <var>Print</var> result in request cancellation.~~
	</ul>		</ul>

	==See also==		==See also==
	{{Template:Stringlist:Print footer}}		{{Template:Stringlist:Print footer}}