Module:Str find word/doc: Difference between revisions

Revision as of 20:45, 30 September 2021

Latest revision as of 10:20, 7 August 2023

(624 intermediate revisions by 3 users not shown)

Line 1:

{{Lua|Module rating:String|pre-alphaModule:TableTools|Module:Yesno}}

Implements template '''{{tl|Str find word}}'''.

:[[:Module:String#find]]

:[[:mw:Extension:Scribunto/Lua_reference_manual#Patterns]]

:[[User:DePiep/sfw]]

:[[User:DePiep/sfw/sandbox]]

This module islooks intendedfor toa findword ''completebeing words''present in a stringcomma-separated list of words. ForIt example,then inreturns the stringa '{{monocode|1=alpha, foobarTrue}}' the wordor '{{monocode|1=alphaFalse}}' appearsvalue. By default, but the wordTrue-value '{{mono|1=foo}}'returned doesis not:the therefound onlyword isitself; the wordFalse-value '{{mono|1=foobar}}'is a blank string.

For example, in the source string '{{mono|1=foo, bar}}' the word '{{mono|1=bar}}' appears, but the word '{{mono|1=november}}' does not.

A '''word''' is defined to be consisting of: alphanumerics (a-z, A-Z, 0-9), the hyphen (-) and the underscore (_). For example: {{mono|1=foobar, foo-bar, foo_bar, foo123, _foo, 12, -x}}. All other characters are non-word-characters (like: {{nowrap|1='{{mono|1=, ; ( ) <space>}}'}}).

:<code><nowiki>{{#invoke:Str find word |main |source=foo, bar |word=bar}}</nowiki></code> <small>({{code|1=True}})</small> &rarr; {{#invoke:Str find word |main |source=foo, bar |word=bar}}

:<code><nowiki>{{#invoke:Str find word |main |source=alpha, beta, gamma |word=november}}</nowiki></code> <small>({{code|1=False}})</small> &rarr; {{#invoke:Str find word |main |source=alpha, beta, gamma |word=november}}

''Multiple word check'': The search can be extended to check for multiple words being present.

''AND''-list of words, all words must be present:

== Usage ==

:<code><nowiki>{{#invoke:Str find word |main |source=alpha, beta, gamma |andwords=beta, alpha}}</nowiki></code> <small>({{code|1=True}})</small> &rarr; {{#invoke:Str find word |main |source=alpha, beta, gamma |andwords=beta, alpha}}

<code><nowiki>{{</nowiki>#invoke:User:DePiep/sfw|''function_name''<nowiki>}}</nowiki></code>

:<code><nowiki>{{#invoke:Str find word |main |source=alpha, beta, gamma |andwords=beta, omega}}</nowiki></code> <small>({{code|1=False}})</small> &rarr; {{#invoke:Str find word |main |source=alpha, beta, gamma |andwords=beta, omega}}

==parameters==

<pre>

''OR''-list of words, at least one off the words must be present:

{{#invoke|main|

:<code><nowiki>{{#invoke:Str find word |main |source=alpha, beta, gamma |orwords=beta, alpha}}</nowiki></code> <small>({{code|1=True}})</small> &rarr; {{#invoke:Str find word |main |source=alpha, beta, gamma |orwords=beta, alpha}}

|source =

:<code><nowiki>{{#invoke:Str find word |main |source=alpha, beta, gamma |orwords=beta, omega}}</nowiki></code> <small>({{code|1=False}})</small> &rarr; {{#invoke:Str find word |main |source=alpha, beta, gamma |orwords=beta, omega}}

|word =

|andwords =

Complete words: the complete word is '{{mono|1=foobar}}' (example needed)

|orwords =

Whitespace is trimmed,

|case =

|yes =

The module is aimed at template code usage. <small>(The editor does not have to apply Lua patterns like {{code|1=[%a%d]*}})</small>.

|no =

|dbg =

}}

==Parameters==

</pre>

:Main parameters (including their synonyms)

<pre>

{|

{{#invoke|main|

|<pre>

|s =

{{Str find word

|w =

|andwsource= s=

|word= andwords= andw=

|orw =

|orwords= orw=

|case =

|yes case=

|out-true=

|no =

|out-false=

|dbg =

}}

</pre>

|}

<pre>{{Str find word |s= |w= |andw= |orw= |case= |out-true= |out-false=}}</pre>

===Basic: ''word'' is in ''source-wordlist''?===

<pre>

{{Str find word

{{#invoke|main|

|1source =

|2word =

|3 =

|4 =

|5 =

|6 =

|7 =

|8 =

}}

</pre>

:<code><nowiki>{{Str find word |source=cow, horse, dog, fish |word=dog}}</nowiki></code> <small>({{code|1=True}})</small> &rarr; {{Str find word |source=cow, horse, dog, fish |word=dog}}

:<code><nowiki>{{Str find word |source=cow, horse, dog, fish |word=cat}}</nowiki></code> <small>({{code|1=False}})</small> &rarr; {{Str find word |source=cow, horse, dog, fish |word=cat}}

===True/False return value===

:When the ''word'' is found in the ''source'' (True), the function returns the ''word'' itself (by default), or {{para|out-true}} value (when entered non-empty).

:When not found (False), the function returns a empty string ({{code|''}}), or the {{para|out-false}} value when entered.

{| class="wikitable"

|-

| {{para|1=source|2=alpha, foo, lima}}

| {{para|word|foo}}

| {{#invoke:Str find word |main |explain=true |source=alpha, foo, lima |word=foo}}

| {{aye}}

|

|-

| {{para|1=source|2=alpha, foo, lima}}

| {{para|word|bar}}

| {{#invoke:Str find word |main |explain=true |source=alpha, foo, lima |word=foo-bar}}

| {{nay}}

| full word ''bar'' not in the source

|-

| {{para|1=source|2=alpha, foo, lima}}

| {{para|word|foobar}}

| {{#invoke:Str find word |main |explain=true |source=alpha, foo, lima}}

| {{nay}}

| word ''foobar'' not in the source as full word

|}

===AND-wordlist checks===

:{{para|word}} can be a ''list of words''. All will be checked with the ''AND''-requirement (each word must be present).

:{{para |andwords}} accepts a ''list of words'' that all will be checked with the ''AND''-requirement (each word must be present).

:Alway, ''both'' {{para|word}} and {{para |andwords}} are combined into one single ''AND''-wordlist.

{| class="wikitable" style=""

|-

! {{para|1=source}}<br/>{{para|1=s}}

! {{para|1=andwords}}<br/>{{para|1=word}}

! result

! note

|-

| {{para|1=s|2=alpha, foo, lima, delta}}

| {{para |andw|delta, lima}}

| {{#invoke:Str find word |main |explain=true |s=alpha, foo, lima, delta |andw=delta, lima}}

| both words present in the source

|-

| {{para|1=s|2=alpha, foo, lima, delta}}

| {{para |andw|foo, nov}}

| {{#invoke:Str find word |main |explain=true |s=alpha, foo, lima, delta}}

| AND-logic: A word in the ''AND''-list is not present ({{mono|nov}}), so false

|-

| {{para|1=s|2=alpha, foo, lima, delta}}

| {{para |andw|delta}}

| {{#invoke:Str find word |main |explain=true |s=alpha, foo, lima, delta |andw=delta}}

| {{para|w}} and {{para |andw}} are combined

|-

| {{para|1=s|2=alpha, foo, lima, delta}}

| {{para |andw|bar, april}}

| {{#invoke:Str find word |main |explain=true |s=alpha, foo, lima, delta |andw=delta}}

|

|}

===OR-wordlist checks===

;{{para |orwords}}, {{para |orw}}

:Accepts a ''list of words'' that all will be checked by the ''OR-requirement'' ("at least one of the words must be present).

{| class="wikitable" style=""

|-

! {{para|1=source}}<br/>{{para|1=s}}

!

! {{para|1=orwords}}

! result

! note

|-

| {{para|1=s|2=alpha, foo, lima, delta}}

|

|

| {{#invoke:Str find word |main |explain=true |s=alpha, foo, lima, delta |andw=delta, lima}}

| both words present in the source

|-

| {{para|1=s|2=alpha, foo, lima, delta}}

|

|

| {{#invoke:Str find word |main |explain=true |s=alpha, foo, lima, delta}}

|

|-

| {{para|1=s|2=alpha, foo, lima, delta}}

| {{para |andw|delta}}

|

| {{#invoke:Str find word |main |explain=true |s=alpha, foo, lima, delta |andw=delta}}

| {{para|w}} and {{para |andw}} are combined

|-

| {{para|1=s|2=alpha, foo, lima, delta}}

|

| {{para |orw|delta, lima}}

| {{#invoke:Str find word |main |explain=true |s=alpha, foo, lima, delta |orw=delta, lima}}

| both OR-words are present in the source

|-

| {{para|1=s|2=alpha, foo, lima, delta}}

|

|

| {{#invoke:Str find word |main |explain=true |s=alpha, foo, lima, delta |orw=foo, nov}}

| OR-logic: one of the words is present ({{para|foo}}), so true

|-

| {{para|1=s|2=alpha, foo, lima, delta}}

| {{para |andw|alpha, lima}}

| {{para |orw|foo, nov}}

| {{#invoke:Str find word |main |explain=true |s=alpha, foo, lima, delta |andw=alpha, lima |orw=foo, nov}}

|

|-

| {{para|1=s|2=alpha, foo, lima, delta}}

| {{para |andw|bar, april}}

| {{para |orw|nov, dec}}

| {{#invoke:Str find word |main |explain=true |s=alpha, foo, lima, delta |andw=delta |orw=nov, dec}}

| none of the OR-words is present, so false

|}

===both AND-words and OR-words to check===

;{{para |andwords}} {{para |orwords}}

:checks ''both'' lists for their own check: "ANd-words" must all be present, "OR-words" must have at least one present.

:Result: True if both check results are True, otherwise False.

{| class="wikitable" style=""

|-

! {{para|1=source}}<br/>{{para|1=s}}

! {{para|1=andwords}}<br/>{{para|1=word}}

! {{para|1=orwords}}

! result

! note

|-

| {{para|1=s|2=alpha, foo, lima, delta}}

| {{para |andw|delta, lima}}

|

| {{#invoke:Str find word |main |explain=true |s=alpha, foo, lima, delta |andw=delta, lima}}

| both words present in the source

|-

| {{para|1=s|2=alpha, foo, lima, delta}}

| {{para |andw|foo, nov}}

|

| {{#invoke:Str find word |main |explain=true |s=alpha, foo, lima, delta}}

| AND-logic: A word in the ''AND''-list is not present ({{mono|nov}}), so false

|-

| {{para|1=s|2=alpha, foo, lima, delta}}

| {{para |andw|delta}}

|

| {{#invoke:Str find word |main |explain=true |s=alpha, foo, lima, delta |andw=delta}}

| {{para|w}} and {{para |andw}} are combined

|-

| {{para|1=s|2=alpha, foo, lima, delta}}

|

| {{para |orw|delta, lima}}

| {{#invoke:Str find word |main |explain=true |s=alpha, foo, lima, delta |orw=delta, lima}}

| both OR-words are present in the source

|-

| {{para|1=s|2=alpha, foo, lima, delta}}

|

|

| {{#invoke:Str find word |main |explain=true |s=alpha, foo, lima, delta |orw=foo, nov}}

| OR-logic: one of the words is present ({{para|foo}}), so true

|-

| {{para|1=s|2=alpha, foo, lima, delta}}

| {{para |andw|alpha, lima}}

| {{para |orw|foo, nov}}

| {{#invoke:Str find word |main |explain=true |s=alpha, foo, lima, delta |andw=alpha, lima |orw=foo, nov}}

|

|-

| {{para|1=s|2=alpha, foo, lima, delta}}

| {{para |andw|bar, april}}

| {{para |orw|nov, dec}}

| {{#invoke:Str find word |main |explain=true |s=alpha, foo, lima, delta |andw=delta |orw=nov, dec}}

| none of the OR-words is present, so false

|}

===Edge cases ===

;Blank list(s)

:Empty input string(s) will conclude negative:

{| class="wikitable"

|-

! colspan="5" style="padding-left:3em; text-align:left;" | {{para|1=source, andwords, orwords|2=&lt;blank>}}

|-

| {{para|1=source|2=&lt;blank>}}

| {{para|word|beta}}

| {{#invoke:Str find word |main |source= |word=beta}}

| {{nay}}

|-

| {{para|1=source|2=alpha, beta, gamma}}

| {{para|word|&lt;blank>}}

| {{#invoke:Str find word |main |alpha, beta, gamma |word=}}

| {{nay}}

|}

<noinclude>

==untested; noinclude from main /doc==

:As of Mar 2023, not supported.

===casesensitive ===

:{{para|casesensitive|true}}, {{para|case|true}} Case-sensistive (A=/=a) DEFAULT

:{{para|casesensitive|false}}, {{para|case|false}} Not case-sensistive (A=a)

{| class="wikitable" style=""

|-

! {{para|1=source}}<br/> {{para|1=s}}

! {{para|1=word}}<br/>{{para|1=w}}

! {{para|1=case}}

! result

! note

|-

| {{para|1=s|2=alpha, foo, lima}}

| {{para|w|foo}}

|

| &rarr; {{#invoke:Str find word |main |explain=true |s=alpha, foo, lima|w=foo|out-true=yes|out-false=no}}

|

|-

| {{para|1=s|2=alpha, foo, lima}}

| {{para|w|foobar}}

|

| &rarr; {{#invoke:Str find word |main |explain=true |source=alpha, foo, lima |word=foobar|out-true=yes|out-false=no}}

|

|-

| {{para|1=s|2=alpha, foobar, lima}}

| {{para|w|foo}}

|

| &rarr; {{#invoke:Str find word |main |explain=true |source=alpha, foobar, lima |word=foo|out-true=yes|out-false=no}}

| 'foo' is not the complete word

|-

| {{para|1=s|2=alpha, FOO, lima}}

| {{para|w|foo}}

|

| &rarr; {{#invoke:Str find word |main |explain=true |source=alpha, FOO, lima |word=foo|out-true=yes|out-false=no|case=false}}

| {{para|case|false}}: a=A ''(default)''

|-

| {{para|1=s|2=alpha, FOO, lima}}

| {{para|w|foo}}

|

| &rarr; {{#invoke:Str find word |main |explain=true |source=alpha, FOO, lima |word=foo|out-true=yes|out-false=no|case=true}}

| {{para|case|true}}: a=/=A

|}

===Rephrase True, False result: {{para|1=out-true=, out-false|2=}}===

{| class="wikitable"

|-

! colspan="5" style="padding-left:3em; text-align:left;" | {{para|out-true|out-true, a hit}}<br/>{{para|out-false|out-falset found}}

|-

| {{para|1=source|2=alpha, foo, lima}}

| {{para|word|foo}}

| {{#invoke:Str find word |main |explain=true |source=alpha, foo, lima |word=foo|out-true=Yes, a hit|out-false=No, not found}}

| {{aye}}

|-

| {{para|1=source|2=alpha, foo, lima}}

| {{para|word|foobar}}

| {{#invoke:Str find word |main |explain=true |source=alpha, foo, lima |word=foobar|out-true=Yes, a hit|out-false=No, not found}}

| {{nay}}

|}

===boolean words===

;{{para|booleans}}

:{{para|booleans|true}} will convert ''all boolean words'' into "True/False".

:per [[:module:Yesno]] ({{code|1=Yes, true, yes, 1}} = true) (todo: document value 2?, nil, blanketc. Irrespective of case?)

:other words not changed ("horse" remains horse, not T/F).

:Note: per logic definition, the ''word'' "false" is returned (as being found).

{| class="wikitable"

|-

! colspan="5" style="padding-left:3em; text-align:left;" | {{para|1=booleans|2=true}}

|-

| {{para|1=source|2=YeS}}

| {{para|1=word|2=true}}

| {{#invoke:Str find word |main |booleans=true |source=YeS |word=1}}

|

|-

| {{para|1=source|2=0}}

| {{para|1=word|2=FalSe}}

| {{#invoke:Str find word |main |booleans=true |source=0 |word=FalSe}}

| ''note:'' the ''word'' "false" is found and returned

|}

===quotes, escape===

:under construction

===synonyms===

:under construction

</noinclude>

==Errors and analysis==

* The logic itself does not produce errors. There is always a True of False result.

* Pages with Unknown parameters are listed in {{clc|Category:Pages using str find word with unknown parameters}}.

:There are no logical errors foreseen: any flaw in the input will return a False result (for example, no input strings to check were entered).

<includeonly>{{Sandbox other||

<!-- Categories below this line; interwikis at Wikidata -->

* {{para|explain|true}}: when in {{button|Preview}}, display a report on input, output and the logical steps (debug).

* {{para|explain|testcases}}: When set in ns {{mono|1=Template}} or {{mono|1=User}} on subpage {{mono|1=/testcases}}, the Preview report is static (shown permanently).

{{String-handling templates|state=collapsed}}

<includeonly>{{sandbox other||

[[:Category:Modules that manipulate strings]]

}}</includeonly>