GNOME.org
 

[postr] Added the documentation's skeleton

commit 2cf5f43e9bf3cc8853781466da88eae77c1b739d
Author: Germán Póo-Caamaño <gpoo gnome org>
Date:   Fri Nov 13 14:34:36 2009 -0300

    Added the documentation's skeleton

 help/C/groups.page       |   16 ++++++++++++++++
 help/C/index.page        |   38 ++++++++++++++++++++++++++++++++++++++
 help/C/introduction.page |   30 ++++++++++++++++++++++++++++++
 help/C/login.page        |   18 ++++++++++++++++++
 help/C/offline.page      |   32 ++++++++++++++++++++++++++++++++
 help/C/permissions.page  |   37 +++++++++++++++++++++++++++++++++++++
 help/C/sets.page         |   37 +++++++++++++++++++++++++++++++++++++
 help/C/tags.page         |   30 ++++++++++++++++++++++++++++++
 help/C/uploading.page    |   18 ++++++++++++++++++
 help/README              |   32 ++++++++++++++++++++++++++++++++
 10 files changed, 288 insertions(+), 0 deletions(-)
---
diff --git a/help/C/groups.page b/help/C/groups.page
new file mode 100644
index 0000000..b48906d
--- /dev/null
+++ b/help/C/groups.page
@@ -0,0 +1,16 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" stlye="task"
+      id="groups">
+<info>
+  <link type="guide" xref="index#properties"/>
+  <desc>Sharing your photographs with other people.</desc>
+  <revision pkgversion="0.13" version="0.1" date="2009-11-13" status="incomplete"/>
+  <credit type="author">
+    <name>Germán Póo-Caamaño</name>
+    <email>gpoo gnome org</email>
+  </credit>
+</info>
+
+<title>Send your photographs to groups of your interest.</title>
+
+</page>
diff --git a/help/C/index.page b/help/C/index.page
new file mode 100644
index 0000000..d6d69a9
--- /dev/null
+++ b/help/C/index.page
@@ -0,0 +1,38 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="guide"
+      id="index">
+
+<info>
+  <desc>Flickr Uploader.</desc>
+  <revision pkgversion="0.13" version="0.1" date="2009-11-13" status="incomplete"/>
+  <credit type="author">
+    <name>Germán Póo-Caamaño</name>
+    <email>gpoo gnome org</email>
+  </credit>
+</info>
+
+<title>Postr</title>
+<p>Getting started with Postr</p>
+
+  <section id="getting-started" style="2column">
+    <info>
+      <title type="link">Getting Started</title>
+    </info>
+    <title>Getting Started</title>
+  </section>
+
+  <section id="properties" style="2column">
+    <info>
+      <title type="link">Setting photograph's properties</title>
+    </info>
+    <title>Setting photograph's properties</title>
+  </section>
+
+  <section id="advanced" style="2column">
+    <info>
+      <title type="link">Advanced actions</title>
+    </info>
+    <title>Advanced actions</title>
+  </section>
+
+</page>
diff --git a/help/C/introduction.page b/help/C/introduction.page
new file mode 100644
index 0000000..f61b724
--- /dev/null
+++ b/help/C/introduction.page
@@ -0,0 +1,30 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic"
+      id="introduction">
+
+<info>
+  <link type="guide" xref="index"/>
+  <desc>Introduction to the <app>Postr</app> flickr uploader.</desc>
+  <revision pkgversion="0.13" version="0.1" date="2009-11-13" status="incomplete"/>
+  <credit type="author">
+    <name>Germán Póo-Caamaño</name>
+    <email>gpoo gnome org</email>
+  </credit>
+</info>
+
+<title>Introduction</title>
+
+  <p>
+    <app>Postr</app> is a tool for uploading pictures to Flickr for the
+    GNOME Desktop.
+  </p>
+
+  <figure>
+    <title><app>Postr</app> window</title>
+    <desc><app>Postr</app> main window</desc>
+    <media type="image" src="figures/postr-main-window.png" mime="image/png" style="right">
+      <p><app>Postr</app> main window.</p>
+    </media>
+  </figure>
+
+</page>
diff --git a/help/C/login.page b/help/C/login.page
new file mode 100644
index 0000000..895f430
--- /dev/null
+++ b/help/C/login.page
@@ -0,0 +1,18 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" style="task"
+      id="login">
+<info>
+  <link type="guide" xref="index#getting-started"/>
+  <desc>Log in on Flickr</desc>
+  <revision pkgversion="0.13" version="0.1" date="2009-11-13" status="incomplete"/>
+  <credit type="author">
+    <name>Germán Póo-Caamaño</name>
+    <email>gpoo gnome org</email>
+  </credit>
+</info>
+<title>Log in on Flickr</title>
+
+  <p>Flickr must authorize to <app>Postr</app> the access to your 
+  information before doing anything else.</p>
+
+</page>
diff --git a/help/C/offline.page b/help/C/offline.page
new file mode 100644
index 0000000..8bf4f06
--- /dev/null
+++ b/help/C/offline.page
@@ -0,0 +1,32 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" stlye="task"
+      id="offline">
+<info>
+  <link type="guide" xref="index#advanced"/>
+  <desc>How to continue your work later.</desc>
+  <revision pkgversion="0.13" version="0.1" date="2009-11-13" status="incomplete"/>
+  <credit type="author">
+    <name>Germán Póo-Caamaño</name>
+    <email>gpoo gnome org</email>
+  </credit>
+</info>
+
+<title>Continue the uploading later</title>
+
+  <p></p>
+
+  <steps>
+    <item><p>Save session.</p></item>
+    <item><p>Choose a name.</p></item>
+    <item><p>The next time, you can load a session previously save.</p></item>
+  </steps>
+
+  <note style="tip">
+    <p>
+      If you load a session when you are off-line, the properties that relies
+      on your connection will be lost.  These properties are: sets, groups and
+      privacy.
+    </p>
+  </note>
+
+</page>
diff --git a/help/C/permissions.page b/help/C/permissions.page
new file mode 100644
index 0000000..abb75f1
--- /dev/null
+++ b/help/C/permissions.page
@@ -0,0 +1,37 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" stlye="task"
+      id="permissions">
+<info>
+  <link type="guide" xref="index#properties"/>
+  <desc>Setting permissions to your photographs.</desc>
+  <revision pkgversion="0.13" version="0.1" date="2009-11-13" status="incomplete"/>
+  <credit type="author">
+    <name>Germán Póo-Caamaño</name>
+    <email>gpoo gnome org</email>
+  </credit>
+</info>
+
+<title>Privacy, safety and license.</title>
+
+  <section id="Privacy">
+    <info>
+      <title type="link">Privacy</title>
+    </info>
+    <title>Privacy of your photographs</title>
+  </section>
+
+  <section id="safety">
+    <info>
+      <title type="link">Safety</title>
+    </info>
+    <title>Defining the safety of your content</title>
+  </section>
+
+  <section id="license">
+    <info>
+      <title type="link">License</title>
+    </info>
+    <title>Choosing a license for your photographs</title>
+  </section>
+
+</page>
diff --git a/help/C/sets.page b/help/C/sets.page
new file mode 100644
index 0000000..6aa3725
--- /dev/null
+++ b/help/C/sets.page
@@ -0,0 +1,37 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" stlye="task"
+      id="sets">
+<info>
+  <link type="guide" xref="index#properties"/>
+  <desc>Grouping pictures by set.</desc>
+  <revision pkgversion="0.13" version="0.1" date="2009-11-13" status="incomplete"/>
+  <credit type="author">
+    <name>Germán Póo-Caamaño</name>
+    <email>gpoo gnome org</email>
+  </credit>
+</info>
+
+<title>Grouping pictures by set.</title>
+
+  <section id="what-is-a-set">
+    <info>
+      <title type="link">What is a set?</title>
+    </info>
+    <title>What is a set?</title>
+  </section>
+
+  <section id="creating-a-set">
+    <info>
+      <title type="link">Creating a set</title>
+    </info>
+    <title>Creating a set</title>
+  </section>
+
+  <section id="choosing-a-set">
+    <info>
+      <title type="link">Choosing a set</title>
+    </info>
+    <title>Choosing a set</title>
+  </section>
+
+</page>
diff --git a/help/C/tags.page b/help/C/tags.page
new file mode 100644
index 0000000..ef71034
--- /dev/null
+++ b/help/C/tags.page
@@ -0,0 +1,30 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" stlye="task"
+      id="tags">
+<info>
+  <link type="guide" xref="index#properties"/>
+  <desc>Adding tags to your pictures.</desc>
+  <revision pkgversion="0.13" version="0.1" date="2009-11-13" status="incomplete"/>
+  <credit type="author">
+    <name>Germán Póo-Caamaño</name>
+    <email>gpoo gnome org</email>
+  </credit>
+</info>
+
+<title>Adding tags to your pictures.</title>
+
+  <section id="what-is-a-tag">
+    <info>
+      <title type="link">What is a tag?</title>
+    </info>
+    <title>What is a tag?</title>
+  </section>
+
+  <section id="creating-a-tag">
+    <info>
+      <title type="link">Creating a tag</title>
+    </info>
+    <title>Creating a tag</title>
+  </section>
+
+</page>
diff --git a/help/C/uploading.page b/help/C/uploading.page
new file mode 100644
index 0000000..60c89f1
--- /dev/null
+++ b/help/C/uploading.page
@@ -0,0 +1,18 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" style="task"
+      id="uploading">
+<info>
+  <link type="guide" xref="index#getting-started"/>
+  <desc>Uploading photographs on Flickr</desc>
+  <revision pkgversion="0.13" version="0.1" date="2009-11-13" status="incomplete"/>
+  <credit type="author">
+    <name>Germán Póo-Caamaño</name>
+    <email>gpoo gnome org</email>
+  </credit>
+</info>
+
+<title>Uploading photographs on Flickr</title>
+
+  <p>This page must be written first.</p>
+
+</page>
diff --git a/help/README b/help/README
new file mode 100644
index 0000000..8b8949f
--- /dev/null
+++ b/help/README
@@ -0,0 +1,32 @@
+Writing documentation
+----------------------
+
+We are using Mallard to write the documentation.  Mallard
+is a subset of Docbook XML with some variations in order
+to make easier the process of writing documentation for
+applications.
+
+The documentation has not been included in the installation
+setup yet, because it only has a general skeleton.
+
+In order to test the see the formated pages, you should run
+yelp giving the full path to the directory of the documentation.
+
+For instance:
+$ yelp /home/foo/code/postr/help/C
+
+
+Mallard resources
+-----------------
+
+Mallard offers an easy format.  You would like to start at:
+http://www.gnome.org/~shaunm/mallard/
+
+It is recommended to look read some tips from Milo
+Casagrande at:
+http://milocasagrande.wordpress.com/2009/10/25/long-time-but-mallard-alive/
+
+As usual, looking what other do to get the things done may also
+help.  For instance, reading the documentation's source of
+Empathy at:
+http://git.gnome.org/cgit/empathy/tree/help/C/?h=gnome-2-28
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]