]> git.sur5r.net Git - glabels/commitdiff
Updated documentation for 2.2.6
authorJim Evins <evins@snaught.com>
Wed, 4 Nov 2009 03:41:09 +0000 (22:41 -0500)
committerJim Evins <evins@snaught.com>
Wed, 4 Nov 2009 03:53:11 +0000 (22:53 -0500)
- Added an example for doing document merge from evolution data server.  (Mario Blättermann)
- Updated most screenshots to 2.2.6 with Clearlooks theme.
- Minor corrections

17 files changed:
.gitignore [new file with mode: 0644]
help/C/figures/main-window-empty.png
help/C/figures/merge-ex1-1.png
help/C/figures/merge-ex1-2.png
help/C/figures/merge-ex1-3.png
help/C/figures/merge-ex1-4.png
help/C/figures/merge-ex2-1.png
help/C/figures/merge-ex2-2.png
help/C/figures/merge-ex2-3.png
help/C/figures/merge-ex2-4.png
help/C/figures/merge-ex3-1.png [new file with mode: 0644]
help/C/figures/merge-ex3-2.png [new file with mode: 0644]
help/C/figures/object-editor-sidebar.png
help/C/figures/print-copies.png
help/C/figures/print-merge.png
help/C/glabels.xml
help/Makefile.am

