GNOME.org
 

[postr] Update documentation using Mallard, and add some screenshots

commit 39af7c1ffb29cb2560ffb2154bea23ba196f133c
Author: Sergio Infante Montero <raulsergio9 gmail com>
Date:   Wed Dec 1 23:31:45 2010 -0800

    Update documentation using Mallard, and add some screenshots
    
    Update some details of documentation using Mallard, added two
    screenshots (empty window and login window) when the application
    is used for first time.  It is an improvement of the skeleton.
    More work is needed, though.
    
    https://bugzilla.gnome.org/show_bug.cgi?id=601815
    
    Signed-off-by: Germán Póo-Caamaño <gpoo gnome org>

 help/C/figures/postr-login-flickr.png |  Bin 0 -> 22772 bytes
 help/C/figures/postr-main-window.png  |  Bin 0 -> 19175 bytes
 help/C/groups.page                    |   34 +++++++++++++------
 help/C/index.page                     |   24 ++++++++++----
 help/C/introduction.page              |   20 +++++++-----
 help/C/login.page                     |   24 +++++++++++---
 help/C/permissions.page               |   57 +++++++++++++++++++++++++++++----
 help/C/tags.page                      |   14 ++++++--
 help/C/uploading.page                 |   21 ++++++++----
 help/Makefile.am                      |    4 ++-
 10 files changed, 148 insertions(+), 50 deletions(-)
---
diff --git a/help/C/figures/postr-login-flickr.png b/help/C/figures/postr-login-flickr.png
new file mode 100644
index 0000000..9aee647
Binary files /dev/null and b/help/C/figures/postr-login-flickr.png differ
diff --git a/help/C/figures/postr-main-window.png b/help/C/figures/postr-main-window.png
new file mode 100644
index 0000000..c77a8e3
Binary files /dev/null and b/help/C/figures/postr-main-window.png differ
diff --git a/help/C/groups.page b/help/C/groups.page
index b48906d..c0a880a 100644
--- a/help/C/groups.page
+++ b/help/C/groups.page
@@ -1,16 +1,28 @@
 <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>
+        <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>
+        <credit type="author">
+            <name>Sergio Infante Montero</name>
+            <email>raulsergio9 gmail com</email>
+        </credit>
 </info>
-
-<title>Send your photographs to groups of your interest.</title>
-
+    <title>Send your photographs to groups of your interest.</title>
+    <steps>
+        <item><p>Choose an image to upload</p></item>
+        <item><p>Click on Send to Groups option. A list of your groups must be shown</p></item>
+        <item><p>Choose in what group or groups will be send the image</p></item>
+    </steps>
+    <note style="warning">
+    <p>
+      Before you can use the Send to Groups option, at least you must have one.
+    </p>
+    </note>Before you can use Groups. At least you must have one.
 </page>
diff --git a/help/C/index.page b/help/C/index.page
index d6d69a9..232bcc9 100644
--- a/help/C/index.page
+++ b/help/C/index.page
@@ -1,14 +1,24 @@
 <page xmlns="http://projectmallard.org/1.0/";
+      xmlns:e="http://projectmallard.org/experimental/";
       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 type="link">Postr</title>
+        <title type="text">Postr</title>
+        <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>
+        <credit type="author">
+            <name>Sergio Infante</name>
+            <email>raulsergio9 gmail com</email>
+        </credit>
+    <license>
+      <p>Creative Commons Share Alike 3.0</p>
+    </license>
 </info>
 
 <title>Postr</title>
diff --git a/help/C/introduction.page b/help/C/introduction.page
index f61b724..9117ee2 100644
--- a/help/C/introduction.page
+++ b/help/C/introduction.page
@@ -3,19 +3,23 @@
       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>
+    <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>
+    <credit type="author">
+        <name>Sergio Infante</name>
+        <email>raulsergio9 gmail com</email>
+    </credit>
 </info>
 
 <title>Introduction</title>
 
   <p>
-    <app>Postr</app> is a tool for uploading pictures to Flickr for the
+    <app>Postr</app> is simple and useful tool for uploading pictures to Flickr.com for the
     GNOME Desktop.
   </p>
 
diff --git a/help/C/login.page b/help/C/login.page
index 895f430..4676826 100644
--- a/help/C/login.page
+++ b/help/C/login.page
@@ -5,14 +5,28 @@
   <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>
+    <credit type="author">
+        <name>Germán Póo-Caamaño</name>
+        <email>gpoo gnome org</email>
+    </credit>
+    <credit type="author">
+        <name>Sergio Infante</name>
+        <email>raulsergio9 gmail com</email>
+    </credit>
 </info>
 <title>Log in on Flickr</title>
 
-  <p>Flickr must authorize to <app>Postr</app> the access to your 
+  <p>Flickr must authorize to <app>Postr</app> the access to your
   information before doing anything else.</p>
 
+    <figure>
+        <title><app>Postr</app> Login to Flickr window</title>
+        <desc><app>Postr</app> Switch account and Login to Flickr window</desc>
+        <media type="image" src="figures/postr-login-flickr.png" mime="image/png" style="right"></media>
+    </figure>
+    <steps>
+        <item><p>Click on Login to Flickr. This action will open the Flickr authentication page on your default web browser.</p></item>
+        <item><p>Follow the instructions on Flickr website to authorize <app>Postr</app></p></item>
+        <item><p>Back to Login to Flickr window on <app>Postr</app> and click on Continue</p></item>
+    </steps>
 </page>
