Doc. Flex/XML - WSDLDoc - WSDL Documentation Generator. What is Doc. Flex/XML WSDLDoc? What you can generate with it. What is processed/documented. Documentation Features. Possiblity of unlimited cutomizations. Getting Started. Template Set Overview. Examples. 1. What is Doc. Flex/XML WSDLDoc? A powerful WSDL/XSD documentation generator that will help you to create a single HTML or RTF documentation. WSDL and XSD (XML schema) files with the possibility of automatic inclusion of XSD diagrams. Altova XMLSpy or Oxygen XML Editor. It is implemented in the form of “WSDLDoc” template set for Doc.
Flex/XML. Doc. Flex/XML is a software system for development and execution of high quality documentation and report generators. XML files. WSDLDoc is an application of it. For more details, please see: Doc. Flex/XML | Overview, Features. WSDLDoc was derived from the early XSDDoc template set (an implementation of. The Web Services Description Language (WSDL / ˈ w ɪ z d əl /) is an XML-based interface definition language that is used for describing the functionality offered. XML Schema Documentation Generator) and inherits all its functionality. Currently, it is made of 1. WSDLDoc template set is found in 'templates/WSDLDoc/'. Doc. Flex/XML archive or installation. It is ready to use. Please read Getting Started! What you can generate with it. Framed HTML Documentation. Using Framed. Doc. HTML documentation by any number of WSDL 1. W3. C XML Schema definition (XSD) files. It looks very similar to Java. Doc and provides most detailed and easy accessible information about all WSDL definitions, XML schema components. Here you can see some samples of such a documentation (click on a screenshot to view the real HTML). The following functionality is supported. Generation of file/page types. Basic Content Pagesoverview- summary. Type. html. message. Type. html. simple. Type. html. group. Group. html. Cross- Reference Pages. Support Files. Javadoc- like Navigation Bar. Switching between FRAMES / NO FRAMES views. Please, take a look also at WSDLDoc | Examples page for. HTML documentation. WSDL / XML schema files found on Internet. Single- File HTML Documentation. Plain. Doc. tpl is another main template designed primarily to generate RTF documentation. However, just by setting the output format to “HTML”. HTML file with the same content. This is a demo documentation generated in that way (click on the screenshot to see it). RTF Documentation. Using Plain. Doc. RTF documentation. WSDL 1. 1 / W3. C XML Schema definition (XSD) files. It is built of the same basic blocks as the framed HTML documentation. These screenshots show pages of a demo RTF documentation (click to enlarge). The following features/functionality are supported. Main Sections (click on each link to see a corresponding screenshot). Table Of Contents - . MS Word according to the special {TOC} field. RTF file and the headings of all sections (below). Overview Summary. Namespace Overview - . WSDL Definition Detail. Services. Bindings. Port Types. XSD Component Detail. Elements. Complex Types. Simple Types. Element Groups. Global Attributes. Attribute Groups. WSDL File Overview - . WSDL file, may include also the full. XML source of the file. Schema Overview - . XML schema. XML Namespace Bindings - . URIs. according to the WSDL / schema sources (those prefixes also appear in the documentation as a part of each XML qualified name). Page Header/Footer. The page header shows the information about the current section, the footer - the documentation short title and the current page number. Page Number References. Although the generated RTF includes hyperlinks (similar to those in HTML), they have no use in the printed form. So, many hyperlinks are supplemented with the page number of the link's target shown like. Grouping of component details (WSDL definitions / XSD components). Rendering of HTML/XHTML tags in WSDL descriptions / XSD annotations / template parameters. You can use XHTML tags in your WSDL descriptions and XSD annotations (see below). Equally, HTML tags can be used in some titles and descriptions passed via template parameters. Although RTF is incompatible with HTML, all of the specified HTML/XHTML markup will be rendered with the appropriate. RTF (including lists, tables and insertion of images). Selectively forcing to start from a new page the documentation sections of particular types. PDF Documentation. Doc. Flex/XML currently generates no PDF directly. However, you can produce quite decent PDF from RTF using some converters. For instance, the following has been created with MS Word 2. RTF. (click on the screenshot to download the PDF file, 4. MB). 3. What is processed/documented. Any number of input WSDL/XSD files. Including all XML schemas embedded in WSDL (within < wsdl: definitons> /< wsdl: types> element). Even when the same XML schema (defining the same namespace) is embedded in multiple WSDL files. There will be no mess out of it. All referenced WSDL/XSD files. Correct processing of all < wsdl: import>. WSDL/XSD files. Including when one embedded XML schema imports another embedded XML schema located in the same WSDL file. Automatic loading and processing (i. WSDL/XSD files. You just need to specify only the root WSDL/XSD files of your project. Everything referenced from them will be loaded automatically! All interconnections between WSDL/XSD. Hyperlinks from WSDL messages to the details of XSD elements/types describing the message data. In XSD element/type details, the list of all WSDL definitions where they are used. Copy the annotations of XSD elements/types. WSDL messages (and even operations) where they are used. XHTML tags in your descriptions/annotations. Below is a demo of what can be achieved using XHTML markup in XML schema annotations. 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 framed HTML documentation generated by that schema (click on screenshots to see the actual HTML). The last two sreenshots show pages of the RTF documentation generated by that schema (click to enlarge). Here, you can also download a PDF converted from that RTF: Human. Evolution- xsddoc. See Also. Support of XML Catalogs. XML catalog(s) may be used in a large WSDL/XML schema project to avoid referencing separate WSDL/XSD files from each other by direct file names. You may also want to use an XML catalog when some WSDL/XSD files involved in your project are located differently as they are specified. WSDL/XSD files. 4. Documentation Features. This section highlights some advanced features, which you rarely find in other documentation generators. That makes our tool so special! Highly navigable framed HTML documentation. The idea comes from Javadoc. In the top- left “Overview Frame” you select some large- scale scope. XML schema. In the bottom- left “List Frame” you select a particular XSD component. The “Detail Frame” shows the details of the selected item (e. That structure allows you to quickly find what you need without disturbing. See Also: Framed HTML Documentation. Dense layouts: more information in less space. Our template technology (see Doc. Flex/XML | Features). Using it, it is possible to generate such things as shown on the left screenshot (click to enlarge). You may think: What's special here? Just yet another page of some documentation.. But it uses three grid layouts! If that technique was not applied, the information printed on that page would occupy 2- 3 pages instead! Abundance of cross- links. When you look at a. Everything seems to be a hyperlink! Cross- links are produced by matching sets of special keys generated. The keys represent actual data being linked. Their generation is specified in templates along with the generation of the. In that way anything can be cross- linked together. At that, if a particular set of keys cannot be matched, an alternative set of keys can be. That means, when the primary target is absent, the link can go to some alternative. For instance, when in a reproduced XML source the value of some attribute. XSD component, that value is linked to the component detail. But when the detail is absent, the link can go to a corresponding item in some. In RTF documentation intended for printing, some cross- links can be emulated with. See Also: Doc. Flex/XML | Features | Hypertext | Cross- Reference Links. Support of any XML schema design patterns. How elements are defined in XML schema is a subject of so called. The difference in many ways comes down to whether the local elements are used and how much. For instance, some XML schemas define only one global element - the root one, all others are defined locally).
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. Archives
October 2017
Categories |