"Fossies" - the Fresh Open Source Software Archive  

Source code changes of the file "docs/omegascript.rst" between
xapian-omega-1.4.18.tar.xz and xapian-omega-1.4.19.tar.xz

About: Xapian Omega is an application built on Xapian, consisting of indexers and a CGI search frontend.

omegascript.rst  (xapian-omega-1.4.18.tar.xz):omegascript.rst  (xapian-omega-1.4.19.tar.xz)
skipping to change at line 80 skipping to change at line 80
filters. filters.
You must use ``$addfilter`` before any command which requires the query You must use ``$addfilter`` before any command which requires the query
to have been parsed - see ``$setmap`` for a list of these commands. to have been parsed - see ``$setmap`` for a list of these commands.
$allterms[{DOCID}] $allterms[{DOCID}]
list of all terms indexing the document with docid `DOCID` - if used list of all terms indexing the document with docid `DOCID` - if used
without a parameter list, them the docid of the current hit is without a parameter list, them the docid of the current hit is
implicitly used. implicitly used.
$base64{DATA}
encodes DATA using base64.
Added in Omega 1.4.19.
$cgi{CGI} $cgi{CGI}
lookup the value of a CGI parameter. If the same parameter has lookup the value of a CGI parameter. If the same parameter has
multiple values, ``$cgi`` will pick one arbitrarily - use ``$cgilist`` multiple values, ``$cgi`` will pick one arbitrarily - use ``$cgilist``
if you want all the values. if you want all the values.
$cgilist{CGI} $cgilist{CGI}
return a list of all values of a CGI parameter return a list of all values of a CGI parameter
$cgiparams $cgiparams
return a list of all the unique CGI parameter names, sorted in return a list of all the unique CGI parameter names, sorted in
skipping to change at line 350 skipping to change at line 355
double quotes. double quotes.
``VALUEFORMAT`` provides a way to specify how to encode values. It's ``VALUEFORMAT`` provides a way to specify how to encode values. It's
evaluated for each value with ``$_`` set to the OmegaScript map value evaluated for each value with ``$_`` set to the OmegaScript map value
and the result should be JSON to use as the JSON object value. If and the result should be JSON to use as the JSON object value. If
omitted or empty the value is encoded as a JSON string (so effectively omitted or empty the value is encoded as a JSON string (so effectively
the default is ``"$json{$_}"``). Note that (unlike ``KEYFORMAT``) this the default is ``"$json{$_}"``). Note that (unlike ``KEYFORMAT``) this
does need to include ``$json{}`` and double quotes, because the value does need to include ``$json{}`` and double quotes, because the value
doesn't have to be a JSON string. doesn't have to be a JSON string.
Added in Omega 1.4.15. Simple example::
$jsonobject{foo}
More complex example which upper-cases the keys and uses JSON integers
for the values::
$jsonobject{foo,$upper{$_},$_}
Added in Omega 1.4.15. Since 1.4.19 the returned JSON no longer
contains newlines, which makes it usable as a single line serialisation
format without post-processing.
$keys{MAP} $keys{MAP}
returns a list containing the keys of MAP (as set by ``$setmap``). returns a list containing the keys of MAP (as set by ``$setmap``).
The keys are in sorted order (by raw byte comparison). The keys are in sorted order (by raw byte comparison).
Added in Omega 1.4.15. Added in Omega 1.4.15.
$last $last
MSet index one beyond the end of the current page (so ``$hit`` runs MSet index one beyond the end of the current page (so ``$hit`` runs
from ``0`` to ``$sub{$last,1}``). from ``0`` to ``$sub{$last,1}``).
skipping to change at line 626 skipping to change at line 642
Omega sets ``flag_default`` to ``true`` by default - you can set it to Omega sets ``flag_default`` to ``true`` by default - you can set it to
an empty value to turn it off (``$set{flag_default,}``): an empty value to turn it off (``$set{flag_default,}``):
* flag_auto_multiword_synonyms * flag_auto_multiword_synonyms
* flag_auto_synonyms * flag_auto_synonyms
* flag_boolean * flag_boolean
* flag_boolean_any_case * flag_boolean_any_case
* flag_cjk_ngram (new in 1.2.22 and 1.3.4) * flag_cjk_ngram (new in 1.2.22 and 1.3.4)
* flag_default * flag_default
* flag_lovehate * flag_lovehate
* flag_no_positions (new in 1.4.19)
* flag_partial * flag_partial
* flag_phrase * flag_phrase
* flag_pure_not * flag_pure_not
* flag_spelling_correction (see ``$suggestion`` for suggested * flag_spelling_correction (see ``$suggestion`` for suggested
correction) correction)
* flag_synonym * flag_synonym
* flag_wildcard * flag_wildcard
Note that the ``Xapian::QueryParser::FLAG_ACCUMULATE`` flag is always Note that the ``Xapian::QueryParser::FLAG_ACCUMULATE`` flag is always
enabled by Omega because it's needed for ``$stoplist`` and ``$unstem`` enabled by Omega because it's needed for ``$stoplist`` and ``$unstem``
 End of changes. 3 change blocks. 
1 lines changed or deleted 18 lines changed or added

Home  |  About  |  Features  |  All  |  Newest  |  Dox  |  Diffs  |  RSS Feeds  |  Screenshots  |  Comments  |  Imprint  |  Privacy  |  HTTP(S)