module Asciidoctor

Set of file extensions recognized as AsciiDoc documents (stored as a truth hash)

Matches an admonition label at the start of a paragraph.

Examples

NOTE: Just a little note.
TIP: Don't forget!

Detects the start of any list item.

Matches the pass inline macro allowed in value of attribute assignment.

Examples

pass:[text]

Matches a document attribute entry.

Examples

:foo: bar
:First Name: Dan
:sectnums!:
:!toc:
:long-entry: Attribute value lines ending in ' +'
             are joined together as a single value,
             collapsing the line breaks and indentation to
             a single space.

Matches an inline attribute reference.

Examples

{foo}
{counter:pcount:1}
{set:foo:bar}
{set:name!}

Matches a single-line (Atx-style) section title.

Examples

== Foo
# ^ a level 1 (h2) section title

== Foo ==
# ^ also a level 1 (h2) section title

match is the delimiter, whose length determines the level match is the title itself match is an inline anchor, which becomes the section id

Matches the author info line immediately following the document title.

Examples

Doc Writer <doc@example.com>
Mary_Sue Brontë

Pointers to the preferred version for a given backend.

Byte arrays for UTF-* Byte Order Marks hex escape sequence used for Ruby 1.8 compatibility

Matches a blank line.

NOTE allows for empty space in line as it could be left by the template engine

Matches an anchor (i.e., id + optional reference text) on a line above a block.

Examples

[[idname]]
[[idname,Reference Text]]

A combined pattern that matches either a block anchor or a block attribute list.

TODO this one gets hit a lot, should be optimized as much as possible

Matches an attribute list above a block element.

Examples

# strictly positional
[quote, Adam Smith, Wealth of Nations]

# name/value pairs
[NOTE, caption="Good to know"]

# as attribute reference
[{lead}]

Matches a title above a block.

Examples

.Title goes here

NOTE Ruby 1.8 cannot match word characters beyond the ASCII range; if you need this feature, upgrade!

Flag to indicate whether encoding can be coerced to UTF-8 All input data must be force encoded to UTF-8 if Encoding.default_external is not UTF-8 Addresses failures performing string operations that are reported as “invalid byte sequence in US-ASCII” Ruby 1.8 doesn't seem to experience this problem (perhaps because it isn't validating the encodings)

Matches a callout reference inside literal text.

Examples

