Thomas Waldmann avatar Thomas Waldmann committed d126d94

docs: updated (in general + changes for namespace branch merge)

Comments (0)

Files changed (6)

docs/admin/backup.rst

 * your data
 * moin configuration, e.g. wikiconfig.py
 * logging configuration, e.g. logging.conf
-* moin script, e.g. moin.wsgi
+* moin deployment script, e.g. moin.wsgi
 * web server configuration, e.g. apache virtualhost config
 * optional: moin code + dependencies; you should at least know which version you ran, so you can reinstall that version when you need to restore
 
 To restore all software and configuration files to their original
 place, create an empty wiki first::
 
- moin moin -s -i  # -s = create new storage
-                  # -i = create new index
+ moin index-create -s -i  # -s = create new storage
+                          # -i = create new index
 
 To load the backup file into your empty wiki, run::
 

docs/admin/configure.rst

 * `jquery_file_upload <http://pypi.python.org/pypi/XStatic-jQuery-File-Upload>`_
   loaded in the template file of index view. It allows to upload many files at once.
 
+* `JSON-js <http://pypi.python.org/pypi/XStatic-JSON-js>`_
+  JSON encoders/decoders in JavaScript.
+
 * `ckeditor <http://pypi.python.org/pypi/XStatic-CKEditor>`_
   used in template file modify_text_html. A WYSIWYG editor similar to word processing 
   desktop editing applications.
   a Java applet loaded from template file of modify_anywikidraw. It can be used for 
   editing drawings and diagrams on items.
 
-* `jquery_multi_download <http://pypi.python.org/pypi/XStatic-multiDownload>`_
-  used in the template of index view for multiple parallel downloads.
-
 
 These packages are imported in wikiconfig by::
 
     from xstatic.main import XStatic
     mod_names = ['jquery', 'jquery_file_upload', 'ckeditor',
                  'svgweb', 'svgedit_moin', 'twikidraw_moin',
-                 'anywikidraw', 'jquery_multi_download', ]
+                 'anywikidraw', ]
     pkg = __import__('xstatic.pkg', fromlist=mod_names)
     for mod_name in mod_names:
         mod = getattr(pkg, mod_name)
 
 Setup of storage is rather complex and layered, involving:
 
-* a router middleware that dispatches parts of the namespace to the respective
-  backend
-* ACL checking middlewares that make sure nobody accesses something he/she is not
+* Routing middleware that dispatches by namespace to the respective backend
+* ACL checking middleware that makes sure nobody accesses something he/she is not
   authorized to access
 * Indexing mixin that indexes some data automatically on commit, so items can
   be selected / retrieved faster.
 ---------------------
 This is a helper function to make storage setup easier. It helps you to:
 
-* create a simple setup that uses 3 storage backends internally for these
-  parts of the namespace:
+* create a simple setup that uses 2 storage backends internally for these
+  namespaces:
 
-  - content
+  - default
   - userprofiles
-* configure ACLs protecting these parts of the namespace
-* setup a router middleware that dispatches to these parts of the namespace
+* configure ACLs protecting these namespaces
+* setup a router middleware that dispatches to these backends
 * setup a indexing mixin that maintains an index
 
 Call it as follows::
 
     from MoinMoin.storage import create_simple_mapping
 
