UfoFilters-docs.xml.in 1.4 KB

1234567891011121314151617181920212223242526272829303132333435363738
  1. <?xml version="1.0"?>
  2. <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
  3. "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
  4. [
  5. <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
  6. ]>
  7. <book id="index">
  8. <bookinfo>
  9. <title>UFO Reference Manual</title>
  10. <releaseinfo>for the UFO Filters package ${UFO_FILTERS_VERSION_STRING_LONG}.
  11. The latest version of this documentation can be found on-line at
  12. <ulink role="online-location"
  13. url="http://ufo.kit.edu/ufo">http://ufo.kit.edu/ufo/</ulink>.
  14. </releaseinfo>
  15. </bookinfo>
  16. <section>
  17. <para>This documentation was generated from the source of the UFO
  18. filters, thus it looks rather technical. What is most important is,
  19. that the filters are instantiated with the shortened form of the name
  20. as given on this page rather than the object name UfoFilterSomething.
  21. A filter should not be instantiated on its own but by calling an
  22. <function>get_filter</function> of an <link linkend="Ufo-Graph">UFO Graph</link>.
  23. </para>
  24. </section>
  25. <chapter>
  26. <title>UFO API Reference</title>
  27. ${_xml_doc_input}
  28. </chapter>
  29. <index id="api-index-full">
  30. <title>API Index</title>
  31. <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
  32. </index>
  33. <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
  34. </book>