Generating Module documentation

Generating Module documentation

[Jannie Hofmeyr]

I am trying to generate the documentation of some of the ConTeXt modules.
When
running texexec --module foo it tries to input the files

\input modu-abr
\input modu-arg
\input modu-env
\input modu-mod
\input modu-pap

but cannot find them. Neither can I.

Hans or other expert, am I missing something?

Best regards
Jannie

------------------------------------
Prof. Jannie Hofmeyr
Dept. of Biochemistry, Univ. of Stellenbosch
Private Bag X1, Matieland 7602
South Africa
e-mail: jhsh@iafrica.com / jhsh@maties.sun.ac.za
tel. +27 21 808 3039
fax. +27 21 808 3022

Re: Generating Module documentation

[Ed L. Cashin]

Jannie Hofmeyr <jhsh@iafrica.com> writes:

> I am trying to generate the documentation of some of the ConTeXt modules.
> When
> running texexec --module foo it tries to input the files
> 
> \input modu-abr
> \input modu-arg
> \input modu-env
> \input modu-mod
> \input modu-pap
> 
> but cannot find them. Neither can I.
> 
> Hans or other expert, am I missing something?

Does it have to be an expert?  ;)

There was a thread last month about this.  Thomas Porter was asking
where to unzip cont-doc.zip, which is the zip file you need.  Hans and
Tobias said it goes in texmf, meaning that the modu-*.tex files wind
up in base.

You can get cont-doc.zip at the pragma website.

-- 
--Ed Cashin                     PGP public key:
  ecashin@coe.uga.edu           http://www.coe.uga.edu/~ecashin/pgp/

Re: Generating Module documentation

[Jannie Hofmeyr]

Ed Cashin answered my query about necessary files for producing module
documentation

> Does it have to be an expert?  ;)
>
> There was a thread last month about this.  Thomas Porter was asking
> where to unzip cont-doc.zip, which is the zip file you need.  Hans and
> Tobias said it goes in texmf, meaning that the modu-*.tex files wind
> up in base.
>
> You can get cont-doc.zip at the pragma website.

Sounds like expert advice to me ;-) Thanks.

I am sure this has been asked many times, but is this mailing list archived
somewhere?

Jannie

Re: Generating Module documentation

[Ed L. Cashin]

Jannie Hofmeyr <jhsh@iafrica.com> writes:

> I am sure this has been asked many times, but is this mailing list
> archived somewhere?

Matthew Baker is making one.  He says that he will have it online
RSN.

-- 
--Ed Cashin                     PGP public key:
  ecashin@coe.uga.edu           http://www.coe.uga.edu/~ecashin/pgp/

Re: Generating Module documentation

[Aditya Mahajan]

On Tue, 6 Jun 2006, Taco Hoekwater wrote:
> Aditya Mahajan wrote:
>> Hi,
>>   How does one generate module documentation? I copied mult-ini.tex to
>> a temp directory and did
>>
>> texmfstart texexec --modules mult-ini.tex
>
> It seems that 'texutil -- documents' is not implemented yet
> in the ruby scripts, so  you have to use the perl version
> instead (it is needed internally). This should do it:
>
>   texmfstart texutil.pl --documents mult-ini.tex
>   texmfstart texexec --module mult-ini.tex
>
On Tue, 6 Jun 2006, Hans Hagen wrote:

> ah, we have a new texutil noe (or actually, texutil is gone) ...
>
> in texexec.rb replace:
>
> job.runtexutil(ffname,"--documents", true)
>
> by
>                                    Kpse.runscript('ctxtools',ffname,'--document')

Thanks.

Aditya

Re: Generating Module documentation

[Hans Hagen]

