brl/gnome-shell
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
a315e75e95
gnome-shell/docs/reference/shell/shell-docs.sgml

75 lines
2.6 KiB
Plaintext
Raw Normal View History

docs: Allow building API documentation As extensions.gnome.org starts to shape up, we should allow to build the API documentation for St/Shell. https://bugzilla.gnome.org/show_bug.cgi?id=661045
2011-09-07 14:23:28 -04:00
<?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'">
docs: Use entity for version Meson's gtk-doc support currently requires the main SGML/XML file to be located in the srcdir, so instead of substituting the module version in that file directly, use a small auxiliary file that's included via a custom entity. https://bugzilla.gnome.org/show_bug.cgi?id=783229
2017-05-28 15:46:02 -04:00
<!ENTITY version SYSTEM "version.xml">
docs: Allow building API documentation As extensions.gnome.org starts to shape up, we should allow to build the API documentation for St/Shell. https://bugzilla.gnome.org/show_bug.cgi?id=661045
2011-09-07 14:23:28 -04:00
]>
<book id="index">
<bookinfo>
<title>Shell Reference Manual</title>
<releaseinfo>
docs: Use entity for version Meson's gtk-doc support currently requires the main SGML/XML file to be located in the srcdir, so instead of substituting the module version in that file directly, use a small auxiliary file that's included via a custom entity. https://bugzilla.gnome.org/show_bug.cgi?id=783229
2017-05-28 15:46:02 -04:00
for Shell &version;.
docs: Allow building API documentation As extensions.gnome.org starts to shape up, we should allow to build the API documentation for St/Shell. https://bugzilla.gnome.org/show_bug.cgi?id=661045
2011-09-07 14:23:28 -04:00
<!--The latest version of this documentation can be found on-line at
<ulink role="online-location" url="http://[SERVER]/shell/index.html">http://[SERVER]/shell/</ulink>.-->
</releaseinfo>
</bookinfo>
<chapter>
<title>Actors</title>
<xi:include href="xml/shell-generic-container.xml"/>
<xi:include href="xml/shell-stack.xml"/>
</chapter>
<chapter>
<title>Application tracking</title>
<xi:include href="xml/shell-app.xml"/>
<xi:include href="xml/shell-app-usage.xml"/>
<xi:include href="xml/shell-window-tracker.xml"/>
</chapter>
<chapter>
<title>Search</title>
<xi:include href="xml/shell-app-system.xml"/>
</chapter>
<chapter>
<title>Tray Icons</title>
<xi:include href="xml/shell-embedded-window.xml"/>
<xi:include href="xml/shell-gtk-embed.xml"/>
<xi:include href="xml/shell-tray-icon.xml"/>
<xi:include href="xml/shell-tray-manager.xml"/>
</chapter>
<chapter>
<title>Recorder</title>
<xi:include href="xml/shell-recorder.xml"/>
</chapter>
<chapter>
<title>Integration helpers and utilities</title>
remote-search: properly document the DBus interface Use real annotations in the XML, and use gdbus-codegen to extract those into docbook. We then include it in the Shell's gtk-doc. https://bugzilla.gnome.org/show_bug.cgi?id=689735
2012-12-05 14:37:57 -05:00
<xi:include href="doc-gen-org.gnome.Shell.SearchProvider.xml"/>
remote-search: add an org.gnome.ShellSearchProvider2 dbus interface We are going to change the interface, so add a new version of it. Providers will need to opt-in to the new API. A summary of the differences compared to the previous API: - ActivateResult() now also takes the search terms and a timestamp as parameters - a new LaunchSearch() method is added https://bugzilla.gnome.org/show_bug.cgi?id=689735
2012-12-05 12:59:24 -05:00
<xi:include href="doc-gen-org.gnome.Shell.SearchProvider2.xml"/>
docs: Allow building API documentation As extensions.gnome.org starts to shape up, we should allow to build the API documentation for St/Shell. https://bugzilla.gnome.org/show_bug.cgi?id=661045
2011-09-07 14:23:28 -04:00
<xi:include href="xml/shell-global.xml"/>
docs: Update for renamed file
2015-01-21 10:01:57 -05:00
<xi:include href="xml/shell-action-modes.xml"/>
docs: Allow building API documentation As extensions.gnome.org starts to shape up, we should allow to build the API documentation for St/Shell. https://bugzilla.gnome.org/show_bug.cgi?id=661045
2011-09-07 14:23:28 -04:00
<xi:include href="xml/shell-wm.xml"/>
<xi:include href="xml/shell-util.xml"/>
<xi:include href="xml/shell-mount-operation.xml"/>
<xi:include href="xml/shell-polkit-authentication-agent.xml"/>
</chapter>
build: Support the meson build system Meson is on track to replace autotools as the build system of choice, so support it in addition to autotools. If all goes well, we'll eventually be able to drop the latter ... https://bugzilla.gnome.org/show_bug.cgi?id=783229
2017-05-24 20:16:27 -04:00
<!-- FIXME:
Not generated at the moment, find out whether to blame gtk-doc or meson
-->
<!--
docs: Allow building API documentation As extensions.gnome.org starts to shape up, we should allow to build the API documentation for St/Shell. https://bugzilla.gnome.org/show_bug.cgi?id=661045
2011-09-07 14:23:28 -04:00
<chapter id="object-tree">
<title>Object Hierarchy</title>
<xi:include href="xml/tree_index.sgml"/>
</chapter>
build: Support the meson build system Meson is on track to replace autotools as the build system of choice, so support it in addition to autotools. If all goes well, we'll eventually be able to drop the latter ... https://bugzilla.gnome.org/show_bug.cgi?id=783229
2017-05-24 20:16:27 -04:00
-->
docs: Allow building API documentation As extensions.gnome.org starts to shape up, we should allow to build the API documentation for St/Shell. https://bugzilla.gnome.org/show_bug.cgi?id=661045
2011-09-07 14:23:28 -04:00
<index id="api-index-full">
<title>API Index</title>
<xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
</index>
<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>
<xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
</book>
Reference in New Issue Copy Permalink