changeset 2293:e5d44d1b9976

Added docs for user.
author Ashutosh Singla <ashu1461@gmail.com>
date Sun, 22 Sep 2013 21:27:05 +0530
parents 7b7e07bb6f8a
children e615e3bbe48d
files docs/admin/configure.rst docs/index.rst docs/intro/features.rst docs/user/namespaces.rst
diffstat 4 files changed, 41 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/docs/admin/configure.rst	Sun Sep 22 16:24:15 2013 +0530
+++ b/docs/admin/configure.rst	Sun Sep 22 21:27:05 2013 +0530
@@ -1375,3 +1375,6 @@
 Please note that the logging configuration has to be a separate file, so don't
 try this in your wiki configuration file!
 
+====================
+Namespaces
+====================
--- a/docs/index.rst	Sun Sep 22 16:24:15 2013 +0530
+++ b/docs/index.rst	Sun Sep 22 21:27:05 2013 +0530
@@ -24,6 +24,7 @@
    user/accounts
    user/markups
    user/search
+   user/namespaces
 
 Administrating MoinMoin
 =======================
--- a/docs/intro/features.rst	Sun Sep 22 16:24:15 2013 +0530
+++ b/docs/intro/features.rst	Sun Sep 22 21:27:05 2013 +0530
@@ -120,6 +120,7 @@
 * "What did I contribute to?" functionality
 * Sitemap
 * Macro support
+* Multiple names and Namespaces support
 
 Markup support
 --------------
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/user/namespaces.rst	Sun Sep 22 21:27:05 2013 +0530
@@ -0,0 +1,36 @@
+==========
+Namespaces
+==========
+
+URL layout
+==========
+``http://server/[NAMESPACE/][[@FIELD/]VALUE][/+VIEW]``
+
+Above defines the URL layout, where uppercase letters are variable parts defined below and [] denotes optional.
+It basically means search for the item field ``FIELD`` value ``VALUE`` in the namespace ``NAMESPACE`` and apply the 
+view ``VIEW`` on it.
+
+NAMESPACE
+ Defines the namespace for looking up the item. NAMESPACE value ``all`` is the "namespace doesn't matter" identifier.
+ It is used to access global views like global history, global tags etc.
+
+FIELD
+ Whoosh schema value where to lookup the VALUE. Default value for field is ``name_exact`` (search by name). FIELD can be a unique identifier like (``itemid, revid, name_exact``) or can be non-unique like (``tags``).
+
+VALUE
+ Value to search in the FIELD. The default value is the default root within that namespace. If the FIELD is non-unique, we
+ show a list items which can have the ``FIELD value:VALUE``.
+
+VIEW
+ used to select the intended view method (default: ``show``).
+
+**Examples**:
+ The following examples show how a url can look like, ``ns1, ns1/ns2`` are namespaces.
+
+ - ``http://localhost:8080/Home``
+ - ``http://localhost:8080/ns1/@tags/sometag``
+ - ``http://localhost:8080/ns1/ns2``
+ - ``http://localhost:8080/ns1/SomePage``
+ - ``http://localhost:8080/+modify/ns1/ns2/SomePage``
+ - ``http://localhost:8080/+delete/ns1/@itemid/37b73d2a6c154bb4ab993d0fb463219c``
+ - ``http://localhost:8080/ns1/@itemid/37b73d2a6c154bb4ab993d0fb463219c``