server: docs: Mention the 3 uses.
authorMurray Cumming <murrayc@murrayc.com>
Tue, 16 Oct 2012 11:55:35 +0000 (13:55 +0200)
committerMurray Cumming <murrayc@murrayc.com>
Tue, 16 Oct 2012 11:55:35 +0000 (13:55 +0200)
doc/reference/librygel-server/gtkdoc/implementing-media-engines.xml [new file with mode: 0644]
doc/reference/librygel-server/gtkdoc/implementing-server-plugins.xml [new file with mode: 0644]
doc/reference/librygel-server/gtkdoc/implementing-servers.xml [new file with mode: 0644]
doc/reference/librygel-server/gtkdoc/librygel-server-docs.xml
doc/reference/librygel-server/gtkdoc/overview.xml

diff --git a/doc/reference/librygel-server/gtkdoc/implementing-media-engines.xml b/doc/reference/librygel-server/gtkdoc/implementing-media-engines.xml
new file mode 100644 (file)
index 0000000..cafabb2
--- /dev/null
@@ -0,0 +1,14 @@
+<?xml version="1.0"?>
+<!DOCTYPE refentry 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'">
+]>
+
+<section id="implementing-media-engines">
+
+<para>
+This library may be used to create Rygel media engines by 
+implementing the <link linkend="RygelMediaEngine">RygelMediaEngine</link> class.
+</para>
+
+</section>
diff --git a/doc/reference/librygel-server/gtkdoc/implementing-server-plugins.xml b/doc/reference/librygel-server/gtkdoc/implementing-server-plugins.xml
new file mode 100644 (file)
index 0000000..6597165
--- /dev/null
@@ -0,0 +1,14 @@
+<?xml version="1.0"?>
+<!DOCTYPE refentry 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'">
+]>
+
+<section id="implementing-server-plugins">
+
+<para>
+This library may be used to create Rygel server plugins by 
+implementing the <link linkend="RygelMediaServerPlugin">RygelMediaServerPlugin</link> class.
+</para>
+
+</section>
diff --git a/doc/reference/librygel-server/gtkdoc/implementing-servers.xml b/doc/reference/librygel-server/gtkdoc/implementing-servers.xml
new file mode 100644 (file)
index 0000000..7508f83
--- /dev/null
@@ -0,0 +1,31 @@
+<?xml version="1.0"?>
+<!DOCTYPE refentry 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'">
+]>
+
+<section id="implementing-servers">
+
+<para>
+This library may be used to create UPnP or DLNA servers via its
+The <link linkend="RygelMediaServer">RygelMediaServer</link>.
+</para>
+
+<!-- TODO: Find a way to mention this C example code in the RygelMediaServer valadoc comments instead. -->
+<para>
+This example program shows how to fill a container with media items and then instantiate a server to serve 
+them.
+</para>
+
+<!-- Do not indent the xi:include node. That puts spaces at the start of the code. -->
+<programlisting role="C">
+<xi:include  href="../../../../examples/standalone-server.c"
+    parse="text"
+    xmlns:xi="http://www.w3.org/2001/XInclude"/>
+</programlisting>
+
+<para>
+librygel-server is licensed under the GNU Lesser General Public License (LGPL).
+</para>
+
+</section>
index 568beaf..1a9ccb9 100644 (file)
     <xi:include href="overview.xml"/>
   </preface>
 
+  <chapter>
+    <title>Implementing Rygel Server Plugins</title>
+    <xi:include href="implementing-server-plugins.xml"/>
+  </chapter>
+
+  <chapter>
+    <title>Implementing Rygel Media Engines</title>
+    <xi:include href="implementing-media-engines.xml"/>
+  </chapter>
+
+  <chapter>
+    <title>Implementing Servers</title>
+    <xi:include href="implementing-servers.xml"/>
+  </chapter>
+
   <!-- These are generated: -->
   <chapter>
     <title>librygel-server API Reference</title>
index b25a2ce..b3de263 100644 (file)
@@ -11,24 +11,6 @@ librygel-server is part of the <ulink url="http://rygel-project.org/">Rygel</uli
 </para>
 
 <para>
-This library may be used to create UPnP or DLNA servers via its
-The <link linkend="RygelMediaServer">RygelMediaServer</link>.
-</para>
-
-<!-- TODO: Find a way to mention this C example code in the RygelMediaServer valadoc comments instead. -->
-<para>
-This example program shows how to fill a container with media items and then instantiate a server to serve 
-them.
-</para>
-
-<!-- Do not indent the xi:include node. That puts spaces at the start of the code. -->
-<programlisting role="C">
-<xi:include  href="../../../../examples/standalone-server.c"
-    parse="text"
-    xmlns:xi="http://www.w3.org/2001/XInclude"/>
-</programlisting>
-
-<para>
 librygel-server is licensed under the GNU Lesser General Public License (LGPL).
 </para>