summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStuart Rackham <srackham@methods.co.nz>2010-08-13 15:58:18 +1200
committerStuart Rackham <srackham@methods.co.nz>2010-08-13 15:58:18 +1200
commitbb49e5e765d196bda7e910608d40d5a546aa05e8 (patch)
treee31fc14c8d84c98113e0b3cc418528d857345043
parentc66f8773afaed2664d9e22f947c0e5efd2718a15 (diff)
downloadasciidoc-bb49e5e765d196bda7e910608d40d5a546aa05e8.tar.gz
- CSS 'quirks' mode is no longer the default 'xhtml11' output
(http://groups.google.com/group/asciidoc/browse_thread/thread/1c02d27d49221aa2). - Remove CSS border in DocBook XSL stylesheet for consistency with AsciiDoc xhtml11 styleing. - Documentation updates.
-rw-r--r--CHANGELOG.txt2
-rw-r--r--asciidoc.conf2
-rw-r--r--doc/asciidoc.dict10
-rw-r--r--doc/asciidoc.txt53
-rw-r--r--doc/epub-notes.txt9
-rw-r--r--doc/faq.txt20
-rw-r--r--examples/website/index.txt53
-rw-r--r--examples/website/layout1.conf2
-rw-r--r--examples/website/layout1.css26
-rw-r--r--examples/website/layout2.css26
-rw-r--r--examples/website/main.aap2
-rw-r--r--stylesheets/docbook-xsl.css1
-rw-r--r--stylesheets/xhtml11-quirks.css2
-rw-r--r--stylesheets/xhtml11.css2
14 files changed, 126 insertions, 84 deletions
diff --git a/CHANGELOG.txt b/CHANGELOG.txt
index 0c1c2a2..3c7d295 100644
--- a/CHANGELOG.txt
+++ b/CHANGELOG.txt
@@ -6,6 +6,8 @@ AsciiDoc ChangeLog
Version 8.5.4 (2010-08-15)
--------------------------
.Additions and changes
+- CSS 'quirks' mode is no longer the default 'xhtml11' output
+ (http://groups.google.com/group/asciidoc/browse_thread/thread/1c02d27d49221aa2).
- Relaxed anchor ID name syntax
(http://groups.google.com/group/asciidoc/browse_thread/thread/5f3e825c74ed30c).
- Added document files: `doc/epub-notes.txt`,
diff --git a/asciidoc.conf b/asciidoc.conf
index f882c95..9456101 100644
--- a/asciidoc.conf
+++ b/asciidoc.conf
@@ -17,7 +17,7 @@ sectids=
iconsdir=./images/icons
encoding=UTF-8
# Uncomment to use xhtml11 quirks mode CSS.
-quirks=
+#quirks=
# Uncomment to use the Pygments source highlighter.
#pygments=
empty=
diff --git a/doc/asciidoc.dict b/doc/asciidoc.dict
index 102d22a..482859e 100644
--- a/doc/asciidoc.dict
+++ b/doc/asciidoc.dict
@@ -1,4 +1,4 @@
-personal_ws-1.1 en 968
+personal_ws-1.1 en 972
mandoc
colspecs
API
@@ -66,10 +66,11 @@ CSW
Potapov
nullam
Moolenaar
+dtb
doctime
CVS
DTD
-Graphviz
+graphviz
toclevel
plaintext
hyperlinks
@@ -194,6 +195,7 @@ mim
Farhat
uninstall
localdate
+ncx
ListEntry
textwidth
ItemTerm
@@ -254,6 +256,7 @@ png
lobortis
Broberg
Bowlin
+navPoint
asciimathml
AsciiMathML
ASCIIMathML
@@ -764,8 +767,8 @@ basebackend
urna
rowsep
checksums
-blockmacro
BlockMacro
+blockmacro
mailto
http
pychart
@@ -786,6 +789,7 @@ halign
AROUT
Wiese
bodyrow
+navMap
listtags
mauris
ListingBlocks
diff --git a/doc/asciidoc.txt b/doc/asciidoc.txt
index 7526260..786991c 100644
--- a/doc/asciidoc.txt
+++ b/doc/asciidoc.txt
@@ -106,8 +106,12 @@ glossary, index).
book
~~~~
-Books share the same format as articles; in addition there is the
-option to add level 0 book part sections.
+Books share the same format as articles, with the following
+differences:
+
+- The part titles in multi-part books are <<X17,top level titles>>
+ (same level as book title).
+- Some sections are book specific e.g. preface and colophon.
Book documents will normally be used to produce DocBook output since
DocBook processors can automatically generate footnotes, table of
@@ -184,10 +188,10 @@ distribution `./stylesheets/` directory.
=====================================================================
All browsers have CSS quirks, but Microsoft's IE6 has so many
omissions and errors that the `xhtml11-quirks.css` stylesheet and
-`xhtml11-quirks.conf` configuration files are included during XHTML
-backend processing to to implement workarounds for IE6. If you don't
-use IE6 then the quirks stylesheet and configuration files can be
-omitted using the `--attribute quirks!` command-line option.
+`xhtml11-quirks.conf` configuration files are available for inclusion
+during XHTML backend processing to to implement workarounds for IE6.
+Set the AsciiDoc 'quirks' attribute to enable AsciiDoc's quirks mode,
+for example with the `--attribute quirks!` command-line option.
=====================================================================
Default 'xhtml11' stylesheets:
@@ -204,8 +208,8 @@ Default 'xhtml11' stylesheets:
Use the 'theme' attribute to select an alternative set of stylesheets.
For example, the command-line option `-a theme=foo` will use
-stylesheets `foo.css`, `foo-manpage.css` and `foo-quirks.css` instead
-of the default stylesheets.
+stylesheets `foo.css`, `foo-manpage.css` (and `foo-quirks.css` if
+quirks mode is enabled) instead of the default stylesheets.
Use the 'stylesheet' attribute to include an additional stylesheet in
XHTML documents. For example, the command-line option `-a
@@ -952,14 +956,16 @@ Unique identifier typically serve as link targets.
Can also be set by the 'BlockId' element.
|role |html4, xhtml11, docbook |
-Role contains a string used to classify or subclassify an element:
+Role contains a string used to classify or subclassify an element and
+can be applied to the following AsciiDoc elements:
-- Adds 'role' attribute to block elements ('docbook' and 'xhtml11'
+- Block elements ('docbook' and 'xhtml11'
backends).
-- Adds 'role' attribute to <<X51,quoted inline elements>> ('docbook',
+- <<X51,Quoted inline elements>> ('docbook',
'xhtml11' and 'html4' backends).
-- The AsciiDoc 'role' attribute is sets the 'role' attribute in
- DocBook elements and sets the 'class' attribute in HTML elements.
+
+The AsciiDoc 'role' attribute is sets the 'role' attribute in DocBook
+outputs and sets the 'class' attribute in HTML outputs.
|reftext |docbook |
'reftext' is used to set the DocBook 'xreflabel' attribute.
@@ -4086,7 +4092,8 @@ predefined intrinsic attributes:
{verbose} defined as '' if --verbose command option specified
{zwsp} Zero-width space character entity
-.NOTES
+[NOTE]
+======
1. Intrinsic attributes are global so avoid defining custom attributes
with the same names.
@@ -4110,6 +4117,8 @@ predefined intrinsic attributes:
the current input file which may be the root document or an
included file. When the input is being read from the standard
input (`stdin`) these attributes are undefined.
+======
+
[[X73]]
Block Element Definitions
@@ -4794,6 +4803,9 @@ indent and then executing the `gq}` command.
Example `~/.vimrc` File
^^^^^^^^^^^^^^^^^^^^^^^
---------------------------------------------------------------------
+" Use bold bright fonts.
+set background=dark
+
" Show tabs and trailing characters.
set listchars=tab:»·,trail:·
set list
@@ -5223,14 +5235,11 @@ to the end of you AsciiDoc source files:
// vim: set syntax=asciidoc:
-NOTE: Dag Wieers has implemented an alternative Vim syntax file for
-AsciiDoc which can be found here
-http://svn.rpmforge.net/svn/trunk/tools/asciidoc-vim/.
+TIP: Bold fonts are often easier to read, use the Vim `:set background=dark`
+command to set bold bright fonts.
-NOTE: Emacs users: The http://xpt.sourceforge.net/[*Nix Power Tools
-project] has released an
-http://xpt.sourceforge.net/tools/doc-mode/[AsciiDoc syntax highlighter
-for emacs].
+NOTE: There are a number of alternative syntax highlighters for various editors
+listed on the http://www.methods.co.nz/asciidoc/[AsciiDoc website].
Limitations
~~~~~~~~~~~
@@ -5427,7 +5436,7 @@ suppressed and block indents are retained. This option is useful when
dealing with large amounts of imported plain text.
|quirks |xhtml11 |
-Use the `xhtml11-quirks.css` stylesheet to work around IE6 browser
+Include the `xhtml11-quirks.css` stylesheet to work around IE6 browser
incompatibilities (this is the default behavior).
|revremark |docbook |
diff --git a/doc/epub-notes.txt b/doc/epub-notes.txt
index 85c7196..a78dd3e 100644
--- a/doc/epub-notes.txt
+++ b/doc/epub-notes.txt
@@ -30,6 +30,15 @@ toc.section.depth).
Environment: DocBook XSL 1.75.2; Xubuntu 10.04
+Also epub/docbook.xsl has written a hard-coded illegal dtb:depth value of -1
+into the toc.ncx navigation control file:
+
+ <ncx:meta name="dtb:depth" content="-1"/>
+
+Shouldn't it be a positive integer equal to the depth navPoint nesting in the
+navMap element (see
+http://www.niso.org/workrooms/daisy/Z39-86-2005.html#NavMeta)? Though epubcheck 1.05 doesn't flag it as invalid -- are they both wrong?
+
[[X1]]
=== epub: untitled DocBook sidebar emits invalid XHTML
diff --git a/doc/faq.txt b/doc/faq.txt
index 58e9d78..e74e333 100644
--- a/doc/faq.txt
+++ b/doc/faq.txt
@@ -9,6 +9,26 @@ AsciiDoc Frequently Asked Questions
newer FAQs may apply to the trunk and not the current release.
======
+== 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
+DocBook XSL Stylesheets
+http://docbook.sourceforge.net/release/xsl/current/doc/html/toc.section.depth.html[toc.section.depth]
+parameter to 'dblatex' (using the `--param` option) or 'xsltproc'
+(using the `--stringparam` option). For example to show only chapter
+titles in the TOC of a 'book' document set 'toc.section.depth' to '0'.
+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"
+
+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
+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
diff --git a/examples/website/index.txt b/examples/website/index.txt
index d3863f7..9055582 100644
--- a/examples/website/index.txt
+++ b/examples/website/index.txt
@@ -161,18 +161,33 @@ documented in link:latexmath.pdf[this PDF file] and can be used in
AsciiDoc documents processed by `dblatex(1)`.
-Vim Syntax Highlighter
-----------------------
-An AsciiDoc syntax highlighter for the Vim text editor is included in
-the AsciiDoc distribution (see 'Appendix F' of the 'AsciiDoc User
-Guide' for details).
-
+Editor Support
+--------------
+- An AsciiDoc syntax highlighter for the Vim text editor is included in the
+ AsciiDoc distribution (see 'Appendix F' of the 'AsciiDoc User Guide' for
+details).
++
.Syntax highlighter screenshot
image::images/highlighter.png[height=250,caption="",link="images/highlighter.png"]
-Dag Wieers has implemented an alternative Vim syntax file for AsciiDoc
-which can be found here
-http://svn.rpmforge.net/svn/trunk/tools/asciidoc-vim/.
+- Dag Wieers has implemented an alternative Vim syntax file for AsciiDoc which
+ can be found here http://svn.rpmforge.net/svn/trunk/tools/asciidoc-vim/.
+- David Avsajanishvili has written a source highlighter for AsciiDoc
+ files for http://projects.gnome.org/gtksourceview/[GtkSourceView]
+ (used by http://projects.gnome.org/gedit/[gedit] and a number of
+ other applications). The project is hosted here:
+ https://launchpad.net/asciidoc-gtk-highlight
+- Florian Kaufman has written
+ http://code.google.com/p/sensorflo-emacs/source/browse/trunk/adoc-mode.el[adoc-mode.el]
+-- a major-mode for editing asciidoc files in Emacs.
+- Sun Tong has written an http://xpt.sourceforge.net/tools/doc-mode/[Emacs mode
+ for AsciiDoc fontlocking].
+- The http://xpt.sourceforge.net/[*Nix Power Tools project] has released an
+ http://xpt.sourceforge.net/tools/doc-mode/[AsciiDoc syntax highlighter for
+ Emacs].
+- Terrence Brannon has written
+ http://github.com/metaperl/asciidoc-el[AsciiDoc functions for
+ Emacs].
[[X5]]
@@ -197,11 +212,6 @@ Resources
Here are resources that I know of, if you know of more drop me a line
and I'll add them to the list.
-- David Avsajanishvili has written a source highlighter for AsciiDoc
- files for http://projects.gnome.org/gtksourceview/[GtkSourceView]
- (used by http://projects.gnome.org/gedit/[gedit] and a number of
- other applications). The project is hosted here:
- https://launchpad.net/asciidoc-gtk-highlight
- Check the link:INSTALL.html#X2[installation page] for packaged versions
of AsciiDoc.
- Alex Efros has written an HTML formatted
@@ -214,18 +224,6 @@ and I'll add them to the list.
http://www.wikimatrix.org/syntax.php[web page] that compares the
various Wiki markup syntaxes. An interesting attempt at Wiki markup
standardization is http://www.wikicreole.org/[CREOLE].
-- Terrence Brannon has written
- http://github.com/metaperl/asciidoc-el[AsciiDoc functions for
- Emacs].
-- Florian Kaufman has written
- http://code.google.com/p/sensorflo-emacs/source/browse/trunk/adoc-mode.el[adoc-mode.el]
- -- a major-mode for editing asciidoc files in Emacs.
-- Sun Tong has written an
- http://xpt.sourceforge.net/tools/doc-mode/[Emacs mode for AsciiDoc
- fontlocking].
-- The http://xpt.sourceforge.net/[*Nix Power Tools project] has
- released an http://xpt.sourceforge.net/tools/doc-mode/[AsciiDoc
- syntax highlighter for Emacs].
- Franck Pommereau has written
http://www.univ-paris12.fr/lacl/pommereau/soft/asciidoctest.html[Asciidoctest],
a program that doctests snippets of Python code within your Asciidoc
@@ -329,8 +327,7 @@ discussion group thread] for details.
- The http://www.netpromi.com/kirbybase_ruby.html[KirbyBase for Ruby]
database management system manual.
- The http://xpt.sourceforge.net/[*Nix Power Tools project] uses
- AsciiDoc for documentation and has released an Emacs syntax
- highlighter (see <<X2,Resources>> above).
+ AsciiDoc for documentation.
- The http://www.wesnoth.org/[Battle for Wesnoth] project uses
AsciiDoc for its http://www.wesnoth.org/wiki/WesnothManual[Manual]
in a number of different languages.
diff --git a/examples/website/layout1.conf b/examples/website/layout1.conf
index 5c090a8..4975824 100644
--- a/examples/website/layout1.conf
+++ b/examples/website/layout1.conf
@@ -42,7 +42,9 @@ ifdef::index-only[]
endif::index-only[]
<link rel="stylesheet" href="{stylesdir=.}/{theme={backend}}.css" type="text/css" />
{doctype-manpage}<link rel="stylesheet" href="{stylesdir=.}/{theme={backend}}-manpage.css" type="text/css" />
+ifdef::quirks[]
<link rel="stylesheet" href="{stylesdir=.}/{theme={backend}}-quirks.css" type="text/css" />
+endif::quirks[]
<link rel="stylesheet" href="{stylesdir=.}/layout1.css" type="text/css" />
<script type="text/javascript">
/*<![CDATA[*/
diff --git a/examples/website/layout1.css b/examples/website/layout1.css
index 8ae10e9..f35e498 100644
--- a/examples/website/layout1.css
+++ b/examples/website/layout1.css
@@ -1,5 +1,5 @@
body {
- background-color: white;
+ background-color: white;
margin: 1%;
}
@@ -8,35 +8,35 @@ h1 {
}
#layout-banner {
- background-color: #73a0c5;
+ background-color: #73a0c5;
color: white;
- font-family: sans-serif;
- text-align: left;
+ font-family: sans-serif;
+ text-align: left;
padding: 0.8em 20px;
}
#layout-title {
- font-family: monospace;
- font-size: 3.5em;
- font-weight: bold;
+ font-family: monospace;
+ font-size: 3.5em;
+ font-weight: bold;
letter-spacing: 0.2em;
margin: 0;
}
#layout-description {
- font-size: 1.2em;
+ font-size: 1.2em;
letter-spacing: 0.1em;
}
#layout-menu {
- background-color: #f4f4f4;
+ background-color: #f4f4f4;
border-right: 3px solid #eeeeee;
padding-top: 0.8em;
padding-left: 20px;
padding-right: 0.8em;
- font-size: 1.1em;
- font-family: sans-serif;
- font-weight: bold;
+ font-size: 1.1em;
+ font-family: sans-serif;
+ font-weight: bold;
}
#layout-menu a {
line-height: 2em;
@@ -47,7 +47,7 @@ h1 {
text-decoration: none;
}
#layout-menu a:hover {
- color: navy;
+ color: navy;
text-decoration: none;
}
#layout-menu #page-source {
diff --git a/examples/website/layout2.css b/examples/website/layout2.css
index bff3245..ad0e9eb 100644
--- a/examples/website/layout2.css
+++ b/examples/website/layout2.css
@@ -9,7 +9,7 @@ body {
width: 100%;
height: 110px;
z-index: 2;
- background-color: #73a0c5;
+ background-color: #73a0c5;
}
#layout-menu-box {
@@ -19,14 +19,14 @@ body {
width: 175px;
height: 100%;
z-index: 1;
- background-color: #f4f4f4;
+ background-color: #f4f4f4;
}
#layout-content-box {
position: relative;
margin-top: 110px;
margin-left: 175px;
- background-color: white;
+ background-color: white;
}
h1 {
@@ -35,21 +35,21 @@ h1 {
#layout-banner {
color: white;
- font-family: sans-serif;
- text-align: left;
+ font-family: sans-serif;
+ text-align: left;
padding: 0.8em 20px;
}
#layout-title {
- font-family: monospace;
- font-size: 3.5em;
- font-weight: bold;
+ font-family: monospace;
+ font-size: 3.5em;
+ font-weight: bold;
letter-spacing: 0.2em;
margin: 0;
}
#layout-description {
- font-size: 1.2em;
+ font-size: 1.2em;
letter-spacing: 0.1em;
}
@@ -59,9 +59,9 @@ h1 {
padding-top: 0.8em;
padding-left: 20px;
padding-right: 0.8em;
- font-size: 1.0em;
- font-family: sans-serif;
- font-weight: bold;
+ font-size: 1.0em;
+ font-family: sans-serif;
+ font-weight: bold;
}
#layout-menu a {
line-height: 2em;
@@ -72,7 +72,7 @@ h1 {
text-decoration: none;
}
#layout-menu a:hover {
- color: navy;
+ color: navy;
text-decoration: none;
}
#layout-menu #page-source {
diff --git a/examples/website/main.aap b/examples/website/main.aap
index 0df59f9..f53013a 100644
--- a/examples/website/main.aap
+++ b/examples/website/main.aap
@@ -93,8 +93,6 @@ DOCS =
# AsciiDoc options to generate documentation HTML.
ASCIIDOC_HTML =
python ../../asciidoc.py -b xhtml11 -f $(LAYOUT).conf -a icons -a badges -a revnumber=$(VERS)@ -a revdate="$(DATE)@" -a max-width=70em
-@if LAYOUT == 'layout2':
- ASCIIDOC_HTML += -a quirks!
:rule %.html : %.txt $(LAYOUT).conf
@if target in ('userguide.html','faq.html'):
diff --git a/stylesheets/docbook-xsl.css b/stylesheets/docbook-xsl.css
index 4df7330..2d83d47 100644
--- a/stylesheets/docbook-xsl.css
+++ b/stylesheets/docbook-xsl.css
@@ -257,7 +257,6 @@ div.informaltable thead, div.informaltable tfoot
}
div.mediaobject img {
- border: 1px solid silver;
margin-bottom: 0.8em;
}
div.figure p.title,
diff --git a/stylesheets/xhtml11-quirks.css b/stylesheets/xhtml11-quirks.css
index b807a95..b3b46d2 100644
--- a/stylesheets/xhtml11-quirks.css
+++ b/stylesheets/xhtml11-quirks.css
@@ -37,5 +37,7 @@ div.exampleblock-content {
padding-left: 0.5em;
}
+div.imageblock.latex div.image-title { margin-top: 0.5em; }
+
/* IE6 sets dynamically generated links as visited. */
div#toc a:visited { color: blue; }
diff --git a/stylesheets/xhtml11.css b/stylesheets/xhtml11.css
index 2081150..bf7e43f 100644
--- a/stylesheets/xhtml11.css
+++ b/stylesheets/xhtml11.css
@@ -205,7 +205,6 @@ div.exampleblock > div.content {
div.imageblock div.content { padding-left: 0; }
span.image img { border-style: none; }
a.image:visited { color: white; }
-div.imageblock.latex div.image-title { margin-top: 0.5em; }
dl {
margin-top: 0.8em;
@@ -374,3 +373,4 @@ div.toclevel4 {
margin-left: 6em;
font-size: 0.9em;
}
+