AsciiDoc User Guide
13 / 88
8.5 Inline Elements
Inline document elementsareusedtoformattextandtoperformvarioustypesoftextsubstitution. Inlineelementsandinline
element syntax is defined in the asciidoc(1) configuration files.
Here is a list of AsciiDoc inline elements in the (default) order in which they are processed:
Special characters
These character sequences escape special characters used by the backend markup (typically <, >, and & characters). See
[specialcharacters] configuration file sections.
Quotes
Elements that markup words and phrases; usually for character formatting. See [quotes] configurationfile sections.
Special Words
Word or word phrase patterns singled out for markup without the need for further annotation. See [specialwords]
configuration file sections.
Replacements
Each replacement defines a word or word phrase pattern to search for along with corresponding replacement text. See
[replacements] configuration file sections.
Attribute references
Document attribute names enclosed in braces are replaced by the corresponding attribute value.
Inline Macros
Inline macros are replaced by the contents of parametrized configuration file sections.
9 Document Processing
The AsciiDoc source document is read and processed as follows:
1. The document Header is parsed, header parameter values are substituted into the configuration file [header] template
section which is then written to the output file.
2. Each document Section is processed and its constituent elements translated to the output file.
3. The configuration file [footer] template section is substituted and written to the output file.
When a block element is encountered asciidoc(1) determines the type of block by checking in the following order (first to
last): (section) Titles, BlockMacros, Lists, DelimitedBlocks, Tables, AttributeEntrys, AttributeLists, BlockTitles, Paragraphs.
The default paragraph definition [paradef-default] is last element to be checked.
Knowing the parsing order will help you devise unambiguous macro, list and block syntax rules.
Inline substitutions within block elements are performed in the following default order:
1. Special characters
2. Quotes
3. Special words
4. Replacements
5. Attributes
6. Inline Macros
7. Replacements2
The substitutions and substitution order performed on Title, Paragraph and DelimitedBlock elements is determined by configu-
ration file parameters.
How to create bookmarks in pdf file - add, remove, update PDF bookmarks in C#.net, ASP.NET, MVC, Ajax, WinForms, WPF
Empower Your C# Project with Rapid PDF Internal Navigation Via Bookmark and Outline
export bookmarks from pdf to excel; creating bookmarks pdf files
How to create bookmarks in pdf file - VB.NET PDF bookmark library: add, remove, update PDF bookmarks in vb.net, ASP.NET, MVC, Ajax, WinForms, WPF
Empower Your VB.NET Project with Rapid PDF Internal Navigation Via Bookmark and Outline
how to create bookmark in pdf automatically; create pdf bookmarks online
AsciiDoc User Guide
14 / 88
10 Text Formatting
10.1 Quoted Text
Words and phrases can be formatted by enclosing inline text with quote characters:
Emphasized text
Word phrases ’enclosed in single quote characters’ (acute accents) or _underline characters_ are emphasized.
Strong text
Word phrases *enclosed in asterisk characters* are rendered in a strong font (usually bold).
Monospaced text
Word phrases +enclosed in plus characters+ are rendered in a monospaced font. Word phrases `enclosed in backtick
characters` (grave accents) are also rendered in a monospaced font but in this case the enclosed text is rendered literally
and is not subject to further expansion (seeinlineliteralpassthrough ).
‘Single quoted text’
Phrases enclosedwitha `single graveaccent to the leftand asingleacuteaccent to theright’ arerenderedinsingle quotation
marks.
“Double quoted text”
Phrases enclosed with ``two grave accents to the left and two acute accents to the right” are rendered in quotation marks.
Unquoted text
Placing #hashes around text# does nothing, it is a mechanism to allow inline attributes to be applied to otherwise unfor-
matted text.
New quote types can be defined by editing asciidoc(1) configuration files. See theConfigurationFilessection for details.
Q
UOTED TEXT BEHAVIOR
• Quoting cannot be overlapped.
• Different quotingtypes can be nested.
• To suppress quoted text formatting place a backslash character immediately in front of the leading quote character(s). In the
case of ambiguity between escaped and non-escaped text you will need to escape both leading and trailing quotes, in the case
of multi-character quotes you may even need to escape individual characters.
10.1.1 Quoted text attributes
Quoted text can be prefixed with anattributelist. The first positional attribute (role attribute) is translated by AsciiDoc to an
HTML span element class attribute or a DocBook phrase element role attribute.
DocBook XSL Stylesheets translate DocBook phrase elements with role attributes to corresponding HTML span elements with
the same class attributes; CSS can then be usedtostylethegeneratedHTML . Thus CSS styling can be applied to both DocBook
and AsciiDoc generated HTML outputs. You can also specify multiple class names separated by spaces.
CSS rules for text color, text background color, text size and text decorators are included in the distributed AsciiDoc CSS files
and are used in conjunction with AsciiDoc xhtml11, html5 and docbook outputs. The CSS class names are:
• <color> (text foreground color).
• <color>-background (text background color).
• big and small (text size).
• underline, overline and line-through (strike through) text decorators.
VB.NET PDF File Compress Library: Compress reduce PDF size in vb.
Bookmarks. below is mainly to optimize PDF file with multiple String outputFilePath = Program.RootPath + "\\" 3_optimized.pdf"; 'create optimizing options
excel hyperlink to pdf bookmark; create bookmarks pdf file
C# PDF File Split Library: Split, seperate PDF into multiple files
Split PDF file by top level bookmarks. The following C# codes explain how to split a PDF file into multiple ones by PDF bookmarks or outlines.
create bookmark in pdf automatically; delete bookmarks pdf
AsciiDoc User Guide
15 / 88
Where <color> can be any of thesixteenHTMLcolornames. Examples:
[red]#Obvious# and [big red yellow-background]
*
very obvious
*
.
[underline]#Underline text#, [overline]#overline text# and
[blue line-through]
*
bold blue and line-through
*
.
is rendered as:
Obvious and veryobvious.
Underline text, overline text and bold blue and line-through.
Note
Color and text decorator attributes are rendered for XHTML and HTML 5 outputs using CSS stylesheets. The mechanism to
implement color and text decorator attributes is providedfor DocBook toolchains viathe DocBook phrase element role attribute,
but the actual rendering is toolchain specific and is not part of the AsciiDoc distribution.
10.1.2 Constrained and Unconstrained Quotes
There are actually two types of quotes:
Constrained quotes
Quoted must be bounded by white space or commonly adjoining punctuation characters. These are the most commonly used
type of quote.
Unconstrained quotes
Unconstrained quotes have no boundaryconstraints and can be placed anywhere within inline text. For consistency and to make
them easier to remember unconstrained quotes are double-ups of the _,
*
,+ and # constrained quotes:
__unconstrained emphasized text__
**
unconstrained strong text
**
++unconstrained monospaced text++
##unconstrained unquoted text##
The following example emboldens the letter F:
**
F
**
ile Open...
10.2 Superscripts and Subscripts
Put ˆcarets on eitherˆ side of the text to be superscripted, put ~tildes on either side~ of text to be subscripted. For example, the
following line:
e^&#960;i^+1 = 0. H~2~O and x^10^. Some ^super text^
and ~some sub text~
Is rendered like:
e
pi
+1 = 0. H
2
Oand x
10
.Some
super text
and
some subtext
Superscripts and subscripts are implemented asunconstrainedquotes and they can be escaped with a leading backslash and
prefixed with with an attribute list.
VB.NET PDF File Split Library: Split, seperate PDF into multiple
how to split a PDF file into multiple ones by PDF bookmarks or outlines. value for each index: 1 to (Page Count - 1). ' Create output PDF file path list
create pdf with bookmarks from word; add bookmark pdf file
C# PDF File Compress Library: Compress reduce PDF size in C#.net
Bookmarks. below is mainly to optimize PDF file with multiple String outputFilePath = Program.RootPath + "\\" 3_optimized.pdf"; // create optimizing options
create bookmarks in pdf from excel; copy pdf bookmarks
AsciiDoc User Guide
16 / 88
10.3 Line Breaks
Aplus character preceded by at least one space character at the end of a non-blank line forces a line break. It generates a
line break (br) tag for HTML outputs and a custom XML asciidoc-br processing instruction for DocBook outputs. The
asciidoc-br processing instruction is handled bya2x(1).
10.4 Page Breaks
Aline of three or more less-than (<<<) characters will generate a hard page break in DocBook and printed HTML outputs. It
uses the CSS page-break-after property for HTML outputs and a custom XML asciidoc-pagebreak processing
instruction for DocBook outputs. The asciidoc-pagebreak processing instruction is handled bya2x(1). Hard page breaks
are sometimes handy but as a general rule you should let your page processor generate page breaks for you.
10.5 Rulers
Aline of three or more apostrophe characters will generate a ruler line. It generates a ruler (hr) tag for HTML outputs and
acustom XML asciidoc-hr processing instruction for DocBook outputs. The asciidoc-hr processing instruction is
handled bya2x(1).
10.6 Tabs
By default tab characters input files will translated to 8 spaces. Tab expansion is set with the tabsize entry in the configuration
file [miscellaneous] section and can be overridden in included files by setting a tabsize attribute in the include macro’s
attribute list. For example:
include::addendum.txt[tabsize=2]
The tab size can also be set using the attribute command-line option, for example --attribute tabsize=4
10.7 Replacements
The following replacements are defined in the default AsciiDoc configuration:
(C) copyright, (TM) trademark, (R) registered trademark,
-- em dash, ... ellipsis, -> right arrow, <- left arrow, => right
double arrow, <= left double arrow.
Which are rendered as:
©copyright, ™ trademark, ® registered trademark, —em dash, .. . ellipsis, ! right arrow,   left arrow, ) right double arrow,
(left double arrow.
You can also include arbitrary entity references in the AsciiDoc source. Examples:
&#x278a; &#182;
renders:
˚¶
To render a replacement literally escape it with a leading back-slash.
TheConfigurationFilessection explains how to configure your own replacements.
C# Create PDF Library SDK to convert PDF from other file formats
Create multipage PDF from OpenOffice and CSV file. Create and save editable PDF with a blank page, bookmarks, links, signatures, etc.
adding bookmarks in pdf; how to bookmark a pdf page
VB.NET Create PDF Library SDK to convert PDF from other file
Create multipage PDF from OpenOffice and CSV file. Create and save editable PDF with a blank page, bookmarks, links, signatures, etc.
bookmark pdf documents; auto bookmark pdf
AsciiDoc User Guide
17 / 88
10.8 Special Words
Words defined in [specialwords] configuration file sections are automatically marked up without having to be explicitly
notated.
TheConfigurationFilessection explains how to add and replace special words.
11 Titles
Document and section titles can be in either of two formats:
11.1 Two line titles
Atwo linetitle consists of atitle line, starting hardagainst the leftmargin, and anunderline. Sectionunderlines consista repeated
character pairs spanning the width of the preceding title (give or take up to two characters):
The default title underlines for each of the document levels are:
Level 0 (top level):
======================
Level 1:
----------------------
Level 2:
~~~~~~~~~~~~~~~~~~~~~~
Level 3:
^^^^^^^^^^^^^^^^^^^^^^
Level 4 (bottom level):
++++++++++++++++++++++
Examples:
Level One Section Title
-----------------------
Level 2 Subsection Title
~~~~~~~~~~~~~~~~~~~~~~~~
11.2 One line titles
One line titles consist of a single line delimited on either side by one or more equals characters (the number of equals characters
corresponds to the section level minus one). Here are some examples:
= Document Title (level 0) =
== Section title (level 1) ==
=== Section title (level 2) ===
==== Section title (level 3) ====
===== Section title (level 4) =====
Note
• One or more spaces must fall between the title and the delimiters.
• The trailing title delimiter is optional.
• The one-line title syntax can be changed by editing the configuration file
[titles]
section
sect0
...
sect4
entries.
.NET PDF SDK - Description of All PDF Processing Control Feastures
page navigation, zooming & rotation; Outlines, bookmarks, & thumbnail Create PDF from Jpeg images; Create PDF from CSV. to Jpeg images; More about PDF Conversion
export pdf bookmarks; export pdf bookmarks to text
C# PDF Convert to HTML SDK: Convert PDF to html files in C#.net
by C#.NET PDF to HTML converter toolkit SDK, preserves all the original anchors, links, bookmarks and font style that are included in target PDF document file.
editing bookmarks in pdf; pdf reader with bookmarks
AsciiDoc User Guide
18 / 88
11.3 Floating titles
Setting the title’s first positional attribute or style attribute to float generates a free-floating title. A free-floating title is rendered
just like a normal section title but is not formally associated with a text body and is not part of the regular section hierarchy so
the normal ordering rules do not apply. Floating titles can also be used in contexts where section titles are illegal: for example
sidebar and admonition blocks. Example:
[float]
The second day
~~~~~~~~~~~~~~
Floating titles do not appear in a document’s table of contents.
12 Block Titles
ABlockTitle element is a single line beginning witha period followed by the titletext. ABlockTitle is appliedtotheimmediately
following Paragraph, DelimitedBlock, List, Table or BlockMacro. For example:
.Notes
- Note 1.
- Note 2.
is rendered as:
N
OTES
• Note 1.
• Note 2.
13 BlockId Element
ABlockId is a single line block element containing a unique identifier enclosed in double square brackets. It is used to assign an
identifier to the ensuing block element. For example:
[[chapter-titles]]
Chapter titles can be ...
The precedingexampleidentifiestheensuingparagraphsoit canbe referencedfrom otherlocations, forexample with<<chapter-titles,chapter
titles>>.
BlockId elementscanbe appliedtoTitle, Paragraph, List, DelimitedBlock, TableandBlockMacroelements. TheBlockIdelement
sets the {id} attribute for substitutionin the subsequent block’s markup template. If a secondpositional argument is supplied it
sets the {reftext} attribute which is used to set the DocBook xreflabel attribute.
The BlockId element has the same syntax and serves the same function to theanchorinlinemacro.
14 AttributeList Element
An AttributeList block element is anattributeliston a line by itself:
• AttributeList attributes are only applied to the immediately following block element— the attributes are made available to the
block’s markuptemplate.
• Multiple contiguous AttributeList elements are additively combined in the order they appear.
• The first positional attribute in the list is oftenused to specifythe ensuing element’sstyle.
AsciiDoc User Guide
19 / 88
14.1 Attribute value substitution
By default, onlysubstitutions that takeplace insideattributelistvaluesareattributereferences, this is because not all attributes are
destined to be marked up and rendered as text (for example the table cols attribute). To perform normal inline text substitutions
(special characters, quotes, macros, replacements) on an attribute value you need to enclose it in single quotes. In the following
quote block the second attribute value in the AttributeList is quoted to ensure the http macro is expanded to a hyperlink.
[quote,’http://en.wikipedia.org/wiki/Samuel_Johnson[Samuel Johnson]’]
_____________________________________________________________________
Sir, a woman’s preaching is like a dog’s walking on his hind legs. It
is not done well; but you are surprised to find it done at all.
_____________________________________________________________________
14.2 Common attributes
Most block elements support the following attributes:
Name
Backends
Description
id
html4, html5,
xhtml11,
docbook
Unique identifier typically serve as link targets. Can also be set by the BlockId
element.
role
html4, html5,
xhtml11,
docbook
Role contains a string used to classify or subclassify an element and can be applied
to AsciiDoc block elements. The AsciiDoc role attribute is translated to the role
attribute in DocBook outputs and is includedin the class attribute in HTML
outputs, inthis respect it behaves like thequotedtextroleattribute.
DocBook XSL Stylesheets translate DocBook role attributes to HTML class
attributes; CSS can then be usedtostylethegeneratedHTML .
reftext
docbook
reftext is used to set the DocBook xreflabel attribute. The reftext attribute can an
also be set by the BlockId element.
15 Paragraphs
Paragraphs are blocks of text terminated by a blank line, the end of file, or the start of a delimited block or a list. There are three
paragraph syntaxes: normal, indented (literal) and admonition which are rendered, by default, with the corresponding paragraph
style.
Each syntax has a default style, but you can explicitly apply any paragraph style to any paragraph syntax. You can also apply
delimited blockstylestosingleparagraphs.
The built-in paragraph styles are: normal, literal, verse, quote, listing, TIP, NOTE, IMPORTANT, WARNING, CAUTION, ab-
stract, partintro, comment, example, sidebar, source, music, latex, graphviz.
15.1 normal paragraph syntax
Normal paragraphsyntax consists of one or more non-blank lines of text. The first line must starthard against the left margin(no
intervening white space). The default processing expectation is that of a normal paragraph of text.
15.2 literal paragraph syntax
Literal paragraphs are rendered verbatim in a monospaced font without any distinguishing background or border. By default
there is no text formatting or substitutions within Literal paragraphs apart from Special Characters and Callouts.
The literal style is applied implicitly to indented paragraphs i.e. where the first line of the paragraph is indented by one or more
space or tab characters. For example:
AsciiDoc User Guide
20 / 88
Consul
*
necessitatibus
*
per id,
consetetur, eu pro everti postulant
homero verear ea mea, qui.
Renders:
Consul
*
necessitatibus
*
per id,
consetetur, eu pro everti postulant
homero verear ea mea, qui.
Note
Becauselists can be indented it’s possible for your indented paragraph to be misinterpreted as a list —in situations like this
apply the literal style to a normal paragraph.
Instead of using a paragraph indent you could apply the literal style explicitly, for example:
[literal]
Consul
*
necessitatibus
*
per id,
consetetur, eu pro everti postulant
homero verear ea mea, qui.
Renders:
Consul
*
necessitatibus
*
per id,
consetetur, eu pro everti postulant
homero verear ea mea, qui.
15.3 quote and verse paragraph styles
The optional attribution and citetitle attributes (positional attributes 2 and 3) specify the author and source respectively.
The verse style retains the line breaks, for example:
[verse, William Blake, from Auguries of Innocence]
To see a world in a grain of sand,
And a heaven in a wild flower,
Hold infinity in the palm of your hand,
And eternity in an hour.
Which is rendered as:
To see a worldin a grain of sand,
And a heaven in a wild flower,
Hold infinity in the palm of your hand,
And eternity in an hour.
—William Blake fromAuguries of Innocence
The quote style flows the text at left and right margins, for example:
[quote, Bertrand Russell, The World of Mathematics (1956)]
A good notation has subtlety and suggestiveness which at times makes
it almost seem like a live teacher.
Which is rendered as:
Agood notationhas subtlety and suggestiveness which at times makes it almost seem like a live teacher.
—Bertrand Russell The World of Mathematics (1956)
AsciiDoc User Guide
21 / 88
15.4 Admonition Paragraphs
TIP, NOTE, IMPORTANT, WARNING and CAUTION admonishment paragraph styles are generated by placing NOTE:, TIP:,
IMPORTANT:, WARNING: or CAUTION: as the first word of the paragraph. For example:
NOTE: This is an example note.
Alternatively, you can specify the paragraph admonition style explicitly using anAttributeListelement. For example:
[NOTE]
This is an example note.
Renders:
Note
This is an example note.
Tip
If your admonition requires more than a single paragraph use anadmonitionblock instead.
15.4.1 Admonition Icons and Captions
Note
Admonition customization with
icons
,
iconsdir
,
icon
and
caption
attributes does not applywhen generatingDocBook
output. If you are going theDocBook routethen thea2x(1)
--no-icons
and
--icons-dir
options can be used to set the
appropriate XSL Stylesheets parameters.
By default the asciidoc(1) HTML backends generate textcaptions insteadof admonitioniconimage links. Togenerate links
to icon images define theicons attribute, for example using the -a icons command-line option.
Theiconsdir attribute sets the location of linked icon images.
You can override the default icon image using the icon attribute to specify the path of the linkedimage. For example:
[icon="./images/icons/wink.png"]
NOTE: What lovely war.
Use the caption attribute to customize the admonition captions (not applicable to docbook backend). The following ex-
ample suppresses the icon image and customizes the caption of a NOTE admonition (undefining the icons attribute with
icons=None is only necessary ifadmonitioniconshave been enabled):
[icons=None, caption="My Special Note"]
NOTE: This is my special note.
This subsection also applies toAdmonitionBlocks.
16 Delimited Blocks
Delimited blocks are blocks of text enveloped by leading and trailing delimiter lines (normally a series of four or more repeated
characters). The behavior of Delimited Blocks is specified by entries in configuration file [blockdef-
*
]sections.
AsciiDoc User Guide
22 / 88
16.1 Predefined Delimited Blocks
AsciiDocships witha number of predefinedDelimitedBlocks (seetheasciidoc.confconfigurationfileinthe asciidoc(1)
program directory):
Predefined delimited block underlines:
CommentBlock:
//////////////////////////
PassthroughBlock: ++++++++++++++++++++++++++
ListingBlock:
--------------------------
LiteralBlock:
..........................
SidebarBlock:
**************************
QuoteBlock:
__________________________
ExampleBlock:
==========================
OpenBlock:
--
Table 3: Default DelimitedBlock substitutions
Attributes
Callouts
Macros
Quotes
Replacements
Special
chars
Special
words
PassthroughBlock
Yes
No
Yes
No
No
No
No
ListingBlock
No
Yes
No
No
No
Yes
No
LiteralBlock
No
Yes
No
No
No
Yes
No
SidebarBlock
Yes
No
Yes
Yes
Yes
Yes
Yes
QuoteBlock
Yes
No
Yes
Yes
Yes
Yes
Yes
ExampleBlock
Yes
No
Yes
Yes
Yes
Yes
Yes
OpenBlock
Yes
No
Yes
Yes
Yes
Yes
Yes
16.2 Listing Blocks
ListingBlocks are renderedverbatim in amonospaced font, theyretainline andwhitespaceformattingand are often distinguished
by a background or border. There is no text formatting or substitutions within Listing blocks apart from Special Characters and
Callouts. Listing blocks are often used for computer output and file listings.
Here’s an example:
--------------------------------------
#include <stdio.h>
int main() {
printf("Hello World!\n");
exit(0);
}
--------------------------------------
Which will be rendered like:
#include <stdio.h>
int main() {
printf("Hello World!\n");
exit(0);
}
By conventionfilterblocksuse the listing block syntax and are implemented as distinct listing block styles.
Documents you may be interested
Documents you may be interested