summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStuart Rackham <srackham@methods.co.nz>2010-08-06 13:55:42 +1200
committerStuart Rackham <srackham@methods.co.nz>2010-08-06 13:55:42 +1200
commit52df6e6e914737fe0ca1aa473576f14c44de661b (patch)
tree525834fc4e93bb7ff052d5b789318cb6ccbe91e1
parent3142a24c7df3dd654e58c49236dc4556bf845df9 (diff)
downloadasciidoc-52df6e6e914737fe0ca1aa473576f14c44de661b.tar.gz
- Refactored chunked.xsl and epub.xsl files.
- User Guide HTML an EPUB outputs are processed as book document type. - Exchanged article.epub for more relevant book.epub on website. - Put asciidoc.epub User Guide on website. - Added EPUB notes file doc/epub.txt.
-rw-r--r--MANIFEST2
-rw-r--r--doc/asciidoc.dict51
-rw-r--r--doc/asciidoc.txt13
-rw-r--r--doc/epub.txt213
-rw-r--r--doc/latexmath.txt5
-rw-r--r--doc/main.aap38
-rw-r--r--docbook-xsl/chunked.xsl4
-rw-r--r--docbook-xsl/common.xsl6
-rw-r--r--docbook-xsl/epub.xsl6
l---------examples/website/epub.txt1
-rw-r--r--examples/website/index.txt41
-rw-r--r--examples/website/main.aap6
12 files changed, 297 insertions, 89 deletions
diff --git a/MANIFEST b/MANIFEST
index 8fd0552..3a3e40a 100644
--- a/MANIFEST
+++ b/MANIFEST
@@ -22,7 +22,7 @@ dblatex/asciidoc-dblatex.sty
dblatex/asciidoc-dblatex.xsl
dblatex/dblatex-readme.txt
doc/a2x.1
-doc/article.epub
+doc/book.epub
doc/article.pdf
doc/asciidoc.1
doc/asciidoc.conf
diff --git a/doc/asciidoc.dict b/doc/asciidoc.dict
index 6ce4559..6306372 100644
--- a/doc/asciidoc.dict
+++ b/doc/asciidoc.dict
@@ -1,4 +1,4 @@
-personal_ws-1.1 en 893
+personal_ws-1.1 en 908
mandoc
colspecs
API
@@ -28,8 +28,9 @@ del
BOM
Bon
ungenerated
-des
+zipP
cmd
+des
ListItems
dev
vulputate
@@ -83,13 +84,14 @@ inline
monospacedwords
informaltable
realpath
+validator
colwidth
hhc
Chai
strongwords
setlocal
-ListingBlock
listingblock
+ListingBlock
exe
AuthorInfo
vsides
@@ -102,8 +104,8 @@ magna
xreflabel
PDF's
PDFs
-MSIE
pede
+MSIE
permalinks
Daly
arcu
@@ -116,8 +118,8 @@ apos
ShareSource
projectname
hoc
-ispum
Maier
+ispum
TableFooter
blog
passthroughs
@@ -165,16 +167,18 @@ PassthroughBlocks
blockdef
javascript
JavaScript
+OEBPS
symlinks
optionname
companyname
pageunits
-nec
loc
+nec
latexmath
articleinfo
auctor
refname
+mim
Farhat
uninstall
localdate
@@ -197,12 +201,12 @@ endDocument
odt
Cygwin
ultrices
-indentedparagraph
IndentedParagraph
+indentedparagraph
ltr
doctests
-AsciiDocAPI
asciidocapi
+AsciiDocAPI
itemtag
Dvips
Jython
@@ -223,6 +227,8 @@ noborders
facto
ListParagraphs
nunc
+opf
+OPF
CustomBlocks
informalfigure
ORed
@@ -234,9 +240,9 @@ BlockId
png
lobortis
Bowlin
-asciimathml
-AsciiMathML
ASCIIMathML
+AsciiMathML
+asciimathml
conf
RCS
CalloutList
@@ -277,14 +283,15 @@ specialsections
subsverbatim
adolescens
qui
+htmltoc
SJR
biggy
pgwide
RevisionDate
crlf
tex
-Bólido
Bolido
+Bólido
tabsize
colpcwidth
Orry
@@ -299,8 +306,8 @@ Tsawassen
Aenean
postsubs
src
-LastName
lastname
+LastName
toc
tmp
Knisley
@@ -345,13 +352,13 @@ revisionhistory
params
undefines
Andrés
-htmlhelp
HTMLHelp
+htmlhelp
cellspacing
Citeaux
srackham
-Luleå
Lulea
+Luleå
Ubuntu
xml
XSLTLib
@@ -405,9 +412,10 @@ js
blogpost
xsltproc
jw
-ln
nd
+ln
ne
+oa
Terje
lt
Helvetica
@@ -429,6 +437,7 @@ tcqn
epub
td
Vivamus
+px
py
th
ru
@@ -459,6 +468,7 @@ endtag
glossdiv
Lebihan
ListTerms
+colsep
indir
texttag
ctags
@@ -488,6 +498,7 @@ notitle
manvolnum
homero
listindex
+validators
testasciidoc
HotSpot
vimrc
@@ -565,6 +576,7 @@ uriStartString
infile
Suspendisse
todo
+mimetype
setlevel
Rosenkraenzer
bodydata
@@ -604,6 +616,7 @@ Skype
POSIX
builtins
bulleted
+Google
globals
porta
OpenBlock
@@ -671,6 +684,7 @@ TableHeader
Mihai
KeyboardInterrupt
justo
+hexdump
sectionbody
SectionBody
nnoremap
@@ -700,6 +714,7 @@ URIs
lang
basebackend
urna
+rowsep
blockmacro
BlockMacro
mailto
@@ -813,8 +828,8 @@ toolchain
cellpadding
entrytbl
authorinitials
-javascripts
JavaScripts
+javascripts
undefining
leveloffset
CustomBlock
@@ -868,8 +883,8 @@ Redhat
datadir
Kumar
IndentedParagraphs
-Berguvsvagen
Berguvsvägen
+Berguvsvagen
executables
tabledef
ftdetect
@@ -889,6 +904,6 @@ lectus
JavaHelp
unescaped
mydoc
-middlename
MiddleName
+middlename
Jimmac's
diff --git a/doc/asciidoc.txt b/doc/asciidoc.txt
index dcf7750..603432f 100644
--- a/doc/asciidoc.txt
+++ b/doc/asciidoc.txt
@@ -10,9 +10,7 @@ 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.
-
-Introduction
-------------
+.This document
**********************************************************************
This is an overly large document, it probably needs to be refactored
into a Tutorial, Quick Reference and Formal Reference.
@@ -22,14 +20,9 @@ Started>> section and take a look at the example AsciiDoc (`*.txt`)
source files in the distribution `doc` directory.
**********************************************************************
-Plain text is the most universal electronic document format,
-regardless of your computing environment you can always read and write
-plain text documentation. But for many applications plain text is not
-the preferred presentation format -- HTML and PDF formats are widely
-used as is the roff man page format. DocBook is a popular
-documentation markup format which can be translated to HTML, PDF and
-other presentation formats.
+Introduction
+------------
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
diff --git a/doc/epub.txt b/doc/epub.txt
new file mode 100644
index 0000000..7315d81
--- /dev/null
+++ b/doc/epub.txt
@@ -0,0 +1,213 @@
+AsciiDoc EPUB Notes
+===================
+
+Notes that mostly relate to limitations imposed by bugs in DocBook XSL
+Stylesheets EPUB generation.
+
+
+Limitations
+-----------
+- If the date format of the DocBook 'data' element is not
+ `YYYY[-MM[-DD]]` you will get an error like the following one when
+ you valid using `epubcheck(1)`:
+
+ ERROR: doc/article.epub/OEBPS/content.opf(6): date value 'Dec 2003'
+ is not valid, YYYY[-MM[-DD]] expected
+
+- Navigation headers and admonition icons are suppressed by
+ `docbook-xsl/epub.xsl`
+ (see <<X2,bug report>>).
+
+- Untitled sidebars are displayed in bold text
+ (see <<X1,bug report>>).
+
+EPUB bugs in DocBook XSL Stylesheets
+------------------------------------
+
+[[X1]]
+=== epub: untitled DocBook sidebar emits invalid XHTML
+https://sourceforge.net/tracker/index.php?func=detail&aid=2840768&group_id=21935&atid=373747
+
+I get the same problem, but is confined to EPUB outputs (not XHTML)
+and results in the sidebar and all subsequent text on the page
+displayed in bold text in both Firefox 3.6.8 and Google Chrome
+5.0.375.125 (I haven't checked other browsers).
+
+Environment: DocBook XSL 1.75.2; Xubuntu 10.04
+
+If a DocBook sidebar element does not have a title then the emitted
+title is (I haven't checked other browsers).
+set to <b/> instead of <b></b>, for example this DocBook markup:
+
+ <sidebar>
+ <simpara>Lorem ipsum dolor sit amet, consectetuer adipiscing elit.</simpara>
+ </sidebar>
+
+Generates this EPUB XHTML:
+
+ <div class="sidebar"><p class="title"><b/></p><p>Lorem ipsum dolor
+ sit amet, consectetuer adipiscing elit.</p></div>
+
+This problem is not picked up by either the epubcheck or the W3C
+validators.
+
+The problem does not occur generating XHTML which emits the following
+for the above example:
+
+ <div class="sidebar"><p class="title"><b></b></p><p>Lorem ipsum
+ dolor sit amet, consectetuer adipiscing elit.</p></div>
+
+
+=== epub: Unreferenced callout icons in OPF
+https://sourceforge.net/tracker/?func=detail&aid=2854075&group_id=21935&atid=373747
+
+Environment: DocBook XSL 1.75.2; Xubuntu 8.04
+
+When callouts are used in a document and callout graphics are disabled
+(callout.graphics=0) the generated 'contents.opf' still contains
+references to all the callout icons even though none are not
+referenced in the generated XHTML content. This results in 10
+epubcheck validation errors like:
+
+ image file OEBPS/images/icons/callouts/1.png is missing
+
+It appears that epub is adding the icons to the OPF without
+first checking the callout.graphics parameter.
+
+
+=== epub: Table grids not generated
+https://sourceforge.net/tracker/?func=detail&aid=2849647&group_id=21935&atid=373747
+
+Environment: DocBook XSL 1.75.2; Xubuntu 8.04
+
+DocBook XSL epub does not appear to process the DocBook table element rowsep
+and colsep attributes -- table grids are not displayed. The DocBook
+<table rowsep="1" colsep="1"> results in:
+
+epub DocBook XSL generates:
+
+ <td style="text-align: left" valign="top">
+
+i.e. epub is not generating CSS borders (same for generated th elements).
+
+Compare this with the (correct) xhtml DocBook XSL generates the correct border
+styles:
+
+ <td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left" valign="top">
+
+
+
+=== epub: htmltoc is not generated
+https://sourceforge.net/tracker/?func=detail&aid=2849686&group_id=21935&atid=373747
+
+Environment: DocBook XSL 1.75.2; Xubuntu 8.04
+
+If DocBook XSL TOC generation is specified the generated
+'contents.opf' contains an 'htmltoc' element but the referenced TOC file
+is not generated by DocBook XSL. For example the contents.opf contains:
+
+ <item id="htmltoc" media-type="application/xhtml+xml" href="ar01-toc.html"/>
+
+but the actual TOC file `OEBPS/ar01-toc.html` is missing and epubcheck
+generates validation errors like:
+
+ ERROR: doc/article.epub: OPS/XHTML file OEBPS/ar01-toc.html is missing
+
+
+=== epub: leading dot in directory name error
+https://sourceforge.net/tracker/?func=detail&aid=2849683&group_id=21935&atid=373747
+
+Environment: DocBook XSL 1.75.2; Xubuntu 8.04
+
+Specifying paths with a leading dot causes problems, for example:
+
+ <xsl:param name="html.stylesheet" select="'./docbook-xsl.css'"/>
+
+This generates validation errors like:
+
+ ERROR: article.epub/OEBPS/index.html(4):
+ 'OEBPS/./docbook-xsl.css': referenced resource missing in the package
+
+The file is in the archive at the correct location, just doesn't
+seem to like './' in the path name -- the path needs to be normalized
+before being written to the contents.opf.
+
+It's not just the validator, the file is missing when the EPUB is viewed
+(in bookworm).
+
+This works fine:
+
+ <xsl:param name="html.stylesheet" select="'docbook-xsl.css'"/>
+
+
+[[X2]]
+=== epub: admonition icon images missing from contents.opf
+https://sourceforge.net/tracker/?func=detail&aid=2849681&group_id=21935&atid=373747
+
+Environment: DocBook XSL 1.75.2; Xubuntu 8.04
+
+When admonition icons are specified epubcheck generates validation
+errors like:
+
+ ERROR: article.epub/OEBPS/index.html(4):
+ 'OEBPS/images/icons/note.png': referenced resource exists,
+ but not declared in the OPF file
+
+i.e. The admonition icon is in the EPUB file but DocBook XSL has not
+been added to the content.opf manifest. Compare this with callout icons
+which are processed correctly.
+
+
+=== Table width attribute validation error
+https://sourceforge.net/tracker/?func=detail&aid=2848734&group_id=21935&atid=373747
+
+Environment: DocBook XSL 1.75.2; Xubuntu 8.04
+
+I get the following validation errors when navigation headers are in
+included in the generated XHTML:
+
+ ERROR: article.epub/OEBPS/ix01.html(3): attribute "width" not allowed
+ at this point; ignored
+
+This is because DocBook XSL has emitted invalid XHTML 1.1: tables
+using the 'width' element are generated automatically in navigation
+headers.
+
+Though, admittedly, navigation is redundant if you're reading with an
+EPUB reader. Suppress by setting the suppress.navigation param to 1.
+
+Is this a DocBook XSL bug?
+
+
+The Linux zip(1) command
+------------------------
+The Linux zip(1) command does not seem to be able to generate EPUB
+compatible zip files -- the 'mimetype' file contents start at 0x3b,
+not the required 0x38 and the validator generates this error:
+
+ $ zip -0 test.epub mimetype
+ adding: mimetype (stored 0%)
+
+ $ hexdump -C test.epub
+ 00000000 50 4b 03 04 0a 00 00 00 00 00 99 50 21 3b 6f 61 |PK.........P!;oa|
+ 00000010 ab 2c 14 00 00 00 14 00 00 00 08 00 15 00 6d 69 |.,............mi|
+ 00000020 6d 65 74 79 70 65 55 54 09 00 03 01 49 9c 4a 01 |metypeUT....I.J.|
+ 00000030 49 9c 4a 55 78 04 00 e9 03 e9 03 61 70 70 6c 69 |I.JUx......appli|
+ 00000040 63 61 74 69 6f 6e 2f 65 70 75 62 2b 7a 69 70 50 |cation/epub+zipP|
+ 00000050 4b 01 02 17 03 0a 00 00 00 00 00 99 50 21 3b 6f |K...........P!;o|
+ 00000060 61 ab 2c 14 00 00 00 14 00 00 00 08 00 0d 00 00 |a.,.............|
+ 00000070 00 00 00 00 00 00 00 a4 81 00 00 00 00 6d 69 6d |.............mim|
+ 00000080 65 74 79 70 65 55 54 05 00 03 01 49 9c 4a 55 78 |etypeUT....I.JUx|
+ 00000090 00 00 50 4b 05 06 00 00 00 00 01 00 01 00 43 00 |..PK..........C.|
+ 000000a0 00 00 4f 00 00 00 00 00 |..O.....|
+ 000000a8
+
+ $ epubcheck test.epub
+ Epubcheck Version 1.0.3
+
+ ERROR: test.epub: mimetype contains wrong type (application/epub+zip expected)
+ ERROR: test.epub: META-INF/container.xml is missing
+
+If there's some zip(1) command-line option I'm missing I'd be keen to
+know about it.
+
diff --git a/doc/latexmath.txt b/doc/latexmath.txt
index 552b359..49550a0 100644
--- a/doc/latexmath.txt
+++ b/doc/latexmath.txt
@@ -3,7 +3,10 @@ Embedding LaTeX Math in AsciiDoc dblatex documents
You can include
ftp://ftp.ams.org/pub/tex/doc/amsmath/short-math-guide.pdf[LaTeX math]
-equations in AsciiDoc documents that are processed by 'dblatex'.
+equations in AsciiDoc documents that are processed by 'dblatex'. The
+AsciiDoc 'latexmath' macros generate DocBook 'inlineequation' and
+'informalequation' elements containing the LaTeX markup which is
+processed by 'dblatex'.
Inline equations
diff --git a/doc/main.aap b/doc/main.aap
index d03158d..dd67c62 100644
--- a/doc/main.aap
+++ b/doc/main.aap
@@ -41,14 +41,14 @@ OUTFILES = $*(ROOT).html $*(ROOT).css.html $*(ROOT).css-embedded.html \
latexmath.pdf \
source-highlight-filter.pdf \
music-filter.pdf \
- article.epub \
+ book.epub \
article-standalone.html
TEST_FILES = $*(ROOT).css-embedded.html
article.css-embedded.html book.css-embedded.html \
article.xml book.xml book-multi.xml asciidoc.xml asciidoc.1.xml \
asciidoc.1.html a2x.1.xml music-filter.xml \
- article.epub asciidoc.epub \
+ book.epub asciidoc.epub \
../examples/oldtables.xml ../examples/oldtables.html
@@ -57,7 +57,7 @@ TEST_FILES = $*(ROOT).css-embedded.html
#####################################################################
:rule %.epub : %.txt
- :sys $A2X -vf epub --epubcheck $source
+ :sys $A2X -f epub -d book --epubcheck $source
:rule %.text : %.txt
# Convert AsciiDoc to HTML then use lynx(1) to convert HTML to text.
@@ -104,6 +104,8 @@ TEST_FILES = $*(ROOT).css-embedded.html
opt += -d manpage
@else:
opt += -n
+ @if source_list[0] == 'asciidoc.txt' or source_list[0].startswith('book'):
+ opt += -d book
:sys $ASCIIDOC $opt -b docbook $(source[0])
@if _no.XMLLINT:
:sys $XMLLINT --nonet --noout --valid $target
@@ -114,6 +116,8 @@ TEST_FILES = $*(ROOT).css-embedded.html
opt =
@if source_list[0] in ('asciidoc.1.txt','a2x.1.txt'):
opt += -d manpage
+ @if source_list[0] == 'asciidoc.txt' or source_list[0].startswith('book'):
+ opt += -d book
:sys $ASCIIDOC $opt -b docbook-sgml $(source[0])
:rule %.html: %.xml
@@ -169,32 +173,12 @@ asciidoc.1.html: asciidoc.1.txt
:print WARNING: xmllint(1) unavailable: skipping validation
# User Guide 'chunked' into linked HTML pages.
-$CHUNK_DIR/index.html: asciidoc.xml
- :mkdir {f} $CHUNK_DIR
- :del {f} {q} $CHUNK_DIR/*.html
- :sys $XSLTPROC --nonet --stringparam base.dir $CHUNK_DIR/ --stringparam html.stylesheet ../docbook-xsl.css ../docbook-xsl/chunked.xsl $source
+$CHUNK_DIR/index.html: asciidoc.txt
+ :sys $A2X -fchunked -dbook --icons -D $CHUNK_DIR asciidoc.txt
# HTML Help formatted User Guide.
$HTMLHELP_DIR/index.html: asciidoc.xml
- :mkdir {f} $HTMLHELP_DIR
- :del {f} {q} $HTMLHELP_DIR/*.html
- :sys $XSLTPROC --nonet --stringparam admon.textlabel 0 --stringparam base.dir $HTMLHELP_DIR/ --stringparam html.stylesheet ../docbook-xsl.css --stringparam htmlhelp.hhp ${HTMLHELP_FILE}.hhp --stringparam htmlhelp.chm ${HTMLHELP_FILE}.chm ../docbook-xsl/htmlhelp.xsl $source
-
-# Book template.
-book.xml: book.txt
- :sys $ASCIIDOC -d book -b docbook $source
- @if _no.XMLLINT:
- :sys $XMLLINT --nonet --noout --valid $target
- @else:
- :print WARNING: xmllint(1) unavailable: skipping validation
-
-# Multi-part book template.
-book-multi.xml: book-multi.txt
- :sys $ASCIIDOC -d book -b docbook $source
- @if _no.XMLLINT:
- :sys $XMLLINT --nonet --noout --valid $target
- @else:
- :print WARNING: xmllint(1) unavailable: skipping validation
+ :sys $A2X -fhtmlhelp -dbook --icons -D $HTMLHELP_DIR asciidoc.txt
../BUGS: ../BUGS.text
# Make BUGS.text and copy to BUGS.
@@ -232,7 +216,7 @@ clean:
:del {f} *.bak # Remove aspell backups.
spell: $INFILES ../CHANGELOG.txt ../README.txt ../BUGS.txt ../INSTALL.txt \
- a2x.1.txt faq.txt asciidocapi.txt testasciidoc.txt
+ a2x.1.txt faq.txt asciidocapi.txt testasciidoc.txt epub.txt
# Interactively spell check all files.
@for s in source_list:
:sys {i} $ASPELL check -p ./asciidoc.dict $s
diff --git a/docbook-xsl/chunked.xsl b/docbook-xsl/chunked.xsl
index cf00ba7..940bec2 100644
--- a/docbook-xsl/chunked.xsl
+++ b/docbook-xsl/chunked.xsl
@@ -11,10 +11,6 @@
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
<xsl:import href="http://docbook.sourceforge.net/release/xsl/current/xhtml/chunk.xsl"/>
<xsl:import href="common.xsl"/>
-<!-- Separate the first chapter from preceding content. -->
-<xsl:param name="chunk.first.sections" select="1"/>
-<!-- Chunk on a chapter by chapter basis (no sub-section chunks. -->
-<xsl:param name="chunk.section.depth" select="0"/>
<xsl:param name="navig.graphics.path">images/icons/</xsl:param>
<xsl:param name="admon.graphics.path">images/icons/</xsl:param>
<xsl:param name="callout.graphics.path" select="'images/icons/callouts/'"/>
diff --git a/docbook-xsl/common.xsl b/docbook-xsl/common.xsl
index 2713cf2..5c7d3d8 100644
--- a/docbook-xsl/common.xsl
+++ b/docbook-xsl/common.xsl
@@ -43,9 +43,11 @@
<xsl:param name="callout.graphics.path" select="'images/icons/callouts/'"/>
<xsl:param name="callout.list.table" select="'1'"/>
-<xsl:param name="chunk.first.sections" select="0"/>
+<xsl:param name="section.autolabel.max.depth" select="2"/>
+
+<xsl:param name="chunk.first.sections" select="1"/>
+<xsl:param name="chunk.section.depth" select="0"/>
<xsl:param name="chunk.quietly" select="0"/>
-<xsl:param name="chunk.section.depth" select="1"/>
<xsl:param name="chunk.toc" select="''"/>
<xsl:param name="chunk.tocs.and.lots" select="0"/>
diff --git a/docbook-xsl/epub.xsl b/docbook-xsl/epub.xsl
index a300c23..b589aa1 100644
--- a/docbook-xsl/epub.xsl
+++ b/docbook-xsl/epub.xsl
@@ -12,12 +12,6 @@
<xsl:import href="http://docbook.sourceforge.net/release/xsl/current/epub/docbook.xsl"/>
<xsl:import href="common.xsl"/>
-<!-- Separate the first chapter from preceding content. -->
-<xsl:param name="chunk.first.sections" select="1"/>
-
-<!-- Chunk on a chapter by chapter basis (no sub-section chunks. -->
-<xsl:param name="chunk.section.depth" select="0"/>
-
<!--
DocBook XSL 1.75.2: Nav headers are invalid XHTML (table width element)
-->
diff --git a/examples/website/epub.txt b/examples/website/epub.txt
new file mode 120000
index 0000000..f4c73e8
--- /dev/null
+++ b/examples/website/epub.txt
@@ -0,0 +1 @@
+../../doc/epub.txt \ No newline at end of file
diff --git a/examples/website/index.txt b/examples/website/index.txt
index c586007..872a3a4 100644
--- a/examples/website/index.txt
+++ b/examples/website/index.txt
@@ -67,27 +67,25 @@ Example Articles
this link:article.html[HTML file] and this
link:article.pdf[PDF file] via DocBook markup generated by AsciiDoc.
-- This link:asciidoc.pdf[PDF formatted User Guide] was generated from
- asciidoc(1) DocBook output.
-
-- This link:article.epub[EPUB formatted article] was generated using
- link:a2x.1.html[a2x].
-
Example Books
~~~~~~~~~~~~~
AsciiDoc markup supports all the standard DocBook frontmatter and
backmatter sections (dedication, preface, bibliography, glossary,
-index, colophon) plus footnotes and index entries.
-
-Book::
- This link:book.txt[AsciiDoc book's] DocBook output
- produced link:book.html[this HTML file] using the
- 'DocBook XSL Stylesheets'.
-
-Multi-part book::
- This link:book-multi.txt[multi-part AsciiDoc book's]
- DocBook output produced link:book-multi.html[this HTML file]
- using the 'DocBook XSL Stylesheets'.
+index, colophon) plus footnotes and index entries. PDF and EPUB
+formatted ebooks can be generated using link:a2x.1.html[a2x] (see also
+link:epub.html[AsciiDoc EPUB Notes]).
+
+- This link:book.txt[AsciiDoc book] produced link:book.html[this HTML
+ file] using the 'DocBook XSL Stylesheets'.
+- The link:asciidoc.pdf[PDF formatted AsciiDoc User Guide] was
+ generated from asciidoc(1) DocBook output.
+- The link:asciidoc.epub[EPUB formatted AsciiDoc User Guide] was
+ generated using link:a2x.1.html[a2x].
+- This link:book.epub[EPUB formatted book skeleton] was generated
+ using link:a2x.1.html[a2x].
+- This link:book-multi.txt[multi-part AsciiDoc book] produced
+ link:book-multi.html[this HTML file] using the 'DocBook XSL
+ Stylesheets'.
Example UNIX Man Pages
~~~~~~~~~~~~~~~~~~~~~~
@@ -143,8 +141,13 @@ You can include mathematical formulae in AsciiDoc XHTML documents using
link:asciimathml.html[ASCIIMathML] or link:latexmathml.html[LaTeXMathML]
notation.
-link:latexmath.pdf[LaTeX Math] can be included in AsciiDoc
-documents processed by `dblatex(1)`.
+The link:latex-filter.html[AsciiDoc LaTeX filter] translates LaTeX
+source to PNG image which is automatically inserted into the AsciiDoc
+output documents.
+
+AsciiDoc also has 'latexmath' macros for DocBook outputs -- they are
+documented in link:latexmath.pdf[this PDF file] and can be used in
+AsciiDoc documents processed by `dblatex(1)`.
Vim Syntax Highlighter
diff --git a/examples/website/main.aap b/examples/website/main.aap
index 064c27b..5321618 100644
--- a/examples/website/main.aap
+++ b/examples/website/main.aap
@@ -25,6 +25,7 @@ WEB_ROOT =
asciimathml
asciidocapi
CHANGELOG
+ epub
faq
index
INSTALL
@@ -64,12 +65,13 @@ DOCS =
$*(DOCS_ROOT).css-embedded.html
$*(DOCS_ROOT).xml
asciidoc.pdf
+ asciidoc.epub
asciidoc.1
article.txt article.html article-standalone.html
book.txt book.html
book-multi.txt book-multi.html
docbook-xsl.css
- article.epub
+ book.epub
article.pdf
latexmath.pdf
@@ -136,10 +138,12 @@ copy: all
:sys rm -rf $LOCAL_WEB/chunked/
:sys mkdir -p $LOCAL_WEB/chunked/
:sys cp $DOCS_DIR/asciidoc.chunked/*.html $LOCAL_WEB/chunked/
+ :sys cp $DOCS_DIR/asciidoc.chunked/*.css $LOCAL_WEB/chunked/
:sys cp -R $DOCS_DIR/asciidoc.chunked/images $LOCAL_WEB/chunked/
:sys cp music?.* $LOCAL_WEB
:sys cp sample?.png $LOCAL_WEB
:sys cp latex?.png $LOCAL_WEB
+ :sys cp *__*.png $LOCAL_WEB
clean:
:del {f} $WEB_PAGES