Return to guideline.txt CVS log

Up to [local] / OpenXM / src / asir-contrib

Annotation of OpenXM/src/asir-contrib/guideline.txt, Revision 1.9

1.9     ! takayama    1: $OpenXM: OpenXM/src/asir-contrib/guideline.txt,v 1.8 2005/03/26 23:25:46 takayama Exp $
1.1       takayama    2:
1.4       takayama    3: How to commit your asir program to asir-contrib? [2005, 3/24]
                      4:    1.  The name of your source code should be
                      5:             yourname_xyz.rr
1.8       takayama    6:        if xyz is a general name like matrix, prime, resultant, etc.
1.4       takayama    7:        The part "yourname" may be your nickname.
                      8:        Example:  noro_matrix.rr
1.8       takayama    9:        If xyz is not a general name, the part yourname_ is not necessary.
1.1       takayama   10:
                     11:        Your asir source should be at asir-contrib/packages/src.
1.5       takayama   12:        Or, you may make a new directory under asir-contrib/packages/src
                     13:        to put your programs and data.
1.6       takayama   14:        Example: asir-contrib/packages/src/todo_parametrize
1.4       takayama   15:
1.8       takayama   16:        Your may use both your own directory and the top level source code
                     17:        to load sources in the own directory.
1.6       takayama   18:        Example:  asir-contrib/packages/src/naka_mora
                     19:                  asir-contrib/packages/src/naka_mora.rr
1.5       takayama   20:
1.8       takayama   21:    2.  Please encapsulate your source code with modules.
1.6       takayama   22:        When you use the module name which represents a mathematical notion
1.4       takayama   23:        or a data structure,
                     24:        the module name should be
                     25:            pxxxx
                     26:        where "p" is your identifying prefix and xxxx is a name of mathematical
                     27:        notion or data structure name related to your module.
                     28:        Example: nmatrix  where "p" is "n" and "xxxx" is "matrix".
                     29:        Example: fres  where "p" is "f" and "xxxx" is "res" (or "resultant").
1.5       takayama   30:        Example: nmora  where "p" is "n" and "xxxx" is "mora".
1.4       takayama   31:
1.1       takayama   32:
1.9     ! takayama   33:    3.  Manuals should be written by the texinfo (gentexi, oxweave)
        !            34:        in English and/or Japanese.
1.6       takayama   35:        They are put under the directory
                     36:        asir-contrib/packagers/doc/'yourname_xyz'
1.4       takayama   37:        The Makefile asir-contrib/packagers/doc/'yourname_xyz'/Makefile
                     38:        is also necessary.
1.9     ! takayama   39:        Example 1: asir-contrib/packages/doc/todo_parametrize/Makefile
1.6       takayama   40:           asir-contrib/packages/doc/todo_parametrize/todo_parametrize_ja.texi
1.9     ! takayama   41:        Example 2: asir-contrib/packages/doc/plucker
1.4       takayama   42:
1.9     ! takayama   43:    4. You are welcome to use "oxweave & gentexi" to generate texinfo manual.
        !            44:       Example: asir-contrib/packages/doc/plucker/*.oxg, *.oxw
1.4       takayama   45:
                     46:    5. Please refer to papers that explain algorithms in your package
                     47:       from your texinfo manual.
                     48:
                     49:    6. Please include test data that you used to check the correctness
1.6       takayama   50:       of your implementation or to make demonstrations.
1.4       takayama   51:
1.7       takayama   52:    7. About function names of your module.
                     53:      Please use any names you like.
                     54:      However, please also include "long function names" separated by "_"
                     55:      such as  "total_degree".
1.4       takayama   56:
                     57:  Directory structure
                     58:  Windows:
                     59:      bin/
                     60:      lib/
                     61:      lib-asir-contrib/
                     62:
                     63:  Unix:
                     64:     lib/asir
                     65:     lib/asir-contrib
                     66:
                     67:  Documents (unix):
                     68:    Online manual (ja)
                     69:     lib/asir/help-jp/
                     70:     lib/asir/help-jp/'modulename.functionname'
                     71:
                     72:    HTML manual (ja)
1.9     ! takayama   73:     doc/asir-contrib/ja/cman-html/cman-ja_toc.html
        !            74:     doc/asir-contrib/ja/'yourname_xyz'-html/'yourname_xyz'_ja_toc.html