Updated documentation for pending release.

9 files changed, 32 insertions, 58 deletions

diff --git a/BUGS.txt b/BUGS.txt
index a6802b8..b74c1a2 100644
--- a/BUGS.txt
+++ b/BUGS.txt
@@ -6,26 +6,14 @@ AsciiDoc
 - A benign warning 'with will become a reserved keyword
   in Python 2.6' sometimes occurs when using Python 2.5 -- it's
   harmless and will disappear with Python 3.
-- The `toc` attribute will be ignored if it's set in a custom user or
-  document configuration file. This is because the default
-  configuration file containing the document `[header]` is sourced
-  before custom configuration files and the `toc` attribute is
-  processed using conditional inclusion macros.
 - Reported line numbers in diagnostic messages are sometimes wrong.
-- Embedding open brace characters `{` in argument values can cause
-  incorrect argument substitution.
 - Attribute references in macro attribute lists can't be unescaped
   (with the exception of attribute list entry `{0}`).
 - Section numbering is incorrect when outputting HTML from a
   multi-part book type document. This is not a biggy since multi-part
   books are generally processed to DocBook.
 - A row of apostrophes in an inline context throws AsciiDoc into an
-  endless loop.
-- Multiple comma separated command names in the manpage NAME section
-  translate to a single DocBook `refname` instead of multiple
-  `refname` elements.
-- Escaping quoted text and macros is sometimes tricky owing to some
-  macro and quoting ambiguities.
+  endless loop. The problem seems to be in the input file 'Reader'.
 
 dblatex
 -------
diff --git a/CHANGELOG.txt b/CHANGELOG.txt
index 18bfee9..54b0186 100644
--- a/CHANGELOG.txt
+++ b/CHANGELOG.txt
@@ -34,7 +34,7 @@ Version 8.6.2 (2010-10-03)
 - Added two more docinfo attributes 'docinfo1' and 'docinfo2' to allow

   and control inclusion of a shared docinfo file. See

   http://groups.google.com/group/asciidoc/browse_thread/thread/c948697943432e24

-- Vim syntax highligher highlights multi-name conditional attributes.

