Mercurial > moin-2.0
changeset 2062:5006c97ab86d
docs: fix some wrong rst markup errors, typos, sphinx warnings, add markdown page
removed the "options" section from the man page, this can be better solved
by just calling moin <command> --help.
| author | Thomas Waldmann <tw AT waldmann-edv DOT de> |
|---|---|
| date | Sun, 31 Mar 2013 20:49:12 +0200 |
| parents | 02c56ec7c09f |
| children | 2e2a75ac620e |
| files | docs/admin/changes.rst docs/admin/configure.rst docs/index.rst docs/intro/general.rst docs/intro/license.rst docs/man/moin.rst docs/user/docbook.rst docs/user/markdown.rst docs/user/markups.rst |
| diffstat | 9 files changed, 21 insertions(+), 18 deletions(-) [+] |
line wrap: on
line diff
--- a/docs/admin/changes.rst Sun Mar 31 17:29:18 2013 +0200 +++ b/docs/admin/changes.rst Sun Mar 31 20:49:12 2013 +0200 @@ -1,6 +1,6 @@ :tocdepth: 2 -.. _changes:: +.. _changes: Changes in MoinMoin ===================
--- a/docs/admin/configure.rst Sun Mar 31 17:29:18 2013 +0200 +++ b/docs/admin/configure.rst Sun Mar 31 20:49:12 2013 +0200 @@ -47,7 +47,7 @@ Why use Python for configuration? --------------------------------- At first, you might wonder why we use Python code for configuration. One of the -reasons is that it is a powerful language. Moinmoin itself is developed in Python +reasons is that it is a powerful language. MoinMoin itself is developed in Python and using something else would usually mean much more work when developing new functionality. @@ -68,7 +68,7 @@ MOINCFG = Config # Flask only likes uppercase characters SOMETHING_FLASKY = 'foobar' -Let's go through this line-by-line:: +Let's go through this line-by-line: 0. this declares the encoding of the config file; make sure your editor uses the same encoding (character set), especially if you intend to use non-ASCII @@ -649,6 +649,7 @@ default is this: :: + passlib_crypt_context = dict( schemes=["sha512_crypt", ], ) @@ -791,7 +792,7 @@ * 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 "SuperMan") are left of the less specific ones. - Usually, you want this order:: + Usually, you want this order: 1) usernames 2) special groups @@ -1324,7 +1325,7 @@ Logging is very configurable and flexible due to the use of the `logging` module of the Python standard library. -The configuration file format is described there:: +The configuration file format is described there: http://www.python.org/doc/current/library/logging.html#configuring-logging
--- a/docs/index.rst Sun Mar 31 17:29:18 2013 +0200 +++ b/docs/index.rst Sun Mar 31 20:49:12 2013 +0200 @@ -13,6 +13,7 @@ intro/general intro/features + intro/license Using MoinMoin ============== @@ -21,7 +22,6 @@ :maxdepth: 2 user/accounts - user/searching user/markups user/search
--- a/docs/intro/general.rst Sun Mar 31 17:29:18 2013 +0200 +++ b/docs/intro/general.rst Sun Mar 31 20:49:12 2013 +0200 @@ -70,7 +70,7 @@ Who is using MoinMoin? ---------------------- -This shows some of the better-known users of MoinMoin:: +This shows some of the better-known users of MoinMoin: Web Sites ~~~~~~~~~~~~~~
--- a/docs/intro/license.rst Sun Mar 31 17:29:18 2013 +0200 +++ b/docs/intro/license.rst Sun Mar 31 20:49:12 2013 +0200 @@ -1,6 +1,8 @@ -:orphan: +.. _license: -.. _license: +======= +License +======= .. literalinclude:: ../../LICENSE.txt
--- a/docs/man/moin.rst Sun Mar 31 17:29:18 2013 +0200 +++ b/docs/man/moin.rst Sun Mar 31 20:49:12 2013 +0200 @@ -12,7 +12,7 @@ Description ----------- -:program:`moin` is the command line interface to miscellaneous moin-related tools. +:program:`moin` is the command line interface to miscellaneous MoinMoin Wiki related tools. If you invoke :program:`moin` without any arguments, it will start the builtin server and you'll have moin running! This is a shortcut for @@ -23,13 +23,6 @@ :program:`moin <subcommand> --help` will give help for some subcommand. -Options -------- - -.. todo:: - - Describe moin command line options. - See also --------
--- a/docs/user/docbook.rst Sun Mar 31 17:29:18 2013 +0200 +++ b/docs/user/docbook.rst Sun Mar 31 20:49:12 2013 +0200 @@ -2,3 +2,5 @@ Docbook XML Markup ================== +.. warning:: + **MOINTODO** fill this page with useful content (see other markup related pages about how it should look like)
--- a/docs/user/markdown.rst Sun Mar 31 17:29:18 2013 +0200 +++ b/docs/user/markdown.rst Sun Mar 31 20:49:12 2013 +0200 @@ -2,3 +2,5 @@ Markdown Markup =============== +.. warning:: + **MOINTODO** fill this page with useful content (see other markup related pages about how it should look like)
--- a/docs/user/markups.rst Sun Mar 31 17:29:18 2013 +0200 +++ b/docs/user/markups.rst Sun Mar 31 20:49:12 2013 +0200 @@ -10,16 +10,19 @@ rest docbook mediawiki + markdown .. _MoinWiki: http://moinmo.in/HelpOnMoinWikiSyntax .. _WikiCreole: http://www.wikicreole.org/ .. _reStructuredText: http://docutils.sourceforge.net/rst.html .. _Docbook: http://www.docbook.org/ .. _MediaWiki: http://www.mediawiki.org/wiki/Help:Formatting +.. _Markdown: http://daringfireball.net/projects/markdown/syntax In Moin2, you specify the item's markup language when you create the document. Its markup language can also be changed at any time by modifying the item's ``contenttype`` metadata. -Currently Moin2 supports `MoinWiki`_, `WikiCreole`_, `reStructuredText`_, `Docbook`_ and `MediaWiki`_ markups. +Currently Moin2 supports `MoinWiki`_, `WikiCreole`_, `reStructuredText`_, `Docbook`_, +`MediaWiki`_ and `Markdown`_ markups. **MOINTODO**: Currently the use of ``{{{#!syntax content}}}`` parsers crashes moin. This should be looked into.