in reply to Re^4: Inserting new elements in an XML doc using XML::Twig
in thread Inserting new elements in an XML doc using XML::Twig

In a previous thread Tanktalus suggested breaking the documentation up more so that the element documentation doesn't collide with the twig documentation and so on. The reply mentioned the tension between searching multiple places for information and being overwelmed by a huge document with the author's inclination falling on the side of one large searchable document.

I understand that viewpoint, however I'd be inclined to split the document up and add an overview document with links to the main documentation for each part. A number of improvements can then be made:

Having the documentation available offline is important for those times you are working offline and need some help. A web based tutorial is fine, but is not a substitute for good POD documentation.

I'm available to help refactor and proof edit the XML::Twig documentation if required.


DWIM is Perl's answer to Gödel
  • Comment on Re^5: Inserting new elements in an XML doc using XML::Twig

Replies are listed 'Best First'.
Re^6: Inserting new elements in an XML doc using XML::Twig
by Herkum (Parson) on Feb 13, 2007 at 03:38 UTC

    I would agree with this statement. The documentation reminds me of another module that is of great use but horrid documentation SOAP::Lite. There is a lot of documentation and unless you are very familiar with XML it is easy to get confused about how XML::Twig converts a document into code and vice-versa. I tried Dumping the object, and that told me nothing, it is kinda scary how much data you keep track of.

    If you would like some help with the documentation mirod I would be willing to help as well.