[nautilus-actions] Reference manual: overview

From: Pierre Wieser <pwieser src gnome org>
To: commits-list gnome org
Cc:
Subject: [nautilus-actions] Reference manual: overview
Date: Wed, 8 Dec 2010 21:34:35 +0000 (UTC)
commit 2bc69c3e81d3cc7da896bfd21ffff986b004a30a
Author: Pierre Wieser <pwieser trychlos org>
Date:   Mon Dec 6 23:33:56 2010 +0100

    Reference manual: overview

 ChangeLog                                |    7 +
 docs/README                              |    6 +-
 docs/reference/Makefile.am               |   24 ++-
 docs/reference/na-compiling.xml          |  270 ++++++++++++++++++++++++++++++
 docs/reference/na-dist-content.xml       |   98 +++++++++++
 docs/reference/na-getting.xml            |   50 ++++++
 docs/reference/na-plugin.xml             |   76 +++++++++
 docs/reference/na-what-is-it.xml         |   39 +++++
 docs/reference/nautilus-actions-docs.xml |   30 +++-
 docs/reference/version_dir.xml           |    1 +
 10 files changed, 580 insertions(+), 21 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index 8c4f4a0..dcd37e2 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,12 @@
 2010-12-06 Pierre Wieser <pwieser trychlos org>
 
+	* docs/reference/na-compiling.xml:
+	* docs/reference/na-dist-content.xml:
+	* docs/reference/na-getting.xml:
+	* docs/reference/na-plugin.xml:
+	* docs/reference/na-what-is-it.xml:
+	* docs/reference/version_dir.xml: New files.
+
 	* data/actions/my-first-na-action.desktop:
 	* data/actions/my-first-na-menu.desktop:
 	* data/actions/open-terminal-here.desktop:
diff --git a/docs/README b/docs/README
index cec15c6..c116d60 100644
--- a/docs/README
+++ b/docs/README
@@ -2,10 +2,8 @@ docs
 ----
 As of Nautilus-Actions 3.0, the documentation is composed of two main
 parts:
