Module:Str find word/doc

All parameters (synonyms)

{{Str find word
|string  = 
|word    =
|orwords = 
|case    =
|yes     =
|no      =
|explain =
}}

{{Str find word
|s    = 
|w    =
|orw  =
|case =
|yes  =
|no   =
|explain =
}}

{{Str find word
|s= source= 
|word= andwords= andw=
|orwords= orw=
|case=
|yes=
|no=
|explain=
}}

{{Str find word |s= |w= |andw= |orw= |case= |yes= |no= |sep= |sep-out= |explain=}}

{{Str find word
|source =
|word   =
}}

When the word is found in the source (True), the function returns the word itself (by default), or |yes= value (when entered non-empty).

When not found (False), the function returns a empty string (''), or the |no= value when entered.

|word= as noted, can be a list of words. All will be checked with the AND-requirement (each word must be present).

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

When both |word=, |andwords= are present, they are combined into one single AND-wordlist.

|orwords= accepts a list of words that all will be checked with the OR-requirement (at least one of the words must be present).

todo

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

• Pages with Unknown parameters are listed in Category:Pages using str find word with unknown parameters (0).

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).

• |explain=true: when in Preview, display a report on input, output and the logical steps (debug).
• |explain=testcases: When set in ns Template or User on subpage /testcases, the Preview report is static (shown permanently).