kgx-docs.xml 2.46 KB
Newer Older
Zander Brown's avatar
Zander Brown committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
[
  <!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
  <!ENTITY % gtkdocentities SYSTEM "xml/gtkdocentities.ent">
  %gtkdocentities;
]>
<book id="index">
  <bookinfo>
    <title>&package_name; Reference Manual</title>
    <releaseinfo>
      <para>This document is the API reference for &package_name; &package_version;</para>
      <para>
        If you find any issues in this API reference, please report it
        using <ulink type="http" url="&package_bugreport;">at the
        bugtracker</ulink>
      </para>
      <para>
        Does Kings Cross need an API reference? nope, might it be useful to
        someone? maybe
      </para>
    </releaseinfo>

    <copyright>
      <year>2019</year>
      <holder>Zander Brown</holder>
    </copyright>
  </bookinfo>

  <part id="core-api">
    <title>Objects</title>
    <xi:include href="xml/kgx-application.xml"/>
    <xi:include href="xml/kgx-window.xml"/>
    <xi:include href="xml/kgx-terminal.xml"/>
    <xi:include href="xml/kgx-process.xml"/>
37
    <xi:include href="xml/kgx-search-box.xml"/>
38 39 40 41 42
    <chapter>
      <title>Confirm Close Dialog</title>
      <xi:include href="xml/kgx-close-dialog.xml"/>
      <xi:include href="xml/kgx-close-dialog-row.xml"/>
    </chapter>
Zander Brown's avatar
Zander Brown committed
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60
  </part>

  <part id="util-api">
    <title>Utils</title>
    <xi:include href="xml/rgba.xml"/>
    <xi:include href="xml/fp-vte-util.xml"/>
  </part>

  <chapter id="object-tree">
    <title>Object Hierarchy</title>
    <xi:include href="xml/tree_index.sgml"/>
  </chapter>

  <index id="api-index-full">
    <title>API Index</title>
    <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
  </index>

61 62 63 64 65 66 67 68 69 70
  <index id="index-0.1.0">
    <title>API added in 0.1.0</title>
    <xi:include href="xml/api-index-0.1.0.xml"><xi:fallback /></xi:include>
  </index>

  <index id="index-0.2.0">
    <title>API added in 0.2.0</title>
    <xi:include href="xml/api-index-0.2.0.xml"><xi:fallback /></xi:include>
  </index>

Zander Brown's avatar
Zander Brown committed
71 72 73 74 75 76 77 78 79 80 81
  <index id="deprecated-api-index" role="deprecated">
    <title>Index of deprecated API</title>
    <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
  </index>

  <index id="annotations-glossary">
  <title>Annotations glossary</title>
  <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
  </index>

</book>