/doc/English/chars-option.t2t

http://txt2tags.googlecode.com/ · Unknown · 154 lines · 104 code · 50 blank · 0 comment · 0 complexity · 8b72a43fe6fb3d00003fbb45d010d6c2 MD5 · raw file

  1. The --chars option
  2. Florent Gallaire
  3. %%mtime(%m/%d/%Y)
  4. %!encoding: UTF-8
  5. %!cc: by-sa
  6. = Targets =
  7. - All the ASCII-Art targets: aat, aap, aas and aaw. **12 chars length**.
  8. - The reStructuredText target: rst. **8 chars length**.
  9. == ASCII-art targets ==
  10. === Default values ===
  11. || corner | border | side | bar1 | bar2 | level2 | level3 | level4 | level5 | bullet | hhead | vhead
  12. | + | - | | | - | = | = | - | ^ | " | - | = | $
  13. There is two exceptions:
  14. - The hhead char of the tables with no border is bind to the border char, so its default value is **-**.
  15. - The bullet char default value is ***** for the aap target.
  16. === Rendering ===
  17. 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:
  18. ```
  19. +------------------------------+
  20. | a first level title in a box |
  21. +------------------------------+
  22. +---+-------+-------+
  23. | $ A | B |
  24. +===+=======+=======+
  25. | 1 $ hhead | vhead |
  26. +---+-------+-------+
  27. | 2 $ = | $ |
  28. +---+-------+-------+
  29. ```
  30. bar1 is a thin horizontal line char:
  31. ```
  32. ------------------------------------------------------------------------
  33. ```
  34. bar2 is a large horizontal line char:
  35. ```
  36. ========================================================================
  37. ```
  38. level2, level3, level4 and level5 are underlined title chars:
  39. ```
  40. level2
  41. ======
  42. level3
  43. ------
  44. level4
  45. ^^^^^^
  46. level5
  47. """"""
  48. ```
  49. bullet is the bullet list char:
  50. ```
  51. - first item
  52. - other item
  53. - last item
  54. ```
  55. === Valid chars ===
  56. **The choice of the chars is completely free** in all the ASCII-Art targets.
  57. There'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:
  58. ```
  59. 7 chars
  60. すすすす
  61. ```
  62. == reStructuredText target ==
  63. === Default values ===
  64. || title | level1 | level2 | level3 | level4 | level5 | bar1 | bullet
  65. | # | * | = | - | ^ | " | - | -
  66. === Rendering ===
  67. title is the underlined and overlined document title char :
  68. ```
  69. #####
  70. title
  71. #####
  72. ```
  73. level1 is the underlined and overlined first level title char :
  74. ```
  75. ******
  76. level1
  77. ******
  78. ```
  79. level2, level3, level4 and level5 are underlined title chars:
  80. ```
  81. level2
  82. ======
  83. level3
  84. ------
  85. level4
  86. ^^^^^^
  87. level5
  88. """"""
  89. ```
  90. bar1 is a horizontal line char:
  91. ```
  92. ------------------------------------------------------------------------
  93. ```
  94. bullet is the bullet list char:
  95. ```
  96. - first item
  97. - other item
  98. - last item
  99. ```
  100. === Valid chars ===
  101. Bullet list char must be chosen from the *** + -** chars.
  102. All the others must be chosen from the **! " # $ % & \ ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~** chars.
  103. The = - ` : . ' " ~ ^ _ * + # chars are recommended.
  104. %%cc