asciidoctor 1.5.2 → 1.5.3
Sign up to get free protection for your applications and to get access to all the features.
Potentially problematic release.
This version of asciidoctor might be problematic. Click here for more details.
- checksums.yaml +4 -4
- data/CHANGELOG.adoc +107 -1
- data/LICENSE.adoc +1 -1
- data/README.adoc +155 -230
- data/Rakefile +2 -1
- data/bin/asciidoctor +5 -1
- data/data/stylesheets/asciidoctor-default.css +37 -29
- data/data/stylesheets/coderay-asciidoctor.css +3 -3
- data/features/text_formatting.feature +2 -0
- data/lib/asciidoctor.rb +46 -21
- data/lib/asciidoctor/abstract_block.rb +14 -8
- data/lib/asciidoctor/abstract_node.rb +77 -24
- data/lib/asciidoctor/attribute_list.rb +1 -1
- data/lib/asciidoctor/block.rb +2 -3
- data/lib/asciidoctor/cli/options.rb +14 -15
- data/lib/asciidoctor/converter/docbook45.rb +8 -8
- data/lib/asciidoctor/converter/docbook5.rb +25 -17
- data/lib/asciidoctor/converter/factory.rb +6 -1
- data/lib/asciidoctor/converter/html5.rb +159 -117
- data/lib/asciidoctor/converter/manpage.rb +671 -0
- data/lib/asciidoctor/converter/template.rb +24 -17
- data/lib/asciidoctor/document.rb +89 -47
- data/lib/asciidoctor/extensions.rb +22 -21
- data/lib/asciidoctor/helpers.rb +73 -16
- data/lib/asciidoctor/list.rb +26 -5
- data/lib/asciidoctor/parser.rb +179 -122
- data/lib/asciidoctor/path_resolver.rb +6 -10
- data/lib/asciidoctor/reader.rb +37 -34
- data/lib/asciidoctor/stylesheets.rb +16 -10
- data/lib/asciidoctor/substitutors.rb +98 -21
- data/lib/asciidoctor/table.rb +21 -17
- data/lib/asciidoctor/timings.rb +3 -3
- data/lib/asciidoctor/version.rb +1 -1
- data/man/asciidoctor.1 +155 -89
- data/man/asciidoctor.adoc +19 -11
- data/test/attributes_test.rb +86 -0
- data/test/blocks_test.rb +203 -15
- data/test/converter_test.rb +15 -2
- data/test/document_test.rb +290 -36
- data/test/extensions_test.rb +22 -3
- data/test/fixtures/circle.svg +8 -0
- data/test/fixtures/subs-docinfo.html +2 -0
- data/test/fixtures/subs.adoc +7 -0
- data/test/invoker_test.rb +25 -0
- data/test/links_test.rb +17 -0
- data/test/lists_test.rb +173 -0
- data/test/options_test.rb +2 -2
- data/test/paragraphs_test.rb +2 -2
- data/test/parser_test.rb +56 -13
- data/test/reader_test.rb +35 -3
- data/test/sections_test.rb +59 -0
- data/test/substitutions_test.rb +53 -14
- data/test/tables_test.rb +158 -2
- data/test/test_helper.rb +7 -2
- metadata +22 -11
- data/benchmark/benchmark.rb +0 -129
- data/benchmark/sample-data/mdbasics.adoc +0 -334
- data/lib/asciidoctor/opal_ext.rb +0 -26
- data/lib/asciidoctor/opal_ext/comparable.rb +0 -38
- data/lib/asciidoctor/opal_ext/dir.rb +0 -13
- data/lib/asciidoctor/opal_ext/error.rb +0 -2
- data/lib/asciidoctor/opal_ext/file.rb +0 -145
data/lib/asciidoctor/table.rb
CHANGED
@@ -73,7 +73,7 @@ class Table < AbstractBlock
|
|
73
73
|
@rows = Rows.new
|
74
74
|
@columns = []
|
75
75
|
|
76
|
-
@has_header_option = attributes.
|
76
|
+
@has_header_option = attributes.key? 'header-option'
|
77
77
|
|
78
78
|
# smell like we need a utility method here
|
79
79
|
# to resolve an integer width from potential bogus input
|
@@ -84,7 +84,7 @@ class Table < AbstractBlock
|
|
84
84
|
end
|
85
85
|
@attributes['tablepcwidth'] = pcwidth_intval
|
86
86
|
|
87
|
-
if @document.attributes.
|
87
|
+
if @document.attributes.key? 'pagewidth'
|
88
88
|
@attributes['tableabswidth'] ||=
|
89
89
|
((@attributes['tablepcwidth'].to_f / 100) * @document.attributes['pagewidth']).round
|
90
90
|
end
|
@@ -136,7 +136,7 @@ class Table < AbstractBlock
|
|
136
136
|
@rows.head = [head]
|
137
137
|
end
|
138
138
|
|
139
|
-
if num_body_rows > 0 && attributes.
|
139
|
+
if num_body_rows > 0 && attributes.key?('footer-option')
|
140
140
|
@rows.foot = [@rows.body.pop]
|
141
141
|
end
|
142
142
|
|
@@ -175,7 +175,7 @@ class Table::Column < AbstractNode
|
|
175
175
|
width = even_width
|
176
176
|
end
|
177
177
|
@attributes['colpcwidth'] = width
|
178
|
-
if parent.attributes.
|
178
|
+
if parent.attributes.key? 'tableabswidth'
|
179
179
|
@attributes['colabswidth'] = ((width.to_f / 100) * parent.attributes['tableabswidth']).round
|
180
180
|
end
|
181
181
|
|
@@ -215,8 +215,8 @@ class Table::Cell < AbstractNode
|
|
215
215
|
@colspan = attributes.delete('colspan')
|
216
216
|
@rowspan = attributes.delete('rowspan')
|
217
217
|
# TODO eventualy remove the style attribute from the attributes hash
|
218
|
-
#@style = attributes.delete('style') if attributes.
|
219
|
-
@style = attributes['style'] if attributes.
|
218
|
+
#@style = attributes.delete('style') if attributes.key? 'style'
|
219
|
+
@style = attributes['style'] if attributes.key? 'style'
|
220
220
|
update_attributes(attributes)
|
221
221
|
end
|
222
222
|
# only allow AsciiDoc cells in non-header rows
|
@@ -305,7 +305,7 @@ class Table::ParserContext
|
|
305
305
|
@format = Table::DEFAULT_DATA_FORMAT
|
306
306
|
end
|
307
307
|
|
308
|
-
@delimiter = if @format == 'psv' && !(attributes.
|
308
|
+
@delimiter = if @format == 'psv' && !(attributes.key? 'separator') && table.document.nested?
|
309
309
|
'!'
|
310
310
|
else
|
311
311
|
attributes['separator'] || Table::DEFAULT_DELIMITERS[@format]
|
@@ -437,13 +437,13 @@ class Table::ParserContext
|
|
437
437
|
@buffer = ''
|
438
438
|
if @format == 'psv'
|
439
439
|
cell_spec = take_cell_spec
|
440
|
-
if cell_spec
|
441
|
-
warn "asciidoctor: ERROR: #{@last_cursor.line_info}: table missing leading separator, recovering automatically"
|
442
|
-
cell_spec = {}
|
443
|
-
repeat = 1
|
444
|
-
else
|
440
|
+
if cell_spec
|
445
441
|
repeat = cell_spec.fetch('repeatcol', 1)
|
446
442
|
cell_spec.delete('repeatcol')
|
443
|
+
else
|
444
|
+
warn %(asciidoctor: ERROR: #{@last_cursor.line_info}: table missing leading separator, recovering automatically)
|
445
|
+
cell_spec = {}
|
446
|
+
repeat = 1
|
447
447
|
end
|
448
448
|
else
|
449
449
|
cell_spec = nil
|
@@ -463,17 +463,21 @@ class Table::ParserContext
|
|
463
463
|
end
|
464
464
|
|
465
465
|
1.upto(repeat) do |i|
|
466
|
-
# make column resolving an operation
|
466
|
+
# TODO make column resolving an operation
|
467
467
|
if @col_count == -1
|
468
|
-
@table.columns << (column = Table::Column.new(@table, @
|
469
|
-
if cell_spec && (cell_spec.
|
468
|
+
@table.columns << (column = Table::Column.new(@table, @table.columns.size + i - 1))
|
469
|
+
if cell_spec && (cell_spec.key? 'colspan') && (extra_cols = cell_spec['colspan'].to_i - 1) > 0
|
470
|
+
offset = @table.columns.size
|
470
471
|
extra_cols.times do |j|
|
471
|
-
@table.columns << Table::Column.new(@table,
|
472
|
+
@table.columns << Table::Column.new(@table, offset + j)
|
472
473
|
end
|
473
474
|
end
|
474
475
|
else
|
475
476
|
# QUESTION is this right for cells that span columns?
|
476
|
-
column = @table.columns[@current_row.size]
|
477
|
+
unless (column = @table.columns[@current_row.size])
|
478
|
+
warn %(asciidoctor: ERROR: #{@last_cursor.line_info}: dropping cell because it exceeds specified number of columns)
|
479
|
+
return
|
480
|
+
end
|
477
481
|
end
|
478
482
|
|
479
483
|
cell = Table::Cell.new(column, cell_text, cell_spec, @last_cursor)
|
data/lib/asciidoctor/timings.rb
CHANGED
@@ -32,9 +32,9 @@ module Asciidoctor
|
|
32
32
|
|
33
33
|
def print_report to = $stdout, subject = nil
|
34
34
|
to.puts %(Input file: #{subject}) if subject
|
35
|
-
to.puts %( Time to read and parse source: #{'%05.5f' % read_parse.
|
36
|
-
to.puts %( Time to convert document: #{'%05.5f' % convert.
|
37
|
-
to.puts %( Total time (read, parse and convert): #{'%05.5f' % read_parse_convert.
|
35
|
+
to.puts %( Time to read and parse source: #{'%05.5f' % read_parse.to_f})
|
36
|
+
to.puts %( Time to convert document: #{'%05.5f' % convert.to_f})
|
37
|
+
to.puts %( Total time (read, parse and convert): #{'%05.5f' % read_parse_convert.to_f})
|
38
38
|
end
|
39
39
|
end
|
40
40
|
end
|
data/lib/asciidoctor/version.rb
CHANGED
data/man/asciidoctor.1
CHANGED
@@ -1,170 +1,236 @@
|
|
1
1
|
'\" t
|
2
2
|
.\" Title: asciidoctor
|
3
|
-
.\" Author: Dan Allen
|
4
|
-
.\" Generator: Asciidoctor 1.5.
|
5
|
-
.\" Date:
|
3
|
+
.\" Author: Dan Allen, Sarah White, Ryan Waldron
|
4
|
+
.\" Generator: Asciidoctor 1.5.3
|
5
|
+
.\" Date: 2015-10-30
|
6
6
|
.\" Manual: Asciidoctor Manual
|
7
|
-
.\" Source: Asciidoctor 1.5.
|
7
|
+
.\" Source: Asciidoctor 1.5.3
|
8
8
|
.\" Language: English
|
9
9
|
.\"
|
10
|
-
.TH "ASCIIDOCTOR" "1" "
|
10
|
+
.TH "ASCIIDOCTOR" "1" "2015-10-30" "Asciidoctor 1.5.3" "Asciidoctor Manual"
|
11
11
|
.ie \n(.g .ds Aq \(aq
|
12
12
|
.el .ds Aq '
|
13
|
+
.ss \n[.ss] 0
|
13
14
|
.nh
|
14
15
|
.ad l
|
16
|
+
.de URL
|
17
|
+
\\$2 \(laURL: \\$1 \(ra\\$3
|
18
|
+
..
|
19
|
+
.if \n[.g] .mso www.tmac
|
20
|
+
.LINKSTYLE blue R < >
|
21
|
+
.SH "NAME"
|
22
|
+
asciidoctor \- converts AsciiDoc source files to HTML, DocBook and other formats
|
15
23
|
.SH "SYNOPSIS"
|
16
24
|
.sp
|
17
|
-
\fBasciidoctor\
|
25
|
+
\fBasciidoctor\fP [\fIOPTION\fP]... \fIFILE\fP...
|
18
26
|
.SH "DESCRIPTION"
|
19
27
|
.sp
|
20
|
-
The asciidoctor(1) command converts the AsciiDoc source file(s) \fIFILE\
|
28
|
+
The asciidoctor(1) command converts the AsciiDoc source file(s) \fIFILE\fP to HTML5, DocBook 5, DocBook 4.5, man(ual) page and other custom output formats.
|
21
29
|
.sp
|
22
|
-
If \fIFILE\
|
30
|
+
If \fIFILE\fP is \fI\-\fP then the AsciiDoc source is read from standard input.
|
23
31
|
.SH "OPTIONS"
|
24
32
|
.SS "Security Settings"
|
25
|
-
.
|
26
|
-
\fB\-B, \-\-base\-dir\
|
33
|
+
.sp
|
34
|
+
\fB\-B, \-\-base\-dir\fP=\fIDIR\fP
|
27
35
|
.RS 4
|
28
|
-
Base directory containing the document and resources
|
36
|
+
Base directory containing the document and resources.
|
37
|
+
Defaults to the directory containing the source file, or the working directory if the source is read from a stream.
|
38
|
+
Can be used as a way to chroot the execution of the program.
|
29
39
|
.RE
|
30
|
-
.
|
31
|
-
\fB\-S, \-\-safe\-mode\
|
40
|
+
.sp
|
41
|
+
\fB\-S, \-\-safe\-mode\fP=\fISAFE_MODE\fP
|
32
42
|
.RS 4
|
33
|
-
Set safe mode level: \fIunsafe\
|
43
|
+
Set safe mode level: \fIunsafe\fP, \fIsafe\fP, \fIserver\fP or \fIsecure\fP.
|
44
|
+
Disables potentially dangerous macros in source files, such as \f[CR]include::[]\fP.
|
45
|
+
If not set, the safe mode level defaults to \fIunsafe\fP when Asciidoctor is invoked using this script.
|
34
46
|
.RE
|
35
|
-
.
|
36
|
-
\fB\-\-safe\
|
47
|
+
.sp
|
48
|
+
\fB\-\-safe\fP
|
37
49
|
.RS 4
|
38
|
-
Set safe mode level to \fIsafe\
|
50
|
+
Set safe mode level to \fIsafe\fP.
|
51
|
+
Enables include macros, but restricts access to ancestor paths of source file.
|
52
|
+
Provided for compatibility with the asciidoc command.
|
53
|
+
If not set, the safe mode level defaults to \fIunsafe\fP when Asciidoctor is invoked using this script.
|
39
54
|
.RE
|
40
55
|
.SS "Document Settings"
|
41
|
-
.
|
42
|
-
\fB\-a, \-\-attribute\
|
56
|
+
.sp
|
57
|
+
\fB\-a, \-\-attribute\fP=\fIATTRIBUTE\fP
|
43
58
|
.RS 4
|
44
|
-
Define, override or delete a document attribute
|
59
|
+
Define, override or delete a document attribute.
|
60
|
+
Command\-line attributes take precedence over attributes defined in the source file.
|
45
61
|
.sp
|
46
|
-
\fIATTRIBUTE\
|
62
|
+
\fIATTRIBUTE\fP is normally formatted as a key\-value pair, in the form \fINAME=VALUE\fP.
|
63
|
+
Alternate acceptable forms are \fINAME\fP (where the \fIVALUE\fP defaults to an empty string), \fINAME!\fP (unassigns the \fINAME\fP attribute) and \fINAME=VALUE@\fP (where \fIVALUE\fP does not override value of \fINAME\fP attribute if it\(cqs already defined in the source document).
|
64
|
+
Values containing spaces should be enclosed in quotes.
|
47
65
|
.sp
|
48
|
-
This option may be specified more than once
|
66
|
+
This option may be specified more than once.
|
49
67
|
.RE
|
50
|
-
.
|
51
|
-
\fB\-b, \-\-backend\
|
68
|
+
.sp
|
69
|
+
\fB\-b, \-\-backend\fP=\fIBACKEND\fP
|
52
70
|
.RS 4
|
53
|
-
Backend output file format: \fIhtml5\
|
71
|
+
Backend output file format: \fIhtml5\fP, \fIdocbook5\fP, \fIdocbook45\fP and \fImanpage\fP are supported out of the box.
|
72
|
+
You can also use the backend alias names \fIhtml\fP (aliased to \fIhtml5\fP) or \fIdocbook\fP (aliased to \fIdocbook5\fP).
|
73
|
+
Defaults to \fIhtml5\fP.
|
74
|
+
Other options can be passed, but if Asciidoctor cannot find the backend, it will fail during conversion.
|
54
75
|
.RE
|
55
|
-
.
|
56
|
-
\fB\-d, \-\-doctype\
|
76
|
+
.sp
|
77
|
+
\fB\-d, \-\-doctype\fP=\fIDOCTYPE\fP
|
57
78
|
.RS 4
|
58
|
-
Document type: \fIarticle\
|
79
|
+
Document type: \fIarticle\fP, \fIbook\fP, \fImanpage\fP or \fIinline\fP.
|
80
|
+
Sets the root element when using the \fIdocbook\fP backend and the style class on the HTML body element when using the \fIhtml\fP backend.
|
81
|
+
The \fIbook\fP document type allows multiple level\-0 section titles in a single document.
|
82
|
+
The \fImanpage\fP document type enables parsing of metadata necessary to produce a manpage.
|
83
|
+
The \fIinline\fP document type allows the content of a single paragraph to be formatted and returned without wrapping it in a containing element.
|
84
|
+
Defaults to \fIarticle\fP.
|
59
85
|
.RE
|
60
86
|
.SS "Rendering Control"
|
61
|
-
.
|
62
|
-
\fB\-C, \-\-compact\
|
87
|
+
.sp
|
88
|
+
\fB\-C, \-\-compact\fP
|
89
|
+
.RS 4
|
90
|
+
Compact the output by removing blank lines.
|
91
|
+
(No longer in use).
|
92
|
+
.RE
|
93
|
+
.sp
|
94
|
+
\fB\-D, \-\-destination\-dir\fP=\fIDIR\fP
|
95
|
+
.RS 4
|
96
|
+
Destination output directory.
|
97
|
+
Defaults to the directory containing the source file, or the working directory if the source is read from a stream.
|
98
|
+
If specified, the directory is resolved relative to the working directory.
|
99
|
+
.RE
|
100
|
+
.sp
|
101
|
+
\fB\-E, \-\-template\-engine\fP=\fINAME\fP
|
63
102
|
.RS 4
|
64
|
-
|
103
|
+
Template engine to use for the custom converter templates.
|
104
|
+
The gem with the same name as the engine will be loaded automatically.
|
105
|
+
This name is also used to build the full path to the custom converter templates.
|
106
|
+
If a template engine is not specified, it will be auto\-detected based on the file extension of the custom converter templates found.
|
65
107
|
.RE
|
66
|
-
.
|
67
|
-
\fB\-
|
108
|
+
.sp
|
109
|
+
\fB\-e, \-\-eruby\fP
|
68
110
|
.RS 4
|
69
|
-
|
111
|
+
Specifies the eRuby implementation to use for executing the custom converter templates written in ERB.
|
112
|
+
Supported values are \fIerb\fP and \fIerubis\fP.
|
113
|
+
Defaults to \fIerb\fP.
|
70
114
|
.RE
|
71
|
-
.
|
72
|
-
\fB\-
|
115
|
+
.sp
|
116
|
+
\fB\-I, \-\-load\-path\fP=\fIDIRECTORY\fP
|
73
117
|
.RS 4
|
74
|
-
|
118
|
+
Add the specified directory to the load path, so that \fI\-r\fP can load extensions from outside the default Ruby load path.
|
119
|
+
This option may be specified more than once.
|
75
120
|
.RE
|
76
|
-
.
|
77
|
-
\fB\-
|
121
|
+
.sp
|
122
|
+
\fB\-n, \-\-section\-numbers\fP
|
78
123
|
.RS 4
|
79
|
-
|
124
|
+
Auto\-number section titles.
|
125
|
+
Synonym for \fB\-\-attribute numbered\fP.
|
80
126
|
.RE
|
81
|
-
.
|
82
|
-
\fB\-
|
127
|
+
.sp
|
128
|
+
\fB\-o, \-\-out\-file\fP=\fIOUT_FILE\fP
|
83
129
|
.RS 4
|
84
|
-
|
130
|
+
Write output to file \fIOUT_FILE\fP.
|
131
|
+
Defaults to the base name of the input file suffixed with \fIbackend\fP extension.
|
132
|
+
If the input is read from standard input, then the output file defaults to stdout.
|
133
|
+
If \fIOUT_FILE\fP is \fI\-\fP then the standard output is also used.
|
134
|
+
If specified, the file is resolved relative to the working directory.
|
85
135
|
.RE
|
86
|
-
.
|
87
|
-
\fB\-
|
136
|
+
.sp
|
137
|
+
\fB\-r, \-\-require\fP=\fILIBRARY\fP
|
88
138
|
.RS 4
|
89
|
-
|
139
|
+
Require the specified library before executing the processor, using the standard Ruby require.
|
140
|
+
This option may be specified more than once.
|
90
141
|
.RE
|
91
|
-
.
|
92
|
-
\fB\-s, \-\-no\-header\-footer\
|
142
|
+
.sp
|
143
|
+
\fB\-s, \-\-no\-header\-footer\fP
|
93
144
|
.RS 4
|
94
|
-
Suppress the document header and footer in the output
|
145
|
+
Suppress the document header and footer in the output.
|
95
146
|
.RE
|
96
|
-
.
|
97
|
-
\fB\-T, \-\-template\-dir\
|
147
|
+
.sp
|
148
|
+
\fB\-T, \-\-template\-dir\fP=\fIDIR\fP
|
98
149
|
.RS 4
|
99
|
-
A directory containing custom converter templates that override one or more templates from the built\-in set
|
150
|
+
A directory containing custom converter templates that override one or more templates from the built\-in set.
|
151
|
+
(requires \fItilt\fP gem)
|
100
152
|
.sp
|
101
|
-
If there is a subfolder that matches the engine name (if specified), that folder is appended to the template directory path
|
153
|
+
If there is a subfolder that matches the engine name (if specified), that folder is appended to the template directory path.
|
154
|
+
Similarly, if there is a subfolder in the resulting template directory that matches the name of the backend, that folder is appended to the template directory path.
|
102
155
|
.sp
|
103
|
-
This option may be specified more than once
|
156
|
+
This option may be specified more than once.
|
157
|
+
Matching templates found in subsequent directories override ones previously discovered.
|
104
158
|
.RE
|
105
159
|
.SS "Processing Information"
|
106
|
-
.
|
107
|
-
\fB\-q, \-\-quiet\
|
160
|
+
.sp
|
161
|
+
\fB\-q, \-\-quiet\fP
|
108
162
|
.RS 4
|
109
|
-
Silence warnings
|
163
|
+
Silence warnings.
|
110
164
|
.RE
|
111
|
-
.
|
112
|
-
\fB\-\-trace\
|
165
|
+
.sp
|
166
|
+
\fB\-\-trace\fP
|
113
167
|
.RS 4
|
114
|
-
Include backtrace information on errors
|
168
|
+
Include backtrace information on errors.
|
169
|
+
Not enabled by default.
|
115
170
|
.RE
|
116
|
-
.
|
117
|
-
\fB\-v, \-\-verbose\
|
171
|
+
.sp
|
172
|
+
\fB\-v, \-\-verbose\fP
|
118
173
|
.RS 4
|
119
|
-
Verbosely print processing information and configuration file checks to stderr
|
174
|
+
Verbosely print processing information and configuration file checks to stderr.
|
120
175
|
.RE
|
121
|
-
.
|
122
|
-
\fB\-t, \-\-timings\
|
176
|
+
.sp
|
177
|
+
\fB\-t, \-\-timings\fP
|
123
178
|
.RS 4
|
124
|
-
Display timings information (time to read, parse and convert)
|
179
|
+
Display timings information (time to read, parse and convert).
|
125
180
|
.RE
|
126
181
|
.SS "Program Information"
|
127
|
-
.
|
128
|
-
\fB\-h, \-\-help\
|
182
|
+
.sp
|
183
|
+
\fB\-h, \-\-help\fP
|
129
184
|
.RS 4
|
130
|
-
Show the help message
|
185
|
+
Show the help message.
|
131
186
|
.RE
|
132
|
-
|
187
|
+
.sp
|
188
|
+
\fB\-V, \-\-version\fP
|
133
189
|
.RS 4
|
134
|
-
Print program version number
|
190
|
+
Print program version number.
|
191
|
+
.sp
|
192
|
+
\f[CR]\-v\fP can also be used if no other flags or arguments are present.
|
135
193
|
.RE
|
136
194
|
.SH "EXIT STATUS"
|
137
|
-
.
|
138
|
-
\fB0\
|
195
|
+
.sp
|
196
|
+
\fB0\fP
|
139
197
|
.RS 4
|
140
|
-
Success
|
198
|
+
Success.
|
141
199
|
.RE
|
142
|
-
.
|
143
|
-
\fB1\
|
200
|
+
.sp
|
201
|
+
\fB1\fP
|
144
202
|
.RS 4
|
145
|
-
Failure (syntax or usage error; configuration error; document processing failure; unexpected error)
|
203
|
+
Failure (syntax or usage error; configuration error; document processing failure; unexpected error).
|
146
204
|
.RE
|
147
205
|
.SH "BUGS"
|
148
206
|
.sp
|
149
|
-
|
207
|
+
Refer to the \fBAsciidoctor\fP issue tracker at
|
208
|
+
.URL "https://github.com/asciidoctor/asciidoctor/issues?q=is%3Aopen" "" "."
|
150
209
|
.SH "AUTHORS"
|
151
210
|
.sp
|
152
|
-
\fBAsciidoctor\
|
211
|
+
\fBAsciidoctor\fP was written by Dan Allen, Ryan Waldron, Jason Porter, Nick Hengeveld and other contributors.
|
153
212
|
.sp
|
154
|
-
\fBAsciiDoc\
|
213
|
+
\fBAsciiDoc\fP was written by Stuart Rackham and has received contributions from many other individuals.
|
155
214
|
.SH "RESOURCES"
|
156
215
|
.sp
|
157
|
-
|
216
|
+
\fBProject web site:\fP
|
217
|
+
.URL "http://asciidoctor.org" "" ""
|
158
218
|
.sp
|
159
|
-
|
219
|
+
\fBGit source repository on GitHub:\fP
|
220
|
+
.URL "https://github.com/asciidoctor/asciidoctor" "" ""
|
160
221
|
.sp
|
161
|
-
|
222
|
+
\fBGitHub organization:\fP
|
223
|
+
.URL "https://github.com/asciidoctor" "" ""
|
162
224
|
.sp
|
163
|
-
|
225
|
+
\fBDiscussion list / forum:\fP
|
226
|
+
.URL "http://discuss.asciidoctor.org" "" ""
|
164
227
|
.SH "COPYING"
|
165
228
|
.sp
|
166
|
-
Copyright (C) 2012\-
|
167
|
-
.
|
168
|
-
.
|
169
|
-
|
170
|
-
|
229
|
+
Copyright (C) 2012\-2015 Dan Allen, Ryan Waldron and the Asciidoctor Project.
|
230
|
+
Free use of this software is granted under the terms of the MIT License.
|
231
|
+
.SH "AUTHOR(S)"
|
232
|
+
.sp
|
233
|
+
\fBDan Allen, Sarah White, Ryan Waldron\fP
|
234
|
+
.RS 4
|
235
|
+
Author(s).
|
236
|
+
.RE
|
data/man/asciidoctor.adoc
CHANGED
@@ -2,7 +2,7 @@
|
|
2
2
|
Dan Allen; Sarah White; Ryan Waldron
|
3
3
|
:doctype: manpage
|
4
4
|
:man manual: Asciidoctor Manual
|
5
|
-
:man source: Asciidoctor 1.5.
|
5
|
+
:man source: Asciidoctor 1.5.3
|
6
6
|
:page-layout: base
|
7
7
|
|
8
8
|
== NAME
|
@@ -15,7 +15,7 @@ asciidoctor - converts AsciiDoc source files to HTML, DocBook and other formats
|
|
15
15
|
|
16
16
|
== DESCRIPTION
|
17
17
|
|
18
|
-
The asciidoctor(1) command converts the AsciiDoc source file(s) _FILE_ to HTML5, DocBook
|
18
|
+
The asciidoctor(1) command converts the AsciiDoc source file(s) _FILE_ to HTML5, DocBook 5, DocBook 4.5, man(ual) page and other custom output formats.
|
19
19
|
|
20
20
|
If _FILE_ is _-_ then the AsciiDoc source is read from standard input.
|
21
21
|
|
@@ -52,7 +52,7 @@ Values containing spaces should be enclosed in quotes.
|
|
52
52
|
This option may be specified more than once.
|
53
53
|
|
54
54
|
*-b, --backend*=_BACKEND_::
|
55
|
-
Backend output file format: _html5_, _docbook45_ and
|
55
|
+
Backend output file format: _html5_, _docbook5_, _docbook45_ and _manpage_ are supported out of the box.
|
56
56
|
You can also use the backend alias names _html_ (aliased to _html5_) or _docbook_ (aliased to _docbook5_).
|
57
57
|
Defaults to _html5_.
|
58
58
|
Other options can be passed, but if Asciidoctor cannot find the backend, it will fail during conversion.
|
@@ -87,6 +87,10 @@ This option may be specified more than once.
|
|
87
87
|
Supported values are _erb_ and _erubis_.
|
88
88
|
Defaults to _erb_.
|
89
89
|
|
90
|
+
*-I, --load-path*=_DIRECTORY_::
|
91
|
+
Add the specified directory to the load path, so that _-r_ can load extensions from outside the default Ruby load path.
|
92
|
+
This option may be specified more than once.
|
93
|
+
|
90
94
|
*-n, --section-numbers*::
|
91
95
|
Auto-number section titles.
|
92
96
|
Synonym for *--attribute numbered*.
|
@@ -98,6 +102,10 @@ This option may be specified more than once.
|
|
98
102
|
If _OUT_FILE_ is _-_ then the standard output is also used.
|
99
103
|
If specified, the file is resolved relative to the working directory.
|
100
104
|
|
105
|
+
*-r, --require*=_LIBRARY_::
|
106
|
+
Require the specified library before executing the processor, using the standard Ruby require.
|
107
|
+
This option may be specified more than once.
|
108
|
+
|
101
109
|
*-s, --no-header-footer*::
|
102
110
|
Suppress the document header and footer in the output.
|
103
111
|
|
@@ -133,6 +141,8 @@ Matching templates found in subsequent directories override ones previously disc
|
|
133
141
|
|
134
142
|
*-V, --version*::
|
135
143
|
Print program version number.
|
144
|
+
+
|
145
|
+
`-v` can also be used if no other flags or arguments are present.
|
136
146
|
|
137
147
|
== EXIT STATUS
|
138
148
|
|
@@ -144,7 +154,7 @@ Matching templates found in subsequent directories override ones previously disc
|
|
144
154
|
|
145
155
|
== BUGS
|
146
156
|
|
147
|
-
|
157
|
+
Refer to the *Asciidoctor* issue tracker at https://github.com/asciidoctor/asciidoctor/issues?q=is%3Aopen.
|
148
158
|
|
149
159
|
== AUTHORS
|
150
160
|
|
@@ -154,17 +164,15 @@ See the *Asciidoctor* issue tracker: <**https://github.com/asciidoctor/asciidoct
|
|
154
164
|
|
155
165
|
== RESOURCES
|
156
166
|
|
157
|
-
|
167
|
+
*Project web site:* http://asciidoctor.org
|
158
168
|
|
159
|
-
|
169
|
+
*Git source repository on GitHub:* https://github.com/asciidoctor/asciidoctor
|
160
170
|
|
161
|
-
GitHub organization
|
171
|
+
*GitHub organization:* https://github.com/asciidoctor
|
162
172
|
|
163
|
-
Discussion list / forum
|
173
|
+
*Discussion list / forum:* http://discuss.asciidoctor.org
|
164
174
|
|
165
175
|
== COPYING
|
166
176
|
|
167
|
-
Copyright \(C) 2012-
|
177
|
+
Copyright \(C) 2012-2015 Dan Allen, Ryan Waldron and the Asciidoctor Project.
|
168
178
|
Free use of this software is granted under the terms of the MIT License.
|
169
|
-
|
170
|
-
// vim: tw=80
|