[Bioperl-l] POD note

[Aaron J. Mackey]

Ahh, I see now, these are in our pre-formatted API summaries ...

-Aaron

On Jan 12, 2005, at 11:31 AM, Aaron J. Mackey wrote:

>
> POD markup (L<>, B<>, etc) is only valid in auto-formatted text (which 
> in POD, is only non-indented text).  It sounds like we have some 
> indented text that shouldn't be indented (rather than removing 
> otherwise valid markup).  POD interprets any indented text as literal, 
> pre-formatted text (much like <pre> in HTML).  Is this why much of our 
> documentation is so poorly line-wrapped !?!
>
> -Aaron
>
> On Jan 12, 2005, at 9:37 AM, Brian Osborne wrote:
>
>> bioperl-l,
>>
>> There are various short tags that you can use in POD to italicize,
>> emphasize, etc. The POD utilities, like pod2html, will only interpret 
>> these
>> tags if the POD line containing them is not indented. So, this works:
>>
>> The L<Bio::SeqIO> module...
>>
>> But this doesn't:
>>
>>    The L<Bio::SeqIO> module...
>>
>> What happens in that last case is that the line is treated literally, 
>> the
>> "L<" and ">" end up in the resultant HTML, if you've run pod2html. I 
>> only
>> mention this because it seems to me that I'm removing tags that I've 
>> removed
>> before - perhaps someone is putting these back? I could be wrong about
>> that...
>>
>>
>> Brian O.
>>
>>
>> _______________________________________________
>> Bioperl-l mailing list
>> Bioperl-l at portal.open-bio.org
>> http://portal.open-bio.org/mailman/listinfo/bioperl-l
>>
>>
> --
> Aaron J. Mackey, Ph.D.
> Dept. of Biology, Goddard 212
> University of Pennsylvania       email:  amackey at pcbi.upenn.edu
> 415 S. University Avenue         office: 215-898-1205
> Philadelphia, PA  19104-6017     fax:    215-746-6697
>
>
--
Aaron J. Mackey, Ph.D.
Dept. of Biology, Goddard 212
University of Pennsylvania       email:  amackey at pcbi.upenn.edu
415 S. University Avenue         office: 215-898-1205
Philadelphia, PA  19104-6017     fax:    215-746-6697