Changeset 15859 in project


Ignore:
Timestamp:
09/13/09 16:36:30 (10 years ago)
Author:
sjamaan
Message:

Fix definition lists (silly wiki syntax tripped me up again!)

File:
1 edited

Legend:

Unmodified
Added
Removed
  • wiki/eggref/4/estraier-client

    r15858 r15859  
    3535type of conditions:
    3636
    37 {{(exn estraier-client args)}} ; Arguments are invalid
    38 {{(exn estraier-client auth)}} ; Authentication failed
    39 {{(exn estraier-client perm)}} ; Permission denied
    40 {{(exn estraier-client node)}} ; Node does not exist
    41 {{(exn estraier-client server)}} ; Internal server error
     37; {{(exn estraier-client args)}} : Arguments are invalid
     38; {{(exn estraier-client auth)}} : Authentication failed
     39; {{(exn estraier-client perm)}} : Permission denied
     40; {{(exn estraier-client node)}} : Node does not exist
     41; {{(exn estraier-client server)}} : Internal server error
    4242
    4343=== Node API
     
    112112following meaning:
    113113
    114 {{phrase}} ; This is the search phrase which is matched against the documents (a string)
    115 {{attr-phrases}} ; These are the search phrases which are matched against the document attributes (a list of strings). This list can contain up to 10 search conditions, but not more. It defaults to the empty list.
    116 {{order}} ; The order in which the results should be returned (a string).
    117 {{max}} ; The maximum number of results returned (a number). If not supplied, it defaults to 10.
    118 {{skip}} ; The number of documents to skip in the result set (a number). Defaults to 0.
    119 {{distinct}} ; The attribute name on which to filter distinctly (a symbol or string).
    120 {{depth}} ; The depth of the meta-search (a number).  Defaults to 0.
    121 {{wwidth}} ; The whole width (in characters) of search result snippets (a number).  Default depends on server configuration. If zero, no snippets are returned. If negative, whole documents are returned.
    122 {{hwidth}} ; The width of strings (in characters) in the snippet in the beginning of the text (a number). Default depends on server configuration.
    123 {{awidth}} ; The width of strings (in characters) around the snipper (a number). Default depends on server configuration.
    124 {{options}} ; Options for the search condition. (TODO)
    125 {{auxiliary}} ; Permission to adopt result of the auxiliary index (a number). By default, it is 32. (TODO)
    126 {{mask}} ; The mask of search targets (a number). 1 means the node itself, 2 means the first link, 4 means the second link, 8 means the third link, and power values of 2 and their summation compose the mask. (TODO)
     114; {{phrase}} : This is the search phrase which is matched against the documents (a string)
     115; {{attr-phrases}} : These are the search phrases which are matched against the document attributes (a list of strings). This list can contain up to 10 search conditions, but not more. It defaults to the empty list.
     116; {{order}} : The order in which the results should be returned (a string).
     117; {{max}} : The maximum number of results returned (a number). If not supplied, it defaults to 10.
     118; {{skip}} : The number of documents to skip in the result set (a number). Defaults to 0.
     119; {{distinct}} : The attribute name on which to filter distinctly (a symbol or string).
     120; {{depth}} : The depth of the meta-search (a number).  Defaults to 0.
     121; {{wwidth}} : The whole width (in characters) of search result snippets (a number).  Default depends on server configuration. If zero, no snippets are returned. If negative, whole documents are returned.
     122; {{hwidth}} : The width of strings (in characters) in the snippet in the beginning of the text (a number). Default depends on server configuration.
     123; {{awidth}} : The width of strings (in characters) around the snipper (a number). Default depends on server configuration.
     124; {{options}} : Options for the search condition. (TODO)
     125; {{auxiliary}} : Permission to adopt result of the auxiliary index (a number). By default, it is 32. (TODO)
     126; {{mask}} : The mask of search targets (a number). 1 means the node itself, 2 means the first link, 4 means the second link, 8 means the third link, and power values of 2 and their summation compose the mask. (TODO)
    127127
    128128See the [[http://hyperestraier.sourceforge.net/uguide-en.html#searchcond|documentation for search conditions]] for information on the syntax of {{phrase}}, {{attr-phrases}} and {{order}}.
     
    276276the following keys:
    277277
    278 {{name}} ; The name of the node (string)
    279 {{label}} ; The label of the node (string)
    280 {{document-count}} ; The number of documents in the node's database (number)
    281 {{word-count}} ; The number of unique words in the node's database (number)
    282 {{size}} ; The size of the node's database (number) (in bytes?)
    283 {{admin-users}} ; The names of the users that are admin to this node (list of strings)
    284 {{guest-users}} ; The names of the users that are guests to this node (list of strings)
     278; {{name}} : The name of the node (string)
     279; {{label}} : The label of the node (string)
     280; {{document-count}} : The number of documents in the node's database (number)
     281; {{word-count}} : The number of unique words in the node's database (number)
     282; {{size}} : The size of the node's database (number) (in bytes?)
     283; {{admin-users}} : The names of the users that are admin to this node (list of strings)
     284; {{guest-users}} : The names of the users that are guests to this node (list of strings)
    285285
    286286==== get-cache-usage
     
    314314alists.  Each node info alist contains the following symbolic keys:
    315315
    316 {{name}} ; The name of the node (string)
    317 {{label}} ; The label of the node (string)
    318 {{document-count}} ; The number of documents in the node's database (number)
    319 {{word-count}} ; The number of unique words in the node's database (number)
    320 {{size}} ; The size of the node's database (number) (in bytes?)
     316; {{name}} : The name of the node (string)
     317; {{label}} : The label of the node (string)
     318; {{document-count}} : The number of documents in the node's database (number)
     319; {{word-count}} : The number of unique words in the node's database (number)
     320; {{size}} : The size of the node's database (number) (in bytes?)
    321321
    322322==== add-node
     
    348348alists.  Each user info alist contains the following symbolic keys:
    349349
    350 {{name}} ; The name of the user
    351 {{password}} ; The encrypted password
    352 {{flags}} ; The user flags. The string contains "b" if the user is banned or "s" if it is a superuser.
    353 {{fullname}} ; The full name of the user.
    354 {{misc}} ; Miscellaneous information about the user.
     350; {{name}} : The name of the user
     351; {{password}} : The encrypted password
     352; {{flags}} : The user flags. The string contains "b" if the user is banned or "s" if it is a superuser.
     353; {{fullname}} : The full name of the user.
     354; {{misc}} : Miscellaneous information about the user.
    355355
    356356All values are strings.
Note: See TracChangeset for help on using the changeset viewer.