Re: How can one put a table into a pod

2011-04-26 Thread Allison Randal


On 04/25/2011 08:09 PM, Karl Williamson wrote:
 On 04/23/2011 11:53 PM, David E. Wheeler wrote:
 On Apr 23, 2011, at 10:09 PM, Karl Williamson wrote:

 I was thinking that PseudoPod implemented most of what might be
 needed, and so why not ship that.

 Its table spec looks quite simple, and perhaps sufficient.

 +1
 
 However, in thinking about this some more, I think we need to be able to
 at least specify centered column headings, and spans.  This is easily
 done with html and tbl.

How about adding some modifiers to the PseudoPod tags, such as:

=row center

=row right


=cell span 2


Worth thinking through the desired characteristics. It'll have to be a
bit of least common denominator, since we don't want to give people
the idea that they can build hugely complicated table specifications in
Pod when there's no way to represent them in the various output formats.

For HTML output, I tend to create a stylesheet that does all the fancy
display work on the tables. (The generated HTML pages do a very
tolerable impression of the O'Reilly printed table format.)

We also need to remember LaTeX and DocBook XML as common table output
formats.

Allison


Lack of html anchor for =item * foo

2011-04-26 Thread Karl Williamson

I discovered that in html output of lists that have elements of the form
=item * foo
no a anchor is generated for foo; this is different from lists of the form
=item foo

The first case generates a ul list, and the second a dl list.
The problem is that in the first form, any link in the file to 'foo' is 
broken, since there is no anchor for it.


Is this deliberate?  Should it be changed?


Re: Bad `=for` spec (WAS: How can one put a table into a pod)

2011-04-26 Thread Allison Randal
On 04/24/2011 06:19 AM, Shawn H Corey wrote:
 
 I have just taken a look at this.  They totally screwed up `=for`.  A
 `=for` paragraph does not need a `=end for`.

That was a decision made by the early developers of PseudoPod, and I
kept it in my implementation for backward compatibility in parsing old
O'Reilly manuscripts. It's entirely optional, though, and entirely
separate from table parsing.

It's kind of fundamental to the nature of subclassing that you can
override any behavior you want. :)

Allison


Re: Bad `=for` spec (WAS: How can one put a table into a pod)

2011-04-26 Thread Shawn H Corey

On 11-04-26 01:06 PM, Allison Randal wrote:

It's kind of fundamental to the nature of subclassing that you can
override any behavior you want.:)



The nicest thing about standards is that everyone can make their own.


--
Just my 0.0002 million dollars worth,
  Shawn

Confusion is the first step of understanding.

Programming is as much about organization and communication
as it is about coding.

The secret to great software:  Fail early  often.

Eliminate software piracy:  use only FLOSS.


Re: Lack of html anchor for =item * foo

2011-04-26 Thread Karl Williamson

On 04/26/2011 11:02 AM, David E. Wheeler wrote:

On Apr 26, 2011, at 9:51 AM, Karl Williamson wrote:


I discovered that in html output of lists that have elements of the form
=item * foo
noa  anchor is generated for foo; this is different from lists of the form
=item foo

The first case generates aul  list, and the second adl  list.
The problem is that in the first form, any link in the file to 'foo' is broken, 
since there is no anchor for it.

Is this deliberate?  Should it be changed?


I think it is deliberate because

 =item * foo

Is no different from

 =item *

 foo

That is, it's just a bullet, it has no name associated with it.dts, OTOH, do 
have a name.

FWIW, Pod::Simple::XHTML doesn't output an ID fordts, either.



When I do a perldoc -ohtml, what module is getting called that does 
generate an ID for dts ?


Re: Lack of html anchor for =item * foo

2011-04-26 Thread David E. Wheeler
On Apr 26, 2011, at 10:36 AM, Karl Williamson wrote:

 When I do a perldoc -ohtml, what module is getting called that does generate 
 an ID for dts ?

Pod::Simple::HTML, IIRC. Use

perldoc -MPod::Simple::XHTML

To get the shiny new HTML output.

