mizuho 0.9.6 → 0.9.8

data/asciidoc/doc/article.txt

@@ -1,122 +1,139 @@
-The Article Title
-=================
-Author's Name <authors@email.address>
-v1.0, Dec 2003
-
-
-This is the optional preamble (an untitled section body). Useful for
-writing simple sectionless documents consisting only of a preamble.
-
-
-Abstract
---------
-The optional abstract (one or more paragraphs) goes here.
-
-This document is an AsciiDoc article skeleton containing briefly
-annotated element placeholders plus a couple of example index entries
-and footnotes. The preface, appendix, bibliography, glossary and index
-section titles are significant ('specialsections').
-
-
-The First Section
------------------
-Article sections start at level 1 and can be nested up to four levels
-deep.
-footnote:[An example footnote.]
-indexterm:[Example index entry]
-
-And now for something completely different: ((monkeys)), lions and
-tigers (Bengal and Siberian) using the alternative syntax index
-entries.
-(((Big cats,Lions)))
-(((Big cats,Tigers,Bengal Tiger)))
-(((Big cats,Tigers,Siberian Tiger)))
-Note that multi-entry terms generate separate index entries.
-
-Here are a couple of image examples: an image:images/smallnew.png[]
-example inline image followed by an example block image:
-
-.Tiger block image
-image::images/tiger.png[Tiger image]
-
-Followed by an example table:
-
-.An example table
-[width="60%",options="header"]
-|==============================================
-| Option          | Description
-| -a 'USER GROUP' | Add 'USER' to 'GROUP'.
-| -R 'GROUP'      | Disables access to 'GROUP'.
-|==============================================
-
-[[X1]]
-Sub-section with Anchor
-~~~~~~~~~~~~~~~~~~~~~~~
-Sub-section at level 2.
-
-A Nested Sub-section
-^^^^^^^^^^^^^^^^^^^^
-Sub-section at level 3.
-
-Yet another nested Sub-section
-++++++++++++++++++++++++++++++
-Sub-section at level 4.
-
-This is the maximum sub-section depth supported by the distributed
-AsciiDoc configuration.
-footnote:[A second example footnote.]
-
-
-The Second Section
-------------------
-Article sections are at level 1 and can contain sub-sections nested up
-to four deep.
-
-An example link to anchor at start of the <<X1,first sub-section>>.
-indexterm:[Second example index entry]
-
-An example link to a bibliography entry <<taoup>>.
-
-Appendix A: Example Appendix
-----------------------------
-AsciiDoc article appendices are just just article sections with
-'specialsection' titles.
-
-Appendix Sub-section
-~~~~~~~~~~~~~~~~~~~~
-Appendix sub-section at level 2.
-
-
-Bibliography
-------------
-The bibliography list is a style of AsciiDoc bulleted list.
-
-[bibliography]
-- [[[taoup]]] Eric Steven Raymond. 'The Art of Unix
-  Programming'. Addison-Wesley. ISBN 0-13-142901-9.
-- [[[walsh-muellner]]] Norman Walsh & Leonard Muellner.
-  'DocBook - The Definitive Guide'. O'Reilly & Associates. 1999.
-  ISBN 1-56592-580-7.
-
-
-Glossary
---------
-Glossaries are optional. Glossaries entries are an example of a style
-of AsciiDoc labeled lists.
-
-[glossary]
-A glossary term::
-  The corresponding (indented) definition.
-
-A second glossary term::
-  The corresponding (indented) definition.
-
-
-ifdef::backend-docbook[]
-Index
------
-////////////////////////////////////////////////////////////////
-The index is normally left completely empty, it's contents being
-generated automatically by the DocBook toolchain.
-////////////////////////////////////////////////////////////////
-endif::backend-docbook[]
+The Article Title
+=================
+Author's Name <authors@email.address>
+v1.0, 2003-12
+
+
+This is the optional preamble (an untitled section body). Useful for
+writing simple sectionless documents consisting only of a preamble.
+
+NOTE: The abstract, preface, appendix, bibliography, glossary and
+index section titles are significant ('specialsections').
+
+
+:numbered!:
+[abstract]
+Example Abstract
+----------------
+The optional abstract (one or more paragraphs) goes here.
+
+This document is an AsciiDoc article skeleton containing briefly
+annotated element placeholders plus a couple of example index entries
+and footnotes.
+
+:numbered:
+
+The First Section
+-----------------
+Article sections start at level 1 and can be nested up to four levels
+deep.
+footnote:[An example footnote.]
+indexterm:[Example index entry]
+
+And now for something completely different: ((monkeys)), lions and
+tigers (Bengal and Siberian) using the alternative syntax index
+entries.
+(((Big cats,Lions)))
+(((Big cats,Tigers,Bengal Tiger)))
+(((Big cats,Tigers,Siberian Tiger)))
+Note that multi-entry terms generate separate index entries.
+
+Here are a couple of image examples: an image:images/smallnew.png[]
+example inline image followed by an example block image:
+
+.Tiger block image
+image::images/tiger.png[Tiger image]
+
+Followed by an example table:
+
+.An example table
+[width="60%",options="header"]
+|==============================================
+| Option          | Description
+| -a 'USER GROUP' | Add 'USER' to 'GROUP'.
+| -R 'GROUP'      | Disables access to 'GROUP'.
+|==============================================
+
+.An example example
+===============================================
+Lorum ipum...
+===============================================
+
+[[X1]]
+Sub-section with Anchor
+~~~~~~~~~~~~~~~~~~~~~~~
+Sub-section at level 2.
+
+A Nested Sub-section
+^^^^^^^^^^^^^^^^^^^^
+Sub-section at level 3.
+
+Yet another nested Sub-section
+++++++++++++++++++++++++++++++
+Sub-section at level 4.
+
+This is the maximum sub-section depth supported by the distributed
+AsciiDoc configuration.
+footnote:[A second example footnote.]
+
+
+The Second Section
+------------------
+Article sections are at level 1 and can contain sub-sections nested up
+to four deep.
+
+An example link to anchor at start of the <<X1,first sub-section>>.
+indexterm:[Second example index entry]
+
+An example link to a bibliography entry <<taoup>>.
+
+
+:numbered!:
+
+[appendix]
+Example Appendix
+----------------
+AsciiDoc article appendices are just just article sections with
+'specialsection' titles.
+
+Appendix Sub-section
+~~~~~~~~~~~~~~~~~~~~
+Appendix sub-section at level 2.
+
+
+[bibliography]
+Example Bibliography
+--------------------
+The bibliography list is a style of AsciiDoc bulleted list.
+
+[bibliography]
+- [[[taoup]]] Eric Steven Raymond. 'The Art of Unix
+  Programming'. Addison-Wesley. ISBN 0-13-142901-9.
+- [[[walsh-muellner]]] Norman Walsh & Leonard Muellner.
+  'DocBook - The Definitive Guide'. O'Reilly & Associates. 1999.
+  ISBN 1-56592-580-7.
+
+
+[glossary]
+Example Glossary
+----------------
+Glossaries are optional. Glossaries entries are an example of a style
+of AsciiDoc labeled lists.
+
+[glossary]
+A glossary term::
+  The corresponding (indented) definition.
+
+A second glossary term::
+  The corresponding (indented) definition.
+
+
+ifdef::backend-docbook[]
+[index]
+Example Index
+-------------
+////////////////////////////////////////////////////////////////
+The index is normally left completely empty, it's contents being
+generated automatically by the DocBook toolchain.
+////////////////////////////////////////////////////////////////
+endif::backend-docbook[]

