git-scribe 0.0.4 → 0.0.5

Sign up to get free protection for your applications and to get access to all the features.
Files changed (151) hide show
  1. data/.gitignore +1 -0
  2. data/Rakefile +31 -0
  3. data/SPEC.asciidoc +126 -0
  4. data/TODO.txt +29 -0
  5. data/bin/git-scribe +2 -1
  6. data/docbook-xsl/.CatalogManager.properties.example +61 -0
  7. data/docbook-xsl/.urilist +1 -0
  8. data/git-scribe.gemspec +32 -0
  9. data/lib/git-scribe.rb +21 -315
  10. data/lib/git-scribe/check.rb +60 -0
  11. data/lib/git-scribe/cli.rb +84 -0
  12. data/lib/git-scribe/generate.rb +222 -0
  13. data/lib/git-scribe/init.rb +16 -0
  14. data/lib/git-scribe/version.rb +3 -0
  15. data/template/.gitignore +1 -0
  16. data/template/.gitscribe +5 -0
  17. data/test/check_test.rb +12 -0
  18. data/test/gen_test.rb +78 -0
  19. data/test/init_test.rb +36 -0
  20. data/test/test_helper.rb +44 -0
  21. metadata +49 -161
  22. data/example/book/big.asc +0 -5604
  23. data/example/book/holmes.asc +0 -12983
  24. data/example/output/META-INF/container.xml +0 -6
  25. data/example/output/OEBPS/ar01s02.html +0 -15
  26. data/example/output/OEBPS/ar01s03.html +0 -3
  27. data/example/output/OEBPS/content.opf +0 -21
  28. data/example/output/OEBPS/index.html +0 -5
  29. data/example/output/OEBPS/toc.ncx +0 -37
  30. data/example/output/a_case_of_identity.html +0 -725
  31. data/example/output/a_example_appendix.html +0 -63
  32. data/example/output/a_migration_notes.html +0 -95
  33. data/example/output/apa.html +0 -20
  34. data/example/output/apb.html +0 -6
  35. data/example/output/apc.html +0 -24
  36. data/example/output/apd.html +0 -30
  37. data/example/output/ape.html +0 -26
  38. data/example/output/apf.html +0 -9
  39. data/example/output/apg.html +0 -42
  40. data/example/output/aph.html +0 -89
  41. data/example/output/ar01s02.html +0 -12
  42. data/example/output/ar01s03.html +0 -34
  43. data/example/output/ar01s04.html +0 -77
  44. data/example/output/ar01s05.html +0 -272
  45. data/example/output/ar01s06.html +0 -35
  46. data/example/output/ar01s07.html +0 -105
  47. data/example/output/ar01s08.html +0 -33
  48. data/example/output/ar01s09.html +0 -12
  49. data/example/output/ar01s10.html +0 -14
  50. data/example/output/ar01s11.html +0 -34
  51. data/example/output/ar01s12.html +0 -63
  52. data/example/output/ar01s13.html +0 -156
  53. data/example/output/ar01s14.html +0 -330
  54. data/example/output/ar01s15.html +0 -22
  55. data/example/output/ar01s16.html +0 -27
  56. data/example/output/ar01s17.html +0 -94
  57. data/example/output/ar01s18.html +0 -359
  58. data/example/output/ar01s19.html +0 -373
  59. data/example/output/ar01s20.html +0 -27
  60. data/example/output/ar01s21.html +0 -33
  61. data/example/output/ar01s22.html +0 -351
  62. data/example/output/ar01s23.html +0 -21
  63. data/example/output/ar01s24.html +0 -69
  64. data/example/output/ar01s25.html +0 -60
  65. data/example/output/ar01s26.html +0 -217
  66. data/example/output/ar01s27.html +0 -88
  67. data/example/output/ar01s28.html +0 -237
  68. data/example/output/ar01s29.html +0 -68
  69. data/example/output/ar01s30.html +0 -154
  70. data/example/output/ar01s31.html +0 -6
  71. data/example/output/ar01s32.html +0 -22
  72. data/example/output/ar01s33.html +0 -209
  73. data/example/output/asciidoc_backends.html +0 -190
  74. data/example/output/asciidoc_document_types.html +0 -131
  75. data/example/output/attribute_entries.html +0 -185
  76. data/example/output/attribute_lists.html +0 -157
  77. data/example/output/attribute_references.html +0 -414
  78. data/example/output/attributelist_element.html +0 -143
  79. data/example/output/b_packager_notes.html +0 -68
  80. data/example/output/bi01.html +0 -18
  81. data/example/output/big.asc +0 -5604
  82. data/example/output/block_element_definitions.html +0 -448
  83. data/example/output/block_titles.html +0 -83
  84. data/example/output/blockid_element.html +0 -80
  85. data/example/output/book.asc +0 -5604
  86. data/example/output/book.epub +0 -0
  87. data/example/output/book.fo +0 -3788
  88. data/example/output/book.html +0 -8793
  89. data/example/output/book.xml +0 -8265
  90. data/example/output/c_asciidoc_safe_mode.html +0 -105
  91. data/example/output/callouts.html +0 -214
  92. data/example/output/catalog +0 -10
  93. data/example/output/colophon.html +0 -397
  94. data/example/output/configuration_files.html +0 -672
  95. data/example/output/converting_docbook_to_other_file_formats.html +0 -324
  96. data/example/output/d_using_asciidoc_with_non-english_languages.html +0 -107
  97. data/example/output/delimited_blocks.html +0 -455
  98. data/example/output/document_attributes.html +0 -95
  99. data/example/output/document_processing.html +0 -116
  100. data/example/output/document_structure.html +0 -493
  101. data/example/output/e_vim_syntax_highlighter.html +0 -111
  102. data/example/output/example_bibliography.html +0 -82
  103. data/example/output/example_colophon.html +0 -58
  104. data/example/output/example_glossary.html +0 -73
  105. data/example/output/example_index.html +0 -108
  106. data/example/output/f_attribute_options.html +0 -129
  107. data/example/output/filters.html +0 -179
  108. data/example/output/footnotes.html +0 -103
  109. data/example/output/g_diagnostics.html +0 -148
  110. data/example/output/generating_plain_text_files.html +0 -68
  111. data/example/output/getting_started.html +0 -87
  112. data/example/output/glossary.html +0 -95
  113. data/example/output/go01.html +0 -24
  114. data/example/output/h_backend_attributes.html +0 -308
  115. data/example/output/help_commands.html +0 -96
  116. data/example/output/holmes.asc +0 -12983
  117. data/example/output/image/octocat_professor.png +0 -0
  118. data/example/output/include/hello.c +0 -10
  119. data/example/output/index.html +0 -656
  120. data/example/output/indexes.html +0 -104
  121. data/example/output/intrinsic_attributes.html +0 -165
  122. data/example/output/ix01.html +0 -3
  123. data/example/output/lists.html +0 -666
  124. data/example/output/macros.html +0 -737
  125. data/example/output/manpage_documents.html +0 -124
  126. data/example/output/master.css +0 -281
  127. data/example/output/mathematical_formulas.html +0 -125
  128. data/example/output/page.html +0 -60
  129. data/example/output/paragraphs.html +0 -192
  130. data/example/output/pr01.html +0 -3
  131. data/example/output/source_code_highlighting.html +0 -59
  132. data/example/output/stylesheets/handbookish-quirks.css +0 -0
  133. data/example/output/stylesheets/handbookish.css +0 -233
  134. data/example/output/tables.html +0 -797
  135. data/example/output/text_formatting.html +0 -273
  136. data/example/output/the_adventure_of_the_beryl_coronet.html +0 -968
  137. data/example/output/the_adventure_of_the_blue_carbuncle.html +0 -825
  138. data/example/output/the_adventure_of_the_copper_beeches.html +0 -998
  139. data/example/output/the_adventure_of_the_engineer_s_thumb.html +0 -851
  140. data/example/output/the_adventure_of_the_noble_bachelor.html +0 -861
  141. data/example/output/the_adventure_of_the_speckled_band.html +0 -1015
  142. data/example/output/the_boscombe_valley_mystery.html +0 -974
  143. data/example/output/the_first_chapter.html +0 -110
  144. data/example/output/the_five_orange_pips.html +0 -776
  145. data/example/output/the_man_with_the_twisted_lip.html +0 -946
  146. data/example/output/the_red-headed_league.html +0 -950
  147. data/example/output/the_second_chapter.html +0 -95
  148. data/example/output/the_third_chapter.html +0 -58
  149. data/example/output/tips_and_tricks.html +0 -452
  150. data/example/output/title.html +0 -120
  151. data/example/output/titles.html +0 -126
