org-ruby 0.5.3 → 0.6.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (97) hide show
  1. data/History.txt +12 -0
  2. data/Rakefile +3 -5
  3. data/announcement.txt +24 -0
  4. data/doc/History_txt.html +272 -0
  5. data/doc/OrgRuby.html +149 -0
  6. data/doc/Orgmode.html +960 -0
  7. data/doc/Orgmode/Headline.html +522 -0
  8. data/doc/Orgmode/HtmlOutputBuffer.html +480 -0
  9. data/doc/Orgmode/Line.html +1251 -0
  10. data/doc/Orgmode/OutputBuffer.html +810 -0
  11. data/doc/Orgmode/Parser.html +852 -0
  12. data/doc/Orgmode/RegexpHelper.html +639 -0
  13. data/doc/Orgmode/TextileOutputBuffer.html +456 -0
  14. data/doc/README_rdoc.html +178 -0
  15. data/doc/announcement_txt.html +142 -0
  16. data/doc/bin/org-ruby.html +54 -0
  17. data/doc/created.rid +15 -0
  18. data/doc/images/brick.png +0 -0
  19. data/doc/images/brick_link.png +0 -0
  20. data/doc/images/bug.png +0 -0
  21. data/doc/images/bullet_black.png +0 -0
  22. data/doc/images/bullet_toggle_minus.png +0 -0
  23. data/doc/images/bullet_toggle_plus.png +0 -0
  24. data/doc/images/date.png +0 -0
  25. data/doc/images/find.png +0 -0
  26. data/doc/images/loadingAnimation.gif +0 -0
  27. data/doc/images/macFFBgHack.png +0 -0
  28. data/doc/images/package.png +0 -0
  29. data/doc/images/page_green.png +0 -0
  30. data/doc/images/page_white_text.png +0 -0
  31. data/doc/images/page_white_width.png +0 -0
  32. data/doc/images/plugin.png +0 -0
  33. data/doc/images/ruby.png +0 -0
  34. data/doc/images/tag_green.png +0 -0
  35. data/doc/images/wrench.png +0 -0
  36. data/doc/images/wrench_orange.png +0 -0
  37. data/doc/images/zoom.png +0 -0
  38. data/doc/index.html +306 -0
  39. data/doc/js/darkfish.js +116 -0
  40. data/doc/js/jquery.js +32 -0
  41. data/doc/js/quicksearch.js +114 -0
  42. data/doc/js/thickbox-compressed.js +10 -0
  43. data/doc/lib/org-ruby/headline_rb.html +52 -0
  44. data/doc/lib/org-ruby/html_output_buffer_rb.html +52 -0
  45. data/doc/lib/org-ruby/html_symbol_replace_rb.html +54 -0
  46. data/doc/lib/org-ruby/line_rb.html +52 -0
  47. data/doc/lib/org-ruby/output_buffer_rb.html +54 -0
  48. data/doc/lib/org-ruby/parser_rb.html +56 -0
  49. data/doc/lib/org-ruby/regexp_helper_rb.html +54 -0
  50. data/doc/lib/org-ruby/textile_output_buffer_rb.html +54 -0
  51. data/doc/lib/org-ruby/textile_symbol_replace_rb.html +54 -0
  52. data/doc/lib/org-ruby_rb.html +52 -0
  53. data/doc/rdoc.css +763 -0
  54. data/lib/org-ruby.rb +1 -1
  55. data/lib/org-ruby/headline.rb +2 -2
  56. data/lib/org-ruby/html_output_buffer.rb +62 -5
  57. data/lib/org-ruby/html_symbol_replace.rb +345 -0
  58. data/lib/org-ruby/line.rb +20 -9
  59. data/lib/org-ruby/output_buffer.rb +8 -1
  60. data/lib/org-ruby/parser.rb +47 -19
  61. data/lib/org-ruby/regexp_helper.rb +16 -0
  62. data/lib/org-ruby/textile_output_buffer.rb +37 -2
  63. data/lib/org-ruby/textile_symbol_replace.rb +345 -0
  64. data/org-ruby.gemspec +41 -0
  65. data/spec/headline_spec.rb +5 -0
  66. data/spec/html_examples/advanced-code.html +10 -0
  67. data/spec/html_examples/advanced-code.org +13 -0
  68. data/spec/html_examples/blockcomment.html +3 -0
  69. data/spec/html_examples/blockcomment.org +15 -0
  70. data/spec/html_examples/center.html +6 -0
  71. data/spec/html_examples/center.org +7 -0
  72. data/spec/html_examples/deflist.html +6 -0
  73. data/spec/html_examples/deflist.org +6 -0
  74. data/spec/html_examples/footnotes.html +10 -0
  75. data/spec/html_examples/footnotes.org +7 -0
  76. data/spec/html_examples/inline-formatting.html +8 -0
  77. data/spec/html_examples/inline-formatting.org +10 -0
  78. data/spec/html_examples/inline-images.html +1 -1
  79. data/spec/html_examples/lists.html +4 -0
  80. data/spec/html_examples/lists.org +11 -0
  81. data/spec/html_examples/subsupscript-nil.html +3 -0
  82. data/spec/html_examples/subsupscript-nil.org +6 -0
  83. data/spec/html_examples/subsupscript.html +3 -0
  84. data/spec/html_examples/subsupscript.org +5 -0
  85. data/spec/html_examples/tables.html +15 -0
  86. data/spec/html_examples/tables.org +24 -0
  87. data/spec/line_spec.rb +17 -13
  88. data/spec/spec_helper.rb +1 -2
  89. data/spec/textile_examples/center.org +7 -0
  90. data/spec/textile_examples/center.textile +6 -0
  91. data/spec/textile_examples/footnotes.org +7 -0
  92. data/spec/textile_examples/footnotes.textile +8 -0
  93. data/spec/textile_examples/tables.org +24 -0
  94. data/spec/textile_examples/tables.textile +17 -0
  95. data/util/gen-special-replace.el +37 -0
  96. metadata +111 -19
  97. data/.gitignore +0 -1
