Documentation updates and errata.8.6.1

8 files changed, 86 insertions, 67 deletions

diff --git a/CHANGELOG.txt b/CHANGELOG.txt
index bb18480..d71836a 100644
--- a/CHANGELOG.txt
+++ b/CHANGELOG.txt
@@ -21,10 +21,10 @@ Version 8.6.1 (2010-08-22)
   attribute have been replaced by a single positional attribute.

 

 .Bug fixes

-- 'FIXED': 'asciidoctest.py': `BACKEND` command argument was being

+- 'FIXED': 'testasciidoc.py': `BACKEND` command argument was being

   ignored.

-- 'FIXED': Broken 'docinfo' file functionality to 'html4' and

-  'xhtml11' backends (previously the docinfo file was included into

+- 'FIXED': Broken 'docinfo' file functionality in 'html4' and

+  'xhtml11' backends (previously the docinfo file was included in

   the 'body' instead of the 'header').

 

 Regression issues

diff --git a/doc/asciidoc.dict b/doc/asciidoc.dict
index 9226464..04e4c26 100644
--- a/doc/asciidoc.dict
+++ b/doc/asciidoc.dict
@@ -1,11 +1,11 @@
-personal_ws-1.1 en 977 
+personal_ws-1.1 en 981 
 mandoc
 colspecs
 API
 testcases
 BSBEV
-dapibus
 dblatex
+dapibus
 attributelist
 AttributeList
 Blondel
@@ -32,8 +32,8 @@ BOM
 Bon
 ungenerated
 zipP
-cmd
 des
+cmd
 ListItems
 dev
 vulputate
@@ -116,8 +116,8 @@ xreflabel
 PDF's
 PDFs
 pygmentize
-pede
 MSIE
+pede
 permalinks
 Boscombe
 Daly
@@ -131,8 +131,8 @@ apos
 ShareSource
 projectname
 hoc
-Maier
 ispum
+Maier
 TableFooter
 blog
 passthroughs
@@ -177,6 +177,7 @@ mansource
 JRE
 verear
 mea
+jqs
 PassthroughBlocks
 blockdef
 javascript
@@ -188,8 +189,8 @@ optionname
 sollicitudin
 companyname
 pageunits
-loc
 nec
+loc
 latexmath
 articleinfo
 auctor
@@ -218,12 +219,12 @@ endDocument
 odt
 Cygwin
 ultrices
-IndentedParagraph
 indentedparagraph
+IndentedParagraph
 ltr
 doctests
-asciidocapi
 AsciiDocAPI
+asciidocapi
 itemtag
 Dvips
 Jython
@@ -260,9 +261,9 @@ lobortis
 Broberg
 Bowlin
 navPoint
-ASCIIMathML
-AsciiMathML
 asciimathml
+AsciiMathML
+ASCIIMathML
 conf
 RCS
 CalloutList
@@ -313,8 +314,8 @@ pgwide
 RevisionDate
 crlf
 tex
-Bolido
 Bólido
+Bolido
 tabsize
 colpcwidth
 Orry
@@ -330,8 +331,8 @@ Tsawassen
 Aenean
 postsubs
 src
-lastname
 LastName
+lastname
 toc
 tmp
 Knisley
@@ -382,8 +383,8 @@ undefines
 Andrés
 yellowback
 Quisque
-HTMLHelp
 htmlhelp
+HTMLHelp
 cellspacing
 Citeaux
 srackham
@@ -393,12 +394,13 @@ Ubuntu
 xml
 XSLTLib
 headrow
+staticfree
 Morbi
 Blauer
 footdata
-cb
-bg
 al
+bg
+cb
 cd
 xsl
 backmatter
@@ -415,16 +417,16 @@ fb
 fermentum
 fi
 cellcount
-fo
 et
+fo
 eu
 hg
 guimenu
 fugiat
 toclevels
 xzf
-JB
 gq
+JB
 refactored
 sgml
 backcolor
@@ -441,14 +443,14 @@ lf
 defacto
 mb
 IndentedBlocks
-js
 md
+js
 erat
 blogpost
 xsltproc
 jw
-nd
 ln
+nd
 ne
 oa
 Terje
@@ -470,8 +472,8 @@ ps
 runtime
 tcqn
 epub
-td
 px
+td
 vivamus
 py
 addon
@@ -487,13 +489,14 @@ tt
 VM
 Frédérique
 SidebarBlock
-ut
 wj
+ut
 Efros
 param
 Movet
 hcol
 manpurpose
+ebooks
 eBooks
 colalign
 debian
@@ -693,8 +696,8 @@ pagebreak
 VariableList
 LiteralBlocks
 Donec
-dbook
 BLONP
+dbook
 asciimath
 interesset
 pellentesque
@@ -736,6 +739,7 @@ posattrs
 subdirectories
 RevisionRemark
 TableHeader
+slideshow
 Mihai
 KeyboardInterrupt
 justo
@@ -772,8 +776,8 @@ basebackend
 urna
 rowsep
 checksums
-blockmacro
 BlockMacro
+blockmacro
 mailto
 http
 pychart
@@ -815,16 +819,16 @@ startDocument
 ifdef
 manmanual
 Konqueror
-firstname
 FirstName
-latexmathml
+firstname
 LaTeXMathML
+latexmathml
 sectnum
 BlockMacros
 cceeff
 unfloat
-snabbkop
 snabbköp
+snabbkop
 NumberedList
 everti
 multi
@@ -894,8 +898,8 @@ cellpadding
 entrytbl
 Ornare
 authorinitials
-JavaScripts
 javascripts
+JavaScripts
 undefining
 leveloffset
 CustomBlock
@@ -951,8 +955,8 @@ Redhat
 datadir
 Kumar
 IndentedParagraphs
-Berguvsvägen
 Berguvsvagen
+Berguvsvägen
 executables
 tabledef
 ftdetect
@@ -973,6 +977,6 @@ lectus
 JavaHelp
 unescaped
 mydoc
-MiddleName
 middlename
+MiddleName
 Jimmac's
diff --git a/doc/asciidoc.txt b/doc/asciidoc.txt
index 82e1cb5..89999ea 100644
--- a/doc/asciidoc.txt
+++ b/doc/asciidoc.txt
@@ -379,8 +379,8 @@ the header of the output document.
 The contents docinfo file is dependent on the type of output:
 
 HTML::
-  Valid HTML 'head' child elements. Typically 'style' and 'script'
-  elements for CSS and JavaScript inclusion.
+  Valid 'head' child elements. Typically 'style' and 'script' elements
+  for CSS and JavaScript inclusion.
 
 DocBook::
   Valid 'articleinfo' or 'bookinfo' child elements.  DocBook defines
@@ -662,21 +662,23 @@ files. See the <<X7,Configuration Files>> section for details.
   multi-character quotes you may even need to escape individual
   characters.
 
+[[X96]]
+Quoted text attributes
+^^^^^^^^^^^^^^^^^^^^^^
 Quoted text can be prefixed with an <<X21,attribute list>>.  The first
-positional attribute is translated to an HTML 'span' element 'class'
-attribute:
+positional attribute is translated by AsciiDoc to an HTML 'span'
+element 'class' attribute or a DocBook 'phrase' element 'role'
+attribute.
 
-- Directly using the AsciiDoc HTML backends.
-- Indirectly using the AsciiDoc 'docbook' backend followed by DocBook
-  XSL Stylesheets. DocBook XSL Stylesheets translate DocBook 'phrase'
-  elements with 'role' attributes to corresponding HTML 'span'
-  elements with the same 'class' attributes; CSS is then used
-  http://www.sagehill.net/docbookxsl/UsingCSS.html[to style the
-  generated HTML].
+DocBook XSL Stylesheets translate DocBook 'phrase' elements with
+'role' attributes to corresponding HTML 'span' elements with the same
+'class' attributes; CSS can then be used
+http://www.sagehill.net/docbookxsl/UsingCSS.html[to style the
+generated HTML].
 
