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.10

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