aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJavier Jardón <jjardon@gnome.org>2012-08-11 21:54:15 +0800
committerMatthew Barnes <mbarnes@redhat.com>2012-08-11 21:54:15 +0800
commit67135c3fb618962c15a5e3252b797686a30e3a52 (patch)
tree7c0ebd02d46fb6ef18cfd661fb56de9a931204b7
parentfc30659d1b22894638f34b558c55cd8435106e75 (diff)
downloadgsoc2013-evolution-67135c3fb618962c15a5e3252b797686a30e3a52.tar.gz
gsoc2013-evolution-67135c3fb618962c15a5e3252b797686a30e3a52.tar.zst
gsoc2013-evolution-67135c3fb618962c15a5e3252b797686a30e3a52.zip
Bug 681641 - Port to new documentation infrastructure
https://live.gnome.org/GnomeGoals/NewDocumentationInfrastructure
-rw-r--r--Makefile.am3
-rw-r--r--configure.ac3
-rw-r--r--e-util/e-util.c2
-rw-r--r--help/C/default-browser.page4
-rw-r--r--help/C/mail-encryption-gpg-create-key.page2
-rw-r--r--help/C/mail-save-as-pdf.page2
-rw-r--r--help/C/offline.page2
-rw-r--r--help/C/problems-getting-help.page2
-rw-r--r--help/Makefile.am12
9 files changed, 14 insertions, 18 deletions
diff --git a/Makefile.am b/Makefile.am
index 015fcf5fe4..1a5743adc5 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -32,7 +32,6 @@ EXTRA_DIST = \
intltool-update.in \
intltool-extract.in \
evolution-zip.in \
- gnome-doc-utils.make \
gtk-doc.make
if ENABLE_SMIME
@@ -98,13 +97,11 @@ MAINTAINERCLEANFILES = \
$(srcdir)/ltmain.sh \
$(srcdir)/missing \
$(srcdir)/mkinstalldirs \
- $(srcdir)/gnome-doc-utils.make \
$(srcdir)/gtk-doc.make \
$(srcdir)/m4/codeset.m4 \
$(srcdir)/m4/gettext.m4 \
$(srcdir)/m4/glibc2.m4 \
$(srcdir)/m4/glibc21.m4 \
- $(srcdir)/m4/gnome-doc-utils.m4 \
$(srcdir)/m4/gtk-doc.m4 \
$(srcdir)/m4/iconv.m4 \
$(srcdir)/m4/intdiv0.m4 \
diff --git a/configure.ac b/configure.ac
index 13a3021b4e..cc6cb86a35 100644
--- a/configure.ac
+++ b/configure.ac
@@ -184,8 +184,7 @@ PKG_PROG_PKG_CONFIG
dnl ********************************************
dnl User / Developer Documentation
dnl ********************************************
-dnl gnome-doc-utils-0.20.10 fixes bug 672826
-GNOME_DOC_INIT(0.20.10)
+YELP_HELP_INIT
GTK_DOC_CHECK([1.14],[--flavour no-tmpl])
dnl ******************************
diff --git a/e-util/e-util.c b/e-util/e-util.c
index 4f9983cfcc..707f0d0bbc 100644
--- a/e-util/e-util.c
+++ b/e-util/e-util.c
@@ -271,7 +271,7 @@ e_display_help (GtkWindow *parent,
GError *error = NULL;
guint32 timestamp;
- uri = g_string_new ("ghelp:" PACKAGE);
+ uri = g_string_new ("help:" PACKAGE);
timestamp = gtk_get_current_event_time ();
if (parent != NULL)
diff --git a/help/C/default-browser.page b/help/C/default-browser.page
index 404fe01f1d..e4fe3ffa94 100644
--- a/help/C/default-browser.page
+++ b/help/C/default-browser.page
@@ -26,7 +26,7 @@
<section id="urls-in-emails">
<title>Change which web browser websites are opened in</title>
-<p>Please see <link href="ghelp:gnome-help#net-default-browser">the GNOME Desktop Help</link>.</p>
+<p>Please see <link href="help:gnome-help#net-default-browser">the GNOME Desktop Help</link>.</p>
<p>If the preferred browser is set as default application but still does not work correctly please contact your distribution via their forum or bug tracker.</p>
@@ -43,7 +43,7 @@
<section id="urls-in-emails">
<title>Change which mail application is used to write emails</title>
-<p>Please see <link href="ghelp:gnome-help#net-default-email">the GNOME Desktop Help</link>.</p>
+<p>Please see <link href="help:gnome-help#net-default-email">the GNOME Desktop Help</link>.</p>
</section>
diff --git a/help/C/mail-encryption-gpg-create-key.page b/help/C/mail-encryption-gpg-create-key.page
index 2d124ab4fd..488792a78b 100644
--- a/help/C/mail-encryption-gpg-create-key.page
+++ b/help/C/mail-encryption-gpg-create-key.page
@@ -22,7 +22,7 @@
<title>Creating a GPG key</title>
-<note style="advanced"><p>These steps are very technical. For average users we recommend using the <link href="ghelp:seahorse#index"><app>Seahorse</app> application</link> for managing GPG/OpenPGP keys.</p></note>
+<note style="advanced"><p>These steps are very technical. For average users we recommend using the <link href="help:seahorse#index"><app>Seahorse</app> application</link> for managing GPG/OpenPGP keys.</p></note>
<!-- TODO:POST-3-2: Update and rewrite using Seahorse. Needs a complete rewrite once https://bugzilla.gnome.org/show_bug.cgi?id=508744 is fixed. -->
<p>Before you can get or send GPG encrypted mail, you need to generate your public and private keys with GPG.</p>
diff --git a/help/C/mail-save-as-pdf.page b/help/C/mail-save-as-pdf.page
index 8266ffd9e2..591b7ebb41 100644
--- a/help/C/mail-save-as-pdf.page
+++ b/help/C/mail-save-as-pdf.page
@@ -19,7 +19,7 @@
<title>Save messages as PDF</title>
-<p>In order to save emails in the PDF file format, select <guiseq><gui>File</gui><gui>Print</gui></guiseq> and then choose <gui>Print to File</gui>. See <link href="ghelp:gnome-help#printing">the desktop help</link> for general information on printing.</p>
+<p>In order to save emails in the PDF file format, select <guiseq><gui>File</gui><gui>Print</gui></guiseq> and then choose <gui>Print to File</gui>. See <link href="help:gnome-help#printing">the desktop help</link> for general information on printing.</p>
<note style="advanced">
<p>You can also export messages as PDF by dragging and dropping them to the file manager, instead of dropping them in mbox (text) format by default.</p>
diff --git a/help/C/offline.page b/help/C/offline.page
index 26ba047428..9eed232856 100644
--- a/help/C/offline.page
+++ b/help/C/offline.page
@@ -25,5 +25,5 @@
<p>If this is not the case and Evolution normally works but has suddenly stopped connecting, you may have unintentionally clicked on the connection icon in the lower left corner. When connected, the icon resembles a pair of sockets joined together. If the sockets are open, there is no connection (and the <gui style="button">Send/Receive</gui> button is grayed out). Click on the icon to change its state.</p>
-<p>If the problem persists and you are sure you have not clicked the icon, but you can still reach the network from other apps on your system (browsers, FTP, SSH, ping etc.) it may be that NetworkManager (NM) is not properly configured. Many Linux distributions now use NM to manage their connections, and if it is installed Evolution will use it to detect if the network is up. However NM can be installed but not properly configured, leaving the network working but not detectable by Evolution. (Note that other GNOME-based applications may also fail for the same reason.) The solution is to configure NM to manage your network interface. This is usually easy to do but is outside the scope of this document. For more information please take a look at the <link href="ghelp:gnome-help#net">Desktop help</link> or seek help from your distribution support forums, mailing lists etc.</p>
+<p>If the problem persists and you are sure you have not clicked the icon, but you can still reach the network from other apps on your system (browsers, FTP, SSH, ping etc.) it may be that NetworkManager (NM) is not properly configured. Many Linux distributions now use NM to manage their connections, and if it is installed Evolution will use it to detect if the network is up. However NM can be installed but not properly configured, leaving the network working but not detectable by Evolution. (Note that other GNOME-based applications may also fail for the same reason.) The solution is to configure NM to manage your network interface. This is usually easy to do but is outside the scope of this document. For more information please take a look at the <link href="help:gnome-help#net">Desktop help</link> or seek help from your distribution support forums, mailing lists etc.</p>
</page>
diff --git a/help/C/problems-getting-help.page b/help/C/problems-getting-help.page
index 64d4edd94d..a5d2d355a4 100644
--- a/help/C/problems-getting-help.page
+++ b/help/C/problems-getting-help.page
@@ -21,5 +21,5 @@
<title>How to get help</title>
-<p>To receive help on problems you can send an email to the <link href="http://mail.gnome.org/mailman/listinfo/evolution-list">Evolution mailing list</link> or talk to developers and other users in the IRC chat channel #evolution on the server irc.gimp.net. To connect to an IRC server you can for example <link href="ghelp:empathy#irc-manage">use the internet messenger application <app>Empathy</app></link>.</p>
+<p>To receive help on problems you can send an email to the <link href="http://mail.gnome.org/mailman/listinfo/evolution-list">Evolution mailing list</link> or talk to developers and other users in the IRC chat channel #evolution on the server irc.gimp.net. To connect to an IRC server you can for example <link href="help:empathy#irc-manage">use the internet messenger application <app>Empathy</app></link>.</p>
</page>
diff --git a/help/Makefile.am b/help/Makefile.am
index e166d80e9d..1b01ed88bb 100644
--- a/help/Makefile.am
+++ b/help/Makefile.am
@@ -1,9 +1,10 @@
+@YELP_HELP_RULES@
+
SUBDIRS = quickref
-include $(top_srcdir)/gnome-doc-utils.make
+HELP_ID = evolution
-DOC_ID = evolution
-DOC_FIGURES = \
+HELP_MEDIA = \
figures/color-204a87.png \
figures/color-2e3436.png \
figures/color-4e9a06.png \
@@ -20,7 +21,7 @@ DOC_FIGURES = \
figures/search-icon.png \
figures/window-overview-layers.png
-DOC_PAGES = \
+HELP_FILES = \
backup-restore.page \
calendar-alarms-and-reminders.page \
calendar-caldav.page \
@@ -237,7 +238,6 @@ DOC_PAGES = \
tasks-webdav.page \
using-categories.page
-DOC_LINGUAS = cs de el en_GB es eu fr gl hu mk oc ru sl sv te zh_CN
-dist-hook: doc-dist-hook
+HELP_LINGUAS = cs de el en_GB es eu fr gl hu mk oc ru sl sv te zh_CN
-include $(top_srcdir)/git.mk