ronn-ng 0.10.1.pre1 → 0.10.1.pre3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/AUTHORS +11 -7
- data/CHANGES +7 -1
- data/INSTALLING.md +29 -27
- data/LICENSE.txt +1 -1
- data/README.md +15 -9
- data/Rakefile +1 -1
- data/bin/ronn +1 -1
- data/lib/ronn/document.rb +4 -1
- data/lib/ronn/roff.rb +4 -0
- data/lib/ronn/template/default.html +1 -1
- data/lib/ronn.rb +4 -6
- data/man/index.html +15 -14
- data/man/index.txt +10 -9
- data/man/ronn-format.7 +2 -2
- data/man/ronn.1 +25 -20
- data/man/ronn.1.ronn +9 -8
- data/ronn-ng.gemspec +6 -69
- metadata +19 -80
- data/Gemfile +0 -2
- data/Gemfile.lock +0 -70
- data/test/angle_bracket_syntax.html +0 -27
- data/test/angle_bracket_syntax.roff +0 -24
- data/test/angle_bracket_syntax.ronn +0 -22
- data/test/backticks.html +0 -14
- data/test/backticks.ronn +0 -10
- data/test/basic_document.html +0 -8
- data/test/basic_document.ronn +0 -4
- data/test/circumflexes.ronn +0 -1
- data/test/code_blocks.html +0 -38
- data/test/code_blocks.roff +0 -38
- data/test/code_blocks.ronn +0 -41
- data/test/code_blocks_regression +0 -19
- data/test/code_blocks_regression.html +0 -38
- data/test/code_blocks_regression.ronn +0 -40
- data/test/contest.rb +0 -70
- data/test/custom_title_document.html +0 -6
- data/test/custom_title_document.ronn +0 -5
- data/test/definition_list_syntax.html +0 -25
- data/test/definition_list_syntax.roff +0 -19
- data/test/definition_list_syntax.ronn +0 -18
- data/test/dots_at_line_start_test.roff +0 -19
- data/test/dots_at_line_start_test.ronn +0 -12
- data/test/ellipses.roff +0 -7
- data/test/ellipses.ronn +0 -7
- data/test/entity_encoding_test.html +0 -42
- data/test/entity_encoding_test.roff +0 -51
- data/test/entity_encoding_test.ronn +0 -34
- data/test/index.txt +0 -8
- data/test/markdown_syntax.html +0 -954
- data/test/markdown_syntax.roff +0 -907
- data/test/markdown_syntax.ronn +0 -881
- data/test/middle_paragraph.html +0 -14
- data/test/middle_paragraph.roff +0 -9
- data/test/middle_paragraph.ronn +0 -10
- data/test/missing_spaces.roff +0 -7
- data/test/missing_spaces.ronn +0 -2
- data/test/nested_list.ronn +0 -19
- data/test/nested_list_with_code.html +0 -14
- data/test/nested_list_with_code.roff +0 -11
- data/test/nested_list_with_code.ronn +0 -6
- data/test/ordered_list.html +0 -28
- data/test/ordered_list.roff +0 -25
- data/test/ordered_list.ronn +0 -21
- data/test/page.with.periods.in.name.5.ronn +0 -4
- data/test/pre_block_with_quotes.roff +0 -8
- data/test/pre_block_with_quotes.ronn +0 -6
- data/test/section_reference_links.html +0 -16
- data/test/section_reference_links.roff +0 -7
- data/test/section_reference_links.ronn +0 -12
- data/test/single_quotes.html +0 -11
- data/test/single_quotes.roff +0 -5
- data/test/single_quotes.ronn +0 -9
- data/test/tables.ronn +0 -24
- data/test/test_ronn.rb +0 -124
- data/test/test_ronn_document.rb +0 -186
- data/test/test_ronn_index.rb +0 -73
- data/test/titleless_document.html +0 -9
- data/test/titleless_document.ronn +0 -3
- data/test/underline_spacing_test.roff +0 -13
- data/test/underline_spacing_test.ronn +0 -11
|
@@ -1,40 +0,0 @@
|
|
|
1
|
-
Example Quote Error
|
|
2
|
-
===================
|
|
3
|
-
|
|
4
|
-
## In the text:
|
|
5
|
-
|
|
6
|
-
This is Renzo's code.
|
|
7
|
-
|
|
8
|
-
Debian's lintian returns the following warning:
|
|
9
|
-
acute-accent-in-manual-page
|
|
10
|
-
|
|
11
|
-
This manual page uses the \' groff sequence. Usually, the intent to
|
|
12
|
-
generate an apostrophe, but that sequence actually renders as a an acute
|
|
13
|
-
accent.
|
|
14
|
-
|
|
15
|
-
For an apostrophe or a single closing quote, use plain '. For single
|
|
16
|
-
opening quote, i.e. a straight downward line ' like the one used in
|
|
17
|
-
shell commands, use \(aq.
|
|
18
|
-
|
|
19
|
-
## Basic code block
|
|
20
|
-
|
|
21
|
-
The situation is even worse when there are code blocks, mainly code
|
|
22
|
-
chunks or commands. E.g., copy-paste fails.
|
|
23
|
-
|
|
24
|
-
Type the following command `echo 'Hello World'`.
|
|
25
|
-
|
|
26
|
-
``` bash
|
|
27
|
-
$ echo 'hello world'
|
|
28
|
-
```
|
|
29
|
-
|
|
30
|
-
The following code cannot be compiled:
|
|
31
|
-
``` C
|
|
32
|
-
int main() {
|
|
33
|
-
int example = 42;
|
|
34
|
-
switch (example) {
|
|
35
|
-
case 'a': return 10;
|
|
36
|
-
default: return 42;
|
|
37
|
-
}
|
|
38
|
-
}
|
|
39
|
-
```
|
|
40
|
-
|
data/test/contest.rb
DELETED
|
@@ -1,70 +0,0 @@
|
|
|
1
|
-
require 'test/unit'
|
|
2
|
-
|
|
3
|
-
module Test
|
|
4
|
-
module Unit
|
|
5
|
-
# TestSuite loads a default test if the suite is empty, whose purpose is to
|
|
6
|
-
# fail. Since having empty contexts is a common practice, we decided to
|
|
7
|
-
# overwrite TestSuite#empty? in order to allow them. Having a failure when no
|
|
8
|
-
# tests have been defined seems counter-intuitive.
|
|
9
|
-
class TestSuite
|
|
10
|
-
def empty?
|
|
11
|
-
false
|
|
12
|
-
end
|
|
13
|
-
end
|
|
14
|
-
|
|
15
|
-
# Contest adds +teardown+, +test+ and +context+ as class methods, and the
|
|
16
|
-
# instance methods +setup+ and +teardown+ now iterate on the corresponding
|
|
17
|
-
# blocks. Note that all setup and teardown blocks must be defined with the
|
|
18
|
-
# block syntax. Adding setup or teardown instance methods defeats the purpose
|
|
19
|
-
# of this library.
|
|
20
|
-
class TestCase
|
|
21
|
-
def self.setup(&block)
|
|
22
|
-
define_method :setup do
|
|
23
|
-
super(&block)
|
|
24
|
-
instance_eval(&block)
|
|
25
|
-
end
|
|
26
|
-
end
|
|
27
|
-
|
|
28
|
-
def self.teardown(&block)
|
|
29
|
-
define_method :teardown do
|
|
30
|
-
instance_eval(&block)
|
|
31
|
-
super(&block)
|
|
32
|
-
end
|
|
33
|
-
end
|
|
34
|
-
|
|
35
|
-
def self.context(name, &block)
|
|
36
|
-
subclass = Class.new(self)
|
|
37
|
-
remove_tests(subclass)
|
|
38
|
-
subclass.class_eval(&block) if block_given?
|
|
39
|
-
const_set(context_name(name), subclass)
|
|
40
|
-
end
|
|
41
|
-
|
|
42
|
-
def self.test(name, &block)
|
|
43
|
-
define_method(test_name(name), &block)
|
|
44
|
-
end
|
|
45
|
-
|
|
46
|
-
class << self
|
|
47
|
-
alias should test
|
|
48
|
-
alias describe context
|
|
49
|
-
end
|
|
50
|
-
|
|
51
|
-
def self.context_name(name)
|
|
52
|
-
"Test#{sanitize_name(name).gsub(/(^| )(\w)/) { $2.upcase }}".to_sym
|
|
53
|
-
end
|
|
54
|
-
|
|
55
|
-
def self.test_name(name)
|
|
56
|
-
"test_#{sanitize_name(name).gsub(/\s+/, '_')}".to_sym
|
|
57
|
-
end
|
|
58
|
-
|
|
59
|
-
def self.sanitize_name(name)
|
|
60
|
-
name.gsub(/\W+/, ' ').strip
|
|
61
|
-
end
|
|
62
|
-
|
|
63
|
-
def self.remove_tests(subclass)
|
|
64
|
-
subclass.public_instance_methods.grep(/^test_/).each do |meth|
|
|
65
|
-
subclass.send(:undef_method, meth.to_sym)
|
|
66
|
-
end
|
|
67
|
-
end
|
|
68
|
-
end
|
|
69
|
-
end
|
|
70
|
-
end
|
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
<div class='mp'>
|
|
2
|
-
|
|
3
|
-
<h2 id="NAME">NAME</h2>
|
|
4
|
-
<p class="man-name">
|
|
5
|
-
<code>definition_list_syntax</code> - <span class="man-whatis">hiya</span>
|
|
6
|
-
</p>
|
|
7
|
-
<p>Definition lists look like unordered lists:</p>
|
|
8
|
-
|
|
9
|
-
<dl>
|
|
10
|
-
<dt>term</dt>
|
|
11
|
-
<dd>definition</dd>
|
|
12
|
-
<dt>another one</dt>
|
|
13
|
-
<dd>The definition may span
|
|
14
|
-
multiple lines and even
|
|
15
|
-
|
|
16
|
-
<p>start</p>
|
|
17
|
-
|
|
18
|
-
<p>new paragraphs</p>
|
|
19
|
-
</dd>
|
|
20
|
-
<dt>
|
|
21
|
-
<code>--somearg</code>=<var>VALUE</var>
|
|
22
|
-
</dt>
|
|
23
|
-
<dd>We can do that too.</dd>
|
|
24
|
-
</dl>
|
|
25
|
-
</div>
|
|
@@ -1,19 +0,0 @@
|
|
|
1
|
-
.TH "DEFINITION_LIST_SYNTAX" "5" "January 1979" ""
|
|
2
|
-
.SH "NAME"
|
|
3
|
-
\fBdefinition_list_syntax\fR \- hiya
|
|
4
|
-
.P
|
|
5
|
-
Definition lists look like unordered lists:
|
|
6
|
-
.TP
|
|
7
|
-
term
|
|
8
|
-
definition
|
|
9
|
-
.TP
|
|
10
|
-
another one
|
|
11
|
-
The definition may span multiple lines and even
|
|
12
|
-
.IP
|
|
13
|
-
start
|
|
14
|
-
.IP
|
|
15
|
-
new paragraphs
|
|
16
|
-
.TP
|
|
17
|
-
\fB\-\-somearg\fR=\fIVALUE\fR
|
|
18
|
-
We can do that too\.
|
|
19
|
-
|
|
@@ -1,18 +0,0 @@
|
|
|
1
|
-
definition_list_syntax(5) -- hiya
|
|
2
|
-
=================================
|
|
3
|
-
|
|
4
|
-
Definition lists look like unordered lists:
|
|
5
|
-
|
|
6
|
-
* term:
|
|
7
|
-
definition
|
|
8
|
-
|
|
9
|
-
* another one:
|
|
10
|
-
The definition may span
|
|
11
|
-
multiple lines and even
|
|
12
|
-
|
|
13
|
-
start
|
|
14
|
-
|
|
15
|
-
new paragraphs
|
|
16
|
-
|
|
17
|
-
* `--somearg`=<VALUE>:
|
|
18
|
-
We can do that too.
|
|
@@ -1,19 +0,0 @@
|
|
|
1
|
-
.TH "DOTS_AT_LINE_START_TEST" "" "January 1979" ""
|
|
2
|
-
.SH "NAME"
|
|
3
|
-
\fBdots_at_line_start_test\fR
|
|
4
|
-
.P
|
|
5
|
-
There's a weird issue where dots at the beginning of a line generate troff warnings due to escaping\.
|
|
6
|
-
.P
|
|
7
|
-
\&\.\. let's see what happens\.
|
|
8
|
-
.IP "" 4
|
|
9
|
-
.nf
|
|
10
|
-
\&\. A dot on an indented line
|
|
11
|
-
|
|
12
|
-
\&\. Another dot on an indented line
|
|
13
|
-
|
|
14
|
-
some text
|
|
15
|
-
some more text
|
|
16
|
-
\&\. A dot on an indented line as part of a paragraph
|
|
17
|
-
.fi
|
|
18
|
-
.IP "" 0
|
|
19
|
-
|
|
@@ -1,12 +0,0 @@
|
|
|
1
|
-
There's a weird issue where dots at the beginning of a line
|
|
2
|
-
generate troff warnings due to escaping.
|
|
3
|
-
|
|
4
|
-
.. let's see what happens.
|
|
5
|
-
|
|
6
|
-
. A dot on an indented line
|
|
7
|
-
|
|
8
|
-
. Another dot on an indented line
|
|
9
|
-
|
|
10
|
-
some text
|
|
11
|
-
some more text
|
|
12
|
-
. A dot on an indented line as part of a paragraph
|
data/test/ellipses.roff
DELETED
data/test/ellipses.ronn
DELETED
|
@@ -1,42 +0,0 @@
|
|
|
1
|
-
<div class='mp'>
|
|
2
|
-
|
|
3
|
-
<h2 id="NAME">NAME</h2>
|
|
4
|
-
<p class="man-name">
|
|
5
|
-
<code>hello</code> - <span class="man-whatis">hello world</span>
|
|
6
|
-
</p>
|
|
7
|
-
<p>Your output <i>might</i> look like this:</p>
|
|
8
|
-
|
|
9
|
-
<pre><code>* Chris
|
|
10
|
-
*
|
|
11
|
-
* &lt;b&gt;GitHub&lt;/b&gt;
|
|
12
|
-
* <b>GitHub</b>
|
|
13
|
-
</code></pre>
|
|
14
|
-
|
|
15
|
-
<p>Here's some special entities:</p>
|
|
16
|
-
|
|
17
|
-
<ul>
|
|
18
|
-
<li>&bull; •</li>
|
|
19
|
-
<li>&nbsp; </li>
|
|
20
|
-
<li>&copy; ©</li>
|
|
21
|
-
<li>&rdquo; ”</li>
|
|
22
|
-
<li>&mdash; —</li>
|
|
23
|
-
<li>&reg; ®</li>
|
|
24
|
-
<li>&sect; §</li>
|
|
25
|
-
<li>&ge; ≥</li>
|
|
26
|
-
<li>&le; ≤</li>
|
|
27
|
-
<li>&ne; ≠</li>
|
|
28
|
-
<li>&equiv; ≡</li>
|
|
29
|
-
</ul>
|
|
30
|
-
|
|
31
|
-
<p>Here's a line that uses non-breaking spaces to force the
|
|
32
|
-
last few words to wrap together.</p>
|
|
33
|
-
|
|
34
|
-
<p>And stuff like this:</p>
|
|
35
|
-
|
|
36
|
-
<p>git bulk [-g] ([-a]|[-w <ws-name>]) <git command> </git></ws-name><br>
|
|
37
|
-
git bulk --addworkspace <ws-name> <ws-root-directory> (--from <url or file>) </url></ws-root-directory></ws-name><br>
|
|
38
|
-
git bulk --removeworkspace <ws-name> <br></p>
|
|
39
|
-
|
|
40
|
-
<p>Should have the <code>&lt;</code>/<code>&gt;</code> entities stay as <code>&lt;</code>/<code>&gt;</code> in HTML, but be
|
|
41
|
-
turned into literal brackets in the ROFF.</p>
|
|
42
|
-
</div>
|
|
@@ -1,51 +0,0 @@
|
|
|
1
|
-
.TH "HELLO" "1" "January 1979" ""
|
|
2
|
-
.SH "NAME"
|
|
3
|
-
\fBhello\fR \- hello world
|
|
4
|
-
.P
|
|
5
|
-
Your output <i>might</i> look like this:
|
|
6
|
-
.IP "" 4
|
|
7
|
-
.nf
|
|
8
|
-
* Chris
|
|
9
|
-
*
|
|
10
|
-
* <b>GitHub</b>
|
|
11
|
-
* <b>GitHub</b>
|
|
12
|
-
.fi
|
|
13
|
-
.IP "" 0
|
|
14
|
-
.P
|
|
15
|
-
Here's some special entities:
|
|
16
|
-
.IP "\(bu" 4
|
|
17
|
-
• \(bu
|
|
18
|
-
.IP "\(bu" 4
|
|
19
|
-
\~
|
|
20
|
-
.IP "\(bu" 4
|
|
21
|
-
© \(co
|
|
22
|
-
.IP "\(bu" 4
|
|
23
|
-
” \(rs
|
|
24
|
-
.IP "\(bu" 4
|
|
25
|
-
— \(em
|
|
26
|
-
.IP "\(bu" 4
|
|
27
|
-
® \(rg
|
|
28
|
-
.IP "\(bu" 4
|
|
29
|
-
§ \(sc
|
|
30
|
-
.IP "\(bu" 4
|
|
31
|
-
≥ \(>=
|
|
32
|
-
.IP "\(bu" 4
|
|
33
|
-
≤ \(<=
|
|
34
|
-
.IP "\(bu" 4
|
|
35
|
-
≠ \(!=
|
|
36
|
-
.IP "\(bu" 4
|
|
37
|
-
≡ \(==
|
|
38
|
-
.IP "" 0
|
|
39
|
-
.P
|
|
40
|
-
Here's a line that uses non\-breaking spaces to force the last\~few\~words\~to\~wrap\~together\.
|
|
41
|
-
.P
|
|
42
|
-
And stuff like this:
|
|
43
|
-
.P
|
|
44
|
-
git bulk [\-g] ([\-a]|[\-w
|
|
45
|
-
.br
|
|
46
|
-
git bulk \-\-addworkspace
|
|
47
|
-
.br
|
|
48
|
-
git bulk \-\-removeworkspace <ws\-name>
|
|
49
|
-
.br
|
|
50
|
-
.P
|
|
51
|
-
Should have the \fB<\fR/\fB>\fR entities stay as \fB<\fR/\fB>\fR in HTML, but be turned into literal brackets in the ROFF\.
|
|
@@ -1,34 +0,0 @@
|
|
|
1
|
-
# hello(1) -- hello world
|
|
2
|
-
|
|
3
|
-
Your output <i>might</i> look like this:
|
|
4
|
-
|
|
5
|
-
* Chris
|
|
6
|
-
*
|
|
7
|
-
* <b>GitHub</b>
|
|
8
|
-
* <b>GitHub</b>
|
|
9
|
-
|
|
10
|
-
Here's some special entities:
|
|
11
|
-
|
|
12
|
-
* &bull; •
|
|
13
|
-
* &nbsp;
|
|
14
|
-
* &copy; ©
|
|
15
|
-
* &rdquo; ”
|
|
16
|
-
* &mdash; —
|
|
17
|
-
* &reg; ®
|
|
18
|
-
* &sect; §
|
|
19
|
-
* &ge; ≥
|
|
20
|
-
* &le; ≤
|
|
21
|
-
* &ne; ≠
|
|
22
|
-
* &equiv; ≡
|
|
23
|
-
|
|
24
|
-
Here's a line that uses non-breaking spaces to force the
|
|
25
|
-
last few words to wrap together.
|
|
26
|
-
|
|
27
|
-
And stuff like this:
|
|
28
|
-
|
|
29
|
-
git bulk [-g] ([-a]|[-w <ws-name>]) <git command> <br/>
|
|
30
|
-
git bulk --addworkspace <ws-name> <ws-root-directory> (--from <URL or file>) <br/>
|
|
31
|
-
git bulk --removeworkspace <ws-name> <br/>
|
|
32
|
-
|
|
33
|
-
Should have the `<`/`>` entities stay as `<`/`>` in HTML, but be
|
|
34
|
-
turned into literal brackets in the ROFF.
|