data/doc/README_rdoc.html ADDED
@@ -0,0 +1,178 @@
1
+ <?xml version="1.0" encoding="utf-8"?>
2
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
3
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4
+
5
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
6
+ <head>
7
+ <meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
8
+
9
+ <title>File: README.rdoc [org-ruby-0.6.0 Documentation]</title>
10
+
11
+ <link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet" />
12
+
13
+ <script src="./js/jquery.js" type="text/javascript"
14
+ charset="utf-8"></script>
15
+ <script src="./js/thickbox-compressed.js" type="text/javascript"
16
+ charset="utf-8"></script>
17
+ <script src="./js/quicksearch.js" type="text/javascript"
18
+ charset="utf-8"></script>
19
+ <script src="./js/darkfish.js" type="text/javascript"
20
+ charset="utf-8"></script>
21
+ </head>
22
+
23
+ <body class="file">
24
+ <div id="metadata">
25
+ <div id="home-metadata">
26
+ <div id="home-section" class="section">
27
+ <h3 class="section-header">
28
+ <a href="./index.html">Home</a>
29
+ <a href="./index.html#classes">Classes</a>
30
+ <a href="./index.html#methods">Methods</a>
31
+ </h3>
32
+ </div>
33
+ </div>
34
+
35
+ <div id="project-metadata">
36
+
37
+
38
+ <div id="fileindex-section" class="section project-section">
39
+ <h3 class="section-header">Files</h3>
40
+ <ul>
41
+
42
+ <li class="file"><a href="./History_txt.html">History.txt</a></li>
43
+
44
+ <li class="file"><a href="./README_rdoc.html">README.rdoc</a></li>
45
+
46
+ <li class="file"><a href="./announcement_txt.html">announcement.txt</a></li>
47
+
48
+ </ul>
49
+ </div>
50
+
51
+
52
+ <div id="classindex-section" class="section project-section">
53
+ <h3 class="section-header">Class Index
54
+ <span class="search-toggle"><img src="./images/find.png"
55
+ height="16" width="16" alt="[+]"
56
+ title="show/hide quicksearch" /></span></h3>
57
+ <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
58
+ <fieldset>
59
+ <legend>Quicksearch</legend>
60
+ <input type="text" name="quicksearch" value=""
61
+ class="quicksearch-field" />
62
+ </fieldset>
63
+ </form>
64
+
65
+ <ul class="link-list">
66
+
67
+ <li><a href="./Orgmode.html">Orgmode</a></li>
68
+
69
+ <li><a href="./Orgmode/Headline.html">Orgmode::Headline</a></li>
70
+
71
+ <li><a href="./Orgmode/HtmlOutputBuffer.html">Orgmode::HtmlOutputBuffer</a></li>
72
+
73
+ <li><a href="./Orgmode/Line.html">Orgmode::Line</a></li>
74
+
75
+ <li><a href="./Orgmode/OutputBuffer.html">Orgmode::OutputBuffer</a></li>
76
+
77
+ <li><a href="./Orgmode/Parser.html">Orgmode::Parser</a></li>
78
+
79
+ <li><a href="./Orgmode/RegexpHelper.html">Orgmode::RegexpHelper</a></li>
80
+
81
+ <li><a href="./Orgmode/TextileOutputBuffer.html">Orgmode::TextileOutputBuffer</a></li>
82
+
83
+ <li><a href="./OrgRuby.html">OrgRuby</a></li>
84
+
85
+ </ul>
86
+ <div id="no-class-search-results" style="display: none;">No matching classes.</div>
87
+ </div>
88
+
89
+
90
+ </div>
91
+ </div>
92
+
93
+ <div id="documentation">
94
+
95
+ <p>org-ruby</p>
96
+
97
+ <pre>by Brian Dewey
98
+ http://github.com/bdewey/org-ruby</pre>
99
+
100
+ <h2>DESCRIPTION:</h2>
101
+
102
+ <p>This gem contains Ruby routines for parsing org-mode files.The most
103
+ significant thing this library does today is convert org-mode files to HTML
104
+ or textile. Currently, you cannot do much to customize the conversion. The
105
+ supplied textile conversion is optimized for extracting “content” from
106
+ the orgfile as opposed to “metadata.”</p>
107
+
108
+ <h2>FEATURES/PROBLEMS:</h2>
109
+ <ul><li>
110
+ <p>Converts org-mode files to HTML or Textile</p>
111
+ </li><li>
112
+ <p>Supports tables, block quotes, and block code</p>
113
+ </li><li>
114
+ <p>Supports bold, italic, underline, strikethrough, and code inline
115
+ formatting.</p>
116
+ </li><li>
117
+ <p>Supports hyperlinks that are in double-brackets</p>
118
+ </li><li>
119
+ <p>Upcoming: Handle export options specified in the org buffer.</p>
120
+ </li></ul>
121
+
122
+ <h2>SYNOPSIS:</h2>
123
+
124
+ <p>From the command line:</p>
125
+
126
+ <pre>org-ruby sample.org</pre>
127
+
128
+ <p>…will output a HTML version of sample.org.</p>
129
+
130
+ <pre>org-ruby --translate textile sample.org</pre>
131
+
132
+ <p>…will output a textile version of sample.org.</p>
133
+
134
+ <p>From Ruby code:</p>
135
+
136
+ <pre>Orgmode::Parser.new(data)</pre>
137
+
138
+ <p>…will construct a new <tt>Parser</tt> object.</p>
139
+
140
+ <h2>INSTALL:</h2>
141
+
142
+ <p>sudo gem install org-ruby</p>
143
+
144
+ <h2>LICENSE:</h2>
145
+
146
+ <p>(The MIT License)</p>
147
+
148
+ <p>Copyright © 2009 Brian Dewey</p>
149
+
150
+ <p>Permission is hereby granted, free of charge, to any person obtaining a
151
+ copy of this software and associated documentation files (the
152
+ ‘Software’), to deal in the Software without restriction, including
153
+ without limitation the rights to use, copy, modify, merge, publish,
154
+ distribute, sublicense, and/or sell copies of the Software, and to permit
155
+ persons to whom the Software is furnished to do so, subject to the
156
+ following conditions:</p>
157
+
158
+ <p>The above copyright notice and this permission notice shall be included in
159
+ all copies or substantial portions of the Software.</p>
160
+
161
+ <p>THE SOFTWARE IS PROVIDED ‘AS IS’, WITHOUT WARRANTY OF ANY KIND, EXPRESS
162
+ OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
163
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
164
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
165
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
166
+ FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
167
+ DEALINGS IN THE SOFTWARE.</p>
168
+
169
+ </div>
170
+
171
+ <div id="validator-badges">
172
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
173
+ <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
174
+ Rdoc Generator</a> 2</small>.</p>
175
+ </div>
176
+ </body>
177
+ </html>
178
+
data/doc/announcement_txt.html ADDED
@@ -0,0 +1,142 @@
1
+ <?xml version="1.0" encoding="utf-8"?>
2
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
3
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4
+
5
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
6
+ <head>
7
+ <meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
8
+
9
+ <title>File: announcement.txt [org-ruby-0.6.0 Documentation]</title>
10
+
11
+ <link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet" />
12
+
13
+ <script src="./js/jquery.js" type="text/javascript"
14
+ charset="utf-8"></script>
15
+ <script src="./js/thickbox-compressed.js" type="text/javascript"
16
+ charset="utf-8"></script>
17
+ <script src="./js/quicksearch.js" type="text/javascript"
18
+ charset="utf-8"></script>
19
+ <script src="./js/darkfish.js" type="text/javascript"
20
+ charset="utf-8"></script>
21
+ </head>
22
+
23
+ <body class="file">
24
+ <div id="metadata">
25
+ <div id="home-metadata">
26
+ <div id="home-section" class="section">
27
+ <h3 class="section-header">
28
+ <a href="./index.html">Home</a>
29
+ <a href="./index.html#classes">Classes</a>
30
+ <a href="./index.html#methods">Methods</a>
31
+ </h3>
32
+ </div>
33
+ </div>
34
+
35
+ <div id="project-metadata">
36
+
37
+
38
+ <div id="fileindex-section" class="section project-section">
39
+ <h3 class="section-header">Files</h3>
40
+ <ul>
41
+
42
+ <li class="file"><a href="./History_txt.html">History.txt</a></li>
43
+
44
+ <li class="file"><a href="./README_rdoc.html">README.rdoc</a></li>
45
+
46
+ <li class="file"><a href="./announcement_txt.html">announcement.txt</a></li>
47
+
48
+ </ul>
49
+ </div>
50
+
51
+
52
+ <div id="classindex-section" class="section project-section">
53
+ <h3 class="section-header">Class Index
54
+ <span class="search-toggle"><img src="./images/find.png"
55
+ height="16" width="16" alt="[+]"
56
+ title="show/hide quicksearch" /></span></h3>
57
+ <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
58
+ <fieldset>
59
+ <legend>Quicksearch</legend>
60
+ <input type="text" name="quicksearch" value=""
61
+ class="quicksearch-field" />
62
+ </fieldset>
63
+ </form>
64
+
65
+ <ul class="link-list">
66
+
67
+ <li><a href="./Orgmode.html">Orgmode</a></li>
68
+
69
+ <li><a href="./Orgmode/Headline.html">Orgmode::Headline</a></li>
70
+
71
+ <li><a href="./Orgmode/HtmlOutputBuffer.html">Orgmode::HtmlOutputBuffer</a></li>
72
+
73
+ <li><a href="./Orgmode/Line.html">Orgmode::Line</a></li>
74
+
75
+ <li><a href="./Orgmode/OutputBuffer.html">Orgmode::OutputBuffer</a></li>
76
+
77
+ <li><a href="./Orgmode/Parser.html">Orgmode::Parser</a></li>
78
+
79
+ <li><a href="./Orgmode/RegexpHelper.html">Orgmode::RegexpHelper</a></li>
80
+
81
+ <li><a href="./Orgmode/TextileOutputBuffer.html">Orgmode::TextileOutputBuffer</a></li>
82
+
83
+ <li><a href="./OrgRuby.html">OrgRuby</a></li>
84
+
85
+ </ul>
86
+ <div id="no-class-search-results" style="display: none;">No matching classes.</div>
87
+ </div>
88
+
89
+
90
+ </div>
91
+ </div>
92
+
93
+ <div id="documentation">
94
+
95
+ <p>org-ruby version 0.6.0</p>
96
+
97
+ <pre>by Brian Dewey
98
+ http://github.com/bdewey/org-ruby</pre>
99
+
100
+ <h2>DESCRIPTION</h2>
101
+
102
+ <p>This gem contains Ruby routines for parsing org-mode files.The most
103
+ significant thing this library does today is convert org-mode files to HTML
104
+ or textile. Currently, you cannot do much to customize the conversion. The
105
+ supplied textile conversion is optimized for extracting “content” from
106
+ the orgfile as opposed to “metadata.”</p>
107
+
108
+ <h2>CHANGES</h2>
109
+ <ul><li>
110
+ <p>The anchor text for a link can now be an image, and will get an img tag
111
+ (thanks, punchagan)</p>
112
+ </li><li>
113
+ <p>Fixed bug in tables; only the first row is a header even if others have
114
+ divider lines (thanks, leathekd)</p>
115
+ </li><li>
116
+ <p>Fixed bug in the list regular expression; lists require a space after the
117
+ item delimiter (thanks, punchagan)</p>
118
+ </li><li>
119
+ <p>Lots from ruediger:</p>
120
+ <ul><li>
121
+ <p>subscript / superscript</p>
122
+ </li><li>
123
+ <p>definition lists</p>
124
+ </li><li>
125
+ <p>centered text</p>
126
+ </li><li>
127
+ <p>symbol replacement</p>
128
+ </li></ul>
129
+ </li><li>
130
+ <p>Minor enhancement: Displays inline images</p>
131
+ </li></ul>
132
+
133
+ </div>
134
+
135
+ <div id="validator-badges">
136
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
137
+ <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
138
+ Rdoc Generator</a> 2</small>.</p>
139
+ </div>
140
+ </body>
141
+ </html>
142
+
data/doc/bin/org-ruby.html ADDED
@@ -0,0 +1,54 @@
1
+ <?xml version="1.0" encoding="utf-8"?>
2
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
3
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4
+
5
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
6
+ <head>
7
+ <meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
8
+
9
+ <title>File: org-ruby [org-ruby-0.6.0 Documentation]</title>
10
+
11
+ <link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet" />
12
+
13
+ <script src="../js/jquery.js" type="text/javascript"
14
+ charset="utf-8"></script>
15
+ <script src="../js/thickbox-compressed.js" type="text/javascript"
16
+ charset="utf-8"></script>
17
+ <script src="../js/quicksearch.js" type="text/javascript"
18
+ charset="utf-8"></script>
19
+ <script src="../js/darkfish.js" type="text/javascript"
20
+ charset="utf-8"></script>
21
+ </head>
22
+
23
+ <body class="file file-popup">
24
+ <div id="metadata">
25
+ <dl>
26
+ <dt class="modified-date">Last Modified</dt>
27
+ <dd class="modified-date">Fri Sep 02 15:27:17 -0700 2011</dd>
28
+
29
+
30
+ <dt class="requires">Requires</dt>
31
+ <dd class="requires">
32
+ <ul>
33
+
34
+ <li>optparse</li>
35
+
36
+ </ul>
37
+ </dd>
38
+
39
+
40
+
41
+ </dl>
42
+ </div>
43
+
44
+ <div id="documentation">
45
+
46
+ <div class="description">
47
+ <h2>Description</h2>
48
+
49
+ </div>
50
+
51
+ </div>
52
+ </body>
53
+ </html>
54
+
data/doc/created.rid ADDED
@@ -0,0 +1,15 @@
1
+ Sat, 03 Sep 2011 12:03:45 -0700
2
+ lib/org-ruby/line.rb Sat, 03 Sep 2011 11:47:31 -0700
3
+ lib/org-ruby/html_symbol_replace.rb Sat, 03 Sep 2011 11:46:23 -0700
4
+ History.txt Sat, 03 Sep 2011 11:57:48 -0700
5
+ bin/org-ruby Fri, 02 Sep 2011 15:27:17 -0700
6
+ lib/org-ruby/textile_output_buffer.rb Sat, 03 Sep 2011 11:46:23 -0700
7
+ README.rdoc Fri, 02 Sep 2011 15:27:17 -0700
8
+ lib/org-ruby/textile_symbol_replace.rb Sat, 03 Sep 2011 11:46:23 -0700
9
+ lib/org-ruby/parser.rb Sat, 03 Sep 2011 11:51:42 -0700
10
+ lib/org-ruby/html_output_buffer.rb Sat, 03 Sep 2011 11:46:23 -0700
11
+ lib/org-ruby/regexp_helper.rb Sat, 03 Sep 2011 11:46:23 -0700
12
+ lib/org-ruby/output_buffer.rb Sat, 03 Sep 2011 11:46:23 -0700
13
+ lib/org-ruby.rb Sat, 03 Sep 2011 11:53:17 -0700
14
+ announcement.txt Sat, 03 Sep 2011 12:03:35 -0700
15
+ lib/org-ruby/headline.rb Sat, 03 Sep 2011 11:51:42 -0700
data/doc/images/brick.png ADDED
Binary file
data/doc/images/brick_link.png ADDED
Binary file
data/doc/images/bug.png ADDED
Binary file
data/doc/images/bullet_black.png ADDED
Binary file
data/doc/images/bullet_toggle_minus.png ADDED
Binary file
data/doc/images/bullet_toggle_plus.png ADDED
Binary file
data/doc/images/date.png ADDED
Binary file
data/doc/images/find.png ADDED
Binary file
data/doc/images/loadingAnimation.gif ADDED
Binary file
data/doc/images/macFFBgHack.png ADDED
Binary file
data/doc/images/package.png ADDED
Binary file
data/doc/images/page_green.png ADDED
Binary file
data/doc/images/page_white_text.png ADDED
Binary file
data/doc/images/page_white_width.png ADDED
Binary file
data/doc/images/plugin.png ADDED
Binary file
data/doc/images/ruby.png ADDED
Binary file
data/doc/images/tag_green.png ADDED
Binary file
data/doc/images/wrench.png ADDED
Binary file
data/doc/images/wrench_orange.png ADDED
Binary file
data/doc/images/zoom.png ADDED
Binary file
data/doc/index.html ADDED
@@ -0,0 +1,306 @@
1
+ <?xml version="1.0" encoding="UTF-8"?>
2
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
3
+ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
4
+
5
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
6
+ <head>
7
+ <meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
8
+
9
+ <title>org-ruby-0.6.0 Documentation</title>
10
+
11
+ <link type="text/css" media="screen" href="rdoc.css" rel="stylesheet" />
12
+
13
+ <script src="js/jquery.js" type="text/javascript" charset="utf-8"></script>
14
+ <script src="js/thickbox-compressed.js" type="text/javascript" charset="utf-8"></script>
15
+ <script src="js/quicksearch.js" type="text/javascript" charset="utf-8"></script>
16
+ <script src="js/darkfish.js" type="text/javascript" charset="utf-8"></script>
17
+
18
+ </head>
19
+ <body class="indexpage">
20
+
21
+
22
+ <h1>org-ruby-0.6.0 Documentation</h1>
23
+
24
+
25
+ <div id="main">
26
+
27
+ <p>org-ruby</p>
28
+
29
+ <pre>by Brian Dewey
30
+ http://github.com/bdewey/org-ruby</pre>
31
+
32
+ <h2>DESCRIPTION:</h2>
33
+
34
+ <p>This gem contains Ruby routines for parsing org-mode files.The most
35
+ significant thing this library does today is convert org-mode files to HTML
36
+ or textile. Currently, you cannot do much to customize the conversion. The
37
+ supplied textile conversion is optimized for extracting “content” from
38
+ the orgfile as opposed to “metadata.”</p>
39
+
40
+ <h2>FEATURES/PROBLEMS:</h2>
41
+ <ul><li>
42
+ <p>Converts org-mode files to HTML or Textile</p>
43
+ </li><li>
44
+ <p>Supports tables, block quotes, and block code</p>
45
+ </li><li>
46
+ <p>Supports bold, italic, underline, strikethrough, and code inline
47
+ formatting.</p>
48
+ </li><li>
49
+ <p>Supports hyperlinks that are in double-brackets</p>
50
+ </li><li>
51
+ <p>Upcoming: Handle export options specified in the org buffer.</p>
52
+ </li></ul>
53
+
54
+ <h2>SYNOPSIS:</h2>
55
+
56
+ <p>From the command line:</p>
57
+
58
+ <pre>org-ruby sample.org</pre>
59
+
60
+ <p>…will output a HTML version of sample.org.</p>
61
+
62
+ <pre>org-ruby --translate textile sample.org</pre>
63
+
64
+ <p>…will output a textile version of sample.org.</p>
65
+
66
+ <p>From Ruby code:</p>
67
+
68
+ <pre>Orgmode::Parser.new(data)</pre>
69
+
70
+ <p>…will construct a new <tt>Parser</tt> object.</p>
71
+
72
+ <h2>INSTALL:</h2>
73
+
74
+ <p>sudo gem install org-ruby</p>
75
+
76
+ <h2>LICENSE:</h2>
77
+
78
+ <p>(The MIT License)</p>
79
+
80
+ <p>Copyright © 2009 Brian Dewey</p>
81
+
82
+ <p>Permission is hereby granted, free of charge, to any person obtaining a
83
+ copy of this software and associated documentation files (the
84
+ ‘Software’), to deal in the Software without restriction, including
85
+ without limitation the rights to use, copy, modify, merge, publish,
86
+ distribute, sublicense, and/or sell copies of the Software, and to permit
87
+ persons to whom the Software is furnished to do so, subject to the
88
+ following conditions:</p>
89
+
90
+ <p>The above copyright notice and this permission notice shall be included in
91
+ all copies or substantial portions of the Software.</p>
92
+
93
+ <p>THE SOFTWARE IS PROVIDED ‘AS IS’, WITHOUT WARRANTY OF ANY KIND, EXPRESS
94
+ OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
95
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
96
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
97
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
98
+ FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
99
+ DEALINGS IN THE SOFTWARE.</p>
100
+
101
+ </div>
102
+
103
+
104
+
105
+
106
+ <h2>Files</h2>
107
+ <ul>
108
+
109
+ <li class="file"><a href="History_txt.html">History.txt</a></li>
110
+
111
+ <li class="file"><a href="README_rdoc.html">README.rdoc</a></li>
112
+
113
+ <li class="file"><a href="announcement_txt.html">announcement.txt</a></li>
114
+
115
+ </ul>
116
+
117
+
118
+ <h2 id="classes">Classes/Modules</h2>
119
+ <ul>
120
+
121
+ <li class="module"><a href="Orgmode.html">Orgmode</a></li>
122
+
123
+ <li class="class"><a href="Orgmode/Headline.html">Orgmode::Headline</a></li>
124
+
125
+ <li class="class"><a href="Orgmode/HtmlOutputBuffer.html">Orgmode::HtmlOutputBuffer</a></li>
126
+
127
+ <li class="class"><a href="Orgmode/Line.html">Orgmode::Line</a></li>
128
+
129
+ <li class="class"><a href="Orgmode/OutputBuffer.html">Orgmode::OutputBuffer</a></li>
130
+
131
+ <li class="class"><a href="Orgmode/Parser.html">Orgmode::Parser</a></li>
132
+
133
+ <li class="class"><a href="Orgmode/RegexpHelper.html">Orgmode::RegexpHelper</a></li>
134
+
135
+ <li class="class"><a href="Orgmode/TextileOutputBuffer.html">Orgmode::TextileOutputBuffer</a></li>
136
+
137
+ <li class="module"><a href="OrgRuby.html">OrgRuby</a></li>
138
+
139
+ </ul>
140
+
141
+ <h2 id="methods">Methods</h2>
142
+ <ul>
143
+
144
+ <li><a href="Orgmode/Headline.html#method-c-headline-3F">::headline? &mdash; Orgmode::Headline</a></li>
145
+
146
+ <li><a href="Orgmode/Parser.html#method-c-load">::load &mdash; Orgmode::Parser</a></li>
147
+
148
+ <li><a href="Orgmode/Line.html#method-c-new">::new &mdash; Orgmode::Line</a></li>
149
+
150
+ <li><a href="Orgmode/Parser.html#method-c-new">::new &mdash; Orgmode::Parser</a></li>
151
+
152
+ <li><a href="Orgmode/RegexpHelper.html#method-c-new">::new &mdash; Orgmode::RegexpHelper</a></li>
153
+
154
+ <li><a href="Orgmode/OutputBuffer.html#method-c-new">::new &mdash; Orgmode::OutputBuffer</a></li>
155
+
156
+ <li><a href="Orgmode/TextileOutputBuffer.html#method-c-new">::new &mdash; Orgmode::TextileOutputBuffer</a></li>
157
+
158
+ <li><a href="Orgmode/Headline.html#method-c-new">::new &mdash; Orgmode::Headline</a></li>
159
+
160
+ <li><a href="Orgmode/HtmlOutputBuffer.html#method-c-new">::new &mdash; Orgmode::HtmlOutputBuffer</a></li>
161
+
162
+ <li><a href="Orgmode.html#method-c-special_symbols_to_html">::special_symbols_to_html &mdash; Orgmode</a></li>
163
+
164
+ <li><a href="Orgmode.html#method-c-special_symbols_to_textile">::special_symbols_to_textile &mdash; Orgmode</a></li>
165
+
166
+ <li><a href="Orgmode/Line.html#method-c-to_textile">::to_textile &mdash; Orgmode::Line</a></li>
167
+
168
+ <li><a href="Orgmode/OutputBuffer.html#method-i-3C-3C">#<< &mdash; Orgmode::OutputBuffer</a></li>
169
+
170
+ <li><a href="Orgmode/Line.html#method-i-begin_block-3F">#begin_block? &mdash; Orgmode::Line</a></li>
171
+
172
+ <li><a href="Orgmode/Line.html#method-i-blank-3F">#blank? &mdash; Orgmode::Line</a></li>
173
+
174
+ <li><a href="Orgmode/Line.html#method-i-block_type">#block_type &mdash; Orgmode::Line</a></li>
175
+
176
+ <li><a href="Orgmode/OutputBuffer.html#method-i-clear_accumulation_buffer-21">#clear_accumulation_buffer! &mdash; Orgmode::OutputBuffer</a></li>
177
+
178
+ <li><a href="Orgmode/Line.html#method-i-code_block_type-3F">#code_block_type? &mdash; Orgmode::Line</a></li>
179
+
180
+ <li><a href="Orgmode/Line.html#method-i-comment-3F">#comment? &mdash; Orgmode::Line</a></li>
181
+
182
+ <li><a href="Orgmode/OutputBuffer.html#method-i-current_mode">#current_mode &mdash; Orgmode::OutputBuffer</a></li>
183
+
184
+ <li><a href="Orgmode/OutputBuffer.html#method-i-current_mode_list-3F">#current_mode_list? &mdash; Orgmode::OutputBuffer</a></li>
185
+
186
+ <li><a href="Orgmode/Parser.html#method-i-custom_keyword_regexp">#custom_keyword_regexp &mdash; Orgmode::Parser</a></li>
187
+
188
+ <li><a href="Orgmode/Line.html#method-i-definition_list-3F">#definition_list? &mdash; Orgmode::Line</a></li>
189
+
190
+ <li><a href="Orgmode/Line.html#method-i-end_block-3F">#end_block? &mdash; Orgmode::Line</a></li>
191
+
192
+ <li><a href="Orgmode/OutputBuffer.html#method-i-enter_table-3F">#enter_table? &mdash; Orgmode::OutputBuffer</a></li>
193
+
194
+ <li><a href="Orgmode/OutputBuffer.html#method-i-exit_table-3F">#exit_table? &mdash; Orgmode::OutputBuffer</a></li>
195
+
196
+ <li><a href="Orgmode/Parser.html#method-i-export_exclude_tags">#export_exclude_tags &mdash; Orgmode::Parser</a></li>
197
+
198
+ <li><a href="Orgmode/Parser.html#method-i-export_footnotes-3F">#export_footnotes? &mdash; Orgmode::Parser</a></li>
199
+
200
+ <li><a href="Orgmode/Parser.html#method-i-export_heading_number-3F">#export_heading_number? &mdash; Orgmode::Parser</a></li>
201
+
202
+ <li><a href="Orgmode/Parser.html#method-i-export_select_tags">#export_select_tags &mdash; Orgmode::Parser</a></li>
203
+
204
+ <li><a href="Orgmode/Parser.html#method-i-export_tables-3F">#export_tables? &mdash; Orgmode::Parser</a></li>
205
+
206
+ <li><a href="Orgmode/Parser.html#method-i-export_todo-3F">#export_todo? &mdash; Orgmode::Parser</a></li>
207
+
208
+ <li><a href="Orgmode/TextileOutputBuffer.html#method-i-flush-21">#flush! &mdash; Orgmode::TextileOutputBuffer</a></li>
209
+
210
+ <li><a href="Orgmode/HtmlOutputBuffer.html#method-i-flush-21">#flush! &mdash; Orgmode::HtmlOutputBuffer</a></li>
211
+
212
+ <li><a href="Orgmode/OutputBuffer.html#method-i-get_next_headline_number">#get_next_headline_number &mdash; Orgmode::OutputBuffer</a></li>
213
+
214
+ <li><a href="Orgmode/Line.html#method-i-in_buffer_setting-3F">#in_buffer_setting? &mdash; Orgmode::Line</a></li>
215
+
216
+ <li><a href="Orgmode/Line.html#method-i-inline_example-3F">#inline_example? &mdash; Orgmode::Line</a></li>
217
+
218
+ <li><a href="Orgmode/TextileOutputBuffer.html#method-i-inline_formatting">#inline_formatting &mdash; Orgmode::TextileOutputBuffer</a></li>
219
+
220
+ <li><a href="Orgmode/OutputBuffer.html#method-i-list_indent_level">#list_indent_level &mdash; Orgmode::OutputBuffer</a></li>
221
+
222
+ <li><a href="Orgmode/RegexpHelper.html#method-i-match_all">#match_all &mdash; Orgmode::RegexpHelper</a></li>
223
+
224
+ <li><a href="Orgmode/Line.html#method-i-metadata-3F">#metadata? &mdash; Orgmode::Line</a></li>
225
+
226
+ <li><a href="Orgmode/Line.html#method-i-nonprinting-3F">#nonprinting? &mdash; Orgmode::Line</a></li>
227
+
228
+ <li><a href="Orgmode/Line.html#method-i-ordered_list-3F">#ordered_list? &mdash; Orgmode::Line</a></li>
229
+
230
+ <li><a href="Orgmode/HtmlOutputBuffer.html#method-i-output_footnotes-21">#output_footnotes! &mdash; Orgmode::HtmlOutputBuffer</a></li>
231
+
232
+ <li><a href="Orgmode/TextileOutputBuffer.html#method-i-output_footnotes-21">#output_footnotes! &mdash; Orgmode::TextileOutputBuffer</a></li>
233
+
234
+ <li><a href="Orgmode/Line.html#method-i-output_text">#output_text &mdash; Orgmode::Line</a></li>
235
+
236
+ <li><a href="Orgmode/Headline.html#method-i-output_text">#output_text &mdash; Orgmode::Headline</a></li>
237
+
238
+ <li><a href="Orgmode/Line.html#method-i-paragraph_type">#paragraph_type &mdash; Orgmode::Line</a></li>
239
+
240
+ <li><a href="Orgmode/Headline.html#method-i-paragraph_type">#paragraph_type &mdash; Orgmode::Headline</a></li>
241
+
242
+ <li><a href="Orgmode/Line.html#method-i-plain_list-3F">#plain_list? &mdash; Orgmode::Line</a></li>
243
+
244
+ <li><a href="Orgmode/Line.html#method-i-plain_text-3F">#plain_text? &mdash; Orgmode::Line</a></li>
245
+
246
+ <li><a href="Orgmode/TextileOutputBuffer.html#method-i-pop_mode">#pop_mode &mdash; Orgmode::TextileOutputBuffer</a></li>
247
+
248
+ <li><a href="Orgmode/OutputBuffer.html#method-i-pop_mode">#pop_mode &mdash; Orgmode::OutputBuffer</a></li>
249
+
250
+ <li><a href="Orgmode/HtmlOutputBuffer.html#method-i-pop_mode">#pop_mode &mdash; Orgmode::HtmlOutputBuffer</a></li>
251
+
252
+ <li><a href="Orgmode/OutputBuffer.html#method-i-prepare">#prepare &mdash; Orgmode::OutputBuffer</a></li>
253
+
254
+ <li><a href="Orgmode/OutputBuffer.html#method-i-preserve_whitespace-3F">#preserve_whitespace? &mdash; Orgmode::OutputBuffer</a></li>
255
+
256
+ <li><a href="Orgmode/HtmlOutputBuffer.html#method-i-push_mode">#push_mode &mdash; Orgmode::HtmlOutputBuffer</a></li>
257
+
258
+ <li><a href="Orgmode/OutputBuffer.html#method-i-push_mode">#push_mode &mdash; Orgmode::OutputBuffer</a></li>
259
+
260
+ <li><a href="Orgmode/TextileOutputBuffer.html#method-i-push_mode">#push_mode &mdash; Orgmode::TextileOutputBuffer</a></li>
261
+
262
+ <li><a href="Orgmode/RegexpHelper.html#method-i-rewrite_emphasis">#rewrite_emphasis &mdash; Orgmode::RegexpHelper</a></li>
263
+
264
+ <li><a href="Orgmode/RegexpHelper.html#method-i-rewrite_footnote">#rewrite_footnote &mdash; Orgmode::RegexpHelper</a></li>
265
+
266
+ <li><a href="Orgmode/RegexpHelper.html#method-i-rewrite_images">#rewrite_images &mdash; Orgmode::RegexpHelper</a></li>
267
+
268
+ <li><a href="Orgmode/RegexpHelper.html#method-i-rewrite_links">#rewrite_links &mdash; Orgmode::RegexpHelper</a></li>
269
+
270
+ <li><a href="Orgmode/RegexpHelper.html#method-i-rewrite_subp">#rewrite_subp &mdash; Orgmode::RegexpHelper</a></li>
271
+
272
+ <li><a href="Orgmode/Parser.html#method-i-skip_header_lines-3F">#skip_header_lines? &mdash; Orgmode::Parser</a></li>
273
+
274
+ <li><a href="Orgmode/Line.html#method-i-strip_ordered_list_tag">#strip_ordered_list_tag &mdash; Orgmode::Line</a></li>
275
+
276
+ <li><a href="Orgmode/Line.html#method-i-strip_unordered_list_tag">#strip_unordered_list_tag &mdash; Orgmode::Line</a></li>
277
+
278
+ <li><a href="Orgmode/Line.html#method-i-table-3F">#table? &mdash; Orgmode::Line</a></li>
279
+
280
+ <li><a href="Orgmode/Line.html#method-i-table_header-3F">#table_header? &mdash; Orgmode::Line</a></li>
281
+
282
+ <li><a href="Orgmode/Line.html#method-i-table_row-3F">#table_row? &mdash; Orgmode::Line</a></li>
283
+
284
+ <li><a href="Orgmode/Line.html#method-i-table_separator-3F">#table_separator? &mdash; Orgmode::Line</a></li>
285
+
286
+ <li><a href="Orgmode/Parser.html#method-i-to_html">#to_html &mdash; Orgmode::Parser</a></li>
287
+
288
+ <li><a href="Orgmode/Line.html#method-i-to_s">#to_s &mdash; Orgmode::Line</a></li>
289
+
290
+ <li><a href="Orgmode/Parser.html#method-i-to_textile">#to_textile &mdash; Orgmode::Parser</a></li>
291
+
292
+ <li><a href="Orgmode/Headline.html#method-i-to_textile">#to_textile &mdash; Orgmode::Headline</a></li>
293
+
294
+ <li><a href="Orgmode/Line.html#method-i-unordered_list-3F">#unordered_list? &mdash; Orgmode::Line</a></li>
295
+
296
+ <li><a href="Orgmode/Parser.html#method-i-use_sub_superscripts-3F">#use_sub_superscripts? &mdash; Orgmode::Parser</a></li>
297
+
298
+ </ul>
299
+
300
+ <div id="validator-badges">
301
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
302
+ <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
303
+ Rdoc Generator</a> 2</small>.</p>
304
+ </div>
305
+ </body>
306
+ </html>