-
-- the Reference Manual describes all features of the product, and
-  rather targets developers and packagers;
-  
+- the Reference Manual describes all features of the product, rather
+  targeting developers and packagers;
 - the Nautilus-Actions Configuration Tool User's Manual.
 
 P. Wieser, Dec. 2010
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
index c6145d6..c5fd68c 100644
--- a/docs/reference/Makefile.am
+++ b/docs/reference/Makefile.am
@@ -44,6 +44,10 @@ DOC_MAIN_SGML_FILE = $(DOC_MODULE)-docs.xml
 # that is, only consider in src/core .c sources whose header is in src/api
 core_headers = $(patsubst $(top_srcdir)/src/core/%,%,$(shell \ls -1 $(top_srcdir)/src/core/*.h))
 
+written_xmls_regexp = $(shell echo "$(DOC_MAIN_SGML_FILE) $(content_files)" | $(SED) 's/[[:space:]]\+/|/g')
+
+written_xmls = $(shell \ls -1 *.xml | $(EGREP) -v "$(written_xmls_regexp)")
+
 # Extra options to supply to gtkdoc-scan
 #	--ignore-headers="config.h devkit-disks-daemon-glue.h"
 #	--rebuild-sections
@@ -101,9 +105,11 @@ MKTMPL_OPTIONS = \
 	$(NULL)
 
 # Non-autogenerated SGML files to be included in $(DOC_MAIN_SGML_FILE)
+# nb: unable to subst/strip/sed a last $(null) terminating character!
+#     so keep it out of there
 content_files = \
 	$(xml_files)								\
-	$(NULL)
+	version_dir.xml
 
 # Images to copy into HTML directory
 HTML_IMAGES = \
@@ -124,22 +130,24 @@ xml_in_files = \
 
 xml_files = $(xml_in_files:.xml.in=.xml)
 
-#CLEANFILES += \
-#	*~											\
-#	gnome-disk-utility-scan*					\
-#	gnome-disk-utility-sections.txt				\
-#	*.stamp										\
-#	-rf html xml tmpl							\
-#	$(NULL)
+version_dir.xml: version.xml
+	cat version.xml | $(SED) 's?^\([[:alnum:]]\.[[:alnum:]]\).*?\1?' > version_dir.xml
+
+CLEANFILES += \
+	version_dir.xml								\
+	$(NULL)
 
 # Version information for marking the documentation
 EXTRA_DIST += \
 	$(xml_in_files)								\
+	$(written_xmls)								\
 	$(NULL)
 
 install-data-local: install-data-local-hook
 
 install-data-local-hook:
 	echo "core_headers=$(core_headers)"
+	echo "written_xmls_regexp=$(written_xmls_regexp)"
+	echo "written_xmls=$(written_xmls)"
 
 #TESTS = $(GTKDOC_CHECK)
diff --git a/docs/reference/na-compiling.xml b/docs/reference/na-compiling.xml
new file mode 100644
index 0000000..fc63c3b
--- /dev/null
+++ b/docs/reference/na-compiling.xml
@@ -0,0 +1,270 @@
+<?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 prodname "<productname>Nautilus-Actions</productname>">
+  <!ENTITY nautilus "<productname>Nautilus</productname>">
+]>
+
+<refentry id="na-compiling" revision="4 Dec 2010">
+
+  <refmeta>
+    <refentrytitle>Compiling the Nautilus-Actions package</refentrytitle>
+    <manvolnum>3</manvolnum>
+    <refmiscinfo>Nautilus-Actions</refmiscinfo>
+  </refmeta>
+
+  <refnamediv>
+    <refname>Compiling the Nautilus-Actions Package</refname>
+    <refpurpose>
+      How to compile Nautilus-Actions
+    </refpurpose>
+  </refnamediv>
+
+  <refsect1 id="building">
+    <title>Building &prodname; on UNIX</title>
+
+    <para>
+      On UNIX, &prodname; uses the standard GNU build system,
+      using <application>autoconf</application> for package
+      configuration and resolving portability issues,
+      <application>automake</application> for building makefiles
+      that comply with the GNU Coding Standards, and
+      <application>libtool</application> for building shared
+      libraries on multiple platforms.  The normal sequence for
+      compiling and installing the &prodname; package is thus:
+
+      <literallayout>
+        <userinput>./configure</userinput>
+        <userinput>make</userinput>
+        <userinput>make install</userinput>
+      </literallayout>
+    </para>
+
+    <para>
+      The standard options provided by <application>GNU
+      autoconf</application> may be passed to the
+      <command>configure</command> script.  Please see the
+      <application>autoconf</application> documentation or run
+      <command>./configure --help</command> for information about
+      the standard options.
+    </para>
+  </refsect1>
+
+  <refsect1 id="dependencies">
+    <title>Dependencies</title>
+
+    <para>
+      Before you can compile the &prodname; package, you need to have
+      various other tools and libraries installed on your
+      system. The two tools needed during the build process (as
+      differentiated from the tools used in when creating &prodname;
+      mentioned above such as <application>autoconf</application>)
+      are <command>pkg-config</command> and GNU make.
+    </para>
+
+    <itemizedlist>
+      <listitem>
+        <para>
+          <ulink url="http://www.freedesktop.org/software/pkgconfig/";>pkg-config</ulink>
+          is a tool for tracking the compilation flags needed for
+          libraries that are used by the &prodname; package.
+          (For each library, a small <literal>.pc</literal> text file is
+          installed in a standard location that contains the compilation
+          flags needed for that library along with version number
+          information.)
+        </para>
+      </listitem>
+      <listitem>
+        <para>
+          The &prodname; makefiles will mostly work with different versions
+          of <command>make</command>. However, there tends to be
+          a few incompatibilities, so the &prodname; team recommends
+          installing <ulink url="http://www.gnu.org/software/make";>GNU
+          make</ulink> if you don't already have it on your system
+          and using it. (It may be called <command>gmake</command>
+          rather than <command>make</command>.)
+        </para>
+      </listitem>
+    </itemizedlist>
+
+    <para>
+      &prodname; depends on a number of other libraries.
+    </para>
+
+    <itemizedlist>
+      <listitem>
+        <para>
+          <ulink url="http://library.gnome.org/devel/glib/stable/";>GLib</ulink>
+          and <ulink url="http://www.gtk.org/";>Gtk+</ulink> are fondamental
+          libraries, both for user interface and for portability and
+          internationalization management.
+        </para>
+      </listitem>
+      <listitem>
+        <para>
+          <ulink url="http://xmlsoft.org/";>libxml2</ulink> is used to
+          manage XML imports and exports.
+        </para>
+      </listitem>
+      <listitem>
+        <para>
+          <ulink url="http://library.gnome.org/devel/libgtop/stable/";>libgtop2</ulink>
+          is used to detect and identify running processes as part of the validation
+          process of a candidate context.
+        </para>
+      </listitem>
+      <listitem>
+        <para>
+          <ulink url="http://www.x.org/";>libSM</ulink>
+          is used as a session management library, in order to be sure the session
+          will not terminate without at least proposing the user to save his
+          modifications.
+        </para>
+      </listitem>
+      <listitem>
+        <para>
+          <ulink url="ftp://ftp.kernel.org/pub/linux/utils/util-linux-ng";>libUUID</ulink>
+          is the universally unique ID library used to automatically generate a
+          unique identifiant at item creation.
+        </para>
+      </listitem>
+      <listitem>
+        <para>
+          <ulink url="http://www.gnome.org/~ebassi/source/";>libunique</ulink>
+          is required so that the Nautilus-Actions Configuration Tool only
+          executes one instance.
+        </para>
+      </listitem>
+      <listitem>
+        <para>
+          And, of course,
+          <ulink url="http://projects.gnome.org/nautilus/";>&nautilus; extension</ulink>
+          is required because &prodname; is first a &nautilus; extension.
+        </para>
+      </listitem>
+    </itemizedlist>
+  </refsect1>
+
+  <refsect1 id="extra-configuration-options">
+    <title>Extra Configuration Options</title>
+
+    <para>
+      In addition to the normal options, the
+      <command>configure</command> script in the &prodname; package
+      supports these additional arguments:
+
+      <cmdsynopsis>
+        <command>configure</command>
+        <group>
+          <arg>--with-nautilus-extdir=DIR</arg>
+        </group>
+        <group>
+          <arg>--with-default-io-provider=na-gconf|na-desktop</arg>
+        </group>
+        <group>
+          <arg>--enable-html-manuals[=gdt|db2html]</arg>
+        </group>
+        <group>
+          <arg>--enable-pdf-manuals[=dblatex]</arg>
+        </group>
+      </cmdsynopsis>
+    </para>
+
+    <formalpara>
+      <title><systemitem>--with-nautilus-extdir=DIR</systemitem></title>
+      <para>
+        With this option, one may define an alternate directory where
+        our &nautilus; extensions will be stored.
+      </para>
+      <para>
+        This is most commonly useful:
+      </para>
+      <itemizedlist>
+        <listitem>
+          <para>
+            In development mode, we only have to install symlinks
+            from &nautilus; standard location to our development
+            tree once. Then, each new version of our libraries
+            will be automatically considered by &nautilus;.
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+            When running <command>make distcheck</command>, so that
+            compiled libraries do not interfere with installed ones.
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+            When &nautilus; is not installed itself in a standard
+            location.
+          </para>
+        </listitem>
+      </itemizedlist>
+    </formalpara>
+
+    <formalpara>
+      <title><systemitem>--with-default-io-provider=na-gconf|na-desktop</systemitem></title>
+      <para>
+        As of version 3.0, &prodname; may store menus and actions
+        both in GConf, which is the historical behavior, or as
+        <filename>.desktop</filename> files.
+      </para>
+      <para>
+        This option lets the packager define which will be the
+        default destination when a new menu or action will be
+        created.
+      </para>
+      <para>
+        This defaults to &quot;na-desktop&quot; which is the internal
+        identifiant of the I/O provider which manages
+        <filename>.desktop</filename> files.
+      </para>
+    </formalpara>
+
+    <formalpara>
+      <title><systemitem>--enable-html-manuals[=gdt|db2html]</systemitem></title>
+      <para>
+        This option lets the packager regenerate user's manuals
+        from the DocBook sources as HTML documents.
+      </para>
+      <para>
+        All available translations are generated.
+      </para>
+      <para>
+        Building HTML documents from DocBook source can be
+        realized through <application>gnome-doc-tool</application>
+        or <application>db2html</application>.
+        &prodname; defaults to use <application>gnome-doc-tool</application>
+        as the output format better sticks with those of
+        <application>Yelp</application>.
+      </para>
+      <para>
+        As this option is always set when running
+        <command>make distcheck</command>, the packager can be
+        mostly sure that the distributed manuals are up to date,
+        and may safely ignore this option.
+      </para>
+    </formalpara>
+
+    <formalpara>
+      <title><systemitem>--enable-pdf-manuals[=dblatex]</systemitem></title>
+      <para>
+        This option lets the packager regenerate user's manuals
+        from the DocBook sources as PDF documents.
+      </para>
+      <para>
+        All available translations are generated.
+      </para>
+      <para>
+        As this option is always set when running
+        <command>make distcheck</command>, the packager can be
+        mostly sure that the distributed manuals are up to date,
+        and may safely ignore this option.
+      </para>
+    </formalpara>
+
+  </refsect1>
+
+</refentry>
\ No newline at end of file
diff --git a/docs/reference/na-dist-content.xml b/docs/reference/na-dist-content.xml
new file mode 100644
index 0000000..72e8b95
--- /dev/null
+++ b/docs/reference/na-dist-content.xml
@@ -0,0 +1,98 @@
+<?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 prodname "<productname>Nautilus-Actions</productname>">
+  <!ENTITY nautilus "<productname>Nautilus</productname>">
+]>
+
+<refentry id="na-dist-content" revision="6 Dec 2010">
+
+  <refmeta>
+    <refentrytitle>Distribution content</refentrytitle>
+    <manvolnum>3</manvolnum>
+    <refmiscinfo>Nautilus-Actions</refmiscinfo>
+  </refmeta>
+
+  <refnamediv>
+    <refname>Distribution content</refname>
+    <refpurpose>
+      What is distributed ?
+    </refpurpose>
+  </refnamediv>
+
+  <refsect1 id="dist-content">
+    <title>What does content the distribution ?</title>
+    <para>
+      &prodname; distribution contains the following components:
+    </para>
+    <itemizedlist>
+      <listitem>
+        <para>
+          Programs
+        </para>
+        <itemizedlist>
+          <listitem>
+            a &nautilus; plugin, said <emphasis>menu</emphasis>,
+            responsible for managing displayed menus and actions
+            through &nautilus; extensions;
+          </listitem>
+          <listitem>
+            a &nautilus; plugin, said <emphasis>tracker</emphasis>,
+            which manages DBus services;
+          </listitem>
+          <listitem>
+            <application>Nautilus-Actions Configuration Tool</application>
+            is the user interface application which lets the user edit,
+            create, delete and organize his collection of menus and actions;
+          </listitem>
+          <listitem>
+            <application>nautilus-actions-new</application> is a
+            command-line utility for defining a new action;
+          </listitem>
+          <listitem>
+            <application>nautilus-actions-run</application> is a
+            command-line utility for running an existing action,
+            taking into account the current &nautilus; selection;
+          </listitem>
+          <listitem>
+            <application>nautilus-actions-schemas</application>
+            is a command-line utility which outputs
+            to stdout the GConf schemas of the
+            <application>Nautilus-Actions Configuration Tool</application>;
+            it rather targets packagers.
+          </listitem>
+        </itemizedlist>
+      </listitem>
+      <listitem>
+        <para>
+          Documentation
+        </para>
+        <itemizedlist>
+          <listitem>
+            the &prodname; Reference Manual (this document) rather
+            targets developers and packagers;
+          </listitem>
+          <listitem>
+            the &prodname; Configuration Tool User's Manual is the user's
+            manual of the
+            <application>Nautilus-Actions Configuration Tool</application>
+            management user interface. The distribution contains all
+            available translations, both as HTML and PDF documents.
+          </listitem>
+        </itemizedlist>
+      </listitem>
+      <listitem>
+        <para>
+          Samples
+        </para>
+        <para>
+          The sample menus and actions described in the
+          &prodname; Configuration Tool User's Manual
+          are included in the standard distribution.
+        </para>
+      </listitem>
+    </itemizedlist>
+  </refsect1>
+
+</refentry>
\ No newline at end of file
diff --git a/docs/reference/na-getting.xml b/docs/reference/na-getting.xml
new file mode 100644
index 0000000..b4e20f2
--- /dev/null
+++ b/docs/reference/na-getting.xml
@@ -0,0 +1,50 @@
+<?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 version_dir SYSTEM "version_dir.xml">
+  <!ENTITY prodname "<productname>Nautilus-Actions</productname>">
+  <!ENTITY nautilus "<productname>Nautilus</productname>">
+]>
+
+<refentry id="na-getting" revision="6 Dec 2010">
+
+  <refmeta>
+    <refentrytitle>Getting Nautilus-Actions</refentrytitle>
+    <refmiscinfo>Nautilus-Actions</refmiscinfo>
+  </refmeta>
+
+  <refnamediv>
+    <refname>Getting Nautilus-Actions</refname>
+    <refpurpose>
+      Where to find it ?
+    </refpurpose>
+  </refnamediv>
+
+  <refsect1 id="getting">
+    <title>Getting Nautilus-Actions</title>
+    <para>
+      The latest release may always be found in
+    </para>
+    <itemizedlist>
+	  <listitem>
+	    <simpara>
+          <ulink role="online-location" url="http://www.nautilus-actions.org/downloads/";>http://www.nautilus-actions.org/downloads/</ulink>
+        </simpara>
+	  </listitem>
+	  <listitem>
+	    <simpara>
+          <ulink role="online-location" url="http://download.gnome.org/sources/nautilus-actions/";>http://ftp.gnome.org/nautilus-actions/&version_dir;/</ulink>
+        </simpara>
+	  </listitem>
+	  <listitem>
+	    <simpara>
+	      <!-- FIXME: address the last version subdirectory,
+               via the 'version_dir' entity, but without the final space -->
+          <ulink role="online-location" url="ftp://ftp.trychlos.org/pub/tarballs/nautilus-actions/";>ftp://ftp.trychlos.org/pub/tarballs/nautilus-actions/</ulink>
+        </simpara>
+	  </listitem>
+    </itemizedlist>
+  </refsect1>
+
+</refentry>
\ No newline at end of file
diff --git a/docs/reference/na-plugin.xml b/docs/reference/na-plugin.xml
new file mode 100644
index 0000000..4c60442
--- /dev/null
+++ b/docs/reference/na-plugin.xml
@@ -0,0 +1,76 @@
+<?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 prodname "<productname>Nautilus-Actions</productname>">
+  <!ENTITY nautilus "<productname>Nautilus</productname>">
+]>
+
+<refentry id="na-plugin" revision="6 Dec 2010">
+
+  <refmeta>
+    <refentrytitle>Extending Nautilus-Actions</refentrytitle>
+    <refmiscinfo>Nautilus-Actions</refmiscinfo>
+  </refmeta>
+
+  <refnamediv>
+    <refname>Plugin development</refname>
+    <refpurpose>
+      How to extend Nautilus-Actions and develop new plugins ?
+    </refpurpose>
+  </refnamediv>
+
+  <refsect1 id="plugin">
+    <title>Plugin Overview</title>
+    <para>
+      &prodname; may be extended by developing new extensions
+      which will be dynamically taken into account at runtime.
+      These are plugins.
+    </para>
+    <para>
+      As of today, &prodname; may be extended in the following
+      areas:
+    </para>
+    <itemizedlist>
+      <listitem>
+        <formalpara>
+          <title>
+            Storing menus and actions in a specific storage subsystem
+          </title>
+          <para>
+            This extension is provided via the public NAIIOProvider
+            interface; it takes care of reading and writing menus
+            and actions to a specific storage subsystem.
+          </para>
+        </formalpara>
+      </listitem>
+      <listitem>
+        <formalpara>
+          <title>
+            Exporting menus and actions
+          </title>
+          <para>
+            This extension is provided via the public NAIExporter
+            interface; it takes care of exporting menus and actions
+            to the filesystem from the &prodname; Configuration Tool
+            user interface.
+          </para>
+        </formalpara>
+      </listitem>
+      <listitem>
+        <formalpara>
+          <title>
+            Importing menus and actions
+          </title>
+          <para>
+            This extension is provided via the public NAIImporter
+            interface; it takes care of importing menus and actions
+            from the filesystem into the &prodname; Configuration Tool
+            user interface.
+          </para>
+        </formalpara>
+      </listitem>
+    </itemizedlist>
+  </refsect1>
+
+</refentry>
\ No newline at end of file
diff --git a/docs/reference/na-what-is-it.xml b/docs/reference/na-what-is-it.xml
new file mode 100644
index 0000000..7f2714f
--- /dev/null
+++ b/docs/reference/na-what-is-it.xml
@@ -0,0 +1,39 @@
+<?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 prodname "<productname>Nautilus-Actions</productname>">
+  <!ENTITY nautilus "<productname>Nautilus</productname>">
+]>
+
+<refentry id="na-what-is-it" revision="6 Dec 2010">
+
+  <refmeta>
+    <refentrytitle>What is it ?</refentrytitle>
+    <refmiscinfo>Nautilus-Actions</refmiscinfo>
+  </refmeta>
+
+  <refnamediv>
+    <refname>What is it ?</refname>
+    <refpurpose>
+      What is Nautilus-Actions ?
+    </refpurpose>
+  </refnamediv>
+
+  <refsect1 id="what-is-it">
+    <title>What is Nautilus-Actions ?</title>
+    <para>
+      &prodname; is a &nautilus; extension whose principal function
+      is to allow the user to add arbitrary actions to the file manager
+      context menus. These actions may be organized in menus and submenus,
+      exported and shared with other desktop environments.
+    </para>
+	<para>
+	  &prodname; is compliant with 
+      <ulink role="online-location" url="http://www.nautilus-actions.org/?q=node/377/";>DES-EMA</ulink>
+	  specification. This means that actions and menus defined in &prodname;
+	  will be shareable with the compliant desktop environments.
+	</para>
+  </refsect1>
+
+</refentry>
\ No newline at end of file
diff --git a/docs/reference/nautilus-actions-docs.xml b/docs/reference/nautilus-actions-docs.xml
index 9db6e80..fc3c3e9 100644
--- a/docs/reference/nautilus-actions-docs.xml
+++ b/docs/reference/nautilus-actions-docs.xml
@@ -2,36 +2,48 @@
 <!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 % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
   <!ENTITY version SYSTEM "version.xml">
   <!ENTITY prodname "<productname>Nautilus-Actions</productname>">
   <!ENTITY nautilus "<productname>Nautilus</productname>">
 ]>
+<!--
+ I miss several things here:
+ - I would like to insert line breaks somewhere (e.g. inside of releaseinfo)
+ - I would like to get ride of the extra space which comes with 'version.xml'
+   and in general with all included entities
+   (see e.g. na-getting.xml)
+-->
 <book id="index">
   <bookinfo>
     <title>&prodname; Reference Manual</title>
     <releaseinfo>
       For Nautilus-Actions &version;
-      <!--
+      <!-- linebreak -->
       The latest version of this documentation can be found on-line at
-      <ulink role="online-location" url="http://[SERVER]/nautilus-actions/index.html";>http://[SERVER]/nautilus-actions/</ulink>.
-      -->
+      <ulink role="online-location" url="http://www.nautilus-actions.org/docs/reference/";>http://www.nautilus-actions.org/docs/reference</ulink>.
     </releaseinfo>
+    <copyright>
+      <year>2010</year>
+	  <holder>Pierre Wieser</holder>
+    </copyright>
   </bookinfo>
 
   <chapter>
     <title>&prodname; Overview</title>
-    <xi:include href="what-is-it.xml" />
-    <xi:include href="compiling.xml" />
-    <xi:include href="dist-content.xml" />
+    <xi:include href="na-what-is-it.xml" />
+    <xi:include href="na-getting.xml" />
+    <xi:include href="na-dist-content.xml" />
+    <xi:include href="na-compiling.xml" />
   </chapter>
 
   <chapter>
-    <title>&prodname; Overview</title>
+    <title>Extending &prodname;</title>
+    <xi:include href="na-plugin.xml" />
   </chapter>
 
   <chapter>
-    <title>Available interfaces</title>
+    <title>Public extension interfaces</title>
     <xi:include href="xml/iio-provider.xml" />
     <xi:include href="xml/iimporter.xml" />
     <xi:include href="xml/iexporter.xml" />
diff --git a/docs/reference/version_dir.xml b/docs/reference/version_dir.xml
new file mode 100644
index 0000000..8c50098
--- /dev/null
+++ b/docs/reference/version_dir.xml
@@ -0,0 +1 @@
+3.1
[Date Prev][Date Next] [Thread Prev][Thread Next] [Thread Index] [Date Index] [Author Index]