OpenXM/src/asir-contrib/guideline.txt - diff

Return to guideline.txt CVS log

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

Diff for /OpenXM/src/asir-contrib/guideline.txt between version 1.4 and 1.10

version 1.4, 2005/03/24 09:05:05

version 1.10, 2009/02/22 17:30:03

Line 1

$OpenXM: OpenXM/src/asir-contrib/guideline.txt,v 1.3 2000/03/23 11:54:07 takayama Exp $

$OpenXM: OpenXM/src/asir-contrib/guideline.txt,v 1.9 2005/04/20 22:58:58 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.

You may make a new directory under asir-contrib/packages/src

Or, you may make a new directory under asir-contrib/packages/src

to put your programs and data,

to put your programs and data.

but the top level file must be under asir-contrib/packages/src.

Example: asir-contrib/packages/src/todo_parametrize

2. Please encapsulate your source code

Your may use both your own directory and the top level source code

If you want to use the module name which represents a mathematical notion

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 modules.

When you use the module name which represents a mathematical notion

or a data structure,

the module name should be

pxxxx

Line 21 How to commit your asir program to asir-contrib? [2005

Line 27 How to commit your asir program to asir-contrib? [2005

notion or data structure name related to your module.

Example: nmatrix where "p" is "n" and "xxxx" is "matrix".

Example: fres where "p" is "f" and "xxxx" is "res" (or "resultant").

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)

They are put in asir-contrib/packagers/doc/'yourname_xyz'

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

4. You are welcome to use "oxweave & gentexi" to generate texinfo manual.

to use "oxweave" or "gdoc" (see http://texinfo.org).

Example: asir-contrib/packages/doc/plucker/*.oxg, *.oxw

5. Please refer to papers that explain algorithms in your package

from your texinfo manual.

6. Please include test data that you used to check the correctness

of your implementation.

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:

Line 51 How to commit your asir program to asir-contrib? [2005

Line 66 How to commit your asir program to asir-contrib? [2005

Documents (unix):

Online manual (ja)

lib/asir/help-jp/

lib/asir/help-ja/

lib/asir/help-jp/'modulename.functionname'

lib/asir/help-ja/'modulename.functionname'

HTML manual (ja)

doc/asir-contrib/help-ja/cman-ja_toc.html

doc/asir-contrib/ja/cman-html/cman-ja_toc.html

doc/asir-contrib/help-ja/'yourname_xyz'/'yourname_xyz'_ja_toc.html

doc/asir-contrib/ja/'yourname_xyz'-html/'yourname_xyz'_ja_toc.html

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>