=================================================================== RCS file: /home/cvs/OpenXM/src/asir-contrib/packages/doc/README,v retrieving revision 1.1.1.1 retrieving revision 1.5 diff -u -p -r1.1.1.1 -r1.5 --- OpenXM/src/asir-contrib/packages/doc/README 1999/11/27 11:25:18 1.1.1.1 +++ OpenXM/src/asir-contrib/packages/doc/README 2008/01/23 03:18:27 1.5 @@ -1,15 +1,54 @@ -%$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.4 2005/04/14 07:15:08 takayama 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 +------------------------------------------------------------- -tex cman.texi for English document +* How to generate the OpenXM-contrib documents: -ptex cman.texi for Japansese document +make install-document -Note that Japanese document is encoded in iso-2022-jp (JIS code). +You will get html, dvi, ps, pdf documents under the directories +${OpenXM_HOME}/doc/asir-contrib/en +and +${OpenXM_HOME}/doc/asir-contrib/ja +------------------------------------------------------ +* How to generate the OpenXM-contrib online helps: +make install +You will have online helps under the directories +${OpenXM_HOME}/lib/asir/help-eg/xm.help +and +${OpenXM_HOME}/lib/asir/help-jp/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 + +See todo_parametrize as an example. + +If it is not written in texinfo style, please only refer to top/misc.oxw +