Slashdot Mirror

← Back to Stories (view on slashdot.org)

Embedding XML In Docs?

Posted by kdawson on from the techniques-and-tips dept.

An anonymous reader writes "Now that XML is the de facto standard (for good or ill) for doing message passing, I find that I need to give XML examples in the documentation that we produce. We're stuck with Word and up till now I've just been doing the examples as cut and paste from the log files. We include schemas in the appendix but it seems that the clients like the 'readability' of the raw XML over other approaches we've tried. I'm wondering what everyone else is doing in the world of XML documentation."

2 of 90 comments (clear)

  1. I always let... by mdm-adph · · Score: 5, Funny

    ...XML document itself. :P

    (Isn't that the beauty of it?)

    --
    It is by my will alone my thoughts acquire motion; it is by the juice of the coffee bean that the thoughts acquire speed
  2. Re:this should work for you: by dvice_null · · Score: 3, Funny

    That is pretty good, but as your example is not valid XML, we need to wrap it inside a valid XML to make it actually work:

    <?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE documentation [
    <!ELEMENT documentation (#PCDATA)>
    ]>
    <documentation>
    <![CDATA[<XML documentation>XML documentation</XML documentation>]]>
    </documentation>