Beefy Boxes and Bandwidth Generously Provided by pair Networks
Come for the quick hacks, stay for the epiphanies.
 
PerlMonks  

Re^2: XML::Twig flexibility (was Re^3: Outputting a hash as XML)

by Tanktalus (Canon)
on Mar 15, 2005 at 18:30 UTC ( [id://439708]=note: print w/replies, xml ) Need Help??


in reply to Re: XML::Twig flexibility (was Re^3: Outputting a hash as XML)
in thread Outputting a hash as XML

I was thinking about taking this to email, but thought that others might like to jump in, or read this thread in the archives ... if they're really, really bored.

Your tutorial: Damn, I wish I had found it when I was writing my XML generator. :-) I would have one tiny suggestion. And I mean tiny. You said you're making it more prominent. My suggestion is to also make it prominent at the end of your perldoc. Specifically, in the SEE ALSO section. Same for the xmltwig.com site as a whole, and for the twig_dev.html page specifically. Key parts of your site should be mentioned in the SEE ALSO section to help idiots like me figure out that there really is important info on the xmltwig site that I would be interested in reading before submitting stupid requests (like "make a tutorial!") in public, making me look stupid, which is different only in the fact it's public now ;-), and wasting your time in defending the fact it already exists ;-). The latter part is hopefully a concern at least ;-)

As for gi/tag - I did miss one. set_name. I would suggest beefing up the docs on why I would want to choose one naming convention over another. For example, "If you're used to the SGML terms, use gi. If you're new to XML, these are called tags. Don't use name." Or something like that ;-)

I do understand why you're avoiding deprecating gi. Note, however, that just because something is deprecated doesn't mean it ever has to stop being there. Marking "gi" as "DEPRECATED - use tag/set_tag instead" doesn't mean you ever remove the gi code. It just tells users which one to pick for new code. IMO, that would be a good thing: it makes things clearer for us XML newbies, and would steer everyone to use the same language, since this is XML::Twig, not SGML::Twig that we're talking about here ;-)

Replies are listed 'Best First'.
Re^3: XML::Twig flexibility (was Re^3: Outputting a hash as XML)
by mirod (Canon) on Mar 15, 2005 at 21:04 UTC

    OK, I have added the link to xmltwig.com both at the beginning and at the end of the module, and made more apparent on the web site that twig_dev.html is the best way to view the docs.

    I like your ideas about deprecation, I'll try to nudge users more towards some of the synonyms. gi will stay though ;--) It might be called XML::Twig, but I use it a lot to process SGML, after a quick osx pass.

    set_name... you got me there, I had forgotten about that one. Which is not a good sign I guess, when even the author can't remember about an option.

    And finally, _you_ don't look half as stupid as the guy who wrote a tutorial but did not make it visible enough and thus spent his time answering questions which answer is in the tutorial...

Log In?
Username:
Password:

What's my password?
Create A New User
Domain Nodelet?
Node Status?
node history
Node Type: note [id://439708]
help
Chatterbox?
and the web crawler heard nothing...

How do I use this?Last hourOther CB clients
Other Users?
Others having an uproarious good time at the Monastery: (3)
As of 2024-04-25 17:37 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found