Update (CharacterMap subroutine) - Revision history

JAL at 20:46, 14 November 2012

2012-11-14T20:46:39Z

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

	The method lets you modify existing character associations or add new ones.		The method lets you modify existing character associations or add new ones.
	The method's parameters and mapping rules are the same as the		The method's parameters and mapping rules are the same as the <var>[[New (CharacterMap constructor)\|New]]</var> method.
	[[New (CharacterMap constructor)\|New]] method.
	==Syntax==		==Syntax==
	{{Template:CharacterMap:Update syntax}}		{{Template:CharacterMap:Update 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.</td></tr>		<td>A <var>CharacterMap</var> object.</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 that you are adding or resetting.		<td>A required, [[Notation conventions for methods#Named parameters\|name required]], argument that specifies the "input table" characters that you are adding or resetting. No character can be specified more than once in the <var>In</var> string, which may not be more than 256 characters.</td></tr>
	No character can be specified more than once 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.
	The <var>Out</var> string may not be longer than the <var>In</var> string; it may be shorter, however, as long as a <var>Pad</var> character is specified. The <var>Out</var> string may not be more than 256 characters.</td></tr>		The <var>Out</var> string may not be longer than the <var>In</var> string; it may be shorter, however, as long as a <var>Pad</var> character is specified. The <var>Out</var> string 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 the <var>In</var> string.		<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 the <var>In</var> string. <var>Pad</var> must be a single character, only.</td></tr>
	<var>Pad</var> must be a single character, only.
	</td></tr>
	</table>		</table>

Line 27:		Line 26:
	<ul>		<ul>
	<li>Case is respected in all character specifications.		<li>Case is respected in all character specifications.
	<li>If an In string character you specify is already mapped in the method object,
			<li>If an <var>In</var> string character you specify is already mapped in the method object,
	the existing mapping is modified by the association indicated in the <var>Update</var> call.		the existing mapping is modified by the association indicated in the <var>Update</var> call.
	If an In string character you specify is not already mapped, the association		If an <var>In</var> string character you specify is not already mapped, the association
	indicated in the <var>Update</var> call is added to the method object's mapping.		indicated in the <var>Update</var> call is added to the method object's mapping.
	<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. In this case, it is a request-canceling error if no <var>Pad</var> 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>The <var>Out</var> argument can be omitted, as long as a <var>Pad</var> argument is present.
	<li>For an example of an <var>Update</var> call, see the [[CharacterMap class#Example\|CharacterMap class]] page.		The <var>Pad</var> argument has no default.

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

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

JALWiccan: 1 revision

2011-04-13T00:03:11Z

1 revision

New page

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

The method lets you modify existing character associations or add new ones.
The method's parameters and mapping rules are the same as the
[[New (CharacterMap constructor)|New]] method.
==Syntax==
{{Template:CharacterMap:Update syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>characterMap</th>
<td>A <var>CharacterMap</var> object.</td></tr>
<tr><th><var>In</var></th>
<td>A required, name required, argument that specifies the "input table" characters that you are adding or resetting.
No character can be specified more than once 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.
The <var>Out</var> string may not be longer than the <var>In</var> string; it may be shorter, however, as long as a <var>Pad</var> character is specified. The <var>Out</var> string 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 the <var>In</var> string.
<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 an In string character you specify is already mapped in the method object,
the existing mapping is modified by the association indicated in the <var>Update</var> call.
If an In string character you specify is not already mapped, the association
indicated in the <var>Update</var> call is added to the method object's mapping.
<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 an <var>Update</var> call, see the [[CharacterMap class#Example|CharacterMap class]] page.
</ul>
==See also==
{{Template:CharacterMap:Update footer}}

Wiccan: 1 revision

2011-02-06T21:45:35Z

1 revision

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

Wiccan: 1 revision

2011-02-06T21:45:34Z

1 revision

← Older revision		Revision as of 21:45, 6 February 2011
Line 11:		Line 11:
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%map</th>		<tr><th>%map</th>
	<td>A CharacterMap object variable.</td></tr>		<td>A <var>CharacterMap</var> object variable.</td></tr>
	<tr><th>In=string</th>		<tr><th>In=string</th>
	<td>A required, name required, argument that specifies the "input table" characters that you are adding or resetting.		<td>A required, name required, argument that specifies the "input table" characters that you are adding or resetting.
Line 27:		Line 27:
	<li>Case is respected in all character specifications.		<li>Case is respected in all character specifications.
	<li>If an In string character you specify is already mapped in the method object,		<li>If an In string character you specify is already mapped in the method object,
	the existing mapping is modified by the association indicated in the Update call.		the existing mapping is modified by the association indicated in the <var>Update</var> call.
	If an In string character you specify is not already mapped, the association		If an In string character you specify is not already mapped, the association
	indicated in the Update call is added to the method object's mapping.		indicated in the <var>Update</var> call is added to the method object's mapping.
	<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
	characters are associated with the Pad character.		characters are associated with the Pad character.
Line 35:		Line 35:
	<li>The Out argument can be omitted, as long as a Pad argument is present.		<li>The Out argument can be omitted, as long as a Pad argument is present.
	The Pad argument has no default.		The Pad argument has no default.
	<li>For an example of an Update call, see the [[CharacterMap class#Example\|CharacterMap class]] page.		<li>For an example of an <var>Update</var> call, see the [[CharacterMap class#Example\|CharacterMap class]] page.
	</ul>		</ul>
	==See also==		==See also==
	{{Template:CharacterMap:Update footer}}		{{Template:CharacterMap:Update footer}}

Wiccan: 1 revision

2011-01-26T17:18:22Z

1 revision

← Older revision	Revision as of 17:18, 26 January 2011
(No difference)

Wiccan: 1 revision

2011-01-26T17:18:21Z

1 revision

← Older revision		Revision as of 17:18, 26 January 2011
Line 1:		Line 1:
	{{Template:CharacterMap:Update subtitle}}		{{Template:CharacterMap:Update subtitle}}
	~~[[Category:CharacterMap methods\|Update subroutine]]~~
	~~<!--DPL?? Category:CharacterMap methods\|Update subroutine: Update CharacterMap object's current character mapping-->~~
	~~<!--DPL?? Category:System methods\|Update (CharacterMap subroutine): Update CharacterMap object's current character mapping-->~~
	<p>		<p>
	</p>		</p>
Line 40:		Line 37:
	<li>For an example of an Update call, see the [[CharacterMap class#Example\|CharacterMap class]] page.		<li>For an example of an Update call, see the [[CharacterMap class#Example\|CharacterMap class]] page.
	</ul>		</ul>
			==See also==
			{{Template:CharacterMap:Update footer}}

Wiccan: 1 revision

2011-01-17T21:03:17Z

1 revision

← Older revision	Revision as of 21:03, 17 January 2011
(No difference)

Wiccan: 1 revision

2011-01-17T21:03:16Z

1 revision

← Older revision		Revision as of 21:03, 17 January 2011
Line 4:		Line 4:
	<!--DPL?? Category:System methods\|Update (CharacterMap subroutine): Update CharacterMap object's current character mapping-->		<!--DPL?? Category:System methods\|Update (CharacterMap subroutine): Update CharacterMap object's current character mapping-->
	<p>		<p>
	~~Update is a member of the [[CharacterMap class]].~~
	</p>		</p>

Wiccan: 1 revision

2011-01-16T03:15:05Z

1 revision

← Older revision	Revision as of 03:15, 16 January 2011
(No difference)

Alex: Undo revision 6094 by Wiccan (talk)

2011-01-16T02:56:50Z

Undo revision 6094 by Wiccan (talk)

← Older revision		Revision as of 02:56, 16 January 2011
Line 13:		Line 13:
	{{Template:CharacterMap:Update syntax}}		{{Template:CharacterMap:Update syntax}}
	===Syntax terms===		===Syntax terms===
	<dl>		<table class="syntaxTable">
	<dt><i>%map</i>		<tr><th>%map</th>
	<dd>A CharacterMap object variable.		<td>A CharacterMap object variable.</td></tr>
	<dt><b>~~In=~~</b><i>string</i>		<tr><th>In=string</th>
	<dd>A required, name required, argument that specifies the ~~“~~input table~~”~~		<td>A required, name required, argument that specifies the "input table" characters that you are adding or resetting.
	characters that you are adding or resetting.		No character can be specified more than once in the In string, which may not be more than 256 characters.</td></tr>
			<tr><th>Out=string</th>
	No character can be specified more than once in the In string, which		<td>An optional, name required, argument that specifies the "output table" characters.
	may not be more than 256 characters.		The Out string may not be longer than the In string; it may be shorter, however, as long as a Pad character is specified. The Out string may not be more than 256 characters.</td></tr>
	<dt><b>~~Out=~~</b><i>string</i>		<tr><th>Pad=char</th>
	<dd>An optional, name required, argument that specifies the ~~“~~output table~~”~~		<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 the In string.
	characters.

	The Out string may not be longer than the In string; it may be shorter, however,
	as long as a Pad character is specified.
	The Out string may not be more than 256 characters.
	<dt><b>~~Pad=~~</b><i>char</i>
	<dd>An optional, name required, argument that specifies the character used
	to pad the output table string on the right if it is shorter than the In string.

	''char'' must be a single character, only.		''char'' must be a single character, only.
			</td></tr>
	</dl>		</table>
	==Usage notes==		==Usage notes==
	<ul>		<ul>
Line 43:		Line 34:
	If an In string character you specify is not already mapped, the association		If an In string character you specify is not already mapped, the association
	indicated in the Update call is added to the method object's mapping.		indicated in the Update call is added to the method object's mapping.
	<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
	characters are associated with the Pad character.		characters are associated with the Pad character.
	In this case, it is a request-canceling error if no Pad character is present.		In this case, it is a request-canceling error if no Pad character is present.