UnicodeToUtf8 (Unicode function) - Revision history

JAL at 20:10, 6 November 2012

2012-11-06T20:10:22Z

← Older revision		Revision as of 20:10, 6 November 2012
Line 26:		Line 26:

	==Usage notes==		==Usage notes==
	<ul><li><var>UnicodeToUtf8</var> is available as of <var class="product">[[Sirius Mods]]</var> Version 7.3.</ul>		<ul>
			<li><var>UnicodeToUtf8</var> is available as of <var class="product">Sirius Mods</var> Version 7.3.
			</ul>

	==Examples==		==Examples==
	~~<ol><li>~~
	In the following fragment, <var>UnicodeToUtf8</var> is used to show how the <var>Unicode</var> U+B2 character (superscript 2) is represented in UTF-8. Appending the <var>StringToHex</var> method is useful for viewing the hex values of characters that do not have displayable EBCDIC equivalents.		In the following fragment, <var>UnicodeToUtf8</var> is used to show how the <var>Unicode</var> U+B2 character (superscript 2) is represented in UTF-8. Appending the <var>StringToHex</var> method is useful for viewing the hex values of characters that do not have displayable EBCDIC equivalents.
	<p class="code">%u unicode initial('²':[[U (String function)\|U]])		<p class="code">%u unicode initial('&#xB2;':[[U (String function)\|U]])
	print %u:UnicodeToUtf8:[[StringToHex (String function)\|stringToHex]]		print %u:UnicodeToUtf8:[[StringToHex (String function)\|stringToHex]]
	</p>		</p>
	The result is:		The result is:
	<p class="output">C2B2		<p class="output">C2B2
	</p~~></ol~~>		</p>

	==See also==		==See also==

JAL: /* Syntax terms */

2012-11-06T20:09:03Z

Syntax terms

