question about EMBOSS manual

[Damian Counsell]

Guy!


* Guy Bottu <gbottu at ben.vub.ac.be> [020826 16:53]:

> from : BEN
> 
> I have started to port under EMBOSS some local developements we had under GCG at 
> the BEN site. I would like to write program documentation files (txt and html). 

Are you looking for a job any time soon? ;-)


> I read the on-line documentation at
> http://www.hgmp.mrc.ac.uk/Software/EMBOSS/Doc/programdoc.html but
> did not get much wiser. Therefore my questions : must the txt files
> respect a certain standard ?

Ooh, don't get me started...

As Alan pointed out, enhancing the documentation is definitely a
priority at the moment and XML (DocBook) will be the new standard.

For the latest news go here:

     http://www.hgmp.mrc.ac.uk/~dcounsel/EDP/EMBOSS_documentation.html

and for Terry Stewart's documentation on the new documentation go here:

     http://www.hgmp.mrc.ac.uk/~tjstewar/EMBOSS/EmbossDocumentation.html

.  With the arrival of this page EMBOSS introduces a variation on
recursive acronyms by telling its developers to RTFMM...

Here's the template:

     http://www.hgmp.mrc.ac.uk/~tjstewar/EMBOSS/EmbossTemplate.html


> Is there a tool make the html files ?

There's a tool to make the XML files:

     http://www.xmlmind.com/xmleditor/

 which you can use in conjunction
with Terry's stylesheets to produce HTML or with the OpenJade package
to produce LaTeX, PDF or RTF.


all the best

Damian

-- 
Damian COUNSELL                      email:  d.counsell at hgmp.mrc.ac.uk
MRC Human Genome Mapping Project RC  phone:  +44 (0)1223 494500
Cambridge CB10 1SB                   direct: +44 (0)1223 494585
http://www.hgmp.mrc.ac.uk/~dcounsel/ fax:    +44 (0)1223 494512