[Live-demo] Sphinx documentations and directives

Frank Gasdorf fgdrf at users.sourceforge.net
Wed Jul 27 05:35:34 EDT 2011


Hello Translators,

the rst documents have both, content itself and directives to get a
expected<http://www.dict.cc/englisch-deutsch/expected.html> layout
in the resulting html files. In the past many documents were translated but
the translators didn't care about the Sphinx syntax (
http://sphinx.pocoo.org/contents.html). As described in the documentation
section of Sphinx are predefined directives available to mark content for
special handling. Fore example you can find :
.. note::
.. tip::
.. image::

:menuselection:
:guilabel:
:file:
:size:
:area:
:target:

etc

in the English documents. THESE (and all other) directives must not be
translated! If translated the resulting documents are broken (missing
sections, images, whatever)

I've found a lot in the el, es, pl and jp folders, Please review and update
the documents. To get a clue where you have to look for please read the
error log http://adhoc.osgeo.osuosl.org/livedvd/logs/nightly_build.err) and
search for Error message : Unknown directive type message The document,
where the error comes from and a line number you can find
/osgeo/livedvd/svn/doc/<lang>/<folder>/<document-name>.rst:178:
(ERROR/3) Unknown directive type "consejo".

Please be careful and if you have questions ask in the mailing list, whether
it's content or not (and therefore some format directives)

Cheers,

Frank
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.osgeo.org/pipermail/live-demo/attachments/20110727/6d82d1ec/attachment.html


More information about the Live-demo mailing list