Module:Str find word/doc

Module:check for unknown parameters

This module looks for a complete word in a comma-separated list of words. It then returns a True or False value, which can be used accordingly.

The search can be ecxtended to check for multiple words being present (

For example, in the string 'alpha, foobar' the word 'alpha' appears, but the word 'foo' does not: there only is the complete word 'foobar'. The module is aimed at template code usage. (The editor does not have to apply Lua patterns like [%a%d]*).

A word is defined to be only of these characters: alphanumerics ('a-z A-Z 0-9'), hyphen ('-') and underscore ('_')  Y. All other characters are non-word characters, and so possible word-separators (like ';,()<space>'   12pxN).

Core function:

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

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.

All parameters, in three options

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

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

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

Instead of a single word to check, a list of target words can be entered: |word=alpha, foo, bingo. This |word=-list will be treated with AND-logic: each and all of the words must be present. See:

Wordlist examples: |word=(wordlist)

|word=alpha, foo

|word=alpha-beta; _bar;all-up#foo(27) Oct Nov [Dec]

When |word= contains a wordlist, all words must be present to return the Yes value (AND-logic).

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

A word

A word can be a-z, A-Z, 0-9, - _ (not: ;,=()[]#$%)

Absent words never can make a True result

Digits are not treated as A number: "12" is a word.

Thus, the digital point "." is a word separato, and so will split "-17.5" into words "-17" and "5".

no numerical treatment: integers only (16.5 -> 16, 5)

newlines are not recognied. (todo: check pipes, etc).

wordlists

Wordlists consist of words & word-separators (=non-word-character): |word=alpha, bravo charlie (17)

Wordlists can be entered in: |source=, |word=, |andwords=, |orwords= and their synonyms |s|w|andw| orw=)

All |word=foo, bar words are treated as AND- words (equally to, and together with |andwords=)

repeated words in a list do not change the result, |word=foo, foo = |word=foo

AND-words: if present, all must be present in the source to be True

OR-words: if present, at least one must be present in the source to be True

An empty wordslist will considered to be True (will not create a False result)

The result to be True requires: AND-check=True and OR-check=True

results

There are no "error" results. If anything logic 'fails', a False value is returned.

By default:

Result=True returns the Yeslist: all words found; the AND-hitlist and the OR-hitlist

By definition, the Yeslist cannot be empty

Each list is , -separated (comma space), between the list is a ;  (semicolon space)

Each list is ordered by their searchlist order: 1. by AND-words 2. by order OR-words (not by order of source-words)

todo example here

Result=False returns a black string

By |yes=|no= parameter

• When entered, the result will return the |yes= or |no= value for True/False respectively.

|yes=OK, my word is found!; |no=No, my word is not in the source

Each can also be explicitly blank: |no=| (=the default no-return value for False); |yes=|: would require |no=not empty to be meaningful

no nil nor null

there is only T/F result. Not a nil situation.

• Pages with Unknown parameters are listed in Category:Unknown parameters (302) (todo)

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