=================================================================== RCS file: /home/cvs/OpenXM/src/asir-contrib/packages/doc/README,v retrieving revision 1.1.1.1 retrieving revision 1.10 diff -u -p -r1.1.1.1 -r1.10 --- OpenXM/src/asir-contrib/packages/doc/README 1999/11/27 11:25:18 1.1.1.1 +++ OpenXM/src/asir-contrib/packages/doc/README 2010/02/13 04:38:36 1.10 @@ -1,15 +1,79 @@ -%$OpenXM: OpenXM/src/asir99/lib/contrib/packages/doc/README,v 1.1 1999/11/18 03:22:08 takayama Exp $ +%$OpenXM: OpenXM/src/asir-contrib/packages/doc/README,v 1.9 2009/02/22 17:30:03 ohara Exp $ -How to generate OpenXM-contrib document: +cd OpenXM/src/util; make install +cd OpenXM/src/asir-doc; make install +are required for "make install" or "make install-document" +in this directory. -make +------------------------------------------------------------- +* Reconstruct all +rm .*done ; make clean ; ./make-configure ; make +make install +** To check +${BROWSER} ${OpenXM_HOME}/doc/asir-contrib/ja/top/cman-html/cman-ja_toc.html +** Partial reconstruction +make clean --> e.g., cd top ; rm .*done +----------- +* How to generate the OpenXM-contrib documents: -tex cman.texi for English document +make install-document -ptex cman.texi for Japansese document +You will get html, dvi, ps, pdf documents under the directories +${OpenXM_HOME}/doc/asir-contrib/en +and +${OpenXM_HOME}/doc/asir-contrib/ja -Note that Japanese document is encoded in iso-2022-jp (JIS code). +------------------------------------------------------ +* How to generate the OpenXM-contrib online helps: +make install +You will have online helps under the directories +${OpenXM_HOME}/lib/asir/help-en/xm.help +and +${OpenXM_HOME}/lib/asir/help-ja/xm.help +------------------------------------------------------ +* In order to get a document in the directory xxx, + cd xxx + make ( generating texinfo files) + make gen-dvi-ja ( generating dvi (ja) documents) + make gen-dvi-en ( generating dvi (en) documents) + make gen-html-ja ( generating html (ja) documents) + make gen-html-en ( generating html (en) documents) + +--------------------------------------------------------- +* How to write a new document for your package. + + Please read oxgentexi/readme-ja.txt + + + +------------------ +How to add new documents? +Edit Makefile.in +Edit top/misc.oxw +Edit top/fix-links.sh + +See todo_parametrize as an example. +See also f_res and mt_graph. + +If it is not written in texinfo style, please only refer in top/misc.oxw + + +------------------ +How to check links to subdocuments. (2009.02.14, for texi2html 1.76 on Debian/Etch) +cd asir-contrib +rm .*done +./make-configure +cd packages/doc +make clean +make install +make install-html-doc +make fix-links +cd ${OpenXM_HOME}/doc/asir-contrib/ja +and open cman-html/cman-ja/cman-ja.html + +The -split mode of texinfo makes different behavior between version. +Asir contrib no longer uses the split mode. 2009.02.15