GNOME.org
 

[grilo-plugins] docs: Add documentation, using Docbook-XML

commit 00ec758bf649e9c88a1ea8afd461d4b54468017c
Author: Murray Cumming <murrayc murrayc com>
Date:   Mon Nov 12 11:36:30 2012 +0100

    docs: Add documentation, using Docbook-XML
    
    Bug #685473

 .gitignore              |    1 +
 Makefile.am             |    2 +-
 autogen.sh              |    1 +
 configure.ac            |    4 +
 doc/.gitignore          |    1 +
 doc/C/grilo-plugins.xml |  179 +++++++++++++++++++++++++++++++++++++++++++++++
 doc/Makefile.am         |   15 ++++
 7 files changed, 202 insertions(+), 1 deletions(-)
---
diff --git a/.gitignore b/.gitignore
index 411a546..597c813 100644
--- a/.gitignore
+++ b/.gitignore
@@ -25,6 +25,7 @@ missing
 omf.make
 stamp-h1
 xmldocs.make
+gnome-doc-utils.make
 
 /m4/*.m4
 !/m4/grilo.m4
diff --git a/Makefile.am b/Makefile.am
index ff59fee..4c10e83 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -7,7 +7,7 @@
 
 ACLOCAL_AMFLAGS = -I m4
 
-SUBDIRS = src examples test
+SUBDIRS = src doc examples test
 
 MAINTAINERCLEANFILES = \
         aclocal.m4 \
diff --git a/autogen.sh b/autogen.sh
index b572851..387eadf 100755
--- a/autogen.sh
+++ b/autogen.sh
@@ -17,6 +17,7 @@ which gnome-autogen.sh || {
     exit 1
 }
 
+gnome-doc-prepare --automake --copy --force
 REQUIRED_AUTOMAKE_VERSION=1.8 \
 USE_GNOME2_MACROS=1 \
 USE_COMMON_DOC_BUILD=yes \
diff --git a/configure.ac b/configure.ac
index 46f2c8f..4e83ac1 100644
--- a/configure.ac
+++ b/configure.ac
@@ -995,6 +995,9 @@ AC_SUBST(DEPS_TMDB_LIBS)
 AC_SUBST([abs_top_builddir])
 AC_SUBST([builddir])
 
+GNOME_DOC_INIT([0.9.0],,
+  [AC_MSG_WARN([[gnome-doc-utils not found: tutorial will not be built.]])])
+
 # ----------------------------------------------------------
 # OUTPUT
 # ----------------------------------------------------------
@@ -1022,6 +1025,7 @@ AC_CONFIG_FILES([
   src/upnp/Makefile
   src/vimeo/Makefile
   src/youtube/Makefile
+  doc/Makefile
   examples/Makefile
   test/Makefile
 ])
diff --git a/doc/.gitignore b/doc/.gitignore
new file mode 100644
index 0000000..0695bc0
--- /dev/null
+++ b/doc/.gitignore
@@ -0,0 +1 @@
+html/*	
diff --git a/doc/C/grilo-plugins.xml b/doc/C/grilo-plugins.xml
new file mode 100644
index 0000000..ec2bc77
--- /dev/null
+++ b/doc/C/grilo-plugins.xml
@@ -0,0 +1,179 @@
+<?xml version="1.0"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+  "http://docbook.org/docbook/xml/4.5/docbookx.dtd"; [
+  <!ENTITY url_refdocs_base "http://developer.gnome.org/grilo/unstable/";>
+  <!ENTITY url_examples_base "http://git.gnome.org/browse/grilo-plugins/tree/examples/";>
+  <!ENTITY uuml "&#252;" >
+  <!ENTITY szlig "&#223;" >
+  <!ENTITY verbar "&#124;" >
+  <!ENTITY copy "&#169;" >
+  <!ENTITY nbsp "&#160;" >
+]>
+
+<!-- The XSL for developer.gnome.org requires this id. -->
+<book id="index">
+
+  <bookinfo>
+
+    <title>Grilo Plugins</title>
+
+    <authorgroup>
+      <author>
+        <firstname>Murray</firstname>
+        <surname>Cumming</surname>
+      </author>
+    </authorgroup>
+
+    <abstract>
+
+      <!-- This text is copied from the introduction. -->
+      <para>Grilo is a framework for browsing and searching media content from various sources using a single API. The Grilo Plugins plugins for the Grilo framework to provide access to various sources of media and metadata.
+      </para>
+    </abstract>
+
+    <copyright>
+      <year>2012</year>
+      <holder>Openismus GmbH</holder>
+    </copyright>
+
+    <legalnotice>
+      <para>
+        Permission is granted to copy, distribute and/or modify this document
+        under the terms of the GNU Free Documentation License, Version 1.2
+        or any later version published by the Free Software Foundation;
+        with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
+        You may obtain a copy of the GNU Free Documentation License from the Free Software Foundation by visiting their Web site or by writing to: Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+      </para>
+    </legalnotice>
+
+  </bookinfo>
+
+<chapter id="chapter-introduction">
+<title>Introduction</title>
+
+<para>Grilo is a framework for browsing and searching media content from various sources using a single API. The Grilo Plugins plugins for the Grilo framework to provide access to various sources of media and metadata.</para>
+</chapter>
+
+
+<chapter id="chapter-plugins">
+<title>Grilo Plugins</title>
+
+
+<sect1 id="sec-plugin-apple-trailers">
+<title>Apple Trailers</title>
+<para>This is a Grilo plugin for Apple trailers. Its plugin ID is <literal>"grl-apple-trailers"</literal></para>
+</sect1>
+
+<sect1 id="sec-plugin-bliptv">
+<title>BlipTV</title>
+<para>This is a Grilo plugin for BlipTV. Its plugin ID is <literal>"grl-bliptv"</literal></para>
+</sect1>
+
+<sect1 id="sec-plugin-bookmarks">
+<title>Bookmarks</title>
+<para>This is a Grilo plugin for bookmarks. Its plugin ID is <literal>"grl-bookmarks"</literal></para>
+</sect1>
+
+<sect1 id="sec-plugin-dmap">
+<title>DMap</title>
+<para>This is a Grilo plugin for DMap. Its plugin ID is <literal>"grl-dmap"</literal></para>
+</sect1>
+
+<sect1 id="sec-plugin-fake-metadata">
+<title>Fake Metadata</title>
+<para>This is a Grilo plugin for fake metadata. Its plugin ID is <literal>"grl-fake-metadata"</literal></para>
+<para></para>
+</sect1>
+
+<sect1 id="sec-plugin-filesystem">
+<title>Filesystem</title>
+<para>This is a Grilo plugin for the filesystem. Its plugin ID is <literal>"grl-filesystem"</literal></para>
+</sect1>
+
+<sect1 id="sec-plugin-flickr">
+<title>Flickr</title>
+<para>This is a Grilo plugin for Flickr. Its plugin ID is <literal>"grl-flickr"</literal></para>
+</sect1>
+
+<sect1 id="sec-plugin-gravatar">
+<title>Gravatar</title>
+<para>This is a Grilo plugin for Gravatar Its plugin ID is <literal>"grl-gravatar"</literal>.</para>
+</sect1>
+
+<sect1 id="sec-plugin-jamendo">
+<title>Jamendo</title>
+<para>This is a Grilo plugin for Jamendo. Its plugin ID is <literal>"grl-jamendo"</literal></para>
+</sect1>
+
+<sect1 id="sec-plugin-lastfm-albumart">
+<title>LastFM Album Art</title>
+<para>This is a Grilo plugin for LastFM album art. Its plugin ID is <literal>"grl-lastfm-albumart"</literal></para>
+</sect1>
+
+<sect1 id="sec-plugin-local-metadata">
+<title>Local Metadata</title>
+<para>This is a Grilo plugin for Local metadata. Its plugin ID is <literal>"grl-local-metadata"</literal></para>
+</sect1>
+
+<sect1 id="sec-plugin-metadata-store">
+<title>Metadata Store</title>
+<para>This is a Grilo plugin for metadata store. Its plugin ID is <literal>"grl-metadata-store"</literal></para>
+</sect1>
+
+<sect1 id="sec-plugin-optical-media">
+<title>Optical Media</title>
+<para>This is a Grilo plugin for optical media. Its plugin ID is <literal>"grl-optical-media"</literal></para>
+</sect1>
+
+<sect1 id="sec-plugin-podcasts">
+<title>Podcasts</title>
+<para>This is a Grilo plugin for podcasts. Its plugin ID is <literal>"grl-podcasts"</literal></para>
+</sect1>
+
+<sect1 id="sec-plugin-shoutcast">
+<title>Shoutcast</title>
+<para>This is a Grilo plugin for Shoutcast. Its plugin ID is <literal>"grl-shoutcast"</literal></para>
+</sect1>
+
+<sect1 id="sec-plugin-tmdb">
+<title>TMDb Plugin</title>
+<para>The TMDb plugin retrieves information about movies from the <ulink url="http://themoviedb.org";>TMDb online service</ulink>, which is a community-maintained movie database. Its plugin ID is <literal>"grl-tmdb"</literal></para>
+<para>Before using this plugin, you should set the TMDB API Key with <ulink url="&url_refdocs_base;GrlConfig.html#grl-config-set-api-key"><function>grl_config_set_api_key()</function></ulink>.</para>
+<para>You may then use <ulink url="&url_refdocs_base;GrlSource.html#grl-source-resolve"><function>grl_source_resolve()</function></ulink> to discover details about an existing GrlMediaItem.</para>
+<para>This plugin does not support search via <ulink url="&url_refdocs_base;GrlSource.html#grl-source-search"><function>grl_source_search()</function></ulink> or queries via <ulink url="&url_refdocs_base;GrlSource.html#grl-source-query"><function>grl_source_query()</function></ulink>.</para>
+
+<para>Here is a simple example of the use of the Grilo TMDb plugin:</para>
+
+<para>File: <ulink url="&url_examples_base;example-tmdb.c"><filename>example-tmdb.c</filename></ulink></para>
+<programlisting>
+<xi:include  href="../../examples/example-tmdb.c" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+</programlisting>
+
+</sect1>
+
+<sect1 id="sec-plugin-tracker">
+<title>Tracker</title>
+<para>This is a Grilo plugin for Tracker. Its plugin ID is <literal>"grl-tracker"</literal></para>
+</sect1>
+
+<sect1 id="sec-plugin-upnp">
+<title>UPnP</title>
+<para>This is a Grilo plugin for UPnP. Its plugin ID is <literal>"grl-upnp"</literal></para>
+</sect1>
+
+<sect1 id="sec-plugin-vimeo">
+<title>Vimeo</title>
+<para>This is a Grilo plugin for Vimeo. Its plugin ID is <literal>"grl-vimeo"</literal></para>
+</sect1>
+
+<sect1 id="sec-plugin-youtube">
+<title>YouTube</title>
+<para>This is a Grilo plugin for YouTube. Its plugin ID is <literal>"grl-youtube"</literal></para>
+</sect1>
+
+</chapter>
+
+</book>
+
+
+
diff --git a/doc/Makefile.am b/doc/Makefile.am
new file mode 100644
index 0000000..7aea3af
--- /dev/null
+++ b/doc/Makefile.am
@@ -0,0 +1,15 @@
+DOC_MODULE = grilo-plugins
+DOC_ENTITIES =
+DOC_INCLUDES = ../../examples/example-tmdb.c
+DOC_FIGURES =
+
+DOC_LINGUAS =
+
+include $(top_srcdir)/gnome-doc-utils.make
+
+
+# For manual checking:
+XMLLINT = xmllint
+validate: $(srcdir)/C/grilo-plugins.xml
+	$(XMLLINT) --xinclude --postvalid --noout $<
+
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]