annotate docs/user/namespaces.rst @ 2934:e2b5a79a1e06

Fixed issue #499 - Search for tickets assigned to a user
author Aabhas Majumdar <majumdaraabhas@gmail.com>
date Sun, 08 Mar 2015 20:57:53 +0530
parents 6af6e61dc25f
children
rev   line source
2293
e5d44d1b9976 Added docs for user.
Ashutosh Singla <ashu1461@gmail.com>
parents:
diff changeset
1 ==========
e5d44d1b9976 Added docs for user.
Ashutosh Singla <ashu1461@gmail.com>
parents:
diff changeset
2 Namespaces
e5d44d1b9976 Added docs for user.
Ashutosh Singla <ashu1461@gmail.com>
parents:
diff changeset
3 ==========
e5d44d1b9976 Added docs for user.
Ashutosh Singla <ashu1461@gmail.com>
parents:
diff changeset
4
e5d44d1b9976 Added docs for user.
Ashutosh Singla <ashu1461@gmail.com>
parents:
diff changeset
5 URL layout
e5d44d1b9976 Added docs for user.
Ashutosh Singla <ashu1461@gmail.com>
parents:
diff changeset
6 ==========
e5d44d1b9976 Added docs for user.
Ashutosh Singla <ashu1461@gmail.com>
parents:
diff changeset
7 ``http://server/[NAMESPACE/][[@FIELD/]VALUE][/+VIEW]``
e5d44d1b9976 Added docs for user.
Ashutosh Singla <ashu1461@gmail.com>
parents:
diff changeset
8
e5d44d1b9976 Added docs for user.
Ashutosh Singla <ashu1461@gmail.com>
parents:
diff changeset
9 Above defines the URL layout, where uppercase letters are variable parts defined below and [] denotes optional.
2790
6af6e61dc25f change coding-std.py to inspect docs/*.rst; mass changes to rst files to remove trailing blanks, tabs, etc
RogerHaase <haaserd@gmail.com>
parents: 2770
diff changeset
10 It basically means search for the item field ``FIELD`` value ``VALUE`` in the namespace ``NAMESPACE`` and apply the
2293
e5d44d1b9976 Added docs for user.
Ashutosh Singla <ashu1461@gmail.com>
parents:
diff changeset
11 view ``VIEW`` on it.
e5d44d1b9976 Added docs for user.
Ashutosh Singla <ashu1461@gmail.com>
parents:
diff changeset
12
e5d44d1b9976 Added docs for user.
Ashutosh Singla <ashu1461@gmail.com>
parents:
diff changeset
13 NAMESPACE
e5d44d1b9976 Added docs for user.
Ashutosh Singla <ashu1461@gmail.com>
parents:
diff changeset
14 Defines the namespace for looking up the item. NAMESPACE value ``all`` is the "namespace doesn't matter" identifier.
e5d44d1b9976 Added docs for user.
Ashutosh Singla <ashu1461@gmail.com>
parents:
diff changeset
15 It is used to access global views like global history, global tags etc.
e5d44d1b9976 Added docs for user.
Ashutosh Singla <ashu1461@gmail.com>
parents:
diff changeset
16
e5d44d1b9976 Added docs for user.
Ashutosh Singla <ashu1461@gmail.com>
parents:
diff changeset
17 FIELD
2770
264e4015212e docs: fixes, additions, formatting
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 2293
diff changeset
18 Whoosh schema field where to lookup the VALUE (default: ``name_exact``, lookup by name).
264e4015212e docs: fixes, additions, formatting
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 2293
diff changeset
19 FIELD can be a unique identifier like (``itemid, revid, name_exact``) or can be non-unique like (``tags``).
2293
e5d44d1b9976 Added docs for user.
Ashutosh Singla <ashu1461@gmail.com>
parents:
diff changeset
20
e5d44d1b9976 Added docs for user.
Ashutosh Singla <ashu1461@gmail.com>
parents:
diff changeset
21 VALUE
2770
264e4015212e docs: fixes, additions, formatting
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 2293
diff changeset
22 Value to search in the FIELD (default: the default root within that namespace). If the FIELD is non-unique,
264e4015212e docs: fixes, additions, formatting
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 2293
diff changeset
23 we show a list of items that have ``FIELD:VALUE``.
2293
e5d44d1b9976 Added docs for user.
Ashutosh Singla <ashu1461@gmail.com>
parents:
diff changeset
24
e5d44d1b9976 Added docs for user.
Ashutosh Singla <ashu1461@gmail.com>
parents:
diff changeset
25 VIEW
e5d44d1b9976 Added docs for user.
Ashutosh Singla <ashu1461@gmail.com>
parents:
diff changeset
26 used to select the intended view method (default: ``show``).
e5d44d1b9976 Added docs for user.
Ashutosh Singla <ashu1461@gmail.com>
parents:
diff changeset
27
e5d44d1b9976 Added docs for user.
Ashutosh Singla <ashu1461@gmail.com>
parents:
diff changeset
28 **Examples**:
e5d44d1b9976 Added docs for user.
Ashutosh Singla <ashu1461@gmail.com>
parents:
diff changeset
29 The following examples show how a url can look like, ``ns1, ns1/ns2`` are namespaces.
e5d44d1b9976 Added docs for user.
Ashutosh Singla <ashu1461@gmail.com>
parents:
diff changeset
30
e5d44d1b9976 Added docs for user.
Ashutosh Singla <ashu1461@gmail.com>
parents:
diff changeset
31 - ``http://localhost:8080/Home``
e5d44d1b9976 Added docs for user.
Ashutosh Singla <ashu1461@gmail.com>
parents:
diff changeset
32 - ``http://localhost:8080/ns1/@tags/sometag``
e5d44d1b9976 Added docs for user.
Ashutosh Singla <ashu1461@gmail.com>
parents:
diff changeset
33 - ``http://localhost:8080/ns1/ns2``
e5d44d1b9976 Added docs for user.
Ashutosh Singla <ashu1461@gmail.com>
parents:
diff changeset
34 - ``http://localhost:8080/ns1/SomePage``
e5d44d1b9976 Added docs for user.
Ashutosh Singla <ashu1461@gmail.com>
parents:
diff changeset
35 - ``http://localhost:8080/+modify/ns1/ns2/SomePage``
e5d44d1b9976 Added docs for user.
Ashutosh Singla <ashu1461@gmail.com>
parents:
diff changeset
36 - ``http://localhost:8080/+delete/ns1/@itemid/37b73d2a6c154bb4ab993d0fb463219c``
e5d44d1b9976 Added docs for user.
Ashutosh Singla <ashu1461@gmail.com>
parents:
diff changeset
37 - ``http://localhost:8080/ns1/@itemid/37b73d2a6c154bb4ab993d0fb463219c``