ubf/priv/doc

ADOC is a documentation environment using AsciiDoc as core component.
ADOC makes it easy to construct AsciiDoc documentation system.
ADOC can make single HTML, chunked HTML, PDF from one plain text data.
ADOC supports English and Japanese.

See http://www.methods.co.nz/asciidoc/ for further details.


== Install ADOC environment

=== Mac OS X - 10.6.7

1. install brew (http://mxcl.github.com/homebrew/)
2. install git brew package
   $ brew install git
3. install the following brew packages for ADOC
   $ brew install ImageMagick
   $ brew install asciidoc
   $ brew install dia
   $ brew install graphviz
   $ brew install mscgen
   $ brew install w3m

=== Linux - Fedora 14

1. install git rpm package
   $ yum install git
2. install wget rpm package
   $ yum install wget
3. install the following rpm packages for ADOC
   $ yum install ImageMagick
   $ yum install asciidoc
   $ yum install dia
   $ yum install graphviz
   $ wget -O /etc/yum.repos.d/mscgen.repo http://www.mcternan.co.uk/mscgen/yum/fedora/mscgen.repo
   $ yum install mscgen
   $ yum install dblatex
   $ yum install w3m

=== Windows - CYGWIN

TO BE ADDED


== Download UBF's (source code & documentation) repository

$ mkdir working-directory-name
$ cd working-directory-name
$ git clone git://github.com/ubf/ubf.git


== Build UBF's documentation guides

$ mkdir working-directory-name
$ cd working-directory-name/priv/doc/src/ubf
$ make clean -OR- make realclean
$ make

HTML documentation is written in the "./public_html" directory.


== Build UBF's website pages

$ mkdir working-directory-name
$ cd working-directory-name/priv/doc/src/ubf/website
$ make clean -OR- make realclean
$ make

HTML documentation is written in the "./public_html" directory.


== NOTES

1. The above recipe was tested on Mac OS X 10.6.7 using asciidoc 8.6.4
   and the following patch.  A fake lang-ja.conf file can easily be created by
   making a symlink to the lang-en.conf file.


diff -r -u 8.6.4-orig/bin/a2x.py 8.6.4/bin/a2x.py
--- 8.6.4-orig/bin/a2x.py	2011-04-24 00:50:26.000000000 +0900
+++ 8.6.4/bin/a2x.py	2011-04-24 00:35:55.000000000 +0900
@@ -156,7 +156,10 @@
 def shell_copy(src, dst):
     verbose('copying "%s" to "%s"' % (src,dst))
     if not OPTIONS.dry_run:
-        shutil.copy(src, dst)
+        try:
+            shutil.copy(src, dst)
+        except shutil.Error:
+            return

 def shell_rm(path):
     if not os.path.exists(path):
Only in 8.6.4/etc/asciidoc: lang-ja.conf