Beefy Boxes and Bandwidth Generously Provided by pair Networks
laziness, impatience, and hubris
 
PerlMonks  

comment on

( [id://3333]=superdoc: print w/replies, xml ) Need Help??
I realize this is probably something beyond your control, but the version dependency of the tutorial comes across as a rather a serious deficit -- this quote from the fourth paragraph makes it sound like you are providing instructions with a very short life-span:
This document refers to version 0.03.77 of PDF::API2. If you have an older version, I recommend that you upgrade. It may still work, but I'm not guaranteeing it. If you've downloaded version 0.40 or greater you should be aware that it is only a developer release and that the API has changed considerably. This tutorial is guaranteed not to work with version 0.40+.
(emphasis in the original)

Apart from that, I'd feel better about the example code if it included "use strict" and "use warnings". I wanted to check that out for myself, but when I followed the link labeled "You can download the source code here: pdf_api2_tutorial_1.pl.txt", I got a page that said "We can't find your document... We've just upgraded our website and have moved things around..." (seems like your source code may have been "moved" into oblivion).

Minor nit-picks: You open a file named "$0.pdf" -- that's probably not a good idea, because $0 can (often will) include the path along with the script name (i.e. where the script itself is located in the file system, which might not be the CWD, and/or might not be write-accessible to the user). Also, I couldn't tell where, or whether, you were checking for failure to open or write the output file. Does the module handle that for you, and if so, what is the best/easiest/safest way for the module user to handle its behavior on failure? (Your sample code should show how to do that.)

It's obvious that the part at the end is "under construction", which makes the "conclusion" of the tutorial a bit of a puzzle, but for the part that is fleshed out, I think it looks very clear and nicely organized -- I actually know next to nothing about creating pdf content from scratch, and your tutorial (what there is of it) leads me to believe that I could learn in very short time how to use this module to good advantage (provided I start with the particular release that you are writing about ;). To me, that's the mark of true success in a tutorial, and you are definitely on the right track in terms of approach.

Regarding the content of the example text for the pdf page... um, why in Latin?


In reply to Re: Review request for PDF::API2 Tutorial by graff
in thread Review request for PDF::API2 Tutorial by BigLug

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post; it's "PerlMonks-approved HTML":



  • Are you posting in the right place? Check out Where do I post X? to know for sure.
  • Posts may use any of the Perl Monks Approved HTML tags. Currently these include the following:
    <code> <a> <b> <big> <blockquote> <br /> <dd> <dl> <dt> <em> <font> <h1> <h2> <h3> <h4> <h5> <h6> <hr /> <i> <li> <nbsp> <ol> <p> <small> <strike> <strong> <sub> <sup> <table> <td> <th> <tr> <tt> <u> <ul>
  • Snippets of code should be wrapped in <code> tags not <pre> tags. In fact, <pre> tags should generally be avoided. If they must be used, extreme care should be taken to ensure that their contents do not have long lines (<70 chars), in order to prevent horizontal scrolling (and possible janitor intervention).
  • Want more info? How to link or How to display code and escape characters are good places to start.
Log In?
Username:
Password:

What's my password?
Create A New User
Domain Nodelet?
Chatterbox?
and the web crawler heard nothing...

How do I use this?Last hourOther CB clients
Other Users?
Others cooling their heels in the Monastery: (None)
    As of 2024-04-25 00:23 GMT
    Sections?
    Information?
    Find Nodes?
    Leftovers?
      Voting Booth?

      No recent polls found