<1> (optionally prefixed by //, #, -- or ;; line comment chars)
<1> <2> (multiple callouts on one line)
<!--1--> (for XML-based languages)

NOTE extract regexps are applied line-by-line, so we can use $ as end-of-line char

Matches a callout list item.

Examples

<1> Foo

NOTE we know trailing (.*) will match at least one character because we strip trailing spaces

NOTE special characters have not been replaced when scanning

NOTE special characters have already been replaced when converting to an SGML format

Parses the start and end of a cell spec (i.e., cellspec) for a table.

Examples

2.3+<.>m

FIXME use step-wise scan (or treetop) rather than this mega-regexp

Parses the column spec (i.e., colspec) for a table.

Examples

1*h,2*,^3e

Matches a comment block.

Examples

////
This is a block comment.
It can span one or more lines.
////

Matches a comment line.

Examples

// an then whatever

Matches a conditional preprocessor directive (e.g., ifdef, ifndef, ifeval and endif).

Examples

ifdef::basebackend-html[]
ifndef::theme[]
ifeval::["{asciidoctor-version}" >= "0.1.0"]
ifdef::asciidoctor[Asciidoctor!]
endif::theme[]
endif::basebackend-html[]
endif::[]

The absolute data path of the Asciidoctor RubyGem

The backend determines the format of the converted output, default to html5

The default document type Can influence markup generated by the converters

Default extensions for the respective base backends

Default page widths for calculating absolute widths

Matches a comma or semi-colon delimiter.

Examples

one,two
three;four

Matches a definition list item.

Examples

foo::
foo:::
foo::::
foo;;

# should be followed by a definition, on the same line...

foo:: That which precedes 'bar' (see also, <<bar>>)

# ...or on a separate line

foo::
  That which precedes 'bar' (see also, <<bar>>)

# the term may be an attribute reference

{foo_term}:: {foo_def}

NOTE negative match for comment line is intentional since that isn't handled when looking for next list item QUESTION should we check for line comment in regex or when scanning the lines?

Matches a sibling definition list item (which does not include the keyed type).

Matches one or more consecutive digits on a single line.

Examples

29

Matches multiple lines of text enclosed in double quotes, capturing the quote char and text.

Examples

"I am a run-on sentence and I like
to take up multiple lines and I
still want to be matched."

Matches a single-line of text enclosed in double quotes, capturing the quote char and text.

Examples

"Who goes there?"

The endline character used for output; stored in constant table as an optimization

Matches an inline e-mail address.

doc.writer@example.com

Matches a space escaped by a backslash.

Examples

one\ two\ three

Matches a restricted (read as safe) eval expression.

Examples

"{asciidoctor-version}" >= "0.1.0"

attributes which be changed within the content of the document (but not header) because it has semantic meaning; ex. sectnums

Flag to indicate whether encoding of external strings needs to be forced to UTF-8

Flag to indicate that line length should be calculated using a unicode mode hint

Matches the block style used to designate a section title as a floating title.

Examples

[float]
= Floating Title

Matches an inline footnote macro, which is allowed to span multiple lines.

Examples

footnote:[text]
footnoteref:[id,text]
footnoteref:[id]

Matches the general block macro pattern.

Examples

gist::123456[]

StripLineWise = /A(?:s*n)?(#{CC_ALL}*?)s*z/m end

Matches an image or icon inline macro.

Examples

image:filename.png[Alt Text]
image:http://example.com/images/filename.png[Alt Text]
image:filename.png[More [Alt\] Text] (alt text becomes "More [Alt] Text")
icon:github[large]

Matches an include preprocessor directive.

Examples

include::chapter1.ad[]
include::example.txt[lines=1;2;5..10]

Matches an indexterm inline macro, which may span multiple lines.

Examples

indexterm:[Tigers,Big cats]
(((Tigers,Big cats)))
indexterm2:[Tigers]
((Tigers))

Matches an anchor (i.e., id + optional reference text) in the flow of text.

Examples

[[idname]]
[[idname,Reference Text]]
anchor:idname[]
anchor:idname[Reference Text]

Matches a bibliography anchor anywhere inline.

Examples

[[[Foo]]]

Matches an anchor (i.e., id + optional reference text) inside a section title.

Examples

Section Title [[idname]]
Section Title [[idname,Reference Text]]

Matches invalid characters in an attribute name.

Matches invalid characters in a section id.

Matches either the kbd or btn inline macro.

Examples

kbd:[F3]
kbd:[Ctrl+Shift+T]
kbd:[Ctrl+\]]
kbd:[Ctrl,T]
btn:[Save]

Matches the delimiter used for kbd value.

Examples

Ctrl + Alt+T
Ctrl,T

The absolute lib path of the Asciidoctor RubyGem

NOTE AsciiDoc Python recognizes both a preceding TAB and a space

Matches an AsciiDoc or Markdown horizontal rule or AsciiDoc page break.

Examples

''' or ' ' ' (horizontal rule)
--- or - - - (horizontal rule)
*** or * * * (horizontal rule)
<<< (page break)

Matches an AsciiDoc horizontal rule or AsciiDoc page break.

Examples

''' (horizontal rule)
<<< (page break)

NOTE JavaScript only treats ^ and $ as line boundaries in multiline regexp; . won't match newlines

Match a link or e-mail inline macro.

Examples

link:path[label]
mailto:doc.writer@example.com[]

Matches an implicit link and some of the link inline macro.

Examples

http://github.com
http://github.com[GitHub]

FIXME revisit! the main issue is we need different rules for implicit vs explicit

A Hash of regexps for lists used for dynamic access.

Matches a literal paragraph, which is a line of text preceded by at least one space.

Examples

<SPACE>Foo
<TAB>Foo

Matches the name and purpose in the manpage doctype.

Examples

asciidoctor - converts AsciiDoc source files to HTML, DocBook and other formats

Matches the title and volnum in the manpage doctype.

Examples

= asciidoctor ( 1 )

Matches an image, video or audio block macro.

Examples

image::filename.png[Caption]
video::http://youtube.com/12345[Cats vs Dogs]

Matches a menu inline macro.

Examples

menu:File[New...]
menu:View[Page Style > No Style]
menu:View[Page Style, No Style]

Matches an implicit menu inline macro.

Examples

"File > New..."

LIST_CONTEXTS = [:ulist, :olist, :dlist, :colist]

The null character to use for splitting attribute values

TODO validate use of explicit style name above ordered list (this list is for selecting an implicit style)

Matches the ordinals for each type of ordered list.

Matches an ordered list item (explicit numbering or up to 5 consecutive dots).

Examples

. Foo
.. Foo
1. Foo (arabic, default)
a. Foo (loweralpha)
A. Foo (upperalpha)
i. Foo (lowerroman)
I. Foo (upperroman)

NOTE leading space match is not always necessary, but is used for list reader NOTE we know trailing (.*) will match at least one character because we strip trailing spaces

Matches several variants of the passthrough inline macro, which may span multiple lines.

Examples

+++text+++
$$text$$
pass:quotes[text]

Matches an inline passthrough value, which may span multiple lines.

Examples

+text+
`text` (compat)

NOTE we always capture the attributes so we know when to use compatible (i.e., legacy) behavior

NOTE in Ruby 1.8.7, [^\] does not match start of line, so we need to match it explicitly order is significant

The absolute root path of the Asciidoctor RubyGem

alias the RUBY_ENGINE constant inside the Asciidoctor namespace

Matches the revision info line, which appears immediately following the author info line beneath the document title.

Examples

v1.0, 2013-01-01: Ring in the new year release

Flag to indicate whether gsub can use a Hash to map matches to replacements

Matches the underline in a two-line (Setext-style) section title.

Examples

======  || ------ || ~~~~~~ || ^^^^^^ || ++++++

Matches the restricted section name for a two-line (Setext-style) section title. The name cannot begin with a dot and has at least one alphanumeric character.

Matches a space delimiter that's not escaped.

Examples

one two three   four

Matches a stem (and alternatives, asciimath and latexmath) inline macro, which may span multiple lines.

Examples

stem:[x != 0]
asciimath:[x != 0]
latexmath:[\sqrt{4} = 2]

Matches a + or - modifier in a subs list

String for matching tab character

Regexp for replacing tab character

Matches a trailing tag directive in an include file.

Examples

// tag::try-catch[]
try {
  someMethod();
catch (Exception e) {
  log(e);
}
// end::try-catch[]

Matches the TOC block macro.

Examples

toc::[]
toc::[levels=2]

Matches one or more consecutive digits at the end of a line.

Examples

docbook45
html5

Matches any character with multibyte support explicitly enabled (length of multibyte char = 1)

NOTE If necessary to hide use of the language modifier (u) from JavaScript, use (Regexp.new '.', false, 'u')

Matches an unordered list item (one level for hyphens, up to 5 levels for asterisks).

Examples

* Foo
- Foo

NOTE we know trailing (.*) will match at least one character because we strip trailing spaces

Detects strings that resemble URIs.

Examples

http://domain
https://domain
file:///path
data:info

not c:/sample.adoc or c:\sample.adoc

Detects the end of an implicit URI in the text

Examples

(http://google.com)
>http://google.com<
(See http://google.com):

Detects XML tags

Matches an xref (i.e., cross-reference) inline macro, which may span multiple lines.

Examples

<<id,reftext>>
xref:id[reftext]

NOTE special characters have already been escaped, hence the entity references