Bug in pod2html with escape sequences in =headX and =item

[p5pRT]

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

Searchable as RT1163$

[p5pRT]

From andreas@mrs.ch

=pod

=head1 Try this E<auml> and you'll see the error

OK here E<auml> I guess.

=cut

Save this file as test.pod and try the following command​:

pod2html test.pod

This results in an error in the <H1> part but not in
the <P> part.

There is no problem with​:

pod2text test.pod

It looks like pod2html escapes the escape sequence twice.

---

Site configuration information for perl 5.00503​:

Summary of my perl5 (5.0 patchlevel 5 subversion 03) configuration​:
  Platform​:
  osname=MSWin32, osvers=4.0, archname=MSWin32-x86-object
  uname=''
  hint=recommended, useposix=true, d_sigaction=undef
  usethreads=undef useperlio=undef d_sfio=undef
  Compiler​:
  cc='cl.exe', optimize='-Od -MD -DNDEBUG -TP -GX', gccversion=
  cppflags='-DWIN32'
  ccflags ='-Od -MD -DNDEBUG -TP -GX -DWIN32 -D_CONSOLE -DNO_STRICT
-DHAVE_DES_FCRYPT -DPERL_OBJECT'
  stdchar='char', d_stdstdio=define, usevfork=false
  intsize=4, longsize=4, ptrsize=4, doublesize=8
  d_longlong=undef, longlongsize=8, d_longdbl=define, longdblsize=10
  alignbytes=8, usemymalloc=n, prototype=define
  Linker and Libraries​:
  ld='link', ldflags ='-nologo -nodefaultlib -release -machine​:x86'
  libpth="c​:\win32app\web\perl\lib\core"
  libs= oldnames.lib kernel32.lib user32.lib gdi32.lib winspool.lib
comdlg32.lib advapi32.lib shell32.lib ole32.lib oleaut32.lib
netapi32.lib uuid.lib wsock32.lib mpr.lib winmm.lib version.lib
odbc32.lib odbccp32.lib PerlCRT.lib
  libc=c​:\win32app\web\perl\lib\CORE\PerlCRT.lib, so=dll,
useshrplib=yes, libperl=perlcore.lib
  Dynamic Linking​:
  dlsrc=dl_win32.xs, dlext=dll, d_dlsymun=undef, ccdlflags=' '
  cccdlflags=' ', lddlflags='-dll -nologo -nodefaultlib -release
-machine​:x86'

Locally applied patches​:
  ACTIVEPERL_LOCAL_PATCHES_ENTRY

---

@​INC for perl 5.00503​:
  c​:/win32app/web/Perl/lib
  c​:/win32app/web/Perl/site/lib
  .

---

Environment for perl 5.00503​:
  HOME (unset)
  LANG (unset)
  LANGUAGE (unset)
  LD_LIBRARY_PATH (unset)
  LOGDIR (unset)
 
PATH=c​:\win32app\web\perl\bin;C​:\WINNT4.0\system32;C​:\WINNT4.0;c​:\win32a
pp\exe
  PERL_BADLANG (unset)
  SHELL (unset)

[p5pRT]

From [Unknown Contact. See original ticket]

But your test case shows that I didn't think
about it while adding ActivePerl-inspired blockheaders and footers to
Pod​::Html.

"ActivePerl-inspired blockheaders and footers"?

Hello?

--tom

[p5pRT]

From [Unknown Contact. See original ticket]

On Tue, 03 Aug 1999 21​:54​:18 +0200, "Andreas Fehr" <andreas@​mrs.ch> wrote​:

This is a bug report for perl from andreas@​mrs.ch,
generated with the help of perlbug 1.26 running under perl 5.00503.

=pod

=head1 Try this E<auml> and you'll see the error

OK here E<auml> I guess.

=cut

Save this file as test.pod and try the following command​:

pod2html test.pod

This results in an error in the <H1> part but not in
the <P> part.

Thanks for the report. This is already fixed in the development branch
since version 5.005_56. But your test case shows that I didn't think
about it while adding ActivePerl-inspired blockheaders and footers to
Pod​::Html. I'll fix that later.

-Jan

[p5pRT]

From [Unknown Contact. See original ticket]

On Tue, 03 Aug 1999 16​:01​:02 -0600, Tom Christiansen
<tchrist@​jhereg.perl.com> wrote​:

But your test case shows that I didn't think
about it while adding ActivePerl-inspired blockheaders and footers to
Pod​::Html.

"ActivePerl-inspired blockheaders and footers"?

Hello?

Umm, sorry, bad choice of words I guess. Look at any doc page at​:

  http​://www.activestate.com/ActivePerl/docs/

You'll see that the pages have a header and footer with a colored
background. They also use a style sheet for formatting. ActiveState used
a hacked up version of Pod​::Html to produce this output. You normally
only get HTML help in this format added to your local installation when
you install binary modules via the PPM (Perl Package Manager). The
packages contain prebuild HTML pages prepared by ActiveState.

I wanted to be able to download a module from CPAN, install it with "perl
Makefile.PL", "make", "make test", "make install" and automatically get
the documentation installed into the same tree too. Therefore I patched
MakeMaker to htmlify the pods​:

http​://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1999-07/msg00018.html

and changed Pod​::Html.pm to support a (somewhat) streamlined version of
ActiveStates Pod​::WinHtml.pm​:

http​://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1999-07/msg00656.html

Both patches are in modified form in 5.005_60.

The patches require a few additional entries in Config.pm and you also
have to update the TOC manually. I did submit a patch for ppm to
ActiveState to allow direct installation from the blib directory via "ppm
install" instead of "make install".

Open issues are​:
- cannot easily use relative address for CSS
- some privlib/sitelib issues with ActivePerl directory layout
- the bug found by Andreas sample

and of course all the other pod2html vs podtohtml issues. :-)

-Jan