GNOME.org
 

[giggle] Initial Mallard documentation port.

commit 225ad793ee553ba42dfb15ddef514bd60f760730
Author: Å?ukasz JernaÅ? <deejay1 srem org>
Date:   Sat Jan 23 13:33:59 2010 +0100

    Initial Mallard documentation port.

 .gitignore                       |    1 +
 Makefile.am                      |    8 +++-
 configure.ac                     |    7 +++-
 help/C/index.page                |   26 ++++++++++++++
 help/C/introduction.page         |   45 +++++++++++++++++++++++
 help/C/legal.xml                 |   72 ++++++++++++++++++++++++++++++++++++++
 help/C/opening-repositories.page |   37 +++++++++++++++++++
 help/C/tagging-commits.page      |   29 +++++++++++++++
 help/Makefile.am                 |   13 +++++++
 m4/.gitignore                    |    1 +
 10 files changed, 236 insertions(+), 3 deletions(-)
---
diff --git a/.gitignore b/.gitignore
index 7c9fab5..45b09af 100644
--- a/.gitignore
+++ b/.gitignore
@@ -3,6 +3,7 @@ autom4te*
 config.*
 configure
 depcomp
+gnome-doc-utils.make
 install-sh
 libtool
 ltmain.sh
diff --git a/Makefile.am b/Makefile.am
index 3386e55..fc4640b 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -1,6 +1,6 @@
 ACLOCAL_AMFLAGS = -I m4 ${ACLOCAL_FLAGS}
 
-SUBDIRS = data libgiggle libgiggle-git plugins src po pixmaps test
+SUBDIRS = data libgiggle libgiggle-git plugins src po pixmaps help test
 
 INTLTOOL = \
 	intltool-extract.in \
@@ -8,9 +8,13 @@ INTLTOOL = \
 	intltool-update.in
 
 EXTRA_DIST = \
-	$(INTLTOOL)
+	$(INTLTOOL) \
+	gnome-doc-utils.make
 
 DISTCLEANFILES = \
 	intltool-extract \
 	intltool-merge \
 	intltool-update
+
+DISTCHECK_CONFIGURE_FLAGS = \
+	--disable-scrollkeeper
diff --git a/configure.ac b/configure.ac
index d6d26b8..82b23b8 100644
--- a/configure.ac
+++ b/configure.ac
@@ -134,6 +134,10 @@ AM_GLIB_DEFINE_LOCALEDIR(LOCALEDIR)
 
 AC_SUBST([CONFIG_STATUS_DEPENDENCIES],['$(top_srcdir)/po/LINGUAS'])
 
+dnl  -------------
+dnl | User Manual |---------------------------------------
+dnl  -------------
+GNOME_DOC_INIT([0.17.3])
 
 dnl  -----------------------
 dnl | GTK+ platform check   |----------------------------------
