Professional Web Applications Themes

Have I an error in my POD? - PERL Modules

I have a package in CPAN (MathML::Entities::Approximate) and when it is installed manually, it's fine. However when it's installed via the CPAN module (perl -MCPAN -e shell...) there is an error about the ABSTRACT (I can't paste the exact message in, as I've installed the package on both my systems now <sad/>) I *thought* that the abstract was deduced from the NAME line: the element after the hyphen.... however this appears not to be the case. I have compared my POD to other packages, and it seams to be complete. SO: 1) What is the abstract? 2) How do I ...

  1. #1

    Default Have I an error in my POD?

    I have a package in CPAN (MathML::Entities::Approximate) and when it is
    installed manually, it's fine.

    However when it's installed via the CPAN module (perl -MCPAN -e
    shell...) there is an error about the ABSTRACT (I can't paste the exact
    message in, as I've installed the package on both my systems now <sad/>)

    I *thought* that the abstract was deduced from the NAME line: the
    element after the hyphen.... however this appears not to be the case.

    I have compared my POD to other packages, and it seams to be complete.

    SO:
    1) What is the abstract?
    2) How do I define it on my package?

    Many thanks...
    --
    Ian
    Ian Stuart Guest

  2. #2

    Default Re: Have I an error in my POD?

    On Thu, 22 Dec 2005 05:35:24 +1100, Ian Stuart wrote:

    Hi Ian
    > However when it's installed via the CPAN module (perl -MCPAN -e
    > shell...) there is an error about the ABSTRACT (I can't paste the
    > exact message in, as I've installed the package on both my systems
    > now <sad/>)
    You could uninstall it, and reinstall it, though.
    > I *thought* that the abstract was deduced from the NAME line: the
    > element after the hyphen.... however this appears not to be the
    > case.
    Right. So can you post the NAME part of your POD.
    > I have compared my POD to other packages, and it seams to be
    > complete.
    Perhaps it needs to be /(.+)\s-\s(.+)/?

    Note the 2 spaces.


    Ron Savage Guest

  3. #3

    Default Re: Have I an error in my POD?


    "Ian Stuart" <ian.stuarted.ac.uk>
    ..
    ..
    >
    > SO:
    > 1) What is the abstract?
    From 'perldoc ExtUtils::MakeMaker':

    ABSTRACT
    One line description of the module. Will be included in PPD file.

    ABSTRACT_FROM
    Name of the file that contains the package description. MakeMaker looks
    for a line in the POD matching /^($package\s-\s)(.*)/. This is
    typically the first line in the "=head1 NAME" section. $2 becomes the
    abstract.
    > 2) How do I define it on my package?
    >
    I think the need to define it should go away if you remove the
    'ABSTRACT_FROM' line in your Makefile.PL. Not sure if that's the recommended
    approach, but it's the one I would take. (I don't think that either ABSTRACT
    or ABSTRACT_FROM are mandatory for a CPAN.pm install ... though, as I don't
    use CPAN.pm, there's a chance that I'm mistaken about that. Looks to me that
    they have relevance only with ppm (binary) package builds - since the "PPD"
    file is part of a ppm package.)

    Or ... if you replace 'ABSTRACT_FROM' in the Makefile.PL with 'ABSTRACT'
    you can define the abstract then and there:

    (ABSTRACT => 'Whatever you want it to be',
    AUTHOR => 'Ian Stuart <Ian.Stuarted.ac.uk>') : ()),

    You should then be able to leave everything else as it is.

    Cheers,
    Rob


    Sisyphus Guest

  4. #4

    Default Re: Have I an error in my POD?

    Ron Savage wrote:
    > You could uninstall it, and reinstall it, though.
    Ah - I had a quick look at the help stuff, and didn't spot that.. I'll
    have a play (however I don't want to upload a new version to cpan is
    this is the only fix - not really a bug-fix <grin />)
    >>I *thought* that the abstract was deduced from the NAME line: the
    >>element after the hyphen.... however this appears not to be the
    >>case.
    > Right. So can you post the NAME part of your POD.
    OK - straight from the .pm file:
    --- start extract ---
    =pod

    =head1 NAME

    MathML::Entities::Approximate - Returns approximated ASCII characters
    for XHTML+MathML Named Entities

    =head1 SYNOPSIS
    ---- end extract ----
    > Perhaps it needs to be /(.+)\s-\s(.+)/?
    >
    > Note the 2 spaces.
    Nope - they are there...
    Hmmm... From Rob's (sisyphus) comment, looking at ExtUtils::MakeMaker:
    "matching /^($package\s-\s)(.*)/ " - could the problem be the *leading*
    space in the text of the NAME section?

    ---
    Ian, Perl Laghu
    Ian Stuart Guest

  5. #5

    Default Re: Have I an error in my POD?

    On Thu, 22 Dec 2005 20:33:19 +1100, Ian Stuart wrote:

    Hi Ian
    > Ah - I had a quick look at the help stuff, and didn't spot that..
    OK.
    > I'll have a play (however I don't want to upload a new version to
    > cpan is this is the only fix - not really a bug-fix <grin />)
    PITA, right?
    >>> I *thought* that the abstract was deduced from the NAME line:
    So did I.
    > MathML::Entities::Approximate - Returns approximated ASCII
    > characters for XHTML+MathML Named Entities
    Looks OK, except...
    > Hmmm... From Rob's (sisyphus) comment, looking at
    > ExtUtils::MakeMaker: "matching /^($package\s-\s)(.*)/ " - could the
    > problem be the *leading* space in the text of the NAME section?
    Yes, that'd be the thing to edit.


    Ron Savage Guest

Similar Threads

  1. Replies: 0
    Last Post: March 29th, 09:49 PM
  2. Replies: 0
    Last Post: November 10th, 05:24 PM
  3. Postscript Print error (ERROR: rangecheck; OFFENDING COMMAND: filter)
    By Darrell_J_Brown@adobeforums.com in forum Adobe Acrobat Windows
    Replies: 1
    Last Post: May 13th, 11:24 AM
  4. Replies: 0
    Last Post: September 25th, 03:23 AM
  5. Replies: 1
    Last Post: August 7th, 07:13 PM

Bookmarks

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •  

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139