changeset 2770:264e4015212e

docs: fixes, additions, formatting
author Thomas Waldmann <tw AT waldmann-edv DOT de>
date Tue, 02 Sep 2014 16:22:47 +0200
parents 88c448cd1001
children 5762664a2887 389f7105b310
files docs/admin/backup.rst docs/admin/configure.rst docs/admin/install.rst docs/admin/requirements.rst docs/devel/development.rst docs/intro/features.rst docs/intro/general.rst docs/intro/glossary.rst docs/user/namespaces.rst docs/user/search.rst
diffstat 10 files changed, 32 insertions(+), 18 deletions(-) [+]
line wrap: on
line diff
--- a/docs/admin/backup.rst	Tue Sep 02 14:19:13 2014 +0200
+++ b/docs/admin/backup.rst	Tue Sep 02 16:22:47 2014 +0200
@@ -21,7 +21,8 @@
 * logging configuration, e.g. logging.conf
 * 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
+* 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 create a dump of all data stored in moinmoin (wiki items, user profiles), run the
 following command::
--- a/docs/admin/configure.rst	Tue Sep 02 14:19:13 2014 +0200
+++ b/docs/admin/configure.rst	Tue Sep 02 16:22:47 2014 +0200
@@ -984,7 +984,8 @@
                   u'AdminGroup': [u'Admin1', u'Admin2', u'John']}
         return ConfigGroups(groups)
 
-CompositeGroups can use, for the most part, any combination of backends. The following is an example of using the ConfigGroups and WikiGroups backends::
+CompositeGroups can use, for the most part, any combination of backends. The
+following is an example of using the ConfigGroups and WikiGroups backends::
 
     def groups(self):
         from MoinMoin.datastruct import ConfigGroups, WikiGroups, CompositeGroups
@@ -1016,7 +1017,8 @@
                                   u'2': 'Two'}}
         return ConfigDicts(request, dicts)
 
-The CompositeDicts backend can use any combination of backends. The following is an example of using the ConfigDicts and WikiDicts backends::
+The CompositeDicts backend can use any combination of backends. The following
+is an example of using the ConfigDicts and WikiDicts backends::
 
     def dicts(self, request):
         from MoinMoin.datastruct import ConfigDicts, WikiDicts, CompositeDicts
--- a/docs/admin/install.rst	Tue Sep 02 14:19:13 2014 +0200
+++ b/docs/admin/install.rst	Tue Sep 02 16:22:47 2014 +0200
@@ -197,9 +197,9 @@
 If you encounter some other issue not described above, try
 researching the unresolved issues at
 https://bitbucket.org/thomaswaldmann/moin-2.0/issues?status=new&status=open.
-If you find a similar issue, please
-add a note saying you also have the problem and add any new
-information that may assist in the problem resolution.
+
+If you find a similar issue, please add a note saying you also have the problem
+and add any new information that may assist in the problem resolution.
 
 If you cannot find a similar issue please create a new issue.
 Or, if you are not sure what to do, join us on IRC at #moin-dev
--- a/docs/admin/requirements.rst	Tue Sep 02 14:19:13 2014 +0200
+++ b/docs/admin/requirements.rst	Tue Sep 02 16:22:47 2014 +0200
@@ -19,8 +19,9 @@
 Python distribution.
 Many linux distributions have a package manager that may do
 the installation. Windows users (and perhaps others) may download
-setuptools from https://pypi.python.org/pypi/setuptools. Once setuptools is installed, do "`easy_install virtualenv`". Current ActiveState
-distributions include virtualenv in the installation bundle.
+setuptools from https://pypi.python.org/pypi/setuptools.
+Once setuptools is installed, do "`easy_install virtualenv`".
+Current ActiveState distributions include virtualenv in the installation bundle.
 If all else fails, try Google.
 
 Mercurial (hg) is required should you wish to contribute
@@ -31,8 +32,7 @@
 with most linux package managers or downloaded
 from http://mercurial.selenic.com/. As an alternative,
 most Windows users will prefer to install TortoiseHG
-(includes Mercurial) from
-http://tortoisehg.bitbucket.org/.
+(includes Mercurial) from http://tortoisehg.bitbucket.org/.
 
 
 Servers
@@ -52,7 +52,9 @@
 Dependencies
 ============
 
-Dependent packages will be automatically downloaded and installed during the moin2 installation process. For a list of dependencies, see setup.py.
+Dependent packages will be automatically downloaded and installed during the
+moin2 installation process. For a list of dependencies, see setup.py.
+
 
 Clients
 =======
