[Bioperl-l] escaping prime characters in POD?

Heikki Lehvaslaiho heikki@ebi.ac.uk
Fri, 14 Dec 2001 16:44:35 +0000


Jason Stajich wrote:
> 
> I noticed that too - i guess the HTML POD translators do a better job
> than the plain text ones.

pod2html is like pod2text and shows \ characters. I tried.

I'll commit the changes I've done. (The only one left is bptutorial.pl)

	-Heikki

> I also notice that the L<...> are not translated very nicely either.
> 
> Can we outline the documentation standard (formatting, how to escape < &
> >, etc) in a wiki - probably at the end of the coding standards page.
> 
> -jason
> On Fri, 14 Dec 2001, Heikki Lehvaslaiho wrote:
> 
> >
> > I've been cleaning the POD codumentation lately and last night I ran into
> > something I do not understand: If there is ' character like in a word
> > "don't", most people escape it into "don\'t" to keep perl syntax
> > highlighting happy. Since these backlashes do not appear on bioperl html doc
> > pages, I have assumed that perl POD translators remove them. But yesterday I
> > noticed that in fact they do not. So what is going on? Is someone removing
> > them from HTML files separately or what is happening to them?
> >
> > I've actually removed most of \' from HEAD but I have not committed
> > anything.
> >
> >       -Heikki
> >
> >
> >
> 
> --
> Jason Stajich
> Duke University
> jason@cgt.mc.duke.edu
> 
> _______________________________________________
> 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
___ _/_/_/_/_/________________________________________________________