[Bioperl-l] bioperl FAQ

[Heikki Lehvaslaiho]

The code and XML are now in doc/faq directory. In addition there is a rough
DTD. It ignores all the common HTML taqs which can also be used.

One script, faq.pl, can generate both text and html versions of the FAQ.
The HTML rendering is quite bare boned but it can be easily changed. 

	-heikki


Heikki Lehvaslaiho wrote:
> 
> Jason Stajich wrote:
> >
> > great stuff - thanks for getting it going, I wasn't sure what was an
> > accepted XML FAQ format.  Any chance you write a faq2txt? I'll make sure
> 
> I'll write the faq2txt.pl.
> 
> > it gets run and produces the file before a release.   I guess now might be
> > a good time to start a new doc/ directory?
> 
> Yep, I'll put my stuff into doc/faq/.
> 
> This for Peter Masiar for suggesting the Twiki. There are quite a lot of us
> who hae used wiki and I think it would be grat if we had more people writing
> docs and web pages.
> 
> As fas as I can see neither twiki or FAQ-O-Matic can generate a plain text
> version to be included into distribution.
> 
>         -heikki
> 
> > -jason
> >
> > On Wed, 29 May 2002, Heikki Lehvaslaiho wrote:
> >
> > >
> > > I started playing with the Bioperl FAQ yesterday. I am putting it into XML
> > > using XML::Twig FAQ structure as a base.
> > >
> > > I am expanding the XML structure to allow sections of questions as in the
> > > current FAQ. I have the faq2html.pl almost ready. I'll move the rest of the
> > > FAQ into the XML and write faq2text.pl soon.
> > >
> > > I planning to put all the files into a new faq directory. The current FAQ
> > > can be deleted or generated from faq/faq.xml.
> > >
> > > Just to let you know to avoid redundant work getting done.
> > >
> > >       -Heikki
> > >
> > >
> > >
> >
> > --
> > Jason Stajich
> > Duke University
> > jason at cgt.mc.duke.edu
> 
> --
> ______ _/      _/_____________________________________________________
>       _/      _/                      http://www.ebi.ac.uk/mutations/
>      _/  _/  _/  Heikki Lehvaslaiho          heikki@ebi.ac.uk
>     _/_/_/_/_/  EMBL Outstation, European Bioinformatics Institute
>    _/  _/  _/  Wellcome Trust Genome Campus, Hinxton
>   _/  _/  _/  Cambs. CB10 1SD, United Kingdom
>      _/      Phone: +44 (0)1223 494 644   FAX: +44 (0)1223 494 468
> ___ _/_/_/_/_/________________________________________________________
> _______________________________________________
> Bioperl-l mailing list
> Bioperl-l@bioperl.org
> http://bioperl.org/mailman/listinfo/bioperl-l

-- 
______ _/      _/_____________________________________________________
      _/      _/                      http://www.ebi.ac.uk/mutations/
     _/  _/  _/  Heikki Lehvaslaiho          heikki@ebi.ac.uk
    _/_/_/_/_/  EMBL Outstation, European Bioinformatics Institute
   _/  _/  _/  Wellcome Trust Genome Campus, Hinxton
  _/  _/  _/  Cambs. CB10 1SD, United Kingdom
     _/      Phone: +44 (0)1223 494 644   FAX: +44 (0)1223 494 468
___ _/_/_/_/_/________________________________________________________