[gnome-nettool] Added documentation in Mallard
- From: GermÃn Poà CaamaÃo <gpoo src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gnome-nettool] Added documentation in Mallard
- Date: Tue, 2 Oct 2012 05:20:16 +0000 (UTC)
commit e6e5fa0792183a414f03970a2b97e748289b2f15
Author: GermÃn Poo-CaamaÃo <gpoo gnome org>
Date: Mon Oct 1 22:16:31 2012 -0700
Added documentation in Mallard
Removed the old template in DocBook.
https://bugzilla.gnome.org/show_bug.cgi?id=398138
Signed-off-by: GermÃn Poo-CaamaÃo <gpoo gnome org>
configure.ac | 2 +-
help/C/figures/gnome-nettool-trail.png | Bin 0 -> 1304 bytes
help/C/figures/gnome-nettool.png | Bin 0 -> 2786 bytes
help/C/index.docbook | 97 --------------------------------
help/C/index.page | 28 +++++++++
help/C/introduction.page | 32 +++++++++++
help/C/ip-information.page | 29 ++++++++++
help/C/legal.xml | 76 -------------------------
help/C/network-connectivity.page | 32 +++++++++++
help/Makefile.am | 12 +++-
10 files changed, 131 insertions(+), 177 deletions(-)
---
diff --git a/configure.ac b/configure.ac
index 532cce7..327ca17 100644
--- a/configure.ac
+++ b/configure.ac
@@ -1,6 +1,6 @@
AC_PREREQ([2.64])
AC_INIT([GNOME Nettool],
- [3.2.0],
+ [3.3.0],
[http://bugzilla.gnome.org/enter_bug.cgi?product=gnome-nettool],
[gnome-nettool],
[http://projects.gnome.org/gnome-network/]) #FIXME: website should be updated, it is even yet named gnome-network
diff --git a/help/C/figures/gnome-nettool-trail.png b/help/C/figures/gnome-nettool-trail.png
new file mode 100644
index 0000000..7d3aab7
Binary files /dev/null and b/help/C/figures/gnome-nettool-trail.png differ
diff --git a/help/C/figures/gnome-nettool.png b/help/C/figures/gnome-nettool.png
new file mode 100644
index 0000000..8a48a6d
Binary files /dev/null and b/help/C/figures/gnome-nettool.png differ
diff --git a/help/C/index.page b/help/C/index.page
new file mode 100644
index 0000000..aad8463
--- /dev/null
+++ b/help/C/index.page
@@ -0,0 +1,28 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="guide" style="task"
+ id="index">
+ <info>
+ <title type='link' role="trail"><media type="image" src="figures/gnome-nettool-trail.png"/></title>
+ <title type='link'>Net Tool</title>
+ <title type='text'>Net Tool</title>
+ <revision pkgversion="3.2" version="0.1" date="2012-10-01" status="stub"/>
+
+ <credit type="author">
+ <name>GermÃn Poo-CaamaÃo</name>
+ <email>gpoo gnome org</email>
+ <years>2012</years>
+ </credit>
+
+ <desc>A network diagnostic tool</desc>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <title><media type="image" src="figures/gnome-nettool.png">Net Tool logo</media>Net Tool</title>
+
+ <section id="information" style="2column">
+ <title>Getting Network Information</title>
+ </section>
+
+</page>
diff --git a/help/C/introduction.page b/help/C/introduction.page
new file mode 100644
index 0000000..a1b4cd2
--- /dev/null
+++ b/help/C/introduction.page
@@ -0,0 +1,32 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="topic" style="task"
+ id="introduction">
+
+ <info>
+ <link type="guide" xref="index"/>
+ <desc>Introduction to the <em>Net Tool</em>.</desc>
+
+ <revision pkgversion="3.2" version="0.1" date="2012-10-01" status="stub"/>
+ <credit type="author">
+ <name>GermÃn Poo-CaamaÃo</name>
+ <email>gpoo gnome org</email>
+ <years>2012</years>
+ </credit>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+<title>Introduction</title>
+
+ <p>
+ <app>Nettool</app> is a tool to diagnose the network and services status.
+ It provides a graphical user interface for a number of common network
+ tools, such as ping, netstat, traceroute, port scan, lookup, finger,
+ and whois.
+ </p><p>
+ The functionality is very basic, it is oriented to get the first
+ insight of an potential issue and to bring this information to
+ technical staff.
+ </p>
+</page>
diff --git a/help/C/ip-information.page b/help/C/ip-information.page
new file mode 100644
index 0000000..785914e
--- /dev/null
+++ b/help/C/ip-information.page
@@ -0,0 +1,29 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="topic" style="task"
+ id="ip-information">
+ <info>
+ <link type="guide" xref="index#information"/>
+ <desc>Find the Internet Address (IP) that provides Internet connectivity.</desc>
+ <revision version="0.1" date="2012-10-01" status="stub"/>
+
+ <credit type="author">
+ <name>GermÃn Poo-CaamaÃo</name>
+ <email>gpoo gnome org</email>
+ <years>2012</years>
+ </credit>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <title>Getting the Internet Address</title>
+
+ <p>Usually a computer has one or more network devices. However, one of them
+ provides connectivity to Internet. In <gui>Devices</gui> you can query
+ the information for each device and get some usage statistics. The
+ statistics are set to zero any time you restart your computer.</p>
+
+ <p>You can query the information of a network device by clicking next to
+ <gui>Network Device</gui>.</p>
+
+</page>
diff --git a/help/C/network-connectivity.page b/help/C/network-connectivity.page
new file mode 100644
index 0000000..120d98c
--- /dev/null
+++ b/help/C/network-connectivity.page
@@ -0,0 +1,32 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="topic" style="task"
+ id="network-connectivity">
+ <info>
+ <link type="guide" xref="index#information"/>
+ <desc>Determine if your computer has Internet access.</desc>
+ <revision version="0.1" date="2012-10-01" status="stub"/>
+
+ <credit type="author">
+ <name>GermÃn Poo-CaamaÃo</name>
+ <email>gpoo gnome org</email>
+ <years>2012</years>
+ </credit>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <title>Checking Network Connectivity</title>
+
+ <p>Select the <gui>Ping</gui> tab to check the network connectivity.</p>
+
+ <p>You can query the information of a network device by clicking next to
+ <gui>Network Device</gui>.</p>
+
+ <p>If you successfuly get replies from another machine in Internet, then
+ your computer is connected to a network (likely toInternet as well). This
+ helps you to discard an issue in your computer for the lack of connectivity
+ to other sites.
+ </p>
+
+</page>
diff --git a/help/Makefile.am b/help/Makefile.am
index 5e80126..150214a 100644
--- a/help/Makefile.am
+++ b/help/Makefile.am
@@ -3,11 +3,17 @@
HELP_ID = gnome-nettool
HELP_FILES = \
- index.docbook \
- legal.xml
+ index.page \
+ introduction.page \
+ ip-information.page \
+ network-connectivity.page
-HELP_MEDIA =
+HELP_MEDIA = \
+ figures/gnome-nettool-trail.png \
+ figures/gnome-nettool.png
HELP_EXTRA =
HELP_LINGUAS = ca cs da de el en_GB es fr oc pa pt_BR ru sv uk vi zh_CN
+
+-include $(top_srcdir)/git.mk
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]