New (CharacterMap constructor) - Revision history

Dme: /* Usage notes */

2016-10-10T16:16:46Z

Usage notes

← Older revision		Revision as of 16:16, 10 October 2016
Line 50:		Line 50:
	The <var>Pad</var> argument has no default.		The <var>Pad</var> argument has no default.

	~~<li>For an example of a <var>New</var> method call, see the [[CharacterMap class#Example\|"CharacterMap class"]] page.~~
	</ul>		</ul>

			==Example==
			{{Template:CharacterMap example}}

	==See also==		==See also==
	{{Template:CharacterMap:New footer}}		{{Template:CharacterMap:New footer}}

JAL at 20:42, 14 November 2012

2012-11-14T20:42:39Z

← Older revision		Revision as of 20:42, 14 November 2012
Line 1:		Line 1:
	{{Template:CharacterMap:New subtitle}}		{{Template:CharacterMap:New subtitle}}
	~~<p>~~
	~~</p>~~

	The <var>New</var> method creates a character map, which associates individual		The <var>New</var> method creates a character map, which associates individual
	characters from an In string (the "input table") with the characters		characters from an <var>In</var> string (the "input table") with the characters
	in the corresponding position in the "output table".		in the corresponding position in the "output table".
	The output table consists of the characters in the Out string (plus copies of		The output table consists of the characters in the <var>Out</var> string (plus copies of
	the Pad character, if necessary).		the <var>Pad</var> character, if necessary).

	==Syntax==		==Syntax==
	{{Template:CharacterMap:New syntax}}		{{Template:CharacterMap:New syntax}}
Line 15:		Line 14:
	<tr><th>%characterMap</th>		<tr><th>%characterMap</th>
	<td>A <var>CharacterMap</var> object variable.</td></tr>		<td>A <var>CharacterMap</var> object variable.</td></tr>

	<tr><th><var>[%(CharacterMap):]</var></th>		<tr><th><var>[%(CharacterMap):]</var></th>
	<td>The optional class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors\|Constructor]]</var>. See [[#Usage notes\|"Usage notes"]], below, for more information about invoking a <var>CharacterMap</var> <var>Constructor</var>.</td></tr>		<td>The optional class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors\|Constructor]]</var>. See [[#Usage notes\|"Usage notes"]], below, for more information about invoking a <var>CharacterMap</var> <var>Constructor</var>.</td></tr>

	<tr><th><var>In</var></th>		<tr><th><var>In</var></th>
	<td>A required, name required, argument that specifies the "input table" characters in the mapping.		<td>A required, [[Notation conventions for methods#Named parameters\|name required]], argument that specifies the "input table" characters in the mapping.
	No character duplications are allowed in the In string, which may not be more than 256 characters.</td></tr>		No character duplications are allowed in the In string, which may not be more than 256 characters.</td></tr>

	<tr><th><var>Out</var></th>		<tr><th><var>Out</var></th>
	<td>An optional, name required, argument that specifies the "output table" characters.		<td>An optional, name required, argument that specifies the "output table" characters.
	<var>Out</var> may not be longer than <var>In</var>; it may be shorter, however, as long as a pad character is specified. <var>Out</var> may not be more than 256 characters.</td></tr>		<var>Out</var> may not be longer than <var>In</var>; it may be shorter, however, as long as a pad character is specified. <var>Out</var> may not be more than 256 characters.</td></tr>

	<tr><th><var>Pad</var></th>		<tr><th><var>Pad</var></th>
	<td>An optional, name required, argument that specifies the character used to pad the output table string on the right if it is shorter than <var>In</var>.		<td>An optional, name required, argument that specifies the character used to pad the output table string on the right if it is shorter than <var>In</var>.
Line 37:		Line 40:
	%charMap = %charMap:new(in='A', out='-')		%charMap = %charMap:new(in='A', out='-')
	</p>		</p>

	<li>Case is respected in all character specifications.		<li>Case is respected in all character specifications.
	<li>If the In string is longer than the Out string, the "extra" In
	characters are associated with the Pad character.		<li>If the <var>In</var> string is longer than the <var>Out</var> string, the "extra" <var>In</var>
	In this case, it is a request-canceling error if no Pad character is present.		characters are associated with the <var>Pad</var> character.
	<li>The Out argument can be omitted, as long as a Pad argument is present.		In this case, it is a request-canceling error if no <var>Pad</var> character is present.
	The Pad argument has no default.
	<li>For an example of a <var>New</var> method call, see the [[CharacterMap class#Example\|CharacterMap class]] page.		<li>The <var>Out</var> argument can be omitted, as long as a <var>Pad</var> argument is present.
			The <var>Pad</var> argument has no default.

			<li>For an example of a <var>New</var> method call, see the [[CharacterMap class#Example\|"CharacterMap class"]] page.
	</ul>		</ul>

	==See also==		==See also==
	{{Template:CharacterMap:New footer}}		{{Template:CharacterMap:New footer}}

JALWiccan: 1 revision

2011-11-30T20:24:14Z

1 revision

← Older revision	Revision as of 20:24, 30 November 2011
(No difference)

JAL2: /* Syntax terms */

2011-11-30T20:24:13Z

Syntax terms

← Older revision		Revision as of 20:24, 30 November 2011
Line 15:		Line 15:
	<tr><th>%characterMap</th>		<tr><th>%characterMap</th>
	<td>A <var>CharacterMap</var> object variable.</td></tr>		<td>A <var>CharacterMap</var> object variable.</td></tr>
	<tr><th><var>[%(CharacterMap)]</var></th>		<tr><th><var>[%(CharacterMap):]</var></th>
	<td>The optional class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors\|Constructor]]</var>. See [[#Usage notes\|"Usage notes"]], below, for more information about invoking a <var>CharacterMap</var> <var>Constructor</var>.</td></tr>		<td>The optional class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors\|Constructor]]</var>. See [[#Usage notes\|"Usage notes"]], below, for more information about invoking a <var>CharacterMap</var> <var>Constructor</var>.</td></tr>
	<tr><th><var>In</var></th>		<tr><th><var>In</var></th>

JAL2: /* Syntax terms */

2011-08-23T00:29:32Z

Syntax terms

← Older revision		Revision as of 00:29, 23 August 2011
Line 15:		Line 15:
	<tr><th>%characterMap</th>		<tr><th>%characterMap</th>
	<td>A <var>CharacterMap</var> object variable.</td></tr>		<td>A <var>CharacterMap</var> object variable.</td></tr>
	<tr><th><var>%(CharacterMap)</var></th>		<tr><th><var>[%(CharacterMap)]</var></th>
	<td>The optional class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors\|Constructor]]</var>. See [[#Usage notes\|"Usage notes"]], below, for more information about invoking a <var>CharacterMap</var> <var>Constructor</var>.</td></tr>		<td>The optional class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors\|Constructor]]</var>. See [[#Usage notes\|"Usage notes"]], below, for more information about invoking a <var>CharacterMap</var> <var>Constructor</var>.</td></tr>
	<tr><th><var>In</var></th>		<tr><th><var>In</var></th>

JAL2: /* Usage notes */

2011-07-27T21:21:53Z

Usage notes

← Older revision		Revision as of 21:21, 27 July 2011
Line 31:		Line 31:
	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>As described in [[Object variables#Using New or other Constructors\|"Using New or other Constructors"]], <var>New</var> can be invoked with no object, with an explicit class name, or with an object variable in the class, even if that object is <var>Null</var>:<p class="code">%charMap = new		<li>As described in [[Object variables#Using New or other Constructors\|"Using New or other Constructors"]], <var>New</var> can be invoked with no object, with an explicit class name, or with an object variable in the class, even if that object is <var>Null</var>:<p class="code">%charMap = new(in='A', out='-')

	%charMap = %(CharacterMap):new		%charMap = %(CharacterMap):new(in='A', out='-')

	%charMap = %charMap:new		%charMap = %charMap:new(in='A', out='-')
	</p>		</p>
	<li>Case is respected in all character specifications.		<li>Case is respected in all character specifications.
Line 45:		Line 45:
	<li>For an example of a <var>New</var> method call, see the [[CharacterMap class#Example\|CharacterMap class]] page.		<li>For an example of a <var>New</var> method call, see the [[CharacterMap class#Example\|CharacterMap class]] page.
	</ul>		</ul>

	==See also==		==See also==
	{{Template:CharacterMap:New footer}}		{{Template:CharacterMap:New footer}}

JAL2 at 21:18, 27 July 2011

2011-07-27T21:18:04Z

← Older revision		Revision as of 21:18, 27 July 2011
Line 16:		Line 16:
	<td>A <var>CharacterMap</var> object variable.</td></tr>		<td>A <var>CharacterMap</var> object variable.</td></tr>
	<tr><th><var>%(CharacterMap)</var></th>		<tr><th><var>%(CharacterMap)</var></th>
	<td>The optional class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors\|Constructor]]</var>. </td></tr>		<td>The optional class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors\|Constructor]]</var>. See [[#Usage notes\|"Usage notes"]], below, for more information about invoking a <var>CharacterMap</var> <var>Constructor</var>.</td></tr>
	<tr><th><var>In</var></th>		<tr><th><var>In</var></th>
	<td>A required, name required, argument that specifies the "input table" characters in the mapping.		<td>A required, name required, argument that specifies the "input table" characters in the mapping.
Line 31:		Line 31:
	==Usage notes==		==Usage notes==
	<ul>		<ul>
			<li>As described in [[Object variables#Using New or other Constructors\|"Using New or other Constructors"]], <var>New</var> can be invoked with no object, with an explicit class name, or with an object variable in the class, even if that object is <var>Null</var>:<p class="code">%charMap = new

			%charMap = %(CharacterMap):new

			%charMap = %charMap:new
			</p>
	<li>Case is respected in all character specifications.		<li>Case is respected in all character specifications.
	<li>If the In string is longer than the Out string, the "extra" In		<li>If the In string is longer than the Out string, the "extra" In

JAL2 at 21:49, 26 July 2011

2011-07-26T21:49:52Z

← Older revision		Revision as of 21:49, 26 July 2011
Line 10:		Line 10:
	==Syntax==		==Syntax==
	{{Template:CharacterMap:New syntax}}		{{Template:CharacterMap:New syntax}}

	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%characterMap</th>		<tr><th>%characterMap</th>
	<td>A <var>CharacterMap</var> object variable.</td></tr>		<td>A <var>CharacterMap</var> object variable.</td></tr>
			<tr><th><var>%(CharacterMap)</var></th>
			<td>The optional class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors\|Constructor]]</var>. </td></tr>
	<tr><th><var>In</var></th>		<tr><th><var>In</var></th>
	<td>A required, name required, argument that specifies the "input table" characters in the mapping.		<td>A required, name required, argument that specifies the "input table" characters in the mapping.

JALWiccan: 1 revision

2011-04-13T00:03:11Z

1 revision

New page

{{Template:CharacterMap:New subtitle}}
<p>
</p>

The <var>New</var> method creates a character map, which associates individual
characters from an In string (the "input table") with the characters
in the corresponding position in the "output table".
The output table consists of the characters in the Out string (plus copies of
the Pad character, if necessary).
==Syntax==
{{Template:CharacterMap:New syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%characterMap</th>
<td>A <var>CharacterMap</var> object variable.</td></tr>
<tr><th><var>In</var></th>
<td>A required, name required, argument that specifies the "input table" characters in the mapping.
No character duplications are allowed in the In string, which may not be more than 256 characters.</td></tr>
<tr><th><var>Out</var></th>
<td>An optional, name required, argument that specifies the "output table" characters.
<var>Out</var> may not be longer than <var>In</var>; it may be shorter, however, as long as a pad character is specified. <var>Out</var> may not be more than 256 characters.</td></tr>
<tr><th><var>Pad</var></th>
<td>An optional, name required, argument that specifies the character used to pad the output table string on the right if it is shorter than <var>In</var>.
<var>Pad</var> must be a single character, only.
</td></tr>
</table>

==Usage notes==
<ul>
<li>Case is respected in all character specifications.
<li>If the In string is longer than the Out string, the "extra" In
characters are associated with the Pad character.
In this case, it is a request-canceling error if no Pad character is present.
<li>The Out argument can be omitted, as long as a Pad argument is present.
The Pad argument has no default.
<li>For an example of a <var>New</var> method call, see the [[CharacterMap class#Example|CharacterMap class]] page.
</ul>
==See also==
{{Template:CharacterMap:New footer}}

Wiccan: 1 revision

2011-02-06T21:45:35Z

1 revision

← Older revision	Revision as of 21:45, 6 February 2011
(No difference)