Re: POD formatter version comments

2024-03-15 Thread Shawn H Corey
On 2024-03-15 14:38, Russ Allbery wrote: If you would be happy with a PR to remove that bullet point, we're just vigorously agreeing.  Otherwise, I'm not sure what you're asking for instead. I guess I wasn't clear. I was talking about making the requirement an option for the formatters.

Re: POD formatter version comments

2024-03-15 Thread Shawn H Corey
On 2024-03-15 12:44, Russ Allbery wrote: Shawn H Corey writes: I think it should be an option. Sometimes it is necessary to know that a change in appearance is caused by changes to a module and not to the generating document. Do we need to explicitly state that it's an option, or would

Re: POD formatter version comments

2024-03-15 Thread Shawn H Corey
On 2024-03-15 11:43, Russ Allbery wrote: perlpodspec currently contains the following note on POD processor implementations: I think it should be an option. Sometimes it is necessary to know that a change in appearance is caused by changes to a module and not to the generating document.

Re: [feature] Add =image to perl pod #18169

2020-10-04 Thread Shawn H Corey
On 2020-10-04 4:01 p.m., Dmitry Karasik wrote: Indeed, either don't use ":" in "something", or use the full syntax, or we may extend the syntax so that "\:" and "\\" expand to the unquoted symbols. Use the POD escape sequence instead: E<0x3A> and E<0x20> Also think about this: =for image

Re: [feature] Add =image to perl pod #18169

2020-10-04 Thread Shawn H Corey
On 2020-10-04 3:23 p.m., Patrice Dumas wrote: Are spaces ignored between :? Should there be a separator to simplify parsing, like =for image src:file.png, text:something Yes, there will be problems with separators since the separator can appear in the "something". =for image src:file.png

Re: [feature] Add =image to perl pod #18169

2020-10-04 Thread Shawn H Corey
On 2020-10-04 11:11 a.m., Dmitry Karasik wrote: =for image src:file.png =for image src:file.png [fallback text] There should be an option for fallback text.

Re: What to do about L and L<"Foo Bar">

2018-05-29 Thread Shawn H Corey
(for now) but update the documentation to best practice. If necessary, put documentation for the old style in `perlpoddeprecated`. -- Don't stop where the ink does. Shawn H Corey

Re: Looking for another pod tip

2018-05-09 Thread Shawn H Corey
y adding a NBSP, > but then I get an extra line that I'd rather not have. Try using the Z<> specification. =over =item one =item two The 2 above items are together =item three Z<> =item four This item is separate from item three =back -- Don't stop where the ink does. Shawn H Corey

Re: =item * foo bar

2018-05-09 Thread Shawn H Corey
would allow both. Sometime during 5.8 it was changed so bullets needed a single * and nothing else. `perldoc perlpod` still isn't clear on this. `perldoc perlpodspec` makes this clear. `perldoc perlpod` should be consider deprecated. -- Don't stop where the ink does. Shawn H Corey

Re: pod embedded in pod

2017-04-13 Thread Shawn H Corey
e font. This is a regular paragraph. =cut -- Don't stop where the ink does. Shawn H Corey

Re: Pod::Simple - August PR Challenge Assignment

2015-08-18 Thread Shawn H Corey
On Tue, 18 Aug 2015 07:58:01 -0700 (PDT) Sean Zellmer s...@lejeunerenard.com wrote: Hey all, I was assigned Pod::Simple as my August module for the PR Challenge and was wondering if anything jumps to mind as a project for my PR. Any ideas are welcome. :) Peace, Sean Well, I do have

Re: Allow Whitespace in L URLs?

2015-01-08 Thread Shawn H Corey
On Thu, 8 Jan 2015 10:42:10 -0800 David E. Wheeler da...@justatheory.com wrote: I think that is probably sane, but maybe there are other opinions? Should we allow whitespace in L URLs? URLs use + or %20 for spaces. There is no need for whitespace in a URL. -- Don't stop where the ink does.

Re: pod::simple::text

2014-06-26 Thread Shawn H Corey
On Thu, 26 Jun 2014 15:40:14 +1200 Grant McLean gr...@mclean.net.nz wrote: On Wed, 2014-06-25 at 18:05 +, John E Guillory wrote: Hello, I thought I wasn’t this new to perl but … How does one use pod::simple::text to print out a section of POD, say the DESCRIPTION section?

Re: Tables in PODs

2013-09-20 Thread Shawn H Corey
On Fri, 20 Sep 2013 15:43:00 +0100 Nicholas Clark n...@ccl4.org wrote: There is a perl 6 specification for tables. See https://raw.github.com/perl6/specs/master/S26-documentation.pod Interesting. But some problems with it. 1. It breaks old parsers. 2. Does not allow for full POD

Contiguous Specification

2013-09-20 Thread Shawn H Corey
I might as well throw this one out there too. This is only for parsers that create multiple pages. Those which don't can skip it. And, of course, older parsers will ignore it. =begin :contiguous =end :contiguous Items within a contiguous section will be render on the same page, if

Tables in PODs

2013-09-20 Thread Shawn H Corey
Is there any specification for tables in PODs? I haven't been able to find any. Isn't it about time tables were added? I have attached a specification for them for your review. -- Don't stop where the ink does. Shawn tables.pod Description: Binary data

Re: The Encoding Warning (Again) - some data

2012-08-29 Thread Shawn H Corey
On Tue, 28 Aug 2012 22:16:20 -0600 Sean M. Burke sbu...@cpan.org wrote: But I think we should also hold pod parsers to a high standard of keeping quiet when simple heuristics are unproblematically applied. I'm not sure about that. One of the reason why there's so much trashy HTML out there is

