diff options
| author | goodger <goodger@929543f6-e4f2-0310-98a6-ba3bd3dd1d04> | 2006-04-23 04:21:06 +0000 |
|---|---|---|
| committer | goodger <goodger@929543f6-e4f2-0310-98a6-ba3bd3dd1d04> | 2006-04-23 04:21:06 +0000 |
| commit | f668e86ae71437a2b429c7b07089cb7abb0cfde4 (patch) | |
| tree | 9de40aeaf58fe54f69e63bf47a64ac47f9782e25 | |
| parent | 9e9f509c3bf0e42cff0751baa6fd3b4bd7966dbd (diff) | |
| download | docutils-f668e86ae71437a2b429c7b07089cb7abb0cfde4.tar.gz | |
fixed line wrapping & whitespace; added Emacs stanza
git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@4512 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
| -rw-r--r-- | docutils/FAQ.txt | 99 |
1 files changed, 60 insertions, 39 deletions
diff --git a/docutils/FAQ.txt b/docutils/FAQ.txt index 4a0f1a9d9..2753e3b3d 100644 --- a/docutils/FAQ.txt +++ b/docutils/FAQ.txt @@ -13,13 +13,13 @@ .. sectnum:: -This is a work in progress. If you are reading a local copy, the `master -copy`_ might be newer. This document uses are relative links; if they don't -work, please use the `master copy`_. +This is a work in progress. If you are reading a local copy, the +`master copy`_ might be newer. This document uses are relative links; +if they don't work, please use the `master copy`_. -Please feel free to ask questions and/or provide answers; send email to the -`Docutils-users`_ mailing list. Project members should feel free to edit the -source text file directly. +Please feel free to ask questions and/or provide answers; send email +to the `Docutils-users`_ mailing list. Project members should feel +free to edit the source text file directly. .. _master copy: http://docutils.sourceforge.net/FAQ.html .. _let us know: @@ -55,7 +55,8 @@ For an overview of the Docutils project implementation, see `PEP Docutils is implemented in Python_. .. _Docutils: http://docutils.sourceforge.net/ -.. _PEPs (Python Enhancement Proposals): http://www.python.org/peps/pep-0012.html +.. _PEPs (Python Enhancement Proposals): + http://www.python.org/peps/pep-0012.html .. _can be used by client code: docs/api/publisher.html .. _front-end tools: docs/user/tools.html .. _test suite: docs/dev/testing.html @@ -399,19 +400,28 @@ implied endorsement or recommendation, and in no particular order: * `Webware for Python wiki <http://wiki.webwareforpython.org/thiswiki.html>`__ + * `Ian Bicking's experimental code <http://docutils.sf.net/sandbox/ianb/wiki/Wiki.py>`__ + * `MoinMoin <http://moinmoin.wikiwikiweb.de/>`__ has some support; `here's a sample <http://moinmoin.wikiwikiweb.de/RestSample>`__ + * Zope-based `Zwiki <http://zwiki.org/>`__ -* Zope3-based Zwiki (in the Zope 3 source tree as ``zope.products.zwiki``) + +* Zope3-based Zwiki (in the Zope 3 source tree as + ``zope.products.zwiki``) + * `StikiWiki <http://mithrandr.moria.org/code/stikiwiki/>`__ -* `Trac <http://projects.edgewall.com/trac/>`__ `supports using reStructuredText - <http://projects.edgewall.com/trac/wiki/WikiRestructuredText>`__ as an - alternative to wiki markup. This includes support for `TracLinks - <http://projects.edgewall.com/trac/wiki/TracLinks>`__ from within RST - text via a custom RST reference-directive or, even easier, an interpreted text - role 'trac' + +* `Trac <http://projects.edgewall.com/trac/>`__ `supports using + reStructuredText + <http://projects.edgewall.com/trac/wiki/WikiRestructuredText>`__ as + an alternative to wiki markup. This includes support for `TracLinks + <http://projects.edgewall.com/trac/wiki/TracLinks>`__ from within + RST text via a custom RST reference-directive or, even easier, an + interpreted text role 'trac' + * `Vogontia <http://www.ososo.de/vogontia/>`__, a Wiki-like FAQ system Please `let us know`_ of any other reStructuredText Wikis. @@ -438,8 +448,8 @@ Please `let us know`_ of any other reStructuredText Blogs. How should I mark up lists? --------------------------- -Bullet_ & enumerated_ list markup is very intuitive but there are 2 points -that must be noted: +Bullet_ & enumerated_ list markup is very intuitive but there are 2 +points that must be noted: .. _bullet: docs/ref/rst/restructuredtext.html#bullet-lists .. _enumerated: docs/ref/rst/restructuredtext.html#enumerated-lists @@ -474,19 +484,20 @@ that must be noted: items of the same level, where blank lines are optional. The example above shows this. -Note that formatting of the *output* is independent of the input, decided by -the writer and the stylesheet. For instance, lists *are* indented in HTML -output by default. See `How are lists formatted in HTML?`_ for details. +Note that formatting of the *output* is independent of the input, and +is decided by the writer and the stylesheet. For instance, lists +*are* indented in HTML output by default. See `How are lists +formatted in HTML?`_ for details. Could lists be indented without generating block quotes? -------------------------------------------------------- -Some people like to write lists with indentation but don't intend a blockquote -context. There has been a lot of discussion about allowing this in -reStructuredText, but there are some issues that would need to be resolved -before it could be implemented. There is a summary of the issues and pointers -to the discussions in `the to-do list`__. +Some people like to write lists with indentation but don't intend a +blockquote context. There has been a lot of discussion about allowing +this in reStructuredText, but there are some issues that would need to +be resolved before it could be implemented. There is a summary of the +issues and pointers to the discussions in `the to-do list`__. __ docs/dev/todo.html#indented-lists @@ -928,14 +939,14 @@ without H2). How are lists formatted in HTML? -------------------------------- -If list formatting looks strange, first check that you understand `list -markup`__. +If list formatting looks strange, first check that you understand +`list markup`__. __ `How should I mark up lists?`_ -* By default, HTML browsers indent lists relative to their context. This - follows a long tradition in browsers (but isn't so established in print). - If you don't like it, you should change the stylesheet. +* By default, HTML browsers indent lists relative to their context. + This follows a long tradition in browsers (but isn't so established + in print). If you don't like it, you should change the stylesheet. This is different from how lists look in reStructuredText source. Extra indentation in the source indicates a blockquote, resulting in @@ -962,12 +973,12 @@ __ `How should I mark up lists?`_ paragraphs - In this example the nested lists are simple (and should appear compacted) - but the outer list is not. + In this example the nested lists are simple (and should appear + compacted) but the outer list is not. - If you want all lists to have equal spacing, disable the `compact_lists`_ - setting (``--no-compact-lists`` option). The precise spacing can be - controlled in the stylesheet. + If you want all lists to have equal spacing, disable the + `compact_lists`_ setting (``--no-compact-lists`` option). The + precise spacing can be controlled in the stylesheet. Note again that this is not exactly WYSIWYG: it partially resembles the rules about blank lines being optional between list items in @@ -981,11 +992,12 @@ __ `How should I mark up lists?`_ Why do enumerated lists only use numbers (no letters or roman numerals)? ------------------------------------------------------------------------ -The rendering of enumerators (the numbers or letters acting as list markers) -is completely governed by the stylesheet, so either the browser can't find the -stylesheet (try enabling the `embed_stylesheet`_ setting [``--embed-stylesheet`` -option]), or the browser can't understand it (try a recent Firefox, Mozilla, -Konqueror, Opera, Safari, or even MSIE). +The rendering of enumerators (the numbers or letters acting as list +markers) is completely governed by the stylesheet, so either the +browser can't find the stylesheet (try enabling the +`embed_stylesheet`_ setting [``--embed-stylesheet`` option]), or the +browser can't understand it (try a recent Firefox, Mozilla, Konqueror, +Opera, Safari, or even MSIE). .. _embed_stylesheet: docs/user/config.html#embed-stylesheet @@ -1148,3 +1160,12 @@ Not directly, no. It borrows bits from DocBook, HTML, and others. I and have my own biases. The Docutils document model is designed for simplicity and extensibility, and has been influenced by the needs of the reStructuredText markup. + + +.. + Local Variables: + mode: indented-text + indent-tabs-mode: nil + sentence-end-double-space: t + fill-column: 70 + End: |