diff --git a/.gitignore b/.gitignore
new file mode 100644 (file)
index 0000000..0ed79a1
--- /dev/null
@@ -0,0 +1,84 @@
+#
+# General ignore patterns
+#
+*.o
+*.lo
+*.la
+.deps
+.libs
+Makefile
+Makefile.in
+Makefile.in.in
+
+#
+# Explicit files and patterns
+#
+/aclocal.m4
+/autom4te.cache
+/config.guess
+/config.h
+/config.h.in
+/config.log
+/config.status
+/config.sub
+/configure
+/depcomp
+/glabels.spec
+/gnome-doc-utils.make
+/gtk-doc.make
+/install-sh
+/intltool-extract.in
+/intltool-merge.in
+/intltool-update.in
+/libtool
+/ltmain.sh
+/missing
+/mkinstalldirs
+/omf.make
+/stamp-h1
+/xmldocs.make
+
+/libglabels/libglabels.pc
+
+/src/marshal.[ch]
+/src/stock-pixmaps/stockpixbufs.h
+/src/glabels
+/src/glabels-batch
+/src/mygal/e-marshal.[ch]
+
+/data/desktop/glabels.desktop
+/data/mime/glabels.keys
+/data/mime/glabels.xml
+
+/po/.intltool-merge-cache
+/po/*.gmo
+/po/POTFILES
+/po/stamp-it
+/po/glabels.pot
+
+/help/glabels-*.omf
+/help/*/.xml2po.mo
+/help/*/glabels.xml
+!/help/C/glabels.xml
+
+/docs/libglabels/*.stamp
+/docs/libglabels/xml/
+/docs/libglabels/html/
+/docs/libglabels/libglabels-decl.txt
+/docs/libglabels/libglabels-undeclared.txt
+/docs/libglabels/libglabels-unused.txt
+/docs/libglabels/libglabels.args
+/docs/libglabels/libglabels.hierarchy
+/docs/libglabels/libglabels.interfaces
+/docs/libglabels/libglabels.prerequisites
+/docs/libglabels/libglabels.signals
+
+#
+# Ignore artifacts from editors, patching, etc.
+#
+*~
+*.bak
+.*.swp
+*.orig
+*.rej
+*.patch
index 305bd6098cbe3747718eb03b77cc372c9cbef3b8..94a2ab4e32e748b98623d3909ce161b5e8e4a9b7 100644 (file)
Binary files a/help/C/figures/main-window-empty.png and b/help/C/figures/main-window-empty.png differ
index f8673c1d7e9dfe1880f17810d5e668124e11c40d..72221b95cf2781abf2e3ba10fb28f9e89afb39e3 100644 (file)
Binary files a/help/C/figures/merge-ex1-1.png and b/help/C/figures/merge-ex1-1.png differ
index a87675aa06aa52dc08891d1547d0eb325834a978..37ea403cb7802ec5a81b186566ab1e41584e100c 100644 (file)
Binary files a/help/C/figures/merge-ex1-2.png and b/help/C/figures/merge-ex1-2.png differ
index f31ecafe34ece80315e01b71631dfab606c15632..ede4240ae16378988e884393bccede077a63df88 100644 (file)
Binary files a/help/C/figures/merge-ex1-3.png and b/help/C/figures/merge-ex1-3.png differ
index 71e11864da8f52a893b8744460382c78f825f964..808aef68f33b9c2265c0539fcdd7367942513779 100644 (file)
Binary files a/help/C/figures/merge-ex1-4.png and b/help/C/figures/merge-ex1-4.png differ
index 1c64ed76d87b0d74b3e8ac0e45891e7e064a19fd..a41e3d6755e263975e0f3f98ee5b9b680711d49b 100644 (file)
Binary files a/help/C/figures/merge-ex2-1.png and b/help/C/figures/merge-ex2-1.png differ
index e1d8f2af0c5a9a7550ce59f0d781e5530a0ca9b2..5de11e0b45a07955fd6421305643c22997085d6a 100644 (file)
Binary files a/help/C/figures/merge-ex2-2.png and b/help/C/figures/merge-ex2-2.png differ
index baac803a92a338aeb2033cda28be9f810377205a..c222d9cdf7f9960aef682fdeffd322050ddf1c5c 100644 (file)
Binary files a/help/C/figures/merge-ex2-3.png and b/help/C/figures/merge-ex2-3.png differ
index 62d750c673a39ef79fc06d00e0a166de4639b3e3..73996dd983515cdb81a670e297d5ea84b795df56 100644 (file)
Binary files a/help/C/figures/merge-ex2-4.png and b/help/C/figures/merge-ex2-4.png differ
diff --git a/help/C/figures/merge-ex3-1.png b/help/C/figures/merge-ex3-1.png
new file mode 100644 (file)
index 0000000..0ef304f
Binary files /dev/null and b/help/C/figures/merge-ex3-1.png differ
diff --git a/help/C/figures/merge-ex3-2.png b/help/C/figures/merge-ex3-2.png
new file mode 100644 (file)
index 0000000..b66fcfc
Binary files /dev/null and b/help/C/figures/merge-ex3-2.png differ
index f0624a266a377bcd8b2b7ffe9e48b8750f1c2d36..1c41426349ac08bc495cadfdb3b22365516f7565 100644 (file)
Binary files a/help/C/figures/object-editor-sidebar.png and b/help/C/figures/object-editor-sidebar.png differ
index d34d03c97cae00753bf436c4b9e1a98bc1208ba8..029add8013324f5b531fa8784cd91085d713a4f1 100644 (file)
Binary files a/help/C/figures/print-copies.png and b/help/C/figures/print-copies.png differ
index de654d095c82f100ad1f05784dc91e8930bed1a9..86f2e929f80bb611e0a1f5ce3c8515a4ccfc6fd3 100644 (file)
Binary files a/help/C/figures/print-merge.png and b/help/C/figures/print-merge.png differ
index 648dbecb4070e1dbc83cfb450142500632f1c81b..8e17cb3d61fcbf4692809c7df962d28d384deef3 100644 (file)
@@ -2,8 +2,8 @@
 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
   <!ENTITY legal SYSTEM "legal.xml">
-  <!ENTITY appversion "2.2">
-  <!ENTITY manrevision "2.2">
+  <!ENTITY appversion "2.2.6">
+  <!ENTITY manrevision "2.2.6">
   <!ENTITY date "December 2007">
   <!ENTITY app "<application>gLabels</application>">
   <!-- Information about the entities
@@ -35,7 +35,7 @@
        </para>
     </abstract>
     <copyright> 
-      <year>2003-2007</year> 
+      <year>2003-2009</year> 
       <holder>Jim Evins</holder> 
     </copyright>
        <publisher> 
 <!-- to V3.0, and so on. -->  
     <revhistory>
       <revision> 
-               <revnumber>gLabels Manual V&manrevision;</revnumber> 
-               <date>&date;</date> 
+               <revnumber>gLabels Manual V2.2.6</revnumber> 
+               <date>October 2009</date> 
+               <revdescription> 
+                       <para role="author">Mario Blättermann
+               <email>mariobl@gnome.org</email>
+                       </para>
+                       <para role="publisher">Jim Evins</para>
+               </revdescription> 
+      </revision> 
+      <revision> 
+               <revnumber>gLabels Manual V2.2</revnumber> 
+               <date>December 2007</date> 
                <revdescription> 
                        <para role="author">Jim Evins
                <email>evins@snaught.com</email>
             <term><guilabel>Print control (Simple)</guilabel></term>
            <listitem> 
 
-             <para>For simple labels or cards (no document merge), the job
+             <para>For simple labels or cards (no document merge), the <guilabel>labels</guilabel>
                 tabbed section contains the following copy controls.</para>
 
              <!-- ==== Figure ==== -->
            <listitem> 
 
              <para>For labels or cards using the document merge (also known
-                as "mail merge") capability, the job tabbed section contains
+                as "mail merge") capability, the <guilabel>labels</guilabel> tabbed section contains
                 the following merge controls instead of copy controls.</para>
 
              <!-- ==== Figure ==== -->
       feature.</para>
 
     <sect2 id="merge-ex1">
-      <title>Example 1: Name Tags</title>
+      <title>Example 1: Name Tags Using a CSV File</title>
   
       <para>In this example we are organizing an orientation party for the new
         crew members of our ship.  We have a list of freshman crew members that we
@@ -1303,7 +1313,7 @@ Name,Department,SN
     </sect2>
 
     <sect2 id="merge-ex2">
-      <title>Example 2: Address Labels</title>
+      <title>Example 2: Address Labels Using a CSV File</title>
   
       <para>In this example we are going to throw a party and need to print mailing
         address labels for our invitations.  We have a list of our closest friends
@@ -1417,6 +1427,120 @@ Kramer,Cosmo,,"Apt 5B","129 W. 81 St.","New York",NY,10024-7207
 
     </sect2>
 
+<sect2 id="merge-ex3">
+      <title>Example 3: Address Labels Using the <application>Evolution</application> Addressbook</title>
+  
+      <para>Our last party was a great success, and now we need to print mailing
+        address labels for the invitations to a new one. To simplify this, we can use
+       the <application>Evolution</application> addressbook, because the address
+       data of all our friends is stored there.</para>
+
+      <note>
+       <para>Depending on how your copy of &app; was packaged, this option could be unavailable.
+         Support for the <application>Evolution</application> addressbook will only be available
+         if the <application>evolution-data-server</application> and its development files
+         were present when &app; was built. Please keep this in mind if you build &app;
+         directly from source.</para>
+       
+       <para>If the &app; package from your distribution lacks this support,
+         you may wish to contact the package maintainer or file a bug against the package
+         to request it.</para>
+      </note>
+
+      <para>In <application>glabels</application> we have created a new &app;
+        document using the Avery 5512 "Address Labels" template. Next we use the
+        <menuchoice> <guimenu>Objects</guimenu>
+        <guimenuitem>Merge Properties</guimenuitem></menuchoice> menu item to display
+        the <guilabel>Merge properties</guilabel> dialog. We use this dialog to
+        select the source type (in our case <guilabel>Data from default Evolution
+       addressbook</guilabel>) as shown.</para>
+
+      <!-- ==== Figure ==== -->
+      <figure id="merge-ex3-1-fig"> 
+       <title>Merge properties dialog</title> 
+       <screenshot> 
+         <mediaobject> 
+           <imageobject><imagedata
+              fileref="figures/merge-ex3-1.png" format="PNG"/> 
+           </imageobject>
+         </mediaobject> 
+       </screenshot> 
+      </figure>
+      <!-- ==== End of Figure ==== -->
+
+      <para>Once we have chosen <guilabel>Data from default Evolution addressbook
+       </guilabel> as our merge source, we will get a full list of its content. Initially,
+       all entries are checked. Assuming we were planning a really big party, we could
+       leave this selection untouched (but let's keep our budget in mind). We will now select or
+       unselect certain entries by clicking on the appropriate checkboxes, or we could use
+       the <guibutton>Select all</guibutton> and <guibutton>Unselect all
+       </guibutton> buttons to activate or deactivate all entries in the address book.</para>
+      <para>We can also view each entry in more detail by clicking on the appropriate
+        expander (the little triangles) as shown. Once we are satisfied with the
+        selections in this dialog, we will click the <guibutton>OK</guibutton> button to
+       accept the changes.</para>
+
+      <para>Now we start adding objects to our glabels document as shown.</para>
+
+      <!-- ==== Figure ==== -->
+      <figure id="merge-ex3-2-fig"> 
+       <title>Adding objects</title> 
+       <screenshot> 
+         <mediaobject> 
+           <imageobject><imagedata
+              fileref="figures/merge-ex3-2.png" format="PNG"/> 
+           </imageobject>
+         </mediaobject> 
+       </screenshot> 
+      </figure>
+      <!-- ==== End of Figure ==== -->
+
+      <para>In this example we have a single text object again. This text object contains
+        all of our merge fields organized on multiple lines as a mailing address.</para>
+
+      <para>Now we can print our address labels by selecting the
+        <menuchoice> <guimenu>File</guimenu>
+        <guimenuitem>Print</guimenuitem> </menuchoice> menu item. This will display
+        the print dialog as shown below.</para>
+
+      <!-- ==== Figure ==== -->
+      <figure id="merge-ex3-3-fig"> 
+       <title>Printing address labels</title> 
+       <screenshot> 
+         <mediaobject> 
+           <imageobject><imagedata
+              fileref="figures/merge-ex2-3.png" format="PNG"/> 
+           </imageobject>
+         </mediaobject> 
+       </screenshot> 
+      </figure>
+      <!-- ==== End of Figure ==== -->
+
+      <para>Just to make sure our labels are going to look okay, we select the
+        <guilabel>Print outlines</guilabel> option and click
+        <guibutton>Print Preview</guibutton>. This will display a print preview dialog
+        as shown below.</para>
+
+      <!-- ==== Figure ==== -->
+      <figure id="merge-ex3-4-fig"> 
+       <title>Address labels preview</title> 
+       <screenshot> 
+         <mediaobject> 
+           <imageobject><imagedata
+              fileref="figures/merge-ex2-4.png" format="PNG"/> 
+           </imageobject>
+         </mediaobject> 
+       </screenshot> 
+      </figure>
+      <!-- ==== End of Figure ==== -->
+
+      <para>Everything looks good, so we can now load up our printer with
+        the appropriate label stock, print our address labels and start mailing
+        our party invitations.</para>
+
+    </sect2>
+
   </sect1>
 
 
index 708fb593147a2daab92deb028b22b360f13a63f4..1d72e50411629ab14117f9ef37bbfc72e06ef65d 100644 (file)
@@ -17,6 +17,8 @@ DOC_FIGURES = figures/glabels-template-cd.png         \
              figures/merge-ex2-2.png                   \
              figures/merge-ex2-3.png                   \
              figures/merge-ex2-4.png                   \
+             figures/merge-ex3-1.png                   \
+             figures/merge-ex3-2.png                   \
              figures/object-editor-sidebar.png         \
              figures/print-copies.png                  \
              figures/print-merge.png