-This allows CSS styling to be applied to both DocBook and HTML outputs
-from the same AsciiDoc source.  You can also specify multiple class
-names separated by spaces. Examples:
+Thus CSS styling can be applied to both DocBook and AsciiDoc generated
+HTML outputs from the same AsciiDoc source.  You can also specify
+multiple class names separated by spaces. Examples:
 
   [red]#obvious#
   [big red yellowback]*very obvious*
@@ -5401,7 +5403,7 @@ JavaScript to the 'xhtml11' output document. The script dynamically
 generates <<X91,table of contents>> and <<X92,footnotes>>.
 
 |docinfo |All backends |
-If the `docinof` attribute is defined the <<X87,document information
+If the `docinfo` attribute is defined the <<X87,document information
 file>> will be included in the the header of the output file.
 
 |[[X54]]encoding |html4, xhtml11, docbook |
diff --git a/doc/faq.txt b/doc/faq.txt
index 9f3f56a..3ea3b72 100644
--- a/doc/faq.txt
+++ b/doc/faq.txt
@@ -17,7 +17,8 @@ to turn an AsciiDoc document (`mydoc.txt`) into a slideshow
 (`mydoc.html`):

 

 . Download and extract the 'JQS5' tarball.

-. Put this your document's 'docinfo' file (`mydoc-docinfo.html`):

+. Put this your document's link:userguide.html#X87[docinfo file]

+  (`mydoc-docinfo.html`):

 +

 ---------------------------------------------------------------------

 <link rel="stylesheet" href="./jqs5/jqs5.css">

@@ -36,7 +37,7 @@ to turn an AsciiDoc document (`mydoc.txt`) into a slideshow
 

 . Generate the slideshow (`mydoc.html`) with this command:

 

-  $ asciidoc -bhtml4 -adocinfo mydoc.txt

+  $ asciidoc -b html4 -a docinfo mydoc.txt

 

 

 == The AsciiDoc toclevels attribute does not work with DocBook outputs, why?

@@ -51,8 +52,8 @@ Increment the 'toc.section.depth' value to show more sub-section
 titles. If you are using 'a2x' you can set the options in the source

 file, for example:

 

