Ticket #674 (new patch)

Opened 6 years ago

Last modified 4 years ago

[doc] POD escape B<> is not handled in verbatim section

Reported by: fperrad Owned by:
Priority: normal Milestone:
Component: docs Version: 1.1.0
Severity: medium Keywords:
Cc: jkeenan Language:
Patch status: new Platform:

Description

in verbatim section, escape B<> is not handled.

for example, in docs/book/ch05_pge.pod :

Run the test script:

  $ B<parrot grammar_test.pir>

becomes in ch05_pge.pod.html

<p>Then compile the grammar:</p>

<pre>  $ B&#60;parrot Perl6Grammar.pbc &#45;&#45;output=Contacts.pir Contacts.pg&#62;</pre>

These escapes were recently added :

  • ch02_getting_started.pod in r38451
  • ch05_pge.pod in r38564

The attached patch removes them.

Attachments

book-remove-escape-B.patch Download (2.2 KB) - added by fperrad 6 years ago.
remove B<> in verbatim section

Change History

Changed 6 years ago by fperrad

remove B<> in verbatim section

follow-up: ↓ 2   Changed 6 years ago by jkeenan

  • cc jkeenan, allison added

This patch seemed reasonable enough. But when I went to apply it and then checked theh patched files with podchecker, I got errors like these:

$ podchecker docs/book/ch02_getting_started.pod 
*** ERROR: Unknown interior-sequence 'U' at line 10 in file docs/book/ch02_getting_started.pod
*** ERROR: Unknown interior-sequence 'U' at line 11 in file docs/book/ch02_getting_started.pod
*** ERROR: Unknown interior-sequence 'U' at line 17 in file docs/book/ch02_getting_started.pod
*** ERROR: =end without =begin at line 120 in file docs/book/ch02_getting_started.pod
*** ERROR: =end without =begin at line 131 in file docs/book/ch02_getting_started.pod
docs/book/ch02_getting_started.pod has 5 pod syntax errors.

And, applying podchecker to docs/book/*.pod more generally, I got abundant errors.

ISTR that Allison is doing some work getting the book ready for publication. Is this a special POD format?

So I didn't apply the patch yet. Thank you very much.

kid51

in reply to: ↑ 1   Changed 6 years ago by jkeenan

  • cc allison removed
  • owner set to allison

Replying to jkeenan:

Coke reported on #parrot that this is Pseudo-Pod. Assigning ticket to Allison.

  Changed 5 years ago by coke

  • owner changed from allison to coke

  Changed 4 years ago by coke

  • owner coke deleted

  Changed 4 years ago by coke

The right approach here is to make our POD -> HTML converter smarter, not to strip out usages of B<>

  Changed 4 years ago by coke

See also TT#559.

Note: See TracTickets for help on using tickets.