Beefy Boxes and Bandwidth Generously Provided by pair Networks
Don't ask to ask, just ask

Re: A New Lesson For My CGI Course

by duff (Parson)
on Jan 10, 2005 at 00:43 UTC ( #420782=note: print w/replies, xml ) Need Help??

in reply to A New Lesson For My CGI Course

My random commentary:

  • In the first paragraph you use the phrase "HERE documents" and later on you use the same phrase but put the word "HERE" in double quotes (as I have just done). I've always found the all-caps version of that phrase rather strange. Usually, I just use a hyphenated form: here-documents.
  • I didn't see anything in a casual glance through the lessons, but might you explain your code such that the lesson can stand on its own? For instance, if I didn't know anything, I'd have questions like: What's the -T option for? Why use strict; use warnings;? etc. One of the things I've always liked about merlyn's articles is that he almost always starts off explaining the code with "As usual, I have blah blah blah at the top of my program because of blah blah blah". Anyway, a small paragraph explaining that stuff immediately after the code and giving pointers to docs would be an improvement IMHO (perhaps in a call-out box like your debugging tips (I'd factor the -T discussion out of debugging tips probably)).
  • The text right before the code for the form says "The form looks something like this". Well, really it's the code that implements the form, not the form itself that you're illustrating.
  • When you talk about the roll and roll_dice subroutines, you write &roll and &roll_dice; respectively. I'd forego the ampersands and semicolon.
  • I didn't scrutinize the code closely, but it looked good to me. (Though I did find the sublty of why you didn't use the fat comma for %races a little distracting. But if you wanted to make that a "sublesson", you could add an exercise for it)

Sorry if my comments sound nit-picky, these are just the things that occured to me as I looked over the lesson.

Anyway, it's nice to know that I can point people at your lessons whenever they ask for a CGI course. Keep up the good work!

Replies are listed 'Best First'.
Re^2: A New Lesson For My CGI Course
by Ovid (Cardinal) on Jan 10, 2005 at 02:51 UTC

    Thanks. I made a few minor changes based upon your feedback. I also didn't like my discussion of the "fat comma", but I was struggling between how I would normally write the code and how I would write it so a beginner can understand it. That's the simplest way that I came up with, aside from the "fat comma" distraction. It did bug the heck out of me, though, and you're quite right to point it out.

    And as for why I don't explain each lesson in such a way that the code can stand on its own: each lesson would take five times as much space and be that much longer to write. And how far back would I go? In order to make this reasonable, I went a fairly standard pedagogical route and assumed that for each lesson, the student had X amount of knowledge coming in and if they get to a particular lesson, anything they didn't know is either explained in a previous lesson, falls under the rubric of "required knowledge to study this" or I have links and suggestions for where they can acquire the knowledge. I'd love to have each lesson stand on its own, but it would just be too much work.

    Thanks for the input!


    New address of my CGI Course.

Log In?

What's my password?
Create A New User
Node Status?
node history
Node Type: note [id://420782]
and all is quiet...

How do I use this? | Other CB clients
Other Users?
Others lurking in the Monastery: (8)
As of 2018-02-19 12:32 GMT
Find Nodes?
    Voting Booth?
    When it is dark outside I am happiest to see ...

    Results (264 votes). Check out past polls.