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