Re: Possible patch to Test::Pod

2012-06-06 Thread Shawn H Corey
On 12-06-06 11:50 AM, David E. Wheeler wrote: End users don’t necessarily know if a test failure is important or not. All tests are important, otherwise they wouldn't be included in the distribution. Therefore, all test failures are important. -- Just my 0.0002 million dollars worth,

Re: Strange perldoc perldoc

2012-04-30 Thread Shawn H Corey
On 12-04-30 01:30 PM, Russ Allbery wrote: Indeed, and it shouldn't have any special treatment. You're experiencing some sort of bug, I think. I just don't know where. This works: /usr/bin/perldoc perldoc $ which perldoc /home/shawn/perl5/perlbrew/perls/perl-5.14.2/bin/perldoc $

Re: =item 1. Error

2012-04-26 Thread Shawn H Corey
On 12-04-26 11:57 AM, Russ Allbery wrote: 1. If the =item tags are numeric, ignore the value of the numbers and just renumber them. This is similar to what other markup languages do, but it has the significant problem of making it a bit more annoying to document, say, a list of exit

Re: pod2html in perl-5.15.9 recognizes POD markup in verbatim sections

2012-04-25 Thread Shawn H Corey
On 12-04-24 11:48 PM, David E. Wheeler wrote: On Apr 24, 2012, at 2:46 PM, chromatic wrote: Any objections? Yes; I use this feature. Better to make it an option in pod2html to turn it off. Or perhaps it turns it off by default, and you need an option to turn it on. I agree. It's best to

Re: pod2html in perl-5.15.9 recognizes POD markup in verbatim sections

2012-04-25 Thread Shawn H Corey
On 12-04-25 11:22 AM, Russ Allbery wrote: I think a better approach would have been to add a new command (=formatted or something) that had these semantics rather than changing the interpretation of existing verbatim paragraphs. It would be better if it used the =begin/=for/=end syntax:

Re: an 'anchor' command is missing from Pod

2012-01-28 Thread Shawn H Corey
On 12-01-27 11:14 PM, Ricardo Signes wrote: You're thinking of X -- Z should always be empty, and is a zero-effect code. Xopen is used to help indexing. It isn't how perldoc -f works, though. No, I've encountered unempty Z in some PODs. -- Just my 0.0002 million dollars worth,

Re: an 'anchor' command is missing from Pod

2012-01-27 Thread Shawn H Corey
On 12-01-27 06:36 PM, Patrice Dumas wrote: It could be along =anchor open if it is a Command Paragraph, or Aopen if it is a formatting command. I thought they were using the Z code for it: =item open FILEHANDLE,EXPR =item open FILEHANDLE,MODE,EXPR =item open FILEHANDLE,MODE,EXPR,LIST

Re: Removal of specific Pod::Checker warnings

2011-08-11 Thread Shawn H Corey
On 11/08/11 11:45 AM, Marc Green wrote: I agree that a POD checker should report *all* errors/warnings, but is having an argumentless =item really a warning? By Pod::Checker's defintion, a warning indicates bad style, so that would mean that having an argumentless =item is bad style.

Re: Removal of specific Pod::Checker warnings

2011-08-11 Thread Shawn H Corey
On 11/08/11 12:17 PM, David E. Wheeler wrote: what if I want my block quote to contain a list, just nest them? Yup. -- 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

Re: [perl #95784] [PATCH] Let X within anchorifiable paragraphs be additional anchors.

2011-08-04 Thread Shawn H Corey
On 11-08-04 09:55 PM, Rocco Caputo wrote: For example, this looks great in the HTML TOC outline. It's reminiscent of traditional man pages where usage summaries are listed at the top. But it's terrible to link to this section: =head3 select_read FILE_HANDLE [, EVENT_NAME [,

Re: Handling nested =open directives

2011-06-25 Thread Shawn H Corey
On 11-06-25 04:19 PM, Marc Green wrote: From ext/Pod-Html/t/htmlview.pod: =over 4 =item foo The foo item. =item bar *The bar item.* =over 4 *This is a list within a list * This paragraph should not be here. There should be nothing between the =over and the first =item.

How to report a documentation error

2011-05-06 Thread Shawn H Corey
I noticed some errors in the documentation of Pod::Simple::HTMLBatch. Here's one: % mkdir out_html % perl -MPod::Simple::HTMLBatch -e Pod::Simple::HTMLBatch::go @INC out_html (to convert the pod from Perl's @INC files under the directory ../htmlversion) Shouldn't ../htmlversion be

Using UTF-8

2011-05-06 Thread Shawn H Corey
Does Pod::Simple understand UTF-8? I have a POD with '½' in it but when I run it through Pod::Simple::SimpleTree, I get '½'. The UTF-8 code is C2 BD which corresponds to  and ½ in ISO-8859-1. How do I turn on UTF-8? -- Just my 0.0002 million dollars worth, Shawn Confusion is the

Re: How can one put a table into a pod

2011-05-04 Thread Shawn H Corey
On 11-05-04 03:16 PM, Ronald J Kimball wrote: =cell Jcenter Jspan 2 This is a wide, centered cell! What if you want a cell to span two columns and two rows at the same time? =cell Jcenter Jmiddle Jrowspan 2 jcolspan 2 paragraph -- Just my 0.0002 million dollars worth, Shawn

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

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

2011-04-24 Thread Shawn H Corey
On 11-04-23 08:23 PM, Allison Randal wrote: The table formatting it uses is demonstrated in: http://search.cpan.org/~arandal/Pod-PseudoPod-0.16/lib/Pod/PseudoPod/Tutorial.pod#Tables I have just taken a look at this. They totally screwed up `=for`. A `=for` paragraph does not need a `=end