Return to guideline.txt CVS log

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

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

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