|
@@ -21,21 +21,21 @@
|
|
|
<title>Notations</title>
|
|
|
<para>The following notations are used:
|
|
|
<orderedlist>
|
|
|
- <listitem>@ - all selects always start with '@'. </listitem>
|
|
|
- <listitem>"string" - string type.</listitem>
|
|
|
- <listitem>integer - integer type.</listitem>
|
|
|
- <listitem>[] - Parameter markers. Can be either [integer] or
|
|
|
+ <listitem><para>@ - all selects always start with '@'.</para></listitem>
|
|
|
+ <listitem><para>"string" - string type.</para></listitem>
|
|
|
+ <listitem><para>integer - integer type.</para></listitem>
|
|
|
+ <listitem><para>[] - Parameter markers. Can be either [integer] or
|
|
|
["string"].
|
|
|
Note that instead of ["string"] one could write .string,
|
|
|
e.g.:
|
|
|
@foo.bar["string"] is equivalent to @foo.bar.string.
|
|
|
- </listitem>
|
|
|
- <listitem>{} - denotes an optional parameter.
|
|
|
+ </para></listitem>
|
|
|
+ <listitem><para>{} - denotes an optional parameter.
|
|
|
E.g.: @ruri.params{["string"]} means you could use
|
|
|
@ruri.params by itself or you could specify an extra parameter:
|
|
|
@ruri.params["trasnport"] or @ruri.params.transport.
|
|
|
- </listitem>
|
|
|
- <listitem><string> - means the next member is not fixed and can
|
|
|
+ </para></listitem>
|
|
|
+ <listitem><para><string> - means the next member is not fixed and can
|
|
|
take any string value (it is a string parameter).
|
|
|
It is equivalent with ["string"], e.g.:
|
|
|
@msg.header.<string> is the same as
|
|
@@ -43,18 +43,18 @@
|
|
|
It is used only to expose an internal implementation detail
|
|
|
(SEL_PARAM_* vs. CONSUME_NEXT_*), but from the script writer point
|
|
|
of view it is the same thing.
|
|
|
- </listitem>
|
|
|
- <listitem>.* - means the select can be followed by a variable number of
|
|
|
- string parameters.
|
|
|
+ </para></listitem>
|
|
|
+ <listitem><para>.* - means the select can be followed by a variable number
|
|
|
+ of string parameters.
|
|
|
E.g.: @cfg_get.* means that @cfg_get.core.version is a valid usage.
|
|
|
- </listitem>
|
|
|
- <listitem>* (without a '.' in front) - it means the last member
|
|
|
- might be a class that might expand further (but the
|
|
|
+ </para></listitem>
|
|
|
+ <listitem><para>* (without a '.' in front) - it means the
|
|
|
+ last member might be a class that might expand further (but the
|
|
|
"expansion" is not defined in the same module).
|
|
|
E.g. @foo.nameaddr* means that nameaddr is most likely
|
|
|
a class that expands further
|
|
|
(for example into @foo.nameaddr.uri a.s.o).
|
|
|
- </listitem>
|
|
|
+ </para></listitem>
|
|
|
</orderedlist>
|
|
|
</para>
|
|
|
</section>
|