Minor documentation fixes.
[docutils.git] / sandbox / stylesheets / index.txt
blobb352a817ad9634f5da5583bdb89182d70863e736
1 =======================
2  Docutils_ Stylesheets
3 =======================
5 :Author: Lea Wiemann and others
6 :Contact: LeWiemann@gmail.com
7 :Revision: $Revision$
8 :Date: $Date$
9 :Copyright: This document has been placed in the public domain.
12 This is a list of stylesheets, which can be used to customize the look
13 of the documents created by Docutils, contributed by various users and
14 developers.
16 If you have a stylesheet to contribute, please send it to the
17 Docutils-users_ mailing list.  (If you have write-access to the
18 repository, you can also upload it to the ``sandbox/stylesheets/`` and
19 add it in the list below.)
21 .. TODO: Add previews of the stylesheets.  Either using PHP or with
22    screenshots.
25 HTML (CSS) Stylesheets
26 ======================
28 Please see "`Writing HTML (CSS) Stylesheets for Docutils`__" on how to
29 write your own CSS stylesheet for use with Docutils' HTML writer.
31 __ ../../docutils/docs/howto/html-stylesheets.html
33 * `<voidspace.css>`_: Blue boxes around section headings, more
34   borders, and somewhat more colorful than the default stylesheet.
36 * `<transition-stars.css>`_:
37   Example/Template for customising the transition_ element.
39   Replaces the horizontal line with three stars as often seen in novels.
42 * `<pygments-default.css>`_, `<pygments-long.css>`_:
43   Examples/templates for syntax highlight of code_ snippets.
46 LaTeX Style Sheets
47 ==================
49 See "`Generating LaTeX with Docutils`_" for details on usage and writing of
50 LaTeX style sheets for the Docutils' "latex2e" writer.
52 Hint: usage is simpler, if you copy (or link) the stye files into a
53 directory in the LaTeX INPUT PATH, e.g., (on a modern TeX installation)
54 ``/usr/local/share/texmf/tex/latex/`` or ``~/texmf/tex/latex/`` und run
55 ``texhash``.
57 * `<times-helvetica-courier.sty>`_ and `<palatino-helvetica-courier.sty>`_:
58   Use Standard Postscript fonts with recommended settings.
60 * `<listings-python-options.sty>`_:
61   Highlight literal blocks as python code. Use with the
62   ``--literal-block-env=lstlistings`` option.
64 * `<listings-tex-options.sty>`_:
65   Highlight literal blocks as (La)TeX code. Use with the
66   ``--literal-block-env=lstlistings`` option.
68 * `<transition-stars.sty>`_:
69   Example/Template for customising the transition_ element.
71   Replaces the horizontal line with three stars as often seen in novels.
73 * `<pygments-default.sty>`_, `<pygments-long.sty>`_:
74   Examples/templates for syntax highlight of code_ snippets.
76 Tools
77 =====
79 * `<pygments_css2sty.py>`_:
80   Convert a CSS stylesheet for syntax highlight in a HTML document
81   into one for Docutils' LaTeX output.
83 .. References
84    ==========
86 .. _Docutils: http://docutils.sourceforge.net/
87 .. _Docutils-users:
88    http://docutils.sf.net/docs/user/mailing-lists.html#docutils-users
89 .. _Generating LaTeX with Docutils:
90    ../../docutils/docs/user/latex.html
92 .. _transition: ../../docutils/docs/ref/rst/restructuredtext.html#transitions
93 .. _code: ../../docutils/docs/ref/rst/directives.html#code
98    Local Variables:
99    mode: indented-text
100    indent-tabs-mode: nil
101    sentence-end-double-space: t
102    fill-column: 70
103    End: