module Asciidoctor

A map of file extensions that are recognized as AsciiDoc documents TODO .txt should be deprecated

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.

NOTE we only have to check as far as the blank character because we know it means non-whitespace follows. IMPORTANT if this regexp does not agree with the regexp for each list type, the parser will hang.

NOTE In JavaScript, ^ and $ match the boundaries of the string when the m flag is not set

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

{foobar} or {app_name} or {product-version}
{counter:sequence-name:1}
{set:foo:bar}
{set:name!}

Matches an Atx (single-line) section title.

Examples

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

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

Matches the delimiter that separates multiple authors.

Examples

Doc Writer; Junior Writer

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

Matches consecutive blank lines.

Examples

one

two

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 an image, video or audio block macro.

Examples

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

Matches a title above a block.

Examples

.Title goes here

Matches the TOC block macro.

Examples

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

NOTE the ‘figure’ key as a string is historical and used by image blocks

CC_ALL is any character, including newlines (must be accompanied by multiline regexp flag)

CC_ANY is any character except newlines

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)
<.> (auto-numbered)

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

Matches a callout list item.

Examples

<1> Explanation

or

<.> Explanation with automatic number

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 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::[]

Matches the custom block macro pattern.

Examples

gist::123456[]

The absolute data directory 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 description list entry.

Examples

foo::
bar:::
baz::::
blah;;

# the term may be followed by a description on the same line...

foo:: The metasyntactic variable that commonly accompanies 'bar' (see also, <<bar>>).

# ...or on a separate line, which may optionally be indented

foo::
  The metasyntactic variable that commonly accompanies 'bar' (see also, <<bar>>).

# attribute references may be used in both the term and the description

{foo-term}:: {foo-desc}

NOTE we know trailing (.*) will match at least one character because we strip trailing spaces NOTE must skip line comment when looking for next list item inside list

Matches a sibling description list item (excluding the delimiter specified by the key). NOTE must skip line comment when looking for sibling list item

Matches whitespace (space, tab, newline) escaped by a backslash.

Examples

three\ blind\ mice

Matches a restricted (read as safe) eval expression.

Examples

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

Matches an extended Atx section title that includes support for the Markdown variant.

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

Examples

''' (horizontal rule)
<<< (page break)
--- or - - - (horizontal rule, Markdown)
*** or * * * (horizontal rule, Markdown)
___ or _ _ _ (horizontal rule, Markdown)

The mode to use when opening a file for reading

The mode to use when opening a file for writing

attributes which be changed throughout the flow of the document (e.g., sectnums)

NOTE AsciiDoc.py allows + to be preceded by TAB; Asciidoctor does not

NOTE In JavaScript, ^ and $ only match the start and end of line if the multiline flag is present

Matches an include preprocessor directive.

Examples

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

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]

Scans for a non-escaped anchor (i.e., id + optional reference text) in the flow of text.

Matches a bibliography anchor at the start of the list item text (in a bibliography list).

Examples

[[[Fowler_1997]]] Fowler M. ...

Matches an inline e-mail address.

doc.writer@example.com

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

Examples

footnote:[text] (not referenceable)
footnote:id[text] (referenceable)
footnote:id[] (reference)
footnoteref:[id,text] (legacy)
footnoteref:[id] (legacy)

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]

NOTE be as non-greedy as possible by not allowing newline or left square bracket in target

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

Examples

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

Matches either the kbd or btn inline macro.

Examples

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

Match a link or e-mail inline macro.

Examples

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

NOTE be as non-greedy as possible by not allowing space or left square bracket in target

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

Examples

https://github.com
https://github.com[GitHub]
<https://github.com>
link:https://github.com[]
"https://github.com[]"

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

Matches a menu inline macro.

Examples

menu:File[Save As...]
menu:Edit[]
menu:View[Page Style > No Style]
menu:View[Page Style, No Style]

Matches an implicit menu inline macro.

Examples

"File > New..."

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

Examples

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

NOTE we have to support an empty pass:[] for compatibility with AsciiDoc.py

Matches an inline passthrough, 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

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

Examples

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

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 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 NOTE { is included in start characters to support target that begins with attribute reference in title content

Matches invalid characters in an attribute name.

Matches invalid ID characters in a section title.

NOTE uppercase chars not included since expression is only run on a lowercase string

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

The absolute lib directory of the Asciidoctor RubyGem

Scans for a leading, non-escaped anchor (i.e., id + optional reference text).

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

Maximum integer value for “boundless” operations; equal to MAX_SAFE_INTEGER in JavaScript

Matches the name of a macro.

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)
= asciidoctor ( 1 )

Matches a Markdown horizontal rule.

Examples

--- or - - -
*** or * * *
___ or _ _ _

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

NOTE order of replacements is significant

The absolute root directory of the Asciidoctor RubyGem

alias the RUBY_ENGINE constant inside the Asciidoctor namespace and define a precomputed alias for runtime

Detects if text is a possible candidate for the replacements substitution.

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

Examples

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

Matches an explicit section level style like sect1

Matches the title only (first line) of an Setext (two-line) section title. The title cannot begin with a dot and must have at least one alphanumeric character.

Matches an inline plus passthrough spanning multiple lines, but only when it occurs directly inside constrained monospaced formatting in non-compat mode.

Examples

+text+

Matches a whitespace delimiter, a sequence of spaces, tabs, and/or newlines. Matches the parsing rules of %w strings in Ruby.

Examples

one two    three   four
five      six

TODO change to /(?<!\)[ tn]+/ once lookbehind assertions are implemented in all modern browsers

Matches a + or - modifier in a subs list

String for matching 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[]

NOTE m flag is required for Asciidoctor.js

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

Examples

docbook5
html5

The mode to use when opening a URI for reading

The user’s home directory, as best we can determine it IMPORTANT this rescue is required for running Asciidoctor on GitHub.com

Alias UTF_8 encoding for convenience / speed

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 XML tags