AsciiDoc User Guide
23 / 88
16.3 Literal Blocks
LiteralBlocks are rendered just likeliteralparagraphs. Example:
...................................
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.
If the listing style is applied to a LiteralBlock it will be rendered as a ListingBlock (this is handy if you have a listing containing
aListingBlock).
16.4 Sidebar Blocks
Asidebar is a short piece of text presented outside the narrative flow of the main text. The sidebar is normally presented inside a
bordered box to set it apart from the main text.
The sidebar body is treated like a normal section body.
Here’s an example:
.An Example Sidebar
************************************************
Any AsciiDoc SectionBody element (apart from
SidebarBlocks) can be placed inside a sidebar.
************************************************
Which will be rendered like:
An Example Sidebar
Any AsciiDoc SectionBody element (apart from SidebarBlocks) canbe placed inside a sidebar.
16.5 Comment Blocks
The contents of CommentBlocks are not processed; theyare useful for annotations and for excludingnewor outdated content that
you don’t want displayed. CommentBlocks are never written to output files. Example:
//////////////////////////////////////////
CommentBlock contents are not processed by
asciidoc(1).
//////////////////////////////////////////
See alsoCommentLines.
Note
System macros are executed inside comment blocks.
Deleting pages from pdf - SDK control service:C# PDF Page Extract Library: copy, paste, cut PDF pages in C#.net, ASP.NET, MVC, Ajax, WinForms, WPF
Easy to Use C# Code to Extract PDF Pages, Copy Pages from One PDF File and Paste into Others
www.rasteredge.com
Deleting pages from pdf - SDK control service:VB.NET PDF Page Extract Library: copy, paste, cut PDF pages in vb.net, ASP.NET, MVC, Ajax, WinForms, WPF
Detailed VB.NET Guide for Extracting Pages from Microsoft PDF Doc
www.rasteredge.com
AsciiDoc User Guide
24 / 88
16.6 Passthrough Blocks
By defaulttheblock contents is subject onlytoattributes andmacros substitutions(usean explicitsubsattributetoapply different
substitutions). PassthroughBlock content will often be backend specific. Here’s an example:
[subs="quotes"]
++++++++++++++++++++++++++++++++++++++
<table border="1"><tr>
<td>
*
Cell 1
*
</td>
<td>
*
Cell 2
*
</td>
</tr></table>
++++++++++++++++++++++++++++++++++++++
The following styles can be applied topassthrough blocks:
pass
No substitutions are performed. This is equivalent to subs="none".
asciimath, latexmath
By default no substitutions are performed, the contents are rendered asmathematicalformulas.
16.7 Quote Blocks
QuoteBlocks are used for quoted passages of text. There are two styles: quote and verse. The style behavior is identical to
quote and verse paragraphsexceptthatblockscancontainmultipleparagraphsand,inthecaseofthequotestyle,othersection
elements. The first positionalattribute sets the style, if no attributes are specified the quote style is used. The optional attribution
and citetitle attributes (positional attributes 2 and 3) specify the quote’s author and source. For example:
[quote, Sir Arthur Conan Doyle, The Adventures of Sherlock Holmes]
____________________________________________________________________
As he spoke there was the sharp sound of horses’ hoofs and
grating wheels against the curb, followed by a sharp pull at the
bell. Holmes whistled.
"A pair, by the sound," said he. "Yes," he continued, glancing
out of the window. "A nice little brougham and a pair of
beauties. A hundred and fifty guineas apiece. There’s money in
this case, Watson, if there is nothing else."
____________________________________________________________________
Which is rendered as:
As he spoke there was the sharp sound of horses’ hoofs and grating wheels against the curb, followed bya sharp pull
at the bell. Holmes whistled.
"A pair, by the sound," said he. "Yes," he continued, glancing out of the window. "A nice little brougham and a pair
of beauties. A hundred and fifty guineas apiece. There’s money in this case, Watson, if there is nothing else."
—Sir Arthur Conan Doyle The Adventures of Sherlock Holmes
16.8 Example Blocks
ExampleBlocks encapsulate the DocBook Example element and are used for, well, examples. Example blocks can be titled by
preceding them with a BlockTitle. DocBook toolchains will normally automatically number examples and generate a List of
Examples backmatter section.
Example blocks are delimited by lines of equals characters and can contain any block elements apart from Titles, BlockTitles
and Sidebars) inside an example block. For example:
SDK control service:C# PDF Page Delete Library: remove PDF pages in C#.net, ASP.NET
C#.NET PDF Library - Delete PDF Document Page in C#.NET. Provide C# Users with Mature .NET PDF Document Manipulating Library for Deleting PDF Pages in C#.
www.rasteredge.com
SDK control service:VB.NET PDF Page Delete Library: remove PDF pages in vb.net, ASP.
Document Page in VB.NET Class. Free PDF edit control and component for deleting PDF pages in Visual Basic .NET framework application.
www.rasteredge.com
AsciiDoc User Guide
25 / 88
.An example
=====================================================================
Qui in magna commodo, est labitur dolorum an. Est ne magna primis
adolescens.
=====================================================================
Renders:
Example 16.1 An example
Qui inmagna commodo, est labitur dolorum an. Est ne magna primis adolescens.
Atitle prefix that can be inserted with the caption attribute (HTML backends). For example:
[caption="Example 1: "]
.An example with a custom caption
=====================================================================
Qui in magna commodo, est labitur dolorum an. Est ne magna primis
adolescens.
=====================================================================
16.9 Admonition Blocks
The ExampleBlock definition includes a set of admonitionstyles (NOTE, TIP, IMPORTANT, WARNING, CAUTION) for gener-
atingadmonition blocks (admonitions containingmore than asingleparagraph). Just precede the ExampleBlock withan attribute
list specifying the admonition style name. For example:
[NOTE]
.A NOTE admonition block
=====================================================================
Qui in magna commodo, est labitur dolorum an. Est ne magna primis
adolescens.
. Fusce euismod commodo velit.
. Vivamus fringilla mi eu lacus.
.. Fusce euismod commodo velit.
.. Vivamus fringilla mi eu lacus.
. Donec eget arcu bibendum
nunc consequat lobortis.
=====================================================================
Renders:
ANOTE admonition block
Qui in magna commodo, est labitur dolorum an. Est ne magna primis adolescens.
1. Fusce euismod commodo velit.
2. Vivamus fringilla mi eu lacus.
a. Fusce euismod commodo velit.
b. Vivamus fringilla mi eu lacus.
3. Donec eget arcu bibendum nunc consequat lobortis.
See alsoAdmonitionIconsandCaptions.
SDK control service:C# PDF File & Page Process Library SDK for C#.net, ASP.NET, MVC
Deleting Pages. You may feel free to define some continuous PDF pages and delete. Certainly, random pages can be deleted from PDF file as well. Sorting Pages.
www.rasteredge.com
SDK control service:C# Word - Delete Word Document Page in C#.NET
C# Word - Delete Word Document Page in C#.NET. Provides Users with Mature Document Manipulating Function for Deleting Word Pages. Overview.
www.rasteredge.com
AsciiDoc User Guide
26 / 88
16.10 Open Blocks
Open blocks are special:
• The open block delimiter is line containing two hyphen characters (instead of four or more repeated characters).
• They can be used to group block elements forListitemcontinuation.
• Open blocks canbe styled to behave like anyother typeof delimited block. The followingbuilt-in styles canbe applied toopen
blocks: literal, verse, quote, listing, TIP, NOTE, IMPORTANT, WARNING, CAUTION, abstract, partintro, comment, example,
sidebar, source, music, latex, graphviz. For example, the following open block and listing block are functionally identical:
[listing]
--
Lorum ipsum ...
--
---------------
Lorum ipsum ...
---------------
• An unstyled open block groups section elements but otherwise does nothing.
Open blocks are used to generate document abstracts and book part introductions:
• Apply the abstract style to generate an abstract, for example:
[abstract]
--
In this paper we will ...
--
1. Apply the partintro style to generate a book part introduction for a multi-part book, for example:
[partintro]
.Optional part introduction title
--
Optional part introduction goes here.
--
17 Lists
L
IST TYPES
• Bulleted lists. Alsoknown as itemized or unordered lists.
• Numbered lists. Also called orderedlists.
• Labeled lists. Sometimes called variable or definition lists.
• Callout lists (a list of callout annotations).
L
IST BEHAVIOR
• List item indentation is optional and does not determine nesting, indentation does however make the source more readable.
• Another list or a literal paragraph immediately following a list item will be implicitly included in the list item; uselistitem
continuationtoexplicitlyappendotherblockelementstoalistitem.
• A comment block or a comment line block macro element will terminate a list—use inline comment lines to put comments
inside lists.
• The listindexintrinsicattribute is the current list item index (1..). If this attribute is used outside a list then it’s value is the
number of items in the most recently closed list. Useful for displaying the number of items in a list.
SDK control service:VB.NET PDF File & Page Process Library SDK for vb.net, ASP.NET
You may feel free to define some continuous PDF pages through deleting pages in VB.NET demo code. Certainly, random pages can be deleted from PDF file as well.
www.rasteredge.com
SDK control service:C# PowerPoint - Delete PowerPoint Document Page in C#.NET
C# PowerPoint - Delete PowerPoint Document Page in C#.NET. Provides Users with Mature Document Manipulating Function for Deleting PowerPoint Pages. Overview.
www.rasteredge.com
AsciiDoc User Guide
27 / 88
17.1 Bulleted Lists
Bulleted list items start with a single dash or one to five asterisks followed by some white space then some text. Bulleted list
syntaxes are:
- List item.
*
List item.
**
List item.
***
List item.
****
List item.
*****
List item.
17.2 Numbered Lists
List item numbers are explicit or implicit.
Explicit numbering List items begin with a number followed by some white space then the item text. The numbers can be
decimal (arabic), roman (upper or lower case) or alpha (upper or lower case). Decimal and alpha numbers are terminated with
aperiod, roman numbers are terminated with a closing parenthesis. The different terminators are necessary to ensure i, v and x
roman numbers are are distinguishable from x, v and x alpha numbers. Examples:
1.
Arabic (decimal) numbered list item.
a.
Lower case alpha (letter) numbered list item.
F.
Upper case alpha (letter) numbered list item.
iii) Lower case roman numbered list item.
IX) Upper case roman numbered list item.
Implicit numbering List items begin one to five period characters, followed by some white space then the item text. Examples:
. Arabic (decimal) numbered list item.
.. Lower case alpha (letter) numbered list item.
... Lower case roman numbered list item.
.... Upper case alpha (letter) numbered list item.
..... Upper case roman numbered list item.
You can use the style attribute (also the first positional attribute) to specify an alternative numbering style. The numbered list
style can be one of the following values: arabic, loweralpha, upperalpha, lowerroman, upperroman.
Here are some examples of bulleted and numbered lists:
- Praesent eget purus quis magna eleifend eleifend.
1. Fusce euismod commodo velit.
a. Fusce euismod commodo velit.
b. Vivamus fringilla mi eu lacus.
c. Donec eget arcu bibendum nunc consequat lobortis.
2. Vivamus fringilla mi eu lacus.
i)
Fusce euismod commodo velit.
ii) Vivamus fringilla mi eu lacus.
3. Donec eget arcu bibendum nunc consequat lobortis.
4. Nam fermentum mattis ante.
- Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
*
Fusce euismod commodo velit.
**
Qui in magna commodo, est labitur dolorum an. Est ne magna primis
adolescens. Sit munere ponderum dignissim et. Minim luptatum et
vel.
**
Vivamus fringilla mi eu lacus.
*
Donec eget arcu bibendum nunc consequat lobortis.
- Nulla porttitor vulputate libero.
SDK control service:VB.NET TIFF: Modify TIFF File by Adding, Deleting & Sort TIFF
Please check following TIFF page deleting methods and &ltsummary> ''' Sort TIFF document pages in designed & profession imaging controls, PDF document, image
www.rasteredge.com
SDK control service:VB.NET TIFF: An Easy VB.NET Solution to Delete or Remove TIFF File
also empowers users to insert blank pages into TIFF I have tried the function of deleting page from powerful & profession imaging controls, PDF document, image
www.rasteredge.com
AsciiDoc User Guide
28 / 88
. Fusce euismod commodo velit.
. Vivamus fringilla mi eu lacus.
[upperroman]
.. Fusce euismod commodo velit.
.. Vivamus fringilla mi eu lacus.
. Donec eget arcu bibendum nunc consequat lobortis.
Which render as:
• Praesent eget purus quis magna eleifend eleifend.
1. Fusce euismod commodo velit.
a. Fusce euismod commodo velit.
b. Vivamus fringilla mi eu lacus.
c. Donec eget arcu bibendum nunc consequat lobortis.
2. Vivamus fringilla mi eu lacus.
i. Fusce euismod commodo velit.
ii. Vivamus fringilla mi eu lacus.
3. Donec eget arcu bibendum nunc consequat lobortis.
4. Nam fermentum mattis ante.
• Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
– Fusce euismod commodo velit.
*
Qui in magna commodo, est labitur dolorum an. Est ne magna primis adolescens. Sit munere ponderum dignissim et.
Minim luptatum et vel.
*
Vivamus fringilla mi eu lacus.
– Donec eget arcu bibendum nunc consequat lobortis.
• Nulla porttitor vulputate libero.
1. Fusce euismod commodo velit.
2. Vivamus fringilla mi eu lacus.
I. Fusce euismod commodo velit.
II. Vivamus fringilla mi eu lacus.
3. Donec eget arcu bibendum nunc consequat lobortis.
Apredefined compact option is available to bulleted and numbered lists —this translates to the DocBook spacing="compact"
lists attribute which may or may not be processed by the DocBooktoolchain. Example:
[options="compact"]
- Compact list item.
- Another compact list item.
Tip
Toapply thecompact optionglobally define adocument-widecompact-option attribute, e.g. using the
-a compact-option
command-line option.
You can setthe list start number usingthe start attribute (works for HTML outputs and DocBook outputs processed by DocBook
XSL Stylesheets). Example:
[start=7]
. List item 7.
. List item 8.
SDK control service:C#: How to Delete Cached Files from Your Web Viewer
PDF pages extract, copy, paste, C#.NET rotate PDF pages, C#.NET VB.NET How-to, VB.NET PDF, VB.NET Word Visual C#.NET Developers the Ways of Deleting Cache Files.
www.rasteredge.com
SDK control service:C# PDF remove image library: remove, delete images from PDF in C#.
VB.NET comment annotate PDF, VB.NET delete PDF pages, VB.NET C# PDF - Remove Image from PDF Page. Provide C# Demo Code for Deleting and Removing Image from PDF
www.rasteredge.com
AsciiDoc User Guide
29 / 88
17.3 Labeled Lists
Labeled list items consist of one or more text labels followed by the text of the list item.
An item label begins a line with an alphanumeric character hard against the left margin and ends with two, three or four colons
or two semi-colons. A list item can have multiple labels, one per line.
The list item text consists of one or more lines of text starting after the last label (either on the same line or a new line) and can
be followed by nested List or ListParagraph elements. Item text can be optionally indented.
Here are some examples:
In::
Lorem::
Fusce euismod commodo velit.
Fusce euismod commodo velit.
Ipsum:: Vivamus fringilla mi eu lacus.
*
Vivamus fringilla mi eu lacus.
*
Donec eget arcu bibendum nunc consequat lobortis.
Dolor::
Donec eget arcu bibendum nunc consequat lobortis.
Suspendisse;;
A massa id sem aliquam auctor.
Morbi;;
Pretium nulla vel lorem.
In;;
Dictum mauris in urna.
Vivamus::: Fringilla mi eu lacus.
Donec:::
Eget arcu bibendum nunc consequat lobortis.
Which render as:
In , Lorem
Fusce euismod commodo velit.
Fusce euismod commodo velit.
Ipsum
Vivamus fringilla mi eu lacus.
• Vivamus fringilla mi eu lacus.
• Donec eget arcu bibendum nunc consequat lobortis.
Dolor
Donec eget arcu bibendum nunc consequat lobortis.
Suspendisse
Amassa id sem aliquam auctor.
Morbi
Pretium nulla vel lorem.
In
Dictum mauris in urna.
Vivamus
Fringilla mi eu lacus.
Donec
Eget arcu bibendum nunc consequat lobortis.
AsciiDoc User Guide
30 / 88
17.3.1 Horizontal labeled list style
The horizontal labeled list style (also the first positional attribute) places the list text side-by-side with the label instead of under
the label. Here is an example:
[horizontal]
*
Lorem
*
:: Fusce euismod commodo velit.
Qui in magna commodo, est
labitur dolorum an. Est ne magna primis adolescens.
Fusce euismod commodo velit.
*
Ipsum
*
:: Vivamus fringilla mi eu lacus.
- Vivamus fringilla mi eu lacus.
- Donec eget arcu bibendum nunc consequat lobortis.
*
Dolor
*
::
- Vivamus fringilla mi eu lacus.
- Donec eget arcu bibendum nunc consequat lobortis.
Which render as:
Lorem
Fusce euismod commodo velit. Qui in magna commodo, estlabitur dolorum an. Est ne magna primis
adolescens.
Fusce euismod commodo velit.
Ipsum
Vivamus fringilla mi eu lacus.
• Vivamus fringilla mi eu lacus.
• Donec eget arcu bibendum nunc consequat lobortis.
Dolor
• Vivamus fringilla mi eu lacus.
• Donec eget arcu bibendum nunc consequat lobortis.
Note
• Current PDF toolchains do not make agood job of determining the relative column widths for horizontal labeled lists.
• Nested horizontal labeledlists will generate DocBook validationerrors because theDocBook XML V4.2 DTDdoes not permit
nested informal tables (althoughDocBookXSLStylesheetsanddblatex process them correctly).
• The label width can be set as a percentage of the total width by setting the width attribute e.g.
width="10%"
17.4 Question and Answer Lists
AsciiDoc comes pre-configured with a qanda style labeled list for generating DocBook question and answer (Q&A) lists. Ex-
ample:
[qanda]
Question one::
Answer one.
Question two::
Answer two.
AsciiDoc User Guide
31 / 88
Renders:
1. Question one
Answer one.
2. Question two
Answer two.
17.5 Glossary Lists
AsciiDoc comes pre-configured with a glossary style labeled list for generating DocBook glossary lists. Example:
[glossary]
A glossary term::
The corresponding definition.
A second glossary term::
The corresponding definition.
For working examples see the article.txt and book.txt documents in the AsciiDoc ./doc distribution directory.
Note
To generate valid DocBook output glossary lists must be located in a section that uses the glossarysectionmarkuptemplate.
17.6 Bibliography Lists
AsciiDoc comes with a predefined bibliography bulleted list style generating DocBook bibliography entries. Example:
[bibliography]
.Optional list title
- [[[taoup]]] Eric Steven Raymond. ’The Art of UNIX
Programming’. Addison-Wesley. ISBN 0-13-142901-9.
- [[[walsh-muellner]]] Norman Walsh & Leonard Muellner.
’DocBook - The Definitive Guide’. O’Reilly & Associates.
1999. ISBN 1-56592-580-7.
The [[[<reference>]]] syntaxis a bibliography entry anchor, itgenerates an anchor named<reference> and addition-
ally displays [<reference>] at the anchor position. For example [[[taoup]]] generates an anchor named taoup that
displays [taoup] at the anchor position. Cite the reference from elsewhere your document using <<taoup>>, this displays a
hyperlink ([taoup]) to the corresponding bibliography entry anchor.
For working examples see the article.txt and book.txt documents in the AsciiDoc ./doc distribution directory.
Note
To generate valid DocBook output bibliography lists must be located in abibliographysection.
17.7 List Item Continuation
Another list or a literal paragraph immediately following a list item is implicitly appended to the list item; to append other block
elements toa listitem you need toexplicitlyjoin them to the list item with a list continuation(a separator line containinga single
plus character). Multiple block elements can be appended to a list item using list continuations (provided they are legal list item
children in the backend markup).
Here are some examples of list item continuations: list item one contains multiple continuations; list item two is continued with
anOpenBlockcontaining multiple elements:
AsciiDoc User Guide
32 / 88
1. List item one.
+
List item one continued with a second paragraph followed by an
Indented block.
+
.................
$ ls
*
.sh
$ mv
*
.sh ~/tmp
.................
+
List item continued with a third paragraph.
2. List item two continued with an open block.
+
--
This paragraph is part of the preceding list item.
a. This list is nested and does not require explicit item continuation.
+
This paragraph is part of the preceding list item.
b. List item b.
This paragraph belongs to item two of the outer list.
--
Renders:
1. List item one.
List item one continued with a second paragraph followed by an Indented block.
$ ls
*
.sh
$ mv
*
.sh ~/tmp
List item continued with a third paragraph.
2. List item two continued withan openblock.
This paragraph is part of the preceding list item.
a. This list is nested anddoes not require explicit item continuation.
This paragraph is part of the preceding list item.
b. List item b.
This paragraph belongs toitem two of the outer list.
18 Footnotes
The shipped AsciiDoc configuration includes three footnote inline macros:
footnote:[<text>]
Generates a footnote with text <text>.
footnoteref:[<id>,<text>]
Generates a footnote with a reference ID <id> and text <text>.
footnoteref:[<id>]
Generates a reference to the footnote with ID <id>.
Documents you may be interested
Documents you may be interested