Best,

David

Blanks and underscores in html links

2011-04-26 Thread Karl Williamson

Look at
http://search.cpan.org/~rjbs/perl-5.12.3/pod/perlsyn.pod

There is a heading in the original source
=head2 Switch statements

The anchor that is generated somehow on the web is
h2a class='u' href='#___top' title='click to go to top of document'
name=Switch_statements_
Switch statements ...

Note that the space in the original is translated into an underscore, 
and the addition of several trailing underscores.  This means that the 
link on the page that goes like

See also L/Switch statements.

doesn't work, as it gets translated into
a href=#Switch_statements class=podlinkpod

Can someone explain the trailing underscores?


RE: Blanks and underscores in html links

2011-04-26 Thread Jan Dubois
On Tue, 26 Apr 2011, Karl Williamson wrote:
 
 Look at
 http://search.cpan.org/~rjbs/perl-5.12.3/pod/perlsyn.pod
 
 There is a heading in the original source
 =head2 Switch statements

If you look closely, the heading is actually:

| =head2 Switch statements
| Xswitch Xcase Xgiven Xwhen Xdefault

Everything up to the paragraph separator is part of the headline.

 The anchor that is generated somehow on the web is
 h2a class='u' href='#___top' title='click to go to top of document'
 name=Switch_statements_
  Switch statements ...
 
 Note that the space in the original is translated into an underscore,
 and the addition of several trailing underscores.  This means that the
 link on the page that goes like
 See also L/Switch statements.
 
 doesn't work, as it gets translated into
 a href=#Switch_statements class=podlinkpod
 
 Can someone explain the trailing underscores?

The trailing underscores correspond to the spaces before and between the
X elements at the end of the heading.

Cheers,
-Jan




Re: Blanks and underscores in html links

2011-04-26 Thread Russ Allbery
Jan Dubois j...@activestate.com writes:
 On Tue, 26 Apr 2011, Karl Williamson wrote:

 Look at
 http://search.cpan.org/~rjbs/perl-5.12.3/pod/perlsyn.pod
 
 There is a heading in the original source
 =head2 Switch statements

 If you look closely, the heading is actually:

 | =head2 Switch statements
 | Xswitch Xcase Xgiven Xwhen Xdefault

 Everything up to the paragraph separator is part of the headline.

Yeah, but they're still basically trailing whitespace.  I think this is a
(minor) bug in whatever module generated that HTML.  It should strip
trailing whitespace from the heading.

-- 
Russ Allbery (r...@stanford.edu) http://www.eyrie.org/~eagle/


RE: Blanks and underscores in html links

2011-04-26 Thread Jan Dubois
On Tue, 26 Apr 2011, Russ Allbery wrote:
 Jan Dubois j...@activestate.com writes:
  If you look closely, the heading is actually:
 
  | =head2 Switch statements
  | Xswitch Xcase Xgiven Xwhen Xdefault
 
  Everything up to the paragraph separator is part of the headline.
 
 Yeah, but they're still basically trailing whitespace.  I think this is a
 (minor) bug in whatever module generated that HTML.  It should strip
 trailing whitespace from the heading.

Oh, I agree, I was just answering the question *why* those underscores
are there.  Confirming déjà vu (from April 2010):

http://www.mail-archive.com/pod-people@perl.org/msg01285.html

Cheers,
-Jan



Re: Blanks and underscores in html links

2011-04-26 Thread David E. Wheeler
On Apr 26, 2011, at 3:41 PM, Russ Allbery wrote:

 Everything up to the paragraph separator is part of the headline.
 
 Yeah, but they're still basically trailing whitespace.  I think this is a
 (minor) bug in whatever module generated that HTML.  It should strip
 trailing whitespace from the heading.

Hrm. I thought I fixed this.

  https://rt.cpan.org/Ticket/Display.html?id=56572
  
https://github.com/theory/pod-simple/commit/51a052ed53c52dc717e38e7685124a7e2023eb0

What version of Pod::Simple are you using?

Best,

David