PageRenderTime 10ms CodeModel.GetById 2ms app.highlight 3ms RepoModel.GetById 1ms app.codeStats 1ms

/doc/English/chars-option.t2t

http://txt2tags.googlecode.com/
Unknown | 154 lines | 104 code | 50 blank | 0 comment | 0 complexity | 8b72a43fe6fb3d00003fbb45d010d6c2 MD5 | raw file
  1The --chars option
  2Florent Gallaire
  3%%mtime(%m/%d/%Y)
  4
  5%!encoding: UTF-8
  6%!cc: by-sa
  7
  8= Targets =
  9
 10- All the ASCII-Art targets: aat, aap, aas and aaw. **12 chars length**.
 11- The reStructuredText target: rst. **8 chars length**.
 12
 13
 14== ASCII-art targets ==
 15
 16=== Default values ===
 17
 18|| corner | border | side | bar1 | bar2 | level2 | level3 | level4 | level5 | bullet | hhead | vhead
 19| + | - | | | - | =  | = | - | ^ | " | - | = | $
 20
 21There is two exceptions:
 22- The hhead char of the tables with no border is bind to the border char, so its default value is **-**.
 23- The bullet char default value is ***** for the aap target.
 24
 25
 26=== Rendering ===
 27
 28corner, 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:
 29
 30```
 31                +------------------------------+
 32                | a first level title in a box |
 33                +------------------------------+
 34
 35+---+-------+-------+
 36|   $   A   |   B   |
 37+===+=======+=======+
 38| 1 $ hhead | vhead |
 39+---+-------+-------+
 40| 2 $   =   |   $   |
 41+---+-------+-------+
 42
 43```
 44
 45bar1 is a thin horizontal line char:
 46
 47```
 48------------------------------------------------------------------------
 49```
 50
 51bar2 is a large horizontal line char:
 52
 53```
 54========================================================================
 55```
 56
 57level2, level3, level4 and level5 are underlined title chars:
 58
 59```
 60level2
 61======
 62
 63level3
 64------
 65
 66level4
 67^^^^^^
 68
 69level5
 70""""""
 71```
 72
 73bullet is the bullet list char:
 74
 75```
 76- first item
 77- other item
 78- last item
 79```
 80
 81=== Valid chars ===
 82
 83**The choice of the chars is completely free** in all the ASCII-Art targets.
 84There's only one limitation, **in UTF-8 encoding, the CJK double width chars are forbidden**, because of their double size which make them useless for the job:
 85
 86```
 877 chars
 88すすすす
 89```
 90
 91== reStructuredText target ==
 92
 93=== Default values ===
 94
 95|| title | level1 | level2 | level3 | level4 | level5 | bar1 | bullet
 96| # | * | = | - | ^ | " | - | -
 97
 98
 99=== Rendering ===
100
101title is the underlined and overlined document title char :
102
103```
104#####
105title
106#####
107```
108
109level1 is the underlined and overlined first level title char :
110
111```
112******
113level1
114******
115```
116
117level2, level3, level4 and level5 are underlined title chars:
118
119```
120level2
121======
122
123level3
124------
125
126level4
127^^^^^^
128
129level5
130""""""
131```
132
133bar1 is a horizontal line char:
134
135```
136------------------------------------------------------------------------
137```
138
139bullet is the bullet list char:
140
141```
142- first item
143- other item
144- last item
145```
146
147=== Valid chars ===
148
149Bullet list char must be chosen from the *** + -** chars.
150
151All the others  must be chosen from the **! " # $ % & \ ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~** chars.
152The = - ` : . ' " ~ ^ _ * + # chars are recommended.
153
154%%cc