[evolution] User docs: Use XInclude for common Account Identity section to avoid string duplication
- From: Andre Klapper <aklapper src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [evolution] User docs: Use XInclude for common Account Identity section to avoid string duplication
- Date: Fri, 19 Apr 2013 18:22:13 +0000 (UTC)
commit 431e33b94600997be144cfa1cab1730f625f10f2
Author: Andre Klapper <a9016009 gmx de>
Date: Fri Apr 19 20:21:54 2013 +0200
User docs: Use XInclude for common Account Identity section to avoid string duplication
help/C/mail-account-manage-imap-plus.page | 11 +++++------
help/C/mail-account-manage-local-delivery.page | 11 +++++------
help/C/mail-account-manage-maildir-format-directories.page | 11 +++++------
help/C/mail-account-manage-mh-format-directories.page | 11 +++++------
help/C/mail-account-manage-microsoft-exchange-evo-ews.page | 12 +++++-------
help/C/mail-account-manage-microsoft-exchange-evo-mapi.page | 12 +++++-------
help/C/mail-account-manage-pop.page | 11 +++++------
help/C/mail-account-manage-unix-mbox-spool-directory.page | 11 +++++------
help/C/mail-account-manage-unix-mbox-spool-file.page | 11 +++++------
help/C/mail-account-manage-usenet-news.page | 11 +++++------
help/C/xinclude-mail-account-identity.xml | 9 +++++++++
11 files changed, 59 insertions(+), 62 deletions(-)
---
diff --git a/help/C/mail-account-manage-imap-plus.page b/help/C/mail-account-manage-imap-plus.page
index 3bd4c8d..3df0d13 100644
--- a/help/C/mail-account-manage-imap-plus.page
+++ b/help/C/mail-account-manage-imap-plus.page
@@ -25,12 +25,11 @@
<p>Mail accounts can be edited via <guiseq><gui>Edit</gui><gui>Preferences</gui><gui>Mail Accounts</gui><gui
style="button">Edit</gui></guiseq> or by right-clicking on the respective top-level node in the folder list
and choosing <gui>Properties</gui>.</p>
<p>The following settings are available when editing an existing account:</p>
-<section id="identity">
-<title>Identity</title>
-<!-- TODO:XINCLUDE: Quite ugly to copy this text into all account type's, but it's not really worth a
separate topic page for it, plus it would make the intro-first-run.page even more complex. Maybe later
replace this text by a single instance by doing some content sharing with xinclude and xpointer in the other
mail-account-manage-*.page files and in intro-first-run.page. <include href="foo.xml"
xmlns="http://www.w3.org/2001/XInclude"/> See gnome-user-docs module for example usage. Also see
https://bugzilla.gnome.org/show_bug.cgi?id=638866 -->
-<p>Here you define your name and your email address.</p>
-<p>Optionally you can make this account your default account (e.g. when writing emails), set a Reply-To
email address (if you want replies to messages sent to a different address), and set an organization (the
company where you work, or the organization you represent when you send email from this account).</p>
-</section>
+<!-- As the "Identity" section is identical in all account pages, it is centrally in one file included
+via XInclude. See +http://blogs.gnome.org/shaunm/2011/07/21/understanding-xinclude/ for how it works. -->
+<include href="xinclude-mail-account-identity.xml"
+ xpointer="xmlns(mal=http://projectmallard.org/1.0/)xpointer(/mal:info/mal:section)"
+ xmlns="http://www.w3.org/2001/XInclude"/>
<section id="receiving-email">
<title>Receiving Email and Receiving options</title>
diff --git a/help/C/mail-account-manage-local-delivery.page b/help/C/mail-account-manage-local-delivery.page
index 22ac417..a1739ed 100644
--- a/help/C/mail-account-manage-local-delivery.page
+++ b/help/C/mail-account-manage-local-delivery.page
@@ -25,12 +25,11 @@
<p>Mail accounts can be edited via <guiseq><gui>Edit</gui><gui>Preferences</gui><gui>Mail Accounts</gui><gui
style="button">Edit</gui></guiseq>.</p>
<p>The following settings are available when editing an existing account:</p>
-<section id="identity">
-<title>Identity</title>
-<!-- TODO:XINCLUDE: Quite ugly to copy this text into all account type's, but it's not really worth a
separate topic page for it, plus it would make the intro-first-run.page even more complex. Maybe later
replace this text by a single instance by doing some content sharing with xinclude and xpointer in the other
mail-account-manage-*.page files and in intro-first-run.page. <include href="foo.xml"
xmlns="http://www.w3.org/2001/XInclude"/> See gnome-user-docs module for example usage. Also see
https://bugzilla.gnome.org/show_bug.cgi?id=638866 -->
-<p>Here you define your name and your email address.</p>
-<p>Optionally you can make this account your default account (e.g. when writing emails), set a Reply-To
email address (if you want replies to messages sent to a different address), and set an organization (the
company where you work, or the organization you represent when you send email from this account).</p>
-</section>
+<!-- As the "Identity" section is identical in all account pages, it is centrally in one file included
+via XInclude. See +http://blogs.gnome.org/shaunm/2011/07/21/understanding-xinclude/ for how it works. -->
+<include href="xinclude-mail-account-identity.xml"
+ xpointer="xmlns(mal=http://projectmallard.org/1.0/)xpointer(/mal:info/mal:section)"
+ xmlns="http://www.w3.org/2001/XInclude"/>
<section id="receiving-email">
<title>Receiving Email and Receiving options</title>
diff --git a/help/C/mail-account-manage-maildir-format-directories.page
b/help/C/mail-account-manage-maildir-format-directories.page
index 71dfe14..f1382d2 100644
--- a/help/C/mail-account-manage-maildir-format-directories.page
+++ b/help/C/mail-account-manage-maildir-format-directories.page
@@ -25,12 +25,11 @@
<p>Mail accounts can be edited via <guiseq><gui>Edit</gui><gui>Preferences</gui><gui>Mail Accounts</gui><gui
style="button">Edit</gui></guiseq>.</p>
<p>The following settings are available when editing an existing account:</p>
-<section id="identity">
-<title>Identity</title>
-<!-- TODO:XINCLUDE: Quite ugly to copy this text into all account type's, but it's not really worth a
separate topic page for it, plus it would make the intro-first-run.page even more complex. Maybe later
replace this text by a single instance by doing some content sharing with xinclude and xpointer in the other
mail-account-manage-*.page files and in intro-first-run.page. <include href="foo.xml"
xmlns="http://www.w3.org/2001/XInclude"/> See gnome-user-docs module for example usage. Also see
https://bugzilla.gnome.org/show_bug.cgi?id=638866 -->
-<p>Here you define your name and your email address.</p>
-<p>Optionally you can make this account your default account (e.g. when writing emails), set a Reply-To
email address (if you want replies to messages sent to a different address), and set an organization (the
company where you work, or the organization you represent when you send email from this account).</p>
-</section>
+<!-- As the "Identity" section is identical in all account pages, it is centrally in one file included
+via XInclude. See +http://blogs.gnome.org/shaunm/2011/07/21/understanding-xinclude/ for how it works. -->
+<include href="xinclude-mail-account-identity.xml"
+ xpointer="xmlns(mal=http://projectmallard.org/1.0/)xpointer(/mal:info/mal:section)"
+ xmlns="http://www.w3.org/2001/XInclude"/>
<section id="receiving-email">
<title>Receiving Email and Receiving options</title>
diff --git a/help/C/mail-account-manage-mh-format-directories.page
b/help/C/mail-account-manage-mh-format-directories.page
index 0f184e9..9662ea6 100644
--- a/help/C/mail-account-manage-mh-format-directories.page
+++ b/help/C/mail-account-manage-mh-format-directories.page
@@ -25,12 +25,11 @@
<p>Mail accounts can be edited via <guiseq><gui>Edit</gui><gui>Preferences</gui><gui>Mail Accounts</gui><gui
style="button">Edit</gui></guiseq>.</p>
<p>The following settings are available when editing an existing account:</p>
-<section id="identity">
-<title>Identity</title>
-<!-- TODO:XINCLUDE: Quite ugly to copy this text into all account type's, but it's not really worth a
separate topic page for it, plus it would make the intro-first-run.page even more complex. Maybe later
replace this text by a single instance by doing some content sharing with xinclude and xpointer in the other
mail-account-manage-*.page files and in intro-first-run.page. <include href="foo.xml"
xmlns="http://www.w3.org/2001/XInclude"/> See gnome-user-docs module for example usage. Also see
https://bugzilla.gnome.org/show_bug.cgi?id=638866 -->
-<p>Here you define your name and your email address.</p>
-<p>Optionally you can make this account your default account (e.g. when writing emails), set a Reply-To
email address (if you want replies to messages sent to a different address), and set an organization (the
company where you work, or the organization you represent when you send email from this account).</p>
-</section>
+<!-- As the "Identity" section is identical in all account pages, it is centrally in one file included
+via XInclude. See +http://blogs.gnome.org/shaunm/2011/07/21/understanding-xinclude/ for how it works. -->
+<include href="xinclude-mail-account-identity.xml"
+ xpointer="xmlns(mal=http://projectmallard.org/1.0/)xpointer(/mal:info/mal:section)"
+ xmlns="http://www.w3.org/2001/XInclude"/>
<section id="receiving-email">
<title>Receiving Email and Receiving options</title>
diff --git a/help/C/mail-account-manage-microsoft-exchange-evo-ews.page
b/help/C/mail-account-manage-microsoft-exchange-evo-ews.page
index 963285b..c1c4f59 100644
--- a/help/C/mail-account-manage-microsoft-exchange-evo-ews.page
+++ b/help/C/mail-account-manage-microsoft-exchange-evo-ews.page
@@ -21,17 +21,15 @@
<section id="account-editor">
<title>Account Editor</title>
-
<p>Mail accounts can be added by choosing <guiseq><gui>File</gui><gui>New</gui><gui>Mail
Account</gui></guiseq> or via <guiseq><gui>Edit</gui><gui>Preferences</gui><gui>Mail Accounts</gui><gui
style="button">Add</gui></guiseq>. The steps are mostly the same as for the <link
xref="intro-first-run">First-Run Assistant</link>, except for not getting asked whether to import data from
other applications or to restore from a backup file.</p>
<p>Mail accounts can be edited via <guiseq><gui>Edit</gui><gui>Preferences</gui><gui>Mail Accounts</gui><gui
style="button">Edit</gui></guiseq> or by right-clicking on the respective top-level node in the folder list
and choosing <gui>Properties</gui>.</p>
<p>The following settings are available when editing an existing account:</p>
-<section id="identity">
-<title>Identity</title>
-<!-- TODO:XINCLUDE: Quite ugly to copy this text into all account type's, but it's not really worth a
separate topic page for it, plus it would make the intro-first-run.page even more complex. Maybe later
replace this text by a single instance by doing some content sharing with xinclude and xpointer in the other
mail-account-manage-*.page files and in intro-first-run.page. <include href="foo.xml"
xmlns="http://www.w3.org/2001/XInclude"/> See gnome-user-docs module for example usage. Also see
https://bugzilla.gnome.org/show_bug.cgi?id=638866 -->
-<p>Here you define your name and your email address.</p>
-<p>Optionally you can make this account your default account (e.g. when writing emails), set a Reply-To
email address (if you want replies to messages sent to a different address), and set an organization (the
company where you work, or the organization you represent when you send email from this account).</p>
-</section>
+<!-- As the "Identity" section is identical in all account pages, it is centrally in one file included
+via XInclude. See +http://blogs.gnome.org/shaunm/2011/07/21/understanding-xinclude/ for how it works. -->
+<include href="xinclude-mail-account-identity.xml"
+ xpointer="xmlns(mal=http://projectmallard.org/1.0/)xpointer(/mal:info/mal:section)"
+ xmlns="http://www.w3.org/2001/XInclude"/>
<section id="receiving-email">
<title>Receiving Email and Receiving options</title>
diff --git a/help/C/mail-account-manage-microsoft-exchange-evo-mapi.page
b/help/C/mail-account-manage-microsoft-exchange-evo-mapi.page
index b7ad088..c4de5ab 100644
--- a/help/C/mail-account-manage-microsoft-exchange-evo-mapi.page
+++ b/help/C/mail-account-manage-microsoft-exchange-evo-mapi.page
@@ -21,17 +21,15 @@
<section id="account-editor">
<title>Account Editor</title>
-
<p>Mail accounts can be added by choosing <guiseq><gui>File</gui><gui>New</gui><gui>Mail
Account</gui></guiseq> or via <guiseq><gui>Edit</gui><gui>Preferences</gui><gui>Mail Accounts</gui><gui
style="button">Add</gui></guiseq>. The steps are mostly the same as for the <link
xref="intro-first-run">First-Run Assistant</link>, except for not getting asked whether to import data from
other applications or to restore from a backup file.</p>
<p>Mail accounts can be edited via <guiseq><gui>Edit</gui><gui>Preferences</gui><gui>Mail Accounts</gui><gui
style="button">Edit</gui></guiseq> or by right-clicking on the respective top-level node in the folder list
and choosing <gui>Properties</gui>.</p>
<p>The following settings are available when editing an existing account:</p>
-<section id="identity">
-<title>Identity</title>
-<!-- TODO:XINCLUDE: Quite ugly to copy this text into all account type's, but it's not really worth a
separate topic page for it, plus it would make the intro-first-run.page even more complex. Maybe later
replace this text by a single instance by doing some content sharing with xinclude and xpointer in the other
mail-account-manage-*.page files and in intro-first-run.page. <include href="foo.xml"
xmlns="http://www.w3.org/2001/XInclude"/> See gnome-user-docs module for example usage. Also see
https://bugzilla.gnome.org/show_bug.cgi?id=638866 -->
-<p>Here you define your name and your email address.</p>
-<p>Optionally you can make this account your default account (e.g. when writing emails), set a Reply-To
email address (if you want replies to messages sent to a different address), and set an organization (the
company where you work, or the organization you represent when you send email from this account).</p>
-</section>
+<!-- As the "Identity" section is identical in all account pages, it is centrally in one file included
+via XInclude. See +http://blogs.gnome.org/shaunm/2011/07/21/understanding-xinclude/ for how it works. -->
+<include href="xinclude-mail-account-identity.xml"
+ xpointer="xmlns(mal=http://projectmallard.org/1.0/)xpointer(/mal:info/mal:section)"
+ xmlns="http://www.w3.org/2001/XInclude"/>
<section id="receiving-email">
<title>Receiving Email and Receiving options</title>
diff --git a/help/C/mail-account-manage-pop.page b/help/C/mail-account-manage-pop.page
index 9264a1b..eab3101 100644
--- a/help/C/mail-account-manage-pop.page
+++ b/help/C/mail-account-manage-pop.page
@@ -25,12 +25,11 @@
<p>Mail accounts can be edited via <guiseq><gui>Edit</gui><gui>Preferences</gui><gui>Mail Accounts</gui><gui
style="button">Edit</gui></guiseq>.</p>
<p>The following settings are available when editing an existing account:</p>
-<section id="identity">
-<title>Identity</title>
-<!-- TODO:XINCLUDE: Quite ugly to copy this text into all account type's, but it's not really worth a
separate topic page for it, plus it would make the intro-first-run.page even more complex. Maybe later
replace this text by a single instance by doing some content sharing with xinclude and xpointer in the other
mail-account-manage-*.page files and in intro-first-run.page. <include href="foo.xml"
xmlns="http://www.w3.org/2001/XInclude"/> See gnome-user-docs module for example usage. Also see
https://bugzilla.gnome.org/show_bug.cgi?id=638866 -->
-<p>Here you define your name and your email address.</p>
-<p>Optionally you can make this account your default account (e.g. when writing emails), set a Reply-To
email address (if you want replies to messages sent to a different address), and set an organization (the
company where you work, or the organization you represent when you send email from this account).</p>
-</section>
+<!-- As the "Identity" section is identical in all account pages, it is centrally in one file included
+via XInclude. See +http://blogs.gnome.org/shaunm/2011/07/21/understanding-xinclude/ for how it works. -->
+<include href="xinclude-mail-account-identity.xml"
+ xpointer="xmlns(mal=http://projectmallard.org/1.0/)xpointer(/mal:info/mal:section)"
+ xmlns="http://www.w3.org/2001/XInclude"/>
<section id="receiving-email">
<title>Receiving Email and Receiving options</title>
diff --git a/help/C/mail-account-manage-unix-mbox-spool-directory.page
b/help/C/mail-account-manage-unix-mbox-spool-directory.page
index 31bf4bd..2792956 100644
--- a/help/C/mail-account-manage-unix-mbox-spool-directory.page
+++ b/help/C/mail-account-manage-unix-mbox-spool-directory.page
@@ -25,12 +25,11 @@
<p>Mail accounts can be edited via <guiseq><gui>Edit</gui><gui>Preferences</gui><gui>Mail Accounts</gui><gui
style="button">Edit</gui></guiseq>.</p>
<p>The following settings are available when editing an existing account:</p>
-<section id="identity">
-<title>Identity</title>
-<!-- TODO:XINCLUDE: Quite ugly to copy this text into all account type's, but it's not really worth a
separate topic page for it, plus it would make the intro-first-run.page even more complex. Maybe later
replace this text by a single instance by doing some content sharing with xinclude and xpointer in the other
mail-account-manage-*.page files and in intro-first-run.page. <include href="foo.xml"
xmlns="http://www.w3.org/2001/XInclude"/> See gnome-user-docs module for example usage. Also see
https://bugzilla.gnome.org/show_bug.cgi?id=638866 -->
-<p>Here you define your name and your email address.</p>
-<p>Optionally you can make this account your default account (e.g. when writing emails), set a Reply-To
email address (if you want replies to messages sent to a different address), and set an organization (the
company where you work, or the organization you represent when you send email from this account).</p>
-</section>
+<!-- As the "Identity" section is identical in all account pages, it is centrally in one file included
+via XInclude. See +http://blogs.gnome.org/shaunm/2011/07/21/understanding-xinclude/ for how it works. -->
+<include href="xinclude-mail-account-identity.xml"
+ xpointer="xmlns(mal=http://projectmallard.org/1.0/)xpointer(/mal:info/mal:section)"
+ xmlns="http://www.w3.org/2001/XInclude"/>
<section id="receiving-email">
<title>Receiving Email and Receiving options</title>
diff --git a/help/C/mail-account-manage-unix-mbox-spool-file.page
b/help/C/mail-account-manage-unix-mbox-spool-file.page
index 17ac7ec..3670d86 100644
--- a/help/C/mail-account-manage-unix-mbox-spool-file.page
+++ b/help/C/mail-account-manage-unix-mbox-spool-file.page
@@ -25,12 +25,11 @@
<p>Mail accounts can be edited via <guiseq><gui>Edit</gui><gui>Preferences</gui><gui>Mail Accounts</gui><gui
style="button">Edit</gui></guiseq>.</p>
<p>The following settings are available when editing an existing account:</p>
-<section id="identity">
-<title>Identity</title>
-<!-- TODO:XINCLUDE: Quite ugly to copy this text into all account type's, but it's not really worth a
separate topic page for it, plus it would make the intro-first-run.page even more complex. Maybe later
replace this text by a single instance by doing some content sharing with xinclude and xpointer in the other
mail-account-manage-*.page files and in intro-first-run.page. <include href="foo.xml"
xmlns="http://www.w3.org/2001/XInclude"/> See gnome-user-docs module for example usage. Also see
https://bugzilla.gnome.org/show_bug.cgi?id=638866 -->
-<p>Here you define your name and your email address.</p>
-<p>Optionally you can make this account your default account (e.g. when writing emails), set a Reply-To
email address (if you want replies to messages sent to a different address), and set an organization (the
company where you work, or the organization you represent when you send email from this account).</p>
-</section>
+<!-- As the "Identity" section is identical in all account pages, it is centrally in one file included
+via XInclude. See +http://blogs.gnome.org/shaunm/2011/07/21/understanding-xinclude/ for how it works. -->
+<include href="xinclude-mail-account-identity.xml"
+ xpointer="xmlns(mal=http://projectmallard.org/1.0/)xpointer(/mal:info/mal:section)"
+ xmlns="http://www.w3.org/2001/XInclude"/>
<section id="receiving-email">
<title>Receiving Email and Receiving options</title>
diff --git a/help/C/mail-account-manage-usenet-news.page b/help/C/mail-account-manage-usenet-news.page
index 632ab7e..702a9ab 100644
--- a/help/C/mail-account-manage-usenet-news.page
+++ b/help/C/mail-account-manage-usenet-news.page
@@ -25,12 +25,11 @@
<p>Mail accounts can be edited via <guiseq><gui>Edit</gui><gui>Preferences</gui><gui>Mail Accounts</gui><gui
style="button">Edit</gui></guiseq> or by right-clicking on the respective top-level node in the folder list
and choosing <gui>Properties</gui>.</p>
<p>The following settings are available when editing an existing account:</p>
-<section id="identity">
-<title>Identity</title>
-<!-- TODO:XINCLUDE: Quite ugly to copy this text into all account type's, but it's not really worth a
separate topic page for it, plus it would make the intro-first-run.page even more complex. Maybe later
replace this text by a single instance by doing some content sharing with xinclude and xpointer in the other
mail-account-manage-*.page files and in intro-first-run.page. <include href="foo.xml"
xmlns="http://www.w3.org/2001/XInclude"/> See gnome-user-docs module for example usage. Also see
https://bugzilla.gnome.org/show_bug.cgi?id=638866 -->
-<p>Here you define your name and your email address.</p>
-<p>Optionally you can make this account your default account (e.g. when writing emails), set a Reply-To
email address (if you want replies to messages sent to a different address), and set an organization (the
company where you work, or the organization you represent when you send email from this account).</p>
-</section>
+<!-- As the "Identity" section is identical in all account pages, it is centrally in one file included
+via XInclude. See +http://blogs.gnome.org/shaunm/2011/07/21/understanding-xinclude/ for how it works. -->
+<include href="xinclude-mail-account-identity.xml"
+ xpointer="xmlns(mal=http://projectmallard.org/1.0/)xpointer(/mal:info/mal:section)"
+ xmlns="http://www.w3.org/2001/XInclude"/>
<section id="receiving-email">
<title>Receiving Email and Receiving options</title>
diff --git a/help/C/xinclude-mail-account-identity.xml b/help/C/xinclude-mail-account-identity.xml
new file mode 100644
index 0000000..e1811e7
--- /dev/null
+++ b/help/C/xinclude-mail-account-identity.xml
@@ -0,0 +1,9 @@
+<info xmlns="http://projectmallard.org/1.0/">
+
+<section id="identity">
+<title>Identity</title>
+<p>Here you define your name and your email address.</p>
+<p>Optionally you can make this account your default account (e.g. when writing emails), set a Reply-To
email address (if you want replies to messages sent to a different address), and set an organization (the
company where you work, or the organization you represent when you send email from this account).</p>
+</section>
+
+</info>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]