Programmer Guide/Command Reference/KEYWORD - Revision history

Jw: /* Searching for a keyword or its abbreviation */

2016-11-15T10:34:18Z

Searching for a keyword or its abbreviation

← Older revision		Revision as of 12:34, 15 November 2016
Line 9:		Line 9:
	<var>var</var> := KEYWORD [ /Full [ /Casesensitive ] ] [[Programmer_Guide/Command_Reference_Options/-\|/-]] <var>testValue</var> <var>keyword<sub>0</sub></var> [ … <var>keyword<sub>n</sub></var> ]		<var>var</var> := KEYWORD [ /Full [ /Casesensitive ] ] [[Programmer_Guide/Command_Reference_Options/-\|/-]] <var>testValue</var> <var>keyword<sub>0</sub></var> [ … <var>keyword<sub>n</sub></var> ]

	;<var>testValue</var>: the keyword to locate in <var>keywordList</var>, or its abbreviation. Note that the <code>KEYWORD</code> command does not expect a unique abbreviation - it will simply return the first keyword starting with <code>testValue</code>, even if there are dozens more.		;<var>testValue</var>: the keyword to locate in <var>keywordList</var>, or its abbreviation. Note that the <code>KEYWORD</code> command does not expect a unique abbreviation - it will simply return the first keyword starting with <code>testValue</code>, even if there are dozens more. Note also, that if this value is an integer, it is interpreted as a zero-based index, making the command synonymous with the [[Programmer_Guide/Command_Reference/WORD\|<code>WORD</code>]] command.
	;<var>keyword<sub>0</sub></var> [ … <var>keyword<sub>n</sub></var> ]: a blank-separated list of keywords		;<var>keyword<sub>0</sub></var> [ … <var>keyword<sub>n</sub></var> ]: a blank-separated list of keywords
	;<code>/Full</code>: if specified, the function searches for the first entry exactly equal to <var>testValue</var>, meaning that abbreviations will not be found.		;<code>/Full</code>: if specified, the function searches for the first entry exactly equal to <var>testValue</var>, meaning that abbreviations will not be found.

Jw at 09:21, 4 March 2016

2016-03-04T09:21:08Z

← Older revision		Revision as of 11:21, 4 March 2016
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}}}}		{{DISPLAYTITLE:{{SUBPAGENAME}}}}
			{{PG_StringCommands}}
	In its first form, the {{STX}} command <code>KEYWORD</code> searches for a keyword, or for the (non-unique) abbreviation of a keyword, in a list of keywords. In its second form, it simply checks a list of keywords for the presence of a keyword with a given index.		In its first form, the {{STX}} command <code>KEYWORD</code> searches for a keyword, or for the (non-unique) abbreviation of a keyword, in a list of keywords. In its second form, it simply checks a list of keywords for the presence of a keyword with a given index.
	__TOC__		__TOC__

Christian: /* Checking for the presence of an index */

2014-05-07T15:29:33Z

Checking for the presence of an index

← Older revision		Revision as of 17:29, 7 May 2014
Line 43:		Line 43:

	<var>var</var> := KEYWORD <var>index</var> <var>keyword<sub>0</sub></var> [ … <var>keyword<sub>n</sub></var> ]		<var>var</var> := KEYWORD <var>index</var> <var>keyword<sub>0</sub></var> [ … <var>keyword<sub>n</sub></var> ]

			=== Examples ===

	// will return 2, simply because there ''is'' a keyword with index 2		// will return 2, simply because there ''is'' a keyword with index 2

Christian: /* Searching for a keyword or its abbreviation */

2014-05-07T15:29:19Z

Searching for a keyword or its abbreviation

← Older revision		Revision as of 17:29, 7 May 2014
Line 14:		Line 14:

	See also the fine [[Programmer_Guide/Command_Reference/WORD\|<code>WORD</code>]] command.		See also the fine [[Programmer_Guide/Command_Reference/WORD\|<code>WORD</code>]] command.

			=== Examples ===

	// will return 0, because "toll" starts with "to"		// will return 0, because "toll" starts with "to"

Christian at 15:28, 7 May 2014

2014-05-07T15:28:46Z

← Older revision		Revision as of 17:28, 7 May 2014
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}}}}~~__TOC__~~		{{DISPLAYTITLE:{{SUBPAGENAME}}}}
	In its first form, the {{STX}} command <code>KEYWORD</code> searches for a keyword, or for the (non-unique) abbreviation of a keyword, in a list of keywords. In its second form, it simply checks a list of keywords for the presence of a keyword with a given index.		In its first form, the {{STX}} command <code>KEYWORD</code> searches for a keyword, or for the (non-unique) abbreviation of a keyword, in a list of keywords. In its second form, it simply checks a list of keywords for the presence of a keyword with a given index.
			__TOC__
	== Searching for a keyword or its abbreviation ==		== Searching for a keyword or its abbreviation ==

