doc: Follow instructions about GNOME Documentation

See http://developer.gnome.org/gnome-doc-make/unstable/migrating.html

Specifically, this commit
- Adds legal.xml file
- Disables scrollkeeper from distcheck flags
- Adds gnome-doc-utils.make to distclean
- Renames doc/ to help/

https://bugzilla.gnome.org/show_bug.cgi?id=685473

4 files changed, 269 insertions, 0 deletions

diff --git a/help/.gitignore b/help/.gitignore
new file mode 100644
index 0000000..cf7cb60
--- /dev/null
+++ b/help/.gitignore
@@ -0,0 +1 @@
+html/*
diff --git a/help/C/grilo-plugins.xml b/help/C/grilo-plugins.xml
new file mode 100644
index 0000000..6553e18
--- /dev/null
+++ b/help/C/grilo-plugins.xml
@@ -0,0 +1,177 @@
+<?xml version="1.0"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+  "http://docbook.org/docbook/xml/4.5/docbookx.dtd" [
+  <!ENTITY legal SYSTEM "legal.xml">
+  <!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/help/C/legal.xml b/help/C/legal.xml
new file mode 100644
index 0000000..05344ae
--- /dev/null
+++ b/help/C/legal.xml
@@ -0,0 +1,75 @@
+  <legalnotice id="legalnotice">
+	<para>
+	  Permission is granted to copy, distribute and/or modify this
+	  document under the terms of the GNU Free Documentation
+	  License (GFDL), Version 1.1 or any later version published
+	  by the Free Software Foundation with no Invariant Sections,
+	  no Front-Cover Texts, and no Back-Cover Texts.  You can find
+	  a copy of the GFDL at this <ulink type="help"
+	  url="help:fdl">link</ulink> or in the file COPYING-DOCS
+	  distributed with this manual.
+         </para>
+         <para> This manual is part of a collection of GNOME manuals
+          distributed under the GFDL.  If you want to distribute this
+          manual separately from the collection, you can do so by
+          adding a copy of the license to the manual, as described in
+          section 6 of the license.
+	</para>
+
+	<para>
+	  Many of the names used by companies to distinguish their
+	  products and services are claimed as trademarks. Where those
+	  names appear in any GNOME documentation, and the members of
+	  the GNOME Documentation Project are made aware of those
+	  trademarks, then the names are in capital letters or initial
+	  capital letters.
+	</para>
+
+	<para>
+	  DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT ARE PROVIDED
+	  UNDER  THE TERMS OF THE GNU FREE DOCUMENTATION LICENSE
+	  WITH THE FURTHER UNDERSTANDING THAT:
+
+	  <orderedlist>
+		<listitem>
+		  <para>DOCUMENT IS PROVIDED ON AN "AS IS" BASIS,
+                    WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR
+                    IMPLIED, INCLUDING, WITHOUT LIMITATION, WARRANTIES
+                    THAT THE DOCUMENT OR MODIFIED VERSION OF THE
+                    DOCUMENT IS FREE OF DEFECTS MERCHANTABLE, FIT FOR
+                    A PARTICULAR PURPOSE OR NON-INFRINGING. THE ENTIRE
+                    RISK AS TO THE QUALITY, ACCURACY, AND PERFORMANCE
+                    OF THE DOCUMENT OR MODIFIED VERSION OF THE
+                    DOCUMENT IS WITH YOU. SHOULD ANY DOCUMENT OR
+                    MODIFIED VERSION PROVE DEFECTIVE IN ANY RESPECT,
+                    YOU (NOT THE INITIAL WRITER, AUTHOR OR ANY
+                    CONTRIBUTOR) ASSUME THE COST OF ANY NECESSARY
+                    SERVICING, REPAIR OR CORRECTION. THIS DISCLAIMER
+                    OF WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS
+                    LICENSE. NO USE OF ANY DOCUMENT OR MODIFIED
+                    VERSION OF THE DOCUMENT IS AUTHORIZED HEREUNDER
+                    EXCEPT UNDER THIS DISCLAIMER; AND
+		  </para>
+		</listitem>
+		<listitem>
+		  <para>UNDER NO CIRCUMSTANCES AND UNDER NO LEGAL
+                       THEORY, WHETHER IN TORT (INCLUDING NEGLIGENCE),
+                       CONTRACT, OR OTHERWISE, SHALL THE AUTHOR,
+                       INITIAL WRITER, ANY CONTRIBUTOR, OR ANY
+                       DISTRIBUTOR OF THE DOCUMENT OR MODIFIED VERSION
+                       OF THE DOCUMENT, OR ANY SUPPLIER OF ANY OF SUCH
+                       PARTIES, BE LIABLE TO ANY PERSON FOR ANY
+                       DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR
+                       CONSEQUENTIAL DAMAGES OF ANY CHARACTER
+                       INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS
+                       OF GOODWILL, WORK STOPPAGE, COMPUTER FAILURE OR
+                       MALFUNCTION, OR ANY AND ALL OTHER DAMAGES OR
+                       LOSSES ARISING OUT OF OR RELATING TO USE OF THE
+                       DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT,
+                       EVEN IF SUCH PARTY SHALL HAVE BEEN INFORMED OF
+                       THE POSSIBILITY OF SUCH DAMAGES.
+		  </para>
+		</listitem>
+	  </orderedlist>
+	</para>
+  </legalnotice>
diff --git a/help/Makefile.am b/help/Makefile.am
new file mode 100644
index 0000000..b5a8c36
--- /dev/null
+++ b/help/Makefile.am
@@ -0,0 +1,16 @@
+include $(top_srcdir)/gnome-doc-utils.make
+dist-hook: doc-dist-hook
+
+DOC_MODULE = grilo-plugins
+DOC_ENTITIES = legal.xml
+DOC_INCLUDES = ../../examples/example-tmdb.c
+DOC_FIGURES =
+
+DOC_LINGUAS =
+
+
+
+# For manual checking:
+XMLLINT = xmllint
+validate: $(srcdir)/C/grilo-plugins.xml
+	$(XMLLINT) --xinclude --postvalid --noout $<