@@ -178,8 +182,9 @@ dnl -----------------------------------------------------------
 AC_CONFIG_FILES([
         Makefile
         data/Makefile
-        libgiggle-git/Makefile
+        help/Makefile
         libgiggle/Makefile
+        libgiggle-git/Makefile
         pixmaps/Makefile
         plugins/Makefile
         po/Makefile.in
diff --git a/help/C/index.page b/help/C/index.page
new file mode 100644
index 0000000..a1ade82
--- /dev/null
+++ b/help/C/index.page
@@ -0,0 +1,26 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="guide"
+      id="index">
+  <info>
+
+    <credit type="author">
+      <name>Å?ukasz JernaÅ?</name>
+      <email>deejay1 srem org</email>
+    </credit>
+
+<!--
+    <copyright>
+      <year>2009</year>
+      <name>GNOME Documentation Project</name>
+    </copyright>
+-->
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+  </info>
+
+  <title>Giggle Help</title>
+
+  <section id="basics" style="2column">
+    <title>Working with GIT repositories</title>
+  </section>
+
+</page>
diff --git a/help/C/introduction.page b/help/C/introduction.page
new file mode 100644
index 0000000..70e3e0f
--- /dev/null
+++ b/help/C/introduction.page
@@ -0,0 +1,45 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic"
+      id="introduction">
+  <info>
+    <link type="guide" xref="index"/>
+    <desc>
+      Introduction to the <app>Giggle</app> GIT repository viewer
+    </desc>
+
+    <credit type="author">
+      <name>Å?ukasz JernaÅ?</name>
+      <email>deejay1 srem org</email>
+    </credit>
+
+<!--
+    <copyright>
+      <year>2009</year>
+      <name>GNOME Documentation Project</name>
+    </copyright>
+-->
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+  </info>
+
+  <title>Introduction</title>
+  <p>The <app>Giggle</app> application enables you to graphically browse and manipulate the contents of a git directory tree.</p>
+
+  <section id="starting-giggle">
+    <title>Starting <app>giggle</app></title>
+      <p>You can start <app>giggle</app> in the following ways:</p>
+      <steps>
+        <item>
+          <p>Choose <guiseq><gui>Programming</gui> <gui>Giggle</gui></guiseq> from the <gui>Applications</gui> menu.</p>
+        </item>
+        <item>
+          <p>Run <cmd>giggle</cmd> at the prompt in a terminal such or from the <gui>Run Application</gui> dialog.</p>
+        </item>
+      </steps>
+  </section>
+
+  <section id="stoping-giggle">
+    <title>Closing <app>giggle</app></title>
+      <p>To close <app>giggle</app> choose <guiseq><gui>Project</gui><gui>Quit</gui></guiseq>, or press <keyseq><key>Ctrl</key><key>Q</key></keyseq>.</p>
+  </section>
+
+</page>
diff --git a/help/C/legal.xml b/help/C/legal.xml
new file mode 100644
index 0000000..030eaf3
--- /dev/null
+++ b/help/C/legal.xml
@@ -0,0 +1,72 @@
+<legalnotice id="legalnotice">
+  <para>
+    Permission is granted to copy, distribute and/or modify this
+    document under the terms of the GNU Free Documentation
+    License (GFDL), Version 1.1 or any later version published
+    by the Free Software Foundation with no Invariant Sections,
+    no Front-Cover Texts, and no Back-Cover Texts.  You can find
+    a copy of the GFDL at this <ulink type="help"
+    url="ghelp:fdl">link</ulink> or in the file COPYING-DOCS
+    distributed with this manual.
+  </para>
+  <para> This manual is part of a collection of GNOME manuals
+    distributed under the GFDL.  If you want to distribute this
+    manual separately from the collection, you can do so by
+    adding a copy of the license to the manual, as described in
+    section 6 of the license.
+  </para>
+
+  <para>
+    Many of the names used by companies to distinguish their
+    products and services are claimed as trademarks. Where those
+    names appear in any GNOME documentation, and the members of
+    the GNOME Documentation Project are made aware of those
+    trademarks, then the names are in capital letters or initial
+    capital letters.
+  </para>
+
+  <para>
+    DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT ARE PROVIDED
+    UNDER  THE TERMS OF THE GNU FREE DOCUMENTATION LICENSE
+    WITH THE FURTHER UNDERSTANDING THAT:
+    <orderedlist>
+      <listitem>
+        <para>
+	  DOCUMENT IS PROVIDED ON AN "AS IS" BASIS,
+          WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR
+          IMPLIED, INCLUDING, WITHOUT LIMITATION, WARRANTIES
+          THAT THE DOCUMENT OR MODIFIED VERSION OF THE
+          DOCUMENT IS FREE OF DEFECTS MERCHANTABLE, FIT FOR
+          A PARTICULAR PURPOSE OR NON-INFRINGING. THE ENTIRE
+          RISK AS TO THE QUALITY, ACCURACY, AND PERFORMANCE
+          OF THE DOCUMENT OR MODIFIED VERSION OF THE
+          DOCUMENT IS WITH YOU. SHOULD ANY DOCUMENT OR
+          MODIFIED VERSION PROVE DEFECTIVE IN ANY RESPECT,
+          YOU (NOT THE INITIAL WRITER, AUTHOR OR ANY
+          CONTRIBUTOR) ASSUME THE COST OF ANY NECESSARY
+          SERVICING, REPAIR OR CORRECTION. THIS DISCLAIMER
+          OF WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS
+          LICENSE. NO USE OF ANY DOCUMENT OR MODIFIED
+          VERSION OF THE DOCUMENT IS AUTHORIZED HEREUNDER
+          EXCEPT UNDER THIS DISCLAIMER; AND
+          UNDER NO CIRCUMSTANCES AND UNDER NO LEGAL
+          THEORY, WHETHER IN TORT (INCLUDING NEGLIGENCE),
+          CONTRACT, OR OTHERWISE, SHALL THE AUTHOR,
+          INITIAL WRITER, ANY CONTRIBUTOR, OR ANY
+          DISTRIBUTOR OF THE DOCUMENT OR MODIFIED VERSION
+          OF THE DOCUMENT, OR ANY SUPPLIER OF ANY OF SUCH
+          PARTIES, BE LIABLE TO ANY PERSON FOR ANY
+          DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR
+          CONSEQUENTIAL DAMAGES OF ANY CHARACTER
+          INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS
+          OF GOODWILL, WORK STOPPAGE, COMPUTER FAILURE OR
+          MALFUNCTION, OR ANY AND ALL OTHER DAMAGES OR
+          LOSSES ARISING OUT OF OR RELATING TO USE OF THE
+          DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT,
+          EVEN IF SUCH PARTY SHALL HAVE BEEN INFORMED OF
+          THE POSSIBILITY OF SUCH DAMAGES.
+        </para>
+      </listitem>
+    </orderedlist>
+  </para>
+</legalnotice>
diff --git a/help/C/opening-repositories.page b/help/C/opening-repositories.page
new file mode 100644
index 0000000..09ff491
--- /dev/null
+++ b/help/C/opening-repositories.page
@@ -0,0 +1,37 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic"
+      id="opening-repositories">
+  <info>
+    <link type="guide" xref="index#basics"/>
+    <desc>
+      Opening GIT repositories
+    </desc>
+
+    <credit type="author">
+      <name>Å?ukasz JernaÅ?</name>
+      <email>deejay1 srem org</email>
+    </credit>
+
+<!--
+    <copyright>
+      <year>2009</year>
+      <name>GNOME Documentation Project</name>
+    </copyright>
+-->
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+  </info>
+
+  <title>Opening a repository</title>
+  <p>You can open a git repository in the following ways:</p>
+    <steps>
+      <item>
+        <p>using <guiseq><gui>Project</gui><gui>Open</gui></guiseq>, and selecting the directory with your repository,</p>
+      </item>
+      <item>
+        <p>running <cmd>giggle</cmd> in your project's directory,</p>
+      </item>
+      <item>
+        <p>running <cmd>giggle</cmd> with the repository path specified as an argument.</p>
+      </item>
+   </steps>
+</page>
diff --git a/help/C/tagging-commits.page b/help/C/tagging-commits.page
new file mode 100644
index 0000000..1c70712
--- /dev/null
+++ b/help/C/tagging-commits.page
@@ -0,0 +1,29 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic"
+      id="tagging-commits">
+  <info>
+    <link type="guide" xref="index#basics"/>
+    <desc>
+      Tagging commits
+    </desc>
+
+    <credit type="author">
+      <name>Å?ukasz JernaÅ?</name>
+      <email>deejay1 srem org</email>
+    </credit>
+
+<!--
+    <copyright>
+      <year>2009</year>
+      <name>GNOME Documentation Project</name>
+    </copyright>
+-->
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+  </info>
+
+  <title>Tagging commits</title>
+    <p>To make a new tag open the context menu by right clicking on a commit in the revision window (it doesn't matter if it's the Browse or History view), then click <gui>Create tag</gui> and enter a name in the just opened dialog window.</p>
+    <p>You will notice that near the revision you have selected a new icon has appeared - it's your newly created tag.</p>
+
+</page>
+
diff --git a/help/Makefile.am b/help/Makefile.am
new file mode 100644
index 0000000..efd1a5f
--- /dev/null
+++ b/help/Makefile.am
@@ -0,0 +1,13 @@
+include $(top_srcdir)/gnome-doc-utils.make
+
+DOC_ID = giggle
+DOC_INCLUDES = legal.xml
+
+DOC_PAGES = \
+	index.page \
+	introduction.page\
+	opening-repositories.page\
+	tagging-commits.page
+
+DOC_LINGUAS =
+dist-hook: doc-dist-hook
diff --git a/m4/.gitignore b/m4/.gitignore
index 55eaa80..5c53635 100644
--- a/m4/.gitignore
+++ b/m4/.gitignore
@@ -4,3 +4,4 @@ ltoptions.m4
 ltsugar.m4
 ltversion.m4
 lt~obsolete.m4
+gnome-doc-utils.m4
\ No newline at end of file
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]