docflex/xml is a java-based software system for developmentand execution of high performance template-driven documentation generators from any data stored in xml files. the actual doc/report generators are programmed in the form of special templates using a graphic template designer , which represents the templates visually in a form resembling the output they generate.further, the templates are interpreted by a template processor ,which takes on input the xml files and produces by them the result documentation. this article describes an application of docflex/xml for the task of generation of high-quality xml schema documentation.that includes the following features of docflex/xml system:
Download Zip >>> https://www.google.com/url?hl=en&q=https://tlniurl.com/2yM60B&source=gmail&ust=1719712629430000&usg=AOvVaw21mJjSRg9n153XD3GTT_sr
local elements are those components that are declared locally within other xsd components. w3c xml schema spec allows you to declare any number of local elements that may share the same name but have different content. that's because their meaning is local and there will be no collisions with other declarations. that, however, creates a problem for documenting, because in a documentation both global and local elements may appear simultaneously in various lists according to their common properties. if each element component is identified only by its name, you will get the lists with multiple repeating names but little clue what they mean. moreover, some xml schemas may contain lots of identical local element declarations (that is, they have the same both name and content). so, you'll get in those lists a mess of repeating names, some of which referencing to effectively the same entities, whereas others to complete different ones. in xsddoc , those problems are solved in two ways:
on the left you can see a documentation generated with such unification. on the right, all local elements are documented straight as they are. click on each screenshot to view the docs: we believe the first documentation (on the left) is easier to understand and use.
you can format your xml schema annotations with xhtml tags, which will be recognized and rendered with the appropriate formatting in both html and rtf output, as shown on the following screenshots (click to see more details): here, on the left you can see the xml source of an xml schema, whose annotations are heavily laden with xhtml markup (including insertion of images). the next is the html documentation generated by that schema. on the right is a page of rtf documentation also generated by that schema.
template parameters serve the same role as options in traditional doc generators. the difference is that docflex template architecture makes the support/implementation of template parameters very cheap (typically, the most of efforts takes writing their descriptions). so, there may be hundreds of parameters controlling a large template application.
although docflex templates are stored as plain-text files (with an xml-like format), they are not supposed for editing manually.rather, a special graphic template designer must be used, which visualizes the templates in the form of template components they are made of.those components are the actual constructs of the template language (not some textual statements, operators, blocks etc.) the following screenshots show templates open in the template designer (click to see a lot more): that approach has a number of advantages, among them:
here is how such a documentation with diagrams looks (click on a screenshot to view the real html): apache ant & maven as a pure java application, docflex/xml can be run in any environment that runs java itself.the template processor can be easily integrated with ant (that can be specified just in the ant build file).in case of maven, docflex/xml includes a simple maven plugin.it is possible also to use all diagraming integrations with both ant and maven. links docflex/xml (home page): -xml/ docflex/xml xsddoc: -xml/xsddoc/ xsddoc examples: -xml/xsddoc/examples/ xmlspy integration: -xml/xmlspy/ oxygenxml integration: -xml/oxygenxml/ free downloads: this original article: -xsd/
7fc3f7cf58