--- a/docs/devel/development.rst	Tue Sep 02 14:19:13 2014 +0200
+++ b/docs/devel/development.rst	Tue Sep 02 16:22:47 2014 +0200
@@ -353,13 +353,19 @@
 Templates and Themes
 --------------------
 Moin uses jinja2 as its templating engine and Flask-Themes as a flask extension to
-support multiple themes. There is a ``MoinMoin/templates`` directory that contains a base set of templates designed for the Modernized theme. Other themes may override or add to the base templates with a directory named ``themes/<theme_name>/templates``. 
+support multiple themes. There is a ``MoinMoin/templates`` directory that contains
+a base set of templates designed for the Modernized theme. Other themes may
+override or add to the base templates with a directory named ``themes/<theme_name>/templates``.
 
 When rendering a template, the template is expanded within an environment of
 values it can use. In addition to this general environment, parameters can
 also be given directly to the render call.
 
-Each theme has a ``static/css`` directory. Stylesheets for the Basic theme in MoinMoin are compiled using the source ``theme.less`` file in the Basic theme's ``static/custom-less`` directory. Stylesheets for the Modernized and Foobar themes are compiled using the ``theme.styl files`` in their respective ``static/css/stylus`` directories. To compile CSS for all themes::
+Each theme has a ``static/css`` directory. Stylesheets for the Basic theme in
+MoinMoin are compiled using the source ``theme.less`` file in the Basic theme's
+``static/custom-less`` directory. Stylesheets for the Modernized and Foobar
+themes are compiled using the ``theme.styl files`` in their respective ``static/css/stylus``
+directories. To compile CSS for all themes::
 
     ./m css  # Windows: m css
 
--- a/docs/intro/features.rst	Tue Sep 02 14:19:13 2014 +0200
+++ b/docs/intro/features.rst	Tue Sep 02 16:22:47 2014 +0200
@@ -17,6 +17,7 @@
 * Any server that talks WSGI to moin:
 
   - Apache2 with mod_wsgi
+  - nginx with uwsgi
   - IIS with isapi-wsgi (not recommended - if you must use Windows, but have
     a choice concerning the web server, please use Apache2).
   - Other WSGI servers, see http://wsgi.org/
--- a/docs/intro/general.rst	Tue Sep 02 14:19:13 2014 +0200
+++ b/docs/intro/general.rst	Tue Sep 02 16:22:47 2014 +0200
@@ -73,7 +73,7 @@
 This shows some of the better-known users of MoinMoin:
 
 Web Sites
-~~~~~~~~~~~~~~
+~~~~~~~~~
 * KernelNewbies, Xen, LinuxWireless, GCC
 * Debian, Ubuntu, CentOS
 * Apache, Gnome, Wine, OpenOffice, Squid, Exim, Dovecot
--- a/docs/intro/glossary.rst	Tue Sep 02 14:19:13 2014 +0200
+++ b/docs/intro/glossary.rst	Tue Sep 02 16:22:47 2014 +0200
@@ -88,4 +88,3 @@
    werkzeug
       A WSGI library used by moin.
 
-
--- a/docs/user/namespaces.rst	Tue Sep 02 14:19:13 2014 +0200
+++ b/docs/user/namespaces.rst	Tue Sep 02 16:22:47 2014 +0200
@@ -15,11 +15,12 @@
  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``).
+ Whoosh schema field where to lookup the VALUE (default: ``name_exact``, lookup 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``.
+ Value to search in the FIELD (default: the default root within that namespace). If the FIELD is non-unique,
+ we show a list of items that have ``FIELD:VALUE``.
 
 VIEW
  used to select the intended view method (default: ``show``).
--- a/docs/user/search.rst	Tue Sep 02 14:19:13 2014 +0200
+++ b/docs/user/search.rst	Tue Sep 02 16:22:47 2014 +0200
@@ -132,6 +132,8 @@
 +-----------------------+-------------------------------------------------------+
 | ``mtime``             | document modification (submission) time, 201112312359 |
 +-----------------------+-------------------------------------------------------+
+| ``username``          | submitter user name, e.g. JoeDoe                      |
++-----------------------+-------------------------------------------------------+
 | ``address``           | submitter IP address, e.g. 127.0.0.1                  |
 +-----------------------+-------------------------------------------------------+
 | ``hostname``          | submitter DNS name, e.g. foo.example.org              |