Christian at 15:28, 7 May 2014

2014-05-07T15:28:35Z

← Older revision		Revision as of 17:28, 7 May 2014
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}}}}		{{DISPLAYTITLE:{{SUBPAGENAME}}}}__TOC__

	In its first form, the {{STX}} command <code>KEYWORD</code> searches for a keyword, or for the (non-unique) abbreviation of a keyword, in a list of keywords. In its second form, it simply checks a list of keywords for the presence of a keyword with a given index.		In its first form, the {{STX}} command <code>KEYWORD</code> searches for a keyword, or for the (non-unique) abbreviation of a keyword, in a list of keywords. In its second form, it simply checks a list of keywords for the presence of a keyword with a given index.

Christian at 15:28, 7 May 2014

2014-05-07T15:28:26Z

← Older revision		Revision as of 17:28, 7 May 2014
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}}}}		{{DISPLAYTITLE:{{SUBPAGENAME}}}}

			In its first form, the {{STX}} command <code>KEYWORD</code> searches for a keyword, or for the (non-unique) abbreviation of a keyword, in a list of keywords. In its second form, it simply checks a list of keywords for the presence of a keyword with a given index.

	== Searching for a keyword or its abbreviation ==		== Searching for a keyword or its abbreviation ==

Line 38:		Line 41:
	Instead of a keyword, or its abbreviation, the <code>KEYWORD</code> command may be supplied an integer. It will then check if this integer is a valid index in the respective keyword list. If this is the case, it will return the unmodified index. Otherwise, it will return -1.		Instead of a keyword, or its abbreviation, the <code>KEYWORD</code> command may be supplied an integer. It will then check if this integer is a valid index in the respective keyword list. If this is the case, it will return the unmodified index. Otherwise, it will return -1.

	<var>var</var> := KEYWORD <var>index</var> <var>~~keywordList~~</var>		<var>var</var> := KEYWORD <var>index</var> <var>keyword<sub>0</sub></var> [ … <var>keyword<sub>n</sub></var> ]

	// will return 2, simply because there ''is'' a keyword with index 2		// will return 2, simply because there ''is'' a keyword with index 2

Christian at 15:25, 7 May 2014

2014-05-07T15:25:48Z

← Older revision		Revision as of 17:25, 7 May 2014
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}}}}=== Searching for a keyword or its abbreviation ===		{{DISPLAYTITLE:{{SUBPAGENAME}}}}
			== Searching for a keyword or its abbreviation ==

	The <code>KEYWORD</code> command searches for a keyword, or for the (non-unique) abbreviation of a keyword, in a list of keywords. It is supplied a single string <var>testValue</var> (the keyword to search, or its abbreviation), and a list of blank-separated keyword arguments, <var>keyword<sub>0</sub></var> [ … <var>keyword<sub>n</sub></var> ]. The command returns the zero-based index of the first keyword in <var>keyword<sub>0</sub></var> [ … <var>keyword<sub>n</sub></var> ] equal to (if option <code>/Full</code> is supplied), or starting with, <var>testValue</var>. If <var>keyword<sub>0</sub></var> [ … <var>keyword<sub>n</sub></var> ] does not contain an appropriate keyword, the command will return -1.		The <code>KEYWORD</code> command searches for a keyword, or for the (non-unique) abbreviation of a keyword, in a list of keywords. It is supplied a single string <var>testValue</var> (the keyword to search, or its abbreviation), and a list of blank-separated keyword arguments, <var>keyword<sub>0</sub></var> [ … <var>keyword<sub>n</sub></var> ]. The command returns the zero-based index of the first keyword in <var>keyword<sub>0</sub></var> [ … <var>keyword<sub>n</sub></var> ] equal to (if option <code>/Full</code> is supplied), or starting with, <var>testValue</var>. If <var>keyword<sub>0</sub></var> [ … <var>keyword<sub>n</sub></var> ] does not contain an appropriate keyword, the command will return -1.

Christian at 15:25, 7 May 2014

2014-05-07T15:25:08Z

← Older revision		Revision as of 17:25, 7 May 2014
Line 20:		Line 20:
	// will return 3, because "tofu" starts with "to"		// will return 3, because "tofu" starts with "to"
	// note that "alas toll" is ''one'' argument		// note that "alas toll" is ''one'' argument
	#index := keyword /- 'alas toll' fine backyard tofu		#index := keyword /- to 'alas toll' fine backyard tofu

	// will return 1, because "toll" starts with "to"		// will return 1, because "toll" starts with "to"
	// note compare this with the previous example		// note compare this with the previous example
	#index := keyword /- alas toll fine backyard tofu		#index := keyword /- to alas toll fine backyard tofu

	// will return -1, because the keyword list does not contain "To"		// will return -1, because the keyword list does not contain "To"

Christian at 15:24, 7 May 2014

2014-05-07T15:24:08Z

