.. _functx_contains-word:

====================
functx:contains-word
==================== 

Whether one string contains another, as a separate word

Description
~~~~~~~~~~~
The functx:contains-word function returns true if $word is contained in $arg as 
a separate word. It must be delimited by non-word characters or the beginning or 
end of $arg. It is case insensitive; it matches a word even if the case is 
different.

A "non-word character" is one that in Unicode belongs in either the Punctuation, 
Separators or Other category. Generally, most punctuation and white space are 
considered non-word characters, while letters and digits are word characters.

.. list-table::
   :widths: 40 60
   :header-rows: 1

   * - **Parameters**
     - **Description**
   * - arg:string()
     - the string to search
   * - word:string()
     - the word to find

Examples
~~~~~~~~
.. list-table::
   :widths: 25 25 50
   :header-rows: 1

   * - **XPath**
     - **Results**
     - **Explanation**
   * - functx:contains-word('abc def ghi', 'def')
     - true
     - 
   * - functx:contains-word('abc.def\ghi', 'def')
     - true
     - 
   * - functx:contains-word('abc def ghi', 'abc')
     - true
     - It can be at the beginning or end.
   * - functx:contains-word('abc', 'abc')
     - true
     - It can be the whole value.
   * - functx:contains-word('abcdef', 'abc')
     - false
     - abc does not appear as a separate word.

Depends On
~~~~~~~~~~
* :ref:`functx_escape-for-regex`.

See Also
~~~~~~~~

.. toctree::
   :titlesonly:
   :glob:

* :ref:`contains`.