[Xfce4-commits] <xfce4-docs:ristretto-master> Update skeleton documentation

Stephan Arts noreply at xfce.org
Thu Oct 27 22:10:01 CEST 2011


Updating branch refs/heads/ristretto-master
         to 538fcece452491a22c41a0c185d3040aa8c5f453 (commit)
       from ebbf730e27fc3db0bbf1196b96f2a92a721d2559 (commit)

commit 538fcece452491a22c41a0c185d3040aa8c5f453
Author: Stephan Arts <stephan at xfce.org>
Date:   Thu Oct 27 22:08:04 2011 +0200

    Update skeleton documentation

 manual/index.page         |   54 +++++++++++++++++++++-----------------------
 manual/index.xsl          |   55 ---------------------------------------------
 manual/open-files.page    |   25 ++++++++++++++++++++
 manual/set-wallpaper.page |   25 ++++++++++++++++++++
 manual/slideshow.page     |   27 ++++++++++++++++++++++
 manual/view-images.page   |   25 ++++++++++++++++++++
 6 files changed, 128 insertions(+), 83 deletions(-)

diff --git a/manual/index.page b/manual/index.page
index 2e103fc..d714e5d 100644
--- a/manual/index.page
+++ b/manual/index.page
@@ -1,36 +1,34 @@
 <page xmlns="http://projectmallard.org/1.0/"
       xmlns:e="http://projectmallard.org/experimental/"
       xmlns:its="http://www.w3.org/2005/11/its"
-      type="topic"
-      id="ristretto">
+      type="guide"
+      id="index">
 
-  <info>
-    <revision pkgversion="0.2.0" date="2011-10-26" />
-    <title type="text">Ristretto</title>
-    <desc>User documentation</desc>
-    <credit type="author" its:translate="no">
-      <name>Stephan Arts</name>
-      <email>stephan at xfce.org</email>
-      <years>2011</years>
-    </credit>
-    <license href="http://www.gnu.org/licenses/fdl-1.3-standalone.html">
-      <p>
-        Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free
-        Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with
-        no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts. The complete license text
-        is available from the <link href="http://www.fsf.org/">Free Software Foundation</link>.
-      </p>
-    </license>
-  </info>
+    <info>
+        <title type="link">Ristretto</title>
+        <title type="text">Ristretto</title>
+        <credit type="author" its:translate="no">
+            <name>Stephan Arts</name>
+            <email>stephan at xfce.org</email>
+        </credit>
+        <license>
+            <p>Creative Commons Share Alike 3.0</p>
+        </license>
+    </info>
 
-  <title>Ristretto</title>
+    <title>Ristretto</title>
 
-  <section id="introduction">
+    <section id="introduction">
+        <title>Introduction</title>
+        <p>
+        The Ristretto Image Viewer is an application that can be used to
+        scroll through images. It can be used to run a slideshow of
+        images, open images with other applications like an image-editor
+        or set the Xfce wallpaper.
+        </p>
+    </section>
 
-    <title>Introduction</title>
-    <p>
-        Lorem Ipsum
-    </p>
-
-  </section>
+    <section id="image-viewer" style="2column">
+        <title>Image Viewer</title>
+    </section>
 </page>
diff --git a/manual/index.xsl b/manual/index.xsl
index cb27ba3..ee81253 100644
--- a/manual/index.xsl
+++ b/manual/index.xsl
@@ -33,61 +33,6 @@ includes the table of contents with links.  -->
   <div class="header">
     <xsl:apply-templates mode="mal2html.title.mode" select="mal:title"/>
     <xsl:apply-templates mode="mal2html.title.mode" select="mal:subtitle"/>
-
-    <p class="p">
-      <xsl:call-template name="l10n.gettext">
-        <xsl:with-param name="msgid" select="'This manual describes'"/>
-      </xsl:call-template>
-      <xsl:text> </xsl:text>
-      <span class="app">
-        <xsl:value-of select="mal:title"/>
-      </span>
-      <xsl:text> </xsl:text>
-      <xsl:call-template name="l10n.gettext">
-        <xsl:with-param name="msgid" select="'version'"/>
-      </xsl:call-template>
-      <xsl:text> </xsl:text>
-      <xsl:value-of select="mal:info/mal:revision/@pkgversion"/>.
-    </p>
-    <xsl:apply-templates mode="mal2html.block.mode" select="mal:info/mal:license/*">
-      <xsl:with-param name="first_child" select="false()"/>
-    </xsl:apply-templates>
-  </div>
-
-  <div class="section toc">
-    <h2 class="title">
-      <xsl:call-template name="l10n.gettext">
-        <xsl:with-param name="msgid" select="'Table of Contents'"/>
-      </xsl:call-template>
-    </h2>
-    <ol>
-      <xsl:for-each select="mal:section[mal:title]">
-        <li>
-          <p>
-            <a>
-              <xsl:attribute name="href">
-                <xsl:value-of select="concat('#', @id)"/>
-              </xsl:attribute>
-              <xsl:value-of select="mal:title"/>
-            </a>
-          </p>
-        <xsl:for-each select="mal:section[mal:title]">
-          <ul>
-            <li>
-              <p>
-                <a>            
-                  <xsl:attribute name="href">
-                    <xsl:value-of select="concat('#', @id)"/>
-                  </xsl:attribute>
-                  <xsl:value-of select="mal:title"/>
-                </a>
-              </p>
-            </li>
-          </ul>
-        </xsl:for-each>
-        </li>
-      </xsl:for-each>
-    </ol>
   </div>
 
   <xsl:apply-templates select="mal:section"/>
