Anonymous avatar Anonymous committed d20365f

Documentation updates and errata.

Comments (0)

Files changed (8)

   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

doc/asciidoc.dict

-personal_ws-1.1 en 977 
+personal_ws-1.1 en 981 
 mandoc
 colspecs
 API
 testcases
 BSBEV
+dblatex
 dapibus
-dblatex
 attributelist
 AttributeList
 Blondel
 Bon
 ungenerated
 zipP
+des
 cmd
-des
 ListItems
 dev
 vulputate
 PDF's
 PDFs
 pygmentize
+MSIE
 pede
-MSIE
 permalinks
 Boscombe
 Daly
 ShareSource
 projectname
 hoc
+ispum
 Maier
-ispum
 TableFooter
 blog
 passthroughs
 JRE
 verear
 mea
+jqs
 PassthroughBlocks
 blockdef
 javascript
 sollicitudin
 companyname
 pageunits
+nec
 loc
-nec
 latexmath
 articleinfo
 auctor
 odt
 Cygwin
 ultrices
+indentedparagraph
 IndentedParagraph
-indentedparagraph
 ltr
 doctests
+AsciiDocAPI
 asciidocapi
-AsciiDocAPI
 itemtag
 Dvips
 Jython
 Broberg
 Bowlin
 navPoint
+asciimathml
+AsciiMathML
 ASCIIMathML
-AsciiMathML
-asciimathml
 conf
 RCS
 CalloutList
 RevisionDate
 crlf
 tex
+B�lido
 Bolido
-B�lido
 tabsize
 colpcwidth
 Orry
 Aenean
 postsubs
 src
+LastName
 lastname
-LastName
 toc
 tmp
 Knisley
 Andr�s
 yellowback
 Quisque
+htmlhelp
 HTMLHelp
-htmlhelp
 cellspacing
 Citeaux
 srackham
 xml
 XSLTLib
 headrow
+staticfree
 Morbi
 Blauer
 footdata
+al
+bg
 cb
-bg
-al
 cd
 xsl
 backmatter
 fermentum
 fi
 cellcount
+et
 fo
-et
 eu
 hg
 guimenu
 fugiat
 toclevels
 xzf
+gq
 JB
-gq
 refactored
 sgml
 backcolor
 defacto
 mb
 IndentedBlocks
+md
 js
-md
 erat
 blogpost
 xsltproc
 jw
+ln
 nd
-ln
 ne
 oa
 Terje
 runtime
 tcqn
 epub
+px
 td
-px
 vivamus
 py
 addon
 VM
 Fr�d�rique
 SidebarBlock
+wj
 ut
-wj
 Efros
 param
 Movet
 hcol
 manpurpose
+ebooks
 eBooks
 colalign
 debian
 VariableList
 LiteralBlocks
 Donec
+BLONP
 dbook
-BLONP
 asciimath
 interesset
 pellentesque
 subdirectories
 RevisionRemark
 TableHeader
+slideshow
 Mihai
 KeyboardInterrupt
 justo
 urna
 rowsep
 checksums
+BlockMacro
 blockmacro
-BlockMacro
 mailto
 http
 pychart
 ifdef
 manmanual
 Konqueror
+FirstName
 firstname
-FirstName
+LaTeXMathML
 latexmathml
-LaTeXMathML
 sectnum
 BlockMacros
 cceeff
 unfloat
+snabbk�p
 snabbkop
-snabbk�p
 NumberedList
 everti
 multi
 entrytbl
 Ornare
 authorinitials
+javascripts
 JavaScripts
-javascripts
 undefining
 leveloffset
 CustomBlock
 datadir
 Kumar
 IndentedParagraphs
+Berguvsvagen
 Berguvsv�gen
-Berguvsvagen
 executables
 tabledef
 ftdetect
 JavaHelp
 unescaped
 mydoc
+middlename
 MiddleName
-middlename
 Jimmac's
 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
   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:
-
-- 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].
-
-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:
+positional attribute is translated by AsciiDoc to an HTML 'span'
+element 'class' attribute or a DocBook 'phrase' element 'role'
+attribute.
+
+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].
+
+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*
 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 |
 (`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">
 
 . 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?
 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
 
 
 == 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?

doc/publishing-ebooks-with-asciidoc.txt

 
 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
 
 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.
+

examples/website/asciidoc-website.dict

 stdout
 usr
 txt
+ebooks
 eBooks
-ebooks
 linenumbering
 ImageMagick
 distros

examples/website/index.txt

 
 .{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

examples/website/main.aap

         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:
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.