-    namespace_mapping, acl_mapping = create_simple_mapping(
+    namespace_mapping, backend_mapping, acl_mapping = create_simple_mapping(
         uri=...,
         content_acl=dict(before=...,
                          default=...,
 The `uri` depends on the kind of storage backend and stores you want to use, 
 see below. Usually it is a URL-like string in the form of::
 
-    stores:fs:/srv/mywiki/%(nsname)s/%(kind)s
-    
+    stores:fs:/srv/mywiki/%(backend)s/%(kind)s
+
 `stores` is the name of the backend, followed by a colon, followed by a store
-specification. `fs` is the name of the store, followed by a specification
+specification. `fs` is the type of the store, followed by a specification
 that makes sense for the fs (filesystem) store, i.e. a path with placeholders.
 
-`%(nsname)s` placeholder will be replaced 'content' or 'userprofiles' for
+`%(backend)s` placeholder will be replaced by 'default' or 'userprofiles' for
 the respective backend. `%(kind)s` will be replaced by 'meta' or 'data'
 later.
 
 In this case, the mapping created will look like this:
 
 +----------------+-----------------------------+
-| Namespace part | Filesystem path for storage |
+| Namespace      | Filesystem path for storage |
 +----------------+-----------------------------+
-| /              | /srv/mywiki/content/        |
+| default        | /srv/mywiki/default/        |
 +----------------+-----------------------------+
-| /UserProfiles/ | /srv/mywiki/userprofiles/   |
+| userprofiles   | /srv/mywiki/userprofiles/   |
 +----------------+-----------------------------+
 
 `content_acl` and `user_profile_acl` are dictionaries specifying the ACLs for
 ------------------
 Features:
 
-* dispatches storage access to different backends depending on the item name
-* in POSIX terms, it is something like fstab/mount
+* dispatches storage access to different backends depending on the namespace
 * if you use create_simple_mapping, the router middleware will be set up
   automatically by moin.
 
 
    add kt store configuration example
 
+mongodb store
+-------------
+Features:
+
+* uses mongodb for storage
+
+.. todo:
+
+   add mongodb store configuration example
 
 memory store
 --------------
     log.load_config('wiki/config/logging/logfile')
 
 You have to fix that path to use a logging configuration matching your
-needs.
+needs (use an absolute path).
 
 Please note that the logging configuration has to be a separate file, so don't
 try this in your wiki configuration file!

docs/devel/development.rst

 * EmeraldTree for xml and tree processing
 * blinker for signalling
 * pygments for syntax highlighting
-* for stores: filesystem, sqlite3, sqlalchemy, kyoto cabinet/tycoon, memory
+* for stores: filesystem, sqlite3, sqlalchemy, kyoto cabinet/tycoon, mongodb, memory
 * jquery javascript lib
 * CKeditor, the GUI editor for (x)html
 * TWikiDraw, AnyWikiDraw, svgdraw drawing tools
 
 Above that, there is miscellaneous functionality in `MoinMoin.storage.middleware` for:
 
-* routing by name to some specific backend, like fstab / mount
+* routing by namespace to some specific backend
 * indexing metadata and data + comfortable and fast index-based access,
   selection and search
 * protecting items by ACLs (Access Control Lists)

docs/intro/features.rst

 * file system
 * sql database, such as sqlite3 or everything supported by SQLalchemy
 * Kyoto Tycoon / Kyoto Cabinet
+* mongodb
 * you can easily add your own backend with little code
 
 Serialization
 * MediaWiki
 * reST
 * DocBook XML
+* Markdown
 * HTML
 * plus code / text file highlighting for many formats
 

docs/user/accounts.rst

 Name
  Your username, as it will appear on the wiki and in the history pages of wiki items which you edit.
 
-Alias-Name
- The alias name can be used to override your username, so you will still log in using your username
- but your alias name will be displayed to other users and in your history page.
+Display-Name
+ The display name can be used to override your username, so you will still log in using your username
+ but your display name will be displayed to other users and in your history page.
 
 OpenID
  If you have an OpenID which you would like to associate with your account, enter it here.
 Your User Page
 --------------
 
-.. warning::
- **MOINTODO** User pages are currently broken as they have no handler for their content type. Because
- of this, they use the binary content type and cannot be viewed (they must be downloaded).
-
 You user page is a wiki space in which you may share information about yourself with other users of
 that wiki. It can be accessed by clicking the button with your username on it at the top of the
 screen, and is edited like a normal wiki item.
 "My Changes"
 ------------
 
-To view your modifications to a wiki, navigate to the URL ``/+mychanges``. This will show a list of
-modifications you have made to wiki items.
-
-.. warning::
- **MOINTODO** There is currently no button to get to +mychanges. This should be fixed.
+To view your modifications to a wiki, click on ``User`` in the navigation area, then on ``My Changes``.
+ his will show a list of modifications you have made to wiki items.
 
  **MOINTODO** +mychanges only links to the item which you edit, not the specific revision. If you edit
  and item several times, it just inserts several identical links to that item. This behaviour should be

docs/user/search.rst

 =====
 moin uses indexed search. Keep in mind that this has some special properties:
 
- * By using an index, the search is rather usually fast 
+ * By using an index, the search is usually rather fast
  * Because it is only using an index, it can only find what was put there
  * If you use wildcards or regexes, it will still use the index, but in a different, slower way
 
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.