diff --git a/manual/open-files.page b/manual/open-files.page
new file mode 100644
index 0000000..0a210d3
--- /dev/null
+++ b/manual/open-files.page
@@ -0,0 +1,25 @@
+<page xmlns="http://projectmallard.org/1.0/"
+      xmlns:e="http://projectmallard.org/experimental/"
+      type="topic"
+      id="open-files">
+
+    <info>
+        <link type="guide" xref="index#image-viewer"/>
+        <link type="seealso" xref="preferences"/>
+        <desc>Opening images with <app>Ristretto</app></desc>
+        <credit type="author">
+        <name>Stephan Arts</name>
+        <email>stephan at xfce.org</email>
+        </credit>
+        <license>
+            <p>Creative Commons Share Alike 3.0</p>
+        </license>
+    </info>
+
+    <title>Open Images</title>
+    <p></p>
+    <figure>
+        <title>Ristretto</title>
+        <media type="image" src="media/open-image.png" mime="image/png" style="right"/>
+    </figure>
+</page>
diff --git a/manual/set-wallpaper.page b/manual/set-wallpaper.page
new file mode 100644
index 0000000..aa71a17
--- /dev/null
+++ b/manual/set-wallpaper.page
@@ -0,0 +1,25 @@
+<page xmlns="http://projectmallard.org/1.0/"
+      xmlns:e="http://projectmallard.org/experimental/"
+      type="topic"
+      id="set-wallpaper">
+
+    <info>
+        <link type="guide" xref="index#image-viewer"/>
+        <link type="seealso" xref="preferences"/>
+        <desc>Setting the Xfce wallpaper with <app>Ristretto</app></desc>
+        <credit type="author">
+        <name>Stephan Arts</name>
+        <email>stephan at xfce.org</email>
+        </credit>
+        <license>
+            <p>Creative Commons Share Alike 3.0</p>
+        </license>
+    </info>
+
+    <title>Set Wallpaper</title>
+    <p></p>
+    <figure>
+        <title>Ristretto</title>
+        <media type="image" src="media/open-image.png" mime="image/png" style="right"/>
+    </figure>
+</page>
diff --git a/manual/slideshow.page b/manual/slideshow.page
new file mode 100644
index 0000000..7988a73
--- /dev/null
+++ b/manual/slideshow.page
@@ -0,0 +1,27 @@
+<page xmlns="http://projectmallard.org/1.0/"
+      xmlns:e="http://projectmallard.org/experimental/"
+      type="topic"
+      id="slideshow">
+
+    <info>
+        <link type="guide" xref="index#image-viewer"/>
+        <link type="seealso" xref="preferences"/>
+        <desc>Show a slideshow of images</desc>
+        <credit type="author">
+        <name>Stephan Arts</name>
+        <email>stephan at xfce.org</email>
+        </credit>
+        <license>
+            <p>Creative Commons Share Alike 3.0</p>
+        </license>
+    </info>
+
+    <title>Slideshow</title>
+    <p></p>
+
+    <section id="slideshow-settings">
+        <title>Configuring</title>
+        <p>
+        </p>
+    </section>
+</page>
diff --git a/manual/view-images.page b/manual/view-images.page
new file mode 100644
index 0000000..7b6b04d
--- /dev/null
+++ b/manual/view-images.page
@@ -0,0 +1,25 @@
+<page xmlns="http://projectmallard.org/1.0/"
+      xmlns:e="http://projectmallard.org/experimental/"
+      type="topic"
+      id="view-images">
+
+    <info>
+        <link type="guide" xref="index#image-viewer"/>
+        <link type="seealso" xref="preferences"/>
+        <desc>Viewing images with <app>Ristretto</app></desc>
+        <credit type="author">
+        <name>Stephan Arts</name>
+        <email>stephan at xfce.org</email>
+        </credit>
+        <license>
+            <p>Creative Commons Share Alike 3.0</p>
+        </license>
+    </info>
+
+    <title>View Images</title>
+    <p></p>
+    <figure>
+        <title>Ristretto</title>
+        <media type="image" src="media/open-image.png" mime="image/png" style="right"/>
+    </figure>
+</page>


More information about the Xfce4-commits mailing list