@@ -1,179 +0,0 @@
1
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2
- <html xmlns="http://www.w3.org/1999/xhtml">
3
- <head>
4
- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
5
- <link rel="stylesheet" href="master.css" type="text/css" />
6
- <title>Filters</title>
7
- </head>
8
-
9
- <body>
10
- <div class="nav" id="navheader">
11
- <table width="100%">
12
- <tr><td width="33%" align="left">
13
-
14
- <a href="block_element_definitions.html">Prev</a><br/>
15
- Block Element Definitions
16
-
17
- </td><td width="33%" align="center">
18
-
19
- <a href="index.html">Home</a><br/>
20
- <strong>AsciiDoc User Guide</strong>
21
-
22
- </td><td width="33%" align="right">
23
-
24
- <a href="converting_docbook_to_other_file_formats.html">Next</a><br/>
25
- Converting DocBook to other file formats
26
-
27
- </td></tr>
28
- </table>
29
- </div>
30
-
31
- <hr/>
32
-
33
- <div class="content">
34
- <div class="section" lang="en" xml:lang="en">
35
- <div class="titlepage"><div><div><h2 class="title" style="clear: both">
36
- <a id="X59"></a>Filters</h2></div></div></div>
37
- <p>Filters are external shell commands used to process Paragraph,
38
- DelimitedBlock and Table content and are specified in the
39
- corresponding configuration file definitions.</p>
40
- <p>There’s nothing special about the filters, they’re just standard UNIX
41
- filters: they read text from the standard input, process it, and write
42
- to the standard output.</p>
43
- <p>Attribute substitution is performed on the filter command prior to
44
- execution — attributes can be used to pass parameters from the
45
- AsciiDoc source document to the filter.</p>
46
- <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
47
- <h3 class="title">Warning</h3>
48
- <p>Filters can potentially generate unsafe output. Before
49
- installing a filter you should verify that it is from a trusted
50
- source.</p>
51
- </div>
52
- <div class="section" lang="en" xml:lang="en">
53
- <div class="titlepage"><div><div><h3 class="title">
54
- <a id="_filter_search_paths"></a>Filter Search Paths</h3></div></div></div>
55
- <p>If the filter command does not specify a directory path then
56
- asciidoc(1) searches for the command:</p>
57
- <div class="itemizedlist"><ul type="disc">
58
- <li>
59
- First it looks in the user’s <code class="literal">$HOME/.asciidoc/filters</code> directory.
60
- </li>
61
- <li>
62
- Next the global filters directory (usually <code class="literal">/etc/asciidoc/filters</code>
63
- or <code class="literal">/usr/local/etc/asciidoc</code>) directory is searched.
64
- </li>
65
- <li>
66
- Then it looks in the asciidoc(1) <code class="literal">./filters</code> directory.
67
- </li>
68
- <li>
69
- Finally it relies on the executing shell to search the environment
70
- search path (<code class="literal">$PATH</code>).
71
- </li>
72
- </ul></div>
73
- <p>Sub-directories are also included in the searches — standard practice
74
- is to install each filter in it’s own sub-directory with the same name
75
- as the filter’s style definition. For example the music filter’s style
76
- name is <span class="emphasis"><em>music</em></span> so it’s configuration and filter files are stored in
77
- the <code class="literal">filters/music</code> directory.</p>
78
- </div>
79
- <div class="section" lang="en" xml:lang="en">
80
- <div class="titlepage"><div><div><h3 class="title">
81
- <a id="_filter_configuration_files"></a>Filter Configuration Files</h3></div></div></div>
82
- <p>Filters are normally accompanied by a configuration file containing a
83
- Paragraph or DelimitedBlock definition along with corresponding markup
84
- templates.</p>
85
- <p>While it is possible to create new Paragraph or DelimitedBlock
86
- definitions the preferred way to implement a filter is to add a
87
- <a class="link" href="block_element_definitions.html#X23" title="Styles">style</a> to the existing Paragraph and ListingBlock definitions
88
- (all filters shipped with AsciiDoc use this technique). The filter is
89
- applied to the paragraph or delimited block by preceding it with an
90
- attribute list: the first positional attribute is the style name,
91
- remaining attributes are normally filter specific parameters.</p>
92
- <p>asciidoc(1) auto-loads all <code class="literal">.conf</code> files found in the filter search
93
- paths (see previous section).</p>
94
- </div>
95
- <div class="section" lang="en" xml:lang="en">
96
- <div class="titlepage"><div><div><h3 class="title">
97
- <a id="X56"></a>Code Filter</h3></div></div></div>
98
- <p>AsciiDoc comes with a toy filter for highlighting source code keywords
99
- and comments. See also the <code class="literal">./filters/code/code-filter-readme.txt</code>
100
- file.</p>
101
- <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
102
- <h3 class="title">Note</h3>
103
- <p>This filter primarily to demonstrate how to write a filter — it’s much to simplistic to be passed off as a code syntax highlighter.
104
- If you want a full featured multi-language highlighter use the
105
- <a class="link" href="filters.html#X57" title="Source Code Highlighter Filter">Source Code Highlighter Filter</a>.</p>
106
- </div>
107
- <pre class="screen">.Code filter example
108
- [code,python]
109
- ----------------------------------------------
110
- ''' A multi-line
111
- comment.'''
112
- def sub_word(mo):
113
- ''' Single line comment.'''
114
- word = mo.group('word') # Inline comment
115
- if word in keywords[language]:
116
- return quote + word + quote
117
- else:
118
- return word
119
- ----------------------------------------------</pre>
120
- <p>Outputs:</p>
121
- <p><b>Code filter example. </b>
122
- </p>
123
- <pre class="screen"><span class="emphasis"><em>''' A multi-line</em></span>
124
- <span class="emphasis"><em> comment.'''</em></span>
125
- <span class="strong"><strong>def</strong></span> sub_word(mo):
126
- <span class="emphasis"><em> ''' Single line comment.'''</em></span>
127
- word = mo.group('word') <span class="emphasis"><em># Inline comment</em></span>
128
- <span class="strong"><strong>if</strong></span> word <span class="strong"><strong>in</strong></span> keywords[language]:
129
- <span class="strong"><strong>return</strong></span> quote + word + quote
130
- <span class="strong"><strong>else</strong></span>:
131
- <span class="strong"><strong>return</strong></span> word</pre>
132
- <p>
133
- </p>
134
- </div>
135
- <div class="section" lang="en" xml:lang="en">
136
- <div class="titlepage"><div><div><h3 class="title">
137
- <a id="X57"></a>Source Code Highlighter Filter</h3></div></div></div>
138
- <p>A
139
- <a class="ulink" href="http://www.methods.co.nz/asciidoc/source-highlight-filter.html" target="_top">source code highlighter filter</a>
140
- can be found in the AsciiDoc distribution <code class="literal">./filters</code> directory.</p>
141
- </div>
142
- <div class="section" lang="en" xml:lang="en">
143
- <div class="titlepage"><div><div><h3 class="title">
144
- <a id="X58"></a>Music Filter</h3></div></div></div>
145
- <p>A <a class="ulink" href="http://www.methods.co.nz/asciidoc/music-filter.html" target="_top">music filter</a> is included in the
146
- distribution <code class="literal">./filters</code> directory. It translates music in
147
- <a class="ulink" href="http://lilypond.org/" target="_top">LilyPond</a> or <a class="ulink" href="http://abcnotation.org.uk/" target="_top">ABC</a>
148
- notation to standard Western classical notation in the form of a
149
- trimmed PNG image which is automatically inserted into the output
150
- document.</p>
151
- </div>
152
- </div>
153
-
154
- </div>
155
-
156
- <hr/>
157
-
158
- <div class="nav" id="navfooter">
159
- <table width="100%">
160
- <tr><td width="33%" align="left">
161
-
162
- <a href="block_element_definitions.html">Prev</a><br/>
163
- Block Element Definitions
164
-
165
- </td><td width="33%" align="center">
166
-
167
- <a href="index.html">Home</a><br/>
168
- AsciiDoc User Guide
169
-
170
- </td><td width="33%" align="right">
171
-
172
- <a href="converting_docbook_to_other_file_formats.html">Next</a><br/>
173
- Converting DocBook to other file formats
174
-
175
- </td></tr>
176
- </table>
177
- </div>
178
- </body>
179
- </html>
@@ -1,103 +0,0 @@
1
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2
- <html xmlns="http://www.w3.org/1999/xhtml">
3
- <head>
4
- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
5
- <link rel="stylesheet" href="master.css" type="text/css" />
6
- <title>Footnotes</title>
7
- </head>
8
-
9
- <body>
10
- <div class="nav" id="navheader">
11
- <table width="100%">
12
- <tr><td width="33%" align="left">
13
-
14
- <a href="lists.html">Prev</a><br/>
15
- Lists
16
-
17
- </td><td width="33%" align="center">
18
-
19
- <a href="index.html">Home</a><br/>
20
- <strong>AsciiDoc User Guide</strong>
21
-
22
- </td><td width="33%" align="right">
23
-
24
- <a href="indexes.html">Next</a><br/>
25
- Indexes
26
-
27
- </td></tr>
28
- </table>
29
- </div>
30
-
31
- <hr/>
32
-
33
- <div class="content">
34
- <div class="section" lang="en" xml:lang="en">
35
- <div class="titlepage"><div><div><h2 class="title" style="clear: both">
36
- <a id="X92"></a>Footnotes</h2></div></div></div>
37
- <p>The shipped AsciiDoc configuration includes three footnote inline
38
- macros:</p>
39
- <div class="variablelist"><dl>
40
- <dt><span class="term">
41
- <code class="literal">footnote:[&lt;text&gt;]</code>
42
- </span></dt>
43
- <dd>
44
- Generates a footnote with text <code class="literal">&lt;text&gt;</code>.
45
- </dd>
46
- <dt><span class="term">
47
- <code class="literal">footnoteref:[&lt;id&gt;,&lt;text&gt;]</code>
48
- </span></dt>
49
- <dd>
50
- Generates a footnote with a reference ID <code class="literal">&lt;id&gt;</code> and text <code class="literal">&lt;text&gt;</code>.
51
- </dd>
52
- <dt><span class="term">
53
- <code class="literal">footnoteref:[&lt;id&gt;]</code>
54
- </span></dt>
55
- <dd>
56
- Generates a reference to the footnote with ID <code class="literal">&lt;id&gt;</code>.
57
- </dd>
58
- </dl></div>
59
- <p>The footnote text can span multiple lines.</p>
60
- <p>The <span class="emphasis"><em>xhtml11</em></span> backend renders footnotes dynamically using JavaScript;
61
- <span class="emphasis"><em>html4</em></span> outputs do not use JavaScript and leave the footnotes inline;
62
- <span class="emphasis"><em>docbook</em></span> footnotes are processed by the downstream DocBook toolchain.</p>
63
- <p>Example footnotes:</p>
64
- <pre class="literallayout">A footnote footnote:[An example footnote.];
65
- a second footnote with a reference ID footnoteref:[note2,Second footnote.];
66
- finally a reference to the second footnote footnoteref:[note2].</pre>
67
- <p>Renders:</p>
68
- <p>A footnote <sup>[<a id="id36119067" href="#ftn.id36119067" class="footnote">2</a>]</sup>;
69
- a second footnote with a reference ID <sup>[<a id="note2" href="#ftn.note2" class="footnote">3</a>]</sup>;
70
- finally a reference to the second footnote <sup>[<a href="footnotes.html#ftn.note2" class="footnoteref">3</a>]</sup>.</p>
71
- <div class="footnotes">
72
- <br><hr width="100" align="left">
73
- <div class="footnote"><p><sup>[<a id="ftn.id36119067" href="#id36119067" class="simpara">2</a>] </sup>An example footnote.</p></div>
74
- <div class="footnote"><p><sup>[<a id="ftn.note2" href="#note2" class="simpara">3</a>] </sup>Second footnote.</p></div>
75
- </div>
76
- </div>
77
-
78
- </div>
79
-
80
- <hr/>
81
-
82
- <div class="nav" id="navfooter">
83
- <table width="100%">
84
- <tr><td width="33%" align="left">
85
-
86
- <a href="lists.html">Prev</a><br/>
87
- Lists
88
-
89
- </td><td width="33%" align="center">
90
-
91
- <a href="index.html">Home</a><br/>
92
- AsciiDoc User Guide
93
-
94
- </td><td width="33%" align="right">
95
-
96
- <a href="indexes.html">Next</a><br/>
97
- Indexes
98
-
99
- </td></tr>
100
- </table>
101
- </div>
102
- </body>
103
- </html>
@@ -1,148 +0,0 @@
1
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2
- <html xmlns="http://www.w3.org/1999/xhtml">
3
- <head>
4
- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
5
- <link rel="stylesheet" href="master.css" type="text/css" />
6
- <title>G. Diagnostics</title>
7
- </head>
8
-
9
- <body>
10
- <div class="nav" id="navheader">
11
- <table width="100%">
12
- <tr><td width="33%" align="left">
13
-
14
- <a href="f_attribute_options.html">Prev</a><br/>
15
- F. Attribute Options
16
-
17
- </td><td width="33%" align="center">
18
-
19
- <a href="index.html">Home</a><br/>
20
- <strong>AsciiDoc User Guide</strong>
21
-
22
- </td><td width="33%" align="right">
23
-
24
- <a href="h_backend_attributes.html">Next</a><br/>
25
- H. Backend Attributes
26
-
27
- </td></tr>
28
- </table>
29
- </div>
30
-
31
- <hr/>
32
-
33
- <div class="content">
34
- <div class="appendix" lang="en" xml:lang="en">
35
- <div class="titlepage"><div><div><h2 class="title">
36
- <a id="X82"></a>G. Diagnostics</h2></div></div></div>
37
- <p>The <code class="literal">asciidoc(1)</code> <code class="literal">--verbose</code> command-line option prints additional
38
- information to stderr: files processed, filters processed, warnings,
39
- system attribute evaluation.</p>
40
- <p>A special attribute named <span class="emphasis"><em>trace</em></span> controls the output of diagnostic
41
- information. If the <span class="emphasis"><em>trace</em></span> attribute is defined then
42
- element-by-element diagnostic messages detailing output markup
43
- generation are printed to stderr. The <span class="emphasis"><em>trace</em></span> attribute can be set on
44
- the command-line or from within the document using <a class="link" href="attribute_entries.html" title="Attribute Entries">Attribute Entries</a> (the latter allows tracing to be confined to specific
45
- portions of the document).</p>
46
- <div class="itemizedlist"><ul type="disc">
47
- <li>
48
- Trace messages consist of a descriptive name followed by the related
49
- markup.
50
- </li>
51
- <li>
52
- The trace message is only printed if the <span class="emphasis"><em>trace</em></span> attribute value
53
- matches the start of the trace name. The <span class="emphasis"><em>trace</em></span> attribute value can
54
- be any Python regular expression.
55
- </li>
56
- <li>
57
- A blank trace value matches all trace names and all trace messages
58
- will be printed (this can result in large amounts of output if
59
- applied to the whole document).
60
- </li>
61
- <li>
62
- <p>
63
- In the case of inline substitutions:
64
- </p>
65
- <div class="itemizedlist"><ul type="circle">
66
- <li>
67
- The text before and after the substitution are printed delineated
68
- by <code class="literal">&lt;&lt;&lt;</code> and <code class="literal">&gt;&gt;&gt;</code> delimiters.
69
- </li>
70
- <li>
71
- The message is only printed if a substitution is made.
72
- </li>
73
- <li>
74
- The <span class="emphasis"><em>subs</em></span> trace value is an alias for all inline substitutions.
75
- </li>
76
- </ul></div>
77
- </li>
78
- </ul></div>
79
- <p>Command-line examples:</p>
80
- <div class="orderedlist"><ol type="1">
81
- <li>
82
- <p>
83
- Trace the entire document.
84
- </p>
85
- <pre class="literallayout">$ asciidoc -a trace mydoc.txt</pre>
86
- </li>
87
- <li>
88
- <p>
89
- Trace messages whose names start with <code class="literal">quotes</code> or <code class="literal">macros</code>:
90
- </p>
91
- <pre class="literallayout">$ asciidoc -a 'trace=quotes|macros' mydoc.txt</pre>
92
- </li>
93
- <li>
94
- <p>
95
- Print the first line of all trace messages:
96
- </p>
97
- <pre class="literallayout">$ asciidoc -a trace mydoc.txt 2&gt;&amp;1 | grep ^TRACE:</pre>
98
- </li>
99
- </ol></div>
100
- <p>Attribute Entry examples:</p>
101
- <div class="orderedlist"><ol type="1">
102
- <li>
103
- <p>
104
- Begin printing all trace messages:
105
- </p>
106
- <pre class="literallayout">:trace:</pre>
107
- </li>
108
- <li>
109
- <p>
110
- Print only matched trace messages:
111
- </p>
112
- <pre class="literallayout">:trace: quotes|macros</pre>
113
- </li>
114
- <li>
115
- <p>
116
- Turn trace messages off:
117
- </p>
118
- <pre class="literallayout">:trace!:</pre>
119
- </li>
120
- </ol></div>
121
- </div>
122
-
123
- </div>
124
-
125
- <hr/>
126
-
127
- <div class="nav" id="navfooter">
128
- <table width="100%">
129
- <tr><td width="33%" align="left">
130
-
131
- <a href="f_attribute_options.html">Prev</a><br/>
132
- F. Attribute Options
133
-
134
- </td><td width="33%" align="center">
135
-
136
- <a href="index.html">Home</a><br/>
137
- AsciiDoc User Guide
138
-
139
- </td><td width="33%" align="right">
140
-
141
- <a href="h_backend_attributes.html">Next</a><br/>
142
- H. Backend Attributes
143
-
144
- </td></tr>
145
- </table>
146
- </div>
147
- </body>
148
- </html>
@@ -1,68 +0,0 @@
1
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2
- <html xmlns="http://www.w3.org/1999/xhtml">
3
- <head>
4
- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
5
- <link rel="stylesheet" href="master.css" type="text/css" />
6
- <title>Generating Plain Text Files</title>
7
- </head>
8
-
9
- <body>
10
- <div class="nav" id="navheader">
11
- <table width="100%">
12
- <tr><td width="33%" align="left">
13
-
14
- <a href="converting_docbook_to_other_file_formats.html">Prev</a><br/>
15
- Converting DocBook to other file formats
16
-
17
- </td><td width="33%" align="center">
18
-
19
- <a href="index.html">Home</a><br/>
20
- <strong>AsciiDoc User Guide</strong>
21
-
22
- </td><td width="33%" align="right">
23
-
24
- <a href="help_commands.html">Next</a><br/>
25
- Help Commands
26
-
27
- </td></tr>
28
- </table>
29
- </div>
30
-
31
- <hr/>
32
-
33
- <div class="content">
34
- <div class="section" lang="en" xml:lang="en">
35
- <div class="titlepage"><div><div><h2 class="title" style="clear: both">
36
- <a id="_generating_plain_text_files"></a>Generating Plain Text Files</h2></div></div></div>
37
- <p>AsciiDoc does not have a text backend (for most purposes AsciiDoc
38
- source text is fine), however you can convert AsciiDoc text files to
39
- formatted text using the AsciiDoc <a class="link" href="converting_docbook_to_other_file_formats.html#X43" title="a2x Toolchain Wrapper">a2x(1)</a> toolchain wrapper
40
- utility.</p>
41
- </div>
42
-
43
- </div>
44
-
45
- <hr/>
46
-
47
- <div class="nav" id="navfooter">
48
- <table width="100%">
49
- <tr><td width="33%" align="left">
50
-
51
- <a href="converting_docbook_to_other_file_formats.html">Prev</a><br/>
52
- Converting DocBook to other file formats
53
-
54
- </td><td width="33%" align="center">
55
-
56
- <a href="index.html">Home</a><br/>
57
- AsciiDoc User Guide
58
-
59
- </td><td width="33%" align="right">
60
-
61
- <a href="help_commands.html">Next</a><br/>
62
- Help Commands
63
-
64
- </td></tr>
65
- </table>
66
- </div>
67
- </body>
68
- </html>