Aditya Mahajan wrote:
> Hi,
>   How does one generate module documentation? I copied mult-ini.tex to 
> a temp directory and did
>
> texmfstart texexec --modules mult-ini.tex
>
> but did not get any output. Looking into texexec.rb, I tried to 
> recreate a temp file to generate the documentation. The following
>
> \usemodule[abr-01,mod-01]
> \def\ModuleNumber{1}
>
> \starttext
> \readlocfile{mult-ini.tex}{}{}
> \stoptext
>
> gives
>
> This is pdfeTeX, Version 3.141592-1.30.3-2.2 (Web2c 7.5.5) 
> (format=cont-en 2006.5.31)  5 JUN 2006 21:13
> entering extended mode
> \write18 enabled.
>   (e:\isoimage\usr\local\context\tex\texmf-local/web2c/natural.tcx)
> **f:/Research/real_time/examples/test2.tex \emergencyend
> (f:/Research/real_time/examples/test2.tex
>
> ConTeXt  ver: 2006.05.28 13:28  fmt: 2006.5.31  int: english  mes: 
> english
>
> language        : language en is active
> <protectionstate 0>
> system          : cont-new loaded
> (e:\isoimage\usr\local\context\tex\texmf-local/tex/context/base/cont-new.tex
> systems         : beware: some patches loaded from cont-new.tex
> color           : palette rollover is available
> )
> system          : cont-old loaded
> (e:\isoimage\usr\local\context\tex\texmf-local/tex/context/base/cont-old.tex
> loading         : Context Old Macros
> )
> system          : cont-fil loaded
> (e:\isoimage\usr\local\context\tex\texmf-local/tex/context/base/cont-fil.tex
> loading         : Context File Synonyms
> )
> system          : cont-sys loaded
> (e:\isoimage\usr\local\context\tex\texmf-local/tex/context/user/cont-sys.tex
> system          : module newmat loaded
> (e:\isoimage\usr\local\context\tex\texmf-local/tex/context/base/m-newmat.tex))
> bodyfont        : 12pt rm is loaded
> language        : patterns nl->texnansi:texnansi->1->2:3 
> nl->ec:ec->2->2:3 fr->
> texnansi:texnansi->3->2:3 fr->ec:ec->4->2:3 
> de->texnansi:texnansi->5->2:3 de->e
> c:ec->6->2:3 it->texnansi:texnansi->7->2:3 it->ec:ec->8->2:3 
> pt->texnansi:texna
> nsi->9->2:3 pt->ec:ec->10->2:3 hr->ec:ec->11->2:3 pl->pl0:pl0->12->2:3 
> pl->ec:e
> c->13->2:3 pl->qx:qx->14->2:3 cz->il2:il2->15->2:3 cz->ec:ec->16->2:3 
> sk->il2:i
> l2->17->2:3 sk->ec:ec->18->2:3 sl->ec:ec->19->2:3 en->ec:ec->21->2:3 
> uk->ec:ec-
>   
>> 22->2:3 us->ec:ec->23->2:3 agr->agr:agr->24->2:3 da->ec:ec->25->2:3 
>>     
> sv->ec:ec-
>   
>> 26->2:3 af->ec:ec->27->2:3 no->ec:ec->28->2:3 deo->ec:ec->29->2:3 
>>     
> es->ec:ec->3
> 0->2:3 ca->ec:ec->31->2:3 la->ec:ec->32->2:3 ro->ec:ec->33->2:3 
> tr->ec:ec->34->
> 2:3 fi->ec:ec->36->2:3 hu->ec:ec->37->2:3 loaded
> specials        : tex,postscript,rokicki loaded
> \openout2 = `test2.tui'.
>
> system          : test2.top loaded
> (./test2.top
> specials        : loading definition file tpd
> (e:\isoimage\usr\local\context\tex\texmf-local/tex/context/base/spec-tpd.tex
> specials        : loading definition file fdf
> (e:\isoimage\usr\local\context\tex\texmf-local/tex/context/base/spec-fdf.tex)
> specials        : fdf loaded
> )
> specials        : fdf,tpd loaded
> )
> \openout0 = `test2-mpgraph.mp'.
>
> \openout0 = `mpgraph.mp'.
>
>
> systems         : system commands are enabled
> system          : module abr-01 loaded
> (e:\isoimage\usr\local\context\tex\texmf-local/tex/context/base/s-abr-01.tex
> check           : logo AMSTEX replaces a macro, use CAPITALS!
> check           : logo CONTEXT replaces a macro, use CAPITALS!
> check           : logo ETEX replaces a macro, use CAPITALS!
> check           : logo LAMSTEX replaces a macro, use CAPITALS!
> check           : logo LATEX replaces a macro, use CAPITALS!
> check           : logo MATHML replaces a macro, use CAPITALS!
> check           : logo METAFONT replaces a macro, use CAPITALS!
> check           : logo METAPOST replaces a macro, use CAPITALS!
> check           : logo PDFETEX replaces a macro, use CAPITALS!
> check           : logo PDFTEX replaces a macro, use CAPITALS!
> check           : logo PICTEX replaces a macro, use CAPITALS!
> check           : logo PPCHTEX replaces a macro, use CAPITALS!
> check           : logo PRAGMA replaces a macro, use CAPITALS!
> check           : logo TABLE replaces a macro, use CAPITALS!
> check           : logo TEXADRES replaces a macro, use CAPITALS!
> check           : logo TEXEDIT replaces a macro, use CAPITALS!
> check           : logo TEXEXEC replaces a macro, use CAPITALS!
> check           : logo TEXFORM replaces a macro, use CAPITALS!
> check           : logo TEXSPELL replaces a macro, use CAPITALS!
> check           : logo TEXUTIL replaces a macro, use CAPITALS!
> check           : logo TEX replaces a macro, use CAPITALS!
> check           : logo XML replaces a macro, use CAPITALS!
> check           : logo XETEX replaces a macro, use CAPITALS!
> check           : logo METAFUN replaces a macro, use CAPITALS!
> )
> system          : module mod-01 loaded
> (e:\isoimage\usr\local\context\tex\texmf-local/tex/context/base/s-mod-01.tex
> system          : module mod-00 loaded
> (e:\isoimage\usr\local\context\tex\texmf-local/tex/context/base/s-mod-00.tex
> system          : module units loaded
> (e:\isoimage\usr\local\context\tex\texmf-local/tex/context/base/m-units.tex
> check           : unit Angstrom replaces a macro, use CAPITALS!
> ) <test2-lang-a.tmp>
> \openout4 = `test2-lang-a.tmp'.
>
>   <test2-lang-b.tmp>
> \openout4 = `test2-lang-b.tmp'.
>
>   <test2-lang-c.tmp>
> \openout4 = `test2-lang-c.tmp'.
>
>   <test2-lang-d.tmp>
> \openout4 = `test2-lang-d.tmp'.
>
>
> system          : module int-load loaded
> (e:\isoimage\usr\local\context\tex\texmf-local/tex/context/base/x-set-11.tex
> system          : module set-02 loaded
> (e:\isoimage\usr\local\context\tex\texmf-local/tex/context/base/x-set-02.tex
> (e:\isoimage\usr\local\context\tex\texmf-local/tex/context/base/mult-con.tex
> loading         : Context Multilingual Macros / Constants
> ) 
> (e:\isoimage\usr\local\context\tex\texmf-local/tex/context/base/mult-com.tex
> loading         : Context Multilingual Macros / Commands
> ))
> debugger        : message:: duplicate tag file in library setup of 
> interface en
> glish
> debugger        : message:: duplicate tag reference in library setup 
> of interfa
> ce english
> )
> (e:\isoimage\usr\local\context\tex\texmf-local/tex/context/interface/cont-en.xm
> l
> check           : eachtexcommand stp:x:defineinteractionmenu replaces 
> a macro,
> use CAPITALS!
> check           : texcommand stp:y:defineinteractionmenu replaces a 
> macro, use
> CAPITALS!
> )) 
> (e:\isoimage\usr\local\context\tex\texmf-local/tex/context/base/type-pre.tex
> ) 
> (e:\isoimage\usr\local\context\tex\texmf-local/tex/context/base/pdfr-ec.tex)
> color           : system rgb is global activated
> color           : color is converted to gray
> interaction     : active
> ) (./test2.tuo) (./test2.tuo) (./test2.tuo) (./test2.tuo) 
> (./test2.tuo)
> (./test2.tuo) (./test2.tuo) (./test2.tuo) (./test2.tuo) (./test2.tuo)
> (e:\isoimage\usr\local\context\tex\texmf-local/tex/context/base/sort-new.tex)
> (e:\isoimage\usr\local\context\tex\texmf-local/tex/context/base/sort-def.tex)
> (e:\isoimage\usr\local\context\tex\texmf-local/tex/context/base/sort-lan.tex)
> (./test2.tuo) (./test2.tuo)
> systems         : begin file test2 at line 4
> (./mult-ini.tex
> loading         : Context Multilingual Macros / Initialization
> )
> systems         : end file test2 at line 6
>   )
> Here is how much of TeX's memory you used:
>   5277 strings out of 220738
>   95875 string characters out of 1298206
>   3054069 words of memory out of 4496831
>   43886 multiletter control sequences out of 10000+100000
>   124827 words of font info for 62 fonts, out of 1000000 for 2000
>   232 hyphenation exceptions out of 8191
>   58i,2n,55p,632b,1694s stack positions out of 
> 10000i,500n,6000p,200000b,40000s
> PDF statistics:
>   1 PDF objects out of 300000
>   0 named destinations out of 131072
>   5 words of extra memory for PDF output out of 10000
>
> No pages of output.
>
>
> How does one generate documentation? Does it require some perl script? 
> (I do not have perl in my path)
>   
ah, we have a new texutil noe (or actually, texutil is gone) ... 

in texexec.rb replace: 
 
job.runtexutil(ffname,"--documents", true)

by 
                                    Kpse.runscript('ctxtools',ffname,'--document')

Hans 

-----------------------------------------------------------------
                                          Hans Hagen | PRAGMA ADE
              Ridderstraat 27 | 8061 GH Hasselt | The Netherlands
     tel: 038 477 53 69 | fax: 038 477 53 74 | www.pragma-ade.com
                                             | www.pragma-pod.nl
-----------------------------------------------------------------

Re: Generating Module documentation

[Taco Hoekwater]

Aditya Mahajan wrote:
> Hi,
>   How does one generate module documentation? I copied mult-ini.tex to 
> a temp directory and did
> 
> texmfstart texexec --modules mult-ini.tex

It seems that 'texutil -- documents' is not implemented yet
in the ruby scripts, so  you have to use the perl version
instead (it is needed internally). This should do it:

   texmfstart texutil.pl --documents mult-ini.tex
   texmfstart texexec --module mult-ini.tex

Cheers, taco

Generating Module documentation

[Aditya Mahajan]

Hi,
  How does one generate module documentation? I copied mult-ini.tex to 
a temp directory and did

texmfstart texexec --modules mult-ini.tex

but did not get any output. Looking into texexec.rb, I tried to 
recreate a temp file to generate the documentation. The following

\usemodule[abr-01,mod-01]
\def\ModuleNumber{1}

\starttext
\readlocfile{mult-ini.tex}{}{}
\stoptext

gives

This is pdfeTeX, Version 3.141592-1.30.3-2.2 (Web2c 7.5.5) 
(format=cont-en 2006.5.31)  5 JUN 2006 21:13
entering extended mode
\write18 enabled.
  (e:\isoimage\usr\local\context\tex\texmf-local/web2c/natural.tcx)
**f:/Research/real_time/examples/test2.tex \emergencyend
(f:/Research/real_time/examples/test2.tex

ConTeXt  ver: 2006.05.28 13:28  fmt: 2006.5.31  int: english  mes: 
english

language        : language en is active
<protectionstate 0>
system          : cont-new loaded
(e:\isoimage\usr\local\context\tex\texmf-local/tex/context/base/cont-new.tex
systems         : beware: some patches loaded from cont-new.tex
color           : palette rollover is available
)
system          : cont-old loaded
(e:\isoimage\usr\local\context\tex\texmf-local/tex/context/base/cont-old.tex
loading         : Context Old Macros
)
system          : cont-fil loaded
(e:\isoimage\usr\local\context\tex\texmf-local/tex/context/base/cont-fil.tex
loading         : Context File Synonyms
)
system          : cont-sys loaded
(e:\isoimage\usr\local\context\tex\texmf-local/tex/context/user/cont-sys.tex
system          : module newmat loaded
(e:\isoimage\usr\local\context\tex\texmf-local/tex/context/base/m-newmat.tex))
bodyfont        : 12pt rm is loaded
language        : patterns nl->texnansi:texnansi->1->2:3 
nl->ec:ec->2->2:3 fr->
texnansi:texnansi->3->2:3 fr->ec:ec->4->2:3 
de->texnansi:texnansi->5->2:3 de->e
c:ec->6->2:3 it->texnansi:texnansi->7->2:3 it->ec:ec->8->2:3 
pt->texnansi:texna
nsi->9->2:3 pt->ec:ec->10->2:3 hr->ec:ec->11->2:3 pl->pl0:pl0->12->2:3 
pl->ec:e
c->13->2:3 pl->qx:qx->14->2:3 cz->il2:il2->15->2:3 cz->ec:ec->16->2:3 
sk->il2:i
l2->17->2:3 sk->ec:ec->18->2:3 sl->ec:ec->19->2:3 en->ec:ec->21->2:3 
uk->ec:ec-
>22->2:3 us->ec:ec->23->2:3 agr->agr:agr->24->2:3 da->ec:ec->25->2:3 
sv->ec:ec-
>26->2:3 af->ec:ec->27->2:3 no->ec:ec->28->2:3 deo->ec:ec->29->2:3 
es->ec:ec->3
0->2:3 ca->ec:ec->31->2:3 la->ec:ec->32->2:3 ro->ec:ec->33->2:3 
tr->ec:ec->34->
2:3 fi->ec:ec->36->2:3 hu->ec:ec->37->2:3 loaded
specials        : tex,postscript,rokicki loaded
\openout2 = `test2.tui'.

system          : test2.top loaded
(./test2.top
specials        : loading definition file tpd
(e:\isoimage\usr\local\context\tex\texmf-local/tex/context/base/spec-tpd.tex
specials        : loading definition file fdf
(e:\isoimage\usr\local\context\tex\texmf-local/tex/context/base/spec-fdf.tex)
specials        : fdf loaded
)
specials        : fdf,tpd loaded
)
\openout0 = `test2-mpgraph.mp'.

\openout0 = `mpgraph.mp'.


systems         : system commands are enabled
system          : module abr-01 loaded
(e:\isoimage\usr\local\context\tex\texmf-local/tex/context/base/s-abr-01.tex
check           : logo AMSTEX replaces a macro, use CAPITALS!
check           : logo CONTEXT replaces a macro, use CAPITALS!
check           : logo ETEX replaces a macro, use CAPITALS!
check           : logo LAMSTEX replaces a macro, use CAPITALS!
check           : logo LATEX replaces a macro, use CAPITALS!
check           : logo MATHML replaces a macro, use CAPITALS!
check           : logo METAFONT replaces a macro, use CAPITALS!
check           : logo METAPOST replaces a macro, use CAPITALS!
check           : logo PDFETEX replaces a macro, use CAPITALS!
check           : logo PDFTEX replaces a macro, use CAPITALS!
check           : logo PICTEX replaces a macro, use CAPITALS!
check           : logo PPCHTEX replaces a macro, use CAPITALS!
check           : logo PRAGMA replaces a macro, use CAPITALS!
check           : logo TABLE replaces a macro, use CAPITALS!
check           : logo TEXADRES replaces a macro, use CAPITALS!
check           : logo TEXEDIT replaces a macro, use CAPITALS!
check           : logo TEXEXEC replaces a macro, use CAPITALS!
check           : logo TEXFORM replaces a macro, use CAPITALS!
check           : logo TEXSPELL replaces a macro, use CAPITALS!
check           : logo TEXUTIL replaces a macro, use CAPITALS!
check           : logo TEX replaces a macro, use CAPITALS!
check           : logo XML replaces a macro, use CAPITALS!
check           : logo XETEX replaces a macro, use CAPITALS!
check           : logo METAFUN replaces a macro, use CAPITALS!
)
system          : module mod-01 loaded
(e:\isoimage\usr\local\context\tex\texmf-local/tex/context/base/s-mod-01.tex
system          : module mod-00 loaded
(e:\isoimage\usr\local\context\tex\texmf-local/tex/context/base/s-mod-00.tex
system          : module units loaded
(e:\isoimage\usr\local\context\tex\texmf-local/tex/context/base/m-units.tex
check           : unit Angstrom replaces a macro, use CAPITALS!
) <test2-lang-a.tmp>
\openout4 = `test2-lang-a.tmp'.

  <test2-lang-b.tmp>
\openout4 = `test2-lang-b.tmp'.

  <test2-lang-c.tmp>
\openout4 = `test2-lang-c.tmp'.

  <test2-lang-d.tmp>
\openout4 = `test2-lang-d.tmp'.


system          : module int-load loaded
(e:\isoimage\usr\local\context\tex\texmf-local/tex/context/base/x-set-11.tex
system          : module set-02 loaded
(e:\isoimage\usr\local\context\tex\texmf-local/tex/context/base/x-set-02.tex
(e:\isoimage\usr\local\context\tex\texmf-local/tex/context/base/mult-con.tex
loading         : Context Multilingual Macros / Constants
) 
(e:\isoimage\usr\local\context\tex\texmf-local/tex/context/base/mult-com.tex
loading         : Context Multilingual Macros / Commands
))
debugger        : message:: duplicate tag file in library setup of 
interface en
glish
debugger        : message:: duplicate tag reference in library setup 
of interfa
ce english
)
(e:\isoimage\usr\local\context\tex\texmf-local/tex/context/interface/cont-en.xm
l
check           : eachtexcommand stp:x:defineinteractionmenu replaces 
a macro,
use CAPITALS!
check           : texcommand stp:y:defineinteractionmenu replaces a 
macro, use
CAPITALS!
)) 
(e:\isoimage\usr\local\context\tex\texmf-local/tex/context/base/type-pre.tex
) 
(e:\isoimage\usr\local\context\tex\texmf-local/tex/context/base/pdfr-ec.tex)
color           : system rgb is global activated
color           : color is converted to gray
interaction     : active
) (./test2.tuo) (./test2.tuo) (./test2.tuo) (./test2.tuo) 
(./test2.tuo)
(./test2.tuo) (./test2.tuo) (./test2.tuo) (./test2.tuo) (./test2.tuo)
(e:\isoimage\usr\local\context\tex\texmf-local/tex/context/base/sort-new.tex)
(e:\isoimage\usr\local\context\tex\texmf-local/tex/context/base/sort-def.tex)
(e:\isoimage\usr\local\context\tex\texmf-local/tex/context/base/sort-lan.tex)
(./test2.tuo) (./test2.tuo)
systems         : begin file test2 at line 4
(./mult-ini.tex
loading         : Context Multilingual Macros / Initialization
)
systems         : end file test2 at line 6
  )
Here is how much of TeX's memory you used:
  5277 strings out of 220738
  95875 string characters out of 1298206
  3054069 words of memory out of 4496831
  43886 multiletter control sequences out of 10000+100000
  124827 words of font info for 62 fonts, out of 1000000 for 2000
  232 hyphenation exceptions out of 8191
  58i,2n,55p,632b,1694s stack positions out of 
10000i,500n,6000p,200000b,40000s
PDF statistics:
  1 PDF objects out of 300000
  0 named destinations out of 131072
  5 words of extra memory for PDF output out of 10000

No pages of output.


How does one generate documentation? Does it require some perl script? 
(I do not have perl in my path)

Aditya