Browse code

textopsx: docs - notes about 1-based indexing for hf value functions

- GH #2387

(cherry picked from commit 6379f1280ba41e87ddb34fa1705ffe4231dcac9c)
(cherry picked from commit f5334a57ae5159f1a37b3f25b9db220a9a860fc2)

Daniel-Constantin Mierla authored on 31/03/2021 14:05:52 • Henning Westerholt committed on 22/10/2021 11:33:01
Showing 1 changed files
... ...
@@ -173,7 +173,8 @@ if(fnmatch("$rU", "123*"))
173 173
 	<itemizedlist>
174 174
 	    <listitem>
175 175
 		<para><emphasis>hf</emphasis> - Header field to be appended. Format: HFNAME [ [IDX] ].
176
-		If index is not specified new header is inserted at the end of message.
176
+		If index is not specified new header is inserted at the end of message. The index 1
177
+		correxponds to the first header.
177 178
 		</para>
178 179
 	    </listitem>
179 180
 	    <listitem>
... ...
@@ -206,7 +207,8 @@ append_hf_value("foo[-1]", "$var(Bar)") # try add value to the last header, if n
206 207
 	<itemizedlist>
207 208
 	    <listitem>
208 209
 		<para><emphasis>hf</emphasis> - Header field to be appended. Format: HFNAME [ [IDX] ].
209
-		If index is not specified new header is inserted at the top of message.
210
+		If index is not specified new header is inserted at the top of message. The index 1
211
+		correxponds to the first header.
210 212
 		</para>
211 213
 	    </listitem>
212 214
 	    <listitem>
... ...
@@ -237,7 +239,8 @@ insert_hf_value("foo[1]", "gogo") # try add to the first header
237 239
 	<itemizedlist>
238 240
 	    <listitem>
239 241
 		<para><emphasis>hf_par</emphasis> - Header field/param to be removed. Format: HFNAME [ [IDX] ] [. PARAM ]
240
-		If asterisk is specified as index then all values are affected.
242
+		If asterisk is specified as index then all values are affected. The index 1
243
+		correxponds to the first header.
241 244
 		</para>
242 245
 	    </listitem>
243 246
 	</itemizedlist>
... ...
@@ -267,7 +270,8 @@ remove_hf_value("foo[*].bar") # for each foo delete bar parameters
267 270
 	<itemizedlist>
268 271
 	    <listitem>
269 272
 		<para><emphasis>hf_par</emphasis> - Header/param to be removed. Format: HFNAME [ [IDX] ] [. PARAM ]
270
-		If asterisk is specified as index then all values are affected.
273
+		If asterisk is specified as index then all values are affected. The index 1
274
+		correxponds to the first header.
271 275
 		</para>
272 276
 	    </listitem>
273 277
 	</itemizedlist>
... ...
@@ -297,7 +301,8 @@ remove_hf_value2("foo[*].bar") # for each foo delete bar parameters
297 301
 	    <listitem>
298 302
 			<para><emphasis>hf_para</emphasis> - Header field value / param to be appended.
299 303
 				Format: HFNAME [ [IDX] ] [. PARAM]
300
-		If asterisk is specified as index then all values are affected.
304
+		If asterisk is specified as index then all values are affected. The index 1
305
+		correxponds to the first header.
301 306
 		</para>
302 307
 	    </listitem>
303 308
 	    <listitem>
... ...
@@ -333,7 +338,8 @@ assign_hf_value("foo[*].bar", "")  # set empty value (ex. lr)
333 338
 	<itemizedlist>
334 339
 	    <listitem>
335 340
 		<para><emphasis>hf_para</emphasis> - Header field value / param to be appended. Format: HFNAME [ [IDX] ] [. PARAM]
336
-		If asterisk is specified as index then all values are affected.
341
+		If asterisk is specified as index then all values are affected. The index 1
342
+		correxponds to the first header.
337 343
 		</para>
338 344
 	    </listitem>
339 345
 	    <listitem>