Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Re: podlators 0.06 released #636

Closed
p5pRT opened this issue Sep 20, 1999 · 2 comments
Closed

Re: podlators 0.06 released #636

p5pRT opened this issue Sep 20, 1999 · 2 comments

Comments

@p5pRT
Copy link

@p5pRT p5pRT commented Sep 20, 1999

Migrated from rt.perl.org#1502 (status was 'resolved')

Searchable as RT1502$

@p5pRT
Copy link
Author

@p5pRT p5pRT commented Sep 20, 1999

From The RT System itself

I think I would have to disagree. The correct implementation for a given
POD translator will of course be specific to the keyword (the format-type
indicator) that follows the =begin or the =for. If its "html" for example
I'd expect the translator to do whatever is appropriate for dealing with
raw html. But if its "text" I don't think its safe to assume that the
resulting text must therefore be verbatim.

HTML and other markup languages would assume that only to the extent
that it knows the raw text in question may contain markup commands
to effect the format of the output, so that its appearance would
indeed be different from the raw text associated with an '=for html'
block. But pod2html and pod2man don't really do any formatting, they
just do translation to another markup format.

This is _not_ the case with pod2text. It is responsible for doing the
actual formatting and most of the presentation. Suppose I want a
paragraph that shows up *only* in the pod2text version of the document
but I want it to be formatted/wrapped just like any other textblock
seen by pod2text?

If =for/=begin are always taken as verbatim, then this is not possible.
If OTOH the non-markup conventions of "leading indentation indicates
verbatim" can still be in effect (even though pod commands and sequences
are not). The program that does the formatting/displaying of the output
still needs to be able to do its job (otherwise it would be akin to forcing
text inside of =for/=begin html to be treated as <PLAINTEXT> or <FORMAT>
IMHO).

So in the case of pod2text and Pod​::Text, I would submit that treating
the text in "=begin/=for text" as literal output that is untouched by
the program that formats the result would be treating it differently
from the other non-text formats, and that non-indented text inside such
section should still be formatted whereas only indented text inside such
sections should be treated as verbatim.

Of course, I could be persuaded into believing something else ;-) But
I'd be dissatisfied with anything that didn't give me a way to let Pod​::Text
provide both text-formatting *and* verbatim text for sections that happen
are part of "=begin/=for text" commands.
--
Brad Appleton <bradapp@​enteract.com> http​://www.enteract.com/~bradapp/
  "And miles to go before I sleep." -- Robert Frost

@p5pRT
Copy link
Author

@p5pRT p5pRT commented Apr 22, 2003

@iabyn - Status changed from 'stalled' to 'resolved'

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
1 participant