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
data/example/output/title.html DELETED
@@ -1,120 +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>Introduction</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="index.html">Prev</a><br/>
15
- Main
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="getting_started.html">Next</a><br/>
25
- Getting Started
26
-
27
- </td></tr>
28
- </table>
29
- </div>
30
-
31
- <hr/>
32
-
33
- <div class="content">
34
- <div class="titlepage">
35
- <div>
36
- <div><h2 class="title">
37
- <a id="id36112365"></a>AsciiDoc User Guide</h2></div>
38
- <div><div class="author">
39
- <h3 class="author">
40
- <span class="firstname">Stuart</span> <span class="surname">Rackham</span>
41
- </h3>
42
- <code class="email">&lt;<a class="email" href="mailto:srackham@gmail.com">srackham@gmail.com</a>&gt;</code>
43
- </div></div>
44
- </div>
45
- <hr>
46
- </div>
47
- <p>AsciiDoc is a text document format for writing notes, documentation,
48
- articles, books, ebooks, slideshows, web pages, blogs and UNIX man
49
- pages. AsciiDoc files can be translated to many formats including
50
- HTML, PDF, EPUB, man page. AsciiDoc is highly configurable: both the
51
- AsciiDoc source file syntax and the backend output markups (which can
52
- be almost any type of SGML/XML markup) can be customized and extended
53
- by the user.</p>
54
- <div class="sidebar">
55
- <p class="title"><b>This document</b></p>
56
- <p>This is an overly large document, it probably needs to be refactored
57
- into a Tutorial, Quick Reference and Formal Reference.</p>
58
- <p>If you’re new to AsciiDoc read this section and the <a class="link" href="getting_started.html" title="Getting Started">Getting Started</a> section and take a look at the example AsciiDoc (<code class="literal">*.txt</code>)
59
- source files in the distribution <code class="literal">doc</code> directory.</p>
60
- </div>
61
- <div class="section" lang="en" xml:lang="en">
62
- <div class="titlepage"><div><div><h2 class="title" style="clear: both">
63
- <a id="_introduction"></a>Introduction</h2></div></div></div>
64
- <p>AsciiDoc is a plain text human readable/writable document format that
65
- can be translated to DocBook or HTML using the asciidoc(1) command.
66
- You can then either use asciidoc(1) generated HTML directly or run
67
- asciidoc(1) DocBook output through your favorite DocBook toolchain or
68
- use the AsciiDoc a2x(1) toolchain wrapper to produce PDF, EPUB, DVI,
69
- LaTeX, PostScript, man page, HTML and text formats.</p>
70
- <p>The AsciiDoc format is a useful presentation format in its own right:
71
- AsciiDoc markup is simple, intuitive and as such is easily proofed and
72
- edited.</p>
73
- <p>AsciiDoc is light weight: it consists of a single Python script and a
74
- bunch of configuration files. Apart from asciidoc(1) and a Python
75
- interpreter, no other programs are required to convert AsciiDoc text
76
- files to DocBook or HTML. See <a class="link" href="getting_started.html#X11" title="Example AsciiDoc Documents">Example AsciiDoc Documents</a>
77
- below.</p>
78
- <p>Text markup conventions tend to be a matter of (often strong) personal
79
- preference: if the default syntax is not to your liking you can define
80
- your own by editing the text based asciidoc(1) configuration files.
81
- You can also create configuration files to translate AsciiDoc
82
- documents to almost any SGML/XML markup.</p>
83
- <p>asciidoc(1) comes with a set of configuration files to translate
84
- AsciiDoc articles, books and man pages to HTML or DocBook backend
85
- formats.</p>
86
- <div class="sidebar">
87
- <p class="title"><b>My AsciiDoc Itch</b></p>
88
- <p>DocBook has emerged as the de facto standard Open Source documentation
89
- format. But DocBook is a complex language, the markup is difficult to
90
- read and even more difficult to write directly — I found I was
91
- spending more time typing markup tags, consulting reference manuals
92
- and fixing syntax errors, than I was writing the documentation.</p>
93
- </div>
94
- </div>
95
- </div>
96
-
97
- <hr/>
98
-
99
- <div class="nav" id="navfooter">
100
- <table width="100%">
101
- <tr><td width="33%" align="left">
102
-
103
- <a href="index.html">Prev</a><br/>
104
- Main
105
-
106
- </td><td width="33%" align="center">
107
-
108
- <a href="index.html">Home</a><br/>
109
- AsciiDoc User Guide
110
-
111
- </td><td width="33%" align="right">
112
-
113
- <a href="getting_started.html">Next</a><br/>
114
- Getting Started
115
-
116
- </td></tr>
117
- </table>
118
- </div>
119
- </body>
120
- </html>
data/example/output/titles.html DELETED
@@ -1,126 +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>Titles</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="text_formatting.html">Prev</a><br/>
15
- Text Formatting
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="block_titles.html">Next</a><br/>
25
- Block Titles
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="X17"></a>Titles</h2></div></div></div>
37
- <p>Document and section titles can be in either of two formats:</p>
38
- <div class="section" lang="en" xml:lang="en">
39
- <div class="titlepage"><div><div><h3 class="title">
40
- <a id="_two_line_titles"></a>Two line titles</h3></div></div></div>
41
- <p>A two line title consists of a title line, starting hard against the
42
- left margin, and an underline. Section underlines consist a repeated
43
- character pairs spanning the width of the preceding title (give or
44
- take up to two characters):</p>
45
- <p>The default title underlines for each of the document levels are:</p>
46
- <pre class="literallayout">Level 0 (top level): ======================
47
- Level 1: ----------------------
48
- Level 2: ~~~~~~~~~~~~~~~~~~~~~~
49
- Level 3: ^^^^^^^^^^^^^^^^^^^^^^
50
- Level 4 (bottom level): ++++++++++++++++++++++</pre>
51
- <p>Examples:</p>
52
- <pre class="literallayout">Level One Section Title
53
- -----------------------</pre>
54
- <pre class="literallayout">Level 2 Subsection Title
55
- ~~~~~~~~~~~~~~~~~~~~~~~~</pre>
56
- </div>
57
- <div class="section" lang="en" xml:lang="en">
58
- <div class="titlepage"><div><div><h3 class="title">
59
- <a id="X46"></a>One line titles</h3></div></div></div>
60
- <p>One line titles consist of a single line delimited on either side by
61
- one or more equals characters (the number of equals characters
62
- corresponds to the section level minus one). Here are some examples:</p>
63
- <pre class="literallayout">= Document Title (level 0) =
64
- == Section title (level 1) ==
65
- === Section title (level 2) ===
66
- ==== Section title (level 3) ====
67
- ===== Section title (level 4) =====</pre>
68
- <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
69
- <h3 class="title">Note</h3>
70
- <div class="itemizedlist"><ul type="disc">
71
- <li>
72
- One or more spaces must fall between the title and the delimiters.
73
- </li>
74
- <li>
75
- The trailing title delimiter is optional.
76
- </li>
77
- <li>
78
- The one-line title syntax can be changed by editing the
79
- configuration file <code class="literal">[titles]</code> section <code class="literal">sect0</code>…<code class="literal">sect4</code> entries.
80
- </li>
81
- </ul></div>
82
- </div>
83
- </div>
84
- <div class="section" lang="en" xml:lang="en">
85
- <div class="titlepage"><div><div><h3 class="title">
86
- <a id="_floating_titles"></a>Floating titles</h3></div></div></div>
87
- <p>Setting the title’s first positional attribute or <span class="emphasis"><em>style</em></span> attribute to
88
- <span class="emphasis"><em>float</em></span> generates a free-floating title. A free-floating title is
89
- rendered just like a normal section title but is not formally
90
- associated with a text body and is not part of the regular section
91
- hierarchy so the normal ordering rules do not apply. Floating titles
92
- can also be used in contexts where section titles are illegal: for
93
- example sidebar and admonition blocks. Example:</p>
94
- <pre class="literallayout">[float]
95
- The second day
96
- ~~~~~~~~~~~~~~</pre>
97
- <p>Floating titles do not appear in a document’s table of contents.</p>
98
- </div>
99
- </div>
100
-
101
- </div>
102
-
103
- <hr/>
104
-
105
- <div class="nav" id="navfooter">
106
- <table width="100%">
107
- <tr><td width="33%" align="left">
108
-
109
- <a href="text_formatting.html">Prev</a><br/>
110
- Text Formatting
111
-
112
- </td><td width="33%" align="center">
113
-
114
- <a href="index.html">Home</a><br/>
115
- AsciiDoc User Guide
116
-
117
- </td><td width="33%" align="right">
118
-
119
- <a href="block_titles.html">Next</a><br/>
120
- Block Titles
121
-
122
- </td></tr>
123
- </table>
124
- </div>
125
- </body>
126
- </html>