data/asciidoc/doc/asciidoc.1

@@ -1,31 +1,48 @@
+'\" t
 .\"     Title: asciidoc
-.\"    Author: 
-.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
-.\"      Date: 01/02/2009
-.\"    Manual: 
-.\"    Source: 
+.\"    Author: [see the "AUTHOR" section]
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\"      Date: 20 May 2011
+.\"    Manual: \ \&
+.\"    Source: \ \& 8.6.5
+.\"  Language: English
 .\"
-.TH "ASCIIDOC" "1" "01/02/2009" "" ""
+.TH "ASCIIDOC" "1" "20 May 2011" "\ \& 8\&.6\&.5" "\ \&"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
 .\" disable hyphenation
 .nh
 .\" disable justification (adjust text to left margin only)
 .ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
 .SH "NAME"
-asciidoc - converts an AsciiDoc text file to DocBook, HTML or LinuxDoc
+asciidoc \- converts an AsciiDoc text file to HTML or DocBook
 .SH "SYNOPSIS"
-\fBasciidoc\fR [\fIOPTIONS\fR] \fIFILE\fR
 .sp
+\fBasciidoc\fR [\fIOPTIONS\fR] \fIFILE\fR
 .SH "DESCRIPTION"
-The asciidoc(1) command translates the AsciiDoc text file \fIFILE\fR to a DocBook, HTML or LinuxDoc file\. If \fIFILE\fR is \fI\-\fR then the standard input is used\.
 .sp
+The asciidoc(1) command translates the AsciiDoc text file \fIFILE\fR to DocBook or HTML\&. If \fIFILE\fR is \fI\-\fR then the standard input is used\&.
 .SH "OPTIONS"
 .PP
 \fB\-a, \-\-attribute\fR=\fIATTRIBUTE\fR
 .RS 4