← Older revision		Revision as of 20:09, 6 November 2012
Line 11:		Line 11:
	<td>A <var>Unicode</var> string.</td></tr>		<td>A <var>Unicode</var> string.</td></tr>
	<tr><th><var>InsertBOM</var></th>		<tr><th><var>InsertBOM</var></th>
	<td>The optional ~~(<var>~~[[~~Methods~~#Named parameters\|~~NameRequired~~]]~~</var>)~~ <var>InsertBOM</var> argument is a [[Boolean enumeration\|Boolean]]:<ul><li>If its value is <code>True</code>, the "Byte Order Mark" (U+FEFF, encoded as X'EFBBBF') is inserted at the start of the output stream.<li>If its value is <code>False</code>, the default, no Byte Order Mark is inserted.</ul></td></tr>		<td>The optional, [[Notation conventions for methods#Named parameters\|name required]], <var>InsertBOM</var> argument is a [[Boolean enumeration\|Boolean]]:
			<ul>
			<li>If its value is <code>True</code>, the "Byte Order Mark" (U+FEFF, encoded as X'EFBBBF') is inserted at the start of the output stream.
			<li>If its value is <code>False</code>, the default, no Byte Order Mark is inserted.
			</ul></td></tr>
	</table>		</table>

JALWiccan: 1 revision

2012-11-06T17:32:27Z

1 revision

← Older revision	Revision as of 17:32, 6 November 2012
(No difference)

JAL2: /* Syntax terms */

2012-11-06T17:32:25Z

Syntax terms

← Older revision		Revision as of 17:32, 6 November 2012
Line 27:		Line 27:
	<ol><li>		<ol><li>
	In the following fragment, <var>UnicodeToUtf8</var> is used to show how the <var>Unicode</var> U+B2 character (superscript 2) is represented in UTF-8. Appending the <var>StringToHex</var> method is useful for viewing the hex values of characters that do not have displayable EBCDIC equivalents.		In the following fragment, <var>UnicodeToUtf8</var> is used to show how the <var>Unicode</var> U+B2 character (superscript 2) is represented in UTF-8. Appending the <var>StringToHex</var> method is useful for viewing the hex values of characters that do not have displayable EBCDIC equivalents.
	<p class="code">%u unicode initial('&~~amp;amp;~~#xB2;':[[U (String function)\|U]])		<p class="code">%u unicode initial('²':[[U (String function)\|U]])
	print %u:UnicodeToUtf8:[[StringToHex (String function)\|stringToHex]]		print %u:UnicodeToUtf8:[[StringToHex (String function)\|stringToHex]]
	</p>		</p>

JAL2: /* Syntax terms */

2011-04-13T00:57:10Z

Syntax terms

← Older revision		Revision as of 00:57, 13 April 2011
Line 11:		Line 11:
	<td>A <var>Unicode</var> string.</td></tr>		<td>A <var>Unicode</var> string.</td></tr>
	<tr><th><var>InsertBOM</var></th>		<tr><th><var>InsertBOM</var></th>
	<td>The optional (<var>[[Methods#Named parameters\|NameRequired]]</var>) <var ~~class="term"~~>InsertBOM</var> argument is a [[Boolean enumeration\|Boolean]]:<ul><li>If its value is <code>True</code>, the "Byte Order Mark" (U+FEFF, encoded as X'EFBBBF') is inserted at the start of the output stream.<li>If its value is <code>False</code>, the default, no Byte Order Mark is inserted.</ul></td></tr>		<td>The optional (<var>[[Methods#Named parameters\|NameRequired]]</var>) <var>InsertBOM</var> argument is a [[Boolean enumeration\|Boolean]]:<ul><li>If its value is <code>True</code>, the "Byte Order Mark" (U+FEFF, encoded as X'EFBBBF') is inserted at the start of the output stream.<li>If its value is <code>False</code>, the default, no Byte Order Mark is inserted.</ul></td></tr>
	</table>		</table>

JALWiccan: 1 revision

2011-04-13T00:55:36Z

1 revision

← Older revision	Revision as of 00:55, 13 April 2011
(No difference)

Goff at 00:55, 13 April 2011

2011-04-13T00:55:35Z

← Older revision		Revision as of 00:55, 13 April 2011
Line 10:		Line 10:
	<tr><th>unicode</th>		<tr><th>unicode</th>
	<td>A <var>Unicode</var> string.</td></tr>		<td>A <var>Unicode</var> string.</td></tr>
	<tr><th>InsertBOM</th>		<tr><th><var>InsertBOM</var></th>
	<td>The optional (<var>[[Methods#Named parameters\|NameRequired]]</var>) <var class="term">InsertBOM</var> argument is a [[Boolean enumeration\|Boolean]]:<ul><li>If its value is <code>True</code>, the "Byte Order Mark" (U+FEFF, encoded as X'EFBBBF') is inserted at the start of the output stream.<li>If its value is <code>False</code>, the default, no Byte Order Mark is inserted.</ul></td></tr>		<td>The optional (<var>[[Methods#Named parameters\|NameRequired]]</var>) <var class="term">InsertBOM</var> argument is a [[Boolean enumeration\|Boolean]]:<ul><li>If its value is <code>True</code>, the "Byte Order Mark" (U+FEFF, encoded as X'EFBBBF') is inserted at the start of the output stream.<li>If its value is <code>False</code>, the default, no Byte Order Mark is inserted.</ul></td></tr>
	</table>		</table>
Line 27:		Line 27:
	<ol><li>		<ol><li>
	In the following fragment, <var>UnicodeToUtf8</var> is used to show how the <var>Unicode</var> U+B2 character (superscript 2) is represented in UTF-8. Appending the <var>StringToHex</var> method is useful for viewing the hex values of characters that do not have displayable EBCDIC equivalents.		In the following fragment, <var>UnicodeToUtf8</var> is used to show how the <var>Unicode</var> U+B2 character (superscript 2) is represented in UTF-8. Appending the <var>StringToHex</var> method is useful for viewing the hex values of characters that do not have displayable EBCDIC equivalents.
	<p class="code">%u unicode initial('&#xB2;':[[U (String function)\|U]])		<p class="code">%u unicode initial('&amp;#xB2;':[[U (String function)\|U]])
	print %u:UnicodeToUtf8:[[StringToHex (String function)\|stringToHex]]		print %u:UnicodeToUtf8:[[StringToHex (String function)\|stringToHex]]
	</p>		</p>

Goff at 00:53, 14 March 2011

2011-03-14T00:53:05Z

← Older revision		Revision as of 00:53, 14 March 2011
Line 25:		Line 25:

	==Examples==		==Examples==
			<ol><li>
	In the following fragment, <var>UnicodeToUtf8</var> is used to show how the <var>Unicode</var> U+B2 character (superscript 2) is represented in UTF-8. Appending the <var>StringToHex</var> method is useful for viewing the hex values of characters that do not have displayable EBCDIC equivalents.		In the following fragment, <var>UnicodeToUtf8</var> is used to show how the <var>Unicode</var> U+B2 character (superscript 2) is represented in UTF-8. Appending the <var>StringToHex</var> method is useful for viewing the hex values of characters that do not have displayable EBCDIC equivalents.
	<p class="code">%u unicode initial('&#xB2;':[[U (String function)\|U]])		<p class="code">%u unicode initial('&#xB2;':[[U (String function)\|U]])
Line 31:		Line 32:
	The result is:		The result is:
	<p class="output">C2B2		<p class="output">C2B2
	</p>		</p></ol>

	==See also==		==See also==

JAL at 21:05, 1 March 2011

2011-03-01T21:05:24Z

← Older revision		Revision as of 21:05, 1 March 2011
Line 11:		Line 11:
	<td>A <var>Unicode</var> string.</td></tr>		<td>A <var>Unicode</var> string.</td></tr>
	<tr><th>InsertBOM</th>		<tr><th>InsertBOM</th>
	<td>The optional (<var>[[Methods#Named parameters\|~~Name-Required~~]]</var>) <var class="term">InsertBOM</var> argument is a Boolean:<ul><li>If its value is <code>True</code>, the "Byte Order Mark" (U+FEFF, encoded as X'EFBBBF') is inserted at the start of the output stream.<li>If its value is <code>False</code>, the default, no Byte Order Mark is inserted.</ul></td></tr>		<td>The optional (<var>[[Methods#Named parameters\|NameRequired]]</var>) <var class="term">InsertBOM</var> argument is a [[Boolean enumeration\|Boolean]]:<ul><li>If its value is <code>True</code>, the "Byte Order Mark" (U+FEFF, encoded as X'EFBBBF') is inserted at the start of the output stream.<li>If its value is <code>False</code>, the default, no Byte Order Mark is inserted.</ul></td></tr>
	</table>		</table>

Line 22:		Line 22:

	==Usage notes==		==Usage notes==
	<ul><li><var>UnicodeToUtf8</var> is available as of <var class="product">[[Sirius Mods~~\|"Sirius Mods"~~]]</var> Version 7.3.</ul>		<ul><li><var>UnicodeToUtf8</var> is available as of <var class="product">[[Sirius Mods]]</var> Version 7.3.</ul>

	==Examples==		==Examples==
	~~<ol><li>~~In the following fragment, <var>UnicodeToUtf8</var> is used to show how the <var>Unicode</var> U+B2 character (superscript 2) is represented in UTF-8. Appending the <var>StringToHex</var> method is useful for viewing the hex values of characters that do not have displayable EBCDIC equivalents.		In the following fragment, <var>UnicodeToUtf8</var> is used to show how the <var>Unicode</var> U+B2 character (superscript 2) is represented in UTF-8. Appending the <var>StringToHex</var> method is useful for viewing the hex values of characters that do not have displayable EBCDIC equivalents.
	<p class="code">%u unicode initial('&#xB2;':[[U (String function)\|U]])		<p class="code">%u unicode initial('&#xB2;':[[U (String function)\|U]])
	print %u:UnicodeToUtf8:[[StringToHex (String function)\|stringToHex]]		print %u:UnicodeToUtf8:[[StringToHex (String function)\|stringToHex]]
Line 31:		Line 31:
	The result is:		The result is:
	<p class="output">C2B2		<p class="output">C2B2
	</p~~></ol~~>		</p>

	==See also==		==See also==

Goff: syntax terms, tags and links

2011-02-25T05:55:11Z

syntax terms, tags and links

← Older revision		Revision as of 05:55, 25 February 2011
Line 1:		Line 1:
	{{Template:Unicode:UnicodeToUtf8 subtitle}}		{{Template:Unicode:UnicodeToUtf8 subtitle}}
			<var>UnicodeToUtf8</var> converts a <var>Unicode</var> string to a UTF-8 <var>Longstring</var> byte stream.

	~~This function converts a <var>Unicode</var> string to a UTF-8~~
	~~<var>Longstring</var> byte stream.~~

	~~The <var>UnicodeToUtf8</var> function is available as of version 7.3 of the <var class=product>Sirius Mods</var>.~~
	==Syntax==		==Syntax==
	{{Template:Unicode:UnicodeToUtf8 syntax}}		{{Template:Unicode:UnicodeToUtf8 syntax}}
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%~~utf8Stream~~</th>		<tr><th>%string</th>
	<td>A <var>String</var> or <var>Longstring</var> variable to receive the method object string translated to a UTF-8 byte stream. </td></tr>		<td>A <var>String</var> or <var>Longstring</var> variable to receive the method object string translated to a UTF-8 byte stream.</td></tr>
	<tr><th>unicode</th>		<tr><th>unicode</th>
	<td>A <var>Unicode</var> string. </td></tr>		<td>A <var>Unicode</var> string.</td></tr>
	<tr><th>InsertBOM~~=bool~~</th>		<tr><th>InsertBOM</th>
	<td>The optional (~~name required~~) InsertBOM argument is a Boolean: <ul> <li>If its value is <tt>True</tt>, the "Byte Order Mark" (U+FEFF, encoded as X'EFBBBF') is inserted at the start of the output stream. <li>If its value is <tt>False</tt>, the default, no Byte Order Mark is inserted. </ul></td></tr>		<td>The optional (<var>[[Methods#Named parameters\|Name-Required]]</var>) <var class="term">InsertBOM</var> argument is a Boolean:<ul><li>If its value is <code>True</code>, the "Byte Order Mark" (U+FEFF, encoded as X'EFBBBF') is inserted at the start of the output stream.<li>If its value is <code>False</code>, the default, no Byte Order Mark is inserted.</ul></td></tr>
	</table>		</table>

	===Exceptions===		===Exceptions===
			<var>UnicodeToUtf8</var> can throw the following exception:
	~~This function~~ can throw the following exception:
	<dl>		<dl>
	<dt><var>CharacterTranslationException</var>		<dt><var>[[CharacterTranslationException class\|CharacterTranslationException]]</var>
	<dd>If the method encounters a translation problem,		<dd>If the method encounters a translation problem, properties of the exception object may indicate the location and type of problem.
	properties of the exception object may indicate the location and type of problem.
	~~See [[CharacterTranslationException exception class]]~~.
	</dl>		</dl>

	==Usage notes==		==Usage notes==
	<ul>		<ul><li><var>UnicodeToUtf8</var> is available as of <var class="product">[[Sirius Mods\|"Sirius Mods"]]</var> Version 7.3.</ul>
	<li>~~For more information about UTF-8 conversions, see [[Unicode#UTF-8 and UTF-16]].~~
	~~<li>The [[UnicodeToUtf16 (Unicode function)\|UnicodeToUtf16]] method~~
	~~converts a~~ <var>~~Unicode~~</var> ~~string to UTF-16.~~
	<li>~~The~~ [[~~Utf8ToUnicode (String function)~~\|~~Utf8ToUnicode~~]] ~~method~~
	~~converts a UTF-8 <var>Longstring</var> byte stream to <var>Unicode~~</var>.
	</ul>
	==Examples==		==Examples==
			<ol><li>In the following fragment, <var>UnicodeToUtf8</var> is used to show how the <var>Unicode</var> U+B2 character (superscript 2) is represented in UTF-8. Appending the <var>StringToHex</var> method is useful for viewing the hex values of characters that do not have displayable EBCDIC equivalents.
	In the following fragment, <var>UnicodeToUtf8</var> is used to show how the		<p class="code">%u unicode initial('&#xB2;':[[U (String function)\|U]])
	<var>Unicode</var> U+B2 character (superscript 2) is represented in UTF-8.		print %u:UnicodeToUtf8:[[StringToHex (String function)\|stringToHex]]
	Appending the <var>StringToHex</var> method is useful for viewing
	the hex values of characters that do not have displayable EBCDIC equivalents.

	~~The [[U (String function)\|U constant function]] and [[StringToHex (String function)\|StringToHex]] function~~
	~~are used in the example~~.
	<p class="code">%u ~~Unicode Initial~~('&#xB2;':U)
	~~Print~~ %u:UnicodeToUtf8:StringToHex
	</p>		</p>

	The result is:		The result is:
	<p class="output">C2B2		<p class="output">C2B2
	</p>		</p></ol>

	==See also==		==See also==
			<ul><li>For more information about UTF-8 conversions, see [[Unicode#UTF-8 and UTF-16\|"Unicode: UTF-8 and UTF-16"]].
			<li><var>[[UnicodeToUtf16 (Unicode function)\|UnicodeToUtf16]]</var> converts a <var>Unicode</var> string to UTF-16.
			<li><var>[[Utf8ToUnicode (String function)\|Utf8ToUnicode]]</var> converts a UTF-8 <var>Longstring</var> byte stream to <var>Unicode</var>.
			</ul>
	{{Template:Unicode:UnicodeToUtf8 footer}}		{{Template:Unicode:UnicodeToUtf8 footer}}