POD not rendering as I intend

syphilis has asked for the wisdom of the Perl Monks concerning the following question:

Hi,

I have a typemap that looks like:

=head1 STUFF
Soldier *    SOLDIER

INPUT
SOLDIER
        $var = INT2PTR($type, SvIV(SvRV($arg)))

OUTPUT
SOLDIER
        $arg     = newSViv(0);
        SV * obj = newSVrv($arg, \"Soldier\");
        sv_setiv(obj, (IV)$var);
        SvREADONLY_on(obj);
        $arg;

=cut
[download]

Let's call it 'crap.pod'. When I view it as 'perldoc crap' it shows up as:

STUFF
    Soldier * SOLDIER

    INPUT SOLDIER $var = INT2PTR($type, SvIV(SvRV($arg)))

    OUTPUT SOLDIER $arg = newSViv(0); SV * obj = newSVrv($arg, \"Soldi
+er\");
    sv_setiv(obj, (IV)$var); SvREADONLY_on(obj); $arg;
[download]

What do I need to do to have perldoc render the file as per the original typemap ? That is, I want 'perldoc crap' to output:

STUFF
Soldier *    SOLDIER

INPUT
SOLDIER
        $var = INT2PTR($type, SvIV(SvRV($arg)))

OUTPUT
SOLDIER
        $arg     = newSViv(0);
        SV * obj = newSVrv($arg, \"Soldier\");
        sv_setiv(obj, (IV)$var);
        SvREADONLY_on(obj);
        $arg;
[download]

Cheers,
Rob

Comment on POD not rendering as I intend Select or Download Code

Replies are listed 'Best First'.
Re: POD not rendering as I intend by Sidhekin (Priest) on Oct 14, 2007 at 10:28 UTC
Indent your text (even by one column), and it will be rendered verbatim. Anything that is not indented will be treated by paragraph, subject to various markup etc ... inluding your =head1 STUFF, so I don't think you can avoid getting that set apart. Unless you remove its =head1. ;-) `=head1 STUFF Soldier * SOLDIER INPUT SOLDIER $var = INT2PTR($type, SvIV(SvRV($arg))) OUTPUT SOLDIER $arg = newSViv(0); SV * obj = newSVrv($arg, \"Soldier\"); sv_setiv(obj, (IV)$var); SvREADONLY_on(obj); $arg; =cut` [download] `print "Just another Perl ${\(trickster and hacker)},"` The Sidhekin proves Sidhe did it!	[reply] [d/l] [select]
Re^2: POD not rendering as I intend by syphilis (Archbishop) on Oct 14, 2007 at 11:10 UTC
Indent your text (even by one column), and it will be rendered verbatim Yes - but then if you copy the 'perldoc crap' output (without removing the leading whitespace) and save it as a typemap, you get all sorts of weird warnings when you run a 'make' process that uses that typemap: Warning: File './typemap' Line 3 ' INPUT' TYPEMAP entry needs 2 or 3 c +olumns Warning: File './typemap' Line 4 ' SOLDIER' TYPEMAP entry needs 2 or 3 + columns Warning: File './typemap' Line 7 ' OUTPUT' TYPEMAP entry needs 2 or 3 +columns Warning: File './typemap' Line 8 ' SOLDIER' TYPEMAP entry needs 2 or 3 + columns Warning: File './typemap' Line 12 ' SvREADONLY_on(obj);' TYPEMA +P entry needs 2 or 3 columns Warning: File './typemap' Line 13 ' $arg;' TYPEMAP entry needs +2 or 3 columns Warning: File 'typemap' Line 3 ' INPUT' TYPEMAP entry needs 2 or 3 col +umns Warning: File 'typemap' Line 4 ' SOLDIER' TYPEMAP entry needs 2 or 3 c +olumns Warning: File 'typemap' Line 7 ' OUTPUT' TYPEMAP entry needs 2 or 3 co +lumns Warning: File 'typemap' Line 8 ' SOLDIER' TYPEMAP entry needs 2 or 3 c +olumns Warning: File 'typemap' Line 12 ' SvREADONLY_on(obj);' TYPEMAP +entry needs 2 or 3 columns Warning: File 'typemap' Line 13 ' $arg;' TYPEMAP entry needs 2 +or 3 columns Warning: File 'typemap' Line 3 ' INPUT' TYPEMAP entry needs 2 or 3 col +umns Warning: File 'typemap' Line 4 ' SOLDIER' TYPEMAP entry needs 2 or 3 c +olumns Warning: File 'typemap' Line 7 ' OUTPUT' TYPEMAP entry needs 2 or 3 co +lumns Warning: File 'typemap' Line 8 ' SOLDIER' TYPEMAP entry needs 2 or 3 c +olumns Warning: File 'typemap' Line 12 ' SvREADONLY_on(obj);' TYPEMAP +entry needs 2 or 3 columns Warning: File 'typemap' Line 13 ' $arg;' TYPEMAP entry needs 2 +or 3 columns [download] The idea is that 'perldoc crap' should output something that can be copy'n'pasted to a 'typemap' and run trouble-free (without having to bother about removing leading whitespace). Thanks Sidhekin, moritz. Cheers, Rob Update: Probably a silly objection. The 'perldoc' output always displays leading whitespace at the beginning of every line (afaict). That being the case, all I'm really quibbling about is the amount of preceding whitespace ... pointless, really :-)	[reply] [d/l]
Re^3: POD not rendering as I intend by grinder (Bishop) on Oct 14, 2007 at 11:28 UTC
Omit your `typemap` from the `MANIFEST`, and generate it directly from `crap.pod` in your `Makefile.PL` or `Build.PL` script. `open my $in, '<', 'crap.pod' or die "moan crap $!\n"; open my $tmap, '>', 'typemap' or die "typemap $!\n"; while (<$in>) { print $tmap $_ if /^=head1/ .. /=^cut/ and /^[^=]/; } close $in; close $tmap;` [download] Remember that `xsubpp` will be run much later, and won't care that `typemap` was created only a few seconds ago, and did not, in fact, come with the original tarball. Just make sure it renders as you want in POD, and remove any POD hackery as you write it out to the `typemap` file. Or go the other way: have a POD stub file, and merge in the contents of `typemap`, appropriately munged. • another intruder with the mooring in the heart of the Perl	[reply] [d/l]
Re^4: POD not rendering as I intend by syphilis (Archbishop) on Oct 14, 2007 at 12:47 UTC
Re^5: POD not rendering as I intend by grinder (Bishop) on Oct 14, 2007 at 14:31 UTC
Re: POD not rendering as I intend by moritz (Cardinal) on Oct 14, 2007 at 10:18 UTC
If you want your text to be rendered verbatim (including whitespaces), you should indent it all by the same amount of whitespace. See perlpod for more details. Perl 6 in German	[reply]


Clear questions and runnable code get the best and fastest answer
	PerlMonks