1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196
|
====================
Short introduction
====================
Lines
=====
The ``-`` and ``|`` are normally used for lines. ``_`` and ``~`` can also be
used. They are slightly longer lines than the ``-``. ``_`` is drawn a bit
lower and ``~`` a bit upper. ``=`` gives a thicker line. The later three line
types can only be drawn horizontally.
::
---- | ___ ~~~|
| -- ___| | ===
~~~
.. aafig::
---- | ___ ~~~|
| -- ___| | ===
~~~
It is also possible to draw diagonal lines. Their use is somewhat restricted
though. Not all cases work as expected.
.. aafig::
+
| - + | - + | - + / -
/ / / / / / / / / / -- |/| / +
| | | + + + - - - / / \ - \|/ |\
+ + + +-+-+ | +
| | | + + + - - - \ \ / - /|\ |/
\ \ \ \ \ \ \ \ \ \ -- |\| \ +
| - + | - + | - + \ -
+
With ``rounded`` flag:
.. aafig::
:rounded:
+
| - + | - + | - + / -
/ / / / / / / / / / -- |/| / +
| | | + + + - - - / / \ - \|/ |\
+ + + +-+-+ | +
| | | + + + - - - \ \ / - /|\ |/
\ \ \ \ \ \ \ \ \ \ -- |\| \ +
| - + | - + | - + \ -
+
And drawing longer diagonal lines with different angles looks ugly...
.. aafig::
+ |
\ /
\ /
--
.. aafig::
:rounded:
+ |
\ /
\ /
--
Arrows
======
Arrow styles are::
---> | | | | | |
---< | | | | | |
---o ^ V v o O #
---O
---#
.. aafig::
---> | | | | | |
---< | | | | | |
---o ^ V v o O #
---O
---#
Boxes
=====
Boxes are automatically draw when the edges are made with ``+``, filled
boxes are made with ``X`` (must be at least two units high or wide).
It is also possible to make rounded edges in two ways::
+-----+ XXX /--\ -- |
| | XXX | | / /
+-----+ XXX \--/ | --
.. aafig::
+-----+ XXX /--\ -- |
| | XXX | | / /
+-----+ XXX \--/ | --
Fills
=====
Upper case characters generate shapes with borders, lower case without border.
Fills must be at least two characters wide or high. (This reduces the chance
that it is detected as Fill instead of a string)
.. aafig::
A B C D E F G H I J K L M
AA BB CC DD EE FF GG HH II JJ KK LL MM
AA BB CC DD EE FF GG HH II JJ KK LL MM
aa bb cc dd ee ff gg hh ii jj kk ll mm
aa bb cc dd ee ff gg hh ii jj kk ll mm
N O P Q R S T U V W X Y Z
NN OO PP QQ RR SS TT UU VV WW XX YY ZZ
NN OO PP QQ RR SS TT UU VV WW XX YY ZZ
nn oo pp qq rr ss tt uu vv ww xx yy zz
nn oo pp qq rr ss tt uu vv ww xx yy zz
Complex shapes can be filled:
.. aafig::
CCCCC C dededede
C CCCC CC dededede
CC CCCCC dededede
Text
====
The images may contain text too. There are different styles to enter text:
direct
------
By default are repeated characters detected as fill::
Hello World dd d
d
.. aafig::
Hello World dd d
d
quoted
------
Text between quotes has priority over any graphical meaning::
"Hello World" dd d
d
.. aafig::
"Hello World" dd d
d
``"``, ``'`` and ``\``` are all valid quotation marks. The quotes are not
visible in the resulting image. This not only disables fills (see below), it
also treats ``-``, ``|`` etc. as text.
textual option
--------------
The ``:textual:`` option disables horizontal fill detection. Fills are only
detected when they are vertically at least 2 characters high::
Hello World dd d
d
.. aafig::
:textual:
Hello World dd d
d
Other
=====
::
* { }
.. aafig::
* { }
|