diff --git a/help/C/permissions.page b/help/C/permissions.page
index abb75f1..861a074 100644
--- a/help/C/permissions.page
+++ b/help/C/permissions.page
@@ -1,23 +1,34 @@
 <page xmlns="http://projectmallard.org/1.0/";
-      type="topic" stlye="task"
+      type="topic" style="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>
+    <credit type="author">
+        <name>Germán Póo-Caamaño</name>
+        <email>gpoo gnome org</email>
+    </credit>
+    <credit type="author">
+        <name>Sergio Infante</name>
+        <email>raulsergio9 gmail com</email>
+    </credit>
 </info>
 
 <title>Privacy, safety and license.</title>
 
-  <section id="Privacy">
+  <section id="privacy">
     <info>
       <title type="link">Privacy</title>
     </info>
     <title>Privacy of your photographs</title>
+    <p>You can choose between:</p>
+        <list>
+            <item><p>Public</p></item>
+            <item><p>Family Only</p></item>
+            <item><p>Friends and Family Only</p></item>
+            <item><p>Private</p></item>
+        </list>
   </section>
 
   <section id="safety">
@@ -25,13 +36,45 @@
       <title type="link">Safety</title>
     </info>
     <title>Defining the safety of your content</title>
+    <p>You can choose between: </p>
+        <list>
+            <item><p>Safe</p></item>
+            <item><p>Moderate</p></item>
+            <item><p>Restricted</p></item>
+        </list>
   </section>
-
+  
+  <section id="content-type">
+    <info>
+      <title type="link">Content Type</title>
+    </info>
+    <title>Content Type of your content</title>
+    <p>You can choose between: </p>
+        <list>
+            <item><p>Photo</p></item>
+            <item><p>Screenshot</p></item>
+            <item><p>Other</p></item>
+        </list>
+  </section>
+  
   <section id="license">
     <info>
       <title type="link">License</title>
     </info>
     <title>Choosing a license for your photographs</title>
+    <p>You can choose between: </p>
+        <list>
+            <item><p>Default</p></item>
+            <item><p>All Rights Reserved</p></item>
+            <item><p>Attribution License</p></item>
+            <item><p>Attribution-NoDerivs License</p></item>
+            <item><p>Attribution-NonCommercial-NoDerivs License</p></item>
+            <item><p>Attribution-NonCommercial License</p></item>
+            <item><p>Attribution-NonCommercial-ShareAlike License</p></item>
+            <item><p>Attribution-ShareAlike License</p></item>
+            <item><p>No known copyright restrictions</p></item>
+            <item><p>United States Government Work</p></item>
+        </list>
   </section>
 
 </page>
diff --git a/help/C/tags.page b/help/C/tags.page
index ef71034..7f6e162 100644
--- a/help/C/tags.page
+++ b/help/C/tags.page
@@ -5,10 +5,14 @@
   <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>
+    <credit type="author">
+        <name>Germán Póo-Caamaño</name>
+        <email>gpoo gnome org</email>
+    </credit>
+    <credit type="author">
+        <name>Sergio Infante</name>
+        <email>raulsergio9 gmail com</email>
+    </credit>
 </info>
 
 <title>Adding tags to your pictures.</title>
@@ -18,6 +22,7 @@
       <title type="link">What is a tag?</title>
     </info>
     <title>What is a tag?</title>
+    <p>A tag is a non-hierarchical term assigned to a piece of information. This term helps describe an item and allows it to be found again by browsing or searching. Tags are generally chosen informally and personally by the user.</p>
   </section>
 
   <section id="creating-a-tag">
@@ -25,6 +30,7 @@
       <title type="link">Creating a tag</title>
     </info>
     <title>Creating a tag</title>
+    <p>Tags are created by typing the term on Tags field on <app>Postr</app> main window</p>
   </section>
 
 </page>
diff --git a/help/C/uploading.page b/help/C/uploading.page
index 60c89f1..6806a32 100644
--- a/help/C/uploading.page
+++ b/help/C/uploading.page
@@ -5,14 +5,21 @@
   <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>
+    <credit type="author">
+        <name>Germán Póo-Caamaño</name>
+        <email>gpoo gnome org</email>
+    </credit>
+    <credit type="author">
+        <name>Sergio Infante</name>
+        <email>raulsergio9 gmail com</email>
+    </credit>
 </info>
 
 <title>Uploading photographs on Flickr</title>
-
-  <p>This page must be written first.</p>
-
+    <steps>
+        <item><p>Click on Add Photos...</p></item>
+        <item><p>Choose the photographs that you want to upload on Flickr</p></item>
+        <item><p>Choose an image and edit the title, description, tags, privacy, safety, type, license and other data of image</p></item>
+        <item><p>When you finish add aditional description, click on Upload button</p></item>
+    </steps>
 </page>
diff --git a/help/Makefile.am b/help/Makefile.am
index efeea53..070a3e3 100644
--- a/help/Makefile.am
+++ b/help/Makefile.am
@@ -3,7 +3,9 @@ include $(top_srcdir)/gnome-doc-utils.make
 dist-hook: doc-dist-hook
 
 DOC_ID = postr
-DOC_FIGURES = 
+DOC_FIGURES = \
+		figures/postr-login-flickr.png \
+		figures/postr-main-window.png
 
 DOC_PAGES = \
 		groups.page		\
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]