diff options
| author | MasterOdin <matt.peveler@gmail.com> | 2021-01-28 21:52:28 +0000 |
|---|---|---|
| committer | MasterOdin <matt.peveler@gmail.com> | 2021-01-28 21:52:28 +0000 |
| commit | 7eca4168e351090ce61f28e02d537665cb4ce7d6 (patch) | |
| tree | 393e8789ca0f18245aa45060b663ade92bca3452 | |
| parent | 434dca7670d3027160602c11cfd1ae844b321de9 (diff) | |
| download | asciidoc-py3-7eca4168e351090ce61f28e02d537665cb4ce7d6.tar.gz | |
deploy: 065fd298
Signed-off-by: MasterOdin <matt.peveler@gmail.com>
103 files changed, 82 insertions, 5295 deletions
diff --git a/CHANGELOG.html b/CHANGELOG.html index eacc99d..6e137ad 100644 --- a/CHANGELOG.html +++ b/CHANGELOG.html @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<meta name="generator" content="AsciiDoc 9.0.5" />
+<meta name="generator" content="AsciiDoc 10.0.0a1" />
<title>AsciiDoc ChangeLog</title>
<link rel="stylesheet" href="./asciidoc.css" type="text/css" />
<link rel="stylesheet" href="./layout2.css" type="text/css" />
@@ -48,7 +48,7 @@ asciidoc.install(); <div class="ulist"><div class="title">Bug fixes</div><ul>
<li>
<p>
-Use config newline setting in system attribute evaulation (thanks @hoadlck)
+Use config newline setting in system attribute evaluation (thanks @hoadlck)
</p>
</li>
</ul></div>
@@ -8299,7 +8299,7 @@ Fixed error that occurred when <em>==</em> title underline was <div id="footer">
<div id="footer-text">
Version 9.0.5<br />
-Last updated 2021-01-27 22:27:28 UTC<br />
+Last updated 2021-01-28 21:51:39 UTC<br />
AsciiDoc is a trademark of the Eclipse Foundation, Inc.
</div>
<div id="footer-badges">
diff --git a/CHANGELOG.txt b/CHANGELOG.txt index 88ab7cf..08c0143 100644 --- a/CHANGELOG.txt +++ b/CHANGELOG.txt @@ -6,7 +6,7 @@ AsciiDoc ChangeLog Version 9.0.5 (2021-01-24) -------------------------- .Bug fixes -- Use config newline setting in system attribute evaulation (thanks @hoadlck) +- Use config newline setting in system attribute evaluation (thanks @hoadlck) .Testing - Update to deadsnakes/python@v2.0.2 diff --git a/INSTALL.html b/INSTALL.html index 428d2a5..b5c9667 100644 --- a/INSTALL.html +++ b/INSTALL.html @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<meta name="generator" content="AsciiDoc 9.0.5" />
+<meta name="generator" content="AsciiDoc 10.0.0a1" />
<title>AsciiDoc Installation</title>
<link rel="stylesheet" href="./asciidoc.css" type="text/css" />
<link rel="stylesheet" href="./layout2.css" type="text/css" />
@@ -265,7 +265,7 @@ Guide</em>.</p></div> <div id="footer">
<div id="footer-text">
Version 9.0.5<br />
-Last updated 2021-01-27 22:27:30 UTC<br />
+Last updated 2021-01-28 21:51:40 UTC<br />
AsciiDoc is a trademark of the Eclipse Foundation, Inc.
</div>
<div id="footer-badges">
diff --git a/README-website.html b/README-website.html index 684346a..57493c9 100644 --- a/README-website.html +++ b/README-website.html @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<meta name="generator" content="AsciiDoc 9.0.5" />
+<meta name="generator" content="AsciiDoc 10.0.0a1" />
<title>AsciiDoc Website</title>
<link rel="stylesheet" href="./asciidoc.css" type="text/css" />
<link rel="stylesheet" href="./layout2.css" type="text/css" />
@@ -102,7 +102,7 @@ browsers.</p></div> <div id="footer">
<div id="footer-text">
Version 9.0.5<br />
-Last updated 2021-01-27 22:27:30 UTC<br />
+Last updated 2021-01-28 21:51:40 UTC<br />
AsciiDoc is a trademark of the Eclipse Foundation, Inc.
</div>
<div id="footer-badges">
diff --git a/README.html b/README.html index 13092ca..7a605d2 100644 --- a/README.html +++ b/README.html @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<meta name="generator" content="AsciiDoc 9.0.5" />
+<meta name="generator" content="AsciiDoc 10.0.0a1" />
<title></title>
<link rel="stylesheet" href="./asciidoc.css" type="text/css" />
<link rel="stylesheet" href="./layout2.css" type="text/css" />
@@ -130,7 +130,7 @@ Public License version 2 (GPLv2).</p></div> <div id="footer">
<div id="footer-text">
Version 9.0.5<br />
-Last updated 2021-01-27 22:27:31 UTC<br />
+Last updated 2021-01-28 21:51:40 UTC<br />
AsciiDoc is a trademark of the Eclipse Foundation, Inc.
</div>
<div id="footer-badges">
@@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<meta name="generator" content="AsciiDoc 9.0.5" />
+<meta name="generator" content="AsciiDoc 10.0.0a1" />
<title>A2X(1)</title>
<link rel="stylesheet" href="./asciidoc.css" type="text/css" />
<link rel="stylesheet" href="./asciidoc-manpage.css" type="text/css" />
@@ -712,7 +712,7 @@ contributed to it.</p></div> <div id="footer">
<div id="footer-text">
Version 9.0.5<br />
-Last updated 2021-01-27 22:27:31 UTC<br />
+Last updated 2021-01-28 21:51:41 UTC<br />
AsciiDoc is a trademark of the Eclipse Foundation, Inc.
</div>
<div id="footer-badges">
diff --git a/article-html5-toc2.html b/article-html5-toc2.html index 756a3fb..d0a73ed 100644 --- a/article-html5-toc2.html +++ b/article-html5-toc2.html @@ -2,606 +2,9 @@ <html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="generator" content="AsciiDoc 9.0.5">
+<meta name="generator" content="AsciiDoc 10.0.0a1">
<title>The Article Title</title>
<style type="text/css">
-/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
-
-/* Default font. */
-body {
- font-family: Georgia,serif;
-}
-
-/* Title font. */
-h1, h2, h3, h4, h5, h6,
-div.title, caption.title,
-thead, p.table.header,
-#toctitle,
-#author, #revnumber, #revdate, #revremark,
-#footer {
- font-family: Arial,Helvetica,sans-serif;
-}
-
-body {
- margin: 1em 5% 1em 5%;
-}
-
-a {
- color: blue;
- text-decoration: underline;
-}
-a:visited {
- color: fuchsia;
-}
-
-em {
- font-style: italic;
- color: navy;
-}
-
-strong {
- font-weight: bold;
- color: #083194;
-}
-
-h1, h2, h3, h4, h5, h6 {
- color: #527bbd;
- margin-top: 1.2em;
- margin-bottom: 0.5em;
- line-height: 1.3;
-}
-
-h1, h2, h3 {
- border-bottom: 2px solid silver;
-}
-h2 {
- padding-top: 0.5em;
-}
-h3 {
- float: left;
-}
-h3 + * {
- clear: left;
-}
-h5 {
- font-size: 1.0em;
-}
-
-div.sectionbody {
- margin-left: 0;
-}
-
-hr {
- border: 1px solid silver;
-}
-
-p {
- margin-top: 0.5em;
- margin-bottom: 0.5em;
-}
-
-ul, ol, li > p {
- margin-top: 0;
-}
-ul > li { color: #aaa; }
-ul > li > * { color: black; }
-
-pre {
- padding: 0;
- margin: 0;
-}
-
-#author {
- color: #527bbd;
- font-weight: bold;
- font-size: 1.1em;
-}
-#email {
-}
-#revnumber, #revdate, #revremark {
-}
-
-#footer {
- font-size: small;
- border-top: 2px solid silver;
- padding-top: 0.5em;
- margin-top: 4.0em;
-}
-#footer-text {
- float: left;
- padding-bottom: 0.5em;
-}
-#footer-badges {
- float: right;
- padding-bottom: 0.5em;
-}
-
-#preamble {
- margin-top: 1.5em;
- margin-bottom: 1.5em;
-}
-div.imageblock, div.exampleblock, div.verseblock,
-div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
-div.admonitionblock {
- margin-top: 1.0em;
- margin-bottom: 1.5em;
-}
-div.admonitionblock {
- margin-top: 2.0em;
- margin-bottom: 2.0em;
- margin-right: 10%;
- color: #606060;
-}
-
-div.content { /* Block element content. */
- padding: 0;
-}
-
-/* Block element titles. */
-div.title, caption.title {
- color: #527bbd;
- font-weight: bold;
- text-align: left;
- margin-top: 1.0em;
- margin-bottom: 0.5em;
-}
-div.title + * {
- margin-top: 0;
-}
-
-td div.title:first-child {
- margin-top: 0.0em;
-}
-div.content div.title:first-child {
- margin-top: 0.0em;
-}
-div.content + div.title {
- margin-top: 0.0em;
-}
-
-div.sidebarblock > div.content {
- background: #ffffee;
- border: 1px solid #dddddd;
- border-left: 4px solid #f0f0f0;
- padding: 0.5em;
-}
-
-div.listingblock > div.content {
- border: 1px solid #dddddd;
- border-left: 5px solid #f0f0f0;
- background: #f8f8f8;
- padding: 0.5em;
-}
-
-div.quoteblock, div.verseblock {
- padding-left: 1.0em;
- margin-left: 1.0em;
- margin-right: 10%;
- border-left: 5px solid #f0f0f0;
- color: #777777;
-}
-
-div.quoteblock > div.attribution {
- padding-top: 0.5em;
- text-align: right;
-}
-
-div.verseblock > pre.content {
- font-family: inherit;
- font-size: inherit;
-}
-div.verseblock > div.attribution {
- padding-top: 0.75em;
- text-align: left;
-}
-/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
-div.verseblock + div.attribution {
- text-align: left;
-}
-
-div.admonitionblock .icon {
- vertical-align: top;
- font-size: 1.1em;
- font-weight: bold;
- text-decoration: underline;
- color: #527bbd;
- padding-right: 0.5em;
-}
-div.admonitionblock td.content {
- padding-left: 0.5em;
- border-left: 3px solid #dddddd;
-}
-
-div.exampleblock > div.content {
- border-left: 3px solid #dddddd;
- padding-left: 0.5em;
-}
-
-div.imageblock div.content { padding-left: 0; }
-span.image img { border-style: none; }
-a.image:visited { color: white; }
-
-dl {
- margin-top: 0.8em;
- margin-bottom: 0.8em;
-}
-dt {
- margin-top: 0.5em;
- margin-bottom: 0;
- font-style: normal;
- color: navy;
-}
-dd > *:first-child {
- margin-top: 0.1em;
-}
-
-ul, ol {
- list-style-position: outside;
-}
-ol.arabic {
- list-style-type: decimal;
-}
-ol.loweralpha {
- list-style-type: lower-alpha;
-}
-ol.upperalpha {
- list-style-type: upper-alpha;
-}
-ol.lowerroman {
- list-style-type: lower-roman;
-}
-ol.upperroman {
- list-style-type: upper-roman;
-}
-
-div.compact ul, div.compact ol,
-div.compact p, div.compact p,
-div.compact div, div.compact div {
- margin-top: 0.1em;
- margin-bottom: 0.1em;
-}
-
-tfoot {
- font-weight: bold;
-}
-td > div.verse {
- white-space: pre;
-}
-
-div.hdlist {
- margin-top: 0.8em;
- margin-bottom: 0.8em;
-}
-div.hdlist tr {
- padding-bottom: 15px;
-}
-dt.hdlist1.strong, td.hdlist1.strong {
- font-weight: bold;
-}
-td.hdlist1 {
- vertical-align: top;
- font-style: normal;
- padding-right: 0.8em;
- color: navy;
-}
-td.hdlist2 {
- vertical-align: top;
-}
-div.hdlist.compact tr {
- margin: 0;
- padding-bottom: 0;
-}
-
-.comment {
- background: yellow;
-}
-
-.footnote, .footnoteref {
- font-size: 0.8em;
-}
-
-span.footnote, span.footnoteref {
- vertical-align: super;
-}
-
-#footnotes {
- margin: 20px 0 20px 0;
- padding: 7px 0 0 0;
-}
-
-#footnotes div.footnote {
- margin: 0 0 5px 0;
-}
-
-#footnotes hr {
- border: none;
- border-top: 1px solid silver;
- height: 1px;
- text-align: left;
- margin-left: 0;
- width: 20%;
- min-width: 100px;
-}
-
-div.colist td {
- padding-right: 0.5em;
- padding-bottom: 0.3em;
- vertical-align: top;
-}
-div.colist td img {
- margin-top: 0.3em;
-}
-
-@media print {
- #footer-badges { display: none; }
-}
-
-#toc {
- margin-bottom: 2.5em;
-}
-
-#toctitle {
- color: #527bbd;
- font-size: 1.1em;
- font-weight: bold;
- margin-top: 1.0em;
- margin-bottom: 0.1em;
-}
-
-div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
- margin-top: 0;
- margin-bottom: 0;
-}
-div.toclevel2 {
- margin-left: 2em;
- font-size: 0.9em;
-}
-div.toclevel3 {
- margin-left: 4em;
- font-size: 0.9em;
-}
-div.toclevel4 {
- margin-left: 6em;
- font-size: 0.9em;
-}
-
-span.aqua { color: aqua; }
-span.black { color: black; }
-span.blue { color: blue; }
-span.fuchsia { color: fuchsia; }
-span.gray { color: gray; }
-span.green { color: green; }
-span.lime { color: lime; }
-span.maroon { color: maroon; }
-span.navy { color: navy; }
-span.olive { color: olive; }
-span.purple { color: purple; }
-span.red { color: red; }
-span.silver { color: silver; }
-span.teal { color: teal; }
-span.white { color: white; }
-span.yellow { color: yellow; }
-
-span.aqua-background { background: aqua; }
-span.black-background { background: black; }
-span.blue-background { background: blue; }
-span.fuchsia-background { background: fuchsia; }
-span.gray-background { background: gray; }
-span.green-background { background: green; }
-span.lime-background { background: lime; }
-span.maroon-background { background: maroon; }
-span.navy-background { background: navy; }
-span.olive-background { background: olive; }
-span.purple-background { background: purple; }
-span.red-background { background: red; }
-span.silver-background { background: silver; }
-span.teal-background { background: teal; }
-span.white-background { background: white; }
-span.yellow-background { background: yellow; }
-
-span.big { font-size: 2em; }
-span.small { font-size: 0.6em; }
-
-span.underline { text-decoration: underline; }
-span.overline { text-decoration: overline; }
-span.line-through { text-decoration: line-through; }
-
-
-/*
- * xhtml11 specific
- *
- * */
-
-tt {
- font-family: monospace;
- font-size: inherit;
- color: navy;
-}
-
-div.tableblock {
- margin-top: 1.0em;
- margin-bottom: 1.5em;
-}
-div.tableblock > table {
- border: 3px solid #527bbd;
-}
-thead, p.table.header {
- font-weight: bold;
- color: #527bbd;
-}
-p.table {
- margin-top: 0;
-}
-/* Because the table frame attribute is overridden by CSS in most browsers. */
-div.tableblock > table[frame="void"] {
- border-style: none;
-}
-div.tableblock > table[frame="hsides"] {
- border-left-style: none;
- border-right-style: none;
-}
-div.tableblock > table[frame="vsides"] {
- border-top-style: none;
- border-bottom-style: none;
-}
-
-
-/*
- * html5 specific
- *
- * */
-
-.monospaced {
- font-family: monospace;
- font-size: inherit;
- color: navy;
-}
-
-table.tableblock {
- margin-top: 1.0em;
- margin-bottom: 1.5em;
-}
-thead, p.tableblock.header {
- font-weight: bold;
- color: #527bbd;
-}
-p.tableblock {
- margin-top: 0;
-}
-table.tableblock {
- border-width: 3px;
- border-spacing: 0px;
- border-style: solid;
- border-color: #527bbd;
- border-collapse: collapse;
-}
-th.tableblock, td.tableblock {
- border-width: 1px;
- padding: 4px;
- border-style: solid;
- border-color: #527bbd;
-}
-
-table.tableblock.frame-topbot {
- border-left-style: hidden;
- border-right-style: hidden;
-}
-table.tableblock.frame-sides {
- border-top-style: hidden;
- border-bottom-style: hidden;
-}
-table.tableblock.frame-none {
- border-style: hidden;
-}
-
-th.tableblock.halign-left, td.tableblock.halign-left {
- text-align: left;
-}
-th.tableblock.halign-center, td.tableblock.halign-center {
- text-align: center;
-}
-th.tableblock.halign-right, td.tableblock.halign-right {
- text-align: right;
-}
-
-th.tableblock.valign-top, td.tableblock.valign-top {
- vertical-align: top;
-}
-th.tableblock.valign-middle, td.tableblock.valign-middle {
- vertical-align: middle;
-}
-th.tableblock.valign-bottom, td.tableblock.valign-bottom {
- vertical-align: bottom;
-}
-
-
-/*
- * manpage specific
- *
- * */
-
-body.manpage h1 {
- padding-top: 0.5em;
- padding-bottom: 0.5em;
- border-top: 2px solid silver;
- border-bottom: 2px solid silver;
-}
-body.manpage h2 {
- border-style: none;
-}
-body.manpage div.sectionbody {
- margin-left: 3em;
-}
-
-@media print {
- body.manpage div#toc { display: none; }
-}
-
-
-/*
- * Theme specific overrides of the preceding (asciidoc.css) CSS.
- *
- */
-body {
- font-family: Garamond, Georgia, serif;
- font-size: 17px;
- color: #3E4349;
- line-height: 1.3em;
-}
-h1, h2, h3, h4, h5, h6,
-div.title, caption.title,
-thead, p.table.header,
-#toctitle,
-#author, #revnumber, #revdate, #revremark,
-#footer {
- font-family: Garmond, Georgia, serif;
- font-weight: normal;
- border-bottom-width: 0;
- color: #3E4349;
-}
-div.title, caption.title { color: #596673; font-weight: bold; }
-h1 { font-size: 240%; }
-h2 { font-size: 180%; }
-h3 { font-size: 150%; }
-h4 { font-size: 130%; }
-h5 { font-size: 115%; }
-h6 { font-size: 100%; }
-#header h1 { margin-top: 0; }
-#toc {
- color: #444444;
- line-height: 1.5;
- padding-top: 1.5em;
-}
-#toctitle {
- font-size: 20px;
-}
-#toc a {
- border-bottom: 1px dotted #999999;
- color: #444444 !important;
- text-decoration: none !important;
-}
-#toc a:hover {
- border-bottom: 1px solid #6D4100;
- color: #6D4100 !important;
- text-decoration: none !important;
-}
-div.toclevel1 { margin-top: 0.2em; font-size: 16px; }
-div.toclevel2 { margin-top: 0.15em; font-size: 14px; }
-em, dt, td.hdlist1 { color: black; }
-strong { color: #3E4349; }
-a { color: #004B6B; text-decoration: none; border-bottom: 1px dotted #004B6B; }
-a:visited { color: #615FA0; border-bottom: 1px dotted #615FA0; }
-a:hover { color: #6D4100; border-bottom: 1px solid #6D4100; }
-div.tableblock > table, table.tableblock { border: 3px solid #E8E8E8; }
-th.tableblock, td.tableblock { border: 1px solid #E8E8E8; }
-ul > li > * { color: #3E4349; }
-pre, tt, .monospaced { font-family: Consolas,Menlo,'Deja Vu Sans Mono','Bitstream Vera Sans Mono',monospace; }
-tt, .monospaced { font-size: 0.9em; color: black;
-}
-div.exampleblock > div.content, div.sidebarblock > div.content, div.listingblock > div.content { border-width: 0 0 0 3px; border-color: #E8E8E8; }
-div.verseblock { border-left-width: 0; margin-left: 3em; }
-div.quoteblock { border-left-width: 3px; margin-left: 0; margin-right: 0;}
-div.admonitionblock td.content { border-left: 3px solid #E8E8E8; }
@media screen {
@@ -1013,7 +416,7 @@ A second glossary term <div id="footer-text">
Version 9.0.5<br>
Last updated
- 2021-01-27 22:27:28 UTC
+ 2021-01-28 21:51:38 UTC
</div>
</div>
</body>
diff --git a/article-standalone.html b/article-standalone.html index 03811b2..1e0aa3c 100644 --- a/article-standalone.html +++ b/article-standalone.html @@ -4,7 +4,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
-<meta name="generator" content="AsciiDoc 9.0.5" />
+<meta name="generator" content="AsciiDoc 10.0.0a1" />
<title>The Article Title</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@@ -1080,7 +1080,7 @@ A second glossary term <div id="footer-text">
Version 9.0.5<br />
Last updated
- 2021-01-27 22:27:28 UTC
+ 2021-01-28 21:51:38 UTC
</div>
</div>
</body>
diff --git a/article.html b/article.html index 52eb5df..a8273f8 100644 --- a/article.html +++ b/article.html @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<meta name="generator" content="AsciiDoc 9.0.5" />
+<meta name="generator" content="AsciiDoc 10.0.0a1" />
<title>The Article Title</title>
<link rel="stylesheet" href="./asciidoc.css" type="text/css" />
<link rel="stylesheet" href="./layout2.css" type="text/css" />
@@ -213,7 +213,7 @@ A second glossary term <div id="footer">
<div id="footer-text">
Version 9.0.5<br />
-Last updated 2021-01-27 22:27:31 UTC<br />
+Last updated 2021-01-28 21:51:41 UTC<br />
AsciiDoc is a trademark of the Eclipse Foundation, Inc.
</div>
<div id="footer-badges">
diff --git a/article.pdf b/article.pdf Binary files differindex 09edd9c..ed3d1ec 100644 --- a/article.pdf +++ b/article.pdf diff --git a/asciidoc-docbook-xsl.html b/asciidoc-docbook-xsl.html index cac31b4..227a896 100644 --- a/asciidoc-docbook-xsl.html +++ b/asciidoc-docbook-xsl.html @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<meta name="generator" content="AsciiDoc 9.0.5" />
+<meta name="generator" content="AsciiDoc 10.0.0a1" />
<title>AsciiDoc DocBook XSL Stylesheets Notes</title>
<link rel="stylesheet" href="./asciidoc.css" type="text/css" />
<link rel="stylesheet" href="./layout2.css" type="text/css" />
@@ -135,7 +135,7 @@ without chapter numbering.</p></div> <div id="footer">
<div id="footer-text">
Version 9.0.5<br />
-Last updated 2021-01-27 22:27:31 UTC<br />
+Last updated 2021-01-28 21:51:41 UTC<br />
AsciiDoc is a trademark of the Eclipse Foundation, Inc.
</div>
<div id="footer-badges">
diff --git a/asciidoc-graphviz-sample.html b/asciidoc-graphviz-sample.html index f6f8fe8..acdeac7 100644 --- a/asciidoc-graphviz-sample.html +++ b/asciidoc-graphviz-sample.html @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<meta name="generator" content="AsciiDoc 9.0.5" />
+<meta name="generator" content="AsciiDoc 10.0.0a1" />
<title>Graphviz filter for AsciiDoc</title>
<link rel="stylesheet" href="./asciidoc.css" type="text/css" />
<link rel="stylesheet" href="./layout2.css" type="text/css" />
@@ -220,7 +220,7 @@ digraph finite_state_machine { <div id="footer">
<div id="footer-text">
Version 9.0.5<br />
-Last updated 2021-01-27 22:27:32 UTC<br />
+Last updated 2021-01-28 21:51:41 UTC<br />
AsciiDoc is a trademark of the Eclipse Foundation, Inc.
</div>
<div id="footer-badges">
diff --git a/asciidoc.1.css-embedded.html b/asciidoc.1.css-embedded.html index 17815b7..75b8e8c 100644 --- a/asciidoc.1.css-embedded.html +++ b/asciidoc.1.css-embedded.html @@ -4,7 +4,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
-<meta name="generator" content="AsciiDoc 9.0.5" />
+<meta name="generator" content="AsciiDoc 10.0.0a1" />
<title>ASCIIDOC(1)</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@@ -1162,7 +1162,7 @@ Public License version 2 (GPLv2).</p></div> <div id="footer-text">
Version 9.0.5<br />
Last updated
- 2021-01-27 22:27:28 UTC
+ 2021-01-28 21:51:38 UTC
</div>
</div>
</body>
diff --git a/asciidoc.1.html b/asciidoc.1.html index bc70c13..fbe2229 100644 --- a/asciidoc.1.html +++ b/asciidoc.1.html @@ -2,7 +2,7 @@ <html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="generator" content="AsciiDoc 9.0.5">
+<meta name="generator" content="AsciiDoc 10.0.0a1">
<title>ASCIIDOC(1)</title>
</head>
<body>
@@ -380,7 +380,7 @@ Public License version 2 (GPLv2).</p> <hr><p><small>
Version 9.0.5<br>
Last updated
- 2021-01-27 22:27:28 UTC
+ 2021-01-28 21:51:38 UTC
</small></p>
</body>
</html>
diff --git a/asciidoc.css-embedded.html b/asciidoc.css-embedded.html index 96987f9..7d7840c 100644 --- a/asciidoc.css-embedded.html +++ b/asciidoc.css-embedded.html @@ -4,7 +4,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
-<meta name="generator" content="AsciiDoc 9.0.5" />
+<meta name="generator" content="AsciiDoc 10.0.0a1" />
<title>AsciiDoc User Guide</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@@ -10452,7 +10452,7 @@ General Public License version 2 for more details.</p></div> <div id="footer-text">
Version 9.0.5<br />
Last updated
- 2021-01-27 22:27:28 UTC
+ 2021-01-28 21:51:38 UTC
</div>
</div>
</body>
diff --git a/asciidoc.html b/asciidoc.html index 760f669..7e7aadd 100644 --- a/asciidoc.html +++ b/asciidoc.html @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<meta name="generator" content="AsciiDoc 9.0.5" />
+<meta name="generator" content="AsciiDoc 10.0.0a1" />
<title>AsciiDoc User Guide</title>
<link rel="stylesheet" href="./asciidoc.css" type="text/css" />
<link rel="stylesheet" href="./layout2.css" type="text/css" />
@@ -9756,7 +9756,7 @@ General Public License version 2 for more details.</p></div> <div id="footer">
<div id="footer-text">
Version 9.0.5<br />
-Last updated 2021-01-27 22:27:33 UTC<br />
+Last updated 2021-01-28 21:51:42 UTC<br />
AsciiDoc is a trademark of the Eclipse Foundation, Inc.
</div>
<div id="footer-badges">
diff --git a/asciidoc.pdf b/asciidoc.pdf Binary files differindex 5a13af3..2f35cfa 100644 --- a/asciidoc.pdf +++ b/asciidoc.pdf diff --git a/asciidocapi.html b/asciidocapi.html index fa71868..c9aeaf9 100644 --- a/asciidocapi.html +++ b/asciidocapi.html @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<meta name="generator" content="AsciiDoc 9.0.5" />
+<meta name="generator" content="AsciiDoc 10.0.0a1" />
<title>AsciiDoc API</title>
<link rel="stylesheet" href="./asciidoc.css" type="text/css" />
<link rel="stylesheet" href="./layout2.css" type="text/css" />
@@ -343,7 +343,7 @@ error occurs.</p></div> <div id="footer">
<div id="footer-text">
Version 9.0.5<br />
-Last updated 2021-01-27 22:27:42 UTC<br />
+Last updated 2021-01-28 21:51:49 UTC<br />
AsciiDoc is a trademark of the Eclipse Foundation, Inc.
</div>
<div id="footer-badges">
diff --git a/asciimathml.html b/asciimathml.html index 2b0653c..d268a6c 100644 --- a/asciimathml.html +++ b/asciimathml.html @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<meta name="generator" content="AsciiDoc 9.0.5" />
+<meta name="generator" content="AsciiDoc 10.0.0a1" />
<title>ASCIIMathML Formulae</title>
<link rel="stylesheet" href="./asciidoc.css" type="text/css" />
<link rel="stylesheet" href="./layout2.css" type="text/css" />
@@ -153,7 +153,7 @@ get the two solutions: <div id="footer">
<div id="footer-text">
Version 9.0.5<br />
-Last updated 2021-01-27 22:27:42 UTC<br />
+Last updated 2021-01-28 21:51:49 UTC<br />
AsciiDoc is a trademark of the Eclipse Foundation, Inc.
</div>
<div id="footer-badges">
diff --git a/book-multi.html b/book-multi.html index 5ceaab2..2f5e340 100644 --- a/book-multi.html +++ b/book-multi.html @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<meta name="generator" content="AsciiDoc 9.0.5" />
+<meta name="generator" content="AsciiDoc 10.0.0a1" />
<title>Multi-Part Book Title Goes Here</title>
<link rel="stylesheet" href="./asciidoc.css" type="text/css" />
<link rel="stylesheet" href="./layout2.css" type="text/css" />
@@ -265,7 +265,7 @@ A second glossary term <div id="footer">
<div id="footer-text">
Version 9.0.5<br />
-Last updated 2021-01-27 22:27:42 UTC<br />
+Last updated 2021-01-28 21:51:50 UTC<br />
AsciiDoc is a trademark of the Eclipse Foundation, Inc.
</div>
<div id="footer-badges">
@@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<meta name="generator" content="AsciiDoc 9.0.5" />
+<meta name="generator" content="AsciiDoc 10.0.0a1" />
<title>Book Title Goes Here</title>
<link rel="stylesheet" href="./asciidoc.css" type="text/css" />
<link rel="stylesheet" href="./layout2.css" type="text/css" />
@@ -231,7 +231,7 @@ A second glossary term <div id="footer">
<div id="footer-text">
Version 9.0.5<br />
-Last updated 2021-01-27 22:27:43 UTC<br />
+Last updated 2021-01-28 21:51:50 UTC<br />
AsciiDoc is a trademark of the Eclipse Foundation, Inc.
</div>
<div id="footer-badges">
diff --git a/chunked/apa.html b/chunked/apa.html deleted file mode 100644 index 79bf1a0..0000000 --- a/chunked/apa.html +++ /dev/null @@ -1,19 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Appendix A. Migration Notes</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="AsciiDoc User Guide" /><link rel="up" href="index.html" title="AsciiDoc User Guide" /><link rel="prev" href="go01.html" title="Glossary" /><link rel="next" href="apb.html" title="Appendix B. Packager Notes" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="go01.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="apb.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="appendix"><div class="titlepage"><div><div><h1 class="title"><a id="_migration_notes"></a>Appendix A. Migration Notes</h1></div></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="X53"></a>A.1. Version 7 to version 8</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -A new set of quotes has been introduced which may match inline text - in existing documents — if they do you’ll need to escape the - matched text with backslashes. -</li><li class="listitem"> -The index entry inline macro syntax has changed — if your documents - include indexes you may need to edit them. -</li><li class="listitem"> -Replaced a2x(1) <code class="literal">--no-icons</code> and <code class="literal">--no-copy</code> options with their - negated equivalents: <code class="literal">--icons</code> and <code class="literal">--copy</code> respectively. The - default behavior has also changed — the use of icons and copying of - icon and CSS files must be specified explicitly with the <code class="literal">--icons</code> - and <code class="literal">--copy</code> options. -</li></ul></div><p>The rationale for the changes can be found in the AsciiDoc -<code class="literal">CHANGELOG</code>.</p><div class="note" style="margin-left: 0; margin-right: 10%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/icons/note.png" /></td><th align="left"></th></tr><tr><td align="left" valign="top"><p>If you want to disable unconstrained quotes, the new alternative -constrained quotes syntax and the new index entry syntax then you can -define the attribute <code class="literal">asciidoc7compatible</code> (for example by using the -<code class="literal">-a asciidoc7compatible</code> command-line option).</p></td></tr></table></div></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="go01.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="apb.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/icons/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
\ No newline at end of file diff --git a/chunked/apb.html b/chunked/apb.html deleted file mode 100644 index 58f5c89..0000000 --- a/chunked/apb.html +++ /dev/null @@ -1,5 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Appendix B. Packager Notes</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="AsciiDoc User Guide" /><link rel="up" href="index.html" title="AsciiDoc User Guide" /><link rel="prev" href="apa.html" title="Appendix A. Migration Notes" /><link rel="next" href="apc.html" title="Appendix C. AsciiDoc Safe Mode" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="apa.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="apc.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="appendix"><div class="titlepage"><div><div><h1 class="title"><a id="X38"></a>Appendix B. Packager Notes</h1></div></div></div><p>Read the <code class="literal">README</code> and <code class="literal">INSTALL</code> files (in the distribution root -directory) for install prerequisites and procedures. The distribution -<code class="literal">Makefile.in</code> (used by <code class="literal">configure</code> to generate the <code class="literal">Makefile</code>) is the -canonical installation procedure.</p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="apa.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="apc.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/icons/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
\ No newline at end of file diff --git a/chunked/apc.html b/chunked/apc.html deleted file mode 100644 index c140d47..0000000 --- a/chunked/apc.html +++ /dev/null @@ -1,23 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Appendix C. AsciiDoc Safe Mode</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="AsciiDoc User Guide" /><link rel="up" href="index.html" title="AsciiDoc User Guide" /><link rel="prev" href="apb.html" title="Appendix B. Packager Notes" /><link rel="next" href="apd.html" title="Appendix D. Using AsciiDoc with non-English Languages" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="apb.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="apd.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="appendix"><div class="titlepage"><div><div><h1 class="title"><a id="X39"></a>Appendix C. AsciiDoc Safe Mode</h1></div></div></div><p>AsciiDoc <span class="emphasis"><em>safe mode</em></span> skips potentially dangerous scripted sections in -AsciiDoc source files by inhibiting the execution of arbitrary code or -the inclusion of arbitrary files.</p><p>The safe mode is disabled by default, it can be enabled with the -asciidoc(1) <code class="literal">--safe</code> command-line option.</p><div class="itemizedlist"><p class="title"><strong>Safe mode constraints</strong></p><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -<code class="literal">eval</code>, <code class="literal">sys</code> and <code class="literal">sys2</code> executable attributes and block macros are - not executed. -</li><li class="listitem"> -<code class="literal">include::<filename>[]</code> and <code class="literal">include1::<filename>[]</code> block macro - files must reside inside the parent file’s directory. -</li><li class="listitem"> -<code class="literal">{include:<filename>}</code> executable attribute files must reside - inside the source document directory. -</li><li class="listitem"> -Passthrough Blocks are dropped. -</li></ul></div><div class="warning" style="margin-left: 0; margin-right: 10%;"><table border="0" summary="Warning"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="images/icons/warning.png" /></td><th align="left"></th></tr><tr><td align="left" valign="top"><p>The safe mode is not designed to protect against unsafe AsciiDoc -configuration files. Be especially careful when:</p><div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -Implementing filters. -</li><li class="listitem"> -Implementing elements that don’t escape special characters. -</li><li class="listitem"> -Accepting configuration files from untrusted sources. -</li></ol></div></td></tr></table></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="apb.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="apd.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/icons/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
\ No newline at end of file diff --git a/chunked/apd.html b/chunked/apd.html deleted file mode 100644 index 5b3f249..0000000 --- a/chunked/apd.html +++ /dev/null @@ -1,23 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Appendix D. Using AsciiDoc with non-English Languages</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="AsciiDoc User Guide" /><link rel="up" href="index.html" title="AsciiDoc User Guide" /><link rel="prev" href="apc.html" title="Appendix C. AsciiDoc Safe Mode" /><link rel="next" href="ape.html" title="Appendix E. Vim Syntax Highlighter" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="apc.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ape.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="appendix"><div class="titlepage"><div><div><h1 class="title"><a id="_using_asciidoc_with_non_english_languages"></a>Appendix D. Using AsciiDoc with non-English Languages</h1></div></div></div><p>AsciiDoc can process UTF-8 character sets but there are some things -you need to be aware of:</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p class="simpara"> -If you are generating output documents using a DocBook toolchain - then you should set the AsciiDoc <code class="literal">lang</code> attribute to the appropriate - language (it defaults to <code class="literal">en</code> (English)). This will ensure things - like table of contents, figure and table captions and admonition - captions are output in the specified language. For example: -</p><pre class="literallayout">$ a2x -a lang=es doc/article.txt</pre></li><li class="listitem"><p class="simpara"> -If you are outputting HTML directly from asciidoc(1) you’ll - need to set the various <code class="literal">*_caption</code> attributes to match your target - language (see the list of captions and titles in the <code class="literal">[attributes]</code> - section of the distribution <code class="literal">lang-*.conf</code> files). The easiest way is - to create a language <code class="literal">.conf</code> file (see the AsciiDoc’s <code class="literal">lang-en.conf</code> - file). -</p><div class="note" style="margin-left: 0; margin-right: 10%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/icons/note.png" /></td><th align="left"></th></tr><tr><td align="left" valign="top"><p>You still use the <span class="emphasis"><em>NOTE</em></span>, <span class="emphasis"><em>CAUTION</em></span>, <span class="emphasis"><em>TIP</em></span>, <span class="emphasis"><em>WARNING</em></span>, -<span class="emphasis"><em>IMPORTANT</em></span> captions in the AsciiDoc source, they get translated in -the HTML output file.</p></td></tr></table></div></li><li class="listitem"> -asciidoc(1) automatically loads configuration files named like - <code class="literal">lang-<lang>.conf</code> where <code class="literal"><lang></code> is a two letter language code that - matches the current AsciiDoc <code class="literal">lang</code> attribute. See also - <a class="link" href="ch26.html#X27" title="26.11. Configuration file names, precedence and locations">Configuration File Names and Locations</a>. -</li></ul></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="apc.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ape.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/icons/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
\ No newline at end of file diff --git a/chunked/ape.html b/chunked/ape.html deleted file mode 100644 index 182637d..0000000 --- a/chunked/ape.html +++ /dev/null @@ -1,16 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Appendix E. Vim Syntax Highlighter</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="AsciiDoc User Guide" /><link rel="up" href="index.html" title="AsciiDoc User Guide" /><link rel="prev" href="apd.html" title="Appendix D. Using AsciiDoc with non-English Languages" /><link rel="next" href="apf.html" title="Appendix F. Attribute Options" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="apd.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="apf.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="appendix"><div class="titlepage"><div><div><h1 class="title"><a id="_vim_syntax_highlighter"></a>Appendix E. Vim Syntax Highlighter</h1></div></div></div><p>Syntax highlighting is incredibly useful, in addition to making -reading AsciiDoc documents much easier syntax highlighting also helps -you catch AsciiDoc syntax errors as you write your documents.</p><p>The AsciiDoc distribution directory contains a Vim syntax highlighter -for AsciiDoc (<code class="literal">./vim/syntax/asciidoc.vim</code>), you can find the latest -version in the online -<a class="ulink" href="https://code.google.com/p/asciidoc/source/browse/" target="_top">AsciiDoc -repository</a>.</p><p>Install the highlighter by copying <code class="literal">asciidoc.vim</code> to your -<code class="literal">$HOME/.vim/syntax</code> directory (create it if it doesn’t already exist).</p><p>To enable syntax highlighting:</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -Put a Vim <span class="emphasis"><em>autocmd</em></span> in your Vim configuration file (see the - <a class="link" href="ch36.html#X61" title="36.2.4. Example ~/.vimrc File">example vimrc file</a>). -</li><li class="listitem"> -or execute the Vim command <code class="literal">:set syntax=asciidoc</code>. -</li><li class="listitem"><p class="simpara"> -or add the following line to the end of you AsciiDoc source files: -</p><pre class="literallayout">// vim: set syntax=asciidoc:</pre></li></ul></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="apd.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="apf.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/icons/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
\ No newline at end of file diff --git a/chunked/apf.html b/chunked/apf.html deleted file mode 100644 index 96f1dea..0000000 --- a/chunked/apf.html +++ /dev/null @@ -1,10 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Appendix F. Attribute Options</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="AsciiDoc User Guide" /><link rel="up" href="index.html" title="AsciiDoc User Guide" /><link rel="prev" href="ape.html" title="Appendix E. Vim Syntax Highlighter" /><link rel="next" href="apg.html" title="Appendix G. Diagnostics" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="ape.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="apg.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="appendix"><div class="titlepage"><div><div><h1 class="title"><a id="X74"></a>Appendix F. Attribute Options</h1></div></div></div><p>Here is the list of predefined <a class="link" href="ch29.html#X75" title="29.1. Options attribute">attribute list options</a>:</p><div class="informaltable"><table class="informaltable" cellpadding="4px" style="border-collapse: collapse;border-top: 3px solid #527bbd; border-bottom: 3px solid #527bbd; "><colgroup><col class="col_1" /><col class="col_2" /><col class="col_3" /><col class="col_4" /></colgroup><thead><tr><th style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top">Option</th><th style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top">Backends</th><th style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top">AsciiDoc Elements</th><th style="border-bottom: 1px solid #527bbd; " align="left" valign="top">Description</th></tr></thead><tbody><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em>autowidth</em></span></p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>xhtml11, html5, html4</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>table</p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>The column widths are determined by the browser, not the AsciiDoc -<span class="emphasis"><em>cols</em></span> attribute. If there is no <span class="emphasis"><em>width</em></span> attribute the table width is -also left up to the browser.</p></td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em>unbreakable</em></span></p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>xhtml11, html5</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>block elements</p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em>unbreakable</em></span> attempts to keep the block element together on a single -printed page c.f. the <span class="emphasis"><em>breakable</em></span> and <span class="emphasis"><em>unbreakable</em></span> docbook (XSL/FO) -options below.</p></td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em>breakable, unbreakable</em></span></p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>docbook (XSL/FO)</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>table, example, block image</p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>The <span class="emphasis"><em>breakable</em></span> options allows block elements to break across page -boundaries; <span class="emphasis"><em>unbreakable</em></span> attempts to keep the block element together -on a single page. If neither option is specified the default XSL -stylesheet behavior prevails.</p></td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em>compact</em></span></p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>docbook, xhtml11, html5</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>bulleted list, numbered list</p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>Minimizes vertical space in the list</p></td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em>footer</em></span></p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>docbook, xhtml11, html5, html4</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>table</p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>The last row of the table is rendered as a footer.</p></td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em>header</em></span></p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>docbook, xhtml11, html5, html4</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>table</p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>The first row of the table is rendered as a header.</p></td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em>pgwide</em></span></p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>docbook (XSL/FO)</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>table, block image, horizontal labeled list</p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>Specifies that the element should be rendered across the full text -width of the page irrespective of the current indentation.</p></td></tr><tr><td style="border-right: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em>strong</em></span></p></td><td style="border-right: 1px solid #527bbd; " align="left" valign="top"><p>xhtml11, html5, html4</p></td><td style="border-right: 1px solid #527bbd; " align="left" valign="top"><p>labeled lists</p></td><td style="" align="left" valign="top"><p>Emboldens label text.</p></td></tr></tbody></table></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ape.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="apg.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/icons/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
\ No newline at end of file diff --git a/chunked/apg.html b/chunked/apg.html deleted file mode 100644 index 1f463fd..0000000 --- a/chunked/apg.html +++ /dev/null @@ -1,76 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Appendix G. Diagnostics</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="AsciiDoc User Guide" /><link rel="up" href="index.html" title="AsciiDoc User Guide" /><link rel="prev" href="apf.html" title="Appendix F. Attribute Options" /><link rel="next" href="aph.html" title="Appendix H. Backend Attributes" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="apf.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="aph.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="appendix"><div class="titlepage"><div><div><h1 class="title"><a id="X82"></a>Appendix G. Diagnostics</h1></div></div></div><p>The <code class="literal">asciidoc(1)</code> <code class="literal">--verbose</code> command-line option prints additional -information to stderr: files processed, filters processed, warnings, -system attribute evaluation.</p><p>A special attribute named <span class="emphasis"><em>trace</em></span> enables the output of -element-by-element diagnostic messages detailing output markup -generation to stderr. The <span class="emphasis"><em>trace</em></span> attribute can be set on the -command-line or from within the document using <a class="link" href="ch28.html" title="Chapter 28. Attribute Entries">Attribute Entries</a> (the latter allows tracing to be confined to specific -portions of the document).</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -Trace messages print the source file name and line number and the - trace name followed by related markup. -</li><li class="listitem"> -<span class="emphasis"><em>trace names</em></span> are normally the names of AsciiDoc elements (see the - list below). -</li><li class="listitem"> -The trace message is only printed if the <span class="emphasis"><em>trace</em></span> attribute value - matches the start of a <span class="emphasis"><em>trace name</em></span>. The <span class="emphasis"><em>trace</em></span> attribute value can - be any Python regular expression. If a trace value is not specified - all trace messages will be printed (this can result in large amounts - of output if applied to the whole document). -</li><li class="listitem"><p class="simpara"> -In the case of inline substitutions: -</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; "><li class="listitem"> -The text before and after the substitution is printed; the before - text is preceded by a line containing <code class="literal"><<<</code> and the after text by - a line containing <code class="literal">>>></code>. -</li><li class="listitem"> -The <span class="emphasis"><em>subs</em></span> trace value is an alias for all inline substitutions. -</li></ul></div></li></ul></div><p><strong>Trace names. </strong> -</p><pre class="literallayout"><blockname> block close -<blockname> block open -<subs> -dropped line (a line containing an undefined attribute reference). -floating title -footer -header -list close -list entry close -list entry open -list item close -list item open -list label close -list label open -list open -macro block (a block macro) -name (man page NAME section) -paragraph -preamble close -preamble open -push blockname -pop blockname -section close -section open: level <level> -subs (all inline substitutions) -table</pre><p> -</p><p>Where:</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -<code class="literal"><level></code> is section level number <span class="emphasis"><em>0…4</em></span>. -</li><li class="listitem"> -<code class="literal"><blockname></code> is a delimited block name: <span class="emphasis"><em>comment</em></span>, <span class="emphasis"><em>sidebar</em></span>, - <span class="emphasis"><em>open</em></span>, <span class="emphasis"><em>pass</em></span>, <span class="emphasis"><em>listing</em></span>, <span class="emphasis"><em>literal</em></span>, <span class="emphasis"><em>quote</em></span>, <span class="emphasis"><em>example</em></span>. -</li><li class="listitem"> -<code class="literal"><subs></code> is an inline substitution type: - <span class="emphasis"><em>specialcharacters</em></span>,<span class="emphasis"><em>quotes</em></span>,<span class="emphasis"><em>specialwords</em></span>, <span class="emphasis"><em>replacements</em></span>, - <span class="emphasis"><em>attributes</em></span>,<span class="emphasis"><em>macros</em></span>,<span class="emphasis"><em>callouts</em></span>, <span class="emphasis"><em>replacements2</em></span>, <span class="emphasis"><em>replacements3</em></span>. -</li></ul></div><p>Command-line examples:</p><div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><p class="simpara"> -Trace the entire document. -</p><pre class="literallayout">$ asciidoc -a trace mydoc.txt</pre></li><li class="listitem"><p class="simpara"> -Trace messages whose names start with <code class="literal">quotes</code> or <code class="literal">macros</code>: -</p><pre class="literallayout">$ asciidoc -a 'trace=quotes|macros' mydoc.txt</pre></li><li class="listitem"><p class="simpara"> -Print the first line of each trace message: -</p><pre class="literallayout">$ asciidoc -a trace mydoc.txt 2>&1 | grep ^TRACE:</pre></li></ol></div><p>Attribute Entry examples:</p><div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><p class="simpara"> -Begin printing all trace messages: -</p><pre class="literallayout">:trace:</pre></li><li class="listitem"><p class="simpara"> -Print only matched trace messages: -</p><pre class="literallayout">:trace: quotes|macros</pre></li><li class="listitem"><p class="simpara"> -Turn trace messages off: -</p><pre class="literallayout">:trace!:</pre></li></ol></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="apf.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="aph.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/icons/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
\ No newline at end of file diff --git a/chunked/aph.html b/chunked/aph.html deleted file mode 100644 index 48308bb..0000000 --- a/chunked/aph.html +++ /dev/null @@ -1,123 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Appendix H. Backend Attributes</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="AsciiDoc User Guide" /><link rel="up" href="index.html" title="AsciiDoc User Guide" /><link rel="prev" href="apg.html" title="Appendix G. Diagnostics" /><link rel="next" href="api.html" title="Appendix I. License" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="apg.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="api.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="appendix"><div class="titlepage"><div><div><h1 class="title"><a id="X88"></a>Appendix H. Backend Attributes</h1></div></div></div><p>This table contains a list of optional attributes that influence the -generated outputs.</p><div class="informaltable"><table class="informaltable" cellpadding="4px" style="border-collapse: collapse;border-top: 3px solid #527bbd; border-bottom: 3px solid #527bbd; "><colgroup><col class="col_1" /><col class="col_2" /><col class="col_3" /></colgroup><thead><tr><th style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top">Name </th><th style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top">Backends </th><th style="border-bottom: 1px solid #527bbd; " align="left" valign="top">Description</th></tr></thead><tbody><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em>badges</em></span></p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>xhtml11, html5</p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>Link badges (<span class="emphasis"><em>XHTML 1.1</em></span> and <span class="emphasis"><em>CSS</em></span>) in document footers. By default -badges are omitted (<span class="emphasis"><em>badges</em></span> is undefined).</p> -<div class="note" style="margin-left: 0; margin-right: 10%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/icons/note.png" /></td><th align="left"></th></tr><tr><td align="left" valign="top"><p>The path names of images, icons and scripts are relative path -names to the output document not the source document.</p></td></tr></table></div></td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em>data-uri</em></span></p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>xhtml11, html5</p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>Embed images using the <a class="link" href="ch21.html#X66" title="Embedding images in XHTML documents">data: uri scheme</a>.</p></td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em>css-signature</em></span></p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>html5, xhtml11</p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>Set a <span class="emphasis"><em>CSS signature</em></span> for the document (sets the <span class="emphasis"><em>id</em></span> attribute of the -HTML <span class="emphasis"><em>body</em></span> element). CSS signatures provide a mechanism that allows -users to personalize the document appearance. The term <span class="emphasis"><em>CSS signature</em></span> -was <a class="ulink" href="http://archivist.incutio.com/viewlist/css-discuss/13291" target="_top">coined by -Eric Meyer</a>.</p></td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em>disable-javascript</em></span></p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>xhtml11, html5</p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>If the <code class="literal">disable-javascript</code> attribute is defined the <code class="literal">asciidoc.js</code> -JavaScript is not embedded or linked to the output document. By -default AsciiDoc automatically embeds or links the <code class="literal">asciidoc.js</code> -JavaScript to the output document. The script dynamically generates -<a class="link" href="aph.html#X91">table of contents</a> and <a class="link" href="ch18.html" title="Chapter 18. Footnotes">footnotes</a>.</p></td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em><a id="X97"></a> docinfo, docinfo1, docinfo2</em></span></p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>All backends</p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>These three attributes control which <a class="link" href="ch08.html#X87" title="8.2.1. Additional document header information">document information files</a> will be included in the the header of the output file:</p> -<div class="variablelist"><dl class="variablelist"><dt><span class="term"> -docinfo -</span></dt><dd> -Include <code class="literal"><filename>-docinfo.<ext></code> -</dd><dt><span class="term"> -docinfo1 -</span></dt><dd> -Include <code class="literal">docinfo.<ext></code> -</dd><dt><span class="term"> -docinfo2 -</span></dt><dd> -Include <code class="literal">docinfo.<ext></code> and <code class="literal"><filename>-docinfo.<ext></code> -</dd></dl></div> -<p>Where <code class="literal"><filename></code> is the file name (sans extension) of the AsciiDoc -input file and <code class="literal"><ext></code> is <code class="literal">.html</code> for HTML outputs or <code class="literal">.xml</code> for -DocBook outputs. If the input file is the standard input then the -output file name is used. The following example will include the -<code class="literal">mydoc-docinfo.xml</code> docinfo file in the DocBook <code class="literal">mydoc.xml</code> output -file:</p> -<pre class="literallayout">$ asciidoc -a docinfo -b docbook mydoc.txt</pre> -<p>This next example will include <code class="literal">docinfo.html</code> and <code class="literal">mydoc-docinfo.html</code> -docinfo files in the HTML output file:</p> -<pre class="literallayout">$ asciidoc -a docinfo2 -b html4 mydoc.txt</pre></td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em><a id="X54"></a>encoding</em></span></p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>html4, html5, xhtml11, docbook</p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>Set the input and output document character set encoding. For example -the <code class="literal">--attribute encoding=ISO-8859-1</code> command-line option will set the -character set encoding to <code class="literal">ISO-8859-1</code>.</p> -<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -The default encoding is UTF-8. -</li><li class="listitem"> -This attribute specifies the character set in the output document. -</li><li class="listitem"> -The encoding name must correspond to a Python codec name or alias. -</li><li class="listitem"><p class="simpara"> -The <span class="emphasis"><em>encoding</em></span> attribute can be set using an AttributeEntry inside - the document header. For example: -</p><pre class="literallayout">:encoding: ISO-8859-1</pre></li></ul></div></td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em>hr</em></span></p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>html4</p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>Defines the <span class="emphasis"><em>html4</em></span> inter-section horizontal ruler element. By default -<span class="emphasis"><em>html4</em></span> top level sections are separated by a horizontal ruler -element, undefine this attribute or set it to an empty string if you -do not want them. The default <span class="emphasis"><em>html4</em></span> backend value for the <span class="emphasis"><em>hr</em></span> -attribute is <code class="literal"><hr></code>.</p></td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em><a id="X45"></a>icons</em></span></p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>xhtml11, html5</p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>Link admonition paragraph and admonition block icon images and badge -images. By default <span class="emphasis"><em>icons</em></span> is undefined and text is used in place of -icon images.</p></td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em><a id="X44"></a>iconsdir</em></span></p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>html4, html5, xhtml11, docbook</p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>The name of the directory containing linked admonition icons, -navigation icons and the <code class="literal">callouts</code> sub-directory (the <code class="literal">callouts</code> -sub-directory contains <a class="link" href="ch20.html" title="Chapter 20. Callouts">callout</a> number images). <span class="emphasis"><em>iconsdir</em></span> -defaults to <code class="literal">./images/icons</code>. If admonition icons are embedded using -the <a class="link" href="ch21.html#X66" title="Embedding images in XHTML documents">data-uri</a> scheme then the <span class="emphasis"><em>iconsdir</em></span> attribute defaults to -the location of the icons installed in the AsciiDoc configuration -directory.</p></td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em>imagesdir</em></span></p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>html4, html5, xhtml11, docbook</p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>If this attribute is defined it is prepended to the target image file -name paths in inline and block image macros.</p></td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em>keywords, description, title</em></span></p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>html4, html5, xhtml11</p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>The <span class="emphasis"><em>keywords</em></span> and <span class="emphasis"><em>description</em></span> attributes set the correspondingly -named HTML meta tag contents; the <span class="emphasis"><em>title</em></span> attribute sets the HTML -title tag contents. Their principle use is for SEO (Search Engine -Optimisation). All three are optional, but if they are used they must -appear in the document header (or on the command-line). If <span class="emphasis"><em>title</em></span> is -not specified the AsciiDoc document title is used.</p></td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em>linkcss</em></span></p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>html5, xhtml11</p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>Link CSS stylesheets and JavaScripts. By default <span class="emphasis"><em>linkcss</em></span> is -undefined in which case stylesheets and scripts are automatically -embedded in the output document.</p></td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em><a id="X103"></a>max-width</em></span></p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>html5, xhtml11</p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>Set the document maximum display width (sets the <span class="emphasis"><em>body</em></span> element CSS -<span class="emphasis"><em>max-width</em></span> property).</p></td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em>numbered</em></span></p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>html4, html5, xhtml11, docbook (XSL Stylesheets)</p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>Adds section numbers to section titles. The <span class="emphasis"><em>docbook</em></span> backend ignores -<span class="emphasis"><em>numbered</em></span> attribute entries after the document header.</p></td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em>plaintext</em></span></p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>All backends</p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>If this global attribute is defined all inline substitutions are -suppressed and block indents are retained. This option is useful when -dealing with large amounts of imported plain text.</p></td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em>quirks</em></span></p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>xhtml11</p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>Include the <code class="literal">xhtml11-quirks.conf</code> configuration file and -<code class="literal">xhtml11-quirks.css</code> <a class="link" href="ch07.html" title="Chapter 7. HTML5 and XHTML 1.1">stylesheet</a> to work around IE6 browser -incompatibilities. This feature is deprecated and its use is -discouraged — documents are still viewable in IE6 without it.</p></td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em>revremark</em></span></p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>docbook</p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>A short summary of changes in this document revision. Must be defined -prior to the first document section. The document also needs to be -dated to output this attribute.</p></td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em>footer-style</em></span></p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>html4, html5, xhtml11</p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>Changes the "Last updated" field in the footer of the document or removes this -field and the revision number (in the footer only). -Can take 3 values:</p> -<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -none : Don’t display the "Last updated" and "Revision number" fields in the - footer of the document -</li><li class="listitem"> -revdate : The "Last updated" field’s date in the footer will be the revision - date specified in the document (<code class="literal">revdate</code> attribute) -</li><li class="listitem"> -default (or any other value) : The "Last updated" field’s date in the footer - will be the date of the input file modification -</li></ul></div> -<p>This attribute can be set, for example, using <code class="literal">:footer-style: revdate</code> in the -header of the file or using the <code class="literal">--attribute footer-style=revdate</code> command-line -option.</p></td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em>scriptsdir</em></span></p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>html5, xhtml11</p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>The name of the directory containing linked JavaScripts. -See <a class="link" href="ch07.html" title="Chapter 7. HTML5 and XHTML 1.1">HTML stylesheets and JavaScript locations</a>.</p></td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em>sgml</em></span></p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>docbook45</p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>The <code class="literal">--backend=docbook45</code> command-line option produces DocBook 4.5 -XML. You can produce the older DocBook SGML format using the -<code class="literal">--attribute sgml</code> command-line option.</p></td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em>stylesdir</em></span></p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>html5, xhtml11</p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>The name of the directory containing linked or embedded -<a class="link" href="ch07.html" title="Chapter 7. HTML5 and XHTML 1.1">stylesheets</a>. -See <a class="link" href="ch07.html" title="Chapter 7. HTML5 and XHTML 1.1">HTML stylesheets and JavaScript locations</a>.</p></td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em>stylesheet</em></span></p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>html5, xhtml11</p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>The file name of an optional additional CSS <a class="link" href="ch07.html" title="Chapter 7. HTML5 and XHTML 1.1">stylesheet</a>.</p></td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em>theme</em></span></p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>html5, xhtml11</p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>Use alternative stylesheet (see <a class="link" href="ch07.html" title="Chapter 7. HTML5 and XHTML 1.1">Stylesheets</a>).</p></td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em><a id="X91"></a>toc</em></span></p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>html5, xhtml11, docbook (XSL Stylesheets)</p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>Adds a table of contents to the start of an article or book document. -The <code class="literal">toc</code> attribute can be specified using the <code class="literal">--attribute toc</code> -command-line option or a <code class="literal">:toc:</code> attribute entry in the document -header. The <span class="emphasis"><em>toc</em></span> attribute is defined by default when the <span class="emphasis"><em>docbook</em></span> -backend is used. To disable table of contents generation undefine the -<span class="emphasis"><em>toc</em></span> attribute by putting a <code class="literal">:toc!:</code> attribute entry in the document -header or from the command-line with an <code class="literal">--attribute toc!</code> option.</p> -<p><span class="strong"><strong>xhtml11 and html5 backends</strong></span></p> -<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -JavaScript needs to be enabled in your browser. -</li><li class="listitem"><p class="simpara"> -The following example generates a numbered table of contents using a - JavaScript embedded in the <code class="literal">mydoc.html</code> output document: -</p><pre class="literallayout">$ asciidoc -a toc -a numbered mydoc.txt</pre></li></ul></div></td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em>toc2</em></span></p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>html5, xhtml11</p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>Adds a scrollable table of contents in the left hand margin of an -article or book document. Use the <span class="emphasis"><em>max-width</em></span> attribute to change the -content width. In all other respects behaves the same as the <span class="emphasis"><em>toc</em></span> -attribute.</p></td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em>toc-placement</em></span></p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>html5, xhtml11</p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>When set to <span class="emphasis"><em>auto</em></span> (the default value) asciidoc(1) will place the -table of contents in the document header. When <span class="emphasis"><em>toc-placement</em></span> is set -to <span class="emphasis"><em>manual</em></span> the TOC can be positioned anywhere in the document by -placing the <code class="literal">toc::[]</code> block macro at the point you want the TOC to -appear.</p> -<div class="note" style="margin-left: 0; margin-right: 10%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/icons/note.png" /></td><th align="left"></th></tr><tr><td align="left" valign="top"><p>If you use <span class="emphasis"><em>toc-placement</em></span> then you also have to define the -<a class="link" href="aph.html#X91">toc</a> attribute.</p></td></tr></table></div></td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em>toc-title</em></span></p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>html5, xhtml11</p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>Sets the table of contents title (defaults to <span class="emphasis"><em>Table of Contents</em></span>).</p></td></tr><tr><td style="border-right: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em>toclevels</em></span></p></td><td style="border-right: 1px solid #527bbd; " align="left" valign="top"><p>html5, xhtml11</p></td><td style="" align="left" valign="top"><p>Sets the number of title levels (1..4) reported in the table of -contents (see the <span class="emphasis"><em>toc</em></span> attribute above). Defaults to 2 and must be -used with the <span class="emphasis"><em>toc</em></span> attribute. Example usage:</p> -<pre class="literallayout">$ asciidoc -a toc -a toclevels=3 doc/asciidoc.txt</pre></td></tr></tbody></table></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="apg.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="api.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/icons/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
\ No newline at end of file diff --git a/chunked/api.html b/chunked/api.html deleted file mode 100644 index 8782d39..0000000 --- a/chunked/api.html +++ /dev/null @@ -1,7 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Appendix I. License</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="AsciiDoc User Guide" /><link rel="up" href="index.html" title="AsciiDoc User Guide" /><link rel="prev" href="aph.html" title="Appendix H. Backend Attributes" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="aph.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> </td></tr></table><hr /></div><div class="appendix"><div class="titlepage"><div><div><h1 class="title"><a id="_license"></a>Appendix I. License</h1></div></div></div><p>AsciiDoc is free software; you can redistribute it and/or modify it -under the terms of the <span class="emphasis"><em>GNU General Public License version 2</em></span> (GPLv2) -as published by the Free Software Foundation.</p><p>AsciiDoc is distributed in the hope that it will be useful, but -WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -General Public License version 2 for more details.</p><p>Copyright © 2002-2013 Stuart Rackham.</p><p>Copyright © 2013-2020 AsciiDoc Contributors.</p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="aph.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> </td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/icons/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
\ No newline at end of file diff --git a/chunked/ch01.html b/chunked/ch01.html deleted file mode 100644 index 85bc8a8..0000000 --- a/chunked/ch01.html +++ /dev/null @@ -1,23 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Chapter 1. Introduction</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="AsciiDoc User Guide" /><link rel="up" href="index.html" title="AsciiDoc User Guide" /><link rel="prev" href="pr01.html" title="" /><link rel="next" href="ch02.html" title="Chapter 2. Getting Started" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="pr01.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch02.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a id="_introduction"></a>Chapter 1. Introduction</h1></div></div></div><p>AsciiDoc is a plain text human readable/writable document format that -can be translated to DocBook or HTML using the asciidoc(1) command. -You can then either use asciidoc(1) generated HTML directly or run -asciidoc(1) DocBook output through your favorite DocBook toolchain or -use the AsciiDoc a2x(1) toolchain wrapper to produce PDF, EPUB, DVI, -LaTeX, PostScript, man page, HTML and text formats.</p><p>The AsciiDoc format is a useful presentation format in its own right: -AsciiDoc markup is simple, intuitive and as such is easily proofed and -edited.</p><p>AsciiDoc is light weight: it consists of a single Python script and a -bunch of configuration files. Apart from asciidoc(1) and a Python -interpreter, no other programs are required to convert AsciiDoc text -files to DocBook or HTML. See <a class="link" href="ch02.html#X11" title="2.2. Example AsciiDoc Documents">Example AsciiDoc Documents</a> -below.</p><p>Text markup conventions tend to be a matter of (often strong) personal -preference: if the default syntax is not to your liking you can define -your own by editing the text based asciidoc(1) configuration files. -You can also create configuration files to translate AsciiDoc -documents to almost any SGML/XML markup.</p><p>asciidoc(1) comes with a set of configuration files to translate -AsciiDoc articles, books and man pages to HTML or DocBook backend -formats.</p><div class="sidebar"><div class="titlepage"><div><div><p class="title"><strong>My AsciiDoc Itch</strong></p></div></div></div><p>DocBook has emerged as the de facto standard Open Source documentation -format. But DocBook is a complex language, the markup is difficult to -read and even more difficult to write directly — I found I was -spending more time typing markup tags, consulting reference manuals -and fixing syntax errors, than I was writing the documentation.</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="pr01.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch02.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/icons/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
\ No newline at end of file diff --git a/chunked/ch02.html b/chunked/ch02.html deleted file mode 100644 index 9667282..0000000 --- a/chunked/ch02.html +++ /dev/null @@ -1,11 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Chapter 2. Getting Started</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="AsciiDoc User Guide" /><link rel="up" href="index.html" title="AsciiDoc User Guide" /><link rel="prev" href="ch01.html" title="Chapter 1. Introduction" /><link rel="next" href="ch03.html" title="Chapter 3. AsciiDoc Document Types" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="ch01.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch03.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a id="X6"></a>Chapter 2. Getting Started</h1></div></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_installing_asciidoc"></a>2.1. Installing AsciiDoc</h2></div></div></div><p>See the <code class="literal">README</code> and <code class="literal">INSTALL</code> files for install prerequisites and -procedures. Packagers take a look at <a class="link" href="apb.html" title="Appendix B. Packager Notes">Packager Notes</a>.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="X11"></a>2.2. Example AsciiDoc Documents</h2></div></div></div><p>The best way to quickly get a feel for AsciiDoc is to view the -AsciiDoc web site and/or distributed examples:</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -Take a look at the linked examples on the AsciiDoc web site home - page <a class="ulink" href="https://asciidoc.org/" target="_top">https://asciidoc.org/</a>. Press the <span class="emphasis"><em>Page Source</em></span> sidebar menu item to view - corresponding AsciiDoc source. -</li><li class="listitem"> -Read the <code class="literal">*.txt</code> source files in the distribution <code class="literal">./doc</code> directory - along with the corresponding HTML and DocBook XML files. -</li></ul></div></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch01.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch03.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/icons/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
\ No newline at end of file diff --git a/chunked/ch03.html b/chunked/ch03.html deleted file mode 100644 index 667942b..0000000 --- a/chunked/ch03.html +++ /dev/null @@ -1,33 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Chapter 3. AsciiDoc Document Types</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="AsciiDoc User Guide" /><link rel="up" href="index.html" title="AsciiDoc User Guide" /><link rel="prev" href="ch02.html" title="Chapter 2. Getting Started" /><link rel="next" href="ch04.html" title="Chapter 4. AsciiDoc Backends" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="ch02.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch04.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a id="_asciidoc_document_types"></a>Chapter 3. AsciiDoc Document Types</h1></div></div></div><p>There are three types of AsciiDoc documents: article, book and -manpage. All document types share the same AsciiDoc format with some -minor variations. If you are familiar with DocBook you will have -noticed that AsciiDoc document types correspond to the same-named -DocBook document types.</p><p>Use the asciidoc(1) <code class="literal">-d</code> (<code class="literal">--doctype</code>) option to specify the AsciiDoc -document type — the default document type is <span class="emphasis"><em>article</em></span>.</p><p>By convention the <code class="literal">.txt</code> file extension is used for AsciiDoc document -source files.</p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_article"></a>3.1. article</h2></div></div></div><p>Used for short documents, articles and general documentation. See the -AsciiDoc distribution <code class="literal">./doc/article.txt</code> example.</p><p>AsciiDoc defines standard DocBook article frontmatter and backmatter -<a class="link" href="ch08.html#X93" title="8.4.1. Section markup templates">section markup templates</a> (appendix, abstract, bibliography, -glossary, index).</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_book"></a>3.2. book</h2></div></div></div><p>Books share the same format as articles, with the following -differences:</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -The part titles in multi-part books are <a class="link" href="ch11.html" title="Chapter 11. Titles">top level titles</a> - (same level as book title). -</li><li class="listitem"> -Some sections are book specific e.g. preface and colophon. -</li></ul></div><p>Book documents will normally be used to produce DocBook output since -DocBook processors can automatically generate footnotes, table of -contents, list of tables, list of figures, list of examples and -indexes.</p><p>AsciiDoc defines standard DocBook book frontmatter and backmatter -<a class="link" href="ch08.html#X93" title="8.4.1. Section markup templates">section markup templates</a> (appendix, dedication, preface, -bibliography, glossary, index, colophon).</p><div class="variablelist"><p class="title"><strong>Example book documents</strong></p><dl class="variablelist"><dt><span class="term"> -Book -</span></dt><dd> - The <code class="literal">./doc/book.txt</code> file in the AsciiDoc distribution. -</dd><dt><span class="term"> -Multi-part book -</span></dt><dd> - The <code class="literal">./doc/book-multi.txt</code> file in the AsciiDoc distribution. -</dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_manpage"></a>3.3. manpage</h2></div></div></div><p>Used to generate roff format UNIX manual pages. AsciiDoc manpage -documents observe special header title and section naming conventions — see the <a class="link" href="ch24.html" title="Chapter 24. Manpage Documents">Manpage Documents</a> section for details.</p><p>AsciiDoc defines the <span class="emphasis"><em>synopsis</em></span> <a class="link" href="ch08.html#X93" title="8.4.1. Section markup templates">section markup template</a> to -generate the DocBook <code class="literal">refsynopsisdiv</code> section.</p><p>See also the asciidoc(1) man page source (<code class="literal">./doc/asciidoc.1.txt</code>) from -the AsciiDoc distribution.</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch02.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch04.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/icons/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
\ No newline at end of file diff --git a/chunked/ch04.html b/chunked/ch04.html deleted file mode 100644 index 528fa78..0000000 --- a/chunked/ch04.html +++ /dev/null @@ -1,71 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Chapter 4. AsciiDoc Backends</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="AsciiDoc User Guide" /><link rel="up" href="index.html" title="AsciiDoc User Guide" /><link rel="prev" href="ch03.html" title="Chapter 3. AsciiDoc Document Types" /><link rel="next" href="ch05.html" title="Chapter 5. DocBook" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="ch03.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch05.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a id="X5"></a>Chapter 4. AsciiDoc Backends</h1></div></div></div><p>The asciidoc(1) command translates an AsciiDoc formatted file to the -backend format specified by the <code class="literal">-b</code> (<code class="literal">--backend</code>) command-line -option. asciidoc(1) itself has little intrinsic knowledge of backend -formats, all translation rules are contained in customizable cascading -configuration files. Backend specific attributes are listed in the -<a class="link" href="aph.html" title="Appendix H. Backend Attributes">Backend Attributes</a> section.</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"> -docbook45 -</span></dt><dd> - Outputs DocBook XML 4.5 markup. -</dd><dt><span class="term"> -docbook5 -</span></dt><dd> - Outputs DocBook XML 5.0 markup. -</dd><dt><span class="term"> -html4 -</span></dt><dd> - This backend generates plain HTML 4.01 Transitional markup. -</dd><dt><span class="term"> -xhtml11 -</span></dt><dd> - This backend generates XHTML 1.1 markup styled with CSS2. Output - files have an <code class="literal">.html</code> extension. -</dd><dt><span class="term"> -html5 -</span></dt><dd> - This backend generates HTML 5 markup, apart from the inclusion of - <a class="link" href="ch22.html" title="Chapter 22. HTML 5 audio and video block macros">audio and video block macros</a> it is functionally identical to - the <span class="emphasis"><em>xhtml11</em></span> backend. -</dd><dt><span class="term"> -slidy -</span></dt><dd> - Use this backend to generate self-contained - <a class="ulink" href="http://www.w3.org/Talks/Tools/Slidy2/" target="_top">Slidy</a> HTML slideshows for - your web browser from AsciiDoc documents. The Slidy backend is - documented in the distribution <code class="literal">doc/slidy.txt</code> file and - <a class="ulink" href="https://asciidoc.org/slidy.html" target="_top">online</a>. -</dd><dt><span class="term"> -wordpress -</span></dt><dd> - A minor variant of the <span class="emphasis"><em>html4</em></span> backend to support - <a class="ulink" href="http://srackham.wordpress.com/blogpost1/" target="_top">blogpost</a>. -</dd><dt><span class="term"> -latex -</span></dt><dd> - Experimental LaTeX backend. -</dd></dl></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_backend_aliases"></a>4.1. Backend Aliases</h2></div></div></div><p>Backend aliases are alternative names for AsciiDoc backends. AsciiDoc -comes with two backend aliases: <span class="emphasis"><em>html</em></span> (aliased to <span class="emphasis"><em>xhtml11</em></span>) and -<span class="emphasis"><em>docbook</em></span> (aliased to <span class="emphasis"><em>docbook45</em></span>).</p><p>You can assign (or reassign) backend aliases by setting an AsciiDoc -attribute named like <code class="literal">backend-alias-<alias></code> to an AsciiDoc backend -name. For example, the following backend alias attribute definitions -appear in the <code class="literal">[attributes]</code> section of the global <code class="literal">asciidoc.conf</code> -configuration file:</p><pre class="literallayout">backend-alias-html=xhtml11 -backend-alias-docbook=docbook45</pre></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="X100"></a>4.2. Backend Plugins</h2></div></div></div><p>The asciidoc(1) <code class="literal">--backend</code> option is also used to install and manage -backend <a class="link" href="ch34.html" title="Chapter 34. Plugins">plugins</a>.</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -A backend plugin is used just like the built-in backends. -</li><li class="listitem"> -Backend plugins <a class="link" href="ch26.html#X27" title="26.11. Configuration file names, precedence and locations">take precedence</a> over built-in backends with - the same name. -</li><li class="listitem"> -You can use the <code class="literal">{asciidoc-confdir}</code> <a class="link" href="ch31.html" title="Chapter 31. Intrinsic Attributes">intrinsic attribute</a> to - refer to the built-in backend configuration file location from - backend plugin configuration files. -</li><li class="listitem"> -You can use the <code class="literal">{backend-confdir}</code> <a class="link" href="ch31.html" title="Chapter 31. Intrinsic Attributes">intrinsic attribute</a> to - refer to the backend plugin configuration file location. -</li><li class="listitem"> -By default backends plugins are installed in - <code class="literal">$HOME/.asciidoc/backends/<backend></code> where <code class="literal"><backend></code> is the - backend name. -</li></ul></div></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch03.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch05.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/icons/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
\ No newline at end of file diff --git a/chunked/ch05.html b/chunked/ch05.html deleted file mode 100644 index 90db229..0000000 --- a/chunked/ch05.html +++ /dev/null @@ -1,161 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Chapter 5. DocBook</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="AsciiDoc User Guide" /><link rel="up" href="index.html" title="AsciiDoc User Guide" /><link rel="prev" href="ch04.html" title="Chapter 4. AsciiDoc Backends" /><link rel="next" href="ch06.html" title="Chapter 6. Generating Plain Text Files" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="ch04.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch06.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a id="_docbook"></a>Chapter 5. DocBook</h1></div></div></div><p>AsciiDoc generates <span class="emphasis"><em>article</em></span>, <span class="emphasis"><em>book</em></span> and <span class="emphasis"><em>refentry</em></span> -<a class="ulink" href="http://www.docbook.org/" target="_top">DocBook</a> documents (corresponding to the -AsciiDoc <span class="emphasis"><em>article</em></span>, <span class="emphasis"><em>book</em></span> and <span class="emphasis"><em>manpage</em></span> document types).</p><p>Most Linux distributions come with conversion tools (collectively -called a toolchain) for <a class="link" href="ch05.html#X12" title="5.1. Converting DocBook to other file formats">converting DocBook files</a> to -presentation 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 example <a class="ulink" href="http://live.gnome.org/Yelp" target="_top">Yelp</a> -(the GNOME help viewer).</p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="X12"></a>5.1. Converting DocBook to other file formats</h2></div></div></div><p>DocBook files are validated, parsed and translated various -presentation file formats using a combination of applications -collectively called a DocBook <span class="emphasis"><em>tool chain</em></span>. 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).</p><p>A wide range of user output format requirements coupled with a choice -of available tools and stylesheets results in many valid tool chain -combinations.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="X43"></a>5.2. a2x Toolchain Wrapper</h2></div></div></div><p>One of the biggest hurdles for new users is installing, configuring -and using a DocBook XML toolchain. <code class="literal">a2x(1)</code> can help — it’s a -toolchain 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. <code class="literal">a2x(1)</code> does all the grunt -work associated with generating and sequencing the toolchain commands -and managing intermediate and output files. <code class="literal">a2x(1)</code> also optionally -deploys admonition and navigation icons and a CSS stylesheet. See the -<code class="literal">a2x(1)</code> man page for more details. In addition to <code class="literal">asciidoc(1)</code> you -also need <a class="link" href="ch05.html#X40">xsltproc(1)</a>, <a class="link" href="ch05.html#X13">DocBook XSL Stylesheets</a> and -optionally: <a class="link" href="ch05.html#X31">dblatex</a> or <a class="link" href="ch05.html#X14">FOP</a> (to generate PDF); -<code class="literal">w3m(1)</code> or <code class="literal">lynx(1)</code> (to generate text).</p><p>The following examples generate <code class="literal">doc/source-highlight-filter.pdf</code> from -the AsciiDoc <code class="literal">doc/source-highlight-filter.txt</code> source file. The first -example uses <code class="literal">dblatex(1)</code> (the default PDF generator) the second -example forces FOP to be used:</p><pre class="literallayout">$ a2x -f pdf doc/source-highlight-filter.txt -$ a2x -f pdf --fop doc/source-highlight-filter.txt</pre><p>See the <code class="literal">a2x(1)</code> man page for details.</p><div class="tip" style="margin-left: 0; margin-right: 10%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="images/icons/tip.png" /></td><th align="left"></th></tr><tr><td align="left" valign="top"><p>Use the <code class="literal">--verbose</code> command-line option to view executed -toolchain commands.</p></td></tr></table></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_html_generation"></a>5.3. HTML generation</h2></div></div></div><p>AsciiDoc produces nicely styled HTML directly without requiring a -DocBook toolchain but there are also advantages in going the DocBook -route:</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -HTML from DocBook can optionally include automatically generated - indexes, tables of contents, footnotes, lists of figures and tables. -</li><li class="listitem"> -DocBook toolchains can also (optionally) generate separate (chunked) - linked HTML pages for each document section. -</li><li class="listitem"> -Toolchain processing performs link and document validity checks. -</li><li class="listitem"> -If the DocBook <span class="emphasis"><em>lang</em></span> 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 <span class="emphasis"><em>lang</em></span> - attribute sets the DocBook <span class="emphasis"><em>lang</em></span> attribute). -</li></ul></div><p>On the other hand, HTML output directly from AsciiDoc is much faster, -is easily customized and can be used in situations where there is no -suitable DocBook toolchain (for example, see the <a class="ulink" href="https://asciidoc.org/" target="_top">AsciiDoc -website</a>).</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_pdf_generation"></a>5.4. PDF generation</h2></div></div></div><p>There are two commonly used tools to generate PDFs from DocBook, -<a class="link" href="ch05.html#X31">dblatex</a> and <a class="link" href="ch05.html#X14">FOP</a>.</p><div class="itemizedlist"><p class="title"><strong>dblatex or FOP?</strong></p><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -<span class="emphasis"><em>dblatex</em></span> is easier to install, there’s zero configuration - required and no Java VM to install — it just works out of the box. -</li><li class="listitem"> -<span class="emphasis"><em>dblatex</em></span> source code highlighting and numbering is superb. -</li><li class="listitem"> -<span class="emphasis"><em>dblatex</em></span> is easier to use as it converts DocBook directly to PDF - whereas before using <span class="emphasis"><em>FOP</em></span> you have to convert DocBook to XML-FO - using <a class="link" href="ch05.html#X13">DocBook XSL Stylesheets</a>. -</li><li class="listitem"> -<span class="emphasis"><em>FOP</em></span> is more feature complete (for example, callouts are processed - inside literal layouts) and arguably produces nicer looking output. -</li></ul></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_html_help_generation"></a>5.5. HTML Help generation</h2></div></div></div><div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -Convert DocBook XML documents to HTML Help compiler source files - using <a class="link" href="ch05.html#X13">DocBook XSL Stylesheets</a> and <a class="link" href="ch05.html#X40">xsltproc(1)</a>. -</li><li class="listitem"> -Convert the HTML Help source (<code class="literal">.hhp</code> and <code class="literal">.html</code>) files to HTML Help - (<code class="literal">.chm</code>) files using the <a class="link" href="ch05.html#X67">Microsoft HTML Help Compiler</a>. -</li></ol></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_toolchain_components_summary"></a>5.6. Toolchain components summary</h2></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term"> -AsciiDoc -</span></dt><dd> - Converts AsciiDoc (<code class="literal">.txt</code>) files to DocBook XML (<code class="literal">.xml</code>) files. -</dd><dt><span class="term"> -<a id="X13"></a><a class="ulink" href="https://github.com/docbook/xslt10-stylesheets" target="_top">DocBook XSLT Stylesheets</a> -</span></dt><dd> - These are a set of XSL stylesheets containing rules for converting - DocBook XML documents to HTML, XSL-FO, manpage and HTML Help files. - The stylesheets are used in conjunction with an XML parser such as - <a class="link" href="ch05.html#X40">xsltproc(1)</a>. -</dd><dt><span class="term"> -<a id="X40"></a><a class="ulink" href="http://www.xmlsoft.org" target="_top">xsltproc</a> -</span></dt><dd> - An XML parser for applying XSLT stylesheets (in our case the - <a class="link" href="ch05.html#X13">DocBook XSL Stylesheets</a>) to XML documents. -</dd><dt><span class="term"> -<a id="X31"></a><a class="ulink" href="http://dblatex.sourceforge.net/" target="_top">dblatex</a> -</span></dt><dd> - Generates PDF, DVI, PostScript and LaTeX formats directly from - DocBook source via the intermediate LaTeX typesetting language — uses <a class="link" href="ch05.html#X13">DocBook XSL Stylesheets</a>, <a class="link" href="ch05.html#X40">xsltproc(1)</a> and - <code class="literal">latex(1)</code>. -</dd><dt><span class="term"> -<a id="X14"></a><a class="ulink" href="http://xmlgraphics.apache.org/fop/" target="_top">FOP</a> -</span></dt><dd> - The Apache Formatting Objects Processor converts XSL-FO (<code class="literal">.fo</code>) - files to PDF files. The XSL-FO files are generated from DocBook - source files using <a class="link" href="ch05.html#X13">DocBook XSL Stylesheets</a> and - <a class="link" href="ch05.html#X40">xsltproc(1)</a>. -</dd><dt><span class="term"> -<a id="X67"></a>Microsoft Help Compiler -</span></dt><dd> - The Microsoft HTML Help Compiler (<code class="literal">hhc.exe</code>) is a command-line tool - that converts HTML Help source files to a single HTML Help (<code class="literal">.chm</code>) - file. It runs on MS Windows platforms and can be downloaded from - <a class="ulink" href="http://www.microsoft.com" target="_top">http://www.microsoft.com</a>. -</dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_asciidoc_dblatex_configuration_files"></a>5.7. AsciiDoc dblatex configuration files</h2></div></div></div><p>The AsciiDoc distribution <code class="literal">./dblatex</code> directory contains -<code class="literal">asciidoc-dblatex.xsl</code> (customized XSL parameter settings) and -<code class="literal">asciidoc-dblatex.sty</code> (customized LaTeX settings). These are examples -of optional <a class="link" href="ch05.html#X31">dblatex</a> output customization and are used by -<a class="link" href="ch05.html#X43" title="5.2. a2x Toolchain Wrapper">a2x(1)</a>.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_asciidoc_docbook_xsl_stylesheets_drivers"></a>5.8. AsciiDoc DocBook XSL Stylesheets drivers</h2></div></div></div><p>You will have noticed that the distributed HTML and HTML Help -documentation files (for example <code class="literal">./doc/asciidoc.html</code>) are not the -plain outputs produced using the default <span class="emphasis"><em>DocBook XSL Stylesheets</em></span> -configuration. This is because they have been processed using -customized DocBook XSL Stylesheets along with (in the case of HTML -outputs) the custom <code class="literal">./stylesheets/docbook-xsl.css</code> CSS stylesheet.</p><p>You’ll find the customized DocBook XSL drivers along with additional -documentation in the distribution <code class="literal">./docbook-xsl</code> directory. The -examples that follow are executed from the distribution documentation -(<code class="literal">./doc</code>) directory. These drivers are also used by <a class="link" href="ch05.html#X43" title="5.2. a2x Toolchain Wrapper">a2x(1)</a>.</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"> -<code class="literal">common.xsl</code> -</span></dt><dd> - Shared driver parameters. This file is not used directly but is - included in all the following drivers. -</dd><dt><span class="term"> -<code class="literal">chunked.xsl</code> -</span></dt><dd><p class="simpara"> - Generate chunked XHTML (separate HTML pages for each document - section) in the <code class="literal">./doc/chunked</code> directory. For example: -</p><pre class="literallayout">$ python ../asciidoc.py -b docbook asciidoc.txt -$ xsltproc --nonet ../docbook-xsl/chunked.xsl asciidoc.xml</pre></dd><dt><span class="term"> -<code class="literal">epub.xsl</code> -</span></dt><dd> - Used by <a class="link" href="ch05.html#X43" title="5.2. a2x Toolchain Wrapper">a2x(1)</a> to generate EPUB formatted documents. -</dd><dt><span class="term"> -<code class="literal">fo.xsl</code> -</span></dt><dd><p class="simpara"> - Generate XSL Formatting Object (<code class="literal">.fo</code>) files for subsequent PDF - file generation using FOP. For example: -</p><pre class="literallayout">$ python ../asciidoc.py -b docbook article.txt -$ xsltproc --nonet ../docbook-xsl/fo.xsl article.xml > article.fo -$ fop article.fo article.pdf</pre></dd><dt><span class="term"> -<code class="literal">htmlhelp.xsl</code> -</span></dt><dd><p class="simpara"> - Generate Microsoft HTML Help source files for the MS HTML Help - Compiler in the <code class="literal">./doc/htmlhelp</code> directory. This example is run on - MS Windows from a Cygwin shell prompt: -</p><pre class="literallayout">$ 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</pre></dd><dt><span class="term"> -<code class="literal">manpage.xsl</code> -</span></dt><dd><p class="simpara"> - Generate a <code class="literal">roff(1)</code> format UNIX man page from a DocBook XML - <span class="emphasis"><em>refentry</em></span> document. This example generates an <code class="literal">asciidoc.1</code> man - page file: -</p><pre class="literallayout">$ python ../asciidoc.py -d manpage -b docbook asciidoc.1.txt -$ xsltproc --nonet ../docbook-xsl/manpage.xsl asciidoc.1.xml</pre></dd><dt><span class="term"> -<code class="literal">xhtml.xsl</code> -</span></dt><dd><p class="simpara"> - Convert a DocBook XML file to a single XHTML file. For example: -</p><pre class="literallayout">$ python ../asciidoc.py -b docbook asciidoc.txt -$ xsltproc --nonet ../docbook-xsl/xhtml.xsl asciidoc.xml > asciidoc.html</pre></dd></dl></div><p>If you want to see how the complete documentation set is processed -take a look at the A-A-P script <code class="literal">./doc/main.aap</code>.</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch04.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch06.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/icons/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
\ No newline at end of file diff --git a/chunked/ch06.html b/chunked/ch06.html deleted file mode 100644 index 4441623..0000000 --- a/chunked/ch06.html +++ /dev/null @@ -1,5 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Chapter 6. Generating Plain Text Files</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="AsciiDoc User Guide" /><link rel="up" href="index.html" title="AsciiDoc User Guide" /><link rel="prev" href="ch05.html" title="Chapter 5. DocBook" /><link rel="next" href="ch07.html" title="Chapter 7. HTML5 and XHTML 1.1" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="ch05.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch07.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a id="_generating_plain_text_files"></a>Chapter 6. Generating Plain Text Files</h1></div></div></div><p>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 AsciiDoc <a class="link" href="ch05.html#X43" title="5.2. a2x Toolchain Wrapper">a2x(1)</a> toolchain wrapper -utility.</p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch05.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch07.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/icons/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
\ No newline at end of file diff --git a/chunked/ch07.html b/chunked/ch07.html deleted file mode 100644 index b5942ef..0000000 --- a/chunked/ch07.html +++ /dev/null @@ -1,57 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Chapter 7. HTML5 and XHTML 1.1</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="AsciiDoc User Guide" /><link rel="up" href="index.html" title="AsciiDoc User Guide" /><link rel="prev" href="ch06.html" title="Chapter 6. Generating Plain Text Files" /><link rel="next" href="ch08.html" title="Chapter 8. Document Structure" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="ch06.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch08.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a id="X35"></a>Chapter 7. HTML5 and XHTML 1.1</h1></div></div></div><p>The <span class="emphasis"><em>xhtml11</em></span> and <span class="emphasis"><em>html5</em></span> backends embed or link CSS and JavaScript -files in their outputs, there is also a <a class="link" href="ch07.html#X99" title="7.1. Themes">themes</a> plugin -framework.</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -If the AsciiDoc <span class="emphasis"><em>linkcss</em></span> attribute is defined then CSS and - JavaScript files are linked to the output document, otherwise they - are embedded (the default behavior). -</li><li class="listitem"> -The default locations for CSS and JavaScript files can be changed by - setting the AsciiDoc <span class="emphasis"><em>stylesdir</em></span> and <span class="emphasis"><em>scriptsdir</em></span> attributes - respectively. -</li><li class="listitem"> -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. -</li><li class="listitem"> -Embedded files are automatically inserted in the output files but - you need to manually copy linked CSS and Javascript files from - AsciiDoc <a class="link" href="ch26.html#X27" title="26.11. Configuration file names, precedence and locations">configuration directories</a> to the correct location - relative to the output document. -</li></ul></div><div class="table"><a id="idm414"></a><p class="title"><strong>Table 7.1. Stylesheet file locations</strong></p><div class="table-contents"><table class="table" summary="Stylesheet file locations" cellpadding="4px" style="border-collapse: collapse;border-top: 3px solid #527bbd; border-bottom: 3px solid #527bbd; "><colgroup><col class="col_1" /><col class="col_2" /><col class="col_3" /></colgroup><thead><tr><th style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><span class="emphasis"><em>stylesdir</em></span> attribute</th><th style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top">Linked location (<span class="emphasis"><em>linkcss</em></span> attribute defined)</th><th style="border-bottom: 1px solid #527bbd; " align="left" valign="top">Embedded location (<span class="emphasis"><em>linkcss</em></span> attribute undefined)</th></tr></thead><tbody><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>Undefined (default).</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>Same directory as the output document.</p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p><code class="literal">stylesheets</code> subdirectory in the AsciiDoc configuration directory -(the directory containing the backend conf file).</p></td></tr><tr><td style="border-right: 1px solid #527bbd; " align="left" valign="top"><p>Absolute or relative directory name.</p></td><td style="border-right: 1px solid #527bbd; " align="left" valign="top"><p>Absolute or relative to the output document.</p></td><td style="" align="left" valign="top"><p>Absolute or relative to the AsciiDoc configuration directory (the -directory containing the backend conf file).</p></td></tr></tbody></table></div></div><br class="table-break" /><div class="table"><a id="idm444"></a><p class="title"><strong>Table 7.2. JavaScript file locations</strong></p><div class="table-contents"><table class="table" summary="JavaScript file locations" cellpadding="4px" style="border-collapse: collapse;border-top: 3px solid #527bbd; border-bottom: 3px solid #527bbd; "><colgroup><col class="col_1" /><col class="col_2" /><col class="col_3" /></colgroup><thead><tr><th style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><span class="emphasis"><em>scriptsdir</em></span> attribute</th><th style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top">Linked location (<span class="emphasis"><em>linkcss</em></span> attribute defined)</th><th style="border-bottom: 1px solid #527bbd; " align="left" valign="top">Embedded location (<span class="emphasis"><em>linkcss</em></span> attribute undefined)</th></tr></thead><tbody><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>Undefined (default).</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>Same directory as the output document.</p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p><code class="literal">javascripts</code> subdirectory in the AsciiDoc configuration directory -(the directory containing the backend conf file).</p></td></tr><tr><td style="border-right: 1px solid #527bbd; " align="left" valign="top"><p>Absolute or relative directory name.</p></td><td style="border-right: 1px solid #527bbd; " align="left" valign="top"><p>Absolute or relative to the output document.</p></td><td style="" align="left" valign="top"><p>Absolute or relative to the AsciiDoc configuration directory (the -directory containing the backend conf file).</p></td></tr></tbody></table></div></div><br class="table-break" /><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="X99"></a>7.1. Themes</h2></div></div></div><p>The AsciiDoc <span class="emphasis"><em>theme</em></span> attribute is used to select an alternative CSS -stylesheet and to optionally include additional JavaScript code.</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -Theme files reside in an AsciiDoc <a class="link" href="ch26.html#X27" title="26.11. Configuration file names, precedence and locations">configuration directory</a> - named <code class="literal">themes/<theme>/</code> (where <code class="literal"><theme></code> is the the theme name set - by the <span class="emphasis"><em>theme</em></span> attribute). asciidoc(1) sets the <span class="emphasis"><em>themedir</em></span> attribute - to the theme directory path name. -</li><li class="listitem"> -The <span class="emphasis"><em>theme</em></span> attribute can also be set using the asciidoc(1) - <code class="literal">--theme</code> option, the <code class="literal">--theme</code> option can also be used to manage - theme <a class="link" href="ch34.html" title="Chapter 34. Plugins">plugins</a>. -</li><li class="listitem"> -AsciiDoc ships with two themes: <span class="emphasis"><em>flask</em></span> and <span class="emphasis"><em>volnitsky</em></span>. -</li><li class="listitem"> -The <code class="literal"><theme>.css</code> file replaces the default <code class="literal">asciidoc.css</code> CSS file. -</li><li class="listitem"> -The <code class="literal"><theme>.js</code> file is included in addition to the default - <code class="literal">asciidoc.js</code> JavaScript file. -</li><li class="listitem"> -If the <a class="link" href="ch21.html#X66" title="Embedding images in XHTML documents">data-uri</a> attribute is defined then icons are loaded - from the theme <code class="literal">icons</code> sub-directory if it exists (i.e. the - <span class="emphasis"><em>iconsdir</em></span> attribute is set to theme <code class="literal">icons</code> sub-directory path). -</li><li class="listitem"> -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. -</li><li class="listitem"> -Linked CSS and JavaScript theme files are linked to the same linked - locations as <a class="link" href="ch07.html" title="Chapter 7. HTML5 and XHTML 1.1">other CSS and JavaScript files</a>. -</li></ul></div><p>For example, the command-line option <code class="literal">--theme foo</code> (or <code class="literal">--attribute -theme=foo</code>) will cause asciidoc(1) to search <a class="link" href="ch26.html#X27" title="26.11. Configuration file names, precedence and locations">configuration file locations 1</a> for a sub-directory called <code class="literal">themes/foo</code> -containing the stylesheet <code class="literal">foo.css</code> and optionally a JavaScript file -name <code class="literal">foo.js</code>.</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch06.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch08.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/icons/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
\ No newline at end of file diff --git a/chunked/ch08.html b/chunked/ch08.html deleted file mode 100644 index 401e06b..0000000 --- a/chunked/ch08.html +++ /dev/null @@ -1,301 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Chapter 8. Document Structure</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="AsciiDoc User Guide" /><link rel="up" href="index.html" title="AsciiDoc User Guide" /><link rel="prev" href="ch07.html" title="Chapter 7. HTML5 and XHTML 1.1" /><link rel="next" href="ch09.html" title="Chapter 9. Document Processing" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="ch07.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch09.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a id="_document_structure"></a>Chapter 8. Document Structure</h1></div></div></div><p>An AsciiDoc document consists of a series of <a class="link" href="go01.html#X8">block elements</a> -starting with an optional document Header, followed by an optional -Preamble, followed by zero or more document Sections.</p><p>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.</p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_block_elements"></a>8.1. Block Elements</h2></div></div></div><p>Block elements consist of one or more lines of text and may contain -other block elements.</p><p>The AsciiDoc block structure can be informally summarized as follows -<a href="#ftn.idm531" class="footnote" id="idm531"><sup class="footnote">[1]</sup></a>:</p><pre class="literallayout">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)*)</pre><p>Where:</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -<span class="emphasis"><em>?</em></span> implies zero or one occurrence, <span class="emphasis"><em>+</em></span> implies one or more - occurrences, <span class="emphasis"><em>*</em></span> implies zero or more occurrences. -</li><li class="listitem"> -All block elements are separated by line boundaries. -</li><li class="listitem"> -<code class="literal">BlockId</code>, <code class="literal">AttributeEntry</code> and <code class="literal">AttributeList</code> block elements (not - shown) can occur almost anywhere. -</li><li class="listitem"> -There are a number of document type and backend specific - restrictions imposed on the block syntax. -</li><li class="listitem"> -The following elements cannot contain blank lines: Header, Title, - Paragraph, ItemText. -</li><li class="listitem"> -A ListParagraph is a Paragraph with its <span class="emphasis"><em>listelement</em></span> option set. -</li><li class="listitem"> -A ListContinuation is a <a class="link" href="ch17.html#X15" title="17.7. List Item Continuation">list continuation element</a>. -</li></ul></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="X95"></a>8.2. Header</h2></div></div></div><p>The Header contains document meta-data, typically title plus optional -authorship and revision information:</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -The Header is optional, but if it is used it must start with a - document <a class="link" href="ch11.html" title="Chapter 11. Titles">title</a>. -</li><li class="listitem"> -Optional Author and Revision information immediately follows the - header title. -</li><li class="listitem"> -The document header must be separated from the remainder of the - document by one or more blank lines and cannot contain blank lines. -</li><li class="listitem"> -The header can include comments. -</li><li class="listitem"> -The header can include <a class="link" href="ch28.html" title="Chapter 28. Attribute Entries">attribute entries</a>, typically - <span class="emphasis"><em>doctype</em></span>, <span class="emphasis"><em>lang</em></span>, <span class="emphasis"><em>encoding</em></span>, <span class="emphasis"><em>icons</em></span>, <span class="emphasis"><em>data-uri</em></span>, <span class="emphasis"><em>toc</em></span>, - <span class="emphasis"><em>numbered</em></span>. -</li><li class="listitem"> -Header attributes are overridden by command-line attributes. -</li><li class="listitem"> -If the header contains non-UTF-8 characters then the <span class="emphasis"><em>encoding</em></span> must - precede the header (either in the document or on the command-line). -</li></ul></div><p>Here’s an example AsciiDoc document header:</p><pre class="literallayout">Writing Documentation using AsciiDoc -==================================== -Joe Bloggs <jbloggs@mymail.com> -v2.0, February 2003: -Rewritten for version 2 release.</pre><p>The author information line contains the author’s name optionally -followed by the author’s email address. The author’s name is formatted -like:</p><pre class="literallayout">firstname[ [middlename ]lastname][ <email>]]</pre><p>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:</p><pre class="literallayout">Joe Bloggs <jbloggs@mymail.com> -Joe Bloggs -Vincent Willem van_Gogh</pre><p>If the author line does not match the above specification then the -entire author line is treated as the first name.</p><p>The optional revision information line follows the author information -line. The revision information can be one of two formats:</p><div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><p class="simpara"> -An optional document revision number followed by an optional - revision date followed by an optional revision remark: -</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -If the revision number is specified it must be followed by a - comma. -</li><li class="listitem"> -The revision number must contain at least one numeric character. -</li><li class="listitem"> -Any non-numeric characters preceding the first numeric character - will be dropped. -</li><li class="listitem"> -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. -</li><li class="listitem"> -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 - <span class="emphasis"><em>docdate</em></span> attribute. -</li></ul></div><p class="simpara">Examples:</p><pre class="literallayout">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.</pre></li><li class="listitem"><p class="simpara"> -The revision information line can also be an RCS/CVS/SVN $Id$ - marker: -</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -AsciiDoc extracts the <span class="emphasis"><em>revnumber</em></span>, <span class="emphasis"><em>revdate</em></span>, and <span class="emphasis"><em>author</em></span> - attributes from the $Id$ revision marker and displays them in the - document header. -</li><li class="listitem"> -If an $Id$ revision marker is used the header author line can be - omitted. -</li></ul></div><p class="simpara">Example:</p><pre class="literallayout">$Id: mydoc.txt,v 1.5 2009/05/17 17:58:44 jbloggs Exp $</pre></li></ol></div><p>You can override or set header parameters by passing <span class="emphasis"><em>revnumber</em></span>, -<span class="emphasis"><em>revremark</em></span>, <span class="emphasis"><em>revdate</em></span>, <span class="emphasis"><em>email</em></span>, <span class="emphasis"><em>author</em></span>, <span class="emphasis"><em>authorinitials</em></span>, -<span class="emphasis"><em>firstname</em></span> and <span class="emphasis"><em>lastname</em></span> attributes using the asciidoc(1) <code class="literal">-a</code> -(<code class="literal">--attribute</code>) command-line option. For example:</p><pre class="literallayout">$ asciidoc -a revdate=2004/07/27 article.txt</pre><p>Attribute entries can also be added to the header for substitution in -the header template with <a class="link" href="ch28.html" title="Chapter 28. Attribute Entries">Attribute Entry</a> elements.</p><p>The <span class="emphasis"><em>title</em></span> element in HTML outputs is set to the AsciiDoc document -title, you can set it to a different value by including a <span class="emphasis"><em>title</em></span> -attribute entry in the document header.</p><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="X87"></a>8.2.1. Additional document header information</h3></div></div></div><p>AsciiDoc has two mechanisms for optionally including additional -meta-data in the header of the output document:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"> -<span class="emphasis"><em>docinfo</em></span> configuration file sections -</span></dt><dd> -If a <a class="link" href="ch26.html" title="Chapter 26. Configuration Files">configuration file</a> section named <span class="emphasis"><em>docinfo</em></span> has been loaded -then it will be included in the document header. Typically the -<span class="emphasis"><em>docinfo</em></span> section name will be prefixed with a <span class="emphasis"><em>+</em></span> character so that it -is appended to (rather than replace) other <span class="emphasis"><em>docinfo</em></span> sections. -</dd><dt><span class="term"> -<span class="emphasis"><em>docinfo</em></span> files -</span></dt><dd> -Two docinfo files are recognized: one named <code class="literal">docinfo</code> and a second -named like the AsciiDoc source file with a <code class="literal">-docinfo</code> suffix. For -example, if the source document is called <code class="literal">mydoc.txt</code> then the -document information files would be <code class="literal">docinfo.xml</code> and -<code class="literal">mydoc-docinfo.xml</code> (for DocBook outputs) and <code class="literal">docinfo.html</code> and -<code class="literal">mydoc-docinfo.html</code> (for HTML outputs). The <a class="link" href="aph.html#X97">docinfo</a> attributes control which docinfo files are included in -the output files. -</dd></dl></div><p>The contents docinfo templates and files is dependent on the type of -output:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"> -HTML -</span></dt><dd> - Valid <span class="emphasis"><em>head</em></span> child elements. Typically <span class="emphasis"><em>style</em></span> and <span class="emphasis"><em>script</em></span> elements - for CSS and JavaScript inclusion. -</dd><dt><span class="term"> -DocBook -</span></dt><dd> - Valid <span class="emphasis"><em>articleinfo</em></span> or <span class="emphasis"><em>bookinfo</em></span> child elements. DocBook defines - numerous elements for document meta-data, for example: copyrights, - document history and authorship information. See the DocBook - <code class="literal">./doc/article-docinfo.xml</code> example that comes with the AsciiDoc - distribution. The rendering of meta-data elements (or not) is - DocBook processor dependent. -</dd></dl></div></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="X86"></a>8.3. Preamble</h2></div></div></div><p>The Preamble is an optional untitled section body between the document -Header and the first Section title.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_sections"></a>8.4. Sections</h2></div></div></div><p>In addition to the document title (level 0), AsciiDoc supports four -section levels: 1 (top) to 4 (bottom). Section levels are delimited -by section <a class="link" href="ch11.html" title="Chapter 11. Titles">titles</a>. Sections are translated using -configuration file <a class="link" href="ch08.html#X93" title="8.4.1. Section markup templates">section markup templates</a>. AsciiDoc -generates the following <a class="link" href="ch31.html" title="Chapter 31. Intrinsic Attributes">intrinsic attributes</a> specifically for -use in section markup templates:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"> -level -</span></dt><dd> -The <code class="literal">level</code> attribute is the section level number, it is normally just -the <a class="link" href="ch11.html" title="Chapter 11. Titles">title</a> level number (1..4). However, if the <code class="literal">leveloffset</code> -attribute is defined it will be added to the <code class="literal">level</code> attribute. The -<code class="literal">leveloffset</code> attribute is useful for <a class="link" href="ch36.html#X90" title="36.5. Combining separate documents">combining documents</a>. -</dd><dt><span class="term"> -sectnum -</span></dt><dd> -The <code class="literal">-n</code> (<code class="literal">--section-numbers</code>) command-line option generates the -<code class="literal">sectnum</code> (section number) attribute. The <code class="literal">sectnum</code> attribute is used -for section numbers in HTML outputs (DocBook section numbering are -handled automatically by the DocBook toolchain commands). -</dd></dl></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="X93"></a>8.4.1. Section markup templates</h3></div></div></div><p>Section markup templates specify output markup and are defined in -AsciiDoc configuration files. Section markup template names are -derived as follows (in order of precedence):</p><div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><p class="simpara"> -From the title’s first positional attribute or <span class="emphasis"><em>template</em></span> - attribute. For example, the following three section titles are - functionally equivalent: -</p><pre class="literallayout">[[terms]] -[glossary] -List of Terms -------------- - -["glossary",id="terms"] -List of Terms -------------- - -[template="glossary",id="terms"] -List of Terms --------------</pre></li><li class="listitem"> -When the title text matches a configuration file - <a class="link" href="ch08.html#X16" title="8.4.3. Special Section Titles"><code class="literal">[specialsections]</code></a> entry. -</li><li class="listitem"> -If neither of the above the default <code class="literal">sect<level></code> template is used - (where <code class="literal"><level></code> is a number from 1 to 4). -</li></ol></div><p>In addition to the normal section template names (<span class="emphasis"><em>sect1</em></span>, <span class="emphasis"><em>sect2</em></span>, -<span class="emphasis"><em>sect3</em></span>, <span class="emphasis"><em>sect4</em></span>) AsciiDoc has the following templates for -frontmatter, backmatter and other special sections: <span class="emphasis"><em>abstract</em></span>, -<span class="emphasis"><em>preface</em></span>, <span class="emphasis"><em>colophon</em></span>, <span class="emphasis"><em>dedication</em></span>, <span class="emphasis"><em>glossary</em></span>, <span class="emphasis"><em>bibliography</em></span>, -<span class="emphasis"><em>synopsis</em></span>, <span class="emphasis"><em>appendix</em></span>, <span class="emphasis"><em>index</em></span>. These special section templates -generate the corresponding Docbook elements; for HTML outputs they -default to the <span class="emphasis"><em>sect1</em></span> section template.</p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_section_ids"></a>8.4.2. Section IDs</h3></div></div></div><p>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 -<span class="strong"><strong>after</strong></span> 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.</p><p>The IDs are generated by the following algorithm:</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -Replace all non-alphanumeric title characters with underscores. -</li><li class="listitem"> -Strip leading or trailing underscores. -</li><li class="listitem"> -Convert to lowercase. -</li><li class="listitem"> -Prepend the <code class="literal">idprefix</code> attribute (so there’s no possibility of name - clashes with existing document IDs). Prepend an underscore if the - <code class="literal">idprefix</code> attribute is not defined. -</li><li class="listitem"> -A numbered suffix (<code class="literal">_2</code>, <code class="literal">_3</code> …) is added if a same named - auto-generated section ID exists. -</li><li class="listitem"> -If the <code class="literal">ascii-ids</code> attribute is defined then non-ASCII characters - are replaced with ASCII equivalents. This attribute should be - <span class="strong"><strong>should be avoided</strong></span> if possible as its sole purpose is to accommodate - deficient downstream applications that cannot process non-ASCII ID - attributes. If available, it will use the - <a class="ulink" href="https://pypi.org/project/trans/" target="_top">trans python module</a>, otherwise it - will fallback to using NFKD algorithm, which cannot handle all - unicode characters. For example, <span class="emphasis"><em>Wstęp żółtej łąki</em></span> will be - translated to <span class="emphasis"><em>Wstep zoltej laki</em></span> under trans and <span class="emphasis"><em>Wstep zotej aki</em></span> - under NFKD. -</li></ul></div><p>Example: the title <span class="emphasis"><em>Jim’s House</em></span> would generate the ID <code class="literal">_jim_s_house</code>.</p><p>Section ID synthesis can be disabled by undefining the <code class="literal">sectids</code> -attribute.</p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="X16"></a>8.4.3. Special Section Titles</h3></div></div></div><p>AsciiDoc has a mechanism for mapping predefined section titles -auto-magically to specific markup templates. For example a title -<span class="emphasis"><em>Appendix A: Code Reference</em></span> will automatically use the <span class="emphasis"><em>appendix</em></span> -<a class="link" href="ch08.html#X93" title="8.4.1. Section markup templates">section markup template</a>. The mappings from title to template -name are specified in <code class="literal">[specialsections]</code> sections in the Asciidoc -language configuration files (<code class="literal">lang-*.conf</code>). Section entries are -formatted like:</p><pre class="literallayout"><title>=<template></pre><p><code class="literal"><title></code> is a Python regular expression and <code class="literal"><template></code> is the name -of a configuration file markup template section. If the <code class="literal"><title></code> -matches an AsciiDoc document section title then the backend output is -marked up using the <code class="literal"><template></code> markup template (instead of the -default <code class="literal">sect<level></code> section template). The <code class="literal">{title}</code> attribute value -is set to the value of the matched regular expression group named -<span class="emphasis"><em>title</em></span>, if there is no <span class="emphasis"><em>title</em></span> group <code class="literal">{title}</code> defaults to the whole -of the AsciiDoc section title. If <code class="literal"><template></code> is blank then any -existing entry with the same <code class="literal"><title></code> will be deleted.</p><div class="sidebar"><div class="titlepage"><div><div><p class="title"><strong>Special section titles vs. explicit template names</strong></p></div></div></div><p>AsciiDoc has two mechanisms for specifying non-default section markup -templates: you can specify the template name explicitly (using the -<span class="emphasis"><em>template</em></span> attribute) or indirectly (using <span class="emphasis"><em>special section titles</em></span>). -Specifying a <a class="link" href="ch08.html#X93" title="8.4.1. Section markup templates">section template</a> attribute explicitly is -preferred. Auto-magical <span class="emphasis"><em>special section titles</em></span> have the following -drawbacks:</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -They are non-obvious, you have to know the exact matching - title for each special section on a language by language basis. -</li><li class="listitem"> -Section titles are predefined and can only be customised with a - configuration change. -</li><li class="listitem"> -The implementation is complicated by multiple languages: every - special section title has to be defined for each language (in each - of the <code class="literal">lang-*.conf</code> files). -</li></ul></div><p>Specifying special section template names explicitly does add more -noise to the source document (the <span class="emphasis"><em>template</em></span> attribute declaration), -but the intention is obvious and the syntax is consistent with other -AsciiDoc elements c.f. bibliographic, Q&A and glossary lists.</p><p>Special section titles have been deprecated but are retained for -backward compatibility.</p></div></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_inline_elements"></a>8.5. Inline Elements</h2></div></div></div><p><a class="link" href="go01.html#X34">Inline document elements</a> are used to format text and to -perform various types of text substitution. Inline elements and inline -element syntax is defined in the asciidoc(1) configuration files.</p><p>Here is a list of AsciiDoc inline elements in the (default) order in -which they are processed:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"> -Special characters -</span></dt><dd> - These character sequences escape special characters used by - the backend markup (typically <code class="literal"><</code>, <code class="literal">></code>, and <code class="literal">&</code> characters). - See <code class="literal">[specialcharacters]</code> configuration file sections. -</dd><dt><span class="term"> -Quotes -</span></dt><dd> - Elements that markup words and phrases; usually for character - formatting. See <code class="literal">[quotes]</code> configuration file sections. -</dd><dt><span class="term"> -Special Words -</span></dt><dd> - Word or word phrase patterns singled out for markup without - the need for further annotation. See <code class="literal">[specialwords]</code> - configuration file sections. -</dd><dt><span class="term"> -Replacements -</span></dt><dd> - Each replacement defines a word or word phrase pattern to - search for along with corresponding replacement text. See - <code class="literal">[replacements]</code> configuration file sections. -</dd><dt><span class="term"> -Attribute references -</span></dt><dd> - Document attribute names enclosed in braces are replaced by - the corresponding attribute value. -</dd><dt><span class="term"> -Inline Macros -</span></dt><dd> - Inline macros are replaced by the contents of parametrized - configuration file sections. -</dd></dl></div></div><div class="footnotes"><br /><hr style="width:100; text-align:left;margin-left: 0" /><div id="ftn.idm531" class="footnote"><p><a href="#idm531" class="simpara"><sup class="simpara">[1] </sup></a>This is a rough structural guide, not a rigorous syntax -definition</p></div></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch07.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch09.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/icons/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
\ No newline at end of file diff --git a/chunked/ch09.html b/chunked/ch09.html deleted file mode 100644 index 0231242..0000000 --- a/chunked/ch09.html +++ /dev/null @@ -1,34 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Chapter 9. Document Processing</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="AsciiDoc User Guide" /><link rel="up" href="index.html" title="AsciiDoc User Guide" /><link rel="prev" href="ch08.html" title="Chapter 8. Document Structure" /><link rel="next" href="ch10.html" title="Chapter 10. Text Formatting" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="ch08.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch10.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a id="_document_processing"></a>Chapter 9. Document Processing</h1></div></div></div><p>The AsciiDoc source document is read and processed as follows:</p><div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -The document <span class="emphasis"><em>Header</em></span> is parsed, header parameter values are - substituted into the configuration file <code class="literal">[header]</code> template section - which is then written to the output file. -</li><li class="listitem"> -Each document <span class="emphasis"><em>Section</em></span> is processed and its constituent elements - translated to the output file. -</li><li class="listitem"> -The configuration file <code class="literal">[footer]</code> template section is substituted - and written to the output file. -</li></ol></div><p>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.</p><p>The default paragraph definition <code class="literal">[paradef-default]</code> is last element -to be checked.</p><p>Knowing the parsing order will help you devise unambiguous macro, list -and block syntax rules.</p><p>Inline substitutions within block elements are performed in the -following default order:</p><div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -Special characters -</li><li class="listitem"> -Quotes -</li><li class="listitem"> -Special words -</li><li class="listitem"> -Replacements -</li><li class="listitem"> -Attributes -</li><li class="listitem"> -Inline Macros -</li><li class="listitem"> -Replacements2 -</li></ol></div><p>The substitutions and substitution order performed on -Title, Paragraph and DelimitedBlock elements is determined by -configuration file parameters.</p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch08.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch10.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/icons/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
\ No newline at end of file diff --git a/chunked/ch10.html b/chunked/ch10.html deleted file mode 100644 index d5f41e6..0000000 --- a/chunked/ch10.html +++ /dev/null @@ -1,120 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Chapter 10. Text Formatting</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="AsciiDoc User Guide" /><link rel="up" href="index.html" title="AsciiDoc User Guide" /><link rel="prev" href="ch09.html" title="Chapter 9. Document Processing" /><link rel="next" href="ch11.html" title="Chapter 11. Titles" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="ch09.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch11.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a id="_text_formatting"></a>Chapter 10. Text Formatting</h1></div></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="X51"></a>10.1. Quoted Text</h2></div></div></div><p>Words and phrases can be formatted by enclosing inline text with -quote characters:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"> -<span class="emphasis"><em>Emphasized text</em></span> -</span></dt><dd> - Word phrases 'enclosed in single quote characters' (acute - accents) or _underline characters_ are emphasized. -</dd><dt><span class="term"> -<span class="strong"><strong>Strong text</strong></span> -</span></dt><dd> - Word phrases *enclosed in asterisk characters* are rendered - in a strong font (usually bold). -</dd><dt><span class="term"> -<a id="X81"></a><code class="literal">Monospaced text</code> -</span></dt><dd> - 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 (see <a class="link" href="ch21.html#X80">inline literal passthrough</a>). -</dd><dt><span class="term"> -‘Single quoted text’ -</span></dt><dd> - Phrases enclosed with a `single grave accent to the left and - a single acute accent to the right' are rendered in single - quotation marks. -</dd><dt><span class="term"> -“Double quoted text” -</span></dt><dd> - Phrases enclosed with ``two grave accents to the left and - two acute accents to the right'' are rendered in quotation - marks. -</dd><dt><span class="term"> -Unquoted text -</span></dt><dd> - Placing #hashes around text# does nothing, it is a mechanism - to allow inline attributes to be applied to otherwise - unformatted text. -</dd></dl></div><p>New quote types can be defined by editing asciidoc(1) configuration -files. See the <a class="link" href="ch26.html" title="Chapter 26. Configuration Files">Configuration Files</a> section for details.</p><div class="itemizedlist"><p class="title"><strong>Quoted text behavior</strong></p><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -Quoting cannot be overlapped. -</li><li class="listitem"> -Different quoting types can be nested. -</li><li class="listitem"> -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. -</li></ul></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="X96"></a>10.1.1. Quoted text attributes</h3></div></div></div><p>Quoted text can be prefixed with an <a class="link" href="ch29.html" title="Chapter 29. Attribute Lists">attribute list</a>. The first -positional attribute (<span class="emphasis"><em>role</em></span> attribute) is translated by AsciiDoc to -an HTML <span class="emphasis"><em>span</em></span> element <span class="emphasis"><em>class</em></span> attribute or a DocBook <span class="emphasis"><em>phrase</em></span> element -<span class="emphasis"><em>role</em></span> attribute.</p><p>DocBook XSL Stylesheets translate DocBook <span class="emphasis"><em>phrase</em></span> elements with -<span class="emphasis"><em>role</em></span> attributes to corresponding HTML <span class="emphasis"><em>span</em></span> elements with the same -<span class="emphasis"><em>class</em></span> attributes; CSS can then be used -<a class="ulink" href="http://www.sagehill.net/docbookxsl/UsingCSS.html" target="_top">to style the -generated HTML</a>. Thus CSS styling can be applied to both DocBook and -AsciiDoc generated HTML outputs. You can also specify multiple class -names separated by spaces.</p><p>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 <span class="emphasis"><em>xhtml11</em></span>, <span class="emphasis"><em>html5</em></span> and <span class="emphasis"><em>docbook</em></span> -outputs. The CSS class names are:</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -<span class="emphasis"><em><color></em></span> (text foreground color). -</li><li class="listitem"> -<span class="emphasis"><em><color>-background</em></span> (text background color). -</li><li class="listitem"> -<span class="emphasis"><em>big</em></span> and <span class="emphasis"><em>small</em></span> (text size). -</li><li class="listitem"> -<span class="emphasis"><em>underline</em></span>, <span class="emphasis"><em>overline</em></span> and <span class="emphasis"><em>line-through</em></span> (strike through) text - decorators. -</li></ul></div><p>Where <span class="emphasis"><em><color></em></span> can be any of the -<a class="ulink" href="http://en.wikipedia.org/wiki/Web_colors#HTML_color_names" target="_top">sixteen HTML -color names</a>. Examples:</p><pre class="literallayout">[red]#Obvious# and [big red yellow-background]*very obvious*.</pre><pre class="literallayout">[underline]#Underline text#, [overline]#overline text# and -[blue line-through]*bold blue and line-through*.</pre><p>is rendered as:</p><p><span class="red">Obvious</span> and <span class="strong"><strong><span class="big red yellow-background">very obvious</span></strong></span>.</p><p><span class="underline">Underline text</span>, <span class="overline">overline text</span> and -<span class="strong"><strong><span class="bold blue line-through">bold blue and line-through</span></strong></span>.</p><div class="note" style="margin-left: 0; margin-right: 10%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/icons/note.png" /></td><th align="left"></th></tr><tr><td align="left" valign="top"><p>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 provided for DocBook toolchains -via the DocBook <span class="emphasis"><em>phrase</em></span> element <span class="emphasis"><em>role</em></span> attribute, but the actual -rendering is toolchain specific and is not part of the AsciiDoc -distribution.</p></td></tr></table></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="X52"></a>10.1.2. Constrained and Unconstrained Quotes</h3></div></div></div><p>There are actually two types of quotes:</p><div class="section"><div class="titlepage"><div><div><h4 class="title"><a id="_constrained_quotes"></a>Constrained quotes</h4></div></div></div><p>Quoted must be bounded by white space or commonly adjoining -punctuation characters. These are the most commonly used type of -quote.</p></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a id="_unconstrained_quotes"></a>Unconstrained quotes</h4></div></div></div><p>Unconstrained quotes have no boundary constraints and can be placed -anywhere within inline text. For consistency and to make them easier -to remember unconstrained quotes are double-ups of the <code class="literal">_</code>, <code class="literal">*</code>, <code class="literal">+</code> -and <code class="literal">#</code> constrained quotes:</p><pre class="literallayout">__unconstrained emphasized text__ -**unconstrained strong text** -++unconstrained monospaced text++ -##unconstrained unquoted text##</pre><p>The following example emboldens the letter F:</p><pre class="literallayout">**F**ile Open...</pre></div></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_superscripts_and_subscripts"></a>10.2. Superscripts and Subscripts</h2></div></div></div><p>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:</p><pre class="literallayout">e^&#960;i^+1 = 0. H~2~O and x^10^. Some ^super text^ -and ~some sub text~</pre><p>Is rendered like:</p><p>e<sup>πi</sup>+1 = 0. H<sub>2</sub>O and x<sup>10</sup>. Some <sup>super text</sup> -and <sub>some sub text</sub></p><p>Superscripts and subscripts are implemented as <a class="link" href="ch10.html#X52" title="10.1.2. Constrained and Unconstrained Quotes">unconstrained quotes</a> and they can be escaped with a leading backslash and prefixed -with with an attribute list.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_line_breaks"></a>10.3. Line Breaks</h2></div></div></div><p>A plus 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 -(<code class="literal">br</code>) tag for HTML outputs and a custom XML <code class="literal">asciidoc-br</code> processing -instruction for DocBook outputs. The <code class="literal">asciidoc-br</code> processing -instruction is handled by <a class="link" href="ch05.html#X43" title="5.2. a2x Toolchain Wrapper">a2x(1)</a>.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_page_breaks"></a>10.4. Page Breaks</h2></div></div></div><p>A line of three or more less-than (<code class="literal"><<<</code>) characters will generate a -hard page break in DocBook and printed HTML outputs. It uses the CSS -<code class="literal">page-break-after</code> property for HTML outputs and a custom XML -<code class="literal">asciidoc-pagebreak</code> processing instruction for DocBook outputs. The -<code class="literal">asciidoc-pagebreak</code> processing instruction is handled by -<a class="link" href="ch05.html#X43" title="5.2. a2x Toolchain Wrapper">a2x(1)</a>. Hard page breaks are sometimes handy but as a general -rule you should let your page processor generate page breaks for you.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_rulers"></a>10.5. Rulers</h2></div></div></div><p>A line of three or more apostrophe characters will generate a ruler -line. It generates a ruler (<code class="literal">hr</code>) tag for HTML outputs and a custom -XML <code class="literal">asciidoc-hr</code> processing instruction for DocBook outputs. The -<code class="literal">asciidoc-hr</code> processing instruction is handled by <a class="link" href="ch05.html#X43" title="5.2. a2x Toolchain Wrapper">a2x(1)</a>.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_tabs"></a>10.6. Tabs</h2></div></div></div><p>By default tab characters input files will translated to 8 spaces. Tab -expansion is set with the <span class="emphasis"><em>tabsize</em></span> entry in the configuration file -<code class="literal">[miscellaneous]</code> section and can be overridden in included files by -setting a <span class="emphasis"><em>tabsize</em></span> attribute in the <code class="literal">include</code> macro’s attribute list. -For example:</p><pre class="literallayout">include::addendum.txt[tabsize=2]</pre><p>The tab size can also be set using the attribute command-line option, -for example <code class="literal">--attribute tabsize=4</code></p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_replacements"></a>10.7. Replacements</h2></div></div></div><p>The following replacements are defined in the default AsciiDoc -configuration:</p><pre class="literallayout">(C) copyright, (TM) trademark, (R) registered trademark, --- em dash, ... ellipsis, -> right arrow, <- left arrow, => right -double arrow, <= left double arrow.</pre><p>Which are rendered as:</p><p>© copyright, ™ trademark, ® registered trademark, — em dash, … ellipsis, → right arrow, ← left arrow, ⇒ right -double arrow, ⇐ left double arrow.</p><p>You can also include arbitrary entity references in the AsciiDoc -source. Examples:</p><pre class="literallayout">&#x278a; &#182;</pre><p>renders:</p><p>➊ ¶</p><p>To render a replacement literally escape it with a leading back-slash.</p><p>The <a class="link" href="ch26.html" title="Chapter 26. Configuration Files">Configuration Files</a> section explains how to configure your -own replacements.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_special_words"></a>10.8. Special Words</h2></div></div></div><p>Words defined in <code class="literal">[specialwords]</code> configuration file sections are -automatically marked up without having to be explicitly notated.</p><p>The <a class="link" href="ch26.html" title="Chapter 26. Configuration Files">Configuration Files</a> section explains how to add and replace -special words.</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch09.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch11.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/icons/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
\ No newline at end of file diff --git a/chunked/ch11.html b/chunked/ch11.html deleted file mode 100644 index f6a8d78..0000000 --- a/chunked/ch11.html +++ /dev/null @@ -1,32 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Chapter 11. Titles</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="AsciiDoc User Guide" /><link rel="up" href="index.html" title="AsciiDoc User Guide" /><link rel="prev" href="ch10.html" title="Chapter 10. Text Formatting" /><link rel="next" href="ch12.html" title="Chapter 12. Block Titles" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="ch10.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch12.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a id="X17"></a>Chapter 11. Titles</h1></div></div></div><p>Document and section titles can be in either of two formats:</p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_two_line_titles"></a>11.1. Two line titles</h2></div></div></div><p>A two line title consists of a title line, starting hard against the -left margin, and an underline. Section underlines consist a repeated -character pairs spanning the width of the preceding title (give or -take up to two characters):</p><p>The default title underlines for each of the document levels are:</p><pre class="literallayout">Level 0 (top level): ====================== -Level 1: ---------------------- -Level 2: ~~~~~~~~~~~~~~~~~~~~~~ -Level 3: ^^^^^^^^^^^^^^^^^^^^^^ -Level 4 (bottom level): ++++++++++++++++++++++</pre><p>Examples:</p><pre class="literallayout">Level One Section Title ------------------------</pre><pre class="literallayout">Level 2 Subsection Title -~~~~~~~~~~~~~~~~~~~~~~~~</pre></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="X46"></a>11.2. One line titles</h2></div></div></div><p>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:</p><pre class="literallayout">= Document Title (level 0) = -== Section title (level 1) == -=== Section title (level 2) === -==== Section title (level 3) ==== -===== Section title (level 4) =====</pre><div class="note" style="margin-left: 0; margin-right: 10%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/icons/note.png" /></td><th align="left"></th></tr><tr><td align="left" valign="top"><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -One or more spaces must fall between the title and the delimiters. -</li><li class="listitem"> -The trailing title delimiter is optional. -</li><li class="listitem"> -The one-line title syntax can be changed by editing the - configuration file <code class="literal">[titles]</code> section <code class="literal">sect0</code>…<code class="literal">sect4</code> entries. -</li></ul></div></td></tr></table></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_floating_titles"></a>11.3. Floating titles</h2></div></div></div><p>Setting the title’s first positional attribute or <span class="emphasis"><em>style</em></span> attribute to -<span class="emphasis"><em>float</em></span> 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:</p><pre class="literallayout">[float] -The second day -~~~~~~~~~~~~~~</pre><p>Floating titles do not appear in a document’s table of contents.</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch10.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch12.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/icons/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
\ No newline at end of file diff --git a/chunked/ch12.html b/chunked/ch12.html deleted file mode 100644 index eb7778c..0000000 --- a/chunked/ch12.html +++ /dev/null @@ -1,11 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Chapter 12. Block Titles</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="AsciiDoc User Guide" /><link rel="up" href="index.html" title="AsciiDoc User Guide" /><link rel="prev" href="ch11.html" title="Chapter 11. Titles" /><link rel="next" href="ch13.html" title="Chapter 13. BlockId Element" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="ch11.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch13.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a id="X42"></a>Chapter 12. Block Titles</h1></div></div></div><p>A <span class="emphasis"><em>BlockTitle</em></span> element is a single line beginning with a period -followed by the title text. A BlockTitle is applied to the immediately -following Paragraph, DelimitedBlock, List, Table or BlockMacro. For -example:</p><pre class="literallayout">.Notes -- Note 1. -- Note 2.</pre><p>is rendered as:</p><div class="itemizedlist"><p class="title"><strong>Notes</strong></p><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -Note 1. -</li><li class="listitem"> -Note 2. -</li></ul></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch11.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch13.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/icons/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
\ No newline at end of file diff --git a/chunked/ch13.html b/chunked/ch13.html deleted file mode 100644 index 7b7cea4..0000000 --- a/chunked/ch13.html +++ /dev/null @@ -1,13 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Chapter 13. BlockId Element</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="AsciiDoc User Guide" /><link rel="up" href="index.html" title="AsciiDoc User Guide" /><link rel="prev" href="ch12.html" title="Chapter 12. Block Titles" /><link rel="next" href="ch14.html" title="Chapter 14. AttributeList Element" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="ch12.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch14.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a id="X41"></a>Chapter 13. BlockId Element</h1></div></div></div><p>A <span class="emphasis"><em>BlockId</em></span> 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:</p><pre class="literallayout">[[chapter-titles]] -Chapter titles can be ...</pre><p>The preceding example identifies the ensuing paragraph so it can be -referenced from other locations, for example with -<code class="literal"><<chapter-titles,chapter titles>></code>.</p><p><span class="emphasis"><em>BlockId</em></span> elements can be applied to Title, Paragraph, List, -DelimitedBlock, Table and BlockMacro elements. The BlockId element -sets the <code class="literal">{id}</code> attribute for substitution in the subsequent block’s -markup template. If a second positional argument is supplied it sets -the <code class="literal">{reftext}</code> attribute which is used to set the DocBook <code class="literal">xreflabel</code> -attribute.</p><p>The <span class="emphasis"><em>BlockId</em></span> element has the same syntax and serves the same function -to the <a class="link" href="ch21.html#X30" title="anchor">anchor inline macro</a>.</p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch12.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch14.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/icons/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
\ No newline at end of file diff --git a/chunked/ch14.html b/chunked/ch14.html deleted file mode 100644 index 74ba9a7..0000000 --- a/chunked/ch14.html +++ /dev/null @@ -1,37 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Chapter 14. AttributeList Element</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="AsciiDoc User Guide" /><link rel="up" href="index.html" title="AsciiDoc User Guide" /><link rel="prev" href="ch13.html" title="Chapter 13. BlockId Element" /><link rel="next" href="ch15.html" title="Chapter 15. Paragraphs" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="ch13.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch15.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a id="X79"></a>Chapter 14. AttributeList Element</h1></div></div></div><p>An <span class="emphasis"><em>AttributeList</em></span> block element is an <a class="link" href="ch29.html" title="Chapter 29. Attribute Lists">attribute list</a> on a -line by itself:</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -<span class="emphasis"><em>AttributeList</em></span> attributes are only applied to the immediately - following block element — the attributes are made available to the - block’s markup template. -</li><li class="listitem"> -Multiple contiguous <span class="emphasis"><em>AttributeList</em></span> elements are additively combined - in the order they appear. -</li><li class="listitem"> -The first positional attribute in the list is often used to specify - the ensuing element’s <a class="link" href="ch32.html#X23" title="32.1. Styles">style</a>. -</li></ul></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_attribute_value_substitution"></a>14.1. Attribute value substitution</h2></div></div></div><p>By default, only substitutions that take place inside attribute list -values are attribute references, this is because not all attributes -are destined to be marked up and rendered as text (for example the -table <span class="emphasis"><em>cols</em></span> 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 <span class="emphasis"><em>http</em></span> macro is expanded to a hyperlink.</p><pre class="screen">[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. -_____________________________________________________________________</pre></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_common_attributes"></a>14.2. Common attributes</h2></div></div></div><p>Most block elements support the following attributes:</p><div class="informaltable"><table class="informaltable" cellpadding="4px" style="border-collapse: collapse;border-top: 3px solid #527bbd; border-bottom: 3px solid #527bbd; "><colgroup><col class="col_1" /><col class="col_2" /><col class="col_3" /></colgroup><thead><tr><th style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top">Name </th><th style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top">Backends </th><th style="border-bottom: 1px solid #527bbd; " align="left" valign="top">Description</th></tr></thead><tbody><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em>id</em></span></p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>html4, html5, xhtml11, docbook</p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>Unique identifier typically serve as link targets. -Can also be set by the <span class="emphasis"><em>BlockId</em></span> element.</p></td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em>role</em></span></p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>html4, html5, xhtml11, docbook</p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>Role contains a string used to classify or subclassify an element and -can be applied to AsciiDoc block elements. The AsciiDoc <span class="emphasis"><em>role</em></span> -attribute is translated to the <span class="emphasis"><em>role</em></span> attribute in DocBook outputs and -is included in the <span class="emphasis"><em>class</em></span> attribute in HTML outputs, in this respect -it behaves like the <a class="link" href="ch10.html#X96" title="10.1.1. Quoted text attributes">quoted text role attribute</a>.</p> -<p>DocBook XSL Stylesheets translate DocBook <span class="emphasis"><em>role</em></span> attributes to HTML -<span class="emphasis"><em>class</em></span> attributes; CSS can then be used -<a class="ulink" href="http://www.sagehill.net/docbookxsl/UsingCSS.html" target="_top">to style the -generated HTML</a>.</p></td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em>reftext</em></span></p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>docbook</p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em>reftext</em></span> is used to set the DocBook <span class="emphasis"><em>xreflabel</em></span> attribute. -The <span class="emphasis"><em>reftext</em></span> attribute can an also be set by the <span class="emphasis"><em>BlockId</em></span> element.</p></td></tr><tr><td style="border-right: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em>floatstyle</em></span></p></td><td style="border-right: 1px solid #527bbd; " align="left" valign="top"><p>docbook</p></td><td style="" align="left" valign="top"><p><span class="emphasis"><em>floatstyle</em></span> is used to specify the floatstyle attribute for the -titled table, example, image and equation blocks. This is useful when -used in conjuction with the dblatex toolchain. A typical example -would be to specify the value as <span class="emphasis"><em>floatstyle="[htbp]"</em></span>.</p></td></tr></tbody></table></div></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch13.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch15.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/icons/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
\ No newline at end of file diff --git a/chunked/ch15.html b/chunked/ch15.html deleted file mode 100644 index 237ffe3..0000000 --- a/chunked/ch15.html +++ /dev/null @@ -1,69 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Chapter 15. Paragraphs</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="AsciiDoc User Guide" /><link rel="up" href="index.html" title="AsciiDoc User Guide" /><link rel="prev" href="ch14.html" title="Chapter 14. AttributeList Element" /><link rel="next" href="ch16.html" title="Chapter 16. Delimited Blocks" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="ch14.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch16.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a id="_paragraphs"></a>Chapter 15. Paragraphs</h1></div></div></div><p>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.</p><p>Each syntax has a default style, but you can explicitly apply any -paragraph style to any paragraph syntax. You can also apply -<a class="link" href="ch16.html" title="Chapter 16. Delimited Blocks">delimited block</a> styles to single paragraphs.</p><p>The built-in paragraph styles are: <span class="emphasis"><em>normal</em></span>, <span class="emphasis"><em>literal</em></span>, <span class="emphasis"><em>verse</em></span>, -<span class="emphasis"><em>quote</em></span>, <span class="emphasis"><em>listing</em></span>, <span class="emphasis"><em>TIP</em></span>, <span class="emphasis"><em>NOTE</em></span>, <span class="emphasis"><em>IMPORTANT</em></span>, <span class="emphasis"><em>WARNING</em></span>, <span class="emphasis"><em>CAUTION</em></span>, -<span class="emphasis"><em>abstract</em></span>, <span class="emphasis"><em>partintro</em></span>, <span class="emphasis"><em>comment</em></span>, <span class="emphasis"><em>example</em></span>, <span class="emphasis"><em>sidebar</em></span>, <span class="emphasis"><em>source</em></span>, -<span class="emphasis"><em>music</em></span>, <span class="emphasis"><em>latex</em></span>, <span class="emphasis"><em>graphviz</em></span>.</p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_normal_paragraph_syntax"></a>15.1. normal paragraph syntax</h2></div></div></div><p>Normal paragraph syntax consists of one or more non-blank lines of -text. The first line must start hard against the left margin (no -intervening white space). The default processing expectation is that -of a normal paragraph of text.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="X85"></a>15.2. literal paragraph syntax</h2></div></div></div><p>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.</p><p>The <span class="emphasis"><em>literal</em></span> 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:</p><pre class="screen"> Consul *necessitatibus* per id, - consetetur, eu pro everti postulant - homero verear ea mea, qui.</pre><p>Renders:</p><pre class="literallayout">Consul *necessitatibus* per id, -consetetur, eu pro everti postulant -homero verear ea mea, qui.</pre><div class="note" style="margin-left: 0; margin-right: 10%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/icons/note.png" /></td><th align="left"></th></tr><tr><td align="left" valign="top"><p>Because <a class="link" href="ch17.html" title="Chapter 17. Lists">lists</a> can be indented it’s possible for your -indented paragraph to be misinterpreted as a list — in situations -like this apply the <span class="emphasis"><em>literal</em></span> style to a normal paragraph.</p></td></tr></table></div><p>Instead of using a paragraph indent you could apply the <span class="emphasis"><em>literal</em></span> -style explicitly, for example:</p><pre class="screen">[literal] -Consul *necessitatibus* per id, -consetetur, eu pro everti postulant -homero verear ea mea, qui.</pre><p>Renders:</p><pre class="literallayout">Consul *necessitatibus* per id, -consetetur, eu pro everti postulant -homero verear ea mea, qui.</pre></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="X94"></a>15.3. quote and verse paragraph styles</h2></div></div></div><p>The optional <span class="emphasis"><em>attribution</em></span> and <span class="emphasis"><em>citetitle</em></span> attributes (positional -attributes 2 and 3) specify the author and source respectively.</p><p>The <span class="emphasis"><em>verse</em></span> style retains the line breaks, for example:</p><pre class="screen">[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.</pre><p>Which is rendered as:</p><div class="blockquote"><table border="0" class="blockquote" style="width: 100%; cellspacing: 0; cellpadding: 0;" summary="Block quote"><tr><td width="10%" valign="top"> </td><td width="80%" valign="top"><div class="literallayout"><p>To see a world in a grain of sand,<br /> -And a heaven in a wild flower,<br /> -Hold infinity in the palm of your hand,<br /> -And eternity in an hour.</p></div></td><td width="10%" valign="top"> </td></tr><tr><td width="10%" valign="top"> </td><td colspan="2" align="right" valign="top">--<span class="attribution"> -William Blake -<em class="citetitle">from Auguries of Innocence</em> -</span></td></tr></table></div><p>The <span class="emphasis"><em>quote</em></span> style flows the text at left and right margins, for -example:</p><pre class="screen">[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.</pre><p>Which is rendered as:</p><div class="blockquote"><table border="0" class="blockquote" style="width: 100%; cellspacing: 0; cellpadding: 0;" summary="Block quote"><tr><td width="10%" valign="top"> </td><td width="80%" valign="top"><p>A good notation has subtlety and suggestiveness which at times makes -it almost seem like a live teacher.</p></td><td width="10%" valign="top"> </td></tr><tr><td width="10%" valign="top"> </td><td colspan="2" align="right" valign="top">--<span class="attribution"> -Bertrand Russell -<em class="citetitle">The World of Mathematics (1956)</em> -</span></td></tr></table></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="X28"></a>15.4. Admonition Paragraphs</h2></div></div></div><p><span class="emphasis"><em>TIP</em></span>, <span class="emphasis"><em>NOTE</em></span>, <span class="emphasis"><em>IMPORTANT</em></span>, <span class="emphasis"><em>WARNING</em></span> and <span class="emphasis"><em>CAUTION</em></span> admonishment -paragraph styles are generated by placing <code class="literal">NOTE:</code>, <code class="literal">TIP:</code>, -<code class="literal">IMPORTANT:</code>, <code class="literal">WARNING:</code> or <code class="literal">CAUTION:</code> as the first word of the -paragraph. For example:</p><pre class="literallayout">NOTE: This is an example note.</pre><p>Alternatively, you can specify the paragraph admonition style -explicitly using an <a class="link" href="ch14.html" title="Chapter 14. AttributeList Element">AttributeList element</a>. For example:</p><pre class="literallayout">[NOTE] -This is an example note.</pre><p>Renders:</p><div class="note" style="margin-left: 0; margin-right: 10%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/icons/note.png" /></td><th align="left"></th></tr><tr><td align="left" valign="top"><p>This is an example note.</p></td></tr></table></div><div class="tip" style="margin-left: 0; margin-right: 10%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="images/icons/tip.png" /></td><th align="left"></th></tr><tr><td align="left" valign="top"><p>If your admonition requires more than a single paragraph use an -<a class="link" href="ch16.html#X22" title="16.9. Admonition Blocks">admonition block</a> instead.</p></td></tr></table></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="X47"></a>15.4.1. Admonition Icons and Captions</h3></div></div></div><div class="note" style="margin-left: 0; margin-right: 10%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/icons/note.png" /></td><th align="left"></th></tr><tr><td align="left" valign="top"><p>Admonition customization with <code class="literal">icons</code>, <code class="literal">iconsdir</code>, <code class="literal">icon</code> and -<code class="literal">caption</code> attributes does not apply when generating DocBook output. If -you are going the DocBook route then the <a class="link" href="ch05.html#X43" title="5.2. a2x Toolchain Wrapper">a2x(1)</a> <code class="literal">--no-icons</code> -and <code class="literal">--icons-dir</code> options can be used to set the appropriate XSL -Stylesheets parameters.</p></td></tr></table></div><p>By default the asciidoc(1) HTML backends generate text captions -instead of admonition icon image links. To generate links to icon -images define the <a class="link" href="aph.html#X45"><code class="literal">icons</code></a> attribute, for example using the <code class="literal">-a -icons</code> command-line option.</p><p>The <a class="link" href="aph.html#X44"><code class="literal">iconsdir</code></a> attribute sets the location of linked icon -images.</p><p>You can override the default icon image using the <code class="literal">icon</code> attribute to -specify the path of the linked image. For example:</p><pre class="literallayout">[icon="./images/icons/wink.png"] -NOTE: What lovely war.</pre><p>Use the <code class="literal">caption</code> attribute to customize the admonition captions (not -applicable to <code class="literal">docbook</code> backend). The following example suppresses the -icon image and customizes the caption of a <span class="emphasis"><em>NOTE</em></span> admonition -(undefining the <code class="literal">icons</code> attribute with <code class="literal">icons=None</code> is only necessary -if <a class="link" href="aph.html#X45">admonition icons</a> have been enabled):</p><pre class="literallayout">[icons=None, caption="My Special Note"] -NOTE: This is my special note.</pre><p>This subsection also applies to <a class="link" href="ch16.html#X22" title="16.9. Admonition Blocks">Admonition Blocks</a>.</p></div></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch14.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch16.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/icons/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
\ No newline at end of file diff --git a/chunked/ch16.html b/chunked/ch16.html deleted file mode 100644 index 7c1aea0..0000000 --- a/chunked/ch16.html +++ /dev/null @@ -1,174 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Chapter 16. Delimited Blocks</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="AsciiDoc User Guide" /><link rel="up" href="index.html" title="AsciiDoc User Guide" /><link rel="prev" href="ch15.html" title="Chapter 15. Paragraphs" /><link rel="next" href="ch17.html" title="Chapter 17. Lists" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="ch15.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch17.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a id="X104"></a>Chapter 16. Delimited Blocks</h1></div></div></div><p>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 <code class="literal">[blockdef-*]</code> sections.</p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_predefined_delimited_blocks"></a>16.1. Predefined Delimited Blocks</h2></div></div></div><p>AsciiDoc ships with a number of predefined DelimitedBlocks (see the -<code class="literal">asciidoc.conf</code> configuration file in the asciidoc(1) program -directory):</p><p>Predefined delimited block underlines:</p><pre class="literallayout">CommentBlock: ////////////////////////// -PassthroughBlock: ++++++++++++++++++++++++++ -ListingBlock: -------------------------- -LiteralBlock: .......................... -SidebarBlock: ************************** -QuoteBlock: __________________________ -ExampleBlock: ========================== -OpenBlock: --</pre><div class="table"><a id="idm1337"></a><p class="title"><strong>Table 16.1. Default DelimitedBlock substitutions</strong></p><div class="table-contents"><table class="table" summary="Default DelimitedBlock substitutions" cellpadding="4px" style="border-collapse: collapse;border-top: 3px solid #527bbd; border-bottom: 3px solid #527bbd; "><colgroup><col class="col_1" /><col class="col_2" /><col class="col_3" /><col class="col_4" /><col class="col_5" /><col class="col_6" /><col class="col_7" /><col class="col_8" /></colgroup><thead><tr><th style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"> </th><th style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top">Attributes </th><th style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top">Callouts </th><th style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top">Macros </th><th style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top"> Quotes </th><th style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top">Replacements</th><th style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top">Special chars </th><th style="border-bottom: 1px solid #527bbd; " align="center" valign="top">Special words</th></tr></thead><tbody><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em>PassthroughBlock</em></span></p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top"><p>Yes</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top"><p>No</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top"><p>Yes</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top"><p>No</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top"><p>No</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top"><p>No</p></td><td style="border-bottom: 1px solid #527bbd; " align="center" valign="top"><p>No</p></td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em>ListingBlock</em></span></p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top"><p>No</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top"><p>Yes</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top"><p>No</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top"><p>No</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top"><p>No</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top"><p>Yes</p></td><td style="border-bottom: 1px solid #527bbd; " align="center" valign="top"><p>No</p></td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em>LiteralBlock</em></span></p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top"><p>No</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top"><p>Yes</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top"><p>No</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top"><p>No</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top"><p>No</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top"><p>Yes</p></td><td style="border-bottom: 1px solid #527bbd; " align="center" valign="top"><p>No</p></td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em>SidebarBlock</em></span></p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top"><p>Yes</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top"><p>No</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top"><p>Yes</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top"><p>Yes</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top"><p>Yes</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top"><p>Yes</p></td><td style="border-bottom: 1px solid #527bbd; " align="center" valign="top"><p>Yes</p></td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em>QuoteBlock</em></span></p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top"><p>Yes</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top"><p>No</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top"><p>Yes</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top"><p>Yes</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top"><p>Yes</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top"><p>Yes</p></td><td style="border-bottom: 1px solid #527bbd; " align="center" valign="top"><p>Yes</p></td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em>ExampleBlock</em></span></p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top"><p>Yes</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top"><p>No</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top"><p>Yes</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top"><p>Yes</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top"><p>Yes</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top"><p>Yes</p></td><td style="border-bottom: 1px solid #527bbd; " align="center" valign="top"><p>Yes</p></td></tr><tr><td style="border-right: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em>OpenBlock</em></span></p></td><td style="border-right: 1px solid #527bbd; " align="center" valign="top"><p>Yes</p></td><td style="border-right: 1px solid #527bbd; " align="center" valign="top"><p>No</p></td><td style="border-right: 1px solid #527bbd; " align="center" valign="top"><p>Yes</p></td><td style="border-right: 1px solid #527bbd; " align="center" valign="top"><p>Yes</p></td><td style="border-right: 1px solid #527bbd; " align="center" valign="top"><p>Yes</p></td><td style="border-right: 1px solid #527bbd; " align="center" valign="top"><p>Yes</p></td><td style="" align="center" valign="top"><p>Yes</p></td></tr></tbody></table></div></div><br class="table-break" /></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_listing_blocks"></a>16.2. Listing Blocks</h2></div></div></div><p><span class="emphasis"><em>ListingBlocks</em></span> are rendered verbatim in a monospaced font, they -retain line and whitespace formatting and 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.</p><p>Here’s an example:</p><pre class="screen">-------------------------------------- -#include <stdio.h> - -int main() { - printf("Hello World!\n"); - exit(0); -} ---------------------------------------</pre><p>Which will be rendered like:</p><pre class="screen">#include <stdio.h> - -int main() { - printf("Hello World!\n"); - exit(0); -}</pre><p>By convention <a class="link" href="ch33.html" title="Chapter 33. Filters">filter blocks</a> use the listing block syntax and -are implemented as distinct listing block styles.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="X65"></a>16.3. Literal Blocks</h2></div></div></div><p><span class="emphasis"><em>LiteralBlocks</em></span> are rendered just like <a class="link" href="ch15.html#X85" title="15.2. literal paragraph syntax">literal paragraphs</a>. -Example:</p><pre class="screen">................................... -Consul *necessitatibus* per id, -consetetur, eu pro everti postulant -homero verear ea mea, qui. -...................................</pre><p>Renders:</p><pre class="literallayout">Consul *necessitatibus* per id, -consetetur, eu pro everti postulant -homero verear ea mea, qui.</pre><p>If the <span class="emphasis"><em>listing</em></span> style is applied to a LiteralBlock it will be -rendered as a ListingBlock (this is handy if you have a listing -containing a ListingBlock).</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_sidebar_blocks"></a>16.4. Sidebar Blocks</h2></div></div></div><p>A sidebar 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.</p><p>The sidebar body is treated like a normal section body.</p><p>Here’s an example:</p><pre class="screen">.An Example Sidebar -************************************************ -Any AsciiDoc SectionBody element (apart from -SidebarBlocks) can be placed inside a sidebar. -************************************************</pre><p>Which will be rendered like:</p><div class="sidebar"><div class="titlepage"><div><div><p class="title"><strong>An Example Sidebar</strong></p></div></div></div><p>Any AsciiDoc SectionBody element (apart from -SidebarBlocks) can be placed inside a sidebar.</p></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="X26"></a>16.5. Comment Blocks</h2></div></div></div><p>The contents of <span class="emphasis"><em>CommentBlocks</em></span> are not processed; they are useful for -annotations and for excluding new or outdated content that you don’t -want displayed. CommentBlocks are never written to output files. -Example:</p><pre class="screen">////////////////////////////////////////// -CommentBlock contents are not processed by -asciidoc(1). -//////////////////////////////////////////</pre><p>See also <a class="link" href="ch21.html#X25" title="21.2.3. Comment Lines">Comment Lines</a>.</p><div class="note" style="margin-left: 0; margin-right: 10%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/icons/note.png" /></td><th align="left"></th></tr><tr><td align="left" valign="top"><p>System macros are executed inside comment blocks.</p></td></tr></table></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="X76"></a>16.6. Passthrough Blocks</h2></div></div></div><p>By default the block contents is subject only to <span class="emphasis"><em>attributes</em></span> and -<span class="emphasis"><em>macros</em></span> substitutions (use an explicit <span class="emphasis"><em>subs</em></span> attribute to apply -different substitutions). PassthroughBlock content will often be -backend specific. Here’s an example:</p><pre class="screen">[subs="quotes"] -++++++++++++++++++++++++++++++++++++++ -<table border="1"><tr> - <td>*Cell 1*</td> - <td>*Cell 2*</td> -</tr></table> -++++++++++++++++++++++++++++++++++++++</pre><p>The following styles can be applied to passthrough blocks:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"> -pass -</span></dt><dd> - No substitutions are performed. This is equivalent to <code class="literal">subs="none"</code>. -</dd><dt><span class="term"> -asciimath, latexmath -</span></dt><dd> - By default no substitutions are performed, the contents are rendered - as <a class="link" href="ch25.html" title="Chapter 25. Mathematical Formulas">mathematical formulas</a>. -</dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_quote_blocks"></a>16.7. Quote Blocks</h2></div></div></div><p><span class="emphasis"><em>QuoteBlocks</em></span> are used for quoted passages of text. There are two -styles: <span class="emphasis"><em>quote</em></span> and <span class="emphasis"><em>verse</em></span>. The style behavior is identical to -<a class="link" href="ch15.html#X94" title="15.3. quote and verse paragraph styles">quote and verse paragraphs</a> except that blocks can contain -multiple paragraphs and, in the case of the <span class="emphasis"><em>quote</em></span> style, other -section elements. The first positional attribute sets the style, if -no attributes are specified the <span class="emphasis"><em>quote</em></span> style is used. The optional -<span class="emphasis"><em>attribution</em></span> and <span class="emphasis"><em>citetitle</em></span> attributes (positional attributes 2 and -3) specify the quote’s author and source. For example:</p><pre class="screen">[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." -____________________________________________________________________</pre><p>Which is rendered as:</p><div class="blockquote"><table border="0" class="blockquote" style="width: 100%; cellspacing: 0; cellpadding: 0;" summary="Block quote"><tr><td width="10%" valign="top"> </td><td width="80%" valign="top"><p>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.</p><p>"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."</p></td><td width="10%" valign="top"> </td></tr><tr><td width="10%" valign="top"> </td><td colspan="2" align="right" valign="top">--<span class="attribution"> -Sir Arthur Conan Doyle -<em class="citetitle">The Adventures of Sherlock Holmes</em> -</span></td></tr></table></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="X48"></a>16.8. Example Blocks</h2></div></div></div><p><span class="emphasis"><em>ExampleBlocks</em></span> encapsulate the DocBook Example element and are used -for, well, examples. Example blocks can be titled by preceding them -with a <span class="emphasis"><em>BlockTitle</em></span>. DocBook toolchains will normally automatically -number examples and generate a <span class="emphasis"><em>List of Examples</em></span> backmatter section.</p><p>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:</p><pre class="screen">.An example -===================================================================== -Qui in magna commodo, est labitur dolorum an. Est ne magna primis -adolescens. -=====================================================================</pre><p>Renders:</p><div class="example"><a id="idm1570"></a><p class="title"><strong>Example 16.1. An example</strong></p><div class="example-contents"><p>Qui in magna commodo, est labitur dolorum an. Est ne magna primis -adolescens.</p></div></div><br class="example-break" /><p>A title prefix that can be inserted with the <code class="literal">caption</code> attribute -(HTML backends). For example:</p><pre class="screen">[caption="Example 1: "] -.An example with a custom caption -===================================================================== -Qui in magna commodo, est labitur dolorum an. Est ne magna primis -adolescens. -=====================================================================</pre></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="X22"></a>16.9. Admonition Blocks</h2></div></div></div><p>The <span class="emphasis"><em>ExampleBlock</em></span> definition includes a set of admonition -<a class="link" href="ch32.html#X23" title="32.1. Styles">styles</a> (<span class="emphasis"><em>NOTE</em></span>, <span class="emphasis"><em>TIP</em></span>, <span class="emphasis"><em>IMPORTANT</em></span>, <span class="emphasis"><em>WARNING</em></span>, <span class="emphasis"><em>CAUTION</em></span>) for -generating admonition blocks (admonitions containing more than a -<a class="link" href="ch15.html#X28" title="15.4. Admonition Paragraphs">single paragraph</a>). Just precede the <span class="emphasis"><em>ExampleBlock</em></span> with an -attribute list specifying the admonition style name. For example:</p><pre class="screen">[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. -=====================================================================</pre><p>Renders:</p><div class="note" style="margin-left: 0; margin-right: 10%;"><table border="0" summary="Note: A NOTE admonition block"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/icons/note.png" /></td><th align="left">A NOTE admonition block</th></tr><tr><td align="left" valign="top"><p>Qui in magna commodo, est labitur dolorum an. Est ne magna primis -adolescens.</p><div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -Fusce euismod commodo velit. -</li><li class="listitem"><p class="simpara"> -Vivamus fringilla mi eu lacus. -</p><div class="orderedlist"><ol class="orderedlist" type="a"><li class="listitem"> -Fusce euismod commodo velit. -</li><li class="listitem"> -Vivamus fringilla mi eu lacus. -</li></ol></div></li><li class="listitem"> -Donec eget arcu bibendum - nunc consequat lobortis. -</li></ol></div></td></tr></table></div><p>See also <a class="link" href="ch15.html#X47" title="15.4.1. Admonition Icons and Captions">Admonition Icons and Captions</a>.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="X29"></a>16.10. Open Blocks</h2></div></div></div><p>Open blocks are special:</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -The open block delimiter is line containing two hyphen characters - (instead of four or more repeated characters). -</li><li class="listitem"> -They can be used to group block elements for <a class="link" href="ch17.html#X15" title="17.7. List Item Continuation">List item continuation</a>. -</li><li class="listitem"><p class="simpara"> -Open blocks can be styled to behave like any other type of delimited - block. The following built-in styles can be applied to open - blocks: <span class="emphasis"><em>literal</em></span>, <span class="emphasis"><em>verse</em></span>, <span class="emphasis"><em>quote</em></span>, <span class="emphasis"><em>listing</em></span>, <span class="emphasis"><em>TIP</em></span>, <span class="emphasis"><em>NOTE</em></span>, - <span class="emphasis"><em>IMPORTANT</em></span>, <span class="emphasis"><em>WARNING</em></span>, <span class="emphasis"><em>CAUTION</em></span>, <span class="emphasis"><em>abstract</em></span>, <span class="emphasis"><em>partintro</em></span>, - <span class="emphasis"><em>comment</em></span>, <span class="emphasis"><em>example</em></span>, <span class="emphasis"><em>sidebar</em></span>, <span class="emphasis"><em>source</em></span>, <span class="emphasis"><em>music</em></span>, <span class="emphasis"><em>latex</em></span>, - <span class="emphasis"><em>graphviz</em></span>. For example, the following open block and listing block - are functionally identical: -</p><pre class="literallayout">[listing] --- -Lorum ipsum ... ---</pre><pre class="literallayout">--------------- -Lorum ipsum ... ----------------</pre></li><li class="listitem"> -An unstyled open block groups section elements but otherwise does - nothing. -</li></ul></div><p>Open blocks are used to generate document abstracts and book part -introductions:</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p class="simpara"> -Apply the <span class="emphasis"><em>abstract</em></span> style to generate an abstract, for example: -</p><pre class="literallayout">[abstract] --- -In this paper we will ... ---</pre><div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><p class="simpara"> -Apply the <span class="emphasis"><em>partintro</em></span> style to generate a book part introduction for - a multi-part book, for example: -</p><pre class="literallayout">[partintro] -.Optional part introduction title --- -Optional part introduction goes here. ---</pre></li></ol></div></li></ul></div></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch15.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch17.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/icons/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
\ No newline at end of file diff --git a/chunked/ch17.html b/chunked/ch17.html deleted file mode 100644 index effaf34..0000000 --- a/chunked/ch17.html +++ /dev/null @@ -1,325 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Chapter 17. Lists</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="AsciiDoc User Guide" /><link rel="up" href="index.html" title="AsciiDoc User Guide" /><link rel="prev" href="ch16.html" title="Chapter 16. Delimited Blocks" /><link rel="next" href="ch18.html" title="Chapter 18. Footnotes" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="ch16.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch18.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a id="X64"></a>Chapter 17. Lists</h1></div></div></div><div class="itemizedlist"><p class="title"><strong>List types</strong></p><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -Bulleted lists. Also known as itemized or unordered lists. -</li><li class="listitem"> -Numbered lists. Also called ordered lists. -</li><li class="listitem"> -Labeled lists. Sometimes called variable or definition lists. -</li><li class="listitem"> -Callout lists (a list of callout annotations). -</li></ul></div><div class="itemizedlist"><p class="title"><strong>List behavior</strong></p><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -List item indentation is optional and does not determine nesting, - indentation does however make the source more readable. -</li><li class="listitem"> -Another list or a literal paragraph immediately following a list - item will be implicitly included in the list item; use <a class="link" href="ch17.html#X15" title="17.7. List Item Continuation">list item continuation</a> to explicitly append other block elements to a - list item. -</li><li class="listitem"> -A comment block or a comment line block macro element will terminate - a list — use inline comment lines to put comments inside lists. -</li><li class="listitem"> -The <code class="literal">listindex</code> <a class="link" href="ch31.html" title="Chapter 31. Intrinsic Attributes">intrinsic attribute</a> 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. -</li></ul></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_bulleted_lists"></a>17.1. Bulleted Lists</h2></div></div></div><p>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:</p><pre class="literallayout">- List item. -* List item. -** List item. -*** List item. -**** List item. -***** List item.</pre></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_numbered_lists"></a>17.2. Numbered Lists</h2></div></div></div><p>List item numbers are explicit or implicit.</p><p><strong>Explicit numbering. </strong>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 a period, roman numbers are terminated with a closing -parenthesis. The different terminators are necessary to ensure <span class="emphasis"><em>i</em></span>, -<span class="emphasis"><em>v</em></span> and <span class="emphasis"><em>x</em></span> roman numbers are are distinguishable from <span class="emphasis"><em>x</em></span>, <span class="emphasis"><em>v</em></span> and -<span class="emphasis"><em>x</em></span> alpha numbers. Examples:</p><pre class="literallayout">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.</pre><p><strong>Implicit numbering. </strong>List items begin one to five period characters, followed by some white -space then the item text. Examples:</p><pre class="literallayout">. 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.</pre><p>You can use the <span class="emphasis"><em>style</em></span> attribute (also the first positional -attribute) to specify an alternative numbering style. The numbered -list style can be one of the following values: <span class="emphasis"><em>arabic</em></span>, <span class="emphasis"><em>loweralpha</em></span>, -<span class="emphasis"><em>upperalpha</em></span>, <span class="emphasis"><em>lowerroman</em></span>, <span class="emphasis"><em>upperroman</em></span>.</p><p>Here are some examples of bulleted and numbered lists:</p><pre class="screen">- 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. - . 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.</pre><p>Which render as:</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p class="simpara"> -Praesent eget purus quis magna eleifend eleifend. -</p><div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><p class="simpara"> -Fusce euismod commodo velit. -</p><div class="orderedlist"><ol class="orderedlist" type="a"><li class="listitem"> -Fusce euismod commodo velit. -</li><li class="listitem"> -Vivamus fringilla mi eu lacus. -</li><li class="listitem"> -Donec eget arcu bibendum nunc consequat lobortis. -</li></ol></div></li><li class="listitem"><p class="simpara"> -Vivamus fringilla mi eu lacus. -</p><div class="orderedlist"><ol class="orderedlist" type="i"><li class="listitem"> -Fusce euismod commodo velit. -</li><li class="listitem"> -Vivamus fringilla mi eu lacus. -</li></ol></div></li><li class="listitem"> -Donec eget arcu bibendum nunc consequat lobortis. -</li><li class="listitem"> -Nam fermentum mattis ante. -</li></ol></div></li><li class="listitem"><p class="simpara"> -Lorem ipsum dolor sit amet, consectetuer adipiscing elit. -</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; "><li class="listitem"><p class="simpara"> -Fusce euismod commodo velit. -</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: square; "><li class="listitem"> -Qui in magna commodo, est labitur dolorum an. Est ne magna primis - adolescens. Sit munere ponderum dignissim et. Minim luptatum et - vel. -</li><li class="listitem"> -Vivamus fringilla mi eu lacus. -</li></ul></div></li><li class="listitem"> -Donec eget arcu bibendum nunc consequat lobortis. -</li></ul></div></li><li class="listitem"><p class="simpara"> -Nulla porttitor vulputate libero. -</p><div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -Fusce euismod commodo velit. -</li><li class="listitem"><p class="simpara"> -Vivamus fringilla mi eu lacus. -</p><div class="orderedlist"><ol class="orderedlist" type="I"><li class="listitem"> -Fusce euismod commodo velit. -</li><li class="listitem"> -Vivamus fringilla mi eu lacus. -</li></ol></div></li><li class="listitem"> -Donec eget arcu bibendum nunc consequat lobortis. -</li></ol></div></li></ul></div><p>A predefined <span class="emphasis"><em>compact</em></span> option is available to bulleted and numbered -lists — this translates to the DocBook <span class="emphasis"><em>spacing="compact"</em></span> lists -attribute which may or may not be processed by the DocBook toolchain. -Example:</p><pre class="literallayout">[options="compact"] -- Compact list item. -- Another compact list item.</pre><div class="tip" style="margin-left: 0; margin-right: 10%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="images/icons/tip.png" /></td><th align="left"></th></tr><tr><td align="left" valign="top"><p>To apply the <span class="emphasis"><em>compact</em></span> option globally define a document-wide -<span class="emphasis"><em>compact-option</em></span> attribute, e.g. using the <code class="literal">-a compact-option</code> -command-line option.</p></td></tr></table></div><p>You can set the list start number using the <span class="emphasis"><em>start</em></span> attribute (works -for HTML outputs and DocBook outputs processed by DocBook XSL -Stylesheets). Example:</p><pre class="literallayout">[start=7] -. List item 7. -. List item 8.</pre></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_labeled_lists"></a>17.3. Labeled Lists</h2></div></div></div><p>Labeled list items consist of one or more text labels followed by the -text of the list item.</p><p>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.</p><p>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.</p><p>Here are some examples:</p><pre class="screen">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.</pre><p>Which render as:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"> -In -, </span><span class="term"> -Lorem -</span></dt><dd><p class="simpara"> - Fusce euismod commodo velit. -</p><pre class="literallayout">Fusce euismod commodo velit.</pre></dd><dt><span class="term"> -Ipsum -</span></dt><dd><p class="simpara"> -Vivamus fringilla mi eu lacus. -</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -Vivamus fringilla mi eu lacus. -</li><li class="listitem"> -Donec eget arcu bibendum nunc consequat lobortis. -</li></ul></div></dd><dt><span class="term"> -Dolor -</span></dt><dd><p class="simpara"> - Donec eget arcu bibendum nunc consequat lobortis. -</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"> -Suspendisse -</span></dt><dd> - A massa id sem aliquam auctor. -</dd><dt><span class="term"> -Morbi -</span></dt><dd> - Pretium nulla vel lorem. -</dd><dt><span class="term"> -In -</span></dt><dd><p class="simpara"> - Dictum mauris in urna. -</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"> -Vivamus -</span></dt><dd> -Fringilla mi eu lacus. -</dd><dt><span class="term"> -Donec -</span></dt><dd> -Eget arcu bibendum nunc consequat lobortis. -</dd></dl></div></dd></dl></div></dd></dl></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_horizontal_labeled_list_style"></a>17.3.1. Horizontal labeled list style</h3></div></div></div><p>The <span class="emphasis"><em>horizontal</em></span> 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:</p><pre class="screen">[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.</pre><p>Which render as:</p><div class="horizontal"><table class="horizontal" cellpadding="4px" style="border: none;"><colgroup><col /><col /></colgroup><tbody valign="top"><tr><td style="" valign="top"> -<p> -<span class="strong"><strong>Lorem</strong></span> -</p> -</td><td style="" valign="top"> -<p> -Fusce euismod commodo velit. Qui in magna commodo, est -labitur dolorum an. Est ne magna primis adolescens. -</p> -<pre class="literallayout">Fusce euismod commodo velit.</pre> -</td></tr><tr><td style="" valign="top"> -<p> -<span class="strong"><strong>Ipsum</strong></span> -</p> -</td><td style="" valign="top"> -<p> -Vivamus fringilla mi eu lacus. -</p> -<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -Vivamus fringilla mi eu lacus. -</li><li class="listitem"> -Donec eget arcu bibendum nunc consequat lobortis. -</li></ul></div> -</td></tr><tr><td style="" valign="top"> -<p> -<span class="strong"><strong>Dolor</strong></span> -</p> -</td><td style="" valign="top"> -<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -Vivamus fringilla mi eu lacus. -</li><li class="listitem"> -Donec eget arcu bibendum nunc consequat lobortis. -</li></ul></div> -</td></tr></tbody></table></div><div class="note" style="margin-left: 0; margin-right: 10%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/icons/note.png" /></td><th align="left"></th></tr><tr><td align="left" valign="top"><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -Current PDF toolchains do not make a good job of determining - the relative column widths for horizontal labeled lists. -</li><li class="listitem"> -Nested horizontal labeled lists will generate DocBook validation - errors because the <span class="emphasis"><em>DocBook XML V4.2</em></span> DTD does not permit nested - informal tables (although <a class="link" href="ch05.html#X13">DocBook XSL Stylesheets</a> and - <a class="link" href="ch05.html#X31">dblatex</a> process them correctly). -</li><li class="listitem"> -The label width can be set as a percentage of the total width by - setting the <span class="emphasis"><em>width</em></span> attribute e.g. <code class="literal">width="10%"</code> -</li></ul></div></td></tr></table></div></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_question_and_answer_lists"></a>17.4. Question and Answer Lists</h2></div></div></div><p>AsciiDoc comes pre-configured with a <span class="emphasis"><em>qanda</em></span> style labeled list for generating -DocBook question and answer (Q&A) lists. Example:</p><pre class="screen">[qanda] -Question one:: - Answer one. -Question two:: - Answer two.</pre><p>Renders:</p><div class="qandaset"><a id="idm1877"></a><table border="0" style="width: 100%;"><colgroup><col align="left" width="1%" /><col /></colgroup><tbody><tr class="question"><td align="left" valign="top"><a id="idm1878"></a><a id="idm1879"></a><p><strong>17.4.1.</strong></p></td><td align="left" valign="top"><p> -Question one -</p></td></tr><tr class="answer"><td align="left" valign="top"></td><td align="left" valign="top"><p> - Answer one. -</p></td></tr><tr class="question"><td align="left" valign="top"><a id="idm1883"></a><a id="idm1884"></a><p><strong>17.4.2.</strong></p></td><td align="left" valign="top"><p> -Question two -</p></td></tr><tr class="answer"><td align="left" valign="top"></td><td align="left" valign="top"><p> - Answer two. -</p></td></tr></tbody></table></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_glossary_lists"></a>17.5. Glossary Lists</h2></div></div></div><p>AsciiDoc comes pre-configured with a <span class="emphasis"><em>glossary</em></span> style labeled list for -generating DocBook glossary lists. Example:</p><pre class="screen">[glossary] -A glossary term:: - The corresponding definition. -A second glossary term:: - The corresponding definition.</pre><p>For working examples see the <code class="literal">article.txt</code> and <code class="literal">book.txt</code> documents in -the AsciiDoc <code class="literal">./doc</code> distribution directory.</p><div class="note" style="margin-left: 0; margin-right: 10%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/icons/note.png" /></td><th align="left"></th></tr><tr><td align="left" valign="top"><p>To generate valid DocBook output glossary lists must be located -in a section that uses the <span class="emphasis"><em>glossary</em></span> <a class="link" href="ch08.html#X93" title="8.4.1. Section markup templates">section markup template</a>.</p></td></tr></table></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_bibliography_lists"></a>17.6. Bibliography Lists</h2></div></div></div><p>AsciiDoc comes with a predefined <span class="emphasis"><em>bibliography</em></span> bulleted list style -generating DocBook bibliography entries. Example:</p><pre class="screen">[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.</pre><p>The <code class="literal">[[[<reference>]]]</code> syntax is a bibliography entry anchor, it -generates an anchor named <code class="literal"><reference></code> and additionally displays -<code class="literal">[<reference>]</code> at the anchor position. For example <code class="literal">[[[taoup]]]</code> -generates an anchor named <code class="literal">taoup</code> that displays <code class="literal">[taoup]</code> at the -anchor position. Cite the reference from elsewhere your document using -<code class="literal"><<taoup>></code>, this displays a hyperlink (<code class="literal">[taoup]</code>) to the -corresponding bibliography entry anchor.</p><p>For working examples see the <code class="literal">article.txt</code> and <code class="literal">book.txt</code> documents in -the AsciiDoc <code class="literal">./doc</code> distribution directory.</p><div class="note" style="margin-left: 0; margin-right: 10%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/icons/note.png" /></td><th align="left"></th></tr><tr><td align="left" valign="top"><p>To generate valid DocBook output bibliography lists must be -located in a <a class="link" href="ch08.html#X93" title="8.4.1. Section markup templates">bibliography section</a>.</p></td></tr></table></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="X15"></a>17.7. List Item Continuation</h2></div></div></div><p>Another list or a literal paragraph immediately following a list item -is implicitly appended to the list item; to append other block -elements to a list item you need to explicitly join them to the list -item with a <span class="emphasis"><em>list continuation</em></span> (a separator line containing a 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).</p><p>Here are some examples of list item continuations: list item one -contains multiple continuations; list item two is continued with an -<a class="link" href="ch16.html#X29" title="16.10. Open Blocks">OpenBlock</a> containing multiple elements:</p><pre class="screen">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. ---</pre><p>Renders:</p><div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><p class="simpara"> -List item one. -</p><p class="simpara">List item one continued with a second paragraph followed by an -Indented block.</p><pre class="literallayout">$ ls *.sh -$ mv *.sh ~/tmp</pre><p class="simpara">List item continued with a third paragraph.</p></li><li class="listitem"><p class="simpara"> -List item two continued with an open block. -</p><p class="simpara">This paragraph is part of the preceding list item.</p><div class="orderedlist"><ol class="orderedlist" type="a"><li class="listitem"><p class="simpara"> -This list is nested and does not require explicit item continuation. -</p><p class="simpara">This paragraph is part of the preceding list item.</p></li><li class="listitem"> -List item b. -</li></ol></div><p class="simpara">This paragraph belongs to item two of the outer list.</p></li></ol></div></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch16.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch18.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/icons/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
\ No newline at end of file diff --git a/chunked/ch18.html b/chunked/ch18.html deleted file mode 100644 index cdab8c4..0000000 --- a/chunked/ch18.html +++ /dev/null @@ -1,22 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Chapter 18. Footnotes</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="AsciiDoc User Guide" /><link rel="up" href="index.html" title="AsciiDoc User Guide" /><link rel="prev" href="ch17.html" title="Chapter 17. Lists" /><link rel="next" href="ch19.html" title="Chapter 19. Indexes" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="ch17.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch19.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a id="X92"></a>Chapter 18. Footnotes</h1></div></div></div><p>The shipped AsciiDoc configuration includes three footnote inline -macros:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"> -<code class="literal">footnote:[<text>]</code> -</span></dt><dd> - Generates a footnote with text <code class="literal"><text></code>. -</dd><dt><span class="term"> -<code class="literal">footnoteref:[<id>,<text>]</code> -</span></dt><dd> - Generates a footnote with a reference ID <code class="literal"><id></code> and text <code class="literal"><text></code>. -</dd><dt><span class="term"> -<code class="literal">footnoteref:[<id>]</code> -</span></dt><dd> - Generates a reference to the footnote with ID <code class="literal"><id></code>. -</dd></dl></div><p>The footnote text can span multiple lines.</p><p>The <span class="emphasis"><em>xhtml11</em></span> and <span class="emphasis"><em>html5</em></span> backends render footnotes dynamically using -JavaScript; <span class="emphasis"><em>html4</em></span> outputs do not use JavaScript and leave the -footnotes inline; <span class="emphasis"><em>docbook</em></span> footnotes are processed by the downstream -DocBook toolchain.</p><p>Example footnotes:</p><pre class="literallayout">A footnote footnote:[An example footnote.]; -a second footnote with a reference ID footnoteref:[note2,Second footnote.]; -finally a reference to the second footnote footnoteref:[note2].</pre><p>Renders:</p><p>A footnote <a href="#ftn.idm1979" class="footnote" id="idm1979"><sup class="footnote">[2]</sup></a>; -a second footnote with a reference ID <a href="#ftn.note2" class="footnote" id="note2"><sup class="footnote">[3]</sup></a>; -finally a reference to the second footnote <a href="ch18.html#ftn.note2" class="footnoteref"><sup class="footnoteref">[3]</sup></a>.</p><div class="footnotes"><br /><hr style="width:100; text-align:left;margin-left: 0" /><div id="ftn.idm1979" class="footnote"><p><a href="#idm1979" class="simpara"><sup class="simpara">[2] </sup></a>An example footnote.</p></div><div id="ftn.note2" class="footnote"><p><a href="#note2" class="simpara"><sup class="simpara">[3] </sup></a>Second footnote.</p></div></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch17.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch19.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/icons/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
\ No newline at end of file diff --git a/chunked/ch19.html b/chunked/ch19.html deleted file mode 100644 index 31759da..0000000 --- a/chunked/ch19.html +++ /dev/null @@ -1,26 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Chapter 19. Indexes</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="AsciiDoc User Guide" /><link rel="up" href="index.html" title="AsciiDoc User Guide" /><link rel="prev" href="ch18.html" title="Chapter 18. Footnotes" /><link rel="next" href="ch20.html" title="Chapter 20. Callouts" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="ch18.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch20.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a id="_indexes"></a>Chapter 19. Indexes</h1></div></div></div><p>The shipped AsciiDoc configuration includes the inline macros for -generating DocBook index entries.</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"> -<code class="literal">indexterm:[<primary>,<secondary>,<tertiary>]</code> -, </span><span class="term"> -<code class="literal">(((<primary>,<secondary>,<tertiary>)))</code> -</span></dt><dd> - This inline macro generates an index term (the <code class="literal"><secondary></code> and - <code class="literal"><tertiary></code> positional attributes are optional). Example: - <code class="literal">indexterm:[Tigers,Big cats]</code> (or, using the alternative syntax - <code class="literal">(((Tigers,Big cats)))</code>. Index terms that have secondary and - tertiary entries also generate separate index terms for the - secondary and tertiary entries. The index terms appear in the - index, not the primary text flow. -</dd><dt><span class="term"> -<code class="literal">indexterm2:[<primary>]</code> -, </span><span class="term"> -<code class="literal">((<primary>))</code> -</span></dt><dd> - This inline macro generates an index term that appears in both the - index and the primary text flow. The <code class="literal"><primary></code> should not be - padded to the left or right with white space characters. -</dd></dl></div><p>For working examples see the <code class="literal">article.txt</code> and <code class="literal">book.txt</code> documents in -the AsciiDoc <code class="literal">./doc</code> distribution directory.</p><div class="note" style="margin-left: 0; margin-right: 10%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/icons/note.png" /></td><th align="left"></th></tr><tr><td align="left" valign="top"><p>Index entries only really make sense if you are generating -DocBook markup — DocBook conversion programs automatically generate -an index at the point an <span class="emphasis"><em>Index</em></span> section appears in source document.</p></td></tr></table></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch18.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch20.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/icons/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
\ No newline at end of file diff --git a/chunked/ch20.html b/chunked/ch20.html deleted file mode 100644 index ed5a4f3..0000000 --- a/chunked/ch20.html +++ /dev/null @@ -1,95 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Chapter 20. Callouts</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="AsciiDoc User Guide" /><link rel="up" href="index.html" title="AsciiDoc User Guide" /><link rel="prev" href="ch19.html" title="Chapter 19. Indexes" /><link rel="next" href="ch21.html" title="Chapter 21. Macros" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="ch19.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch21.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a id="X105"></a>Chapter 20. Callouts</h1></div></div></div><p>Callouts are a mechanism for annotating verbatim text (for example: -source code, computer output and user input). Callout markers are -placed inside the annotated text while the actual annotations are -presented in a callout list after the annotated text. Here’s an -example:</p><pre class="screen"> .MS-DOS directory listing - ----------------------------------------------------- - 10/17/97 9:04 <DIR> bin - 10/16/97 14:11 <DIR> DOS <1> - 10/16/97 14:40 <DIR> Program Files - 10/16/97 14:46 <DIR> TEMP - 10/17/97 9:04 <DIR> tmp - 10/16/97 14:37 <DIR> WINNT - 10/16/97 14:25 119 AUTOEXEC.BAT <2> - 2/13/94 6:21 54,619 COMMAND.COM <2> - 10/16/97 14:25 115 CONFIG.SYS <2> - 11/16/97 17:17 61,865,984 pagefile.sys - 2/13/94 6:21 9,349 WINA20.386 <3> - ----------------------------------------------------- - - <1> This directory holds MS-DOS. - <2> System startup code for DOS. - <3> Some sort of Windows 3.1 hack.</pre><p>Which renders:</p><p><strong>MS-DOS directory listing. </strong> -</p><pre class="screen">10/17/97 9:04 <DIR> bin -10/16/97 14:11 <DIR> DOS <a id="CO1-1"></a><span><img src="images/icons/callouts/1.png" alt="1" border="0" /></span> -10/16/97 14:40 <DIR> Program Files -10/16/97 14:46 <DIR> TEMP -10/17/97 9:04 <DIR> tmp -10/16/97 14:37 <DIR> WINNT -10/16/97 14:25 119 AUTOEXEC.BAT <a id="CO1-2"></a><span><img src="images/icons/callouts/2.png" alt="2" border="0" /></span> - 2/13/94 6:21 54,619 COMMAND.COM <a id="CO1-3"></a><span><img src="images/icons/callouts/3.png" alt="3" border="0" /></span> -10/16/97 14:25 115 CONFIG.SYS <a id="CO1-4"></a><span><img src="images/icons/callouts/4.png" alt="4" border="0" /></span> -11/16/97 17:17 61,865,984 pagefile.sys - 2/13/94 6:21 9,349 WINA20.386 <a id="CO1-5"></a><span><img src="images/icons/callouts/5.png" alt="5" border="0" /></span></pre><p> -</p><div class="calloutlist"><table border="0" summary="Callout list"><tr><td width="5%" valign="top" align="left"><p><a href="#CO1-1"><span><img src="images/icons/callouts/1.png" alt="1" border="0" /></span></a> </p></td><td valign="top" align="left"><p> -This directory holds MS-DOS. -</p></td></tr><tr><td width="5%" valign="top" align="left"><p><a href="#CO1-2"><span><img src="images/icons/callouts/2.png" alt="2" border="0" /></span></a> <a href="#CO1-3"><span><img src="images/icons/callouts/3.png" alt="3" border="0" /></span></a> <a href="#CO1-4"><span><img src="images/icons/callouts/4.png" alt="4" border="0" /></span></a> </p></td><td valign="top" align="left"><p> -System startup code for DOS. -</p></td></tr><tr><td width="5%" valign="top" align="left"><p><a href="#CO1-5"><span><img src="images/icons/callouts/5.png" alt="5" border="0" /></span></a> </p></td><td valign="top" align="left"><p> -Some sort of Windows 3.1 hack. -</p></td></tr></table></div><div class="itemizedlist"><p class="title"><strong>Explanation</strong></p><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -The callout marks are whole numbers enclosed in angle brackets — they refer to the correspondingly numbered item in the following - callout list. -</li><li class="listitem"> -By default callout marks are confined to <span class="emphasis"><em>LiteralParagraphs</em></span>, - <span class="emphasis"><em>LiteralBlocks</em></span> and <span class="emphasis"><em>ListingBlocks</em></span> (although this is a - configuration file option and can be changed). -</li><li class="listitem"> -Callout list item numbering is fairly relaxed — list items can - start with <code class="literal"><n></code>, <code class="literal">n></code> or <code class="literal">></code> where <code class="literal">n</code> is the optional list item - number (in the latter case list items starting with a single <code class="literal">></code> - character are implicitly numbered starting at one). -</li><li class="listitem"> -Callout lists should not be nested. -</li><li class="listitem"> -Callout lists cannot be used within tables. -</li><li class="listitem"> -Callout lists start list items hard against the left margin. -</li><li class="listitem"> -If you want to present a number inside angle brackets you’ll need to - escape it with a backslash to prevent it being interpreted as a - callout mark. -</li></ul></div><div class="note" style="margin-left: 0; margin-right: 10%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/icons/note.png" /></td><th align="left"></th></tr><tr><td align="left" valign="top"><p>Define the AsciiDoc <span class="emphasis"><em>icons</em></span> attribute (for example using the <code class="literal">-a -icons</code> command-line option) to display callout icons.</p></td></tr></table></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_implementation_notes"></a>20.1. Implementation Notes</h2></div></div></div><p>Callout marks are generated by the <span class="emphasis"><em>callout</em></span> inline macro while -callout lists are generated using the <span class="emphasis"><em>callout</em></span> list definition. The -<span class="emphasis"><em>callout</em></span> macro and <span class="emphasis"><em>callout</em></span> list are special in that they work -together. The <span class="emphasis"><em>callout</em></span> inline macro is not enabled by the normal -<span class="emphasis"><em>macros</em></span> substitutions option, instead it has its own <span class="emphasis"><em>callouts</em></span> -substitution option.</p><p>The following attributes are available during inline callout macro -substitution:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"> -<code class="literal">{index}</code> -</span></dt><dd> - The callout list item index inside the angle brackets. -</dd><dt><span class="term"> -<code class="literal">{coid}</code> -</span></dt><dd> - An identifier formatted like <code class="literal">CO<listnumber>-<index></code> that - uniquely identifies the callout mark. For example <code class="literal">CO2-4</code> - identifies the fourth callout mark in the second set of callout - marks. -</dd></dl></div><p>The <code class="literal">{coids}</code> attribute can be used during callout list item -substitution — it is a space delimited list of callout IDs that refer -to the explanatory list item.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_including_callouts_in_included_code"></a>20.2. Including callouts in included code</h2></div></div></div><p>You can annotate working code examples with callouts — just remember -to put the callouts inside source code comments. This example displays -the <code class="literal">test.py</code> source file (containing a single callout) using the -<span class="emphasis"><em>source</em></span> (code highlighter) filter:</p><p><strong>AsciiDoc source. </strong> -</p><pre class="screen"> [source,python] - ------------------------------------------- - \include::test.py[] - ------------------------------------------- - - <1> Print statement.</pre><p> -</p><p><strong>Included <code class="literal">test.py</code> source. </strong> -</p><pre class="screen">print 'Hello World!' # <1></pre><p> -</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch19.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch21.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/icons/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
\ No newline at end of file diff --git a/chunked/ch21.html b/chunked/ch21.html deleted file mode 100644 index b1900af..0000000 --- a/chunked/ch21.html +++ /dev/null @@ -1,365 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Chapter 21. Macros</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="AsciiDoc User Guide" /><link rel="up" href="index.html" title="AsciiDoc User Guide" /><link rel="prev" href="ch20.html" title="Chapter 20. Callouts" /><link rel="next" href="ch22.html" title="Chapter 22. HTML 5 audio and video block macros" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="ch20.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch22.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a id="_macros"></a>Chapter 21. Macros</h1></div></div></div><p>Macros are a mechanism for substituting parametrized text into output -documents.</p><p>Macros have a <span class="emphasis"><em>name</em></span>, a single <span class="emphasis"><em>target</em></span> argument and an <span class="emphasis"><em>attribute -list</em></span>. The usual syntax is <code class="literal"><name>:<target>[<attrlist>]</code> (for -inline macros) and <code class="literal"><name>::<target>[<attrlist>]</code> (for block -macros). Here are some examples:</p><pre class="literallayout">http://www.docbook.org/[DocBook.org] -include::chapt1.txt[tabsize=2] -mailto:srackham@gmail.com[]</pre><div class="itemizedlist"><p class="title"><strong>Macro behavior</strong></p><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -<code class="literal"><name></code> is the macro name. It can only contain letters, digits or - dash characters and cannot start with a dash. -</li><li class="listitem"> -The optional <code class="literal"><target></code> cannot contain white space characters. -</li><li class="listitem"> -<code class="literal"><attrlist></code> is a <a class="link" href="ch29.html" title="Chapter 29. Attribute Lists">list of attributes</a> enclosed in square - brackets. -</li><li class="listitem"> -<code class="literal">]</code> characters inside attribute lists must be escaped with a - backslash. -</li><li class="listitem"> -Expansion of macro references can normally be escaped by prefixing a - backslash character (see the AsciiDoc <span class="emphasis"><em>FAQ</em></span> for examples of - exceptions to this rule). -</li><li class="listitem"> -Attribute references in block macros are expanded. -</li><li class="listitem"> -The substitutions performed prior to Inline macro macro expansion - are determined by the inline context. -</li><li class="listitem"> -Macros are processed in the order they appear in the configuration - file(s). -</li><li class="listitem"> -Calls to inline macros can be nested inside different inline macros - (an inline macro call cannot contain a nested call to itself). -</li><li class="listitem"> -In addition to <code class="literal"><name></code>, <code class="literal"><target></code> and <code class="literal"><attrlist></code> the - <code class="literal"><passtext></code> and <code class="literal"><subslist></code> named groups are available to - <a class="link" href="ch21.html#X77" title="21.4. Passthrough macros">passthrough macros</a>. A macro is a passthrough macro if the - definition includes a <code class="literal"><passtext></code> named group. -</li></ul></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_inline_macros"></a>21.1. Inline Macros</h2></div></div></div><p>Inline Macros occur in an inline element context. Predefined Inline -macros include <span class="emphasis"><em>URLs</em></span>, <span class="emphasis"><em>image</em></span> and <span class="emphasis"><em>link</em></span> macros.</p><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_urls"></a>21.1.1. URLs</h3></div></div></div><p><span class="emphasis"><em>http</em></span>, <span class="emphasis"><em>https</em></span>, <span class="emphasis"><em>ftp</em></span>, <span class="emphasis"><em>file</em></span>, <span class="emphasis"><em>mailto</em></span> and <span class="emphasis"><em>callto</em></span> URLs are -rendered using predefined inline macros.</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -If you don’t need a custom link caption you can enter the <span class="emphasis"><em>http</em></span>, - <span class="emphasis"><em>https</em></span>, <span class="emphasis"><em>ftp</em></span>, <span class="emphasis"><em>file</em></span> URLs and email addresses without any special - macro syntax. -</li><li class="listitem"> -If the <code class="literal"><attrlist></code> is empty the URL is displayed. -</li></ul></div><p>Here are some examples:</p><pre class="literallayout">http://www.docbook.org/[DocBook.org] -http://www.docbook.org/ -mailto:joe.bloggs@foobar.com[email Joe Bloggs] -joe.bloggs@foobar.com</pre><p>Which are rendered:</p><p><a class="ulink" href="http://www.docbook.org/" target="_top">DocBook.org</a></p><p><a class="ulink" href="http://www.docbook.org/" target="_top">http://www.docbook.org/</a></p><p><a class="ulink" href="mailto:joe.bloggs@foobar.com" target="_top">email Joe Bloggs</a></p><p><a class="ulink" href="mailto:joe.bloggs@foobar.com" target="_top">joe.bloggs@foobar.com</a></p><p>If the <code class="literal"><target></code> necessitates space characters use <code class="literal">%20</code>, for example -<code class="literal">large%20image.png</code>.</p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_internal_cross_references"></a>21.1.2. Internal Cross References</h3></div></div></div><p>Two AsciiDoc inline macros are provided for creating hypertext links -within an AsciiDoc document. You can use either the standard macro -syntax or the (preferred) alternative.</p><div class="section"><div class="titlepage"><div><div><h4 class="title"><a id="X30"></a>anchor</h4></div></div></div><p>Used to specify hypertext link targets:</p><pre class="literallayout">[[<id>,<xreflabel>]] -anchor:<id>[<xreflabel>]</pre><p>The <code class="literal"><id></code> is a unique string that conforms to the output markup’s -anchor syntax. The optional <code class="literal"><xreflabel></code> is the text to be displayed -by captionless <span class="emphasis"><em>xref</em></span> macros that refer to this anchor. The optional -<code class="literal"><xreflabel></code> is only really useful when generating DocBook output. -Example anchor:</p><pre class="literallayout">[[X1]]</pre><p>You may have noticed that the syntax of this inline element is the -same as that of the <a class="link" href="ch13.html" title="Chapter 13. BlockId Element">BlockId block element</a>, this is no -coincidence since they are functionally equivalent.</p></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a id="_xref"></a>xref</h4></div></div></div><p>Creates a hypertext link to a document anchor.</p><pre class="literallayout"><<<id>,<caption>>> -xref:<id>[<caption>]</pre><p>The <code class="literal"><id></code> refers to an anchor ID. The optional <code class="literal"><caption></code> is the -link’s displayed text. Example:</p><pre class="literallayout"><<X21,attribute lists>></pre><p>If <code class="literal"><caption></code> is not specified then the displayed text is -auto-generated:</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -The AsciiDoc <span class="emphasis"><em>xhtml11</em></span> and <span class="emphasis"><em>html5</em></span> backends display the <code class="literal"><id></code> - enclosed in square brackets. -</li><li class="listitem"> -If DocBook is produced the DocBook toolchain is responsible for the - displayed text which will normally be the referenced figure, table - or section title number followed by the element’s title text. -</li></ul></div><p>Here is an example:</p><pre class="screen">[[tiger_image]] -.Tyger tyger -image::tiger.png[] - -This can be seen in <<tiger_image>>.</pre></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_linking_to_local_documents"></a>21.1.3. Linking to Local Documents</h3></div></div></div><p>Hypertext links to files on the local file system are specified using -the <span class="emphasis"><em>link</em></span> inline macro.</p><pre class="literallayout">link:<target>[<caption>]</pre><p>The <span class="emphasis"><em>link</em></span> macro generates relative URLs. The link macro <code class="literal"><target></code> is -the target file name (relative to the file system location of the -referring document). The optional <code class="literal"><caption></code> is the link’s displayed -text. If <code class="literal"><caption></code> is not specified then <code class="literal"><target></code> is displayed. -Example:</p><pre class="literallayout">link:downloads/foo.zip[download foo.zip]</pre><p>You can use the <code class="literal"><filename>#<id></code> syntax to refer to an anchor within -a target document but this usually only makes sense when targeting -HTML documents.</p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="X9"></a>21.1.4. Images</h3></div></div></div><p>Inline images are inserted into the output document using the <span class="emphasis"><em>image</em></span> -macro. The inline syntax is:</p><pre class="literallayout">image:<target>[<attributes>]</pre><p>The contents of the image file <code class="literal"><target></code> is displayed. To display the -image its file format must be supported by the target backend -application. HTML and DocBook applications normally support PNG or JPG -files.</p><p><code class="literal"><target></code> file name paths are relative to the location of the -referring document.</p><div class="itemizedlist"><a id="X55"></a><p class="title"><strong>Image macro attributes</strong></p><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p class="simpara"> -The optional <span class="emphasis"><em>alt</em></span> attribute is also the first positional attribute, - it specifies alternative text which is displayed if the output - application is unable to display the image file (see also - <a class="ulink" href="http://htmlhelp.com/feature/art3.htm" target="_top">Use of ALT texts in IMGs</a>). For - example: -</p><pre class="literallayout">image:images/logo.png[Company Logo]</pre></li><li class="listitem"> -The optional <span class="emphasis"><em>title</em></span> attribute provides a title for the image. The - <a class="link" href="ch21.html#X49" title="21.2.2. Images">block image macro</a> renders the title alongside the image. - The inline image macro displays the title as a popup “tooltip” in - visual browsers (AsciiDoc HTML outputs only). -</li><li class="listitem"><p class="simpara"> -The optional <code class="literal">width</code> and <code class="literal">height</code> attributes scale the image size - and can be used in any combination. The units are pixels. The - following example scales the previous example to a height of 32 - pixels: -</p><pre class="literallayout">image:images/logo.png["Company Logo",height=32]</pre></li><li class="listitem"><p class="simpara"> -The optional <code class="literal">link</code> attribute is used to link the image to an - external document. The following example links a screenshot - thumbnail to a full size version: -</p><pre class="literallayout">image:screen-thumbnail.png[height=32,link="screen.png"]</pre></li><li class="listitem"><p class="simpara"> -The optional <code class="literal">scaledwidth</code> attribute is only used in DocBook block - images (specifically for PDF documents). The following example - scales the images to 75% of the available print width: -</p><pre class="literallayout">image::images/logo.png[scaledwidth="75%",alt="Company Logo"]</pre></li><li class="listitem"> -The image <code class="literal">scale</code> attribute sets the DocBook <code class="literal">imagedata</code> element - <code class="literal">scale</code> attribute. -</li><li class="listitem"><p class="simpara"> -The optional <code class="literal">align</code> attribute aligns block macro images - horizontally. Allowed values are <code class="literal">center</code>, <code class="literal">left</code> and <code class="literal">right</code>. For - example: -</p><pre class="literallayout">image::images/tiger.png["Tiger image",align="left"]</pre></li><li class="listitem"> -The optional <code class="literal">float</code> attribute floats the image <code class="literal">left</code> or <code class="literal">right</code> on - the page (works with HTML outputs only, has no effect on DocBook - outputs). <code class="literal">float</code> and <code class="literal">align</code> attributes are mutually exclusive. - Use the <code class="literal">unfloat::[]</code> block macro to stop floating. -</li></ul></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_comment_lines"></a>21.1.5. Comment Lines</h3></div></div></div><p>See <a class="link" href="ch21.html#X25" title="21.2.3. Comment Lines">comment block macro</a>.</p></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_block_macros"></a>21.2. Block Macros</h2></div></div></div><p>A Block macro reference must be contained in a single line separated -either side by a blank line or a block delimiter.</p><p>Block macros behave just like Inline macros, with the following -differences:</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -They occur in a block context. -</li><li class="listitem"> -The default syntax is <code class="literal"><name>::<target>[<attrlist>]</code> (two - colons, not one). -</li><li class="listitem"> -Markup template section names end in <code class="literal">-blockmacro</code> instead of - <code class="literal">-inlinemacro</code>. -</li></ul></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_block_identifier"></a>21.2.1. Block Identifier</h3></div></div></div><p>The Block Identifier macro sets the <code class="literal">id</code> attribute and has the same -syntax as the <a class="link" href="ch21.html#X30" title="anchor">anchor inline macro</a> since it performs -essentially the same function — block templates use the <code class="literal">id</code> -attribute as a block element ID. For example:</p><pre class="literallayout">[[X30]]</pre><p>This is equivalent to the <code class="literal">[id="X30"]</code> <a class="link" href="ch14.html" title="Chapter 14. AttributeList Element">AttributeList element</a>).</p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="X49"></a>21.2.2. Images</h3></div></div></div><p>The <span class="emphasis"><em>image</em></span> block macro is used to display images in a block context. -The syntax is:</p><pre class="literallayout">image::<target>[<attributes>]</pre><p>The block <code class="literal">image</code> macro has the same <a class="link" href="ch21.html#X55" title="Image macro attributes">macro attributes</a> as it’s -<a class="link" href="ch21.html#X9" title="21.1.4. Images">inline image macro</a> counterpart.</p><div class="warning" style="margin-left: 0; margin-right: 10%;"><table border="0" summary="Warning"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="images/icons/warning.png" /></td><th align="left"></th></tr><tr><td align="left" valign="top"><p>Unlike the inline <code class="literal">image</code> macro, the entire block <code class="literal">image</code> macro -must be on a single line.</p></td></tr></table></div><p>Block images can be titled by preceding the <span class="emphasis"><em>image</em></span> macro with a -<span class="emphasis"><em>BlockTitle</em></span>. DocBook toolchains normally number titled block images -and optionally list them in an automatically generated <span class="emphasis"><em>List of -Figures</em></span> backmatter section.</p><p>This example:</p><pre class="literallayout">.Main circuit board -image::images/layout.png[J14P main circuit board]</pre><p>is equivalent to:</p><pre class="literallayout">image::images/layout.png["J14P main circuit board", title="Main circuit board"]</pre><p>A title prefix that can be inserted with the <code class="literal">caption</code> attribute -(HTML backends). For example:</p><pre class="literallayout">.Main circuit board -[caption="Figure 2: "] -image::images/layout.png[J14P main circuit board]</pre><div class="sidebar"><a id="X66"></a><div class="titlepage"><div><div><p class="title"><strong>Embedding images in XHTML documents</strong></p></div></div></div><p>If you define the <code class="literal">data-uri</code> attribute then images will be embedded in -XHTML outputs using the -<a class="ulink" href="http://en.wikipedia.org/wiki/Data:_URI_scheme" target="_top">data URI scheme</a>. You -can use the <span class="emphasis"><em>data-uri</em></span> attribute with the <span class="emphasis"><em>xhtml11</em></span> and <span class="emphasis"><em>html5</em></span> -backends to produce single-file XHTML documents with embedded images -and CSS, for example:</p><pre class="literallayout">$ asciidoc -a data-uri mydocument.txt</pre><div class="note" style="margin-left: 0; margin-right: 10%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/icons/note.png" /></td><th align="left"></th></tr><tr><td align="left" valign="top"><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -All current popular browsers support data URIs, although versions - of Internet Explorer prior to version 8 do not. -</li><li class="listitem"> -Some browsers limit the size of data URIs. -</li></ul></div></td></tr></table></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="X25"></a>21.2.3. Comment Lines</h3></div></div></div><p>Single lines starting with two forward slashes hard up against the -left margin are treated as comments. Comment lines do not appear in -the output unless the <span class="emphasis"><em>showcomments</em></span> attribute is defined. Comment -lines have been implemented as both block and inline macros so a -comment line can appear as a stand-alone block or within block elements -that support inline macro expansion. Example comment line:</p><pre class="literallayout">// This is a comment.</pre><p>If the <span class="emphasis"><em>showcomments</em></span> attribute is defined comment lines are written -to the output:</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -In DocBook the comment lines are enclosed by the <span class="emphasis"><em>remark</em></span> element - (which may or may not be rendered by your toolchain). -</li><li class="listitem"> -The <span class="emphasis"><em>showcomments</em></span> attribute does not expose <a class="link" href="ch16.html#X26" title="16.5. Comment Blocks">Comment Blocks</a>. - Comment Blocks are never passed to the output. -</li></ul></div></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_system_macros"></a>21.3. System Macros</h2></div></div></div><p>System macros are block macros that perform a predefined task and are -hardwired into the asciidoc(1) program.</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -You can escape system macros with a leading backslash character - (as you can with other macros). -</li><li class="listitem"> -The syntax and tasks performed by system macros is built into - asciidoc(1) so they don’t appear in configuration files. You can - however customize the syntax by adding entries to a configuration - file <code class="literal">[macros]</code> section. -</li></ul></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="X63"></a>21.3.1. Include Macros</h3></div></div></div><p>The <code class="literal">include</code> and <code class="literal">include1</code> system macros to include the contents of -a named file into the source document.</p><p>The <code class="literal">include</code> macro includes a file as if it were part of the parent -document — tabs are expanded and system macros processed. The -contents of <code class="literal">include1</code> files are not subject to tab expansion or -system macro processing nor are attribute or lower priority -substitutions performed. The <code class="literal">include1</code> macro’s intended use is to -include verbatim embedded CSS or scripts into configuration file -headers. Example:</p><pre class="screen">include::chapter1.txt[tabsize=4]</pre><div class="itemizedlist"><p class="title"><strong>Include macro behavior</strong></p><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -If the included file name is specified with a relative path then the - path is relative to the location of the referring document. -</li><li class="listitem"> -Include macros can appear inside configuration files. -</li><li class="listitem"> -Files included from within <span class="emphasis"><em>DelimitedBlocks</em></span> are read to completion - to avoid false end-of-block underline termination. -</li><li class="listitem"> -Attribute references are expanded inside the include <span class="emphasis"><em>target</em></span>; if an - attribute is undefined then the included file is silently skipped. -</li><li class="listitem"> -The <span class="emphasis"><em>tabsize</em></span> macro attribute sets the number of space characters to - be used for tab expansion in the included file (not applicable to - <code class="literal">include1</code> macro). -</li><li class="listitem"> -The <span class="emphasis"><em>depth</em></span> macro attribute sets the maximum permitted number of - subsequent nested includes (not applicable to <code class="literal">include1</code> macro which - does not process nested includes). Setting <span class="emphasis"><em>depth</em></span> to <span class="emphasis"><em>1</em></span> disables - nesting inside the included file. By default, nesting is limited to - a depth of ten. -</li><li class="listitem"> -If the he <span class="emphasis"><em>warnings</em></span> attribute is set to <span class="emphasis"><em>False</em></span> (or any other - Python literal that evaluates to boolean false) then no warning - message is printed if the included file does not exist. By default - <span class="emphasis"><em>warnings</em></span> are enabled. -</li><li class="listitem"> -Internally the <code class="literal">include1</code> macro is translated to the <code class="literal">include1</code> - system attribute which means it must be evaluated in a region where - attribute substitution is enabled. To inhibit nested substitution in - included files it is preferable to use the <code class="literal">include</code> macro and set - the attribute <code class="literal">depth=1</code>. -</li></ul></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_conditional_inclusion_macros"></a>21.3.2. Conditional Inclusion Macros</h3></div></div></div><p>Lines of text in the source document can be selectively included or -excluded from processing based on the existence (or not) of a document -attribute.</p><p>Document text between the <code class="literal">ifdef</code> and <code class="literal">endif</code> macros is included if a -document attribute is defined:</p><pre class="literallayout">ifdef::<attribute>[] -: -endif::<attribute>[]</pre><p>Document text between the <code class="literal">ifndef</code> and <code class="literal">endif</code> macros is not included -if a document attribute is defined:</p><pre class="literallayout">ifndef::<attribute>[] -: -endif::<attribute>[]</pre><p><code class="literal"><attribute></code> is an attribute name which is optional in the trailing -<code class="literal">endif</code> macro.</p><p>If you only want to process a single line of text then the text can be -put inside the square brackets and the <code class="literal">endif</code> macro omitted, for -example:</p><pre class="literallayout">ifdef::revnumber[Version number 42]</pre><p>Is equivalent to:</p><pre class="literallayout">ifdef::revnumber[] -Version number 42 -endif::revnumber[]</pre><p><span class="emphasis"><em>ifdef</em></span> and <span class="emphasis"><em>ifndef</em></span> macros also accept multiple attribute names:</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -Multiple <span class="emphasis"><em>,</em></span> separated attribute names evaluate to defined if one - or more of the attributes is defined, otherwise it’s value is - undefined. -</li><li class="listitem"> -Multiple <span class="emphasis"><em>+</em></span> separated attribute names evaluate to defined if all - of the attributes is defined, otherwise it’s value is undefined. -</li></ul></div><p>Document text between the <code class="literal">ifeval</code> and <code class="literal">endif</code> macros is included if -the Python expression inside the square brackets is true. Example:</p><pre class="literallayout">ifeval::[{rs458}==2] -: -endif::[]</pre><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -Document attribute references are expanded before the expression is - evaluated. -</li><li class="listitem"> -If an attribute reference is undefined then the expression is - considered false. -</li></ul></div><p>Take a look at the <code class="literal">*.conf</code> configuration files in the AsciiDoc -distribution for examples of conditional inclusion macro usage.</p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_executable_system_macros"></a>21.3.3. Executable system macros</h3></div></div></div><p>The <span class="emphasis"><em>eval</em></span>, <span class="emphasis"><em>sys</em></span> and <span class="emphasis"><em>sys2</em></span> block macros exhibit the same behavior as -their same named <a class="link" href="ch30.html#X24" title="30.3. System Attribute References">system attribute references</a>. The difference -is that system macros occur in a block macro context whereas system -attributes are confined to inline contexts where attribute -substitution is enabled.</p><p>The following example displays a long directory listing inside a -literal block:</p><pre class="literallayout">------------------ -sys::[ls -l *.txt] -------------------</pre><div class="note" style="margin-left: 0; margin-right: 10%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/icons/note.png" /></td><th align="left"></th></tr><tr><td align="left" valign="top"><p>There are no block macro versions of the <span class="emphasis"><em>eval3</em></span> and <span class="emphasis"><em>sys3</em></span> -system attributes.</p></td></tr></table></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_template_system_macro"></a>21.3.4. Template System Macro</h3></div></div></div><p>The <code class="literal">template</code> block macro allows the inclusion of one configuration -file template section within another. The following example includes -the <code class="literal">[admonitionblock]</code> section in the <code class="literal">[admonitionparagraph]</code> -section:</p><pre class="literallayout">[admonitionparagraph] -template::[admonitionblock]</pre><div class="itemizedlist"><p class="title"><strong>Template macro behavior</strong></p><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -The <code class="literal">template::[]</code> macro is useful for factoring configuration file - markup. -</li><li class="listitem"> -<code class="literal">template::[]</code> macros cannot be nested. -</li><li class="listitem"> -<code class="literal">template::[]</code> macro expansion is applied after all configuration - files have been read. -</li></ul></div></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="X77"></a>21.4. Passthrough macros</h2></div></div></div><p>Passthrough macros are analogous to <a class="link" href="ch16.html#X76" title="16.6. Passthrough Blocks">passthrough blocks</a> and are -used to pass text directly to the output. The substitution performed -on the text is determined by the macro definition but can be overridden -by the <code class="literal"><subslist></code>. The usual syntax is -<code class="literal"><name>:<subslist>[<passtext>]</code> (for inline macros) and -<code class="literal"><name>::<subslist>[<passtext>]</code> (for block macros). Passthroughs, by -definition, take precedence over all other text substitutions.</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"> -pass -</span></dt><dd><p class="simpara"> - Inline and block. Passes text unmodified (apart from explicitly - specified substitutions). Examples: -</p><pre class="literallayout">pass:[<q>To be or not to be</q>] -pass:attributes,quotes[<u>the '{author}'</u>]</pre></dd><dt><span class="term"> -asciimath, latexmath -</span></dt><dd> - Inline and block. Passes text unmodified. Used for - <a class="link" href="ch25.html" title="Chapter 25. Mathematical Formulas">mathematical formulas</a>. -</dd><dt><span class="term"> -+++ -</span></dt><dd><p class="simpara"> - Inline and block. The triple-plus passthrough is functionally - identical to the <span class="emphasis"><em>pass</em></span> macro but you don’t have to escape <code class="literal">]</code> - characters and you can prefix with quoted attributes in the inline - version. Example: -</p><pre class="literallayout">Red [red]+++`sum_(i=1)\^n i=(n(n+1))/2`$+++ AsciiMathML formula</pre></dd><dt><span class="term"> -$$ -</span></dt><dd><p class="simpara"> - Inline and block. The double-dollar passthrough is functionally - identical to the triple-plus passthrough with one exception: special - characters are escaped. Example: -</p><pre class="literallayout">$$`[[a,b],[c,d]]((n),(k))`$$</pre></dd><dt><span class="term"> -<a id="X80"></a>` -</span></dt><dd> - Text quoted with single backtick characters constitutes an <span class="emphasis"><em>inline - literal</em></span> passthrough. The enclosed text is rendered in a monospaced - font and is only subject to special character substitution. This - makes sense since monospace text is usually intended to be rendered - literally and often contains characters that would otherwise have to - be escaped. If you need monospaced text containing inline - substitutions use a <a class="link" href="ch10.html#X81">plus character instead of a backtick</a>. -</dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_macro_definitions"></a>21.5. Macro Definitions</h2></div></div></div><p>Each entry in the configuration <code class="literal">[macros]</code> section is a macro -definition which can take one of the following forms:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"> -<code class="literal"><pattern>=<name>[<subslist]</code> -</span></dt><dd> -Inline macro definition. -</dd><dt><span class="term"> -<code class="literal"><pattern>=#<name>[<subslist]</code> -</span></dt><dd> -Block macro definition. -</dd><dt><span class="term"> -<code class="literal"><pattern>=+<name>[<subslist]</code> -</span></dt><dd> -System macro definition. -</dd><dt><span class="term"> -<code class="literal"><pattern></code> -</span></dt><dd> -Delete the existing macro with this <code class="literal"><pattern></code>. -</dd></dl></div><p><code class="literal"><pattern></code> is a Python regular expression and <code class="literal"><name></code> is the name of -a markup template. If <code class="literal"><name></code> is omitted then it is the value of the -regular expression match group named <span class="emphasis"><em>name</em></span>. The optional -<code class="literal">[<subslist]</code> is a comma-separated list of substitution names enclosed -in <code class="literal">[]</code> brackets, it sets the default substitutions for passthrough -text, if omitted then no passthrough substitutions are performed.</p><p><strong>Pattern named groups. </strong>The following named groups can be used in macro <code class="literal"><pattern></code> regular -expressions and are available as markup template attributes:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"> -name -</span></dt><dd> - The macro name. -</dd><dt><span class="term"> -target -</span></dt><dd> - The macro target. -</dd><dt><span class="term"> -attrlist -</span></dt><dd> - The macro attribute list. -</dd><dt><span class="term"> -passtext -</span></dt><dd> - Contents of this group are passed unmodified to the output subject - only to <span class="emphasis"><em>subslist</em></span> substitutions. -</dd><dt><span class="term"> -subslist -</span></dt><dd> - Processed as a comma-separated list of substitution names for - <span class="emphasis"><em>passtext</em></span> substitution, overrides the the macro definition - <span class="emphasis"><em>subslist</em></span>. -</dd></dl></div><div class="itemizedlist"><p class="title"><strong>Here’s what happens during macro substitution</strong></p><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -Each contextually relevant macro <span class="emphasis"><em>pattern</em></span> from the <code class="literal">[macros]</code> - section is matched against the input source line. -</li><li class="listitem"> -If a match is found the text to be substituted is loaded from a - configuration markup template section named like - <code class="literal"><name>-inlinemacro</code> or <code class="literal"><name>-blockmacro</code> (depending on the macro - type). -</li><li class="listitem"> -Global and macro attribute list attributes are substituted in the - macro’s markup template. -</li><li class="listitem"> -The substituted template replaces the macro reference in the output - document. -</li></ul></div></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch20.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch22.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/icons/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
\ No newline at end of file diff --git a/chunked/ch22.html b/chunked/ch22.html deleted file mode 100644 index 1975077..0000000 --- a/chunked/ch22.html +++ /dev/null @@ -1,57 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Chapter 22. HTML 5 audio and video block macros</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="AsciiDoc User Guide" /><link rel="up" href="index.html" title="AsciiDoc User Guide" /><link rel="prev" href="ch21.html" title="Chapter 21. Macros" /><link rel="next" href="ch23.html" title="Chapter 23. Tables" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="ch21.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch23.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a id="X98"></a>Chapter 22. HTML 5 audio and video block macros</h1></div></div></div><p>The <span class="emphasis"><em>html5</em></span> backend <span class="emphasis"><em>audio</em></span> and <span class="emphasis"><em>video</em></span> block macros generate the HTML -5 <span class="emphasis"><em>audio</em></span> and <span class="emphasis"><em>video</em></span> elements respectively. They follow the usual -AsciiDoc block macro syntax <code class="literal"><name>::<target>[<attrlist>]</code> where:</p><div class="horizontal"><table class="horizontal" cellpadding="4px" style="border: none;"><colgroup><col /><col /></colgroup><tbody valign="top"><tr><td style="" valign="top"> -<p> -<code class="literal"><name></code> -</p> -</td><td style="" valign="top"> -<p> -<span class="emphasis"><em>audio</em></span> or <span class="emphasis"><em>video</em></span>. -</p> -</td></tr><tr><td style="" valign="top"> -<p> -<code class="literal"><target></code> -</p> -</td><td style="" valign="top"> -<p> -The URL or file name of the video or audio file. -</p> -</td></tr><tr><td style="" valign="top"> -<p> -<code class="literal"><attrlist></code> -</p> -</td><td style="" valign="top"> -<p> -A list of named attributes (see below). -</p> -</td></tr></tbody></table></div><div class="table"><a id="idm2641"></a><p class="title"><strong>Table 22.1. Audio macro attributes</strong></p><div class="table-contents"><table class="table" summary="Audio macro attributes" cellpadding="4px" style="border-collapse: collapse;border-top: 3px solid #527bbd; border-bottom: 3px solid #527bbd; "><colgroup><col class="col_1" /><col class="col_2" /></colgroup><thead><tr><th style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top">Name </th><th style="border-bottom: 1px solid #527bbd; " align="left" valign="top"> Value</th></tr></thead><tbody><tr><td style="border-right: 1px solid #527bbd; " align="left" valign="top"><p>options</p></td><td style="" align="left" valign="top"><p>A comma separated list of one or more of the following items: -<span class="emphasis"><em>autoplay</em></span>, <span class="emphasis"><em>loop</em></span> which correspond to the same-named HTML 5 <span class="emphasis"><em>audio</em></span> -element boolean attributes. By default the player <span class="emphasis"><em>controls</em></span> are -enabled, include the <span class="emphasis"><em>nocontrols</em></span> option value to hide them.</p></td></tr></tbody></table></div></div><br class="table-break" /><div class="table"><a id="idm2661"></a><p class="title"><strong>Table 22.2. Video macro attributes</strong></p><div class="table-contents"><table class="table" summary="Video macro attributes" cellpadding="4px" style="border-collapse: collapse;border-top: 3px solid #527bbd; border-bottom: 3px solid #527bbd; "><colgroup><col class="col_1" /><col class="col_2" /></colgroup><thead><tr><th style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top">Name </th><th style="border-bottom: 1px solid #527bbd; " align="left" valign="top"> Value</th></tr></thead><tbody><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>height</p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>The height of the player in pixels.</p></td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>width</p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>The width of the player in pixels.</p></td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>poster</p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>The URL or file name of an image representing the video.</p></td></tr><tr><td style="border-right: 1px solid #527bbd; " align="left" valign="top"><p>options</p></td><td style="" align="left" valign="top"><p>A comma separated list of one or more of the following items: -<span class="emphasis"><em>autoplay</em></span>, <span class="emphasis"><em>loop</em></span> and <span class="emphasis"><em>nocontrols</em></span>. The <span class="emphasis"><em>autoplay</em></span> and <span class="emphasis"><em>loop</em></span> options -correspond to the same-named HTML 5 <span class="emphasis"><em>video</em></span> element boolean -attributes. By default the player <span class="emphasis"><em>controls</em></span> are enabled, include the -<span class="emphasis"><em>nocontrols</em></span> option value to hide them.</p></td></tr></tbody></table></div></div><br class="table-break" /><p>Examples:</p><pre class="screen">audio::images/example.ogg[] - -video::gizmo.ogv[width=200,options="nocontrols,autoplay"] - -.Example video -video::gizmo.ogv[] - -video::http://www.808.dk/pics/video/gizmo.ogv[]</pre><p>If your needs are more complex put raw HTML 5 in a markup block, for -example (from <a class="ulink" href="http://www.808.dk/?code-html-5-video" target="_top">http://www.808.dk/?code-html-5-video</a>):</p><pre class="screen">++++ -<video poster="pics/video/gizmo.jpg" id="video" style="cursor: pointer;" > - <source src="pics/video/gizmo.mp4" /> - <source src="pics/video/gizmo.webm" type="video/webm" /> - <source src="pics/video/gizmo.ogv" type="video/ogg" /> - Video not playing? <a href="pics/video/gizmo.mp4">Download file</a> instead. -</video> - -<script type="text/javascript"> - var video = document.getElementById('video'); - video.addEventListener('click',function(){ - video.play(); - },false); -</script> -++++</pre></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch21.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch23.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/icons/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
\ No newline at end of file diff --git a/chunked/ch23.html b/chunked/ch23.html deleted file mode 100644 index 8fb65fe..0000000 --- a/chunked/ch23.html +++ /dev/null @@ -1,381 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Chapter 23. Tables</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="AsciiDoc User Guide" /><link rel="up" href="index.html" title="AsciiDoc User Guide" /><link rel="prev" href="ch22.html" title="Chapter 22. HTML 5 audio and video block macros" /><link rel="next" href="ch24.html" title="Chapter 24. Manpage Documents" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="ch22.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch24.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a id="_tables"></a>Chapter 23. Tables</h1></div></div></div><p>The AsciiDoc table syntax looks and behaves like other delimited block -types and supports standard <a class="link" href="ch32.html" title="Chapter 32. Block Element Definitions">block configuration entries</a>. -Formatting is easy to read and, just as importantly, easy to enter.</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -Cells and columns can be formatted using built-in customizable styles. -</li><li class="listitem"> -Horizontal and vertical cell alignment can be set on columns and - cell. -</li><li class="listitem"> -Horizontal and vertical cell spanning is supported. -</li></ul></div><div class="sidebar"><div class="titlepage"><div><div><p class="title"><strong>Use tables sparingly</strong></p></div></div></div><p>When technical users first start creating documents, tables (complete -with column spanning and table nesting) are often considered very -important. The reality is that tables are seldom used, even in -technical documentation.</p><p>Try this exercise: thumb through your library of technical books, -you’ll be surprised just how seldom tables are actually used, even -less seldom are tables containing block elements (such as paragraphs -or lists) or spanned cells. This is no accident, like figures, tables -are outside the normal document flow — tables are for consulting not -for reading.</p><p>Tables are designed for, and should normally only be used for, -displaying column oriented tabular data.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_example_tables"></a>23.1. Example tables</h2></div></div></div><div class="table"><a id="idm2722"></a><p class="title"><strong>Table 23.1. Simple table</strong></p><div class="table-contents"><table class="table" summary="Simple table" cellpadding="4px" style="border-collapse: collapse;border-top: 3px solid #527bbd; border-bottom: 3px solid #527bbd; border-left: 3px solid #527bbd; border-right: 3px solid #527bbd; " width="15%"><colgroup><col class="col_1" /><col class="col_2" /><col class="col_3" /></colgroup><tbody><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>1</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>2</p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>A</p></td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>3</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>4</p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>B</p></td></tr><tr><td style="border-right: 1px solid #527bbd; " align="left" valign="top"><p>5</p></td><td style="border-right: 1px solid #527bbd; " align="left" valign="top"><p>6</p></td><td style="" align="left" valign="top"><p>C</p></td></tr></tbody></table></div></div><br class="table-break" /><p><strong>AsciiDoc source. </strong> -</p><pre class="screen">[width="15%"] -|======= -|1 |2 |A -|3 |4 |B -|5 |6 |C -|=======</pre><p> -</p><div class="table"><a id="idm2754"></a><p class="title"><strong>Table 23.2. Columns formatted with strong, monospaced and emphasis styles</strong></p><div class="table-contents"><table class="table" summary="Columns formatted with strong, monospaced and emphasis styles" cellpadding="4px" style="border-collapse: collapse;border-top: 3px solid #527bbd; border-bottom: 3px solid #527bbd; " width="50%"><colgroup><col class="col_1" /><col class="col_2" /><col class="col_3" /></colgroup><thead><tr><th style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="right" valign="top"> </th><th style="border-bottom: 1px solid #527bbd; " colspan="2" align="center" valign="top">Columns 2 and 3</th></tr></thead><tfoot><tr><th style="border-right: 1px solid #527bbd; " align="right" valign="top"><p><span class="strong"><strong>footer 1</strong></span></p></th><th style="border-right: 1px solid #527bbd; " align="center" valign="top"><p><code class="literal">footer 2</code></p></th><th style="" align="left" valign="top"><p><span class="emphasis"><em>footer 3</em></span></p></th></tr></tfoot><tbody><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="right" valign="top"><p><span class="strong"><strong>1</strong></span></p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top"><p><code class="literal">Item 1</code></p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em>Item 1</em></span></p></td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="right" valign="top"><p><span class="strong"><strong>2</strong></span></p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top"><p><code class="literal">Item 2</code></p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em>Item 2</em></span></p></td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="right" valign="top"><p><span class="strong"><strong>3</strong></span></p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top"><p><code class="literal">Item 3</code></p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em>Item 3</em></span></p></td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="right" valign="top"><p><span class="strong"><strong>4</strong></span></p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top"><p><code class="literal">Item 4</code></p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em>Item 4</em></span></p></td></tr></tbody></table></div></div><br class="table-break" /><p><strong>AsciiDoc source. </strong> -</p><pre class="screen">.An example table -[width="50%",cols=">s,^m,e",frame="topbot",options="header,footer"] -|========================== -| 2+|Columns 2 and 3 -|1 |Item 1 |Item 1 -|2 |Item 2 |Item 2 -|3 |Item 3 |Item 3 -|4 |Item 4 |Item 4 -|footer 1|footer 2|footer 3 -|==========================</pre><p> -</p><div class="table"><a id="idm2820"></a><p class="title"><strong>Table 23.3. Horizontal and vertical source data</strong></p><div class="table-contents"><table class="table" summary="Horizontal and vertical source data" cellpadding="4px" style="border-collapse: collapse;border-top: 3px solid #527bbd; border-bottom: 3px solid #527bbd; border-left: 3px solid #527bbd; border-right: 3px solid #527bbd; " width="80%"><colgroup><col class="col_1" /><col class="col_2" /><col class="col_3" /><col class="col_4" /></colgroup><thead><tr><th style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top">Date </th><th style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top">Duration </th><th style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top">Avg HR </th><th style="border-bottom: 1px solid #527bbd; " align="left" valign="top">Notes</th></tr></thead><tbody><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>22-Aug-08</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top"><p>10:24</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top"><p>157</p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>Worked out MSHR (max sustainable heart rate) by going hard -for this interval.</p></td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>22-Aug-08</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top"><p>23:03</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top"><p>152</p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>Back-to-back with previous interval.</p></td></tr><tr><td style="border-right: 1px solid #527bbd; " align="left" valign="top"><p>24-Aug-08</p></td><td style="border-right: 1px solid #527bbd; " align="center" valign="top"><p>40:00</p></td><td style="border-right: 1px solid #527bbd; " align="center" valign="top"><p>145</p></td><td style="" align="left" valign="top"><p>Moderately hard interspersed with 3x 3min intervals (2min -hard + 1min really hard taking the HR up to 160).</p></td></tr></tbody></table></div></div><br class="table-break" /><p>Short cells can be entered horizontally, longer cells vertically. The -default behavior is to strip leading and trailing blank lines within a -cell. These characteristics aid readability and data entry.</p><p><strong>AsciiDoc source. </strong> -</p><pre class="screen">.Windtrainer workouts -[width="80%",cols="3,^2,^2,10",options="header"] -|========================================================= -|Date |Duration |Avg HR |Notes - -|22-Aug-08 |10:24 | 157 | -Worked out MSHR (max sustainable heart rate) by going hard -for this interval. - -|22-Aug-08 |23:03 | 152 | -Back-to-back with previous interval. - -|24-Aug-08 |40:00 | 145 | -Moderately hard interspersed with 3x 3min intervals (2min -hard + 1min really hard taking the HR up to 160). - -|=========================================================</pre><p> -</p><div class="table"><a id="idm2866"></a><p class="title"><strong>Table 23.4. A table with externally sourced CSV data</strong></p><div class="table-contents"><table class="table" summary="A table with externally sourced CSV data" cellpadding="4px" style="border-collapse: collapse;border-top: 3px solid #527bbd; border-bottom: 3px solid #527bbd; border-left: 3px solid #527bbd; border-right: 3px solid #527bbd; "><colgroup><col class="col_1" /><col class="col_2" /><col class="col_3" /><col class="col_4" /><col class="col_5" /></colgroup><thead><tr><th style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top">ID</th><th style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top">Customer Name</th><th style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top">Contact Name</th><th style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top">Customer Address</th><th style="border-bottom: 1px solid #527bbd; " align="left" valign="top">Phone</th></tr></thead><tbody><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top"><p>AROUT</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>Around the Horn</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>Thomas Hardy</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>120 Hanover Sq. -London</p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>(171) 555-7788</p></td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top"><p>BERGS</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>Berglunds snabbkop</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>Christina Berglund</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>Berguvsvagen 8 -Lulea</p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>0921-12 34 65</p></td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top"><p>BLAUS</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>Blauer See Delikatessen</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>Hanna Moos</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>Forsterstr. 57 -Mannheim</p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>0621-08460</p></td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top"><p>BLONP</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>Blondel pere et fils</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>Frederique Citeaux</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>24, place Kleber -Strasbourg</p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>88.60.15.31</p></td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top"><p>BOLID</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>Bolido Comidas preparadas</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>Martin Sommer</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>C/ Araquil, 67 -Madrid</p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>(91) 555 22 82</p></td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top"><p>BONAP</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>Bon app'</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>Laurence Lebihan</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>12, rue des Bouchers -Marseille</p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>91.24.45.40</p></td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top"><p>BOTTM</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>Bottom-Dollar Markets</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>Elizabeth Lincoln</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>23 Tsawassen Blvd. -Tsawassen</p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>(604) 555-4729</p></td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top"><p>BSBEV</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>B’s Beverages</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>Victoria Ashworth</p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>Fauntleroy Circus -London</p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>(171) 555-1212</p></td></tr><tr><td style="border-right: 1px solid #527bbd; " align="center" valign="top"><p>CACTU</p></td><td style="border-right: 1px solid #527bbd; " align="left" valign="top"><p>Cactus Comidas para llevar</p></td><td style="border-right: 1px solid #527bbd; " align="left" valign="top"><p>Patricio Simpson</p></td><td style="border-right: 1px solid #527bbd; " align="left" valign="top"><p>Cerrito 333 -Buenos Aires</p></td><td style="" align="left" valign="top"><p>(1) 135-5555</p></td></tr></tbody></table></div></div><br class="table-break" /><p><strong>AsciiDoc source. </strong> -</p><pre class="screen">[format="csv",cols="^1,4*2",options="header"] -|=================================================== -ID,Customer Name,Contact Name,Customer Address,Phone -include::customers.csv[] -|===================================================</pre><p> -</p><div class="table"><a id="idm2985"></a><p class="title"><strong>Table 23.5. Cell spans, alignments and styles</strong></p><div class="table-contents"><table class="table" summary="Cell spans, alignments and styles" cellpadding="4px" style="border-collapse: collapse;border-top: 3px solid #527bbd; border-bottom: 3px solid #527bbd; border-left: 3px solid #527bbd; border-right: 3px solid #527bbd; " width="25%"><colgroup><col class="col_1" /><col class="col_2" /><col class="col_3" /><col class="col_4" /></colgroup><tbody><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em>1</em></span></p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="right" valign="top"><p><span class="strong"><strong>2</strong></span></p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top"><p>3</p></td><td style="border-bottom: 1px solid #527bbd; " align="right" valign="top"><p><span class="strong"><strong>4</strong></span></p></td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top"><p><span class="emphasis"><em>5</em></span></p></td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " rowspan="2" colspan="2" align="center" valign="middle"><p><code class="literal">6</code></p></td><td style="" rowspan="3" align="left" valign="bottom"><p><code class="literal">7</code></p></td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="center" valign="top"><p><span class="emphasis"><em>8</em></span></p></td></tr><tr><td style="border-right: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em>9</em></span></p></td><td style="border-right: 1px solid #527bbd; " colspan="2" align="right" valign="top"><p><code class="literal">10</code></p></td></tr></tbody></table></div></div><br class="table-break" /><p><strong>AsciiDoc source. </strong> -</p><pre class="screen">[cols="e,m,^,>s",width="25%"] -|============================ -|1 >s|2 |3 |4 -^|5 2.2+^.^|6 .3+<.>m|7 -^|8 -|9 2+>|10 -|============================</pre><p> -</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="X68"></a>23.2. Table input data formats</h2></div></div></div><p>AsciiDoc table data can be <span class="emphasis"><em>psv</em></span>, <span class="emphasis"><em>dsv</em></span> or <span class="emphasis"><em>csv</em></span> formatted. The -default table format is <span class="emphasis"><em>psv</em></span>.</p><p>AsciiDoc <span class="emphasis"><em>psv</em></span> (<span class="emphasis"><em>Prefix Separated Values</em></span>) and <span class="emphasis"><em>dsv</em></span> (<span class="emphasis"><em>Delimiter -Separated Values</em></span>) formats are cell oriented — the table is treated -as a sequence of cells — there are no explicit row separators.</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -<span class="emphasis"><em>psv</em></span> prefixes each cell with a separator whereas <span class="emphasis"><em>dsv</em></span> delimits - cells with a separator. -</li><li class="listitem"> -<span class="emphasis"><em>psv</em></span> and <span class="emphasis"><em>dsv</em></span> separators are Python regular expressions. -</li><li class="listitem"> -The default <span class="emphasis"><em>psv</em></span> separator contains <a class="link" href="ch23.html#X84" title="23.5. Cell Specifiers">cell specifier</a> related - named regular expression groups. -</li><li class="listitem"> -The default <span class="emphasis"><em>dsv</em></span> separator is <code class="literal">:|\n</code> (a colon or a new line - character). -</li><li class="listitem"> -<span class="emphasis"><em>psv</em></span> and <span class="emphasis"><em>dsv</em></span> cell separators can be escaped by preceding them - with a backslash character. -</li></ul></div><p>Here are four <span class="emphasis"><em>psv</em></span> cells (the second item spans two columns; the -last contains an escaped separator):</p><pre class="literallayout">|One 2+|Two and three |A \| separator character</pre><p><span class="emphasis"><em>csv</em></span> is the quasi-standard row oriented <span class="emphasis"><em>Comma Separated Values -(CSV)</em></span> format commonly used to import and export spreadsheet and -database data.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="X69"></a>23.3. Table attributes</h2></div></div></div><p>Tables can be customized by the following attributes:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"> -format -</span></dt><dd> -<span class="emphasis"><em>psv</em></span> (default), <span class="emphasis"><em>dsv</em></span> or <span class="emphasis"><em>csv</em></span> (See <a class="link" href="ch23.html#X68" title="23.2. Table input data formats">Table Data Formats</a>). -</dd><dt><span class="term"> -separator -</span></dt><dd> -The cell separator. A Python regular expression (<span class="emphasis"><em>psv</em></span> and <span class="emphasis"><em>dsv</em></span> -formats) or a single character (<span class="emphasis"><em>csv</em></span> format). -</dd><dt><span class="term"> -frame -</span></dt><dd> -Defines the table border and can take the following values: <span class="emphasis"><em>topbot</em></span> -(top and bottom), <span class="emphasis"><em>all</em></span> (all sides), <span class="emphasis"><em>none</em></span> and <span class="emphasis"><em>sides</em></span> (left and -right sides). The default value is <span class="emphasis"><em>all</em></span>. -</dd><dt><span class="term"> -grid -</span></dt><dd> -Defines which ruler lines are drawn between table rows and columns. -The <span class="emphasis"><em>grid</em></span> attribute value can be any of the following values: <span class="emphasis"><em>none</em></span>, -<span class="emphasis"><em>cols</em></span>, <span class="emphasis"><em>rows</em></span> and <span class="emphasis"><em>all</em></span>. The default value is <span class="emphasis"><em>all</em></span>. -</dd><dt><span class="term"> -align -</span></dt><dd> -Use the <span class="emphasis"><em>align</em></span> attribute to horizontally align the table on the -page (works with HTML outputs only, has no effect on DocBook outputs). -The following values are valid: <span class="emphasis"><em>left</em></span>, <span class="emphasis"><em>right</em></span>, and <span class="emphasis"><em>center</em></span>. -</dd><dt><span class="term"> -float -</span></dt><dd> -Use the <span class="emphasis"><em>float</em></span> attribute to float the table <span class="emphasis"><em>left</em></span> or <span class="emphasis"><em>right</em></span> on the -page (works with HTML outputs only, has no effect on DocBook outputs). -Floating only makes sense in conjunction with a table <span class="emphasis"><em>width</em></span> -attribute value of less than 100% (otherwise the table will take up -all the available space). <span class="emphasis"><em>float</em></span> and <span class="emphasis"><em>align</em></span> attributes are mutually -exclusive. Use the <code class="literal">unfloat::[]</code> block macro to stop floating. -</dd><dt><span class="term"> -halign -</span></dt><dd> -Use the <span class="emphasis"><em>halign</em></span> attribute to horizontally align all cells in a table. -The following values are valid: <span class="emphasis"><em>left</em></span>, <span class="emphasis"><em>right</em></span>, and <span class="emphasis"><em>center</em></span> -(defaults to <span class="emphasis"><em>left</em></span>). Overridden by <a class="link" href="ch23.html#X70" title="23.4. Column Specifiers">Column specifiers</a> and -<a class="link" href="ch23.html#X84" title="23.5. Cell Specifiers">Cell specifiers</a>. -</dd><dt><span class="term"> -valign -</span></dt><dd> -Use the <span class="emphasis"><em>valign</em></span> attribute to vertically align all cells in a table. -The following values are valid: <span class="emphasis"><em>top</em></span>, <span class="emphasis"><em>bottom</em></span>, and <span class="emphasis"><em>middle</em></span> -(defaults to <span class="emphasis"><em>top</em></span>). Overridden by <a class="link" href="ch23.html#X70" title="23.4. Column Specifiers">Column specifiers</a> and -<a class="link" href="ch23.html#X84" title="23.5. Cell Specifiers">Cell specifiers</a>. -</dd><dt><span class="term"> -options -</span></dt><dd> -The <span class="emphasis"><em>options</em></span> attribute can contain comma separated values, for -example: <span class="emphasis"><em>header</em></span>, <span class="emphasis"><em>footer</em></span>. By default header and footer rows are -omitted. See <a class="link" href="apf.html" title="Appendix F. Attribute Options">attribute options</a> for a complete list of -available table options. -</dd><dt><span class="term"> -cols -</span></dt><dd><p class="simpara"> -The <span class="emphasis"><em>cols</em></span> attribute is a comma separated list of <a class="link" href="ch23.html#X70" title="23.4. Column Specifiers">column specifiers</a>. For example <code class="literal">cols="2<p,2*,4p,>"</code>. -</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -If <span class="emphasis"><em>cols</em></span> is present it must specify all columns. -</li><li class="listitem"> -If the <span class="emphasis"><em>cols</em></span> attribute is not specified the number of columns is - calculated as the number of data items in the <span class="strong"><strong>first line</strong></span> of the - table. -</li><li class="listitem"> -The degenerate form for the <span class="emphasis"><em>cols</em></span> attribute is an integer - specifying the number of columns e.g. <code class="literal">cols=4</code>. -</li></ul></div></dd><dt><span class="term"> -width -</span></dt><dd> -The <span class="emphasis"><em>width</em></span> attribute is expressed as a percentage value -(<span class="emphasis"><em>"1%"</em></span>…<span class="emphasis"><em>"99%"</em></span>). The width specifies the table width relative to -the available width. HTML backends use this value to set the table -width attribute. It’s a bit more complicated with DocBook, see the -<a class="link" href="ch23.html#X89" title="DocBook table widths">DocBook table widths</a> sidebar. -</dd><dt><span class="term"> -filter -</span></dt><dd> -The <span class="emphasis"><em>filter</em></span> attribute defines an external shell command that is -invoked for each cell. The built-in <span class="emphasis"><em>asciidoc</em></span> table style is -implemented using a filter. -</dd></dl></div><div class="sidebar"><a id="X89"></a><div class="titlepage"><div><div><p class="title"><strong>DocBook table widths</strong></p></div></div></div><p>The AsciiDoc docbook backend generates CALS tables. CALS tables do not -support a table width attribute — table width can only be controlled -by specifying absolute column widths.</p><p>Specifying absolute column widths is not media independent because -different presentation media have different physical dimensions. To -get round this limitation both -<a class="ulink" href="http://www.sagehill.net/docbookxsl/Tables.html#TableWidth" target="_top">DocBook XSL -Stylesheets</a> and -<a class="ulink" href="http://dblatex.sourceforge.net/doc/manual/ch03s05.html#sec-table-width" target="_top">dblatex</a> -have implemented table width processing instructions for setting the -table width as a percentage of the available width. AsciiDoc emits -these processing instructions if the <span class="emphasis"><em>width</em></span> attribute is set along -with proportional column widths (the AsciiDoc docbook backend -<span class="emphasis"><em>pageunits</em></span> attribute defaults to <span class="emphasis"><em>*</em></span>).</p><p>To generate DocBook tables with absolute column widths set the -<span class="emphasis"><em>pageunits</em></span> attribute to a CALS absolute unit such as <span class="emphasis"><em>pt</em></span> and set the -<span class="emphasis"><em>pagewidth</em></span> attribute to match the width of the presentation media.</p></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="X70"></a>23.4. Column Specifiers</h2></div></div></div><p>Column specifiers define how columns are rendered and appear in the -table <a class="link" href="ch23.html#X69" title="23.3. Table attributes">cols attribute</a>. A column specifier consists of an -optional column multiplier followed by optional alignment, width and -style values and is formatted like:</p><pre class="literallayout">[<multiplier>*][<align>][<width>][<style>]</pre><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -All components are optional. The multiplier must be first and the - style last. The order of <code class="literal"><align></code> or <code class="literal"><width></code> is not important. -</li><li class="listitem"> -Column <code class="literal"><width></code> can be either an integer proportional value (1…) - or a percentage (1%…100%). The default value is 1. To ensure - portability across different backends, there is no provision for - absolute column widths (not to be confused with output column width - <a class="link" href="ch23.html#X72" title="23.7. Markup attributes">markup attributes</a> which are available in both percentage and - absolute units). -</li><li class="listitem"><p class="simpara"> -The <span class="emphasis"><em><align></em></span> column alignment specifier is formatted like: -</p><pre class="literallayout">[<horizontal>][.<vertical>]</pre><p class="simpara">Where <code class="literal"><horizontal></code> and <code class="literal"><vertical></code> are one of the following -characters: <code class="literal"><</code>, <code class="literal">^</code> or <code class="literal">></code> which represent <span class="emphasis"><em>left</em></span>, <span class="emphasis"><em>center</em></span> and -<span class="emphasis"><em>right</em></span> horizontal alignment or <span class="emphasis"><em>top</em></span>, <span class="emphasis"><em>middle</em></span> and <span class="emphasis"><em>bottom</em></span> vertical -alignment respectively.</p></li><li class="listitem"> -A <code class="literal"><multiplier></code> can be used to specify repeated columns e.g. - <code class="literal">cols="4*<"</code> specifies four left-justified columns. The default - multiplier value is 1. -</li><li class="listitem"> -The <code class="literal"><style></code> name specifies a <a class="link" href="ch23.html#X71" title="23.6. Table styles">table style</a> to used to markup - column cells (you can use the full style names if you wish but the - first letter is normally sufficient). -</li><li class="listitem"> -Column specific styles are not applied to header rows. -</li></ul></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="X84"></a>23.5. Cell Specifiers</h2></div></div></div><p>Cell specifiers allow individual cells in <span class="emphasis"><em>psv</em></span> formatted tables to be -spanned, multiplied, aligned and styled. Cell specifiers prefix <span class="emphasis"><em>psv</em></span> -<code class="literal">|</code> delimiters and are formatted like:</p><pre class="literallayout">[<span>*|+][<align>][<style>]</pre><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p class="simpara"> -<span class="emphasis"><em><span></em></span> specifies horizontal and vertical cell spans (<span class="emphasis"><em>+</em></span> operator) or - the number of times the cell is replicated (<span class="emphasis"><em>*</em></span> operator). <span class="emphasis"><em><span></em></span> - is formatted like: -</p><pre class="literallayout">[<colspan>][.<rowspan>]</pre><p class="simpara">Where <code class="literal"><colspan></code> and <code class="literal"><rowspan></code> are integers specifying the number of -columns and rows to span.</p></li><li class="listitem"> -<code class="literal"><align></code> specifies horizontal and vertical cell alignment an is the - same as in <a class="link" href="ch23.html#X70" title="23.4. Column Specifiers">column specifiers</a>. -</li><li class="listitem"> -A <code class="literal"><style></code> value is the first letter of <a class="link" href="ch23.html#X71" title="23.6. Table styles">table style</a> name. -</li></ul></div><p>For example, the following <span class="emphasis"><em>psv</em></span> formatted cell will span two columns -and the text will be centered and emphasized:</p><pre class="literallayout">`2+^e| Cell text`</pre></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="X71"></a>23.6. Table styles</h2></div></div></div><p>Table styles can be applied to the entire table (by setting the -<span class="emphasis"><em>style</em></span> attribute in the table’s attribute list) or on a per column -basis (by specifying the style in the table’s <a class="link" href="ch23.html#X69" title="23.3. Table attributes">cols attribute</a>). -Table data can be formatted using the following predefined styles:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"> -default -</span></dt><dd> -The default style: AsciiDoc inline text formatting; blank lines are -treated as paragraph breaks. -</dd><dt><span class="term"> -emphasis -</span></dt><dd> -Like default but all text is emphasised. -</dd><dt><span class="term"> -monospaced -</span></dt><dd> -Like default but all text is in a monospaced font. -</dd><dt><span class="term"> -strong -</span></dt><dd> -Like default but all text is bold. -</dd><dt><span class="term"> -header -</span></dt><dd> -Apply the same style as the table header. Normally used to create a -vertical header in the first column. -</dd><dt><span class="term"> -asciidoc -</span></dt><dd> -With this style table cells can contain any of the AsciiDoc elements -that are allowed inside document sections. This style runs asciidoc(1) -as a filter to process cell contents. See also <a class="link" href="ch23.html#X83" title="23.9. DocBook table limitations">Docbook table limitations</a>. -</dd><dt><span class="term"> -literal -</span></dt><dd> -No text formatting; monospaced font; all line breaks are retained -(the same as the AsciiDoc <a class="link" href="ch16.html#X65" title="16.3. Literal Blocks">LiteralBlock</a> element). -</dd><dt><span class="term"> -verse -</span></dt><dd> -All line breaks are retained (just like the AsciiDoc <a class="link" href="ch15.html#X94" title="15.3. quote and verse paragraph styles">verse paragraph style</a>). -</dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="X72"></a>23.7. Markup attributes</h2></div></div></div><p>AsciiDoc makes a number of attributes available to table markup -templates and tags. Column specific attributes are available when -substituting the <span class="emphasis"><em>colspec</em></span> cell data tags.</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"> -pageunits -</span></dt><dd> -DocBook backend only. Specifies table column absolute width units. -Defaults to <span class="emphasis"><em>*</em></span>. -</dd><dt><span class="term"> -pagewidth -</span></dt><dd> -DocBook backend only. The nominal output page width in <span class="emphasis"><em>pageunit</em></span> -units. Used to calculate CALS tables absolute column and table -widths. Defaults to <span class="emphasis"><em>425</em></span>. -</dd><dt><span class="term"> -tableabswidth -</span></dt><dd> -Integer value calculated from <span class="emphasis"><em>width</em></span> and <span class="emphasis"><em>pagewidth</em></span> attributes. -In <span class="emphasis"><em>pageunit</em></span> units. -</dd><dt><span class="term"> -tablepcwidth -</span></dt><dd> -Table width expressed as a percentage of the available width. Integer -value (0..100). -</dd><dt><span class="term"> -colabswidth -</span></dt><dd> -Integer value calculated from <span class="emphasis"><em>cols</em></span> column width, <span class="emphasis"><em>width</em></span> and -<span class="emphasis"><em>pagewidth</em></span> attributes. In <span class="emphasis"><em>pageunit</em></span> units. -</dd><dt><span class="term"> -colpcwidth -</span></dt><dd> -Column width expressed as a percentage of the table width. Integer -value (0..100). -</dd><dt><span class="term"> -colcount -</span></dt><dd> -Total number of table columns. -</dd><dt><span class="term"> -rowcount -</span></dt><dd> -Total number of table rows. -</dd><dt><span class="term"> -halign -</span></dt><dd> -Horizontal cell content alignment: <span class="emphasis"><em>left</em></span>, <span class="emphasis"><em>right</em></span> or <span class="emphasis"><em>center</em></span>. -</dd><dt><span class="term"> -valign -</span></dt><dd> -Vertical cell content alignment: <span class="emphasis"><em>top</em></span>, <span class="emphasis"><em>bottom</em></span> or <span class="emphasis"><em>middle</em></span>. -</dd><dt><span class="term"> -colnumber, colstart -</span></dt><dd> -The number of the leftmost column occupied by the cell (1…). -</dd><dt><span class="term"> -colend -</span></dt><dd> -The number of the rightmost column occupied by the cell (1…). -</dd><dt><span class="term"> -colspan -</span></dt><dd> -Number of columns the cell should span. -</dd><dt><span class="term"> -rowspan -</span></dt><dd> -Number of rows the cell should span (1…). -</dd><dt><span class="term"> -morerows -</span></dt><dd> -Number of additional rows the cell should span (0…). -</dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_nested_tables"></a>23.8. Nested tables</h2></div></div></div><p>An alternative <span class="emphasis"><em>psv</em></span> separator character <span class="emphasis"><em>!</em></span> can be used (instead of -<span class="emphasis"><em>|</em></span>) in nested tables. This allows a single level of table nesting. -Columns containing nested tables must use the <span class="emphasis"><em>asciidoc</em></span> style. An -example can be found in <code class="literal">./examples/website/newtables.txt</code>.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="X83"></a>23.9. DocBook table limitations</h2></div></div></div><p>Fully implementing tables is not trivial, some DocBook toolchains do -better than others. AsciiDoc HTML table outputs are rendered -correctly in all the popular browsers — if your DocBook generated -tables don’t look right compare them with the output generated by the -AsciiDoc <span class="emphasis"><em>xhtml11</em></span> backend or try a different DocBook toolchain. Here -is a list of things to be aware of:</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p class="simpara"> -Although nested tables are not legal in DocBook 4 the FOP and - dblatex toolchains will process them correctly. If you use <code class="literal">a2x(1)</code> - you will need to include the <code class="literal">--no-xmllint</code> option to suppress - DocBook validation errors. -</p><div class="note" style="margin-left: 0; margin-right: 10%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/icons/note.png" /></td><th align="left"></th></tr><tr><td align="left" valign="top"><p>In theory you can nest DocBook 4 tables one level using the -<span class="emphasis"><em>entrytbl</em></span> element, but not all toolchains process <span class="emphasis"><em>entrytbl</em></span>.</p></td></tr></table></div></li><li class="listitem"> -DocBook only allows a subset of block elements inside table cells so - not all AsciiDoc elements produce valid DocBook inside table cells. - If you get validation errors running <code class="literal">a2x(1)</code> try the <code class="literal">--no-xmllint</code> - option, toolchains will often process nested block elements such as - sidebar blocks and floating titles correctly even though, strictly - speaking, they are not legal. -</li><li class="listitem"> -Text formatting in cells using the <span class="emphasis"><em>monospaced</em></span> table style will - raise validation errors because the DocBook <span class="emphasis"><em>literal</em></span> element was - not designed to support formatted text (using the <span class="emphasis"><em>literal</em></span> element - is a kludge on the part of AsciiDoc as there is no easy way to set - the font style in DocBook. -</li><li class="listitem"> -Cell alignments are ignored for <span class="emphasis"><em>verse</em></span>, <span class="emphasis"><em>literal</em></span> or <span class="emphasis"><em>asciidoc</em></span> - table styles. -</li></ul></div></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch22.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch24.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/icons/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
\ No newline at end of file diff --git a/chunked/ch24.html b/chunked/ch24.html deleted file mode 100644 index 2ac16f7..0000000 --- a/chunked/ch24.html +++ /dev/null @@ -1,26 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Chapter 24. Manpage Documents</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="AsciiDoc User Guide" /><link rel="up" href="index.html" title="AsciiDoc User Guide" /><link rel="prev" href="ch23.html" title="Chapter 23. Tables" /><link rel="next" href="ch25.html" title="Chapter 25. Mathematical Formulas" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="ch23.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch25.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a id="X1"></a>Chapter 24. Manpage Documents</h1></div></div></div><p>Sooner or later, if you program in a UNIX environment, you’re going -to have to write a man page.</p><p>By observing a couple of additional conventions (detailed below) you -can write AsciiDoc files that will generate HTML and PDF man pages -plus the native manpage roff format. The easiest way to generate roff -manpages from AsciiDoc source is to use the a2x(1) command. The -following example generates a roff formatted manpage file called -<code class="literal">asciidoc.1</code> (a2x(1) uses asciidoc(1) to convert <code class="literal">asciidoc.1.txt</code> to -DocBook which it then converts to roff using DocBook XSL Stylesheets):</p><pre class="literallayout">a2x --doctype manpage --format manpage asciidoc.1.txt</pre><div class="sidebar"><div class="titlepage"><div><div><p class="title"><strong>Viewing and printing manpage files</strong></p></div></div></div><p>Use the <code class="literal">man(1)</code> command to view the manpage file:</p><pre class="literallayout">$ man -l asciidoc.1</pre><p>To print a high quality man page to a postscript printer:</p><pre class="literallayout">$ man -l -Tps asciidoc.1 | lpr</pre><p>You could also create a PDF version of the man page by converting -PostScript to PDF using <code class="literal">ps2pdf(1)</code>:</p><pre class="literallayout">$ man -l -Tps asciidoc.1 | ps2pdf - asciidoc.1.pdf</pre><p>The <code class="literal">ps2pdf(1)</code> command is included in the Ghostscript distribution.</p></div><p>To find out more about man pages view the <code class="literal">man(7)</code> manpage -(<code class="literal">man 7 man</code> and <code class="literal">man man-pages</code> commands).</p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_document_header"></a>24.1. Document Header</h2></div></div></div><p>A manpage document Header is mandatory. The title line contains the -man page name followed immediately by the manual section number in -brackets, for example <span class="emphasis"><em>ASCIIDOC(1)</em></span>. The title name should not contain -white space and the manual section number is a single digit optionally -followed by a single character.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_the_name_section"></a>24.2. The NAME Section</h2></div></div></div><p>The first manpage section is mandatory, must be titled <span class="emphasis"><em>NAME</em></span> and must -contain a single paragraph (usually a single line) consisting of a -list of one or more comma separated command name(s) separated from the -command purpose by a dash character. The dash must have at least one -white space character on either side. For example:</p><pre class="literallayout">printf, fprintf, sprintf - print formatted output</pre></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_the_synopsis_section"></a>24.3. The SYNOPSIS Section</h2></div></div></div><p>The second manpage section is mandatory and must be titled <span class="emphasis"><em>SYNOPSIS</em></span>.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_refmiscinfo_attributes"></a>24.4. refmiscinfo attributes</h2></div></div></div><p>In addition to the automatically created man page <a class="link" href="ch31.html" title="Chapter 31. Intrinsic Attributes">intrinsic attributes</a> you can assign DocBook -<a class="ulink" href="http://www.docbook.org/tdg5/en/html/refmiscinfo.html" target="_top">refmiscinfo</a> -element <span class="emphasis"><em>source</em></span>, <span class="emphasis"><em>version</em></span> and <span class="emphasis"><em>manual</em></span> values using AsciiDoc -<code class="literal">{mansource}</code>, <code class="literal">{manversion}</code> and <code class="literal">{manmanual}</code> attributes -respectively. This example is from the AsciiDoc header of a man page -source file:</p><pre class="literallayout">:man source: AsciiDoc -:man version: {revnumber} -:man manual: AsciiDoc Manual</pre></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch23.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch25.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/icons/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
\ No newline at end of file diff --git a/chunked/ch25.html b/chunked/ch25.html deleted file mode 100644 index fa26ce4..0000000 --- a/chunked/ch25.html +++ /dev/null @@ -1,43 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Chapter 25. Mathematical Formulas</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="AsciiDoc User Guide" /><link rel="up" href="index.html" title="AsciiDoc User Guide" /><link rel="prev" href="ch24.html" title="Chapter 24. Manpage Documents" /><link rel="next" href="ch26.html" title="Chapter 26. Configuration Files" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="ch24.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch26.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a id="X78"></a>Chapter 25. Mathematical Formulas</h1></div></div></div><p>The <span class="emphasis"><em>asciimath</em></span> and <span class="emphasis"><em>latexmath</em></span> <a class="link" href="ch16.html#X76" title="16.6. Passthrough Blocks">passthrough blocks</a> along with -the <span class="emphasis"><em>asciimath</em></span> and <span class="emphasis"><em>latexmath</em></span> <a class="link" href="ch21.html#X77" title="21.4. Passthrough macros">passthrough macros</a> provide a -(backend dependent) mechanism for rendering mathematical formulas. You -can use the following math markups:</p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_latex_math"></a>25.1. LaTeX Math</h2></div></div></div><p><a class="ulink" href="ftp://ftp.ams.org/pub/tex/doc/amsmath/short-math-guide.pdf" target="_top">LaTeX -math</a> can be included in documents that are processed by -<a class="link" href="ch05.html#X31">dblatex(1)</a>. Example inline formula:</p><pre class="literallayout">latexmath:[$C = \alpha + \beta Y^{\gamma} + \epsilon$]</pre><p>For more examples see the <a class="ulink" href="https://asciidoc.org/" target="_top">AsciiDoc website</a> or the -distributed <code class="literal">doc/latexmath.txt</code> file.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_mathjax"></a>25.2. MathJax</h2></div></div></div><p><a class="ulink" href="http://www.mathjax.org/" target="_top">MathJax</a> allows LaTeX Math style formulas to be included -in XHTML documents generated via the AsciiDoc <span class="emphasis"><em>xhtml11</em></span> and <span class="emphasis"><em>html5</em></span> backends. -This route overcomes several restrictions of the MathML-based approaches, -notably, restricted support of MathML by many mainstream browsers. To enable -<span class="emphasis"><em>MathJax</em></span> support you must define the <span class="emphasis"><em>mathjax</em></span> attribute, for example using the -<code class="literal">-a mathjax</code> command-line option. Equations are specified as explained above -using the <span class="emphasis"><em>latexmath</em></span> passthrough blocks. By default, rendering of equations -with <span class="emphasis"><em>MathJax</em></span> requires a working internet connection and will thus not work if -you are offline (but it can be configured differently).</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_latexmathml"></a>25.3. LaTeXMathML</h2></div></div></div><p><span class="emphasis"><em>LaTeXMathML</em></span> allows LaTeX Math style formulas to be included in XHTML -documents generated using the AsciiDoc <span class="emphasis"><em>xhtml11</em></span> and <span class="emphasis"><em>html5</em></span> backends. -AsciiDoc uses the -<a class="ulink" href="http://www.maths.nottingham.ac.uk/personal/drw/lm.html" target="_top">original -LaTeXMathML</a> by Douglas Woodall. <span class="emphasis"><em>LaTeXMathML</em></span> is derived from -ASCIIMathML and is for users who are more familiar with or prefer -using LaTeX math formulas (it recognizes a subset of LaTeX Math, the -differences are documented on the <span class="emphasis"><em>LaTeXMathML</em></span> web page). To enable -LaTeXMathML support you must define the <span class="emphasis"><em>latexmath</em></span> attribute, for -example using the <code class="literal">-a latexmath</code> command-line option. Example inline -formula:</p><pre class="literallayout">latexmath:[$\sum_{n=1}^\infty \frac{1}{2^n}$]</pre><p>For more examples see the <a class="ulink" href="https://asciidoc.org/" target="_top">AsciiDoc website</a> or the -distributed <code class="literal">doc/latexmathml.txt</code> file.</p><div class="note" style="margin-left: 0; margin-right: 10%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/icons/note.png" /></td><th align="left"></th></tr><tr><td align="left" valign="top"><p>The <span class="emphasis"><em>latexmath</em></span> macro used to include <span class="emphasis"><em>LaTeX Math</em></span> in DocBook -outputs is not the same as the <span class="emphasis"><em>latexmath</em></span> macro used to include -<span class="emphasis"><em>LaTeX MathML</em></span> in XHTML outputs. <span class="emphasis"><em>LaTeX Math</em></span> applies to DocBook -outputs that are processed by <a class="link" href="ch05.html#X31">dblatex</a> and is normally used to -generate PDF files. <span class="emphasis"><em>LaTeXMathML</em></span> is very much a subset of <span class="emphasis"><em>LaTeX -Math</em></span> and applies to XHTML documents. This remark does not -apply to <span class="emphasis"><em>MathJax</em></span> which does not use any of the <span class="emphasis"><em>latexmath</em></span> macros -(but only requires the <span class="emphasis"><em>latexmath</em></span> passthrough blocks for identification -of the equations).</p></td></tr></table></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_asciimathml"></a>25.4. ASCIIMathML</h2></div></div></div><p><a class="ulink" href="http://www1.chapman.edu/~jipsen/mathml/asciimath.html" target="_top">ASCIIMathML</a> -formulas can be included in XHTML documents generated using the -<span class="emphasis"><em>xhtml11</em></span> and <span class="emphasis"><em>html5</em></span> backends. To enable ASCIIMathML support you must -define the <span class="emphasis"><em>asciimath</em></span> attribute, for example using the <code class="literal">-a asciimath</code> -command-line option. Example inline formula:</p><pre class="literallayout">asciimath:[`x/x={(1,if x!=0),(text{undefined},if x=0):}`]</pre><p>For more examples see the <a class="ulink" href="https://asciidoc.org/" target="_top">AsciiDoc website</a> or the -distributed <code class="literal">doc/asciimathml.txt</code> file.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_mathml"></a>25.5. MathML</h2></div></div></div><p><a class="ulink" href="http://www.w3.org/Math/" target="_top">MathML</a> is a low level XML markup for -mathematics. AsciiDoc has no macros for MathML but users familiar with -this markup could use passthrough macros and passthrough blocks to -include MathML in output documents.</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch24.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch26.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/icons/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
\ No newline at end of file diff --git a/chunked/ch26.html b/chunked/ch26.html deleted file mode 100644 index 4f921d7..0000000 --- a/chunked/ch26.html +++ /dev/null @@ -1,374 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Chapter 26. Configuration Files</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="AsciiDoc User Guide" /><link rel="up" href="index.html" title="AsciiDoc User Guide" /><link rel="prev" href="ch25.html" title="Chapter 25. Mathematical Formulas" /><link rel="next" href="ch27.html" title="Chapter 27. Document Attributes" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="ch25.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch27.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a id="X7"></a>Chapter 26. Configuration Files</h1></div></div></div><p>AsciiDoc source file syntax and output file markup is largely -controlled by a set of cascading, text based, configuration files. At -runtime The AsciiDoc default configuration files are combined with -optional user and document specific configuration files.</p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_configuration_file_format"></a>26.1. Configuration File Format</h2></div></div></div><p>Configuration files contain named sections. Each section begins with a -section name in square brackets []. The section body consists of the -lines of text between adjacent section headings.</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -Section names consist of one or more alphanumeric, underscore or - dash characters and cannot begin or end with a dash. -</li><li class="listitem"> -Lines starting with a <span class="emphasis"><em>#</em></span> character are treated as comments and - ignored. -</li><li class="listitem"> -If the section name is prefixed with a <span class="emphasis"><em>+</em></span> character then the - section contents is appended to the contents of an already existing - same-named section. -</li><li class="listitem"> -Otherwise same-named sections and section entries override - previously loaded sections and section entries (this is sometimes - referred to as <span class="emphasis"><em>cascading</em></span>). Consequently, downstream configuration - files need only contain those sections and section entries that need - to be overridden. -</li></ul></div><div class="tip" style="margin-left: 0; margin-right: 10%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="images/icons/tip.png" /></td><th align="left"></th></tr><tr><td align="left" valign="top"><p>When creating custom configuration files you only need to include -the sections and entries that differ from the default configuration.</p></td></tr></table></div><div class="tip" style="margin-left: 0; margin-right: 10%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="images/icons/tip.png" /></td><th align="left"></th></tr><tr><td align="left" valign="top"><p>The best way to learn about configuration files is to read the -default configuration files in the AsciiDoc distribution in -conjunction with asciidoc(1) output files. You can view configuration -file load sequence by turning on the asciidoc(1) <code class="literal">-v</code> (<code class="literal">--verbose</code>) -command-line option.</p></td></tr></table></div><p>AsciiDoc reserves the following section names for specific purposes:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"> -miscellaneous -</span></dt><dd> - Configuration options that don’t belong anywhere else. -</dd><dt><span class="term"> -attributes -</span></dt><dd> - Attribute name/value entries. -</dd><dt><span class="term"> -specialcharacters -</span></dt><dd> - Special characters reserved by the backend markup. -</dd><dt><span class="term"> -tags -</span></dt><dd> - Backend markup tags. -</dd><dt><span class="term"> -quotes -</span></dt><dd> - Definitions for quoted inline character formatting. -</dd><dt><span class="term"> -specialwords -</span></dt><dd> - Lists of words and phrases singled out for special markup. -</dd><dt><span class="term"> -replacements, replacements2, replacements3 -</span></dt><dd> - Find and replace substitution definitions. -</dd><dt><span class="term"> -specialsections -</span></dt><dd> - Used to single out special section names for specific markup. -</dd><dt><span class="term"> -macros -</span></dt><dd> - Macro syntax definitions. -</dd><dt><span class="term"> -titles -</span></dt><dd> - Heading, section and block title definitions. -</dd><dt><span class="term"> -paradef-* -</span></dt><dd> - Paragraph element definitions. -</dd><dt><span class="term"> -blockdef-* -</span></dt><dd> - DelimitedBlock element definitions. -</dd><dt><span class="term"> -listdef-* -</span></dt><dd> - List element definitions. -</dd><dt><span class="term"> -listtags-* -</span></dt><dd> - List element tag definitions. -</dd><dt><span class="term"> -tabledef-* -</span></dt><dd> - Table element definitions. -</dd><dt><span class="term"> -tabletags-* -</span></dt><dd> - Table element tag definitions. -</dd></dl></div><p>Each line of text in these sections is a <span class="emphasis"><em>section entry</em></span>. Section -entries share the following syntax:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"> -name=value -</span></dt><dd> - The entry value is set to value. -</dd><dt><span class="term"> -name= -</span></dt><dd> - The entry value is set to a zero length string. -</dd><dt><span class="term"> -name! -</span></dt><dd> - The entry is undefined (deleted from the configuration). This - syntax only applies to <span class="emphasis"><em>attributes</em></span> and <span class="emphasis"><em>miscellaneous</em></span> - sections. -</dd></dl></div><div class="itemizedlist"><p class="title"><strong>Section entry behavior</strong></p><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -All equals characters inside the <code class="literal">name</code> must be escaped with a - backslash character. -</li><li class="listitem"> -<code class="literal">name</code> and <code class="literal">value</code> are stripped of leading and trailing white space. -</li><li class="listitem"> -Attribute names, tag entry names and markup template section names - consist of one or more alphanumeric, underscore or dash characters. - Names should not begin or end with a dash. -</li><li class="listitem"> -A blank configuration file section (one without any entries) deletes - any preceding section with the same name (applies to non-markup - template sections). -</li></ul></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_miscellaneous_section"></a>26.2. Miscellaneous section</h2></div></div></div><p>The optional <code class="literal">[miscellaneous]</code> section specifies the following -<code class="literal">name=value</code> options:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"> -newline -</span></dt><dd><p class="simpara"> - Output file line termination characters. Can include any - valid Python string escape sequences. The default value is - <code class="literal">\r\n</code> (carriage return, line feed). Should not be quoted or - contain explicit spaces (use <code class="literal">\x20</code> instead). For example: -</p><pre class="literallayout">$ asciidoc -a 'newline=\n' -b docbook mydoc.txt</pre></dd><dt><span class="term"> -outfilesuffix -</span></dt><dd> - The default extension for the output file, for example - <code class="literal">outfilesuffix=.html</code>. Defaults to backend name. -</dd><dt><span class="term"> -tabsize -</span></dt><dd> - The number of spaces to expand tab characters, for example - <code class="literal">tabsize=4</code>. Defaults to 8. A <span class="emphasis"><em>tabsize</em></span> of zero suppresses tab - expansion (useful when piping included files through block - filters). Included files can override this option using the - <span class="emphasis"><em>tabsize</em></span> attribute. -</dd><dt><span class="term"> -pagewidth, pageunits -</span></dt><dd> - These global table related options are documented in the - <a class="link" href="ch32.html#X4">Table Configuration File Definitions</a> sub-section. -</dd></dl></div><div class="note" style="margin-left: 0; margin-right: 10%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/icons/note.png" /></td><th align="left"></th></tr><tr><td align="left" valign="top"><p><code class="literal">[miscellaneous]</code> configuration file entries can be set using -the asciidoc(1) <code class="literal">-a</code> (<code class="literal">--attribute</code>) command-line option.</p></td></tr></table></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_titles_section"></a>26.3. Titles section</h2></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term"> -sectiontitle -</span></dt><dd> - Two line section title pattern. The entry value is a Python - regular expression containing the named group <span class="emphasis"><em>title</em></span>. -</dd><dt><span class="term"> -underlines -</span></dt><dd><p class="simpara"> - A comma separated list of document and section title underline - character pairs starting with the section level 0 and ending - with section level 4 underline. The default setting is: -</p><pre class="literallayout">underlines="==","--","~~","^^","++"</pre></dd><dt><span class="term"> -sect0…sect4 -</span></dt><dd> - One line section title patterns. The entry value is a Python - regular expression containing the named group <span class="emphasis"><em>title</em></span>. -</dd><dt><span class="term"> -blocktitle -</span></dt><dd> - <a class="link" href="ch12.html" title="Chapter 12. Block Titles">BlockTitle element</a> pattern. The entry value is a - Python regular expression containing the named group <span class="emphasis"><em>title</em></span>. -</dd><dt><span class="term"> -subs -</span></dt><dd> - A comma separated list of substitutions that are performed on - the document header and section titles. Defaults to <span class="emphasis"><em>normal</em></span> - substitution. -</dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_tags_section"></a>26.4. Tags section</h2></div></div></div><p>The <code class="literal">[tags]</code> section contains backend tag definitions (one per -line). Tags are used to translate AsciiDoc elements to backend -markup.</p><p>An AsciiDoc tag definition is formatted like -<code class="literal"><tagname>=<starttag>|<endtag></code>. For example:</p><pre class="literallayout">emphasis=<em>|</em></pre><p>In this example asciidoc(1) replaces the | character with the -emphasized text from the AsciiDoc input file and writes the result to -the output file.</p><p>Use the <code class="literal">{brvbar}</code> attribute reference if you need to include a | pipe -character inside tag text.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_attributes_section"></a>26.5. Attributes section</h2></div></div></div><p>The optional <code class="literal">[attributes]</code> section contains predefined attributes.</p><p>If the attribute value requires leading or trailing spaces then the -text text should be enclosed in quotation mark (") characters.</p><p>To delete a attribute insert a <code class="literal">name!</code> entry in a downstream -configuration file or use the asciidoc(1) <code class="literal">--attribute name!</code> -command-line option (an attribute name suffixed with a <code class="literal">!</code> character -deletes the attribute)</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_special_characters_section"></a>26.6. Special Characters section</h2></div></div></div><p>The <code class="literal">[specialcharacters]</code> section specifies how to escape characters -reserved by the backend markup. Each translation is specified on a -single line formatted like:</p><pre class="literallayout"><special_character>=<translated_characters></pre><p>Special characters are normally confined to those that resolve -markup ambiguity (in the case of HTML and XML markups the ampersand, -less than and greater than characters). The following example causes -all occurrences of the <code class="literal"><</code> character to be replaced by <code class="literal">&lt;</code>.</p><pre class="literallayout"><=&lt;</pre></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_quoted_text_section"></a>26.7. Quoted Text section</h2></div></div></div><p>Quoting is used primarily for text formatting. The <code class="literal">[quotes]</code> section -defines AsciiDoc quoting characters and their corresponding backend -markup tags. Each section entry value is the name of a of a <code class="literal">[tags]</code> -section entry. The entry name is the character (or characters) that -quote the text. The following examples are taken from AsciiDoc -configuration files:</p><pre class="literallayout">[quotes] -_=emphasis</pre><pre class="literallayout">[tags] -emphasis=<em>|</em></pre><p>You can specify the left and right quote strings separately by -separating them with a | character, for example:</p><pre class="literallayout">``|''=quoted</pre><p>Omitting the tag will disable quoting, for example, if you don’t want -superscripts or subscripts put the following in a custom configuration -file or edit the global <code class="literal">asciidoc.conf</code> configuration file:</p><pre class="literallayout">[quotes] -^= -~=</pre><p><a class="link" href="ch10.html#X52" title="10.1.2. Constrained and Unconstrained Quotes">Unconstrained quotes</a> are differentiated from constrained -quotes by prefixing the tag name with a hash character, for example:</p><pre class="literallayout">__=#emphasis</pre><div class="itemizedlist"><p class="title"><strong>Quoted text behavior</strong></p><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -Quote characters must be non-alphanumeric. -</li><li class="listitem"> -To minimize quoting ambiguity try not to use the same quote - characters in different quote types. -</li></ul></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_special_words_section"></a>26.8. Special Words section</h2></div></div></div><p>The <code class="literal">[specialwords]</code> section is used to single out words and phrases -that you want to consistently format in some way throughout your -document without having to repeatedly specify the markup. The name of -each entry corresponds to a markup template section and the entry -value consists of a list of words and phrases to be marked up. For -example:</p><pre class="literallayout">[specialwords] -strongwords=NOTE IMPORTANT</pre><pre class="literallayout">[strongwords] -<strong>{words}</strong></pre><p>The examples specifies that any occurrence of <code class="literal">NOTE</code> or <code class="literal">IMPORTANT</code> -should appear in a bold font.</p><p>Words and word phrases are treated as Python regular expressions: for -example, the word <code class="literal">^NOTE</code> would only match <code class="literal">NOTE</code> if appeared at -the start of a line.</p><p>AsciiDoc comes with three built-in Special Word types: -<span class="emphasis"><em>emphasizedwords</em></span>, <span class="emphasis"><em>monospacedwords</em></span> and <span class="emphasis"><em>strongwords</em></span>, each has a -corresponding (backend specific) markup template section. Edit the -configuration files to customize existing Special Words and to add new -ones.</p><div class="itemizedlist"><p class="title"><strong>Special word behavior</strong></p><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -Word list entries must be separated by space characters. -</li><li class="listitem"> -Word list entries with embedded spaces should be enclosed in quotation (") - characters. -</li><li class="listitem"> -A <code class="literal">[specialwords]</code> section entry of the form - <code class="literal">name=word1 [word2…]</code> adds words to existing <code class="literal">name</code> entries. -</li><li class="listitem"> -A <code class="literal">[specialwords]</code> section entry of the form <code class="literal">name</code> undefines - (deletes) all existing <code class="literal">name</code> words. -</li><li class="listitem"> -Since word list entries are processed as Python regular expressions - you need to be careful to escape regular expression special - characters. -</li><li class="listitem"> -By default Special Words are substituted before Inline Macros, this - may lead to undesirable consequences. For example the special word - <code class="literal">foobar</code> would be expanded inside the macro call - <code class="literal">http://www.foobar.com[]</code>. A possible solution is to emphasize - whole words only by defining the word using regular expression - characters, for example <code class="literal">\bfoobar\b</code>. -</li><li class="listitem"> -If the first matched character of a special word is a backslash then - the remaining characters are output without markup i.e. the - backslash can be used to escape special word markup. For example - the special word <code class="literal">\\?\b[Tt]en\b</code> will mark up the words <code class="literal">Ten</code> and - <code class="literal">ten</code> only if they are not preceded by a backslash. -</li></ul></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="X10"></a>26.9. Replacements section</h2></div></div></div><p><code class="literal">[replacements]</code>, <code class="literal">[replacements2]</code> and <code class="literal">[replacements3]</code> -configuration file entries specify find and replace text and are -formatted like:</p><pre class="literallayout"><find_pattern>=<replacement_text></pre><p>The find text can be a Python regular expression; the replace text can -contain Python regular expression group references.</p><p>Use Replacement shortcuts for often used macro references, for -example (the second replacement allows us to backslash escape the -macro name):</p><pre class="literallayout">NEW!=image:./images/smallnew.png[New!] -\\NEW!=NEW!</pre><p>The only difference between the three replacement types is how they -are applied. By default <span class="emphasis"><em>replacements</em></span> and <span class="emphasis"><em>replacements2</em></span> are applied -in <a class="link" href="ch32.html#X102">normal</a> substitution contexts whereas <span class="emphasis"><em>replacements3</em></span> needs -to be configured explicitly and should only be used in backend -configuration files.</p><div class="itemizedlist"><p class="title"><strong>Replacement behavior</strong></p><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -The built-in replacements can be escaped with a backslash. -</li><li class="listitem"> -If the find or replace text has leading or trailing spaces then the - text should be enclosed in quotation (") characters. -</li><li class="listitem"> -Since the find text is processed as a regular expression you need to - be careful to escape regular expression special characters. -</li><li class="listitem"> -Replacements are performed in the same order they appear in the - configuration file replacements section. -</li></ul></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_markup_template_sections"></a>26.10. Markup Template Sections</h2></div></div></div><p>Markup template sections supply backend markup for translating -AsciiDoc elements. Since the text is normally backend dependent -you’ll find these sections in the backend specific configuration -files. Template sections differ from other sections in that they -contain a single block of text instead of per line <span class="emphasis"><em>name=value</em></span> -entries. A markup template section body can contain:</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -Attribute references -</li><li class="listitem"> -System macro calls. -</li><li class="listitem"> -A document content placeholder -</li></ul></div><p>The document content placeholder is a single | character and is -replaced by text from the source element. Use the <code class="literal">{brvbar}</code> -attribute reference if you need a literal | character in the template.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="X27"></a>26.11. Configuration file names, precedence and locations</h2></div></div></div><p>Configuration files have a <code class="literal">.conf</code> file name extension; they are -loaded from the following locations:</p><div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -The directory containing the asciidoc executable. -</li><li class="listitem"> -If there is no <code class="literal">asciidoc.conf</code> file in the directory containing the - asciidoc executable then load from the global configuration - directory (normally <code class="literal">/etc/asciidoc</code> or <code class="literal">/usr/local/etc/asciidoc</code>) - i.e. the global configuration files directory is skipped if - AsciiDoc configuration files are installed in the same directory as - the asciidoc executable. This allows both a system wide copy and - multiple local copies of AsciiDoc to coexist on the same host PC. -</li><li class="listitem"> -The user’s <code class="literal">$HOME/.asciidoc</code> directory (if it exists). -</li><li class="listitem"> -The directory containing the AsciiDoc source file. -</li><li class="listitem"><p class="simpara"> -Explicit configuration files specified using: -</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -The <code class="literal">conf-files</code> attribute (one or more file names separated by a - <code class="literal">|</code> character). These files are loaded in the order they are - specified and prior to files specified using the <code class="literal">--conf-file</code> - command-line option. -</li><li class="listitem"> -The asciidoc(1) <code class="literal">--conf-file</code>) command-line option. The - <code class="literal">--conf-file</code> option can be specified multiple times, in which - case configuration files will be processed in the same order they - appear on the command-line. -</li></ul></div></li><li class="listitem"> -<a class="link" href="ch04.html#X100" title="4.2. Backend Plugins">Backend plugin</a> configuration files are loaded from - subdirectories named like <code class="literal">backends/<backend></code> in locations 1, 2 - and 3. -</li><li class="listitem"> -<a class="link" href="ch33.html" title="Chapter 33. Filters">Filter</a> configuration files are loaded from subdirectories - named like <code class="literal">filters/<filter></code> in locations 1, 2 and 3. -</li></ol></div><p>Configuration files from the above locations are loaded in the -following order:</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p class="simpara"> -The <code class="literal">[attributes]</code> section only from: -</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; "><li class="listitem"> -<code class="literal">asciidoc.conf</code> in location 3 -</li><li class="listitem"><p class="simpara"> -Files from location 5. -</p><p class="simpara">This first pass makes locally set attributes available in the global -<code class="literal">asciidoc.conf</code> file.</p></li></ul></div></li><li class="listitem"> -<code class="literal">asciidoc.conf</code> from locations 1, 2, 3. -</li><li class="listitem"> -<span class="emphasis"><em>attributes</em></span>, <span class="emphasis"><em>titles</em></span> and <span class="emphasis"><em>specialcharacters</em></span> sections from the - <code class="literal">asciidoc.conf</code> in location 4. -</li><li class="listitem"> -The document header is parsed at this point and we can assume the - <span class="emphasis"><em>backend</em></span> and <span class="emphasis"><em>doctype</em></span> have now been defined. -</li><li class="listitem"> -Backend plugin <code class="literal"><backend>.conf</code> and <code class="literal"><backend>-<doctype>.conf</code> files - from locations 6. If a backend plugin is not found then try - locations 1, 2 and 3 for <code class="literal"><backend>.conf</code> and - <code class="literal"><backend>-<doctype>.conf</code> backend configuration files. -</li><li class="listitem"> -Filter conf files from locations 7. -</li><li class="listitem"> -<code class="literal">lang-<lang>.conf</code> from locations 1, 2, 3. -</li><li class="listitem"> -<code class="literal">asciidoc.conf</code> from location 4. -</li><li class="listitem"> -<code class="literal"><backend>.conf</code> and <code class="literal"><backend>-<doctype>.conf</code> from location 4. -</li><li class="listitem"> -Filter conf files from location 4. -</li><li class="listitem"> -<code class="literal"><docfile>.conf</code> and <code class="literal"><docfile>-<backend>.conf</code> from location 4. -</li><li class="listitem"> -Configuration files from location 5. -</li></ul></div><p>Where:</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -<code class="literal"><backend></code> and <code class="literal"><doctype></code> are values specified by the asciidoc(1) - <code class="literal">-b</code> (<code class="literal">--backend</code>) and <code class="literal">-d</code> (<code class="literal">--doctype</code>) command-line options. -</li><li class="listitem"> -<code class="literal"><infile></code> is the path name of the AsciiDoc input file without the - file name extension. -</li><li class="listitem"> -<code class="literal"><lang></code> is a two letter country code set by the the AsciiDoc <span class="emphasis"><em>lang</em></span> - attribute. -</li></ul></div><div class="note" style="margin-left: 0; margin-right: 10%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/icons/note.png" /></td><th align="left"></th></tr><tr><td align="left" valign="top"><p>The backend and language global configuration files are loaded <span class="strong"><strong>after</strong></span> -the header has been parsed. This means that you can set most -attributes in the document header. Here’s an example header:</p><pre class="literallayout">Life's Mysteries -================ -:author: Hu Nose -:doctype: book -:toc: -:icons: -:data-uri: -:lang: en -:encoding: iso-8859-1</pre><p>Attributes set in the document header take precedence over -configuration file attributes.</p></td></tr></table></div><div class="tip" style="margin-left: 0; margin-right: 10%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="images/icons/tip.png" /></td><th align="left"></th></tr><tr><td align="left" valign="top"><p>Use the asciidoc(1) <code class="literal">-v</code> (<code class="literal">--verbose</code>) command-line option to see -which configuration files are loaded and the order in which they are -loaded.</p></td></tr></table></div></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch25.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch27.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/icons/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
\ No newline at end of file diff --git a/chunked/ch27.html b/chunked/ch27.html deleted file mode 100644 index 27c1ca3..0000000 --- a/chunked/ch27.html +++ /dev/null @@ -1,20 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Chapter 27. Document Attributes</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="AsciiDoc User Guide" /><link rel="up" href="index.html" title="AsciiDoc User Guide" /><link rel="prev" href="ch26.html" title="Chapter 26. Configuration Files" /><link rel="next" href="ch28.html" title="Chapter 28. Attribute Entries" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="ch26.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch28.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a id="_document_attributes"></a>Chapter 27. Document Attributes</h1></div></div></div><p>A document attribute is comprised of a <span class="emphasis"><em>name</em></span> and a textual <span class="emphasis"><em>value</em></span> -and is used for textual substitution in AsciiDoc documents and -configuration files. An attribute reference (an attribute name -enclosed in braces) is replaced by the corresponding attribute -value. Attribute names are case insensitive and can only contain -alphanumeric, dash and underscore characters.</p><p>There are four sources of document attributes (from highest to lowest -precedence):</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -Command-line attributes. -</li><li class="listitem"> -AttributeEntry, AttributeList, Macro and BlockId elements. -</li><li class="listitem"> -Configuration file <code class="literal">[attributes]</code> sections. -</li><li class="listitem"> -Intrinsic attributes. -</li></ul></div><p>Within each of these divisions the last processed entry takes -precedence.</p><div class="note" style="margin-left: 0; margin-right: 10%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/icons/note.png" /></td><th align="left"></th></tr><tr><td align="left" valign="top"><p>If an attribute is not defined then the line containing the -attribute reference is dropped. This property is used extensively in -AsciiDoc configuration files to facilitate conditional markup -generation.</p></td></tr></table></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch26.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch28.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/icons/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
\ No newline at end of file diff --git a/chunked/ch28.html b/chunked/ch28.html deleted file mode 100644 index e206035..0000000 --- a/chunked/ch28.html +++ /dev/null @@ -1,80 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Chapter 28. Attribute Entries</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="AsciiDoc User Guide" /><link rel="up" href="index.html" title="AsciiDoc User Guide" /><link rel="prev" href="ch27.html" title="Chapter 27. Document Attributes" /><link rel="next" href="ch29.html" title="Chapter 29. Attribute Lists" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="ch27.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch29.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a id="X18"></a>Chapter 28. Attribute Entries</h1></div></div></div><p>The <code class="literal">AttributeEntry</code> block element allows document attributes to be -assigned within an AsciiDoc document. Attribute entries are added to -the global document attributes dictionary. The attribute name/value -syntax is a single line like:</p><pre class="literallayout">:<name>: <value></pre><p>For example:</p><pre class="literallayout">:Author Initials: JB</pre><p>This will set an attribute reference <code class="literal">{authorinitials}</code> to the value -<span class="emphasis"><em>JB</em></span> in the current document.</p><p>To delete (undefine) an attribute use the following syntax:</p><pre class="literallayout">:<name>!:</pre><div class="itemizedlist"><p class="title"><strong>AttributeEntry behavior</strong></p><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -The attribute entry line begins with colon — no white space allowed - in left margin. -</li><li class="listitem"> -AsciiDoc converts the <code class="literal"><name></code> to a legal attribute name (lower - case, alphanumeric, dash and underscore characters only — all other - characters deleted). This allows more human friendly text to be - used. -</li><li class="listitem"> -Leading and trailing white space is stripped from the <code class="literal"><value></code>. -</li><li class="listitem"><p class="simpara"> -Lines ending in a space followed by a plus character are continued - to the next line, for example: -</p><pre class="literallayout">:description: AsciiDoc is a text document format for writing notes, + - documentation, articles, books, slideshows, web pages + - and man pages.</pre></li><li class="listitem"> -If the <code class="literal"><value></code> is blank then the corresponding attribute value is - set to an empty string. -</li><li class="listitem"> -Attribute references contained in the entry <code class="literal"><value></code> will be - expanded. -</li><li class="listitem"> -By default AttributeEntry values are substituted for - <code class="literal">specialcharacters</code> and <code class="literal">attributes</code> (see above), if you want to - change or disable AttributeEntry substitution use the <a class="link" href="ch21.html#X77" title="21.4. Passthrough macros">pass:[] inline macro</a> syntax. -</li><li class="listitem"> -Attribute entries in the document Header are available for header - markup template substitution. -</li><li class="listitem"> -Attribute elements override configuration file and intrinsic - attributes but do not override command-line attributes. -</li></ul></div><p>Here are some more attribute entry examples:</p><pre class="screen">AsciiDoc User Manual -==================== -:author: Stuart Rackham -:email: srackham@gmail.com -:revdate: April 23, 2004 -:revnumber: 5.1.1</pre><p>Which creates these attributes:</p><pre class="literallayout">{author}, {firstname}, {lastname}, {authorinitials}, {email}, -{revdate}, {revnumber}</pre><p>The previous example is equivalent to this <a class="link" href="ch08.html#X95" title="8.2. Header">document header</a>:</p><pre class="screen">AsciiDoc User Manual -==================== -Stuart Rackham <srackham@gmail.com> -5.1.1, April 23, 2004</pre><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_setting_configuration_entries"></a>28.1. Setting configuration entries</h2></div></div></div><p>A variant of the Attribute Entry syntax allows configuration file -section entries and markup template sections to be set from within an -AsciiDoc document:</p><pre class="literallayout">:<section_name>.[<entry_name>]: <entry_value></pre><p>Where <code class="literal"><section_name></code> is the configuration section name, -<code class="literal"><entry_name></code> is the name of the entry and <code class="literal"><entry_value></code> is the -optional entry value. This example sets the default labeled list -style to <span class="emphasis"><em>horizontal</em></span>:</p><pre class="literallayout">:listdef-labeled.style: horizontal</pre><p>It is exactly equivalent to a configuration file containing:</p><pre class="literallayout">[listdef-labeled] -style=horizontal</pre><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p class="simpara"> -If the <code class="literal"><entry_name></code> is omitted then the entire section is - substituted with the <code class="literal"><entry_value></code>. This feature should only be - used to set markup template sections. The following example sets the - <span class="emphasis"><em>xref2</em></span> inline macro markup template: -</p><pre class="literallayout">:xref2-inlinemacro.: <a href="#{1}">{2?{2}}</a></pre></li><li class="listitem"> -No substitution is performed on configuration file attribute entries - and they cannot be undefined. -</li><li class="listitem"> -This feature can only be used in attribute entries — configuration - attributes cannot be set using the asciidoc(1) command <code class="literal">--attribute</code> - option. -</li></ul></div><div class="sidebar"><a id="X62"></a><div class="titlepage"><div><div><p class="title"><strong>Attribute entries promote clarity and eliminate repetition</strong></p></div></div></div><p>URLs and file names in AsciiDoc macros are often quite long — they -break paragraph flow and readability suffers. The problem is -compounded by redundancy if the same name is used repeatedly. -Attribute entries can be used to make your documents easier to read -and write, here are some examples:</p><pre class="literallayout">:1: http://freshmeat.net/projects/asciidoc/ -:homepage: http://asciidoc.org[AsciiDoc home page] -:new: image:./images/smallnew.png[] -:footnote1: footnote:[A meaningless latin term]</pre><pre class="literallayout">Using previously defined attributes: See the {1}[Freshmeat summary] -or the {homepage} for something new {new}. Lorem ispum {footnote1}.</pre><div class="itemizedlist"><p class="title"><strong>Note</strong></p><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -The attribute entry definition must precede it’s usage. -</li><li class="listitem"> -You are not limited to URLs or file names, entire macro calls or - arbitrary lines of text can be abbreviated. -</li><li class="listitem"> -Shared attributes entries could be grouped into a separate file and - <a class="link" href="ch21.html#X63" title="21.3.1. Include Macros">included</a> in multiple documents. -</li></ul></div></div></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch27.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch29.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/icons/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
\ No newline at end of file diff --git a/chunked/ch29.html b/chunked/ch29.html deleted file mode 100644 index fea006c..0000000 --- a/chunked/ch29.html +++ /dev/null @@ -1,59 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Chapter 29. Attribute Lists</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="AsciiDoc User Guide" /><link rel="up" href="index.html" title="AsciiDoc User Guide" /><link rel="prev" href="ch28.html" title="Chapter 28. Attribute Entries" /><link rel="next" href="ch30.html" title="Chapter 30. Attribute References" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="ch28.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch30.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a id="X21"></a>Chapter 29. Attribute Lists</h1></div></div></div><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -An attribute list is a comma separated list of attribute values. -</li><li class="listitem"> -The entire list is enclosed in square brackets. -</li><li class="listitem"> -Attribute lists are used to pass parameters to macros, blocks (using - the <a class="link" href="ch14.html" title="Chapter 14. AttributeList Element">AttributeList element</a>) and inline quotes. -</li></ul></div><p>The list consists of zero or more positional attribute values followed -by zero or more named attribute values. Here are three examples: a -single unquoted positional attribute; three unquoted positional -attribute values; one positional attribute followed by two named -attributes; the unquoted attribute value in the final example contains -comma (<code class="literal">&#44;</code>) and double-quote (<code class="literal">&#34;</code>) character entities:</p><pre class="literallayout">[Hello] -[quote, Bertrand Russell, The World of Mathematics (1956)] -["22 times", backcolor="#0e0e0e", options="noborders,wide"] -[A footnote&#44; &#34;with an image&#34; image:smallnew.png[]]</pre><div class="itemizedlist"><p class="title"><strong>Attribute list behavior</strong></p><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -If one or more attribute values contains a comma the all string - values must be quoted (enclosed in double quotation mark - characters). -</li><li class="listitem"> -If the list contains any named or quoted attributes then all string - attribute values must be quoted. -</li><li class="listitem"> -To include a double quotation mark (") character in a quoted - attribute value the the quotation mark must be escaped with a - backslash. -</li><li class="listitem"> -List attributes take precedence over existing attributes. -</li><li class="listitem"> -List attributes can only be referenced in configuration file markup - templates and tags, they are not available elsewhere in the - document. -</li><li class="listitem"> -Setting a named attribute to <code class="literal">None</code> undefines the attribute. -</li><li class="listitem"> -Positional attributes are referred to as <code class="literal">{1}</code>,<code class="literal">{2}</code>,<code class="literal">{3}</code>,… -</li><li class="listitem"> -Attribute <code class="literal">{0}</code> refers to the entire list (excluding the enclosing - square brackets). -</li><li class="listitem"> -Named attribute names cannot contain dash characters. -</li></ul></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="X75"></a>29.1. Options attribute</h2></div></div></div><p>If the attribute list contains an attribute named <code class="literal">options</code> it is -processed as a comma separated list of option names:</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -Each name generates an attribute named like <code class="literal"><option>-option</code> (where - <code class="literal"><option></code> is the option name) with an empty string value. For - example <code class="literal">[options="opt1,opt2,opt3"]</code> is equivalent to setting the - following three attributes - <code class="literal">[opt1-option="",opt2-option="",opt2-option=""]</code>. -</li><li class="listitem"> -If you define a an option attribute globally (for example with an - <a class="link" href="ch28.html" title="Chapter 28. Attribute Entries">attribute entry</a>) then it will apply to all elements in the - document. -</li><li class="listitem"> -AsciiDoc implements a number of predefined options which are listed - in the <a class="link" href="apf.html" title="Appendix F. Attribute Options">Attribute Options appendix</a>. -</li></ul></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_macro_attribute_lists"></a>29.2. Macro Attribute lists</h2></div></div></div><p>Macros calls are suffixed with an attribute list. The list may be -empty but it cannot be omitted. List entries are used to pass -attribute values to macro markup templates.</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch28.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch30.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/icons/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
\ No newline at end of file diff --git a/chunked/ch30.html b/chunked/ch30.html deleted file mode 100644 index 767e019..0000000 --- a/chunked/ch30.html +++ /dev/null @@ -1,216 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Chapter 30. Attribute References</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="AsciiDoc User Guide" /><link rel="up" href="index.html" title="AsciiDoc User Guide" /><link rel="prev" href="ch29.html" title="Chapter 29. Attribute Lists" /><link rel="next" href="ch31.html" title="Chapter 31. Intrinsic Attributes" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="ch29.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch31.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a id="_attribute_references"></a>Chapter 30. Attribute References</h1></div></div></div><p>An attribute reference is an attribute name (possibly followed by an -additional parameters) enclosed in curly braces. When an attribute -reference is encountered it is evaluated and replaced by its -corresponding text value. If the attribute is undefined the line -containing the attribute is dropped.</p><p>There are three types of attribute reference: <span class="emphasis"><em>Simple</em></span>, <span class="emphasis"><em>Conditional</em></span> -and <span class="emphasis"><em>System</em></span>.</p><div class="itemizedlist"><p class="title"><strong>Attribute reference evaluation</strong></p><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -You can suppress attribute reference expansion by placing a - backslash character immediately in front of the opening brace - character. -</li><li class="listitem"> -By default attribute references are not expanded in - <span class="emphasis"><em>LiteralParagraphs</em></span>, <span class="emphasis"><em>ListingBlocks</em></span> or <span class="emphasis"><em>LiteralBlocks</em></span>. -</li><li class="listitem"> -Attribute substitution proceeds line by line in reverse line order. -</li><li class="listitem"> -Attribute reference evaluation is performed in the following order: - <span class="emphasis"><em>Simple</em></span> then <span class="emphasis"><em>Conditional</em></span> and finally <span class="emphasis"><em>System</em></span>. -</li></ul></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_simple_attributes_references"></a>30.1. Simple Attributes References</h2></div></div></div><p>Simple attribute references take the form <code class="literal">{<name>}</code>. If the -attribute name is defined its text value is substituted otherwise the -line containing the reference is dropped from the output.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_conditional_attribute_references"></a>30.2. Conditional Attribute References</h2></div></div></div><p>Additional parameters are used in conjunction with attribute names to -calculate a substitution value. Conditional attribute references take -the following forms:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"> -<code class="literal">{<names>=<value>}</code> -</span></dt><dd> - <code class="literal"><value></code> is substituted if the attribute <code class="literal"><names></code> is - undefined otherwise its value is substituted. <code class="literal"><value></code> can - contain simple attribute references. -</dd><dt><span class="term"> -<code class="literal">{<names>?<value>}</code> -</span></dt><dd> - <code class="literal"><value></code> is substituted if the attribute <code class="literal"><names></code> is defined - otherwise an empty string is substituted. <code class="literal"><value></code> can - contain simple attribute references. -</dd><dt><span class="term"> -<code class="literal">{<names>!<value>}</code> -</span></dt><dd> - <code class="literal"><value></code> is substituted if the attribute <code class="literal"><names></code> is - undefined otherwise an empty string is substituted. <code class="literal"><value></code> - can contain simple attribute references. -</dd><dt><span class="term"> -<code class="literal">{<names>#<value>}</code> -</span></dt><dd> - <code class="literal"><value></code> is substituted if the attribute <code class="literal"><names></code> is defined - otherwise the undefined attribute entry causes the containing - line to be dropped. <code class="literal"><value></code> can contain simple attribute - references. -</dd><dt><span class="term"> -<code class="literal">{<names>%<value>}</code> -</span></dt><dd> - <code class="literal"><value></code> is substituted if the attribute <code class="literal"><names></code> is not - defined otherwise the containing line is dropped. <code class="literal"><value></code> - can contain simple attribute references. -</dd><dt><span class="term"> -<code class="literal">{<names>@<regexp>:<value1>[:<value2>]}</code> -</span></dt><dd> - <code class="literal"><value1></code> is substituted if the value of attribute <code class="literal"><names></code> - matches the regular expression <code class="literal"><regexp></code> otherwise <code class="literal"><value2></code> - is substituted. If attribute <code class="literal"><names></code> is not defined the - containing line is dropped. If <code class="literal"><value2></code> is omitted an empty - string is assumed. The values and the regular expression can - contain simple attribute references. To embed colons in the - values or the regular expression escape them with backslashes. -</dd><dt><span class="term"> -<code class="literal">{<names>$<regexp>:<value1>[:<value2>]}</code> -</span></dt><dd><p class="simpara"> - Same behavior as the previous ternary attribute except for - the following cases: -</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"> -<code class="literal">{<names>$<regexp>:<value>}</code> -</span></dt><dd> - Substitutes <code class="literal"><value></code> if <code class="literal"><names></code> matches <code class="literal"><regexp></code> - otherwise the result is undefined and the containing - line is dropped. -</dd><dt><span class="term"> -<code class="literal">{<names>$<regexp>::<value>}</code> -</span></dt><dd> - Substitutes <code class="literal"><value></code> if <code class="literal"><names></code> does not match - <code class="literal"><regexp></code> otherwise the result is undefined and the - containing line is dropped. -</dd></dl></div></dd></dl></div><p>The attribute <code class="literal"><names></code> parameter normally consists of a single -attribute name but it can be any one of the following:</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -A single attribute name which evaluates to the attributes value. -</li><li class="listitem"> -Multiple <span class="emphasis"><em>,</em></span> separated attribute names which evaluates to an empty - string if one or more of the attributes is defined, otherwise it’s - value is undefined. -</li><li class="listitem"> -Multiple <span class="emphasis"><em>+</em></span> separated attribute names which evaluates to an empty - string if all of the attributes are defined, otherwise it’s value is - undefined. -</li></ul></div><p>Conditional attributes with single attribute names are evaluated first -so they can be used inside the multi-attribute conditional <code class="literal"><value></code>.</p><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_conditional_attribute_examples"></a>30.2.1. Conditional attribute examples</h3></div></div></div><p>Conditional attributes are mainly used in AsciiDoc configuration -files — see the distribution <code class="literal">.conf</code> files for examples.</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"> -Attribute equality test -</span></dt><dd><p class="simpara"> - If <code class="literal">{backend}</code> is <span class="emphasis"><em>docbook45</em></span> or <span class="emphasis"><em>xhtml11</em></span> the example evaluates to - “DocBook 4.5 or XHTML 1.1 backend” otherwise it evaluates to - “some other backend”: -</p><pre class="literallayout">{backend@docbook45|xhtml11:DocBook 4.5 or XHTML 1.1 backend:some other backend}</pre></dd><dt><span class="term"> -Attribute value map -</span></dt><dd><p class="simpara"> - This example maps the <code class="literal">frame</code> attribute values [<code class="literal">topbot</code>, <code class="literal">all</code>, - <code class="literal">none</code>, <code class="literal">sides</code>] to [<code class="literal">hsides</code>, <code class="literal">border</code>, <code class="literal">void</code>, <code class="literal">vsides</code>]: -</p><pre class="literallayout">{frame@topbot:hsides}{frame@all:border}{frame@none:void}{frame@sides:vsides}</pre></dd></dl></div></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="X24"></a>30.3. System Attribute References</h2></div></div></div><p>System attribute references generate the attribute text value by -executing a predefined action that is parametrized by one or more -arguments. The syntax is <code class="literal">{<action>:<arguments>}</code>.</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"> -<code class="literal">{counter:<attrname>[:<seed>]}</code> -</span></dt><dd><p class="simpara"> - Increments the document attribute (if the attribute is - undefined it is set to <code class="literal">1</code>). Returns the new attribute value. -</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -Counters generate global (document wide) attributes. -</li><li class="listitem"> -The optional <code class="literal"><seed></code> specifies the counter’s initial value; - it can be a number or a single letter; defaults to <span class="emphasis"><em>1</em></span>. -</li><li class="listitem"> -<code class="literal"><seed></code> can contain simple and conditional attribute - references. -</li><li class="listitem"> -The <span class="emphasis"><em>counter</em></span> system attribute will not be executed if the - containing line is dropped by the prior evaluation of an - undefined attribute. -</li></ul></div></dd><dt><span class="term"> -<code class="literal">{counter2:<attrname>[:<seed>]}</code> -</span></dt><dd> - Same as <code class="literal">counter</code> except the it always returns a blank string. -</dd><dt><span class="term"> -<code class="literal">{eval:<expression>}</code> -</span></dt><dd><p class="simpara"> - Substitutes the result of the Python <code class="literal"><expression></code>. -</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -If <code class="literal"><expression></code> evaluates to <code class="literal">None</code> or <code class="literal">False</code> the - reference is deemed undefined and the line containing the - reference is dropped from the output. -</li><li class="listitem"> -If the expression evaluates to <code class="literal">True</code> the attribute - evaluates to an empty string. -</li><li class="listitem"> -<code class="literal"><expression></code> can contain simple and conditional attribute - references. -</li><li class="listitem"> -The <span class="emphasis"><em>eval</em></span> system attribute can be nested inside other - system attributes. -</li></ul></div></dd><dt><span class="term"> -<code class="literal">{eval3:<command>}</code> -</span></dt><dd> - Passthrough version of <code class="literal">{eval:<expression>}</code> — the generated - output is written directly to the output without any further - substitutions. -</dd><dt><span class="term"> -<code class="literal">{include:<filename>}</code> -</span></dt><dd><p class="simpara"> - Substitutes contents of the file named <code class="literal"><filename></code>. -</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -The included file is read at the time of attribute - substitution. -</li><li class="listitem"> -If the file does not exist a warning is emitted and the line - containing the reference is dropped from the output file. -</li><li class="listitem"> -Tabs are expanded based on the current <span class="emphasis"><em>tabsize</em></span> attribute - value. -</li></ul></div></dd><dt><span class="term"> -<code class="literal">{set:<attrname>[!][:<value>]}</code> -</span></dt><dd><p class="simpara"> - Sets or unsets document attribute. Normally only used in - configuration file markup templates (use - <a class="link" href="ch28.html" title="Chapter 28. Attribute Entries">AttributeEntries</a> in AsciiDoc documents). -</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -If the attribute name is followed by an exclamation mark - the attribute becomes undefined. -</li><li class="listitem"> -If <code class="literal"><value></code> is omitted the attribute is set to a blank - string. -</li><li class="listitem"> -<code class="literal"><value></code> can contain simple and conditional attribute - references. -</li><li class="listitem"> -Returns a blank string unless the attribute is undefined in - which case the return value is undefined and the enclosing - line will be dropped. -</li></ul></div></dd><dt><span class="term"> -<code class="literal">{set2:<attrname>[!][:<value>]}</code> -</span></dt><dd> - Same as <code class="literal">set</code> except that the attribute scope is local to the - template. -</dd><dt><span class="term"> -<code class="literal">{sys:<command>}</code> -</span></dt><dd> - Substitutes the stdout generated by the execution of the shell - <code class="literal"><command></code>. -</dd><dt><span class="term"> -<code class="literal">{sys2:<command>}</code> -</span></dt><dd> - Substitutes the stdout and stderr generated by the execution - of the shell <code class="literal"><command></code>. -</dd><dt><span class="term"> -<code class="literal">{sys3:<command>}</code> -</span></dt><dd> - Passthrough version of <code class="literal">{sys:<command>}</code> — the generated - output is written directly to the output without any further - substitutions. -</dd><dt><span class="term"> -<code class="literal">{template:<template>}</code> -</span></dt><dd> - Substitutes the contents of the configuration file section - named <code class="literal"><template></code>. Attribute references contained in the - template are substituted. -</dd></dl></div><div class="itemizedlist"><p class="title"><strong>System reference behavior</strong></p><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -System attribute arguments can contain non-system attribute - references. -</li><li class="listitem"> -Closing brace characters inside system attribute arguments must be - escaped with a backslash. -</li></ul></div></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch29.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch31.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/icons/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
\ No newline at end of file diff --git a/chunked/ch31.html b/chunked/ch31.html deleted file mode 100644 index 845b9ee..0000000 --- a/chunked/ch31.html +++ /dev/null @@ -1,135 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Chapter 31. Intrinsic Attributes</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="AsciiDoc User Guide" /><link rel="up" href="index.html" title="AsciiDoc User Guide" /><link rel="prev" href="ch30.html" title="Chapter 30. Attribute References" /><link rel="next" href="ch32.html" title="Chapter 32. Block Element Definitions" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="ch30.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch32.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a id="X60"></a>Chapter 31. Intrinsic Attributes</h1></div></div></div><p>Intrinsic attributes are simple attributes that are created -automatically from: AsciiDoc document header parameters; asciidoc(1) -command-line arguments; attributes defined in the default -configuration files; the execution context. Here’s the list of -predefined intrinsic attributes:</p><pre class="literallayout">{amp} ampersand (&) character entity -{asciidoc-args} used to pass inherited arguments to asciidoc filters -{asciidoc-confdir} the asciidoc(1) global configuration directory -{asciidoc-dir} the asciidoc(1) application directory -{asciidoc-file} the full path name of the asciidoc(1) script -{asciidoc-version} the version of asciidoc(1) -{author} author's full name -{authored} empty string '' if {author} or {email} defined, -{authorinitials} author initials (from document header) -{backend-<backend>} empty string '' -{<backend>-<doctype>} empty string '' -{backend} document backend specified by `-b` option -{backend-confdir} the directory containing the <backend>.conf file -{backslash} backslash character -{basebackend-<base>} empty string '' -{basebackend} html or docbook -{blockname} current block name (note 8). -{brvbar} broken vertical bar (|) character -{docdate} document last modified date (note 9) -{docdir} document input directory name (note 5) -{docfile} document file name (note 5) -{docname} document file name without extension (note 6) -{doctime} document last modified time (note 9) -{doctitle} document title (from document header) -{doctype-<doctype>} empty string '' -{doctype} document type specified by `-d` option -{email} author's email address (from document header) -{empty} empty string '' -{encoding} specifies input and output encoding -{filetype-<fileext>} empty string '' -{filetype} output file name file extension -{firstname} author first name (from document header) -{gt} greater than (>) character entity -{id} running block id generated by BlockId elements -{indir} input file directory name (note 2,5) -{infile} input file name (note 2,5) -{lastname} author last name (from document header) -{ldquo} Left double quote character (note 7) -{level} title level 1..4 (in section titles) -{listindex} the list index (1..) of the most recent list item -{localdate} the current date (note 9) -{localtime} the current time (note 9) -{lsquo} Left single quote character (note 7) -{lt} less than (<) character entity -{manname} manpage name (defined in NAME section) -{manpurpose} manpage (defined in NAME section) -{mantitle} document title minus the manpage volume number -{manvolnum} manpage volume number (1..8) (from document header) -{middlename} author middle name (from document header) -{nbsp} non-breaking space character entity -{notitle} do not display the document title -{outdir} document output directory name (note 2) -{outfile} output file name (note 2) -{plus} plus character -{python} the full path name of the Python interpreter executable -{rdquo} right double quote character (note 7) -{reftext} running block xreflabel generated by BlockId elements -{revdate} document revision date (from document header) -{revnumber} document revision number (from document header) -{rsquo} right single quote character (note 7) -{sectnum} formatted section number (in section titles) -{sp} space character -{showcomments} send comment lines to the output -{title} section title (in titled elements) -{two-colons} two colon characters -{two-semicolons} two semicolon characters -{user-dir} the ~/.asciidoc directory (if it exists) -{verbose} defined as '' if --verbose command option specified -{wj} word-joiner -{zwsp} zero-width space character entity</pre><div class="note" style="margin-left: 0; margin-right: 10%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/icons/note.png" /></td><th align="left"></th></tr><tr><td align="left" valign="top"><div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -Intrinsic attributes are global so avoid defining custom attributes - with the same names. -</li><li class="listitem"> -<code class="literal">{outfile}</code>, <code class="literal">{outdir}</code>, <code class="literal">{infile}</code>, <code class="literal">{indir}</code> attributes are - effectively read-only (you can set them but it won’t affect the - input or output file paths). -</li><li class="listitem"> -See also the <a class="link" href="aph.html" title="Appendix H. Backend Attributes">Backend Attributes</a> section for attributes - that relate to AsciiDoc XHTML file generation. -</li><li class="listitem"> -The entries that translate to blank strings are designed to be used - for conditional text inclusion. You can also use the <code class="literal">ifdef</code>, - <code class="literal">ifndef</code> and <code class="literal">endif</code> System macros for conditional inclusion. - <a href="#ftn.idm4432" class="footnote" id="idm4432"><sup class="footnote">[4]</sup></a> -</li><li class="listitem"> -<code class="literal">{docfile}</code> and <code class="literal">{docdir}</code> refer to root document specified on the - asciidoc(1) command-line; <code class="literal">{infile}</code> and <code class="literal">{indir}</code> refer to the - current input file which may be the root document or an included - file. When the input is being read from the standard input - (<code class="literal">stdin</code>) these attributes are undefined. -</li><li class="listitem"> -If the input file is the standard input and the output file is not - the standard output then <code class="literal">{docname}</code> is the output file name sans - file extension. -</li><li class="listitem"> -See - <a class="ulink" href="http://en.wikipedia.org/wiki/Non-English_usage_of_quotation_marks" target="_top">non-English - usage of quotation marks</a>. -</li><li class="listitem"><p class="simpara"> -The <code class="literal">{blockname}</code> attribute identifies the style of the current - block. It applies to delimited blocks, lists and tables. Here is a - list of <code class="literal">{blockname}</code> values (does not include filters or custom - block and style names): -</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"> -delimited blocks -</span></dt><dd> -comment, sidebar, open, pass, literal, verse, - listing, quote, example, note, tip, important, caution, warning, - abstract, partintro -</dd><dt><span class="term"> -lists -</span></dt><dd> -arabic, loweralpha, upperalpha, lowerroman, upperroman, - labeled, labeled3, labeled4, qanda, horizontal, bibliography, - glossary -</dd><dt><span class="term"> -tables -</span></dt><dd> -table -</dd></dl></div></li><li class="listitem"> -If the <code class="literal">SOURCE_DATE_EPOCH</code> environment variable is set to a UNIX - timestamp, then the <code class="literal">{docdate}</code>, <code class="literal">{doctime}</code>, <code class="literal">{localdate}</code>, and - <code class="literal">{localtime}</code> attributes are computed in the UTC time zone, with any - timestamps newer than <code class="literal">SOURCE_DATE_EPOCH</code> replaced by - <code class="literal">SOURCE_DATE_EPOCH</code>. (This helps software using AsciiDoc to build - reproducibly.) -</li></ol></div></td></tr></table></div><div class="footnotes"><br /><hr style="width:100; text-align:left;margin-left: 0" /><div id="ftn.idm4432" class="footnote"><p><a href="#idm4432" class="simpara"><sup class="simpara">[4] </sup></a>Conditional inclusion using <code class="literal">ifdef</code> and <code class="literal">ifndef</code> macros - differs from attribute conditional inclusion in that the former - occurs when the file is read while the latter occurs when the - contents are written.</p></div></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch30.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch32.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/icons/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
\ No newline at end of file diff --git a/chunked/ch32.html b/chunked/ch32.html deleted file mode 100644 index 64deea5..0000000 --- a/chunked/ch32.html +++ /dev/null @@ -1,250 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Chapter 32. Block Element Definitions</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="AsciiDoc User Guide" /><link rel="up" href="index.html" title="AsciiDoc User Guide" /><link rel="prev" href="ch31.html" title="Chapter 31. Intrinsic Attributes" /><link rel="next" href="ch33.html" title="Chapter 33. Filters" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="ch31.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch33.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a id="X73"></a>Chapter 32. Block Element Definitions</h1></div></div></div><p>The syntax and behavior of Paragraph, DelimitedBlock, List and Table -block elements is determined by block definitions contained in -<a class="link" href="ch26.html" title="Chapter 26. Configuration Files">AsciiDoc configuration file</a> sections.</p><p>Each definition consists of a section title followed by one or more -section entries. Each entry defines a block parameter controlling some -aspect of the block’s behavior. Here’s an example:</p><pre class="screen">[blockdef-listing] -delimiter=^-{4,}$ -template=listingblock -presubs=specialcharacters,callouts</pre><p>Configuration file block definition sections are processed -incrementally after each configuration file is loaded. Block -definition section entries are merged into the block definition, this -allows block parameters to be overridden and extended by later -<a class="link" href="ch26.html#X27" title="26.11. Configuration file names, precedence and locations">loading configuration files</a>.</p><p>AsciiDoc Paragraph, DelimitedBlock, List and Table block elements -share a common subset of configuration file parameters:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"> -delimiter -</span></dt><dd> - A Python regular expression that matches the first line of a block - element — in the case of DelimitedBlocks and Tables it also matches - the last line. -</dd><dt><span class="term"> -template -</span></dt><dd> - The name of the configuration file markup template section that will - envelope the block contents. The pipe (<span class="emphasis"><em>|</em></span>) character is substituted - for the block contents. List elements use a set of (list specific) - tag parameters instead of a single template. The template name can - contain attribute references allowing dynamic template selection a - the time of template substitution. -</dd><dt><span class="term"> -options -</span></dt><dd> - A comma delimited list of element specific option names. In addition - to being used internally, options are available during markup tag - and template substitution as attributes with an empty string value - named like <code class="literal"><option>-option</code> (where <code class="literal"><option></code> is the option name). - See <a class="link" href="apf.html" title="Appendix F. Attribute Options">attribute options</a> for a complete list of available - options. -</dd><dt><span class="term"> -subs, presubs, postsubs -</span></dt><dd><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -<span class="emphasis"><em>presubs</em></span> and <span class="emphasis"><em>postsubs</em></span> are lists of comma separated substitutions that are - performed on the block contents. <span class="emphasis"><em>presubs</em></span> is applied first, - <span class="emphasis"><em>postsubs</em></span> (if specified) second. -</li><li class="listitem"> -<span class="emphasis"><em>subs</em></span> is an alias for <span class="emphasis"><em>presubs</em></span>. -</li><li class="listitem"> -If a <span class="emphasis"><em>filter</em></span> is allowed (Paragraphs, DelimitedBlocks and Tables) - and has been specified then <span class="emphasis"><em>presubs</em></span> and <span class="emphasis"><em>postsubs</em></span> substitutions - are performed before and after the filter is run respectively. -</li><li class="listitem"> -Allowed values: <span class="emphasis"><em>specialcharacters</em></span>, <span class="emphasis"><em>quotes</em></span>, <span class="emphasis"><em>specialwords</em></span>, - <span class="emphasis"><em>replacements</em></span>, <span class="emphasis"><em>macros</em></span>, <span class="emphasis"><em>attributes</em></span>, <span class="emphasis"><em>callouts</em></span>. -</li><li class="listitem"><p class="simpara"> -<a id="X102"></a>The following composite values are also allowed: -</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"> -<span class="emphasis"><em>none</em></span> -</span></dt><dd> - No substitutions. -</dd><dt><span class="term"> -<span class="emphasis"><em>normal</em></span> -</span></dt><dd> - The following substitutions in the following order: - <span class="emphasis"><em>specialcharacters</em></span>, <span class="emphasis"><em>quotes</em></span>, <span class="emphasis"><em>attributes</em></span>, <span class="emphasis"><em>specialwords</em></span>, - <span class="emphasis"><em>replacements</em></span>, <span class="emphasis"><em>macros</em></span>, <span class="emphasis"><em>replacements2</em></span>. -</dd><dt><span class="term"> -<span class="emphasis"><em>verbatim</em></span> -</span></dt><dd> - The following substitutions in the following order: - <span class="emphasis"><em>specialcharacters</em></span> and <span class="emphasis"><em>callouts</em></span>. -</dd></dl></div></li><li class="listitem"> -<span class="emphasis"><em>normal</em></span> and <span class="emphasis"><em>verbatim</em></span> substitutions can be redefined by with - <code class="literal">subsnormal</code> and <code class="literal">subsverbatim</code> entries in a configuration file - <code class="literal">[miscellaneous]</code> section. -</li><li class="listitem"> -The substitutions are processed in the order in which they are - listed and can appear more than once. -</li></ul></div></dd><dt><span class="term"> -filter -</span></dt><dd> - This optional entry specifies an executable shell command for - processing block content (Paragraphs, DelimitedBlocks and Tables). - The filter command can contain attribute references. -</dd><dt><span class="term"> -posattrs -</span></dt><dd><p class="simpara"> - Optional comma separated list of positional attribute names. This - list maps positional attributes (in the block’s <a class="link" href="ch29.html" title="Chapter 29. Attribute Lists">attribute list</a>) to named block attributes. The following example, from the - QuoteBlock definition, maps the first and section positional - attributes: -</p><pre class="literallayout">posattrs=attribution,citetitle</pre></dd><dt><span class="term"> -style -</span></dt><dd> - This optional parameter specifies the default style name. -</dd><dt><span class="term"> -<stylename>-style -</span></dt><dd> - Optional style definition (see <a class="link" href="ch32.html#X23" title="32.1. Styles">Styles</a> below). -</dd></dl></div><p>The following block parameters behave like document attributes and can -be set in block attribute lists and style definitions: <span class="emphasis"><em>template</em></span>, -<span class="emphasis"><em>options</em></span>, <span class="emphasis"><em>subs</em></span>, <span class="emphasis"><em>presubs</em></span>, <span class="emphasis"><em>postsubs</em></span>, <span class="emphasis"><em>filter</em></span>.</p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="X23"></a>32.1. Styles</h2></div></div></div><p>A style is a set of block parameter bundled as a single named -parameter. The following example defines a style named <span class="emphasis"><em>verbatim</em></span>:</p><pre class="literallayout">verbatim-style=template="literalblock",subs="verbatim"</pre><p>If a block’s <a class="link" href="ch29.html" title="Chapter 29. Attribute Lists">attribute list</a> contains a <span class="emphasis"><em>style</em></span> attribute then -the corresponding style parameters are be merged into the default -block definition parameters.</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -All style parameter names must be suffixed with <code class="literal">-style</code> and the - style parameter value is in the form of a list of <a class="link" href="ch29.html" title="Chapter 29. Attribute Lists">named attributes</a>. -</li><li class="listitem"> -The <span class="emphasis"><em>template</em></span> style parameter is mandatory, other parameters can be - omitted in which case they inherit their values from the default - block definition parameters. -</li><li class="listitem"> -Multi-item style parameters (<span class="emphasis"><em>subs</em></span>,<span class="emphasis"><em>presubs</em></span>,<span class="emphasis"><em>postsubs</em></span>,<span class="emphasis"><em>posattrs</em></span>) - must be specified using Python tuple syntax (rather than a simple - list of values as they in separate entries) e.g. - <code class="literal">postsubs=("callouts",)</code> not <code class="literal">postsubs="callouts"</code>. -</li></ul></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_paragraphs_2"></a>32.2. Paragraphs</h2></div></div></div><p>Paragraph translation is controlled by <code class="literal">[paradef-*]</code> configuration -file section entries. Users can define new types of paragraphs and -modify the behavior of existing types by editing AsciiDoc -configuration files.</p><p>Here is the shipped Default paragraph definition:</p><pre class="screen">[paradef-default] -delimiter=(?P<text>\S.*) -template=paragraph</pre><p>The normal paragraph definition has a couple of special properties:</p><div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -It must exist and be defined in a configuration file section named - <code class="literal">[paradef-default]</code>. -</li><li class="listitem"> -Irrespective of its position in the configuration files default - paragraph document matches are attempted only after trying all - other paragraph types. -</li></ol></div><p>Paragraph specific block parameter notes:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"> -delimiter -</span></dt><dd> - This regular expression must contain the named group <span class="emphasis"><em>text</em></span> which - matches the text on the first line. Paragraphs are terminated by a - blank line, the end of file, or the start of a DelimitedBlock. -</dd><dt><span class="term"> -options -</span></dt><dd> - The <span class="emphasis"><em>listelement</em></span> option specifies that paragraphs of this type will - automatically be considered part of immediately preceding list - items. The <span class="emphasis"><em>skip</em></span> option causes the paragraph to be treated as a - comment (see <a class="link" href="ch16.html#X26" title="16.5. Comment Blocks">CommentBlocks</a>). -</dd></dl></div><div class="orderedlist"><p class="title"><strong>Paragraph processing proceeds as follows:</strong></p><ol class="orderedlist" type="1"><li class="listitem"> -The paragraph text is aligned to the left margin. -</li><li class="listitem"> -Optional <span class="emphasis"><em>presubs</em></span> inline substitutions are performed on the - paragraph text. -</li><li class="listitem"> -If a filter command is specified it is executed and the paragraph - text piped to its standard input; the filter output replaces the - paragraph text. -</li><li class="listitem"> -Optional <span class="emphasis"><em>postsubs</em></span> inline substitutions are performed on the - paragraph text. -</li><li class="listitem"> -The paragraph text is enveloped by the paragraph’s markup template - and written to the output file. -</li></ol></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_delimited_blocks"></a>32.3. Delimited Blocks</h2></div></div></div><p>DelimitedBlock <span class="emphasis"><em>options</em></span> values are:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"> -sectionbody -</span></dt><dd> - The block contents are processed as a SectionBody. -</dd><dt><span class="term"> -skip -</span></dt><dd> - The block is treated as a comment (see <a class="link" href="ch16.html#X26" title="16.5. Comment Blocks">CommentBlocks</a>). - Preceding <a class="link" href="ch29.html" title="Chapter 29. Attribute Lists">attribute lists</a> and <a class="link" href="ch12.html" title="Chapter 12. Block Titles">block titles</a> are not - consumed. -</dd></dl></div><p><span class="emphasis"><em>presubs</em></span>, <span class="emphasis"><em>postsubs</em></span> and <span class="emphasis"><em>filter</em></span> entries are ignored when -<span class="emphasis"><em>sectionbody</em></span> or <span class="emphasis"><em>skip</em></span> options are set.</p><p>DelimitedBlock processing proceeds as follows:</p><div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -Optional <span class="emphasis"><em>presubs</em></span> substitutions are performed on the block - contents. -</li><li class="listitem"> -If a filter is specified it is executed and the block’s contents - piped to its standard input. The filter output replaces the block - contents. -</li><li class="listitem"> -Optional <span class="emphasis"><em>postsubs</em></span> substitutions are performed on the block - contents. -</li><li class="listitem"> -The block contents is enveloped by the block’s markup template and - written to the output file. -</li></ol></div><div class="tip" style="margin-left: 0; margin-right: 10%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="images/icons/tip.png" /></td><th align="left"></th></tr><tr><td align="left" valign="top"><p>Attribute expansion is performed on the block filter command -before it is executed, this is useful for passing arguments to the -filter.</p></td></tr></table></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_lists"></a>32.4. Lists</h2></div></div></div><p>List behavior and syntax is determined by <code class="literal">[listdef-*]</code> configuration -file sections. The user can change existing list behavior and add new -list types by editing configuration files.</p><p>List specific block definition notes:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"> -type -</span></dt><dd> - This is either <span class="emphasis"><em>bulleted</em></span>,<span class="emphasis"><em>numbered</em></span>,<span class="emphasis"><em>labeled</em></span> or <span class="emphasis"><em>callout</em></span>. -</dd><dt><span class="term"> -delimiter -</span></dt><dd> - A Python regular expression that matches the first line of a - list element entry. This expression can contain the named groups - <span class="emphasis"><em>text</em></span> (bulleted groups), <span class="emphasis"><em>index</em></span> and <span class="emphasis"><em>text</em></span> (numbered lists), - <span class="emphasis"><em>label</em></span> and <span class="emphasis"><em>text</em></span> (labeled lists). -</dd><dt><span class="term"> -tags -</span></dt><dd> - The <code class="literal"><name></code> of the <code class="literal">[listtags-<name>]</code> configuration file section - containing list markup tag definitions. The tag entries (<span class="emphasis"><em>list</em></span>, - <span class="emphasis"><em>entry</em></span>, <span class="emphasis"><em>label</em></span>, <span class="emphasis"><em>term</em></span>, <span class="emphasis"><em>text</em></span>) map the AsciiDoc list structure to - backend markup; see the <span class="emphasis"><em>listtags</em></span> sections in the AsciiDoc - distributed backend <code class="literal">.conf</code> configuration files for examples. -</dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_tables_2"></a>32.5. Tables</h2></div></div></div><p>Table behavior and syntax is determined by <code class="literal">[tabledef-*]</code> and -<code class="literal">[tabletags-*]</code> configuration file sections. The user can change -existing table behavior and add new table types by editing -configuration files. The following <code class="literal">[tabledef-*]</code> section entries -generate table output markup elements:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"> -colspec -</span></dt><dd> - The table <span class="emphasis"><em>colspec</em></span> tag definition. -</dd><dt><span class="term"> -headrow, footrow, bodyrow -</span></dt><dd> - Table header, footer and body row tag definitions. <span class="emphasis"><em>headrow</em></span> and - <span class="emphasis"><em>footrow</em></span> table definition entries default to <span class="emphasis"><em>bodyrow</em></span> if - they are undefined. -</dd><dt><span class="term"> -headdata, footdata, bodydata -</span></dt><dd> - Table header, footer and body data tag definitions. <span class="emphasis"><em>headdata</em></span> and - <span class="emphasis"><em>footdata</em></span> table definition entries default to <span class="emphasis"><em>bodydata</em></span> if they - are undefined. -</dd><dt><span class="term"> -paragraph -</span></dt><dd> - If the <span class="emphasis"><em>paragraph</em></span> tag is specified then blank lines in the cell - data are treated as paragraph delimiters and marked up using this - tag. -</dd></dl></div><p><a id="X4"></a>Table behavior is also influenced by the following <code class="literal">[miscellaneous]</code> -configuration file entries:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"> -pagewidth -</span></dt><dd> - This integer value is the printable width of the output media. See - <a class="link" href="ch23.html#X69" title="23.3. Table attributes">table attributes</a>. -</dd><dt><span class="term"> -pageunits -</span></dt><dd> - The units of width in output markup width attribute values. -</dd></dl></div><div class="itemizedlist"><p class="title"><strong>Table definition behavior</strong></p><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -The output markup generation is specifically designed to work with - the HTML and CALS (DocBook) table models, but should be adaptable to - most XML table schema. -</li><li class="listitem"> -Table definitions can be “mixed in” from multiple cascading - configuration files. -</li><li class="listitem"> -New table definitions inherit the default table and table tags - definitions (<code class="literal">[tabledef-default]</code> and <code class="literal">[tabletags-default]</code>) so you - only need to override those conf file entries that require - modification. -</li></ul></div></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch31.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch33.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/icons/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
\ No newline at end of file diff --git a/chunked/ch33.html b/chunked/ch33.html deleted file mode 100644 index 2cf41f6..0000000 --- a/chunked/ch33.html +++ /dev/null @@ -1,67 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Chapter 33. Filters</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="AsciiDoc User Guide" /><link rel="up" href="index.html" title="AsciiDoc User Guide" /><link rel="prev" href="ch32.html" title="Chapter 32. Block Element Definitions" /><link rel="next" href="ch34.html" title="Chapter 34. Plugins" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="ch32.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch34.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a id="X59"></a>Chapter 33. Filters</h1></div></div></div><p>AsciiDoc filters allow external commands to process AsciiDoc -<span class="emphasis"><em>Paragraphs</em></span>, <span class="emphasis"><em>DelimitedBlocks</em></span> and <span class="emphasis"><em>Table</em></span> content. Filters are -primarily an extension mechanism for generating specialized outputs. -Filters are implemented using external commands which are specified in -configuration file definitions.</p><p>There’s nothing special about the filters, they’re just standard UNIX -filters: they read text from the standard input, process it, and write -to the standard output.</p><p>The asciidoc(1) command <code class="literal">--filter</code> option can be used to install and -remove filters. The same option is used to unconditionally load a -filter.</p><p>Attribute substitution is performed on the filter command prior to -execution — attributes can be used to pass parameters from the -AsciiDoc source document to the filter.</p><div class="warning" style="margin-left: 0; margin-right: 10%;"><table border="0" summary="Warning"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="images/icons/warning.png" /></td><th align="left"></th></tr><tr><td align="left" valign="top"><p>Filters sometimes included executable code. Before installing -a filter you should verify that it is from a trusted source.</p></td></tr></table></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_filter_search_paths"></a>33.1. Filter Search Paths</h2></div></div></div><p>If the filter command does not specify a directory path then -asciidoc(1) recursively searches for the executable filter command:</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -First it looks in the user’s <code class="literal">$HOME/.asciidoc/filters</code> directory. -</li><li class="listitem"> -Next the global filters directory (usually <code class="literal">/etc/asciidoc/filters</code> - or <code class="literal">/usr/local/etc/asciidoc</code>) directory is searched. -</li><li class="listitem"> -Then it looks in the asciidoc(1) <code class="literal">./filters</code> directory. -</li><li class="listitem"> -Finally it relies on the executing shell to search the environment - search path (<code class="literal">$PATH</code>). -</li></ul></div><p>Standard practice is to install each filter in it’s own sub-directory -with the same name as the filter’s style definition. For example the -music filter’s style name is <span class="emphasis"><em>music</em></span> so it’s configuration and filter -files are stored in the <code class="literal">filters/music</code> directory.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_filter_configuration_files"></a>33.2. Filter Configuration Files</h2></div></div></div><p>Filters are normally accompanied by a configuration file containing a -Paragraph or DelimitedBlock definition along with corresponding markup -templates.</p><p>While it is possible to create new <span class="emphasis"><em>Paragraph</em></span> or <span class="emphasis"><em>DelimitedBlock</em></span> -definitions the preferred way to implement a filter is to add a -<a class="link" href="ch32.html#X23" title="32.1. Styles">style</a> to the existing Paragraph and ListingBlock definitions -(all filters shipped with AsciiDoc use this technique). The filter is -applied to the paragraph or delimited block by preceding it with an -attribute list: the first positional attribute is the style name, -remaining attributes are normally filter specific parameters.</p><p>asciidoc(1) auto-loads all <code class="literal">.conf</code> files found in the filter search -paths unless the container directory also contains a file named -<code class="literal">__noautoload__</code> (see previous section). The <code class="literal">__noautoload__</code> feature -is used for filters that will be loaded manually using the <code class="literal">--filter</code> -option.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="X56"></a>33.3. Example Filter</h2></div></div></div><p>AsciiDoc comes with a toy filter for highlighting source code keywords -and comments. See also the <code class="literal">./filters/code/code-filter-readme.txt</code> -file.</p><div class="note" style="margin-left: 0; margin-right: 10%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/icons/note.png" /></td><th align="left"></th></tr><tr><td align="left" valign="top"><p>The purpose of this toy filter is to demonstrate how to write a -filter — it’s much to simplistic to be passed off as a code syntax -highlighter. If you want a full featured multi-language highlighter -use the <a class="ulink" href="https://asciidoc.org/source-highlight-filter.html" target="_top">source code highlighter -filter</a>.</p></td></tr></table></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_built_in_filters"></a>33.4. Built-in filters</h2></div></div></div><p>The AsciiDoc distribution includes <span class="emphasis"><em>source</em></span>, <span class="emphasis"><em>music</em></span>, <span class="emphasis"><em>latex</em></span> and -<span class="emphasis"><em>graphviz</em></span> filters, details are on the -<a class="ulink" href="https://asciidoc.org/index.html#_filters" target="_top">AsciiDoc website</a>.</p><div class="table"><a id="idm4841"></a><p class="title"><strong>Table 33.1. Built-in filters list</strong></p><div class="table-contents"><table class="table" summary="Built-in filters list" cellpadding="4px" style="border-collapse: collapse;border-top: 3px solid #527bbd; border-bottom: 3px solid #527bbd; "><colgroup><col class="col_1" /><col class="col_2" /></colgroup><thead><tr><th style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top">Filter name </th><th style="border-bottom: 1px solid #527bbd; " align="left" valign="top">Description</th></tr></thead><tbody><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em>music</em></span></p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>A <a class="ulink" href="https://asciidoc.org/music-filter.html" target="_top">music filter</a> is included in the -distribution <code class="literal">./filters/</code> directory. It translates music in -<a class="ulink" href="http://lilypond.org/" target="_top">LilyPond</a> or <a class="ulink" href="http://abcnotation.org.uk/" target="_top">ABC</a> -notation to standard classical notation.</p></td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em>source</em></span></p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>A <a class="ulink" href="https://asciidoc.org/source-highlight-filter.html" target="_top">source code highlight filter</a> -is included in the distribution <code class="literal">./filters/</code> directory.</p></td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em>latex</em></span></p></td><td style="border-bottom: 1px solid #527bbd; " align="left" valign="top"><p>The <a class="ulink" href="https://asciidoc.org/latex-filter.html" target="_top">AsciiDoc LaTeX filter</a> translates -LaTeX source to an image that is automatically inserted into the -AsciiDoc output documents.</p></td></tr><tr><td style="border-right: 1px solid #527bbd; " align="left" valign="top"><p><span class="emphasis"><em>graphviz</em></span></p></td><td style="" align="left" valign="top"><p>Gouichi Iisaka has written a <a class="ulink" href="http://www.graphviz.org/" target="_top">Graphviz</a> -filter for AsciiDoc. Graphviz generates diagrams from a textual -specification. Gouichi Iisaka’s Graphviz filter is included in the -AsciiDoc distribution. Here are some -<a class="ulink" href="https://asciidoc.org/asciidoc-graphviz-sample.html" target="_top">AsciiDoc Graphviz examples</a>.</p></td></tr></tbody></table></div></div><br class="table-break" /></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="X58"></a>33.5. Filter plugins</h2></div></div></div><p>Filter <a class="link" href="ch34.html" title="Chapter 34. Plugins">plugins</a> are a mechanism for distributing AsciiDoc -filters. A filter plugin is a Zip file containing the files that -constitute a filter. The asciidoc(1) <code class="literal">--filter</code> option is used to -load and manage filer <a class="link" href="ch34.html" title="Chapter 34. Plugins">plugins</a>.</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -Filter plugins <a class="link" href="ch26.html#X27" title="26.11. Configuration file names, precedence and locations">take precedence</a> over built-in filters with - the same name. -</li><li class="listitem"> -By default filter plugins are installed in - <code class="literal">$HOME/.asciidoc/filters/<filter></code> where <code class="literal"><filter></code> is the filter - name. -</li></ul></div></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch32.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch34.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/icons/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
\ No newline at end of file diff --git a/chunked/ch34.html b/chunked/ch34.html deleted file mode 100644 index 6e97329..0000000 --- a/chunked/ch34.html +++ /dev/null @@ -1,20 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Chapter 34. Plugins</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="AsciiDoc User Guide" /><link rel="up" href="index.html" title="AsciiDoc User Guide" /><link rel="prev" href="ch33.html" title="Chapter 33. Filters" /><link rel="next" href="ch35.html" title="Chapter 35. Help Commands" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="ch33.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch35.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a id="X101"></a>Chapter 34. Plugins</h1></div></div></div><p>The AsciiDoc plugin architecture is an extension mechanism that allows -additional <a class="link" href="ch04.html#X100" title="4.2. Backend Plugins">backends</a>, <a class="link" href="ch33.html#X58" title="33.5. Filter plugins">filters</a> and <a class="link" href="ch07.html#X99" title="7.1. Themes">themes</a> to be -added to AsciiDoc.</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -A plugin is a Zip file containing an AsciiDoc backend, filter or - theme (configuration files, stylesheets, scripts, images). -</li><li class="listitem"> -The asciidoc(1) <code class="literal">--backend</code>, <code class="literal">--filter</code> and <code class="literal">--theme</code> command-line - options are used to load and manage plugins. Each of these options - responds to the plugin management <span class="emphasis"><em>install</em></span>, <span class="emphasis"><em>list</em></span>, <span class="emphasis"><em>remove</em></span> and - <span class="emphasis"><em>build</em></span> commands. -</li><li class="listitem"> -The plugin management command names are reserved and cannot be used - for filter, backend or theme names. -</li><li class="listitem"> -The plugin Zip file name always begins with the backend, filter or - theme name. -</li></ul></div><p>Plugin commands and conventions are documented in the asciidoc(1) man -page. You can find lists of plugins on the -<a class="ulink" href="https://asciidoc.org/plugins.html" target="_top">AsciiDoc website</a>.</p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch33.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch35.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/icons/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
\ No newline at end of file diff --git a/chunked/ch35.html b/chunked/ch35.html deleted file mode 100644 index de4861e..0000000 --- a/chunked/ch35.html +++ /dev/null @@ -1,21 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Chapter 35. Help Commands</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="AsciiDoc User Guide" /><link rel="up" href="index.html" title="AsciiDoc User Guide" /><link rel="prev" href="ch34.html" title="Chapter 34. Plugins" /><link rel="next" href="ch36.html" title="Chapter 36. Tips and Tricks" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="ch34.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch36.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a id="X36"></a>Chapter 35. Help Commands</h1></div></div></div><p>The asciidoc(1) command has a <code class="literal">--help</code> option which prints help topics -to stdout. The default topic summarizes asciidoc(1) usage:</p><pre class="literallayout">$ asciidoc --help</pre><p>To print a help topic specify the topic name as a command argument. -Help topic names can be shortened so long as they are not ambiguous. -Examples:</p><pre class="literallayout">$ asciidoc --help manpage -$ asciidoc -h m # Short version of previous example. -$ asciidoc --help syntax -$ asciidoc -h s # Short version of previous example.</pre><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_customizing_help"></a>35.1. Customizing Help</h2></div></div></div><p>To change, delete or add your own help topics edit a help -configuration file. The help file name <code class="literal">help-<lang>.conf</code> is based on -the setting of the <code class="literal">lang</code> attribute, it defaults to <code class="literal">help.conf</code> -(English). The <a class="link" href="ch26.html#X27" title="26.11. Configuration file names, precedence and locations">help file location</a> will depend on whether you -want the topics to apply to all users or just the current user.</p><p>The help topic files have the same named section format as other -<a class="link" href="ch26.html" title="Chapter 26. Configuration Files">configuration files</a>. The <code class="literal">help.conf</code> files are stored in the -same locations and loaded in the same order as other configuration -files.</p><p>When the <code class="literal">--help</code> command-line option is specified AsciiDoc loads the -appropriate help files and then prints the contents of the section -whose name matches the help topic name. If a topic name is not -specified <code class="literal">default</code> is used. You don’t need to specify the whole help -topic name on the command-line, just enough letters to ensure it’s not -ambiguous. If a matching help file section is not found a list of -available topics is printed.</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch34.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch36.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/icons/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
\ No newline at end of file diff --git a/chunked/ch36.html b/chunked/ch36.html deleted file mode 100644 index ce8f0e1..0000000 --- a/chunked/ch36.html +++ /dev/null @@ -1,216 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Chapter 36. Tips and Tricks</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="AsciiDoc User Guide" /><link rel="up" href="index.html" title="AsciiDoc User Guide" /><link rel="prev" href="ch35.html" title="Chapter 35. Help Commands" /><link rel="next" href="go01.html" title="Glossary" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="ch35.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="go01.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a id="_tips_and_tricks"></a>Chapter 36. Tips and Tricks</h1></div></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_know_your_editor"></a>36.1. Know Your Editor</h2></div></div></div><p>Writing AsciiDoc documents will be a whole lot more pleasant if you -know your favorite text editor. Learn how to indent and reformat text -blocks, paragraphs, lists and sentences. <a class="link" href="ch36.html#X20" title="36.2. Vim Commands for Formatting AsciiDoc">Tips for <span class="emphasis"><em>vim</em></span> users</a> -follow.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="X20"></a>36.2. Vim Commands for Formatting AsciiDoc</h2></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_text_wrap_paragraphs"></a>36.2.1. Text Wrap Paragraphs</h3></div></div></div><p>Use the vim <code class="literal">:gq</code> command to reformat paragraphs. Setting the -<span class="emphasis"><em>textwidth</em></span> sets the right text wrap margin; for example:</p><pre class="literallayout">:set textwidth=70</pre><p>To reformat a paragraph:</p><div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -Position the cursor at the start of the paragraph. -</li><li class="listitem"> -Type <code class="literal">gq}</code>. -</li></ol></div><p>Execute <code class="literal">:help gq</code> command to read about the vim gq command.</p><div class="tip" style="margin-left: 0; margin-right: 10%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="images/icons/tip.png" /></td><th align="left"></th></tr><tr><td align="left" valign="top"><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -Assign the <code class="literal">gq}</code> command to the Q key with the <code class="literal">nnoremap Q gq}</code> - command or put it in your <code class="literal">~/.vimrc</code> file to so it’s always - available (see the <a class="link" href="ch36.html#X61" title="36.2.4. Example ~/.vimrc File">Example <code class="literal">~/.vimrc</code> file</a>). -</li><li class="listitem"> -Put <code class="literal">set</code> commands in your <code class="literal">~/.vimrc</code> file so you don’t have to - enter them manually. -</li><li class="listitem"> -The Vim website (<a class="ulink" href="http://www.vim.org" target="_top">http://www.vim.org</a>) has a wealth of resources, - including scripts for automated spell checking and ASCII Art - drawing. -</li></ul></div></td></tr></table></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_format_lists"></a>36.2.2. Format Lists</h3></div></div></div><p>The <code class="literal">gq</code> command can also be used to format bulleted, numbered and -callout lists. First you need to set the <code class="literal">comments</code>, <code class="literal">formatoptions</code> -and <code class="literal">formatlistpat</code> (see the <a class="link" href="ch36.html#X61" title="36.2.4. Example ~/.vimrc File">Example <code class="literal">~/.vimrc</code> file</a>).</p><p>Now you can format simple lists that use dash, asterisk, period and -plus bullets along with numbered ordered lists:</p><div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -Position the cursor at the start of the list. -</li><li class="listitem"> -Type <code class="literal">gq}</code>. -</li></ol></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_indent_paragraphs"></a>36.2.3. Indent Paragraphs</h3></div></div></div><p>Indent whole paragraphs by indenting the fist line with the desired -indent and then executing the <code class="literal">gq}</code> command.</p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="X61"></a>36.2.4. Example <code class="literal">~/.vimrc</code> File</h3></div></div></div><pre class="screen">" Use bold bright fonts. -set background=dark - -" Show tabs and trailing characters. -"set listchars=tab:»·,trail:·,eol:¬ -set listchars=tab:»·,trail:· -set list - -" Reformat paragraphs and list. -nnoremap <Leader>r gq} - -" Delete trailing white space and Dos-returns and to expand tabs to spaces. -nnoremap <Leader>t :set et<CR>:retab!<CR>:%s/[\r \t]\+$//<CR> - -autocmd BufRead,BufNewFile *.txt,*.asciidoc,README,TODO,CHANGELOG,NOTES,ABOUT - \ setlocal autoindent expandtab tabstop=8 softtabstop=2 shiftwidth=2 filetype=asciidoc - \ textwidth=70 wrap formatoptions=tcqn - \ formatlistpat=^\\s*\\d\\+\\.\\s\\+\\\\|^\\s*<\\d\\+>\\s\\+\\\\|^\\s*[a-zA-Z.]\\.\\s\\+\\\\|^\\s*[ivxIVX]\\+\\.\\s\\+ - \ comments=s1:/*,ex:*/,://,b:#,:%,:XCOMM,fb:-,fb:*,fb:+,fb:.,fb:></pre></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_troubleshooting"></a>36.3. Troubleshooting</h2></div></div></div><p>AsciiDoc diagnostic features are detailed in the <a class="link" href="apg.html" title="Appendix G. Diagnostics">Diagnostics appendix</a>.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_gotchas"></a>36.4. Gotchas</h2></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term"> -Incorrect character encoding -</span></dt><dd> - If you get an error message like <code class="literal">'UTF-8' codec can't decode ...</code> - then you source file contains invalid UTF-8 characters — set the - AsciiDoc <a class="link" href="aph.html#X54">encoding attribute</a> for the correct character set - (typically ISO-8859-1 (Latin-1) for European languages). -</dd><dt><span class="term"> -Invalid output -</span></dt><dd><p class="simpara"> - AsciiDoc attempts to validate the input AsciiDoc source but makes - no attempt to validate the output markup, it leaves that to - external tools such as <code class="literal">xmllint(1)</code> (integrated into <code class="literal">a2x(1)</code>). - Backend validation cannot be hardcoded into AsciiDoc because - backends are dynamically configured. The following example - generates valid HTML but invalid DocBook (the DocBook <code class="literal">literal</code> - element cannot contain an <code class="literal">emphasis</code> element): -</p><pre class="literallayout">+monospaced text with an _emphasized_ word+</pre></dd><dt><span class="term"> -Misinterpreted text formatting -</span></dt><dd><p class="simpara"> - You can suppress markup expansion by placing a backslash character - immediately in front of the element. The following example - suppresses inline monospaced formatting: -</p><pre class="literallayout">\+1 for C++.</pre></dd><dt><span class="term"> -Overlapping text formatting -</span></dt><dd><p class="simpara"> - Overlapping text formatting will generate illegal overlapping - markup tags which will result in downstream XML parsing errors. - Here’s an example: -</p><pre class="literallayout">Some *strong markup _that overlaps* emphasized markup_.</pre></dd><dt><span class="term"> -Ambiguous underlines -</span></dt><dd> - A DelimitedBlock can immediately follow a paragraph without an - intervening blank line, but be careful, a single line paragraph - underline may be misinterpreted as a section title underline - resulting in a “closing block delimiter expected” error. -</dd><dt><span class="term"> -Ambiguous ordered list items -</span></dt><dd><p class="simpara"> - Lines beginning with numbers at the end of sentences will be - interpreted as ordered list items. The following example - (incorrectly) begins a new list with item number 1999: -</p><pre class="literallayout">He was last sighted in -1999. Since then things have moved on.</pre><p class="simpara">The <span class="emphasis"><em>list item out of sequence</em></span> warning makes it unlikely that this -problem will go unnoticed.</p></dd><dt><span class="term"> -Special characters in attribute values -</span></dt><dd><p class="simpara"> - Special character substitution precedes attribute substitution so - if attribute values contain special characters you may, depending - on the substitution context, need to escape the special characters - yourself. For example: -</p><pre class="literallayout">$ asciidoc -a 'orgname=Bill &amp; Ben Inc.' mydoc.txt</pre></dd><dt><span class="term"> -Attribute lists -</span></dt><dd><p class="simpara"> - If any named attribute entries are present then all string - attribute values must be quoted. For example: -</p><pre class="literallayout">["Desktop screenshot",width=32]</pre></dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="X90"></a>36.5. Combining separate documents</h2></div></div></div><p>You have a number of stand-alone AsciiDoc documents that you want to -process as a single document. Simply processing them with a series of -<code class="literal">include</code> macros won’t work because the documents contain (level 0) -document titles. The solution is to create a top level wrapper -document and use the <code class="literal">leveloffset</code> attribute to push them all down one -level. For example:</p><pre class="screen">Combined Document Title -======================= - -// Push titles down one level. -:leveloffset: 1 - -include::document1.txt[] - -// Return to normal title levels. -:leveloffset: 0 - -A Top Level Section -------------------- -Lorum ipsum. - -// Push titles down one level. -:leveloffset: 1 - -include::document2.txt[] - -include::document3.txt[]</pre><p>The document titles in the included documents will now be processed as -level 1 section titles, level 1 sections as level 2 sections and so -on.</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> -Put a blank line between the <code class="literal">include</code> macro lines to ensure the - title of the included document is not seen as part of the last - paragraph of the previous document. -</li><li class="listitem"> -You won’t want non-title document header lines (for example, Author - and Revision lines) in the included files — conditionally exclude - them if they are necessary for stand-alone processing. -</li></ul></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_processing_document_sections_separately"></a>36.6. Processing document sections separately</h2></div></div></div><p>You have divided your AsciiDoc document into separate files (one per -top level section) which are combined and processed with the following -top level document:</p><pre class="screen">Combined Document Title -======================= -Joe Bloggs -v1.0, 12-Aug-03 - -include::section1.txt[] - -include::section2.txt[] - -include::section3.txt[]</pre><p>You also want to process the section files as separate documents. -This is easy because asciidoc(1) will quite happily process -<code class="literal">section1.txt</code>, <code class="literal">section2.txt</code> and <code class="literal">section3.txt</code> separately — the -resulting output documents contain the section but have no document -title.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_processing_document_snippets"></a>36.7. Processing document snippets</h2></div></div></div><p>Use the <code class="literal">-s</code> (<code class="literal">--no-header-footer</code>) command-line option to suppress -header and footer output, this is useful if the processed output is to -be included in another file. For example:</p><pre class="literallayout">$ asciidoc -sb docbook section1.txt</pre><p>asciidoc(1) can be used as a filter, so you can pipe chunks of text -through it. For example:</p><pre class="literallayout">$ echo 'Hello *World!*' | asciidoc -s - -<div class="paragraph"><p>Hello <strong>World!</strong></p></div></pre></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_badges_in_html_page_footers"></a>36.8. Badges in HTML page footers</h2></div></div></div><p>See the <code class="literal">[footer]</code> section in the AsciiDoc distribution <code class="literal">xhtml11.conf</code> -configuration file.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_pretty_printing_asciidoc_output"></a>36.9. Pretty printing AsciiDoc output</h2></div></div></div><p>If the indentation and layout of the asciidoc(1) output is not to your -liking you can:</p><div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -Change the indentation and layout of configuration file markup - template sections. The <code class="literal">{empty}</code> attribute is useful for outputting - trailing blank lines in markup templates. -</li><li class="listitem"><p class="simpara"> -Use Dave Raggett’s <a class="ulink" href="http://tidy.sourceforge.net/" target="_top">HTML Tidy</a> program - to tidy asciidoc(1) output. Example: -</p><pre class="literallayout">$ asciidoc -b docbook -o - mydoc.txt | tidy -indent -xml >mydoc.xml</pre></li><li class="listitem"><p class="simpara"> -Use the <code class="literal">xmllint(1)</code> format option. Example: -</p><pre class="literallayout">$ xmllint --format mydoc.xml</pre></li></ol></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_supporting_minor_docbook_dtd_variations"></a>36.10. Supporting minor DocBook DTD variations</h2></div></div></div><p>The conditional inclusion of DocBook SGML markup at the end of the -distribution <code class="literal">docbook45.conf</code> file illustrates how to support minor -DTD variations. The included sections override corresponding entries -from preceding sections.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_creating_stand_alone_html_documents"></a>36.11. Creating stand-alone HTML documents</h2></div></div></div><p>If you’ve ever tried to send someone an HTML document that includes -stylesheets and images you’ll know that it’s not as straight-forward -as exchanging a single file. AsciiDoc has options to create -stand-alone documents containing embedded images, stylesheets and -scripts. The following AsciiDoc command creates a single file -containing <a class="link" href="ch21.html#X66" title="Embedding images in XHTML documents">embedded images</a>, CSS stylesheets, and JavaScript -(for table of contents and footnotes):</p><pre class="literallayout">$ asciidoc -a data-uri -a icons -a toc -a max-width=55em article.txt</pre><p>You can view the HTML file here: <a class="ulink" href="https://asciidoc.org/article-standalone.html" target="_top">https://asciidoc.org/article-standalone.html</a></p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_shipping_stand_alone_asciidoc_source"></a>36.12. Shipping stand-alone AsciiDoc source</h2></div></div></div><p>Reproducing presentation documents from someone else’s source has one -major problem: unless your configuration files are the same as the -creator’s you won’t get the same output.</p><p>The solution is to create a single backend specific configuration file -using the asciidoc(1) <code class="literal">-c</code> (<code class="literal">--dump-conf</code>) command-line option. You -then ship this file along with the AsciiDoc source document plus the -<code class="literal">asciidoc.py</code> script. The only end user requirement is that they have -Python installed (and that they consider you a trusted source). This -example creates a composite HTML configuration file for <code class="literal">mydoc.txt</code>:</p><pre class="literallayout">$ asciidoc -cb xhtml11 mydoc.txt > mydoc-xhtml11.conf</pre><p>Ship <code class="literal">mydoc.txt</code>, <code class="literal">mydoc-html.conf</code>, and <code class="literal">asciidoc.py</code>. With -these three files (and a Python interpreter) the recipient can -regenerate the HMTL output:</p><pre class="literallayout">$ ./asciidoc.py -eb xhtml11 mydoc.txt</pre><p>The <code class="literal">-e</code> (<code class="literal">--no-conf</code>) option excludes the use of implicit -configuration files, ensuring that only entries from the -<code class="literal">mydoc-html.conf</code> configuration are used.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_inserting_blank_space"></a>36.13. Inserting blank space</h2></div></div></div><p>Adjust your style sheets to add the correct separation between block -elements. Inserting blank paragraphs containing a single non-breaking -space character <code class="literal">{nbsp}</code> works but is an ad hoc solution compared -to using style sheets.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_closing_open_sections"></a>36.14. Closing open sections</h2></div></div></div><p>You can close off section tags up to level <code class="literal">N</code> by calling the -<code class="literal">eval::[Section.setlevel(N)]</code> system macro. This is useful if you -want to include a section composed of raw markup. The following -example includes a DocBook glossary division at the top section level -(level 0):</p><pre class="screen">ifdef::basebackend-docbook[] - -eval::[Section.setlevel(0)] - -+++++++++++++++++++++++++++++++ -<glossary> - <title>Glossary</title> - <glossdiv> - ... - </glossdiv> -</glossary> -+++++++++++++++++++++++++++++++ -endif::basebackend-docbook[]</pre></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_validating_output_files"></a>36.15. Validating output files</h2></div></div></div><p>Use <code class="literal">xmllint(1)</code> to check the AsciiDoc generated markup is both well -formed and valid. Here are some examples:</p><pre class="literallayout">$ xmllint --nonet --noout --valid docbook-file.xml -$ xmllint --nonet --noout --valid xhtml11-file.html -$ xmllint --nonet --noout --valid --html html4-file.html</pre><p>The <code class="literal">--valid</code> option checks the file is valid against the document -type’s DTD, if the DTD is not installed in your system’s catalog then -it will be fetched from its Internet location. If you omit the -<code class="literal">--valid</code> option the document will only be checked that it is well -formed.</p><p>The online <a class="ulink" href="http://validator.w3.org/#validate_by_uri+with_options" target="_top">W3C -Markup Validation Service</a> is the defacto standard when it comes to -validating HTML (it validates all HTML standards including HTML5).</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch35.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="go01.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/icons/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
\ No newline at end of file diff --git a/chunked/docbook-xsl.css b/chunked/docbook-xsl.css deleted file mode 100644 index ee9ca46..0000000 --- a/chunked/docbook-xsl.css +++ /dev/null @@ -1,329 +0,0 @@ -/* - CSS stylesheet for XHTML produced by DocBook XSL stylesheets. -*/ - -body { - font-family: Georgia,serif; -} - -code, pre { - font-family: "Courier New", Courier, monospace; -} - -span.strong { - font-weight: bold; -} - -body blockquote { - margin-top: .75em; - line-height: 1.5; - margin-bottom: .75em; -} - -html body { - margin: 1em 5% 1em 5%; - line-height: 1.2; -} - -body div { - margin: 0; -} - -h1, h2, h3, h4, h5, h6 -{ - color: #527bbd; - font-family: Arial,Helvetica,sans-serif; -} - -div.toc p:first-child, -div.list-of-figures p:first-child, -div.list-of-tables p:first-child, -div.list-of-examples p:first-child, -div.example p.title, -div.sidebar p.title -{ - font-weight: bold; - color: #527bbd; - font-family: Arial,Helvetica,sans-serif; - margin-bottom: 0.2em; -} - -body h1 { - margin: .0em 0 0 -4%; - line-height: 1.3; - border-bottom: 2px solid silver; -} - -body h2 { - margin: 0.5em 0 0 -4%; - line-height: 1.3; - border-bottom: 2px solid silver; -} - -body h3 { - margin: .8em 0 0 -3%; - line-height: 1.3; -} - -body h4 { - margin: .8em 0 0 -3%; - line-height: 1.3; -} - -body h5 { - margin: .8em 0 0 -2%; - line-height: 1.3; -} - -body h6 { - margin: .8em 0 0 -1%; - line-height: 1.3; -} - -body hr { - border: none; /* Broken on IE6 */ -} -div.footnotes hr { - border: 1px solid silver; -} - -div.navheader th, div.navheader td, div.navfooter td { - font-family: Arial,Helvetica,sans-serif; - font-size: 0.9em; - font-weight: bold; - color: #527bbd; -} -div.navheader img, div.navfooter img { - border-style: none; -} -div.navheader a, div.navfooter a { - font-weight: normal; -} -div.navfooter hr { - border: 1px solid silver; -} - -body td { - line-height: 1.2 -} - -body th { - line-height: 1.2; -} - -ol { - line-height: 1.2; -} - -ul, body dir, body menu { - line-height: 1.2; -} - -html { - margin: 0; - padding: 0; -} - -body h1, body h2, body h3, body h4, body h5, body h6 { - margin-left: 0 -} - -body pre { - margin: 0.5em 10% 0.5em 1em; - line-height: 1.0; - color: navy; -} - -tt.literal, code.literal { - color: navy; -} - -.programlisting, .screen { - border: 1px solid silver; - background: #f4f4f4; - margin: 0.5em 10% 0.5em 0; - padding: 0.5em 1em; -} - -div.sidebar { - background: #ffffee; - margin: 1.0em 10% 0.5em 0; - padding: 0.5em 1em; - border: 1px solid silver; -} -div.sidebar * { padding: 0; } -div.sidebar div { margin: 0; } -div.sidebar p.title { - margin-top: 0.5em; - margin-bottom: 0.2em; -} - -div.bibliomixed { - margin: 0.5em 5% 0.5em 1em; -} - -div.glossary dt { - font-weight: bold; -} -div.glossary dd p { - margin-top: 0.2em; -} - -dl { - margin: .8em 0; - line-height: 1.2; -} - -dt { - margin-top: 0.5em; -} - -dt span.term { - font-style: normal; - color: navy; -} - -div.variablelist dd p { - margin-top: 0; -} - -div.itemizedlist li, div.orderedlist li { - margin-left: -0.8em; - margin-top: 0.5em; -} - -ul, ol { - list-style-position: outside; -} - -div.sidebar ul, div.sidebar ol { - margin-left: 2.8em; -} - -div.itemizedlist p.title, -div.orderedlist p.title, -div.variablelist p.title -{ - margin-bottom: -0.8em; -} - -div.revhistory table { - border-collapse: collapse; - border: none; -} -div.revhistory th { - border: none; - color: #527bbd; - font-family: Arial,Helvetica,sans-serif; -} -div.revhistory td { - border: 1px solid silver; -} - -/* Keep TOC and index lines close together. */ -div.toc dl, div.toc dt, -div.list-of-figures dl, div.list-of-figures dt, -div.list-of-tables dl, div.list-of-tables dt, -div.indexdiv dl, div.indexdiv dt -{ - line-height: normal; - margin-top: 0; - margin-bottom: 0; -} - -/* - Table styling does not work because of overriding attributes in - generated HTML. -*/ -div.table table, -div.informaltable table -{ - margin-left: 0; - margin-right: 5%; - margin-bottom: 0.8em; -} -div.informaltable table -{ - margin-top: 0.4em -} -div.table thead, -div.table tfoot, -div.table tbody, -div.informaltable thead, -div.informaltable tfoot, -div.informaltable tbody -{ - /* No effect in IE6. */ - border-top: 3px solid #527bbd; - border-bottom: 3px solid #527bbd; -} -div.table thead, div.table tfoot, -div.informaltable thead, div.informaltable tfoot -{ - font-weight: bold; -} - -div.mediaobject img { - margin-bottom: 0.8em; -} -div.figure p.title, -div.table p.title -{ - margin-top: 1em; - margin-bottom: 0.4em; -} - -div.calloutlist p -{ - margin-top: 0em; - margin-bottom: 0.4em; -} - -a img { - border-style: none; -} - -@media print { - div.navheader, div.navfooter { display: none; } -} - -span.aqua { color: aqua; } -span.black { color: black; } -span.blue { color: blue; } -span.fuchsia { color: fuchsia; } -span.gray { color: gray; } -span.green { color: green; } -span.lime { color: lime; } -span.maroon { color: maroon; } -span.navy { color: navy; } -span.olive { color: olive; } -span.purple { color: purple; } -span.red { color: red; } -span.silver { color: silver; } -span.teal { color: teal; } -span.white { color: white; } -span.yellow { color: yellow; } - -span.aqua-background { background: aqua; } -span.black-background { background: black; } -span.blue-background { background: blue; } -span.fuchsia-background { background: fuchsia; } -span.gray-background { background: gray; } -span.green-background { background: green; } -span.lime-background { background: lime; } -span.maroon-background { background: maroon; } -span.navy-background { background: navy; } -span.olive-background { background: olive; } -span.purple-background { background: purple; } -span.red-background { background: red; } -span.silver-background { background: silver; } -span.teal-background { background: teal; } -span.white-background { background: white; } -span.yellow-background { background: yellow; } - -span.big { font-size: 2em; } -span.small { font-size: 0.6em; } - -span.underline { text-decoration: underline; } -span.overline { text-decoration: overline; } -span.line-through { text-decoration: line-through; } diff --git a/chunked/go01.html b/chunked/go01.html deleted file mode 100644 index 32dda23..0000000 --- a/chunked/go01.html +++ /dev/null @@ -1,23 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Glossary</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="AsciiDoc User Guide" /><link rel="up" href="index.html" title="AsciiDoc User Guide" /><link rel="prev" href="ch36.html" title="Chapter 36. Tips and Tricks" /><link rel="next" href="apa.html" title="Appendix A. Migration Notes" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="ch36.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="apa.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="glossary"><div class="titlepage"><div><div><h1 class="title"><a id="_glossary"></a>Glossary</h1></div></div></div><dl><dt><span class="glossterm"> -<a id="X8"></a> Block element -</span></dt><dd class="glossdef"><p> - An AsciiDoc block element is a document entity composed of one or - more whole lines of text. -</p></dd><dt><span class="glossterm"> -<a id="X34"></a> Inline element -</span></dt><dd class="glossdef"><p> - AsciiDoc inline elements occur within block element textual - content, they perform formatting and substitution tasks. -</p></dd><dt><span class="glossterm"> -Formal element -</span></dt><dd class="glossdef"><p> - An AsciiDoc block element that has a BlockTitle. Formal elements - are normally listed in front or back matter, for example lists of - tables, examples and figures. -</p></dd><dt><span class="glossterm"> -Verbatim element -</span></dt><dd class="glossdef"><p> - The word verbatim indicates that white space and line breaks in - the source document are to be preserved in the output document. -</p></dd></dl></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch36.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="apa.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/icons/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
\ No newline at end of file diff --git a/chunked/images/icons/callouts/1.png b/chunked/images/icons/callouts/1.png Binary files differdeleted file mode 100644 index 7d47343..0000000 --- a/chunked/images/icons/callouts/1.png +++ /dev/null diff --git a/chunked/images/icons/callouts/2.png b/chunked/images/icons/callouts/2.png Binary files differdeleted file mode 100644 index 5d09341..0000000 --- a/chunked/images/icons/callouts/2.png +++ /dev/null diff --git a/chunked/images/icons/callouts/3.png b/chunked/images/icons/callouts/3.png Binary files differdeleted file mode 100644 index ef7b700..0000000 --- a/chunked/images/icons/callouts/3.png +++ /dev/null diff --git a/chunked/images/icons/callouts/4.png b/chunked/images/icons/callouts/4.png Binary files differdeleted file mode 100644 index adb8364..0000000 --- a/chunked/images/icons/callouts/4.png +++ /dev/null diff --git a/chunked/images/icons/callouts/5.png b/chunked/images/icons/callouts/5.png Binary files differdeleted file mode 100644 index 4d7eb46..0000000 --- a/chunked/images/icons/callouts/5.png +++ /dev/null diff --git a/chunked/images/icons/home.png b/chunked/images/icons/home.png Binary files differdeleted file mode 100644 index 37a5231..0000000 --- a/chunked/images/icons/home.png +++ /dev/null diff --git a/chunked/images/icons/next.png b/chunked/images/icons/next.png Binary files differdeleted file mode 100644 index 64e126b..0000000 --- a/chunked/images/icons/next.png +++ /dev/null diff --git a/chunked/images/icons/note.png b/chunked/images/icons/note.png Binary files differdeleted file mode 100644 index 7c1f3e2..0000000 --- a/chunked/images/icons/note.png +++ /dev/null diff --git a/chunked/images/icons/prev.png b/chunked/images/icons/prev.png Binary files differdeleted file mode 100644 index 3e8f12f..0000000 --- a/chunked/images/icons/prev.png +++ /dev/null diff --git a/chunked/images/icons/tip.png b/chunked/images/icons/tip.png Binary files differdeleted file mode 100644 index f087c73..0000000 --- a/chunked/images/icons/tip.png +++ /dev/null diff --git a/chunked/images/icons/warning.png b/chunked/images/icons/warning.png Binary files differdeleted file mode 100644 index d41edb9..0000000 --- a/chunked/images/icons/warning.png +++ /dev/null diff --git a/chunked/index.html b/chunked/index.html deleted file mode 100644 index f610a84..0000000 --- a/chunked/index.html +++ /dev/null @@ -1,2 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>AsciiDoc User Guide</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="AsciiDoc User Guide" /><link rel="next" href="pr01.html" title="" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="pr01.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr></table><hr /></div><div xml:lang="en" class="book" lang="en"><div class="titlepage"><div><div><h1 class="title"><a id="idm1"></a>AsciiDoc User Guide</h1></div><div><div class="author"><h3 class="author"><span class="firstname">Stuart</span> <span class="surname">Rackham</span></h3><code class="email"><<a class="email" href="mailto:srackham@gmail.com">srackham@gmail.com</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl class="toc"><dt><span class="preface"><a href="pr01.html"></a></span></dt><dt><span class="chapter"><a href="ch01.html">1. Introduction</a></span></dt><dt><span class="chapter"><a href="ch02.html">2. Getting Started</a></span></dt><dd><dl><dt><span class="section"><a href="ch02.html#_installing_asciidoc">2.1. Installing AsciiDoc</a></span></dt><dt><span class="section"><a href="ch02.html#X11">2.2. Example AsciiDoc Documents</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch03.html">3. AsciiDoc Document Types</a></span></dt><dd><dl><dt><span class="section"><a href="ch03.html#_article">3.1. article</a></span></dt><dt><span class="section"><a href="ch03.html#_book">3.2. book</a></span></dt><dt><span class="section"><a href="ch03.html#_manpage">3.3. manpage</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch04.html">4. AsciiDoc Backends</a></span></dt><dd><dl><dt><span class="section"><a href="ch04.html#_backend_aliases">4.1. Backend Aliases</a></span></dt><dt><span class="section"><a href="ch04.html#X100">4.2. Backend Plugins</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch05.html">5. DocBook</a></span></dt><dd><dl><dt><span class="section"><a href="ch05.html#X12">5.1. Converting DocBook to other file formats</a></span></dt><dt><span class="section"><a href="ch05.html#X43">5.2. a2x Toolchain Wrapper</a></span></dt><dt><span class="section"><a href="ch05.html#_html_generation">5.3. HTML generation</a></span></dt><dt><span class="section"><a href="ch05.html#_pdf_generation">5.4. PDF generation</a></span></dt><dt><span class="section"><a href="ch05.html#_html_help_generation">5.5. HTML Help generation</a></span></dt><dt><span class="section"><a href="ch05.html#_toolchain_components_summary">5.6. Toolchain components summary</a></span></dt><dt><span class="section"><a href="ch05.html#_asciidoc_dblatex_configuration_files">5.7. AsciiDoc dblatex configuration files</a></span></dt><dt><span class="section"><a href="ch05.html#_asciidoc_docbook_xsl_stylesheets_drivers">5.8. AsciiDoc DocBook XSL Stylesheets drivers</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch06.html">6. Generating Plain Text Files</a></span></dt><dt><span class="chapter"><a href="ch07.html">7. HTML5 and XHTML 1.1</a></span></dt><dd><dl><dt><span class="section"><a href="ch07.html#X99">7.1. Themes</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch08.html">8. Document Structure</a></span></dt><dd><dl><dt><span class="section"><a href="ch08.html#_block_elements">8.1. Block Elements</a></span></dt><dt><span class="section"><a href="ch08.html#X95">8.2. Header</a></span></dt><dt><span class="section"><a href="ch08.html#X86">8.3. Preamble</a></span></dt><dt><span class="section"><a href="ch08.html#_sections">8.4. Sections</a></span></dt><dt><span class="section"><a href="ch08.html#_inline_elements">8.5. Inline Elements</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch09.html">9. Document Processing</a></span></dt><dt><span class="chapter"><a href="ch10.html">10. Text Formatting</a></span></dt><dd><dl><dt><span class="section"><a href="ch10.html#X51">10.1. Quoted Text</a></span></dt><dt><span class="section"><a href="ch10.html#_superscripts_and_subscripts">10.2. Superscripts and Subscripts</a></span></dt><dt><span class="section"><a href="ch10.html#_line_breaks">10.3. Line Breaks</a></span></dt><dt><span class="section"><a href="ch10.html#_page_breaks">10.4. Page Breaks</a></span></dt><dt><span class="section"><a href="ch10.html#_rulers">10.5. Rulers</a></span></dt><dt><span class="section"><a href="ch10.html#_tabs">10.6. Tabs</a></span></dt><dt><span class="section"><a href="ch10.html#_replacements">10.7. Replacements</a></span></dt><dt><span class="section"><a href="ch10.html#_special_words">10.8. Special Words</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch11.html">11. Titles</a></span></dt><dd><dl><dt><span class="section"><a href="ch11.html#_two_line_titles">11.1. Two line titles</a></span></dt><dt><span class="section"><a href="ch11.html#X46">11.2. One line titles</a></span></dt><dt><span class="section"><a href="ch11.html#_floating_titles">11.3. Floating titles</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch12.html">12. Block Titles</a></span></dt><dt><span class="chapter"><a href="ch13.html">13. BlockId Element</a></span></dt><dt><span class="chapter"><a href="ch14.html">14. AttributeList Element</a></span></dt><dd><dl><dt><span class="section"><a href="ch14.html#_attribute_value_substitution">14.1. Attribute value substitution</a></span></dt><dt><span class="section"><a href="ch14.html#_common_attributes">14.2. Common attributes</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch15.html">15. Paragraphs</a></span></dt><dd><dl><dt><span class="section"><a href="ch15.html#_normal_paragraph_syntax">15.1. normal paragraph syntax</a></span></dt><dt><span class="section"><a href="ch15.html#X85">15.2. literal paragraph syntax</a></span></dt><dt><span class="section"><a href="ch15.html#X94">15.3. quote and verse paragraph styles</a></span></dt><dt><span class="section"><a href="ch15.html#X28">15.4. Admonition Paragraphs</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch16.html">16. Delimited Blocks</a></span></dt><dd><dl><dt><span class="section"><a href="ch16.html#_predefined_delimited_blocks">16.1. Predefined Delimited Blocks</a></span></dt><dt><span class="section"><a href="ch16.html#_listing_blocks">16.2. Listing Blocks</a></span></dt><dt><span class="section"><a href="ch16.html#X65">16.3. Literal Blocks</a></span></dt><dt><span class="section"><a href="ch16.html#_sidebar_blocks">16.4. Sidebar Blocks</a></span></dt><dt><span class="section"><a href="ch16.html#X26">16.5. Comment Blocks</a></span></dt><dt><span class="section"><a href="ch16.html#X76">16.6. Passthrough Blocks</a></span></dt><dt><span class="section"><a href="ch16.html#_quote_blocks">16.7. Quote Blocks</a></span></dt><dt><span class="section"><a href="ch16.html#X48">16.8. Example Blocks</a></span></dt><dt><span class="section"><a href="ch16.html#X22">16.9. Admonition Blocks</a></span></dt><dt><span class="section"><a href="ch16.html#X29">16.10. Open Blocks</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch17.html">17. Lists</a></span></dt><dd><dl><dt><span class="section"><a href="ch17.html#_bulleted_lists">17.1. Bulleted Lists</a></span></dt><dt><span class="section"><a href="ch17.html#_numbered_lists">17.2. Numbered Lists</a></span></dt><dt><span class="section"><a href="ch17.html#_labeled_lists">17.3. Labeled Lists</a></span></dt><dt><span class="section"><a href="ch17.html#_question_and_answer_lists">17.4. Question and Answer Lists</a></span></dt><dt><span class="section"><a href="ch17.html#_glossary_lists">17.5. Glossary Lists</a></span></dt><dt><span class="section"><a href="ch17.html#_bibliography_lists">17.6. Bibliography Lists</a></span></dt><dt><span class="section"><a href="ch17.html#X15">17.7. List Item Continuation</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch18.html">18. Footnotes</a></span></dt><dt><span class="chapter"><a href="ch19.html">19. Indexes</a></span></dt><dt><span class="chapter"><a href="ch20.html">20. Callouts</a></span></dt><dd><dl><dt><span class="section"><a href="ch20.html#_implementation_notes">20.1. Implementation Notes</a></span></dt><dt><span class="section"><a href="ch20.html#_including_callouts_in_included_code">20.2. Including callouts in included code</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch21.html">21. Macros</a></span></dt><dd><dl><dt><span class="section"><a href="ch21.html#_inline_macros">21.1. Inline Macros</a></span></dt><dt><span class="section"><a href="ch21.html#_block_macros">21.2. Block Macros</a></span></dt><dt><span class="section"><a href="ch21.html#_system_macros">21.3. System Macros</a></span></dt><dt><span class="section"><a href="ch21.html#X77">21.4. Passthrough macros</a></span></dt><dt><span class="section"><a href="ch21.html#_macro_definitions">21.5. Macro Definitions</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch22.html">22. HTML 5 audio and video block macros</a></span></dt><dt><span class="chapter"><a href="ch23.html">23. Tables</a></span></dt><dd><dl><dt><span class="section"><a href="ch23.html#_example_tables">23.1. Example tables</a></span></dt><dt><span class="section"><a href="ch23.html#X68">23.2. Table input data formats</a></span></dt><dt><span class="section"><a href="ch23.html#X69">23.3. Table attributes</a></span></dt><dt><span class="section"><a href="ch23.html#X70">23.4. Column Specifiers</a></span></dt><dt><span class="section"><a href="ch23.html#X84">23.5. Cell Specifiers</a></span></dt><dt><span class="section"><a href="ch23.html#X71">23.6. Table styles</a></span></dt><dt><span class="section"><a href="ch23.html#X72">23.7. Markup attributes</a></span></dt><dt><span class="section"><a href="ch23.html#_nested_tables">23.8. Nested tables</a></span></dt><dt><span class="section"><a href="ch23.html#X83">23.9. DocBook table limitations</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch24.html">24. Manpage Documents</a></span></dt><dd><dl><dt><span class="section"><a href="ch24.html#_document_header">24.1. Document Header</a></span></dt><dt><span class="section"><a href="ch24.html#_the_name_section">24.2. The NAME Section</a></span></dt><dt><span class="section"><a href="ch24.html#_the_synopsis_section">24.3. The SYNOPSIS Section</a></span></dt><dt><span class="section"><a href="ch24.html#_refmiscinfo_attributes">24.4. refmiscinfo attributes</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch25.html">25. Mathematical Formulas</a></span></dt><dd><dl><dt><span class="section"><a href="ch25.html#_latex_math">25.1. LaTeX Math</a></span></dt><dt><span class="section"><a href="ch25.html#_mathjax">25.2. MathJax</a></span></dt><dt><span class="section"><a href="ch25.html#_latexmathml">25.3. LaTeXMathML</a></span></dt><dt><span class="section"><a href="ch25.html#_asciimathml">25.4. ASCIIMathML</a></span></dt><dt><span class="section"><a href="ch25.html#_mathml">25.5. MathML</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch26.html">26. Configuration Files</a></span></dt><dd><dl><dt><span class="section"><a href="ch26.html#_configuration_file_format">26.1. Configuration File Format</a></span></dt><dt><span class="section"><a href="ch26.html#_miscellaneous_section">26.2. Miscellaneous section</a></span></dt><dt><span class="section"><a href="ch26.html#_titles_section">26.3. Titles section</a></span></dt><dt><span class="section"><a href="ch26.html#_tags_section">26.4. Tags section</a></span></dt><dt><span class="section"><a href="ch26.html#_attributes_section">26.5. Attributes section</a></span></dt><dt><span class="section"><a href="ch26.html#_special_characters_section">26.6. Special Characters section</a></span></dt><dt><span class="section"><a href="ch26.html#_quoted_text_section">26.7. Quoted Text section</a></span></dt><dt><span class="section"><a href="ch26.html#_special_words_section">26.8. Special Words section</a></span></dt><dt><span class="section"><a href="ch26.html#X10">26.9. Replacements section</a></span></dt><dt><span class="section"><a href="ch26.html#_markup_template_sections">26.10. Markup Template Sections</a></span></dt><dt><span class="section"><a href="ch26.html#X27">26.11. Configuration file names, precedence and locations</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch27.html">27. Document Attributes</a></span></dt><dt><span class="chapter"><a href="ch28.html">28. Attribute Entries</a></span></dt><dd><dl><dt><span class="section"><a href="ch28.html#_setting_configuration_entries">28.1. Setting configuration entries</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch29.html">29. Attribute Lists</a></span></dt><dd><dl><dt><span class="section"><a href="ch29.html#X75">29.1. Options attribute</a></span></dt><dt><span class="section"><a href="ch29.html#_macro_attribute_lists">29.2. Macro Attribute lists</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch30.html">30. Attribute References</a></span></dt><dd><dl><dt><span class="section"><a href="ch30.html#_simple_attributes_references">30.1. Simple Attributes References</a></span></dt><dt><span class="section"><a href="ch30.html#_conditional_attribute_references">30.2. Conditional Attribute References</a></span></dt><dt><span class="section"><a href="ch30.html#X24">30.3. System Attribute References</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch31.html">31. Intrinsic Attributes</a></span></dt><dt><span class="chapter"><a href="ch32.html">32. Block Element Definitions</a></span></dt><dd><dl><dt><span class="section"><a href="ch32.html#X23">32.1. Styles</a></span></dt><dt><span class="section"><a href="ch32.html#_paragraphs_2">32.2. Paragraphs</a></span></dt><dt><span class="section"><a href="ch32.html#_delimited_blocks">32.3. Delimited Blocks</a></span></dt><dt><span class="section"><a href="ch32.html#_lists">32.4. Lists</a></span></dt><dt><span class="section"><a href="ch32.html#_tables_2">32.5. Tables</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch33.html">33. Filters</a></span></dt><dd><dl><dt><span class="section"><a href="ch33.html#_filter_search_paths">33.1. Filter Search Paths</a></span></dt><dt><span class="section"><a href="ch33.html#_filter_configuration_files">33.2. Filter Configuration Files</a></span></dt><dt><span class="section"><a href="ch33.html#X56">33.3. Example Filter</a></span></dt><dt><span class="section"><a href="ch33.html#_built_in_filters">33.4. Built-in filters</a></span></dt><dt><span class="section"><a href="ch33.html#X58">33.5. Filter plugins</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch34.html">34. Plugins</a></span></dt><dt><span class="chapter"><a href="ch35.html">35. Help Commands</a></span></dt><dd><dl><dt><span class="section"><a href="ch35.html#_customizing_help">35.1. Customizing Help</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch36.html">36. Tips and Tricks</a></span></dt><dd><dl><dt><span class="section"><a href="ch36.html#_know_your_editor">36.1. Know Your Editor</a></span></dt><dt><span class="section"><a href="ch36.html#X20">36.2. Vim Commands for Formatting AsciiDoc</a></span></dt><dt><span class="section"><a href="ch36.html#_troubleshooting">36.3. Troubleshooting</a></span></dt><dt><span class="section"><a href="ch36.html#_gotchas">36.4. Gotchas</a></span></dt><dt><span class="section"><a href="ch36.html#X90">36.5. Combining separate documents</a></span></dt><dt><span class="section"><a href="ch36.html#_processing_document_sections_separately">36.6. Processing document sections separately</a></span></dt><dt><span class="section"><a href="ch36.html#_processing_document_snippets">36.7. Processing document snippets</a></span></dt><dt><span class="section"><a href="ch36.html#_badges_in_html_page_footers">36.8. Badges in HTML page footers</a></span></dt><dt><span class="section"><a href="ch36.html#_pretty_printing_asciidoc_output">36.9. Pretty printing AsciiDoc output</a></span></dt><dt><span class="section"><a href="ch36.html#_supporting_minor_docbook_dtd_variations">36.10. Supporting minor DocBook DTD variations</a></span></dt><dt><span class="section"><a href="ch36.html#_creating_stand_alone_html_documents">36.11. Creating stand-alone HTML documents</a></span></dt><dt><span class="section"><a href="ch36.html#_shipping_stand_alone_asciidoc_source">36.12. Shipping stand-alone AsciiDoc source</a></span></dt><dt><span class="section"><a href="ch36.html#_inserting_blank_space">36.13. Inserting blank space</a></span></dt><dt><span class="section"><a href="ch36.html#_closing_open_sections">36.14. Closing open sections</a></span></dt><dt><span class="section"><a href="ch36.html#_validating_output_files">36.15. Validating output files</a></span></dt></dl></dd><dt><span class="glossary"><a href="go01.html">Glossary</a></span></dt><dt><span class="appendix"><a href="apa.html">A. Migration Notes</a></span></dt><dd><dl><dt><span class="section"><a href="apa.html#X53">A.1. Version 7 to version 8</a></span></dt></dl></dd><dt><span class="appendix"><a href="apb.html">B. Packager Notes</a></span></dt><dt><span class="appendix"><a href="apc.html">C. AsciiDoc Safe Mode</a></span></dt><dt><span class="appendix"><a href="apd.html">D. Using AsciiDoc with non-English Languages</a></span></dt><dt><span class="appendix"><a href="ape.html">E. Vim Syntax Highlighter</a></span></dt><dt><span class="appendix"><a href="apf.html">F. Attribute Options</a></span></dt><dt><span class="appendix"><a href="apg.html">G. Diagnostics</a></span></dt><dt><span class="appendix"><a href="aph.html">H. Backend Attributes</a></span></dt><dt><span class="appendix"><a href="api.html">I. License</a></span></dt></dl></div><div class="list-of-tables"><p><strong>List of Tables</strong></p><dl><dt>7.1. <a href="ch07.html#idm414">Stylesheet file locations</a></dt><dt>7.2. <a href="ch07.html#idm444">JavaScript file locations</a></dt><dt>16.1. <a href="ch16.html#idm1337">Default DelimitedBlock substitutions</a></dt><dt>22.1. <a href="ch22.html#idm2641">Audio macro attributes</a></dt><dt>22.2. <a href="ch22.html#idm2661">Video macro attributes</a></dt><dt>23.1. <a href="ch23.html#idm2722">Simple table</a></dt><dt>23.2. <a href="ch23.html#idm2754">Columns formatted with strong, monospaced and emphasis styles</a></dt><dt>23.3. <a href="ch23.html#idm2820">Horizontal and vertical source data</a></dt><dt>23.4. <a href="ch23.html#idm2866">A table with externally sourced CSV data</a></dt><dt>23.5. <a href="ch23.html#idm2985">Cell spans, alignments and styles</a></dt><dt>33.1. <a href="ch33.html#idm4841">Built-in filters list</a></dt></dl></div><div class="list-of-examples"><p><strong>List of Examples</strong></p><dl><dt>16.1. <a href="ch16.html#idm1570">An example</a></dt></dl></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="pr01.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr></table></div></body></html>
\ No newline at end of file diff --git a/chunked/pr01.html b/chunked/pr01.html deleted file mode 100644 index 654f3b6..0000000 --- a/chunked/pr01.html +++ /dev/null @@ -1,10 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title></title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="AsciiDoc User Guide" /><link rel="up" href="index.html" title="AsciiDoc User Guide" /><link rel="prev" href="index.html" title="AsciiDoc User Guide" /><link rel="next" href="ch01.html" title="Chapter 1. Introduction" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="index.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch01.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="preface"><div class="titlepage"><div><div><h1 class="title"><a id="idm9"></a></h1></div></div></div><p>AsciiDoc is a text document format for writing notes, documentation, -articles, books, ebooks, slideshows, web pages, blogs and UNIX man -pages. AsciiDoc files can be translated to many formats including -HTML, PDF, EPUB, man page. AsciiDoc is highly configurable: both the -AsciiDoc source file syntax and the backend output markups (which can -be almost any type of SGML/XML markup) can be customized and extended -by the user.</p><div class="sidebar"><div class="titlepage"><div><div><p class="title"><strong>This document</strong></p></div></div></div><p>This is an overly large document, it probably needs to be refactored -into a Tutorial, Quick Reference and Formal Reference.</p><p>If you’re new to AsciiDoc read this section and the <a class="link" href="ch02.html" title="Chapter 2. Getting Started">Getting Started</a> section and take a look at the example AsciiDoc (<code class="literal">*.txt</code>) -source files in the distribution <code class="literal">doc</code> directory.</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="index.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch01.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/icons/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
\ No newline at end of file diff --git a/epub-notes.html b/epub-notes.html index 657fdc7..adaf5d3 100644 --- a/epub-notes.html +++ b/epub-notes.html @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<meta name="generator" content="AsciiDoc 9.0.5" />
+<meta name="generator" content="AsciiDoc 10.0.0a1" />
<title>AsciiDoc EPUB Notes</title>
<link rel="stylesheet" href="./asciidoc.css" type="text/css" />
<link rel="stylesheet" href="./layout2.css" type="text/css" />
@@ -271,7 +271,7 @@ will emit errors like “extra field length for first filename must be <div id="footer">
<div id="footer-text">
Version 9.0.5<br />
-Last updated 2021-01-27 22:27:43 UTC<br />
+Last updated 2021-01-28 21:51:50 UTC<br />
AsciiDoc is a trademark of the Eclipse Foundation, Inc.
</div>
<div id="footer-badges">
@@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<meta name="generator" content="AsciiDoc 9.0.5" />
+<meta name="generator" content="AsciiDoc 10.0.0a1" />
<title>AsciiDoc Frequently Asked Questions</title>
<link rel="stylesheet" href="./asciidoc.css" type="text/css" />
<link rel="stylesheet" href="./layout2.css" type="text/css" />
@@ -1809,7 +1809,7 @@ by Dan Allen</a>.</p></div> <div id="footer">
<div id="footer-text">
Version 9.0.5<br />
-Last updated 2021-01-27 22:27:43 UTC<br />
+Last updated 2021-01-28 21:51:50 UTC<br />
AsciiDoc is a trademark of the Eclipse Foundation, Inc.
</div>
<div id="footer-badges">
@@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<meta name="generator" content="AsciiDoc 9.0.5" />
+<meta name="generator" content="AsciiDoc 10.0.0a1" />
<meta name="description" content="AsciiDoc is a text document format for writing notes, documentation, articles, books, ebooks, slideshows, web pages, man pages and blogs. AsciiDoc files can be translated to many formats including HTML, PDF, EPUB, man page." />
<meta name="keywords" content="AsciiDoc, DocBook, EPUB, PDF, ebooks, slideshow, slidy, man page" />
<title>AsciiDoc Home Page</title>
@@ -907,7 +907,7 @@ Include documentation updates if you’re up to it; otherwise insert <div id="footer">
<div id="footer-text">
Version 9.0.5<br />
-Last updated 2021-01-27 22:27:44 UTC<br />
+Last updated 2021-01-28 21:51:51 UTC<br />
AsciiDoc is a trademark of the Eclipse Foundation, Inc.
</div>
<div id="footer-badges">
diff --git a/latex-backend.html b/latex-backend.html index 84514cc..03f97cd 100644 --- a/latex-backend.html +++ b/latex-backend.html @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<meta name="generator" content="AsciiDoc 9.0.5" />
+<meta name="generator" content="AsciiDoc 10.0.0a1" />
<title>LaTeX backend for Asciidoc</title>
<link rel="stylesheet" href="./asciidoc.css" type="text/css" />
<link rel="stylesheet" href="./layout2.css" type="text/css" />
@@ -555,7 +555,7 @@ Option for switching titlepage on and off <div id="footer">
<div id="footer-text">
Version 9.0.5<br />
-Last updated 2021-01-27 22:27:44 UTC<br />
+Last updated 2021-01-28 21:51:51 UTC<br />
AsciiDoc is a trademark of the Eclipse Foundation, Inc.
</div>
<div id="footer-badges">
diff --git a/latex-bugs.html b/latex-bugs.html index ece15a4..e8b77cb 100644 --- a/latex-bugs.html +++ b/latex-bugs.html @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<meta name="generator" content="AsciiDoc 9.0.5" />
+<meta name="generator" content="AsciiDoc 10.0.0a1" />
<title>Bugs in asciidoc latex backend</title>
<link rel="stylesheet" href="./asciidoc.css" type="text/css" />
<link rel="stylesheet" href="./layout2.css" type="text/css" />
@@ -405,7 +405,7 @@ Wait until this bug is fixed? <div id="footer">
<div id="footer-text">
Version 9.0.5<br />
-Last updated 2021-01-27 22:27:45 UTC<br />
+Last updated 2021-01-28 21:51:52 UTC<br />
AsciiDoc is a trademark of the Eclipse Foundation, Inc.
</div>
<div id="footer-badges">
diff --git a/latex-filter.html b/latex-filter.html index e0cbb04..975e8fb 100644 --- a/latex-filter.html +++ b/latex-filter.html @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<meta name="generator" content="AsciiDoc 9.0.5" />
+<meta name="generator" content="AsciiDoc 10.0.0a1" />
<title>LaTeX Filter</title>
<link rel="stylesheet" href="./asciidoc.css" type="text/css" />
<link rel="stylesheet" href="./layout2.css" type="text/css" />
@@ -272,7 +272,7 @@ The <code>asciidoc(1)</code> input and output files cannot both be <code>-</code <div id="footer">
<div id="footer-text">
Version 9.0.5<br />
-Last updated 2021-01-27 22:27:45 UTC<br />
+Last updated 2021-01-28 21:51:52 UTC<br />
AsciiDoc is a trademark of the Eclipse Foundation, Inc.
</div>
<div id="footer-badges">
diff --git a/latexmath.html b/latexmath.html index eabbb16..49027f3 100644 --- a/latexmath.html +++ b/latexmath.html @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<meta name="generator" content="AsciiDoc 9.0.5" />
+<meta name="generator" content="AsciiDoc 10.0.0a1" />
<title>Embedding LaTeX Math in AsciiDoc dblatex documents</title>
<link rel="stylesheet" href="./asciidoc.css" type="text/css" />
<link rel="stylesheet" href="./layout2.css" type="text/css" />
@@ -161,7 +161,7 @@ passthrough delimited block.</p></div> <div id="footer">
<div id="footer-text">
Version 9.0.5<br />
-Last updated 2021-01-27 22:27:46 UTC<br />
+Last updated 2021-01-28 21:51:53 UTC<br />
AsciiDoc is a trademark of the Eclipse Foundation, Inc.
</div>
<div id="footer-badges">
diff --git a/latexmathml.html b/latexmathml.html index a556801..7c350bd 100644 --- a/latexmathml.html +++ b/latexmathml.html @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<meta name="generator" content="AsciiDoc 9.0.5" />
+<meta name="generator" content="AsciiDoc 10.0.0a1" />
<title>LaTeXMathML Formulae</title>
<link rel="stylesheet" href="./asciidoc.css" type="text/css" />
<link rel="stylesheet" href="./layout2.css" type="text/css" />
@@ -104,7 +104,7 @@ $\displaystyle{ V_i = C_0 - C_3 <div id="footer">
<div id="footer-text">
Version 9.0.5<br />
-Last updated 2021-01-27 22:27:46 UTC<br />
+Last updated 2021-01-28 21:51:53 UTC<br />
AsciiDoc is a trademark of the Eclipse Foundation, Inc.
</div>
<div id="footer-badges">
diff --git a/manpage.html b/manpage.html index aeac635..48c9747 100644 --- a/manpage.html +++ b/manpage.html @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<meta name="generator" content="AsciiDoc 9.0.5" />
+<meta name="generator" content="AsciiDoc 10.0.0a1" />
<title>ASCIIDOC(1)</title>
<link rel="stylesheet" href="./asciidoc.css" type="text/css" />
<link rel="stylesheet" href="./asciidoc-manpage.css" type="text/css" />
@@ -467,7 +467,7 @@ Public License version 2 (GPLv2).</p></div> <div id="footer">
<div id="footer-text">
Version 9.0.5<br />
-Last updated 2021-01-27 22:27:47 UTC<br />
+Last updated 2021-01-28 21:51:53 UTC<br />
AsciiDoc is a trademark of the Eclipse Foundation, Inc.
</div>
<div id="footer-badges">
diff --git a/music-filter.html b/music-filter.html index 9387e9d..574b43b 100644 --- a/music-filter.html +++ b/music-filter.html @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<meta name="generator" content="AsciiDoc 9.0.5" />
+<meta name="generator" content="AsciiDoc 10.0.0a1" />
<title>Music Filter</title>
<link rel="stylesheet" href="./asciidoc.css" type="text/css" />
<link rel="stylesheet" href="./layout2.css" type="text/css" />
@@ -215,7 +215,7 @@ a problem).</td> <div id="footer">
<div id="footer-text">
Version 9.0.5<br />
-Last updated 2021-01-27 22:27:47 UTC<br />
+Last updated 2021-01-28 21:51:53 UTC<br />
AsciiDoc is a trademark of the Eclipse Foundation, Inc.
</div>
<div id="footer-badges">
diff --git a/newlists.html b/newlists.html index a130fec..3e78a7e 100644 --- a/newlists.html +++ b/newlists.html @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<meta name="generator" content="AsciiDoc 9.0.5" />
+<meta name="generator" content="AsciiDoc 10.0.0a1" />
<title>AsciiDoc New Lists</title>
<link rel="stylesheet" href="./asciidoc.css" type="text/css" />
<link rel="stylesheet" href="./layout2.css" type="text/css" />
@@ -98,7 +98,7 @@ You’ll need to update any customized configuration file list <div id="footer">
<div id="footer-text">
Version 9.0.5<br />
-Last updated 2021-01-27 22:27:48 UTC<br />
+Last updated 2021-01-28 21:51:55 UTC<br />
AsciiDoc is a trademark of the Eclipse Foundation, Inc.
</div>
<div id="footer-badges">
diff --git a/newtables.html b/newtables.html index a35d147..60a381a 100644 --- a/newtables.html +++ b/newtables.html @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<meta name="generator" content="AsciiDoc 9.0.5" />
+<meta name="generator" content="AsciiDoc 10.0.0a1" />
<title>AsciiDoc New tables</title>
<link rel="stylesheet" href="./asciidoc.css" type="text/css" />
<link rel="stylesheet" href="./layout2.css" type="text/css" />
@@ -1370,7 +1370,7 @@ v|&nbsp; <div id="footer">
<div id="footer-text">
Version 9.0.5<br />
-Last updated 2021-01-27 22:27:49 UTC<br />
+Last updated 2021-01-28 21:51:55 UTC<br />
AsciiDoc is a trademark of the Eclipse Foundation, Inc.
</div>
<div id="footer-badges">
diff --git a/plugins.html b/plugins.html index 4a1b478..95f2a51 100644 --- a/plugins.html +++ b/plugins.html @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<meta name="generator" content="AsciiDoc 9.0.5" />
+<meta name="generator" content="AsciiDoc 10.0.0a1" />
<title>AsciiDoc Plugins</title>
<link rel="stylesheet" href="./asciidoc.css" type="text/css" />
<link rel="stylesheet" href="./layout2.css" type="text/css" />
@@ -217,7 +217,7 @@ cellspacing="0" cellpadding="4"> <div id="footer">
<div id="footer-text">
Version 9.0.5<br />
-Last updated 2021-01-27 22:27:50 UTC<br />
+Last updated 2021-01-28 21:51:56 UTC<br />
AsciiDoc is a trademark of the Eclipse Foundation, Inc.
</div>
<div id="footer-badges">
diff --git a/publishing-ebooks-with-asciidoc.html b/publishing-ebooks-with-asciidoc.html index 97495f4..c75fed7 100644 --- a/publishing-ebooks-with-asciidoc.html +++ b/publishing-ebooks-with-asciidoc.html @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<meta name="generator" content="AsciiDoc 9.0.5" />
+<meta name="generator" content="AsciiDoc 10.0.0a1" />
<meta name="description" content="How to create EPUB and PDF ebooks using AsciiDoc." />
<meta name="keywords" content="AsciiDoc, EPUB tools, EPUB, PDF, ebooks" />
<title>Publishing eBooks with AsciiDoc</title>
@@ -556,7 +556,7 @@ can be formatted as EPUB eBooks.</p></div> <div id="footer">
<div id="footer-text">
Version 9.0.5<br />
-Last updated 2021-01-27 22:27:50 UTC<br />
+Last updated 2021-01-28 21:51:56 UTC<br />
AsciiDoc is a trademark of the Eclipse Foundation, Inc.
</div>
<div id="footer-badges">
diff --git a/slidy-example.html b/slidy-example.html index f1bddd2..1a2d005 100644 --- a/slidy-example.html +++ b/slidy-example.html @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<meta name="generator" content="AsciiDoc 9.0.5" />
+<meta name="generator" content="AsciiDoc 10.0.0a1" />
<title>Slidy Example Slideshow</title>
<link rel="stylesheet" href="./asciidoc.css" type="text/css" />
<link rel="stylesheet" href="./layout2.css" type="text/css" />
@@ -753,7 +753,7 @@ SUVORK5CYII=" /> <div id="footer">
<div id="footer-text">
Version 9.0.5<br />
-Last updated 2021-01-27 22:27:51 UTC<br />
+Last updated 2021-01-28 21:51:57 UTC<br />
AsciiDoc is a trademark of the Eclipse Foundation, Inc.
</div>
<div id="footer-badges">
@@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<meta name="generator" content="AsciiDoc 9.0.5" />
+<meta name="generator" content="AsciiDoc 10.0.0a1" />
<title>Slidy backend for AsciiDoc</title>
<link rel="stylesheet" href="./asciidoc.css" type="text/css" />
<link rel="stylesheet" href="./layout2.css" type="text/css" />
@@ -270,7 +270,7 @@ Use the AsciiDoc <em>max-width</em> attribute to set the document display <div id="footer">
<div id="footer-text">
Version 9.0.5<br />
-Last updated 2021-01-27 22:27:52 UTC<br />
+Last updated 2021-01-28 21:51:58 UTC<br />
AsciiDoc is a trademark of the Eclipse Foundation, Inc.
</div>
<div id="footer-badges">
diff --git a/source-highlight-filter.html b/source-highlight-filter.html index 3f0533f..6f6292e 100644 --- a/source-highlight-filter.html +++ b/source-highlight-filter.html @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<meta name="generator" content="AsciiDoc 9.0.5" />
+<meta name="generator" content="AsciiDoc 10.0.0a1" />
<title>Source Code Highlight Filter</title>
<link rel="stylesheet" href="./asciidoc.css" type="text/css" />
<link rel="stylesheet" href="./layout2.css" type="text/css" />
@@ -442,7 +442,7 @@ You should place callout markers inside source code comments to <div id="footer">
<div id="footer-text">
Version 9.0.5<br />
-Last updated 2021-01-27 22:27:52 UTC<br />
+Last updated 2021-01-28 21:51:58 UTC<br />
AsciiDoc is a trademark of the Eclipse Foundation, Inc.
</div>
<div id="footer-badges">
diff --git a/support.html b/support.html index e36e36f..1bd2bd4 100644 --- a/support.html +++ b/support.html @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<meta name="generator" content="AsciiDoc 9.0.5" />
+<meta name="generator" content="AsciiDoc 10.0.0a1" />
<title>AsciiDoc Support</title>
<link rel="stylesheet" href="./asciidoc.css" type="text/css" />
<link rel="stylesheet" href="./layout2.css" type="text/css" />
@@ -66,7 +66,7 @@ Questions about general syntax or usage should be posted to the <div id="footer">
<div id="footer-text">
Version 9.0.5<br />
-Last updated 2021-01-27 22:27:52 UTC<br />
+Last updated 2021-01-28 21:51:58 UTC<br />
AsciiDoc is a trademark of the Eclipse Foundation, Inc.
</div>
<div id="footer-badges">
diff --git a/testasciidoc.1.html b/testasciidoc.1.html index 8bba29f..7aa2f0e 100644 --- a/testasciidoc.1.html +++ b/testasciidoc.1.html @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<meta name="generator" content="AsciiDoc 9.0.5" />
+<meta name="generator" content="AsciiDoc 10.0.0a1" />
<title>TESTASCIIDOC(1)</title>
<link rel="stylesheet" href="./asciidoc.css" type="text/css" />
<link rel="stylesheet" href="./asciidoc-manpage.css" type="text/css" />
@@ -253,7 +253,7 @@ contributed to it.</p></div> <div id="footer">
<div id="footer-text">
Version 9.0.5<br />
-Last updated 2021-01-27 22:27:53 UTC<br />
+Last updated 2021-01-28 21:51:58 UTC<br />
AsciiDoc is a trademark of the Eclipse Foundation, Inc.
</div>
<div id="footer-badges">
diff --git a/testasciidoc.html b/testasciidoc.html index 944a257..c8b91ce 100644 --- a/testasciidoc.html +++ b/testasciidoc.html @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<meta name="generator" content="AsciiDoc 9.0.5" />
+<meta name="generator" content="AsciiDoc 10.0.0a1" />
<title>AsciiDoc Tests</title>
<link rel="stylesheet" href="./asciidoc.css" type="text/css" />
<link rel="stylesheet" href="./layout2.css" type="text/css" />
@@ -402,7 +402,7 @@ directory).</p></div> <div id="footer">
<div id="footer-text">
Version 9.0.5<br />
-Last updated 2021-01-27 22:27:53 UTC<br />
+Last updated 2021-01-28 21:51:58 UTC<br />
AsciiDoc is a trademark of the Eclipse Foundation, Inc.
</div>
<div id="footer-badges">
diff --git a/userguide.html b/userguide.html index 4e08bdd..9daa1eb 100644 --- a/userguide.html +++ b/userguide.html @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<meta name="generator" content="AsciiDoc 9.0.5" />
+<meta name="generator" content="AsciiDoc 10.0.0a1" />
<title>AsciiDoc User Guide</title>
<link rel="stylesheet" href="./asciidoc.css" type="text/css" />
<link rel="stylesheet" href="./layout2.css" type="text/css" />
@@ -9756,7 +9756,7 @@ General Public License version 2 for more details.</p></div> <div id="footer">
<div id="footer-text">
Version 9.0.5<br />
-Last updated 2021-01-27 22:27:53 UTC<br />
+Last updated 2021-01-28 21:51:59 UTC<br />
AsciiDoc is a trademark of the Eclipse Foundation, Inc.
</div>
<div id="footer-badges">
diff --git a/version83.html b/version83.html index 2b1ed8b..667e530 100644 --- a/version83.html +++ b/version83.html @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<meta name="generator" content="AsciiDoc 9.0.5" />
+<meta name="generator" content="AsciiDoc 10.0.0a1" />
<title>AsciiDoc Version 8.3</title>
<link rel="stylesheet" href="./asciidoc.css" type="text/css" />
<link rel="stylesheet" href="./layout2.css" type="text/css" />
@@ -108,7 +108,7 @@ additions and changes.</p></div> <div id="footer">
<div id="footer-text">
Version 9.0.5<br />
-Last updated 2021-01-27 22:28:02 UTC<br />
+Last updated 2021-01-28 21:52:06 UTC<br />
AsciiDoc is a trademark of the Eclipse Foundation, Inc.
</div>
<div id="footer-badges">
|
