Return to README CVS log

Up to [local] / OpenXM / src / asir-contrib / packages / doc

Annotation of OpenXM/src/asir-contrib/packages/doc/README, Revision 1.7

1.7     ! takayama    1: %$OpenXM: OpenXM/src/asir-contrib/packages/doc/README,v 1.6 2009/02/14 08:34:38 takayama Exp $
1.4       takayama    2:
                      3: cd OpenXM/src/util; make install
                      4: cd OpenXM/src/asir-doc; make install
                      5: are required for "make install" or "make install-document"
                      6: in this directory.
                      7:
                      8: -------------------------------------------------------------
1.1       takayama    9:
1.3       takayama   10: * How to generate the OpenXM-contrib documents:
1.1       takayama   11:
1.3       takayama   12: make install-document
1.1       takayama   13:
1.3       takayama   14: You will get html, dvi, ps, pdf documents  under the directories
                     15: ${OpenXM_HOME}/doc/asir-contrib/en
                     16: and
                     17: ${OpenXM_HOME}/doc/asir-contrib/ja
1.1       takayama   18:
1.3       takayama   19: ------------------------------------------------------
                     20: * How to generate the OpenXM-contrib online helps:
1.1       takayama   21:
1.3       takayama   22: make install
1.2       takayama   23:
1.3       takayama   24: You will have online helps under the directories
                     25: ${OpenXM_HOME}/lib/asir/help-eg/xm.help
                     26: and
                     27: ${OpenXM_HOME}/lib/asir/help-jp/xm.help
1.2       takayama   28:
1.3       takayama   29: ------------------------------------------------------
                     30: * In order to get a document in the directory xxx,
                     31:   cd xxx
                     32:   make              ( generating texinfo files)
                     33:   make gen-dvi-ja   ( generating dvi (ja) documents)
                     34:   make gen-dvi-en   ( generating dvi (en) documents)
                     35:   make gen-html-ja  ( generating html (ja) documents)
                     36:   make gen-html-en  ( generating html (en) documents)
1.2       takayama   37:
1.1       takayama   38:
1.3       takayama   39: ---------------------------------------------------------
                     40: * How to write a new document for your package.
                     41:
                     42:   Please read oxgentexi/readme-ja.txt
1.1       takayama   43:
                     44:
                     45:
1.5       takayama   46: ------------------
                     47: How to add new documents?
                     48: Edit Makefile.in
                     49: Edit top/misc.oxw
1.6       takayama   50: Edit top/fix-links.sh
1.5       takayama   51:
                     52: See todo_parametrize as an example.
1.6       takayama   53: See also f_res and mt_graph.
1.5       takayama   54:
1.6       takayama   55: If it is not written in texinfo style, please only refer in top/misc.oxw
1.5       takayama   56:
1.6       takayama   57:
                     58: ------------------
                     59: How to check links to subdocuments.  (2009.02.14,  for texi2html 1.76 on Debian/Etch)
                     60: cd asir-contrib
                     61: rm .*done
                     62: ./make-configure
                     63: cd packages/doc
1.7     ! takayama   64: make install
1.6       takayama   65: make install-html-doc
                     66: make fix-links
                     67: cd ${OpenXM_HOME}/doc/asir-contrib/ja
1.7     ! takayama   68: and open cman-html/cman-ja/cman-ja.html
        !            69:
        !            70: The -split mode of texinfo makes different behavior between version.
        !            71: Asir contrib no longer uses the split mode.  2009.02.15