Commits

Thomas Waldmann committed 4c9c332

docs: fix markup errors, remove some TODOs

  • Participants
  • Parent commits 4e236dc

Comments (0)

Files changed (9)

docs/admin/configure.rst

 Kinds of configuration files
 ============================
 To change how moinmoin behaves and looks, you may customize it by editing
-its configuration files::
+its configuration files:
 
 * Wiki Engine Configuration
 
 You can either add some normal css stylesheet or add a choice of alternate
 stylesheets.
 
-See::
+See:
 
 * `CSS media types <http://www.w3.org/TR/CSS2/media.html>`_
 * `Alternate Stylesheets <http://www.alistapart.com/articles/alternate/>`_
 
     user_use_gravatar = True
 
-Please note that using the gravatar service has some privacy issues::
+Please note that using the gravatar service has some privacy issues:
 
 * to register your image for your email at gravatar.com, you need to give them
   your email address, which is the same as you use in your wiki user profile.
 javascript library or larger js libraries) and we definitely do not want to merge 
 them into our project.
 
-For MoinMoin we require the following XStatic Packages in setup.py::
+For MoinMoin we require the following XStatic Packages in setup.py:
 
 * `jquery <http://pypi.python.org/pypi/XStatic-jQuery>`_
   for jquery lib functions loaded in the template file base.html
     from MoinMoin.auth import GivenAuth
     auth = [GivenAuth(autocreate=True, coding='utf-8')]
 
-Using this method has some pros and cons::
+Using this method has some pros and cons:
 
 * you can use lots of authentication extensions available for your web server
 * but the only information moin will get via REMOTE_USER is the authenticated
 and hard security. However, you may need different settings depending on the situation that the wiki
 admin, wiki owner or wiki community will have to deal with.
 
-So keep in mind::
+So keep in mind:
 
 * if your wiki is rather open, you might make it easy to contribute, e.g. a
   user who is not a regular user of your wiki could fix some typos he has just
    "before" -> "item acl from metadata (if specified)" -> "after";
    "before" -> "default (otherwise)"                   -> "after";
 
-How to use before/default/after::
+How to use before/default/after:
 
 * `before` is usually used to force something, for example if you want to give some
   wiki admin all permissions indiscriminately
 changes happening as a result of changes in the hierarchy, such as when you create,
 rename or delete items.
 
-Supported capabilities (rights)::
+Supported capabilities (rights):
 
 * read - read content
 * write - write (edit, modify) content
 ACLs - special groups
 ---------------------
 In addition to the groups provided by the group backend(s), there are some
-special group names available within ACLs::
+special group names available within ACLs:
 
 * All - a virtual group containing every user
 * Known - a virtual group containing every logged-in user
 An ACL is a unicode string with one or more access control entries
 which are space separated.
 
-An entry is a colon-separated set of two values::
+An entry is a colon-separated set of two values:
 
 * the left side is a comma-separated list of user and/or group names
 * the right side is a comma-separated list of rights / capabilities for those users/groups.
 destroy is not listed on the right side of the "All" entry. If moin wants to know
 whether he may write, the answer will be "yes".
 
