Words (String function) - Revision history

ELowell at 22:51, 3 September 2015

2015-09-03T22:51:13Z

← Older revision		Revision as of 22:51, 3 September 2015
Line 1:		Line 1:
	{{Template:String:Words subtitle}}		{{Template:String:Words subtitle}}

	<var>Words</var> returns a substring of the method object string using word counts. The method returns a specified number of words, starting from a specified word and including consecutive following words.		<var>Words</var> returns a substring of the method object string using word counts. The method returns a specified number of words, starting from a specified word and including consecutive following words.

Line 10:		Line 9:
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%outString</th><td>The returned substring of <var class="term">string</var>. <var class="term">%outString</var> contains as many words as <var class="term">count</var>, including and continuing from word number <var class="term">start</var>. As shown in the [[#Whitespace not collapsed\|"Whitespace not collapsed"]] example, whitespace characters within the return result are not collapsed.		<tr><th nowrap>%outString</th><td>The returned substring of <var class="term">string</var>. <var class="term">%outString</var> contains as many words as <var class="term">count</var>, including and continuing from word number <var class="term">start</var>. As shown in the [[#Whitespace not collapsed\|"Whitespace not collapsed"]] example, whitespace characters within the return result are not collapsed.
	</td></tr>		</td></tr>
	<tr><th>string</th>		<tr><th>string</th>

Dme: /* Whitespace not collapsed */

2013-06-24T17:17:18Z

Whitespace not collapsed

← Older revision		Revision as of 17:17, 24 June 2013
Line 41:		Line 41:
	<p class="output">'a!b@@@c':words(2, spaces='@!')=b@@@c		<p class="output">'a!b@@@c':words(2, spaces='@!')=b@@@c
	</p>		</p>
			<ul>
			<li>The output result contains exactly the selected input substring; multiple whitespace characters are not collapsed.
			</ul>

	===Miscellaneous===		===Miscellaneous===
	The following fragment:		The following fragment:

Dme: /* Syntax terms */

2013-06-24T17:15:43Z

Syntax terms

← Older revision		Revision as of 17:15, 24 June 2013
Line 10:		Line 10:
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%outString</th><td>The returned substring of <var class="term">string</var>. <var class="term">%outString</var> contains as many words as <var class="term">count</var>, including and continuing from word number <var class="term">start</var>.		<tr><th>%outString</th><td>The returned substring of <var class="term">string</var>. <var class="term">%outString</var> contains as many words as <var class="term">count</var>, including and continuing from word number <var class="term">start</var>. As shown in the [[#Whitespace not collapsed\|"Whitespace not collapsed"]] example, whitespace characters within the return result are not collapsed.
	</td></tr>		</td></tr>
	<tr><th>string</th>		<tr><th>string</th>
Line 25:		Line 25:

	<tr><th><var>Spaces</var></th>		<tr><th><var>Spaces</var></th>
	<td>This optional, [[Notation conventions for methods#Named parameters\|name required]], argument is a set of "whitespace" characters, that is, characters that separate words. The default is the blank character. If the null string is provided, the blank character is used as the whitespace character. </td></tr>		<td>This optional, [[Notation conventions for methods#Named parameters\|name required]], argument is a set of "whitespace" characters, that is, characters that separate words. The default is the blank character. If the null string is provided, the blank character is used as the whitespace character. See the [[#Whitespace not collapsed\|"Whitespace not collapsed"]] example. </td></tr>
	</table>		</table>

Dme: /* Examples */

2013-06-24T17:13:16Z

Examples

← Older revision		Revision as of 17:13, 24 June 2013
Line 34:		Line 34:

	==Examples==		==Examples==
			===Whitespace not collapsed===
	The following fragment:		The following fragment:
	<p class="code">~~PrintText~~ {~='~~aa bb cc~~':~~Words~~(2~~)}.~~		<p class="code">printText {~='a!b@@@c':words(2, spaces='@!')}
	~~PrintText {~='aa bb cc':Words(1~~, ~~2)}.~~
	~~PrintText {~~~='~~aa bb cc~~'~~:Words(4, 1)}.~~
	~~PrintText {~='aa bb cc':Words(3, 2)}.~~
	~~PrintText {~='aa bb cc':Words(2, 0~~)}.
	</p>		</p>
	produces this result:		produces this result:
	<p class="output">'aa bb cc':~~Words~~(2)=bb cc.		<p class="output">'a!b@@@c':words(2, spaces='@!')=b@@@c
	'aa bb cc':~~Words~~(1, 2)=aa bb.		</p>
	'aa bb cc':~~Words~~(4, 1)=.		===Miscellaneous===
	'aa bb cc':~~Words~~(3, 2)=cc.		The following fragment:
	'aa bb cc':~~Words~~(2, 0)=.		<p class="code">printText {~='aa bb cc':words(2)}.
			printText {~='aa bb cc':words(1, 2)}.
			printText {~='aa bb cc':words(4, 1)}.
			printText {~='aa bb cc':words(3, 2)}.
			printText {~='aa bb cc':words(2, 0)}.
			</p>
			produces this result:
			<p class="output">'aa bb cc':words(2)=bb cc.
			'aa bb cc':words(1, 2)=aa bb.
			'aa bb cc':words(4, 1)=.
			'aa bb cc':words(3, 2)=cc.
			'aa bb cc':words(2, 0)=.
	</p>		</p>

JAL at 23:17, 5 November 2012

2012-11-05T23:17:08Z

← Older revision		Revision as of 23:17, 5 November 2012
Line 25:		Line 25:

	<tr><th><var>Spaces</var></th>		<tr><th><var>Spaces</var></th>
	<td>A set of "whitespace" characters, that is, characters that separate words. The default is the blank character. If the null string is provided, the blank character is used as the whitespace character. </td></tr>		<td>This optional, [[Notation conventions for methods#Named parameters\|name required]], argument is a set of "whitespace" characters, that is, characters that separate words. The default is the blank character. If the null string is provided, the blank character is used as the whitespace character. </td></tr>
	</table>		</table>

Line 41:		Line 41:
	PrintText {~='aa bb cc':Words(2, 0)}.		PrintText {~='aa bb cc':Words(2, 0)}.
	</p>		</p>
	produces ~~the following~~ result:		produces this result:
	<p class="output">'aa bb cc':Words(2)=bb cc.		<p class="output">'aa bb cc':Words(2)=bb cc.
	'aa bb cc':Words(1, 2)=aa bb.		'aa bb cc':Words(1, 2)=aa bb.
Line 56:		Line 56:
	<li><var class="camel">[[WordNumberIn and WordNumberOf (String functions)\|WordNumberIn and WordNumberOf]]</var>, which return the word number of a "needle" word within a "haystack" list of words		<li><var class="camel">[[WordNumberIn and WordNumberOf (String functions)\|WordNumberIn and WordNumberOf]]</var>, which return the word number of a "needle" word within a "haystack" list of words
	</ul>		</ul>

	{{Template:String:Words footer}}		{{Template:String:Words footer}}

JAL2: /* See also */

2012-03-21T18:41:59Z

JAL2 at 16:37, 21 March 2012

2012-03-21T16:37:59Z

← Older revision		Revision as of 16:37, 21 March 2012
Line 1:		Line 1:
	{{Template:String:Words subtitle}}		{{Template:String:Words subtitle}}

	<p></p>		<var>Words</var> returns a substring of the method object string using word counts. The method returns a specified number of words, starting from a specified word and including consecutive following words.

	Note that processing a string of words may be better accomplished with the <var>[[StringTokenizer class\|StringTokenizer]]</var> class.		Note that processing a string of words may be better accomplished with the <var>[[StringTokenizer class\|StringTokenizer]]</var> class.

	==Syntax==		==Syntax==
	{{Template:String:Words syntax}}		{{Template:String:Words syntax}}

	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%outString</th><td> <var>~~Words~~</var> ~~returns the substring of the~~ <var class="term">~~string~~</var> ~~method object which starts at word number~~ <var class="term">~~start~~</var> and ~~continues for up to as many words as~~ <var class="term">~~count~~</var>.		<tr><th>%outString</th><td>The returned substring of <var class="term">string</var>. <var class="term">%outString</var> contains as many words as <var class="term">count</var>, including and continuing from word number <var class="term">start</var>.
	</td></tr>		</td></tr>
	<tr><th>string</th>		<tr><th>string</th>
	<td>The method object string, from which ~~the~~ substring is extracted.		<td>The method object string, from which substring <var class="term">%outString</var> is extracted.
	</td></tr>		</td></tr>

	<tr><th>start</th>		<tr><th>start</th>
	<td>The number of the word in <var class="term">string</var> that is the start of the extracted ~~substring;~~ must be greater than or equal to 1 (1 designates the first word). If <var class="term">start</var> is greater than the number of words in <var class="term">string</var>, the null string is returned.		<td>The number of the word in <var class="term">string</var> that is the start of the extracted <var class="term">%outString</var>. <var class="term">start</var> must be greater than or equal to 1, which designates the first word. If <var class="term">start</var> is greater than the number of words in <var class="term">string</var>, the null string is returned. </td></tr>
	</td></tr>
	<tr><th>count</th>		<tr><th>count</th>
	<td>The number of words in ~~the substring~~ to extract. This is an optional argument; the default is to extract the rest of <var class="term">string</var> starting at word number <var class="term">start</var>. If <var class="term">count</var> is greater than the number of words remaining in <var class="term">string</var> starting with word number <var class="term">start</var>, the remainder of the <var class="term">string</var> starting at word number <var class="term">start</var> is returned. This argument must be non-negative; if zero, the null string is returned.		<td>The number of words in <var class="term">string</var> to extract to <var class="term">%outString</var>. This is an optional argument; the default is to extract the rest of <var class="term">string</var> starting at word number <var class="term">start</var>. If <var class="term">count</var> is greater than the number of words remaining in <var class="term">string</var> starting with word number <var class="term">start</var>, the remainder of the <var class="term">string</var> starting at word number <var class="term">start</var> is returned.
	</td></tr>
			This argument must be non-negative; if zero, the null string is returned. </td></tr>

	<tr><th><var>Spaces</var></th>		<tr><th><var>Spaces</var></th>
	<td>A set of "whitespace" characters, that is, characters that separate words. The default is the blank character. If the null string is provided, the blank character is used as the whitespace character.		<td>A set of "whitespace" characters, that is, characters that separate words. The default is the blank character. If the null string is provided, the blank character is used as the whitespace character. </td></tr>
	</td></tr>
	</table>		</table>

	==Usage notes==		==Usage notes==
	<ul>		<ul>
Line 30:		Line 35:
	==Examples==		==Examples==
	The following fragment:		The following fragment:
	<p class="code">PrintText {~='aa bb cc':Words(1, 2)}.		<p class="code">PrintText {~='aa bb cc':Words(2)}.
			PrintText {~='aa bb cc':Words(1, 2)}.
	PrintText {~='aa bb cc':Words(4, 1)}.		PrintText {~='aa bb cc':Words(4, 1)}.
	PrintText {~='aa bb cc':Words(3, 2)}.		PrintText {~='aa bb cc':Words(3, 2)}.
Line 42:		Line 48:
	'aa bb cc':Words(2, 0)=.		'aa bb cc':Words(2, 0)=.
	</p>		</p>

	==See also==		==See also==
	<ul>		<ul>
	<li>[[List of StringTokenizer methods]]		<li>[[List of StringTokenizer methods]]
	<li><var>[[Word (String function)\|Word]]</var> ~~- Select~~ word from list of words		<li><var>[[Word (String function)\|Word]]</var>, which selects a word from a list of words
	<li><var>[[WordCount (String function)\|WordCount]]</var> ~~- Count~~ words in list		<li><var>[[WordCount (String function)\|WordCount]]</var>, which counts the words in a list
	<li><var>[[WordNumberIn and WordNumberOf (String functions)\|WordNumberIn and WordNumberOf]]</var> ~~- Word~~ number of "needle" word within "haystack" list of words		<li><var>[[WordNumberIn and WordNumberOf (String functions)\|WordNumberIn and WordNumberOf]]</var>, which returns the word number of a "needle" word within a "haystack" list of words
	</ul>		</ul>
	{{Template:String:Words footer}}		{{Template:String:Words footer}}

JAL2: /* Usage notes */

2012-03-21T14:58:22Z

Usage notes

← Older revision		Revision as of 14:58, 21 March 2012
Line 25:		Line 25:
	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li><var>Words</var> is the OO version of <var>$Lstr_SubWord</var>.		<li><var>Words</var> is the OO version of <var>[[$Lstr_SubWord]]</var>.
	</ul>		</ul>

JAL2: /* Usage notes */

2012-03-21T14:58:06Z

Usage notes

← Older revision		Revision as of 14:58, 21 March 2012
Line 24:		Line 24:
	</table>		</table>
	==Usage notes==		==Usage notes==
			<ul>
			<li><var>Words</var> is the OO version of <var>$Lstr_SubWord</var>.
			</ul>

	==Examples==		==Examples==
	The following fragment:		The following fragment:

JAL2: /* See also */

2012-03-21T14:57:48Z

← Older revision		Revision as of 18:41, 21 March 2012
Line 54:		Line 54:
	<li><var>[[Word (String function)\|Word]]</var>, which selects a word from a list of words		<li><var>[[Word (String function)\|Word]]</var>, which selects a word from a list of words
	<li><var>[[WordCount (String function)\|WordCount]]</var>, which counts the words in a list		<li><var>[[WordCount (String function)\|WordCount]]</var>, which counts the words in a list
	<li><var>[[WordNumberIn and WordNumberOf (String functions)\|WordNumberIn and WordNumberOf]]</var>, which ~~returns~~ the word number of a "needle" word within a "haystack" list of words		<li><var class="camel">[[WordNumberIn and WordNumberOf (String functions)\|WordNumberIn and WordNumberOf]]</var>, which return the word number of a "needle" word within a "haystack" list of words
	</ul>		</ul>
	{{Template:String:Words footer}}		{{Template:String:Words footer}}

← Older revision		Revision as of 14:57, 21 March 2012
Line 44:		Line 44:
	<li><var>[[WordCount (String function)\|WordCount]]</var> - Count words in list		<li><var>[[WordCount (String function)\|WordCount]]</var> - Count words in list
	<li><var>[[WordNumberIn and WordNumberOf (String functions)\|WordNumberIn and WordNumberOf]]</var> - Word number of "needle" word within "haystack" list of words		<li><var>[[WordNumberIn and WordNumberOf (String functions)\|WordNumberIn and WordNumberOf]]</var> - Word number of "needle" word within "haystack" list of words
	~~<li><var>Words</var> is the OO version of <var>$Lstr_SubWord</var>.~~
	</ul>		</ul>
	{{Template:String:Words footer}}		{{Template:String:Words footer}}