/doc/English/chars-option.html
http://txt2tags.googlecode.com/ · HTML · 181 lines · 142 code · 37 blank · 2 comment · 0 complexity · 9cea2e4f1b0459adc25ecd89012fb2d7 MD5 · raw file
- <!doctype html><html><meta charset=UTF-8><title>The --chars option</title><pre>
- ========================================================================
- +--------------------+
- | The --chars option |
- +--------------------+
- +------------------+
- | Florent Gallaire |
- +------------------+
- +------------+
- | 04/09/2012 |
- +------------+
- ========================================================================
- +---------+
- | Targets |
- +---------+
- - All the ASCII-Art targets: aat, aap, aas and aaw. <b>12 chars
- length</b>.
- - The reStructuredText target: rst. <b>8 chars length</b>.
- ASCII-art targets
- =================
- Default values
- --------------
- +--------+--------+------+------+------+--------+--------+--------+--------+--------+-------+-------+
- | corner | border | side | bar1 | bar2 | level2 | level3 | level4 | level5 | bullet | hhead | vhead |
- +--------+--------+------+------+------+--------+--------+--------+--------+--------+-------+-------+
- | + | - | | | - | = | = | - | ^ | " | - | = | $ |
- +--------+--------+------+------+------+--------+--------+--------+--------+--------+-------+-------+
- There is two exceptions:
- - The hhead char of the tables with no border is bind to the border
- char, so its default value is <b>-</b>.
- - The bullet char default value is <b>*</b> for the aap target.
- Rendering
- ---------
- corner, border and side define box for first level titles (quotes and
- lists are also boxed by the aap target). They are used for the tables
- too, with hhead the horizontal header char and vhead the vertical header
- char:
- +------------------------------+
- | a first level title in a box |
- +------------------------------+
-
- +---+-------+-------+
- | $ A | B |
- +===+=======+=======+
- | 1 $ hhead | vhead |
- +---+-------+-------+
- | 2 $ = | $ |
- +---+-------+-------+
-
- bar1 is a thin horizontal line char:
- ------------------------------------------------------------------------
- bar2 is a large horizontal line char:
- ========================================================================
- level2, level3, level4 and level5 are underlined title chars:
- level2
- ======
-
- level3
- ------
-
- level4
- ^^^^^^
-
- level5
- """"""
- bullet is the bullet list char:
- - first item
- - other item
- - last item
- Valid chars
- -----------
- <b>The choice of the chars is completely free</b> in all the ASCII-Art targets.
- There's only one limitation, <b>in UTF-8 encoding, the CJK double width
- chars are forbidden</b>, because of their double size which make them
- useless for the job:
- 7 chars
- すすすす
- reStructuredText target
- =======================
- Default values
- --------------
- +-------+--------+--------+--------+--------+--------+------+--------+
- | title | level1 | level2 | level3 | level4 | level5 | bar1 | bullet |
- +-------+--------+--------+--------+--------+--------+------+--------+
- | # | * | = | - | ^ | " | - | - |
- +-------+--------+--------+--------+--------+--------+------+--------+
- Rendering
- ---------
- title is the underlined and overlined document title char :
- #####
- title
- #####
- level1 is the underlined and overlined first level title char :
- ******
- level1
- ******
- level2, level3, level4 and level5 are underlined title chars:
- level2
- ======
-
- level3
- ------
-
- level4
- ^^^^^^
-
- level5
- """"""
- bar1 is a horizontal line char:
- ------------------------------------------------------------------------
- bullet is the bullet list char:
- - first item
- - other item
- - last item
- Valid chars
- -----------
- Bullet list char must be chosen from the <b>* + -</b> chars.
- All the others must be chosen from the <b>! " # $ % & \ ' ( ) * + ,
- - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~</b> chars.
- The = - ` : . ' " ~ ^ _ * + # chars are recommended.
- <a href="http://creativecommons.org/licenses/by-sa/3.0"><img src="http://i.creativecommons.org/l/by-sa/3.0/88x31.png" alt="Creative Commons by-sa"></a>
- <!-- ASCII Art code generated by txt2tags 2.6.881 (http://txt2tags.org) -->
- <!-- cmdline: txt2tags -t aatw chars-option.t2t -->
- </pre></html>