← Older revision		Revision as of 17:24, 7 May 2014
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}}}}=== Searching for a keyword or its abbreviation ===		{{DISPLAYTITLE:{{SUBPAGENAME}}}}=== Searching for a keyword or its abbreviation ===

	The <code>KEYWORD</code> command searches for a keyword, or for the (non-unique) abbreviation of a keyword, in a list of keywords. It is supplied a single string <var>testValue</var> (the keyword to search, or its abbreviation), and a list of blank-separated ~~keywords~~, <var>~~keywordList~~</var>. The command returns the zero-based index of the first keyword in <var>~~keywordList~~</var> equal to (if option <code>/Full</code> is supplied), or starting with, <var>testValue</var>. If <var>~~keywordList~~</var> does not contain an appropriate keyword, the command will return -1.		The <code>KEYWORD</code> command searches for a keyword, or for the (non-unique) abbreviation of a keyword, in a list of keywords. It is supplied a single string <var>testValue</var> (the keyword to search, or its abbreviation), and a list of blank-separated keyword arguments, <var>keyword<sub>0</sub></var> [ … <var>keyword<sub>n</sub></var> ]. The command returns the zero-based index of the first keyword in <var>keyword<sub>0</sub></var> [ … <var>keyword<sub>n</sub></var> ] equal to (if option <code>/Full</code> is supplied), or starting with, <var>testValue</var>. If <var>keyword<sub>0</sub></var> [ … <var>keyword<sub>n</sub></var> ] does not contain an appropriate keyword, the command will return -1.

	<var>var</var> := KEYWORD [ /Full [ /Casesensitive ] ] [[Programmer_Guide/Command_Reference_Options/-\|/-]] <var>testValue</var> <var>~~keywordList~~</var>		<var>var</var> := KEYWORD [ /Full [ /Casesensitive ] ] [[Programmer_Guide/Command_Reference_Options/-\|/-]] <var>testValue</var> <var>keyword<sub>0</sub></var> [ … <var>keyword<sub>n</sub></var> ]

	;<var>testValue</var>: the keyword to locate in <var>keywordList</var>, or its abbreviation. Note that the <code>KEYWORD</code> command does not expect a unique abbreviation - it will simply return the first keyword starting with <code>testValue</code>, even if there are dozens more.		;<var>testValue</var>: the keyword to locate in <var>keywordList</var>, or its abbreviation. Note that the <code>KEYWORD</code> command does not expect a unique abbreviation - it will simply return the first keyword starting with <code>testValue</code>, even if there are dozens more.
	;<var>~~keywordList~~</var>: a blank-separated list of keywords		;<var>keyword<sub>0</sub></var> [ … <var>keyword<sub>n</sub></var> ]: a blank-separated list of keywords
	;<code>/Full</code>: if specified, the function searches for the first entry exactly equal to <var>testValue</var>, meaning that abbreviations will not be found.		;<code>/Full</code>: if specified, the function searches for the first entry exactly equal to <var>testValue</var>, meaning that abbreviations will not be found.
	;<code>/Casesensitive</code>: If used in conjunction with <code>/Full</code>, the comparison is case sensitive. Without <code>/Full</code>, this option will be ignored and will have no effect whatsoever.		;<code>/Casesensitive</code>: If used in conjunction with <code>/Full</code>, the comparison is case sensitive. Without <code>/Full</code>, this option will be ignored and will have no effect whatsoever.

			See also the fine [[Programmer_Guide/Command_Reference/WORD\|<code>WORD</code>]] command.

	// will return 0, because "toll" starts with "to"		// will return 0, because "toll" starts with "to"
Line 15:		Line 17:
	// will return 2, because "/Full" looks for strict equality		// will return 2, because "/Full" looks for strict equality
	#index := keyword /Full /- to toll too to Toledo		#index := keyword /Full /- to toll too to Toledo

			// will return 3, because "tofu" starts with "to"
			// note that "alas toll" is ''one'' argument
			#index := keyword /- 'alas toll' fine backyard tofu

			// will return 1, because "toll" starts with "to"
			// note compare this with the previous example
			#index := keyword /- alas toll fine backyard tofu

	// will return -1, because the keyword list does not contain "To"		// will return -1, because the keyword list does not contain "To"
Line 23:		Line 33:
	#index := keyword /Casesensitive /- To toll too to Toledo		#index := keyword /Casesensitive /- To toll too to Toledo

	=== Checking for the presence of an index ===		== Checking for the presence of an index ==

	Instead of a keyword, or its abbreviation, the <code>KEYWORD</code> command may be supplied an integer. It will then check if this integer is a valid index in the respective keyword list. If this is the case, it will return the unmodified index. Otherwise, it will return -1.		Instead of a keyword, or its abbreviation, the <code>KEYWORD</code> command may be supplied an integer. It will then check if this integer is a valid index in the respective keyword list. If this is the case, it will return the unmodified index. Otherwise, it will return -1.