devexpress pdf viewer control asp.net : Delete page from pdf Library software class asp.net winforms html ajax asciidoc1-part986

AsciiDoc User Guide
3/ 88
html4
This backend generates plain HTML 4.01 Transitional markup.
xhtml11
This backend generates XHTML 1.1 markup styled with CSS2. Output files have an .html extension.
html5
This backend generates HTML 5 markup, apart from the inclusion ofaudioandvideoblockmacros it is functionally
identical to the xhtml11 backend.
slidy
Usethis backendto generateself-containedSlidyHTML slideshows for your webbrowser from AsciiDocdocuments. The
Slidy backend is documented in the distribution doc/slidy.txt file andonline.
wordpress
Aminor variant of the html4 backend to supportblogpost.
latex
Experimental LaTeX backend.
4.1 Backend Aliases
Backend aliases are alternative names for AsciiDoc backends. AsciiDoc comes with two backend aliases: html (aliased to
xhtml11) and docbook (aliased todocbook45).
You can assign (or reassign) backend aliases by setting an AsciiDoc attribute named like backend-alias-<alias> to an
AsciiDoc backend name. For example, the following backend alias attribute definitions appear in the [attributes] section
of the global asciidoc.conf configuration file:
backend-alias-html=xhtml11
backend-alias-docbook=docbook45
4.2 Backend Plugins
The asciidoc(1) --backend option is also used to install and manage backendplugins.
• A backend plugin is used just like the built-in backends.
• Backend pluginstakeprecedence over built-in backends with the same name.
• You can use the {asciidoc-confdir}intrinsicattribute to refer to the built-in backend configuration file location from
backend plugin configuration files.
• You can use the {backend-confdir}intrinsicattribute to refer to the backend plugin configuration file location.
• By default backends plugins are installed in $HOME/.asciidoc/backends/<backend> where <backend> is the
backend name.
5 DocBook
AsciiDoc generates article, book and refentryDocBookdocuments (corresponding to the AsciiDoc article, book and manpage
document types).
Most Linux distributions come with conversion tools (collectively called a toolchain) forconvertingDocBookfiles to presenta-
tion formats such as Postscript, HTML, PDF, EPUB, DVI, PostScript, LaTeX, roff (the native man page format), HTMLHelp,
JavaHelp and text. There are also programs that allow you to view DocBook files directly, for exampleYelp(the GNOME help
viewer).
Delete page from pdf - Library software class: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
Delete page from pdf - Library software class: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
4/ 88
5.1 Converting DocBook to other file formats
DocBook files are validated, parsed and translated various presentation file formats using a combination of applications collec-
tively called a DocBook tool chain. The function of a tool chain is to read the DocBook markup (produced by AsciiDoc) and
transform it to a presentation format (for example HTML, PDF, HTML Help, EPUB, DVI, PostScript, LaTeX).
Awide range of user output format requirements coupled with a choice of available tools and stylesheets results in many valid
tool chain combinations.
5.2 a2x Toolchain Wrapper
One of the biggest hurdles for new users is installing, configuring and usinga DocBook XML toolchain. a2x(1) canhelp— it’s
atoolchain wrapper command that will generate XHTML (chunked and unchunked), PDF, EPUB, DVI, PS, LaTeX, man page,
HTML Help and text file outputs from an AsciiDoc text file. a2x(1) does all the grunt work associated with generating and
sequencing the toolchain commands and managing intermediate and output files. a2x(1) also optionally deploys admonition
and navigation icons and a CSS stylesheet. See the a2x(1) man page for more details. In addition to asciidoc(1) you
also needxsltproc(1),DocBookXSLStylesheetsand optionally:dblatex orFOP (to generate PDF); w3m(1) or lynx(1) (to
generate text).
The following examples generate doc/source-highlight-filter.pdffrom theAsciiDocdoc/source-highlight-filter.txt
source file. The first example uses dblatex(1) (the default PDF generator) the second example forces FOP to be used:
$ a2x -f pdf doc/source-highlight-filter.txt
$ a2x -f pdf --fop doc/source-highlight-filter.txt
See the a2x(1) man page for details.
Tip
Use the
--verbose
command-line option to view executed toolchain commands.
5.3 HTML generation
AsciiDoc produces nicely styled HTML directly without requiring a DocBook toolchain but there are also advantages in going
the DocBook route:
• HTML from DocBook can optionally include automatically generated indexes, tables of contents, footnotes, lists of figures
and tables.
• DocBook toolchains can also (optionally) generate separate (chunked) linked HTML pages for each document section.
• Toolchain processing performs link and document validity checks.
• If the DocBook lang attribute is set then things like table of contents, figure and table captions and admonition captions will
be output in the specified language (setting the AsciiDoc lang attribute sets the DocBook langattribute).
On the other hand, HTML outputdirectly from AsciiDoc is much faster, is easily customizedand can be used insituations where
there is no suitable DocBook toolchain (for example, see theAsciiDocwebsite).
5.4 PDF generation
There are two commonly used tools to generate PDFs from DocBook,dblatex andFOP.
DBLATEX OR
FOP?
• dblatex is easier to install, there’s zero configuration required andno Java VM to install—it just works out of the box.
Library software class:VB.NET PDF Page Delete Library: remove PDF pages in vb.net, ASP.
Home ›› XDoc.PDF ›› VB.NET PDF: Delete PDF Page. This page is aimed to help you learn how to delete page from your PDF document in VB.NET application.
www.rasteredge.com
Library software class:C# PDF Page Delete Library: remove PDF pages in C#.net, ASP.NET
Pages. |. Home ›› XDoc.PDF ›› C# PDF: Delete PDF Page. Demo Code: How to Delete a Single PDF Page from PDF File in C#.NET. How
www.rasteredge.com
AsciiDoc User Guide
5/ 88
• dblatex source code highlighting and numbering is superb.
• dblatex is easier to use as it converts DocBook directly to PDF whereas before using FOP you have to convert DocBook to
XML-FO usingDocBookXSLStylesheets.
• FOP is more feature complete (for example, callouts are processed inside literal layouts) and arguably produces nicer looking
output.
5.5 HTML Help generation
1. Convert DocBook XML documents to HTML Helpcompiler source files usingDocBookXSLStylesheetsandxsltproc(1).
2. Convert the HTML Help source (.hhp and .html) files to HTML Help (.chm) files using theMicrosoftHTMLHelp
Compiler.
5.6 Toolchain components summary
AsciiDoc
Converts AsciiDoc (.txt) files to DocBook XML (.xml) files.
DocBook XSL Stylesheets
Theseare asetof XSL stylesheetscontainingrulesfor convertingDocBookXML documents toHTML, XSL-FO, manpage
and HTML Help files. The stylesheets are used in conjunction with an XML parser such asxsltproc(1).
xsltproc
An XML parser for applying XSLT stylesheets (in our case theDocBookXSLStylesheets) to XML documents.
dblatex
Generates PDF, DVI, PostScriptandLaTeXformats directly from DocBook source viathe intermediate LaTeX typesetting
language— usesDocBookXSLStylesheets,xsltproc(1)and latex(1).
FOP
The Apache Formatting Objects Processor converts XSL-FO (.fo) files to PDF files. The XSL-FO files are generated
from DocBook source files usingDocBookXSLStylesheetsandxsltproc(1).
Microsoft Help Compiler
TheMicrosoft HTML Help Compiler (hhc.exe) is a command-line tool thatconverts HTML Help sourcefiles toa single
HTML Help (.chm) file. It runs on MS Windows platforms and can be downloaded fromhttp://www.microsoft.com .
5.7 AsciiDoc dblatex configuration files
The AsciiDoc distribution ./dblatex directory contains asciidoc-dblatex.xsl (customized XSL parameter settings)
and asciidoc-dblatex.sty (customized LaTeX settings). These are examples of optionaldblatex output customization
and are used bya2x(1).
5.8 AsciiDoc DocBook XSL Stylesheets drivers
You willhavenoticedthat thedistributed HTML andHTML Help documentationfiles (for example ./doc/asciidoc.html)
are not the plain outputs produced using the defaultDocBook XSL Stylesheets configuration. This is because they have been pro-
cessedusingcustomizedDocBook XSLStylesheetsalong with (inthe caseof HTML outputs) the custom ./stylesheets/docbook-xsl.css
CSS stylesheet.
You’ll find the customized DocBook XSL drivers along with additional documentation in the distribution ./docbook-xsl
directory. The examples that followare executed from the distribution documentation (./doc) directory. These drivers are also
used bya2x(1).
Library software class:C# PDF File & Page Process Library SDK for C#.net, ASP.NET, MVC
C# File: Merge PDF; C# File: Split PDF; C# Page: Insert PDF pages; C# Page: Delete PDF pages; C# Read: PDF Text Extract; C# Read: PDF
www.rasteredge.com
Library software class:C# PDF Page Insert Library: insert pages into PDF file in C#.net
page processing functions, such as how to merge PDF document files by C# code, how to rotate PDF document page, how to delete PDF page using C# .NET, how to
www.rasteredge.com
AsciiDoc User Guide
6/ 88
common.xsl
Shared driver parameters. This file is not used directly but is included in all the following drivers.
chunked.xsl
Generate chunked XHTML (separate HTML pages for each document section) in the ./doc/chunked directory. For
example:
$ python ../asciidoc.py -b docbook asciidoc.txt
$ xsltproc --nonet ../docbook-xsl/chunked.xsl asciidoc.xml
epub.xsl
Used bya2x(1)to generate EPUB formatted documents.
fo.xsl
Generate XSL Formatting Object (.fo) files for subsequent PDF file generation using FOP. For example:
$ python ../asciidoc.py -b docbook article.txt
$ xsltproc --nonet ../docbook-xsl/fo.xsl article.xml > article.fo
$ fop article.fo article.pdf
htmlhelp.xsl
Generate Microsoft HTML Help source files for the MS HTML HelpCompiler in the ./doc/htmlhelp directory. This
example is run on MS Windows from a Cygwin shell prompt:
$ python ../asciidoc.py -b docbook asciidoc.txt
$ xsltproc --nonet ../docbook-xsl/htmlhelp.xsl asciidoc.xml
$ c:/Program\ Files/HTML\ Help\ Workshop/hhc.exe htmlhelp.hhp
manpage.xsl
Generate a roff(1) format UNIX man page from a DocBook XML refentry document. This example generates an
asciidoc.1 man page file:
$ python ../asciidoc.py -d manpage -b docbook asciidoc.1.txt
$ xsltproc --nonet ../docbook-xsl/manpage.xsl asciidoc.1.xml
xhtml.xsl
Convert a DocBook XML file to a single XHTML file. For example:
$ python ../asciidoc.py -b docbook asciidoc.txt
$ xsltproc --nonet ../docbook-xsl/xhtml.xsl asciidoc.xml > asciidoc.html
If you want to see how the complete documentation set is processed take a look at the A-A-P script ./doc/main.aap.
6 Generating Plain Text Files
AsciiDoc does not have a text backend (for most purposes AsciiDoc source text is fine), however you can convert AsciiDoc text
files to formatted text using the AsciiDoca2x(1)toolchain wrapper utility.
Library software class:VB.NET PDF Page Insert Library: insert pages into PDF file in vb.
PDF: Insert PDF Page. VB.NET PDF - How to Insert a New Page to PDF in VB.NET. Easy to Use VB.NET APIs to Add a New Blank Page to PDF Document in VB.NET Program.
www.rasteredge.com
Library software class:C# PDF remove image library: remove, delete images from PDF in C#.
C# File: Merge PDF; C# File: Split PDF; C# Page: Insert PDF pages; C# Page: Delete PDF pages; C# Read: PDF Text Extract; C# Read: PDF
www.rasteredge.com
AsciiDoc User Guide
7/ 88
7 HTML5 and XHTML 1.1
The xhtml11 and html5 backends embedor linkCSS and JavaScriptfiles intheir outputs, there is also athemes plugin framework.
• If the AsciiDoc linkcss attribute is defined then CSS and JavaScript files are linked to the output document, otherwise they are
embedded (the default behavior).
• The default locations for CSS and JavaScript files can be changed by setting the AsciiDoc stylesdir and scriptsdir attributes
respectively.
• The default locations for embedded and linked files differ and are calculated at different times —embedded files are loaded
when asciidoc(1) generates the output document, linked files are loaded by the browser when the user views the output
document.
• Embedded files are automatically inserted in the output files but you need to manually copy linked CSS and Javascript files
from AsciiDocconfigurationdirectoriesto the correct location relative to the output document.
Table 1: Stylesheet file locations
stylesdir attribute
Linked location (linkcss attribute
defined)
Embedded location (linkcss
attribute undefined)
Undefined (default).
Same directory as the output
document.
stylesheets subdirectory in the
AsciiDoc configuration directory (the
directory containing the backend conf
file).
Absolute or relative directory name.
Absolute or relative to the output
document.
Absolute or relative to the AsciiDoc
configuration directory (the directory
containing the backend conf file).
Table 2: JavaScript file locations
scriptsdir attribute
Linked location (linkcss attribute
defined)
Embedded location (linkcss
attribute undefined)
Undefined (default).
Same directory as the output
document.
javascripts subdirectory in the
AsciiDoc configuration directory (the
directory containing the backend conf
file).
Absolute or relative directory name.
Absolute or relative to the output
document.
Absolute or relative to the AsciiDoc
configuration directory (the directory
containing the backend conf file).
7.1 Themes
The AsciiDoc theme attribute is usedto select an alternative CSS stylesheet andto optionally include additional JavaScript code.
• Theme files reside in an AsciiDocconfigurationdirectory named themes/<theme>/ (where <theme> is the the theme
name set by the theme attribute). asciidoc(1) sets the themedir attribute to the theme directory path name.
• The theme attribute can also be set using the asciidoc(1) --theme option, the --theme option can also be used to
manage themeplugins.
Library software class:VB.NET PDF delete text library: delete, remove text from PDF file
VB.NET: Delete a Character in PDF Page. It demonstrates how to delete a character in the first page of sample PDF file with the location of (123F, 187F).
www.rasteredge.com
Library software class:VB.NET PDF remove image library: remove, delete images from PDF in
C# File: Split PDF; C# Page: Insert PDF pages; C# Page: Delete PDF pages; C# Read: PDF Text Extract; Delete image objects in selected PDF page in ASPX webpage.
www.rasteredge.com
AsciiDoc User Guide
8/ 88
• AsciiDoc ships with two themes: flask and volnitsky.
• The <theme>.css file replaces the default asciidoc.css CSS file.
• The <theme>.js file is included in addition to the default asciidoc.js JavaScript file.
• If thedata-uriattribute is defined then icons are loaded from the theme icons sub-directory if it exists (i.e. the iconsdir
attribute is set to theme icons sub-directory path).
• Embedded theme files are automatically inserted in the output files but you need to manually copy linked CSS and Javascript
files to the location of the output documents.
• Linked CSS and JavaScript theme files are linked to the same linked locations asotherCSSandJavaScriptfiles.
For example, the command-line option --theme foo (or --attribute theme=foo) will cause asciidoc(1) to
searchconfigurationfilelocations1 for a sub-directory called themes/foo containing the stylesheet foo.css and optionally
aJavaScript file name foo.js.
8 Document Structure
An AsciiDoc document consists of a series ofblockelementsstartingwith anoptional document Header, followed by anoptional
Preamble, followed by zero or more document Sections.
Almost any combination of zero or more elements constitutes a valid AsciiDoc document: documents can range from a single
sentence to a multi-part book.
8.1 Block Elements
Block elements consist of one or more lines of text and may contain other block elements.
The AsciiDoc block structure can be informally summarized as follows
1
:
Document
::= (Header?,Preamble?,Section
*
)
Header
::= (Title,(AuthorInfo,RevisionInfo?)?)
AuthorInfo
::= (FirstName,(MiddleName?,LastName)?,EmailAddress?)
RevisionInfo
::= (RevisionNumber?,RevisionDate,RevisionRemark?)
Preamble
::= (SectionBody)
Section
::= (Title,SectionBody?,(Section)
*
)
SectionBody
::= ((BlockTitle?,Block)|BlockMacro)+
Block
::= (Paragraph|DelimitedBlock|List|Table)
List
::= (BulletedList|NumberedList|LabeledList|CalloutList)
BulletedList
::= (ListItem)+
NumberedList
::= (ListItem)+
CalloutList
::= (ListItem)+
LabeledList
::= (ListEntry)+
ListEntry
::= (ListLabel,ListItem)
ListLabel
::= (ListTerm+)
ListItem
::= (ItemText,(List|ListParagraph|ListContinuation)
*
)
Where:
• ? implies zero or one occurrence, + implies one or more occurrences, * implies zero or more occurrences.
• All block elements are separated by line boundaries.
• BlockId, AttributeEntry and AttributeList blockelements (not shown) can occur almost anywhere.
1
This is arough structuralguide,not arigorous syntax definition
Library software class:C# PDF delete text Library: delete, remove text from PDF file in
C#.NET Sample Code: Delete Text from Specified PDF Page. The following demo code will show how to delete text in specified PDF page. // Open a document.
www.rasteredge.com
Library software class:C# PDF metadata Library: add, remove, update PDF metadata in C#.
Allow C# Developers to Read, Add, Edit, Update and Delete PDF Metadata in .NET Project. Remove and delete metadata from PDF file.
www.rasteredge.com
AsciiDoc User Guide
9/ 88
• There are a number of document type and backend specific restrictions imposed on the block syntax.
• The following elements cannot contain blank lines: Header, Title, Paragraph, ItemText.
• A ListParagraph is a Paragraph with its listelement option set.
• A ListContinuation is alistcontinuationelement.
8.2 Header
The Header contains document meta-data, typically title plus optional authorship and revision information:
• The Header is optional, but if it is used it must start with a documenttitle.
• Optional Author and Revision information immediately follows the header title.
• The document header must be separated from the remainder of the document by one or more blank lines and cannot contain
blank lines.
• The header can include comments.
• The header can includeattributeentries, typically doctype, lang, encoding, icons, data-uri, toc, numbered.
• Header attributes are overridden by command-line attributes.
• If the header contains non-UTF-8 characters then the encoding must precede the header (either in the document or on the
command-line).
Here’s an example AsciiDoc document header:
Writing Documentation using AsciiDoc
====================================
Joe Bloggs <jbloggs@mymail.com>
v2.0, February 2003:
Rewritten for version 2 release.
The author information line contains the author’s name optionally followed by the author’s email address. The author’s name is
formatted like:
firstname[ [middlename ]lastname][ <email>]]
i.e. a first name followed by optional middle and last names followed by an email address in that order. Multi-word first, middle
and last names can be entered using the underscore as a word separator. The email address comes last and must be enclosed in
angle <> brackets. Here a some examples of author information lines:
Joe Bloggs <jbloggs@mymail.com>
Joe Bloggs
Vincent Willem van_Gogh
If the author line does not match the above specification then the entire author line is treated as the first name.
The optional revision information line follows the author information line. The revision information can be one of two formats:
1. An optional document revision number followed by an optional revision date followed by an optional revision remark:
• If the revision number is specified it must be followed by a comma.
• The revision number must contain at least one numeric character.
• Any non-numeric characters preceding the first numeric character will be dropped.
AsciiDoc User Guide
10 / 88
• If a revision remark is specified it must be preceded by a colon. The revision remark extends from the colon up to the
next blank line, attribute entry or comment and is subject to normal text substitutions.
• If a revision number or remark has been set but the revision date has not been set then the revision date is set to the value
of the docdate attribute.
Examples:
v2.0, February 2003
February 2003
v2.0,
v2.0, February 2003: Rewritten for version 2 release.
February 2003: Rewritten for version 2 release.
v2.0,: Rewritten for version 2 release.
:Rewritten for version 2 release.
2. The revision information line can also be an RCS/CVS/SVN $Id$ marker:
• AsciiDoc extracts the revnumber, revdate, and author attributes from the $Id$ revision marker and displays them in the
document header.
• If an $Id$ revision marker is used the header author line can be omitted.
Example:
$Id: mydoc.txt,v 1.5 2009/05/17 17:58:44 jbloggs Exp $
You canoverride or set header parameters by passing revnumber, revremark, revdate, email, author, authorinitials, firstname and
lastname attributes usingthe asciidoc(1) -a (--attribute) command-line option. For example:
$ asciidoc -a revdate=2004/07/27 article.txt
Attribute entries can also be added to the header for substitution in the header template withAttributeEntryelements.
The title element in HTML outputs is set to the AsciiDoc document title, you can set it to a different value by including a title
attribute entry in the document header.
8.2.1 Additional document header information
AsciiDoc has two mechanisms for optionally including additional meta-data in the header of the output document:
docinfo configuration file sections
If aconfigurationfile section named docinfo has been loaded then it will be included in the document header. Typically
the docinfo section name will be prefixed with a + character so that it is appended to (rather than replace) other docinfo
sections.
docinfo files
Two docinfo files are recognized: one named docinfo and a second named like the AsciiDoc source file with a
-docinfo suffix. For example, if the source documentis called mydoc.txt then the document information files would
be docinfo.xmlandmydoc-docinfo.xml (for DocBook outputs) anddocinfo.html andmydoc-docinfo.html
(for HTML outputs). Thedocinfo attributes control which docinfo files are included in the output files.
The contents docinfo templates and files is dependent on the type of output:
HTML
Valid head child elements. Typically style and script elements for CSS and JavaScript inclusion.
DocBook
Valid articleinfo or bookinfo child elements. DocBook defines numerous elements for document meta-data, for example:
copyrights, document historyandauthorshipinformation. Seethe DocBook./doc/article-docinfo.xmlexample
that comes with the AsciiDoc distribution. The rendering of meta-data elements (or not) is DocBook processor dependent.
AsciiDoc User Guide
11 / 88
8.3 Preamble
The Preamble is an optional untitled section body between the document Header and the first Section title.
8.4 Sections
In addition to the document title (level 0), AsciiDoc supports four section levels: 1 (top) to 4 (bottom). Section levels are
delimited by sectiontitles. Sections are translated using configuration filesectionmarkuptemplates. AsciiDoc generates the
followingintrinsicattributes specifically for use in section markup templates:
level
The level attribute is the section level number, it is normally just the title level number (1..4). However, if the
leveloffset attribute is defined it will be added to the level attribute. The leveloffset attribute is useful
forcombiningdocuments.
sectnum
The-n(--section-numbers) command-line optiongenerates thesectnum (sectionnumber) attribute. Thesectnum
attribute is usedfor section numbers inHTML outputs (DocBook sectionnumberingarehandledautomaticallybytheDoc-
Book toolchain commands).
8.4.1 Section markup templates
Sectionmarkuptemplates specifyoutput markupandare defined in AsciiDoc configurationfiles. Sectionmarkup template names
are derived as follows (in order of precedence):
1. From thetitle’sfirst positional attribute or template attribute. For example, the following three sectiontitles are functionally
equivalent:
[[terms]]
[glossary]
List of Terms
-------------
["glossary",id="terms"]
List of Terms
-------------
[template="glossary",id="terms"]
List of Terms
-------------
2. When the title text matches a configuration file[specialsections] entry.
3. If neither of the above the default sect<level> template is used (where <level> is a number from 1 to 4).
In addition tothe normal sectiontemplate names (sect1, sect2, sect3, sect4) AsciiDochas the followingtemplates for frontmatter,
backmatter andother specialsections: abstract, preface, colophon, dedication, glossary, bibliography, synopsis, appendix, index.
These special section templates generate the corresponding Docbook elements; for HTML outputs they default to the sect1
section template.
8.4.2 Section IDs
If no explicit section ID is specified an ID will be synthesised from the section title. The primary purpose of this feature is to
ensure persistence of table of contents links (permalinks): the missing section IDs are generated dynamically by the JavaScript
TOC generator after the page is loaded. If you link to a dynamically generated TOC address the page will load but the browser
will ignore the (as yet ungenerated) section ID.
The IDs are generated by the following algorithm:
AsciiDoc User Guide
12 / 88
• Replace all non-alphanumeric title characters with underscores.
• Strip leadingor trailing underscores.
• Convert to lowercase.
• Prepend the idprefix attribute (so there’s no possibility of name clashes with existing document IDs). Prepend an under-
score if the idprefix attribute is not defined.
• A numbered suffix(_2, _3 ... ) is added if a same named auto-generated section ID exists.
• If the ascii-ids attribute is defined then non-ASCII characters are replaced with ASCII equivalents. This attribute may be
deprecated in future releases and should be avoided, it’s sole purpose is to accommodate deficient downstream applications
that cannot process non-ASCII ID attributes.
Example: the title Jim’s House would generate the ID _jim_s_house.
Section ID synthesis can be disabled by undefining the sectids attribute.
8.4.3 Special Section Titles
AsciiDoc has a mechanism for mapping predefined sectiontitles auto-magically to specific markup templates. For examplea title
Appendix A: Code Reference will automatically use the appendixsectionmarkuptemplate. The mappings from title to template
name are specified in [specialsections] sections in the Asciidoc language configuration files (lang-
*
.conf). Section
entries are formatted like:
<title>=<template>
<title> is a Python regular expression and <template> is the name of a configuration file markup template section. If the
<title> matches an AsciiDoc document section title then the backend output is marked up using the <template> markup
template (instead of the default sect<level> section template). The {title} attribute value is set to the value of the
matched regular expression group named title, if there is no title group {title} defaults to the whole of the AsciiDoc section
title. If <template> is blank then any existing entry with the same <title> will be deleted.
Special section titles vs. explicit template names
AsciiDoc has two mechanisms for specifying non-default section markup templates: you can specify the template name
explicitly (using the template attribute) or indirectly (using special section titles). Specifying asectiontemplate attribute
explicitly is preferred. Auto-magical special section titles have the following drawbacks:
• They are non-obvious, you have to know the exact matching title for each special section on a language by language
basis.
• Section titles are predefined and can only be customised with a configuration change.
• The implementationis complicatedbymultiple languages: everyspecialsection titlehas tobe defined for each language
(in each of the lang-
*
.conf files).
Specifying special section template names explicitly does add more noise to the source document (the template attribute
declaration), but the intention is obvious and the syntax is consistent with other AsciiDoc elements c.f. bibliographic,
Q&A and glossary lists.
Special section titles have been deprecated but are retained for backward compatibility.
Documents you may be interested
Documents you may be interested