Return to readme-ja.txt CVS log

Up to [local] / OpenXM / src / util

Annotation of OpenXM/src/util/readme-ja.txt, Revision 1.2

1.2     ! takayama    1: $OpenXM: OpenXM/src/util/readme-ja.txt,v 1.1 2005/04/05 13:12:06 takayama Exp $
1.1       takayama    2:
                      3: $B;H$$$+$?$N4JC1$J2r@b$r$H$j$"$($:$3$N%U%!%$%k$K=q$/(B.
                      4:
                      5: oxgentexi:   $B4X?t$N;EMM$+$i(B texi $B%U%!%$%k$r@8@.$9$k%D!<%k(B.
                      6:              asir-contrib $B$N%^%K%e%"%k:n@.$K;H$o$l$F$$$k(B.
                      7: oxreplace:   $BJ8;zNs$NCV$-49$($r9T$J$&%D!<%k(B.
                      8:              latex2html $B$G:n$i$l$?%U%!%$%k$K:Y9)$9$k$N$K;H$o$l$F$$$k(B.
                      9: oxweave:     $B0l$D$N%U%!%$%k$K1Q8l$N%I%-%e%a%s%H$dF|K\8l$N%I%-%e%a%s%H=q$$$F(B
                     10:             $B$*$$$F$=$l$r(B oxweave $B$GJ,2r$9$k(B. oxgentexi $B$HAH$G$b;H$&(B.
                     11:             speficication $B$d(B asir-contrib $B$N%^%K%e%"%k$G;H$C$F$k(B.
                     12:
                     13: [oxgentexi]
                     14:   oxgentexi $B$X$NF~NO$O(B item $B$H$$$&C10L$G4IM}$5$l$F$$$k(B.
                     15:   $B0l$D$N(B item $B$O(B $B%-!<%o!<%I(B begin:  $B$G$O$8$^$j(B,
                     16:   end: $B$G$*$o$k(B.
                     17:   begin: ~ end: $B$N30$N%G!<%?$O$9$Y$FFI$_Ht$P$5$l$k(B.
                     18:   : ($B%3%m%s(B) $B$G$*$o$kC18l$O(B oxgentexi $B$G$O%-!<%o!<%I$H$J$k(B.
                     19:   $B%3%m%s$rF~NO$9$k$K$O(B @colon $B$rMQ$$$k(B.
                     20:
                     21:   $B%3%m%s$G$*$o$k%-!<%o!<%I$N<!$K$O$+$J$i$:6uGr$+2~9T$r$$$l$k$3$H(B.
                     22:
1.2     ! takayama   23:   item $B$O8=:_$N$H$3$m(B
        !            24:     (1) asir$B4X?t(Bitem
        !            25:   $B$H(B
        !            26:     (2) verbatim item
        !            27:   $B$N(B2$B<oN`$,$"$k(B.
1.1       takayama   28:
                     29:   verbatim item $B$O<!$N$h$&$K=q$/(B.
                     30:   begin:  key|
                     31:     texinfo $B7A<0$NF~NO(B.
                     32:   end:
                     33:
                     34:   key $B$O1Q?t;z$NJB$S$G$"$k(B. key $B$K$D$$$F$O8e=R(B.
                     35:   | $B$N$"$H$K(B texinfo $B7A<0$NF~NO$r=q$/$H$=$l$,$=$N$^$^=PNO$5$l$k(B.
                     36:
                     37:   asir$B4X?t(Bitem $B$O<!$N$h$&$K=q$/(B.
                     38:   begin:  fname(arg1,arg2,...)
1.2     ! takayama   39:      short description of the function fname.
1.1       takayama   40:   description:
                     41:      explain about fname. It accepts texinfo inputs.
                     42:   example:
                     43:      X=fname(2,3);
                     44:      Y=fctr(X);
                     45:   exampleDescription:
                     46:     explain about the example.
                     47:   ref:
1.2     ! takayama   48:     xxx,yyy
1.1       takayama   49:   end:
                     50:
                     51:   example: $B$NCf$G$O(B { } $B$d(B @ $B$O(B texinfo $B$NFC<l5-9f$H$7$F$O07$o$l$J$$(B.
                     52:
                     53:   item $B$O(B key $B$K$h$j(B $B%=!<%H$5$l$F$+$i=PNO$5$l$k(B.
                     54:   asir$B4X?t(Bitem $B$N>l9g$O(B fname $B$,(B key $B$H$J$k(B.
                     55:   key $B$rJQ99$9$k$K$O(B sortKey: $B%-!<%o!<%I$G;XDj$9$k(B.
1.2     ! takayama   56:   sortKey: $B%-!<%o!<%I$O(B short description $B0J9_$K=q$+$J$$$H$$$1$J$$(B.
        !            57:
        !            58:   ref: $B$N8e$m$K$O;2>H$9$Y$-4X?tL>(B (asir$B4X?t(Bitem $B$NL>A0(B)$B$r(B $B%3%s%^$G6h@Z$C$F(B
        !            59:   $BF~NO$9$k(B.
        !            60:
        !            61:   short description $B0J9_$K;H$($k$=$NB>$N%-!<%o!<%I(B.
        !            62:   algorithm:  $B%"%k%4%j%:%`$N2r@b$r=q$/(B.
        !            63:   author:     $B%W%m%0%i%`$N:n<T$r=q$/(B.
        !            64:
1.1       takayama   65:
                     66: [$B%*%W%7%g%s(B|oxgentexi]
                     67:
                     68:   --noSorting    key $B$G%=!<%H$7$J$$(B.
                     69:   --title        texinfo $B%U%!%$%k$N(B title $B$r;XDj$9$k(B. $B$3$l$N;XDj$,$"$k$H(B,
                     70:                  $BI=Bj$b=PNO$7$F40A4$J(B texinfo $B%U%!%$%k$r=PNO$9$k(B.
                     71:   --author       $BI=Bj$K$"$i$o$l$kCx<TL>(B.
                     72:   --infoFileName  info $B$N%U%!%$%kL>(B.
                     73:   --upnode
                     74:   --category
                     75:
                     76: [$BNc(B1|oxgentexi]
                     77:   $B0J2<$NNc$O(B
                     78:   nkf -e readme-ja.txt |oxweave ja| oxgentexi --title 'Test of oxgentexi' >test.texi
                     79:   ptex test.texi
                     80:   $B$H=hM}(B.
                     81: /*&ja
                     82:
                     83:   begin:  igcd(F,G)
                     84:     igcd $B$O@0?t(B {F} $B$H(B {G} $B$N:GBg8xLs?t$r7W;;$9$k(B.
                     85:   example:
                     86:     igcd(5,3);
                     87:   example_description:
                     88:     5 $B$H(B 3 $B$N(B gcd $B$N7W;;(B. $BEz$($O(B 1.
                     89:   example:
                     90:     igcd(10,15);
                     91:   example_description:
                     92:     10 $B$H(B 15 $B$N(B gcd $B$N7W;;(B. $BEz$($O(B 5.
                     93:
                     94:   end:
                     95:
                     96:   begin:  fctr(F)
                     97:     fctr $B$OB?9`<0(B{F} $B$r0x?tJ,2r$9$k(B.
                     98:   description:
                     99:    @table @b
                    100:    @item $B%"%k%4%j%:%`(B
                    101:     $B0x?tJ,2r$K$O(B Berlkamp $B$N%"%k%4%j%:%`$rMQ$$$k(B.
                    102:    @item $BCm0U(B
                    103:     $B%J%C%W%5%C%/%"%k%4%j%:%`$O$^$@<BAu$7$F$J$$(B.
                    104:    @end table
                    105:   example:
                    106:    fctr(x^10-1);
                    107:
                    108:   end:
                    109:
                    110: */
                    111:
                    112: [$BNc(B2|oxgentexi]
                    113:   $B0J2<$NNc$O(B
                    114:   nkf -e readme-ja.txt |oxweave ja2| oxgentexi --noSorting --title 'Test 2 of oxgentexi' >test2.texi
                    115:
                    116:   ptex test2.texi
                    117:   $B$H=hM}(B.
                    118: /*&ja2
                    119:   begin: start|
                    120:   @section $B4X?t$N>R2p(B.
                    121:
                    122:    $B$3$N@a$G$O=iJbE*$J4X?t$r>R2p$9$k(B.
                    123:
                    124:   end:
                    125:
                    126:   begin:  igcd(F,G)
                    127:     igcd $B$O@0?t(B {F} $B$H(B {G} $B$N:GBg8xLs?t$r7W;;$9$k(B.
                    128:   example:
                    129:     igcd(5,3);
                    130:   example_description:
                    131:     5 $B$H(B 3 $B$N(B gcd $B$N7W;;(B. $BEz$($O(B 1.
                    132:   example:
                    133:     igcd(10,15);
                    134:   example_description:
                    135:     10 $B$H(B 15 $B$N(B gcd $B$N7W;;(B. $BEz$($O(B 5.
                    136:
                    137:   end:
                    138:
                    139:   begin:  fctr(F)
                    140:     fctr $B$OB?9`<0(B{F} $B$r0x?tJ,2r$9$k(B.
                    141:   description:
                    142:    @table @b
                    143:    @item $B%"%k%4%j%:%`(B
                    144:     $B0x?tJ,2r$K$O(B Berlkamp $B$N%"%k%4%j%:%`$rMQ$$$k(B.
                    145:    @item $BCm0U(B
                    146:     $B%J%C%W%5%C%/%"%k%4%j%:%`$O$^$@<BAu$7$F$J$$(B.
                    147:    @end table
                    148:   example:
                    149:    fctr(x^10-1);
                    150:
                    151:   end:
                    152:
                    153:   begin: owari|
                    154:
                    155:   @section $B=*$j$N>O(B
                    156:   $B$3$l$G$*$7$^$$(B.
                    157:
                    158:   end:
                    159: */
                    160:
1.2     ! takayama  161:
        !           162: [oxweave]
        !           163:
        !           164: oxweave [--plain] [--source] [--recursive] [key1 key2 ...]
        !           165: oxweave reads bytes from the standarndard input stream
        !           166: and outputs them if one of the following conditions
        !           167: is satisfied:
        !           168: (1) hogehoge is output if hogehoge is enclosed
        !           169:     like /*&xyz  hogehoge */ and xyz matches with one of the keys
        !           170: (2) hogehoge is output if hogehoge comes after //&xyz
        !           171:     followed with the newline and xyz matches with one of the keys
        !           172: (3) If the option --plain is given, all texts out of /*&xyz */ and //&xyz
        !           173:     are output.
        !           174: (4) If the option --recursive is given, the symbol */ is treated recursively.
        !           175: (5) --debug is used to find unmatched /* and */
        !           176: Example 1: oxweave --source ja <oxweave.c >t.tex
        !           177:
        !           178: Example 2: oxweave  ja <oxweave.c >t.tex
        !           179:   ja $B$,(B $B%-!<$J$N$G(B  /*&ja  $B$H(B */ $B$G0O$^$l$?ItJ,$,<h$j=P$5$l$k(B.
        !           180:
        !           181: Example 3: oxweave --plain  <oxweave.c >t.tex
        !           182:
        !           183: [oxreplace]
        !           184:
        !           185: oxreplace $B$G$O%U%!%$%k(B file1 file2 ... $B$,(B overwrite $B$5$l$k(B.
        !           186:
        !           187: oxreplace [--old oword --new nword --f rule_file_name]
        !           188:           [file1 file2 ... ]
        !           189:     Use --oldx or --newx to give a word in hexadeciam codes
1.1       takayama  190: