/doc/English/chars-option.html

http://txt2tags.googlecode.com/ · 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. | The --chars option |
  5. +--------------------+
  6. +------------------+
  7. | Florent Gallaire |
  8. +------------------+
  9. +------------+
  10. | 04/09/2012 |
  11. +------------+
  12. ========================================================================
  13. +---------+
  14. | Targets |
  15. +---------+
  16. - All the ASCII-Art targets: aat, aap, aas and aaw. <b>12 chars
  17. length</b>.
  18. - The reStructuredText target: rst. <b>8 chars length</b>.
  19. ASCII-art targets
  20. =================
  21. Default values
  22. --------------
  23. +--------+--------+------+------+------+--------+--------+--------+--------+--------+-------+-------+
  24. | corner | border | side | bar1 | bar2 | level2 | level3 | level4 | level5 | bullet | hhead | vhead |
  25. +--------+--------+------+------+------+--------+--------+--------+--------+--------+-------+-------+
  26. | + | - | | | - | = | = | - | ^ | " | - | = | $ |
  27. +--------+--------+------+------+------+--------+--------+--------+--------+--------+-------+-------+
  28. There is two exceptions:
  29. - The hhead char of the tables with no border is bind to the border
  30. char, so its default value is <b>-</b>.
  31. - The bullet char default value is <b>*</b> for the aap target.
  32. Rendering
  33. ---------
  34. corner, border and side define box for first level titles (quotes and
  35. lists are also boxed by the aap target). They are used for the tables
  36. too, with hhead the horizontal header char and vhead the vertical header
  37. char:
  38. +------------------------------+
  39. | a first level title in a box |
  40. +------------------------------+
  41. +---+-------+-------+
  42. | $ A | B |
  43. +===+=======+=======+
  44. | 1 $ hhead | vhead |
  45. +---+-------+-------+
  46. | 2 $ = | $ |
  47. +---+-------+-------+
  48. bar1 is a thin horizontal line char:
  49. ------------------------------------------------------------------------
  50. bar2 is a large horizontal line char:
  51. ========================================================================
  52. level2, level3, level4 and level5 are underlined title chars:
  53. level2
  54. ======
  55. level3
  56. ------
  57. level4
  58. ^^^^^^
  59. level5
  60. """"""
  61. bullet is the bullet list char:
  62. - first item
  63. - other item
  64. - last item
  65. Valid chars
  66. -----------
  67. <b>The choice of the chars is completely free</b> in all the ASCII-Art targets.
  68. There's only one limitation, <b>in UTF-8 encoding, the CJK double width
  69. chars are forbidden</b>, because of their double size which make them
  70. useless for the job:
  71. 7 chars
  72. すすすす
  73. reStructuredText target
  74. =======================
  75. Default values
  76. --------------
  77. +-------+--------+--------+--------+--------+--------+------+--------+
  78. | title | level1 | level2 | level3 | level4 | level5 | bar1 | bullet |
  79. +-------+--------+--------+--------+--------+--------+------+--------+
  80. | # | * | = | - | ^ | " | - | - |
  81. +-------+--------+--------+--------+--------+--------+------+--------+
  82. Rendering
  83. ---------
  84. title is the underlined and overlined document title char :
  85. #####
  86. title
  87. #####
  88. level1 is the underlined and overlined first level title char :
  89. ******
  90. level1
  91. ******
  92. level2, level3, level4 and level5 are underlined title chars:
  93. level2
  94. ======
  95. level3
  96. ------
  97. level4
  98. ^^^^^^
  99. level5
  100. """"""
  101. bar1 is a horizontal line char:
  102. ------------------------------------------------------------------------
  103. bullet is the bullet list char:
  104. - first item
  105. - other item
  106. - last item
  107. Valid chars
  108. -----------
  109. Bullet list char must be chosen from the <b>* + -</b> chars.
  110. All the others must be chosen from the <b>! " # $ % &amp; \ ' ( ) * + ,
  111. - . / : ; &lt; = &gt; ? @ [ \ ] ^ _ ` { | } ~</b> chars.
  112. The = - ` : . ' " ~ ^ _ * + # chars are recommended.
  113. <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>
  114. <!-- ASCII Art code generated by txt2tags 2.6.881 (http://txt2tags.org) -->
  115. <!-- cmdline: txt2tags -t aatw chars-option.t2t -->
  116. </pre></html>