[sr-dev] git:5.8:7bf787d0: textopx/doc: fixed hard-to-read documentation for textopsx

Module: kamailio Branch: 5.8 Commit: 7bf787d00f9f7ed8a2d758219d6d1413b2b5c975 URL: https://github.com/kamailio/kamailio/commit/7bf787d00f9f7ed8a2d758219d6d141… Author: Dragos Vingarzan &lt;vingarzan(a)gmail.com&gt; Committer: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Date: 2024-07-01T09:10:51+02:00 textopx/doc: fixed hard-to-read documentation for textopsx - was missing line-wraps in examples list, hence very hard to read (cherry picked from commit 48d97c1941f660aa396b5ef100584611cf92ad21) --- Modified: src/modules/textopsx/doc/selects.xml --- Diff: https://github.com/kamailio/kamailio/commit/7bf787d00f9f7ed8a2d758219d6d141… Patch: https://github.com/kamailio/kamailio/commit/7bf787d00f9f7ed8a2d758219d6d141… --- diff --git a/src/modules/textopsx/doc/selects.xml b/src/modules/textopsx/doc/selects.xml index 6d4dd4e3a25..3c72c21cd36 100644 --- a/src/modules/textopsx/doc/selects.xml +++ b/src/modules/textopsx/doc/selects.xml @@ -9,30 +9,35 @@ <title>@hf_value</title> <para> Get value of required header-value or param. Note that functions called 'value2' - works with Authorization-like headers where comma is not treated as value delimiter. Formats: - @hf_value.HFNAME[IDX] # idx value, negative value counts from bottom - @hf_value.HFNAME.PARAM_NAME - @hf_value.HFNAME[IDX].PARAM_NAME - @hf_value.HFNAME.p.PARAM_NAME # or .param., useful if required called "uri", "p", "param" - @hf_value.HFNAME[IDX].p.PARAM_NAME # dtto - @hf_value.HFNAME[IDX].uri # (&lt; &amp; &gt; excluded) - @hf_value.HFNAME[*] # return comma delimited list of all values (combines headers) - @hf_value.HFNAME # the same as above [*] but may be parsed by cfg.y - @hf_value.HFNAME[*].uri # return comma delimited list of uris (&lt; &amp; &gt; excluded) - @hf_value.HFNAME.uri # the same as above [*] but may be parsed by cfg.y - @hf_value.HFNAME[IDX].name # returns name part, quotes excluded - @hf_value.HFNAME.name # returns name part of the first value + works with Authorization-like headers where comma is not treated as value delimiter. + </para> + <para> + Formats: + <itemizedlist> + &lt;listitem&gt;(a)hf_value.HFNAME[IDX] # idx value, negative value counts from bottom</listitem> + &lt;listitem&gt;(a)hf_value.HFNAME.PARAM_NAME&lt;/listitem&gt; + &lt;listitem&gt;(a)hf_value.HFNAME[IDX].PARAM_NAME&lt;/listitem&gt; + &lt;listitem&gt;(a)hf_value.HFNAME.p.PARAM_NAME # or .param., useful if required called "uri", "p", "param"</listitem> + &lt;listitem&gt;(a)hf_value.HFNAME[IDX].p.PARAM_NAME # dtto</listitem> + &lt;listitem&gt;(a)hf_value.HFNAME[IDX].uri # (&lt; &amp; &gt; excluded)</listitem> + &lt;listitem&gt;(a)hf_value.HFNAME[*] # return comma delimited list of all values (combines headers)</listitem> + &lt;listitem&gt;(a)hf_value.HFNAME # the same as above [*] but may be parsed by cfg.y</listitem> + &lt;listitem&gt;(a)hf_value.HFNAME[*].uri # return comma delimited list of uris (&lt; &amp; &gt; excluded)</listitem> + &lt;listitem&gt;(a)hf_value.HFNAME.uri # the same as above [*] but may be parsed by cfg.y</listitem> + &lt;listitem&gt;(a)hf_value.HFNAME[IDX].name # returns name part, quotes excluded</listitem> + &lt;listitem&gt;(a)hf_value.HFNAME.name # returns name part of the first value</listitem> - @hf_value2.HFNAME # returns value of first header - @hf_value2.HFNAME[IDX] # returns value of idx's header - @hf_value2.HFNAME.PARAM_NAME - @hf_value2.HFNAME[IDX].PARAM_NAME + &lt;listitem&gt;(a)hf_value2.HFNAME # returns value of first header</listitem> + &lt;listitem&gt;(a)hf_value2.HFNAME[IDX] # returns value of idx's header</listitem> + &lt;listitem&gt;(a)hf_value2.HFNAME.PARAM_NAME&lt;/listitem&gt; + &lt;listitem&gt;(a)hf_value2.HFNAME[IDX].PARAM_NAME&lt;/listitem&gt; - @hf_value.HFNAME[IDX].uri # return URI, quotes excluded - @hf_value.HFNAME.p.uri # returns param named uri, not URI itself - @hf_value.HFNAME.p.name # returns param named name, not name itself - @hf_value.HFNAME[IDX].uri.name # any sel_any_uri nested features may be used - @hf_value.HFNAME[IDX].nameaddr.name # select_any_nameaddr + &lt;listitem&gt;(a)hf_value.HFNAME[IDX].uri # return URI, quotes excluded</listitem> + &lt;listitem&gt;(a)hf_value.HFNAME.p.uri # returns param named uri, not URI itself</listitem> + &lt;listitem&gt;(a)hf_value.HFNAME.p.name # returns param named name, not name itself</listitem> + &lt;listitem&gt;(a)hf_value.HFNAME[IDX].uri.name # any sel_any_uri nested features may be used</listitem> + &lt;listitem&gt;(a)hf_value.HFNAME[IDX].nameaddr.name # select_any_nameaddr</listitem> + </itemizedlist> </para> <para>Meaning of the parameters is as follows:</para> <itemizedlist>