Sfoglia il codice sorgente

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)
(cherry picked from commit 7bf787d00f9f7ed8a2d758219d6d1413b2b5c975)
(cherry picked from commit e017ae88c155c2bd60a9611bca676308695f3c75)
Dragos Vingarzan 1 anno fa
parent
commit
12ace0b9d8
1 ha cambiato i file con 27 aggiunte e 22 eliminazioni
  1. 27 22
      src/modules/textopsx/doc/selects.xml

+ 27 - 22
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>
+		<listitem>@hf_value.HFNAME[IDX]    # idx value, negative value counts from bottom</listitem>
+		<listitem>@hf_value.HFNAME.PARAM_NAME</listitem>
+		<listitem>@hf_value.HFNAME[IDX].PARAM_NAME</listitem>
+		<listitem>@hf_value.HFNAME.p.PARAM_NAME  # or .param., useful if required called "uri", "p", "param"</listitem>
+		<listitem>@hf_value.HFNAME[IDX].p.PARAM_NAME # dtto</listitem>
+		<listitem>@hf_value.HFNAME[IDX].uri # (&lt; &amp; &gt; excluded)</listitem>
+		<listitem>@hf_value.HFNAME[*]     # return comma delimited list of all values (combines headers)</listitem>
+		<listitem>@hf_value.HFNAME        # the same as above [*] but may be parsed by cfg.y</listitem>
+		<listitem>@hf_value.HFNAME[*].uri # return comma delimited list of uris (&lt; &amp; &gt; excluded)</listitem>
+		<listitem>@hf_value.HFNAME.uri    # the same as above [*] but may be parsed by cfg.y</listitem>
+		<listitem>@hf_value.HFNAME[IDX].name  # returns name part, quotes excluded</listitem>
+		<listitem>@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
+		<listitem>@hf_value2.HFNAME        # returns value of first header</listitem>
+		<listitem>@hf_value2.HFNAME[IDX]   # returns value of idx's header</listitem>
+		<listitem>@hf_value2.HFNAME.PARAM_NAME</listitem>
+		<listitem>@hf_value2.HFNAME[IDX].PARAM_NAME</listitem>
 
-		@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
+		<listitem>@hf_value.HFNAME[IDX].uri  # return URI, quotes excluded</listitem>
+		<listitem>@hf_value.HFNAME.p.uri  # returns param named uri, not URI itself</listitem>
+		<listitem>@hf_value.HFNAME.p.name # returns param named name, not name itself</listitem>
+		<listitem>@hf_value.HFNAME[IDX].uri.name #  any sel_any_uri nested features may be used</listitem>
+		<listitem>@hf_value.HFNAME[IDX].nameaddr.name # select_any_nameaddr</listitem>
+	</itemizedlist>
 	</para>
 	<para>Meaning of the parameters is as follows:</para>
 	<itemizedlist>