-Notes::
+Notes:
 
 * As a consequence of the left-to-right and first-match-counts processing,
   you must order ACL entries so that the more specific ones (like for
 the prefix is '-', the answer will be "no" and it will not even proceed and
 look at the third entry.
 
-Notes::
+Notes:
 
 * you usually use these modifiers if most of the rights for a given user shall be specified
   later, but a special user or group should be treated slightly different for
 A TextCHA is a pure text alternative to ''CAPTCHAs''. MoinMoin uses it to
 prevent wiki spamming and it has proven to be very effective.
 
-Features::
+Features:
 
 * when registering a user or saving an item, it can ask a random question
 * moin matches the given answer against a regular expression
 TextCha Configuration
 ~~~~~~~~~~~~~~~~~~~~~
 
-Tips for configuration::
+Tips for configuration:
 
 * have 1 word / 1 number answers
 * ask questions that normal users of your site are likely to be able to answer
 
 Secrets
 =======
-Moin uses secrets to encrypt or cryptographically sign something like::
+Moin uses secrets to encrypt or cryptographically sign something like:
 
 * textchas
 * tickets
 =======
 MoinMoin supports storage backends as different ways of storing wiki items.
 
-Setup of storage is rather complex and layered, involving::
+Setup of storage is rather complex and layered, involving:
 
 * a router middleware that dispatches parts of the namespace to the respective
   backend
 
 create_simple_mapping
 ---------------------
-This is a helper function to make storage setup easier. It helps you to::
+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:
 the respective backend. `%(kind)s` will be replaced by 'meta' or 'data'
 later.
 
-In this case, the mapping created will look like this::
+In this case, the mapping created will look like this:
 
 +----------------+-----------------------------+
 | Namespace part | Filesystem path for storage |
 
 protecting middleware
 ---------------------
-Features::
+Features:
 
 * protects access to lower storage layers by ACLs (Access Control Lists)
 * makes sure there won't be ACL security issues, even if upper layers have bugs
 
 routing middleware
 ------------------
-Features::
+Features:
 
 * dispatches storage access to different backends depending on the item name
 * in POSIX terms, it is something like fstab/mount
 
 indexing middleware
 -------------------
-Features::
+Features:
 
 * maintains an index for important metadata values
 * speeds up looking up / selecting items
 
 fs store
 --------
-Features::
+Features:
 
 * stores into the filesystem
 * store metadata and data into separate files/directories
 
 sqla store
 ----------
-Features::
+Features:
 
 * stores data into an (SQL) database / table
 * can either use 1 database per store or 1 table per store and you need to
   give different table names then
 * uses slqalchemy (without the ORM) for database abstraction
-* supports multiple types of databases, for example::
+* supports multiple types of databases, for example:
  
   - sqlite (default, comes built-into Python)
   - postgresql
 
 sqlite store
 ------------
-Features::
+Features:
 
 * directly talks to sqlite, without using sqlalchemy
 * stores data into an sqlite database, which is a single file
 
 kc store
 --------
-Features::
+Features:
 
 * uses a Kyoto Cabinet file for storage
 * very fast
 
 kt store
 --------
-Features::
+Features:
 
 * uses a Kyoto Tycoon server for storage
 * fast
 
 memory store
 --------------
-Features::
+Features:
 
 * keeps everything in RAM
 * if your system or the moin process crashes, all data is lost, so definitely not for production use
 
 fileserver backend
 ------------------
-Features::
+Features:
 
 * exposes a part of the filesystem as read-only wiki items
 
 
 Sending E-Mail
 --------------
-Moin can optionally send E-Mail. Possible uses::
+Moin can optionally send E-Mail. Possible uses:
 
 * send out item change notifications.
 * enable users to reset forgotten passwords

docs/admin/index.rst

     index_storage = 'FileStorage', ("/path/to/moin-2.0/wiki/index", ), {}
 
 **Notes for FileStorage:**
+
 * The path MUST be absolute, writable and should be on a fast, local filesystem.
 * Moin will use `index.temp` directory as well, if you build an index at
-the `temporary location`.
+  the `temporary location`.
 
 
 moin index script reference
 Process all revisions of the wiki and add the indexable documents to the index.
 
 **Note:**
+
 * For big wikis, this can take rather long; consider using --tmp.
 * index-build does NOT clear the index at the beginning.
 * index-build does not check the current contents of the index. Therefore you must not run

docs/admin/install.rst

  # confirm the problems by running:
  pip install -e .
 
-Now install each package into your virtual env manually::
+Now install each package into your virtual env manually:
 
 * Find the required packages by looking at "install_requires" within `setup.py`.
 * Download each required package from http://pypi.python.org/

docs/devel/development.rst

 ====================
 We mainly use IRC and the wiki for communication, documentation and planning.
 
-IRC channels on chat.freenode.net::
+IRC channels on chat.freenode.net:
 
 * #moin-dev (core development topics)
 * #moin (user support, extensions)
 
-Wikis::
+Wikis:
 
 * http://moinmo.in/
 
-Documentation::
+Documentation:
 
 * http://readthedocs.org/docs/moin-20/en/latest/
 
-Issue tracker::
+Issue tracker:
 
 * http://bitbucket.org/thomaswaldmann/moin-2.0/issues
 
-Code Repositories::
+Code Repositories:
 
 * http://hg.moinmo.in/moin/2.0 - main repository
 * http://bitbucket.org/thomaswaldmann/moin-2.0 - bitbucket mirror for your
 If you are not using Mercurial, you can still submit patches.
 In that case, open an issue in the issue tracker and attach the patch there.
 
-Code review::
+Code review:
 
 Please use http://codereview.appspot.com/ for getting feedback on moin-related
 code, especially if you want to contribute or publish that code.
 
 MoinMoin architecture
 =====================
-moin2 is a WSGI application and uses::
+moin2 is a WSGI application and uses:
 
 * flask as framework
 
 
 WSGI application creation
 -------------------------
-First, the moin Flask application is created; see `MoinMoin.app.create_app`::
+First, the moin Flask application is created; see `MoinMoin.app.create_app`:
 
 * load the configuration (app.cfg)
 * register some modules that handle different parts of the functionality
 
 Request processing
 ------------------
-Let's look at how it shows a wiki item::
+Let's look at how it shows a wiki item:
 
 * the Flask app receives a GET request for /WikiItem
 * Flask's routing rules determine that this request should be served by
   `MoinMoin.apps.frontend.show_item`.
-* Flask calls the before request handler of this module, which::
+* Flask calls the before request handler of this module, which:
 
   - sets up the user as flaskg.user - an anonymous user or logged in user
   - initializes dicts/groups as flaskg.dicts, flaskg.groups
   - initializes jinja2 environment - templating
 * Flask then calls the handler function `MoinMoin.apps.frontend.show_item`,
-  which::
+  which:
 
   - creates an in-memory Item
 
 A backend is one layer above. It deals with objects that have metadata and
 data, see `MoinMoin.storage.backends`.
 
-Above that, there is miscellaneous functionality in `MoinMoin.storage.middleware` for::
+Above that, there is miscellaneous functionality in `MoinMoin.storage.middleware` for:
 
 * routing by name to some specific backend, like fstab / mount
 * indexing metadata and data + comfortable and fast index-based access,
 converter. The converter parses this input and creates an in-memory `dom tree`
 representation from it.
 
-This dom tree is then transformed through multiple dom-to-dom converters for example::
+This dom tree is then transformed through multiple dom-to-dom converters for example:
 
 * link processing
 * include processing

docs/devel/support.rst

 Free Support
 ------------
 You can get free support and information here:
+
 * on our chat channels, see http://moinmo.in/MoinMoinChat
 * on our wiki, see http://moinmo.in/ - please note that quite a lot of content
   there is about moin 1.x and does not apply to moin2. One page has a lot

docs/devel/translate.rst

 First steps with a new ``*.po`` file
 ````````````````````````````````````
 
-A newly created translation needs a few initial preparations::
+A newly created translation needs a few initial preparations:
 
 * replace "``PROJECT``" with "``MoinMoin 2``"
 

docs/intro/features.rst

 
   - global, using a mapping, so you can apply ACLs on parts of the namespace
   - local, per wiki item
-  - give rights, such as::
+  - give rights, such as:
 
     + create, destroy
     + read, write, rename

docs/user/accounts.rst

 OpenID
  If you have an OpenID which you would like to associate with your account, enter it here.
 
-.. warning::
- **MOINTODO** Leaving the OpenID field blank gives a warning saying "This OpenID is already in use"
-
 Timezone
  Setting this value will allow you to see edit times as they would appear in your time zone. For
  example, an edit time of 10AM UTC would appear as 8PM AEST if you changed your time zone to 
 Logging out
 ===========
 
-.. warning::
- **MOINTODO** Currently logging out just removes the user's session cookie. These cookies remain
- valid after logging out (and even after a password change), and could be used to impersonate a
- user. See BitBucket issue #94.
-
 Logging out of your account can prevent account hijacking on untrusted or insecure computers, and is
 considered best practice for security. To log out, click the :guilabel:`Logout` button at the top
 of the page. You will be redirected to a page confirming that you have logged out successfully.

docs/user/search.rst

  * 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
 
-For example::
+For example:
 
  * "foobar" is put into the index somehow
  * you search for "ooba" - you will not find it, because only "foobar" was put into the index