-Define or delete document attribute\.
+Define or delete document attribute\&.
 \fIATTRIBUTE\fR
 is formatted like
-\fINAME=VALUE\fR\. Command\-line attributes take precedence over document and configuration file attributes\. Alternate acceptable forms are
+\fINAME=VALUE\fR\&. Command\-line attributes take precedence over document and configuration file attributes\&. Alternate acceptable forms are
 \fINAME\fR
 (the
 \fIVALUE\fR
@@ -34,24 +51,44 @@ defaults to an empty string);
 (delete the
 \fINAME\fR
 attribute);
-\fINAME@\fR
-(do not override document or configuration file attributes)\. Values containing spaces should be enclosed in double\-quote characters\. This option may be specified more than once\.
+\fINAME=VALUE@\fR
+(do not override document or configuration file attributes)\&. Values containing spaces should be enclosed in double\-quote characters\&. This option may be specified more than once\&. A special attribute named
+\fItrace\fR
+controls the output of diagnostic information\&.
 .RE
 .PP
 \fB\-b, \-\-backend\fR=\fIBACKEND\fR
 .RS 4
 Backend output file format:
-\fIdocbook\fR,
-\fIxhtml11\fR
+\fIdocbook45\fR,
+\fIxhtml11\fR,
+\fIhtml4\fR,
+\fIwordpress\fR
 or
-\fIhtml4\fR\. Defaults to
-\fIxhtml11\fR\.
+\fIlatex\fR
+(the
+\fIlatex\fR
+backend is experimental)\&. You can also the backend alias names
+\fIhtml\fR
+(aliased to
+\fIxhtml11\fR) or
+\fIdocbook\fR
+(aliased to
+\fIdocbook45\fR)\&. Defaults to
+\fIhtml\fR\&.
 .RE
 .PP
 \fB\-f, \-\-conf\-file\fR=\fICONF_FILE\fR
 .RS 4
 Use configuration file
-\fICONF_FILE\fR\.Configuration files processed in command\-line order (after implicit configuration files)\. This option may be specified more than once\.
+\fICONF_FILE\fR\&.Configuration files processed in command\-line order (after implicit configuration files)\&. This option may be specified more than once\&.
+.RE
+.PP
+\fB\-\-doctest\fR
+.RS 4
+Run Python doctests in
+\fIasciidoc\fR
+module\&.
 .RE
 .PP
 \fB\-d, \-\-doctype\fR=\fIDOCTYPE\fR
@@ -60,73 +97,147 @@ Document type:
 \fIarticle\fR,
 \fImanpage\fR
 or
-\fIbook\fR\. The
+\fIbook\fR\&. The
 \fIbook\fR
 document type is only supported by the
 \fIdocbook\fR
-backend\. Default document type is
-\fIarticle\fR\.
+backend\&. Default document type is
+\fIarticle\fR\&.
 .RE
 .PP
 \fB\-c, \-\-dump\-conf\fR
 .RS 4
-Dump configuration to stdout\.
+Dump configuration to stdout\&.
+.RE
+.PP
+\fB\-\-filter\fR
+.RS 4
+Manage asciidoc(1) filters (see
+\fBFILTER COMMANDS\fR)\&.
 .RE
 .PP
-\fB\-h, \-\-help\fR[=\fITOPIC\fR]
+\fB\-h, \-\-help\fR [\fITOPIC\fR]
 .RS 4
-Print help TOPIC\.
-\fB\-\-help\fR=\fItopics\fR
+Print help TOPIC\&.
+\fB\-\-help\fR
+\fItopics\fR
 will print a list of help topics,
-\fB\-\-help\fR=\fIsyntax\fR
+\fB\-\-help\fR
+\fIsyntax\fR
 summarizes AsciiDoc syntax,
-\fB\-\-help\fR=\fImanpage\fR
-prints the AsciiDoc manpage\.
+\fB\-\-help\fR
+\fImanpage\fR
+prints the AsciiDoc manpage\&.
 .RE
 .PP
 \fB\-e, \-\-no\-conf\fR
 .RS 4
-Exclude implicitly loaded configuration files except for those named like the input file (\fIinfile\.conf\fR
+Exclude implicitly loaded configuration files except for those named like the input file (\fIinfile\&.conf\fR
 and
-\fIinfile\-backend\.conf\fR)\.
+\fIinfile\-backend\&.conf\fR)\&.
 .RE
 .PP
 \fB\-s, \-\-no\-header\-footer\fR
 .RS 4
-Suppress document header and footer output\.
+Suppress document header and footer output\&.
 .RE
 .PP
 \fB\-o, \-\-out\-file\fR=\fIOUT_FILE\fR
 .RS 4
 Write output to file
