===================================================================
RCS file: /home/cvs/OpenXM/src/asir-contrib/guideline.txt,v
retrieving revision 1.6
retrieving revision 1.9
diff -u -p -r1.6 -r1.9
--- OpenXM/src/asir-contrib/guideline.txt	2005/03/24 22:07:15	1.6
+++ OpenXM/src/asir-contrib/guideline.txt	2005/04/20 22:58:58	1.9
@@ -1,22 +1,24 @@
-$OpenXM: OpenXM/src/asir-contrib/guideline.txt,v 1.5 2005/03/24 09:09:34 takayama Exp $
+$OpenXM: OpenXM/src/asir-contrib/guideline.txt,v 1.8 2005/03/26 23:25:46 takayama Exp $
 
 How to commit your asir program to asir-contrib? [2005, 3/24]
-
    1.  The name of your source code should be 
             yourname_xyz.rr
+       if xyz is a general name like matrix, prime, resultant, etc.
        The part "yourname" may be your nickname. 
        Example:  noro_matrix.rr
+       If xyz is not a general name, the part yourname_ is not necessary.
 
        Your asir source should be at asir-contrib/packages/src.
        Or, you may make a new directory under asir-contrib/packages/src
        to put your programs and data.
        Example: asir-contrib/packages/src/todo_parametrize
 
-       Your may use both your own directory and the top level source code.
+       Your may use both your own directory and the top level source code
+       to load sources in the own directory.
        Example:  asir-contrib/packages/src/naka_mora
                  asir-contrib/packages/src/naka_mora.rr
 
-   2.  Please encapsulate your source code with module.
+   2.  Please encapsulate your source code with modules.
        When you use the module name which represents a mathematical notion
        or a data structure,
        the module name should be 
@@ -28,16 +30,18 @@ How to commit your asir program to asir-contrib? [2005
        Example: nmora  where "p" is "n" and "xxxx" is "mora".
 
     
-   3.  Manuals should be written by the texinfo in English and/or Japanese.
+   3.  Manuals should be written by the texinfo (gentexi, oxweave)
+       in English and/or Japanese.
        They are put under the directory 
        asir-contrib/packagers/doc/'yourname_xyz'
        The Makefile asir-contrib/packagers/doc/'yourname_xyz'/Makefile
        is also necessary.
-       Example: asir-contrib/packages/doc/todo_parametrize/Makefile
+       Example 1: asir-contrib/packages/doc/todo_parametrize/Makefile
           asir-contrib/packages/doc/todo_parametrize/todo_parametrize_ja.texi
+       Example 2: asir-contrib/packages/doc/plucker
 
-   4. If you want to embed your manual in the source, you are welcome
-      to use "oxweave" or "gdoc" (see http://texinfo.org).
+   4. You are welcome to use "oxweave & gentexi" to generate texinfo manual.
+      Example: asir-contrib/packages/doc/plucker/*.oxg, *.oxw
 
    5. Please refer to papers that explain algorithms in your package
       from your texinfo manual.
@@ -45,6 +49,10 @@ How to commit your asir program to asir-contrib? [2005
    6. Please include test data that you used to check the correctness
       of your implementation or to make demonstrations.
 
+   7. About function names of your module.
+     Please use any names you like. 
+     However, please also include "long function names" separated by "_"
+     such as  "total_degree".
 
  Directory structure
  Windows:   
@@ -62,5 +70,5 @@ How to commit your asir program to asir-contrib? [2005
     lib/asir/help-jp/'modulename.functionname'
 
    HTML manual (ja)
-    doc/asir-contrib/help-ja/cman-ja_toc.html
-    doc/asir-contrib/help-ja/'yourname_xyz'/'yourname_xyz'_ja_toc.html
+    doc/asir-contrib/ja/cman-html/cman-ja_toc.html
+    doc/asir-contrib/ja/'yourname_xyz'-html/'yourname_xyz'_ja_toc.html