version 1.1, 1999/11/27 11:25:18 |
version 1.7, 2009/02/15 01:51:12 |
|
|
%$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.6 2009/02/14 08:34:38 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 |
|
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 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 |