develooper Front page | perl.perl5.porters | Postings from December 2004

Re: perlpodtut

Thread Previous | Thread Next
December 26, 2004 02:10
Re: perlpodtut
Message ID:
Michael G Schwern skribis 2004-12-24 22:42 (-0500):
> Besides, I'm sure POD entities and HTML entities have diverged, or
> will diverge, in other ways.  I think its sufficient to say "they have
> names like HTML entities, see L<perlpod|Formatting Codes> for details.

That section in perlpod basically says they're the same as HTML escapes,
with the addition of verbar and sol :)

So by definition they cannot diverge much. perlpodspec specifies it even
further: "the most recent XHTML specification at".

> While writing up a comment to a different part of the document, I think it
> was the code paragraphs, I considered suggesting an analogy to <pre> tags.

In fact, I had an analogy with <pre> before I removed that. The analogy
is wrong because in a verbatim paragraph, formatting codes cannot be
used while in <pre>, using you can use other tags, like <b>.

> Then I realized lots of competant programmers don't know anything about
> HTML.  Or perhaps they've only ever used WYSIWYG editors. 

I may have misassumed. Still, knowing that it's HTML-based is enough to
know where to find the information. Can you think of a better way to
explain E<>?

Maybe a link to would come in handy?

> But I really only bring up E<lt> and E<gt> against E<sol> in the sense that
> if you're going to bring up any specific entities bring up gt and lt.

perlpod does mention E<lt> and E<gt> explicitly, even though they're
practically part of the E<html> definition. You and perlpod have
convinced me that E<lt> and E<gt> should get special attention in
perlpodtut too.

> > So if you think methods should be in head3s, please come up with another
> > good example for =over/=item/=list. 
> Command line switches.

Ah, yes.

I've experimented with =head3 for methods, and I like it.


Thread Previous | Thread Next Perl Programming lists via nntp and http.
Comments to Ask Bjørn Hansen at | Group listing | About