-  //    a2x: --xsltproc-opts "--stringparam toc.section.depth 0"

-  //    a2x: --dblatex-opts "--param toc.section.depth=0"

+  // a2x: --xsltproc-opts "--stringparam toc.section.depth 0"

+  // a2x: --dblatex-opts "--param toc.section.depth=0"

 

 If the document is of type 'article' use the value '1' to show only

 top level section titles in the TOC, use the value '2' for two levels

@@ -60,12 +61,9 @@ etc.
 

 

 == How can I customize the appearance of XHTML and EPUB documents generated by a2x?

-You can completely customize the appearance of a document by creating

-your own CSS file. The easiest way to do this is to copy the existing

-default `docbook-xsl.css` file (located in the AsciiDoc `stylesheets`

-configuration directory) to the same directory as your AsciiDoc source

-file and then edit it.  See also the 'a2x' `--stylesheet` and `-r,

---resource-dir` command-line options.

+You can customize the appearance of an EPUB document with CSS.  See

+the link:publishing-ebooks-with-asciidoc.html[Sherlock Holmes eBook

+example] on the AsciiDoc website.

 

 

 == DocBook has many elements for document meta-data -- how can I use them from AsciiDoc?

diff --git a/doc/publishing-ebooks-with-asciidoc.txt b/doc/publishing-ebooks-with-asciidoc.txt
index 35a879a..4d879fd 100644
--- a/doc/publishing-ebooks-with-asciidoc.txt
+++ b/doc/publishing-ebooks-with-asciidoc.txt
@@ -309,8 +309,8 @@ Holmes only has two title levels:
 
 Styling your books
 ------------------
-You can customize the appearance of a document by creating your own
-CSS file. Either create your own or copy and edit the existing default
+You can customize the appearance of a document with CSS.  CSS file.
+Either create your own or copy and edit the existing default
 `docbook-xsl.css` file (located in the AsciiDoc `stylesheets`
 configuration directory) then place it in the same directory as your
 AsciiDoc source file. Use the 'a2x' `--stylesheet` option if you
@@ -331,3 +331,13 @@ natively.
 
 As of writing this article most eBook readers (with the notable
 exception of Amazon's Kindle) support the EPUB format.
+
+
+Non-fiction Books and Manuals
+-----------------------------
+AsciiDoc supports a rich set of markup conventions and can generate
+reference works and technical manuals complete with tables,
+illustrations, indexes, bibliographies and appendices. All the
+examples on the http:///www.methods.co.nz/asciidoc/[AsciiDoc web site]
+can be formatted as EPUB eBooks.
+
diff --git a/examples/website/asciidoc-website.dict b/examples/website/asciidoc-website.dict
index ce8c301..8a2df5d 100644
--- a/examples/website/asciidoc-website.dict
+++ b/examples/website/asciidoc-website.dict
@@ -66,8 +66,8 @@ matplotlib
 stdout
 usr
 txt
-eBooks
 ebooks
+eBooks
 linenumbering
 ImageMagick
 distros
diff --git a/examples/website/index.txt b/examples/website/index.txt
index f746e6d..e36cf48 100644
--- a/examples/website/index.txt
+++ b/examples/website/index.txt
@@ -3,12 +3,17 @@ AsciiDoc Home Page
 

 .{revdate}: AsciiDoc {revnumber} Released

 ************************************************************************

-This release follows hard on the heels of 8.6.0, it includes a couple

-'a2x' enhancements. In addition the AsciiDoc 'Quote element'

-attributes have been simplified and generalized (this change is not

-backward compatible).  The

-link:publishing-ebooks-with-asciidoc.html[publishing eBooks with

-AsciiDoc] webpage has also been updated.

+This release follows hard on the heels of 8.6.0, it includes:

+

+- A couple of new and enhanced 'a2x' command options.

+- The AsciiDoc link:userguide.html#X96[Quote element attributes] have

+  been simplified and generalized (this change is not backward

+  compatible).

+- A cover image and customized page design have been added to the

+  link:publishing-ebooks-with-asciidoc.html#_the_adventures_of_sherlock_holmes[Sherlock

+  Holmes example eBook] on the

+  link:publishing-ebooks-with-asciidoc.html[publishing eBooks with

+  AsciiDoc] web page.

 

 Read the link:CHANGELOG.html[CHANGELOG] for a full list of all

 additions, changes and bug fixes. Changes are documented in the

diff --git a/examples/website/main.aap b/examples/website/main.aap
index 51c439a..823fcfd 100644
--- a/examples/website/main.aap
+++ b/examples/website/main.aap
@@ -102,7 +102,7 @@ ASCIIDOC_HTML =
         opts = -a latexmath
     @else:
         opts =
-    @if target in ('index.html','INSTALL.html','asciidocapi.html','testasciidoc.html'):
+    @if target in ('index.html','INSTALL.html','asciidocapi.html','testasciidoc.html','publishing-ebooks-with-asciidoc.html'):
         opts += -a toc -a toclevels=1
     :sys $ASCIIDOC_HTML $opts $(source[0])
     @if _no.XMLLINT: