Minor documentation fixes.
[docutils.git] / sandbox / stylesheets / transition-stars.sty
blobed491e4c3815483d32f1a0ddd4340faa525055f9
1 % transiton-stars.sty
2 % ===================
3 % Style a Docutils transition
4 % ---------------------------
5 %
6 % :Author: Günter Milde
7 % :Revision: $Revision: 5534 $
8 % :Date: $Date: 2009-05-07$
9 % :Copyright: © 2009 Günter Milde.
10 % Released without warranties or conditions of any kind
11 % under the terms of the Apache License, Version 2.0
12 % http://www.apache.org/licenses/LICENSE-2.0
14 % LaTeX style sheet for use with Docutils::
16 \ProvidesPackage{transition-stars}
17 [2009/05/07 v0.1 starred transition element for docutils]
20 % You can use this style as a template for customising the transition
21 % element in LaTeX.
23 % Introduction
24 % ~~~~~~~~~~~~
26 % By default, the `transition element`_ is rendered as a horizontal line.
28 % In novels, often the form of three stars or some ornamental is used.
29 % A simple vertical space is also common.
31 % An article about several variants implemented in LaTeX is available at
32 % http://www.tug.org/pracjourn/2005-4/walden/ .
34 % The `memoir` class defines a ``\fancybreak`` macro, that includes some
35 % provision for page breaks and suppresses the indentation of the following
36 % paragraph. It takes one argument, the characters marking the break.
38 % The following macro is a somewhat simplified version without
39 % a starred version and with 1/2 baselineskip above and below.
40 % ::
42 \providecommand{\fancybreak}[1]{\par
43 \penalty -100
44 \vskip 0.5\baselineskip
45 \noindent\parbox{\linewidth}{\centering #1}\null
46 \penalty -20
47 %% \vskip -\onelineskip
48 \vskip 0.5\baselineskip
49 \@afterindentfalse
50 \@afterheading}
52 % Now use this definition to configure ``DUtransition``::
54 \newcommand{\DUtransition}{\fancybreak{*\quad*\quad*}}
56 % .. _transition element:
57 % http://docutils.sourceforge.net/docs/user/rst/quickref.html#transitions