-\fIOUT_FILE\fR\. Defaults to the base name of input file with
+\fIOUT_FILE\fR\&. Defaults to the base name of input file with
 \fIbackend\fR
-extension\. If the input is stdin then the outfile defaults to stdout\. If
+extension\&. If the input is stdin then the outfile defaults to stdout\&. If
 \fIOUT_FILE\fR
 is
 \fI\-\fR
-then the standard output is used\.
+then the standard output is used\&.
 .RE
 .PP
 \fB\-n, \-\-section\-numbers\fR
 .RS 4
-Auto\-number HTML article section titles\. Synonym for
-\fB\-a numbered\fR\.
+Auto\-number HTML article section titles\&. Synonym for
+\fB\-a numbered\fR\&.
 .RE
 .PP
-\fB\-\-unsafe\fR
+\fB\-\-safe\fR
 .RS 4
-Disable safe mode\. Safe mode is enabled by default, disabling it is potentially dangerous\.
+Enable safe mode\&. Safe mode is disabled by default\&. AsciiDoc
+\fIsafe mode\fR
+skips potentially dangerous scripted sections in AsciiDoc source files\&.
 .RE
 .PP
 \fB\-v, \-\-verbose\fR
 .RS 4
-Verbosely print processing information and configuration file checks to stderr\.
+Verbosely print processing information and configuration file checks to stderr\&.
 .RE
 .PP
 \fB\-\-version\fR
 .RS 4
-Print program version number\.
+Print program version number\&.
+.RE
+.SH "FILTER COMMANDS"
+.sp
+The \fB\-\-filter\fR option is used to install, remove and list AsciiDoc filter plugins\&. Filter commands syntax:
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+asciidoc \-\-filter install ZIP_FILE [FILTERS_DIR]
+asciidoc \-\-filter remove FILTER_NAME [FILTERS_DIR]
+asciidoc \-\-filter list
+.fi
+.if n \{\
+.RE
+.\}
+.sp
+Where:
+.PP
+\fBFILTER_NAME\fR
+.RS 4
+A unique filter name containing only alphanumeric or underscore characters\&.
+.RE
+.PP
+\fBZIP_FILE\fR
+.RS 4
+A Zip file containing filter resources, the name must start with the filter name e\&.g\&.
+my_filter\-1\&.0\&.zip
+packages filter
+my_filter\&.
+.RE
+.PP
+\fBFILTERS_DIR\fR
+.RS 4
+The directory containing installed filters\&. Each filter is contained in its own separate subdirectory which has the same name as the filter\&.
+\fBFILTERS_DIR\fR
+defaults to the
+\&.asciidoc/filters
+directory in the user\(cqs home directory\&.
+.RE
+.sp
+The filter commands perform as follows:
+.PP
+\fBinstall\fR
+.RS 4
+Create a subdirectory in
+\fBFILTERS_DIR\fR
+with the same name as the filter then extract the
+\fBZIP_FILE\fR
+into it\&.
+.RE
+.PP
+\fBremove\fR
+.RS 4
+Delete the
+\fBFILTER_NAME\fR
+filter subdirectory and all its contents from the
+\fBFILTERS_DIR\fR\&.
+.RE
+.PP
+\fBlist\fR
+.RS 4
+List the names and locations of all installed filters (including standard filters installed in the global configuration directory)\&.
 .RE
 .SH "EXIT STATUS"
 .PP
@@ -137,19 +248,19 @@ Success
 .PP
 \fB1\fR
 .RS 4
-Failure (syntax or usage error; configuration error; document processing failure; unexpected error)\.
+Failure (syntax or usage error; configuration error; document processing failure; unexpected error)\&.
 .RE
 .SH "BUGS"
-See the AsciiDoc distribution BUGS file\.
 .sp
+See the AsciiDoc distribution BUGS file\&.
 .SH "AUTHOR"
-Written by Stuart Rackham, <srackham@gmail\.com>
 .sp
+AsciiDoc was originally written by Stuart Rackham\&. Many people have contributed to it\&.
 .SH "RESOURCES"
-SourceForge: http://sourceforge\.net/projects/asciidoc/
 .sp
-Main web site: http://www\.methods\.co\.nz/asciidoc/
+SourceForge: http://sourceforge\&.net/projects/asciidoc/
 .sp
+Main web site: http://www\&.methods\&.co\&.nz/asciidoc/
 .SH "COPYING"
-Copyright (C) 2002\-2008 Stuart Rackham\. Free use of this software is granted under the terms of the GNU General Public License (GPL)\.
 .sp
+Copyright (C) 2002\-2011 Stuart Rackham\&. Free use of this software is granted under the terms of the GNU General Public License (GPL)\&.