+- Vim syntax highlighter highlights multi-name conditional attributes.

 - LaTeX backend patch submitted by Andreas Hermann Braml (see

   http://groups.google.com/group/asciidoc/browse_thread/thread/1c415fc4540ce5e5).

 - Implemented 'backend aliases'; renamed `docbook.conf` to

diff --git a/MANIFEST b/MANIFEST
index c910624..5fc9aee 100644
--- a/MANIFEST
+++ b/MANIFEST
@@ -9,7 +9,7 @@ common.aap
 CHANGELOG
 CHANGELOG.txt
 asciidoc.conf
-docbook.conf
+docbook45.conf
 help.conf
 html4.conf
 lang-*.conf
diff --git a/doc/asciidoc.dict b/doc/asciidoc.dict
index 95690b2..d768f3f 100644
--- a/doc/asciidoc.dict
+++ b/doc/asciidoc.dict
@@ -1,4 +1,4 @@
-personal_ws-1.1 en 994 
+personal_ws-1.1 en 995 
 mandoc
 colspecs
 API
@@ -338,6 +338,7 @@ postsubs
 src
 lastname
 LastName
+OpenBlocks
 toc
 tmp
 Knisley
@@ -698,8 +699,8 @@ ListBlock
 LiteralBlock
 literalblock
 href
-Mozilla
 metus
+Mozilla
 unstyled
 pagebreak
 VariableList
diff --git a/doc/asciidoc.txt b/doc/asciidoc.txt
index adc74e7..72c1411 100644
--- a/doc/asciidoc.txt
+++ b/doc/asciidoc.txt
@@ -308,15 +308,17 @@ authorship and revision information:
 
 - The Header is optional, but if it is used it must start with a
   document <<X17,title>>.
-- The header can include comments.
-- The header can include <<X18,attribute entries>>, typically
-  'doctype', 'lang', 'encoding', 'icons', 'data-uri', 'toc',
-  'numbered'.  Header attributes are overridden by command-line
-  attributes.
 - Optional Author and Revision information immediately follows the
   header title.
 - The document header must be separated from the remainder of the
   document by one or more blank lines and cannot contain blank lines.
+- The header can include comments.
+- The header can include <<X18,attribute entries>>, typically
+  'doctype', 'lang', 'encoding', 'icons', 'data-uri', 'toc',
+  'numbered'.
+- Header attributes are overridden by command-line attributes.
+- If the header contains non-UTF-8 characters then the 'encoding' must
+  precede the header (either in the document or on the command-line).
 
 Here's an example AsciiDoc document header:
 
diff --git a/doc/faq.txt b/doc/faq.txt
index 3050b0b..456f810 100644
--- a/doc/faq.txt
+++ b/doc/faq.txt
@@ -9,37 +9,6 @@ AsciiDoc Frequently Asked Questions
   newer FAQs may apply to the trunk and not the current release.

 ======

 

-== Can AsciiDoc generate slide shows?

-There are a number of browser based HTML slideshow applications

-written in JavaScript, most could probably be made to work with

-AsciiDoc. Here's how to use

-http://staticfree.info/projects/jqs5/[JQS5] to turn an AsciiDoc

-document (`mydoc.txt`) into a slideshow (`mydoc.html`):

-

-. Download and extract the 'JQS5' tarball.

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

-  (`mydoc-docinfo.html`):

-+

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

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

-<link rel="stylesheet" href="./jqs5/theme/staticfree/style.css">

-<script src="./jqs5/jquery-1.2.6.js" type="text/javascript"></script>

-<script src="./jqs5/jqs5.js" type="text/javascript"></script>

-<script type="text/javascript">

-      $(document).ready(jqs5_init);

-</script>

-<style type="text/css"> hr { visibility: hidden; } </style>

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

-  * The `./jqs5/jquery-1.2.6.js` file name may differ depending on the

-    version of 'JQS5'.

-  * The last line hides 'hr' elements generated by by the Asciidoc

-    'html4' backend.

-

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

-

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

-

-

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

 DocBook has no provision for specifying table of contents levels but

 you can set the TOC level further down the toolchain by passing the

diff --git a/doc/latex-filter.txt b/doc/latex-filter.txt
index 4994cf5..9af9d28 100644
--- a/doc/latex-filter.txt
+++ b/doc/latex-filter.txt
@@ -171,7 +171,7 @@ For example:
   [latex]
   \Large $y = \int_0^\infty \gamma^2 \cos(x) dx$
 
-NOTE: The `\Large` command is outside the `$` math delimiters.
+The `\Large` command is outside the `$` math delimiters.
 
 =====================================================================
 
diff --git a/examples/website/asciidoc-website.dict b/examples/website/asciidoc-website.dict
index 8a2df5d..4776bf6 100644
--- a/examples/website/asciidoc-website.dict
+++ b/examples/website/asciidoc-website.dict
@@ -1,4 +1,4 @@
-personal_ws-1.1 en 204 
+personal_ws-1.1 en 209 
 O'Reilly
 awb
 Blogpost
@@ -23,6 +23,7 @@ faq
 Efros
 stdin
 LinuxDoc
+slideshows
 Klum
 CentOS
 src
@@ -37,6 +38,7 @@ css
 Rosten
 screenshot
 CSW
+slideshow
 Wiese
 ShareSource
 autowidth
@@ -66,8 +68,8 @@ matplotlib
 stdout
 usr
 txt
-ebooks
 eBooks
+ebooks
 linenumbering
 ImageMagick
 distros
@@ -94,6 +96,7 @@ doctests
 backends
 Gingras
 sinx
+Romé
 multi
 autoconf
 Dmitry
@@ -128,8 +131,9 @@ dx
 eBook
 hg
 Gouichi
+lang
 conf
-Wiki
+wiki
 Maier
 DelimitedBlocks
 Berker
@@ -172,6 +176,7 @@ DocBook
 fontlocking
 Rosenkraenzer
 toolchain
+slidy
 ebuild
 syntaxes
 toclevels
diff --git a/examples/website/index.txt b/examples/website/index.txt
index 571fd60..6fc85d0 100644
--- a/examples/website/index.txt
+++ b/examples/website/index.txt
@@ -4,7 +4,7 @@ AsciiDoc Home Page
 .{revdate}: AsciiDoc {revnumber} Released

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

 This release adds a <<X8,Slidy>> backend for creating browser

-slideshows.

+slideshows (based on Phillip Lord's slidy backend).

 

 You can now put document 'doctype', 'icons', 'lang' and 'backend' meta

 attributes in the document header.  Backend and language configuration

@@ -281,6 +281,12 @@ and I'll add them to the list.
   blog] describes a http://ditaa.sourceforge.net/[ditaa] filter for

   AsciiDoc which converts http://en.wikipedia.org/wiki/ASCII_art[ASCII

   art] into graphics.

+- http://github.com/github/gollum[Gollum] is a git-powered wiki, it

+  supports various formats, including AsciiDoc.

+- Gregory Romé has written an

+  http://github.com/gpr/redmine_asciidoc_formatter[AsciiDoc plugin]

+  for the http://www.redmine.org/[Redmine] project management

+  application.

 

 Please let me know if any of these links need updating.

 

@@ -367,6 +373,9 @@ discussion group thread] for details.
   website is generated using AsciiDoc.

 - Warren Block has http://www.wonkity.com/~wblock/docs/[posted a

   number of articles written using AsciiDoc].

+- The http://code.google.com/p/waf/[Waf project]'s

+  http://freehackers.org/~tnagy/wafbook/index.html[Waf Book] is

+  written using AsciiDoc.

 

 Please let me know if any of these links need updating.