Merge lp:~jwcampbell/deja-dup/deja-dup-doc-updates into lp:deja-dup/28

[Jim Campbell]

Some trivial fixes to the Deja Dup documentation. Most of the fixes are related to style, but I did fix a validation error on credits.page, as well as a few minor typos.

[Michael Terry (mterry)]

Thanks so much for the fixes!

A) I don't like the change from "Backup Help" to icon / "Deja Dup Backup Tool". The icon isn't well-aligned and I'd prefer to not use the deja dup name quite so prominently.

B) I don't notice the effect of the style="tip" or style="task" changes. Is it a subtle change or something that my theme might not be doing?

C) For Alternatively->Alternately, I think Alternatively actually makes more sense. See http://www.wordnik.com/words/alternately vs http://www.wordnik.com/words/alternatively

D) Why do you prefer "regularly" to be after the verb rather than in front?

E) Good catch on "services costs" and the missing id= attributes.

review: Needs Fixing

[lp:~jwcampbell/deja-dup/deja-dup-doc-updates]

1459. By Jim Campbell on 2013-07-17

docs: increased size of deja-dup icon. changed title back to 'backup help'. changed 'alternately' back to 'alternatively'

[Jim Campbell (jwcampbell)]

Hi Michael,

Here are my notes based on your prior comments:

A) I don't like the change from "Backup Help" to icon / "Deja Dup Backup Tool". The icon isn't well-aligned and I'd prefer to not use the deja dup name quite so prominently.

-- I've changed this back.

B) I don't notice the effect of the style="tip" or style="task" changes. Is it a subtle change or something that my theme might not be doing?

-- It's a bit hard to explain in writing, but when the 'style="tip"' or other style attribute is missing, it looks as if an image in the "favicon" area of yelp tried to load, but couldn't. It isn't a big deal, but I just think it looks a bit better to use the style attribute.

C) For Alternatively->Alternately, I think Alternatively actually makes more sense. See http://www.wordnik.com/words/alternately vs http://www.wordnik.com/words/alternatively

-- I've reverted this change.

D) Why do you prefer "regularly" to be after the verb rather than in front?

-- Thanks for asking. Per this page [0], including the adverb at the end of the sentence makes it stronger. Given that we're encouraging people to back up more frequently, I thought it gave it a little more oomph to put "reguarly" at the end. (Both approaches are technically fine, though).

E) Good catch on "services costs" and the missing id= attributes.

-- : )

==========
One other thing I noticed was that the docs don't break the line at 79 characters, and this makes diffs hard to read in Launchpad (and in other diff-related tools). With GNOME docs, we prefer to break the lines at 79 chars where possible just because it makes diffs easier to read. I wanted to hold off on making that change until I got an OK from you, though.

If it's ok with you, I'll make the change to each of the doc pages (breaking the lines at 79 chars where I can) w/o making any other textual changes. Let me know what you think.

[0] http://www.perfect-english-grammar.com/adverbs-of-frequency.html

[Michael Terry (mterry)]

100 + <title type="link">Backup Help</title>
101 + <title type="text">Backup Help</title>

This is duplicated, I assume accidentally.

111 + <media type="image" mime="image/png" src="figures/deja-dup-icon.png">
112 + </media>

This doesn't seem well-centered in my tests. Plus, none of the other GNOME apps seem to use an icon. I'm inclined to drop this change.

[Jim Campbell (jwcampbell)]

> 100 + <title type="link">Backup Help</title>
> 101 + <title type="text">Backup Help</title>
>
> This is duplicated, I assume accidentally.

The repetition is intentional. See here for further information: http://projectmallard.org/1.0/mal_info_title

This approach is used in gnome-user-docs, gedit, file-roller, the draft seahorse help, and other gnome help.

>
> 111 + <media type="image" mime="image/png" src="figures/deja-dup-
> icon.png">
> 112 + </media>
>
> This doesn't seem well-centered in my tests. Plus, none of the other GNOME
> apps seem to use an icon. I'm inclined to drop this change.

I'm using the same approach as used in gedit, gnome-help, ubuntu help, seahorse (aka passwords and keys), gnome-terminal, and the other gnome applications will be getting their appropriate icon in this manner in the near future. I see what you mean about it not lining up exactly right - not sure what I can do about it, as the alignment is handled by the yelp stylesheets.

Thanks for being so thorough in your review. Let me know if you have other fixes you'd like me to make.

[Jim Campbell (jwcampbell)]

If you'd prefer, I can resubmit without the icon. You had just noted that you were inclined to drop this change, so I am not sure if you meant the entire changeset I submitted, or just the icon.

Here is more information on use of multiple title links: http://projectmallard.org/pipermail/mallard-list/2013-July/000167.html

Cheers

[Michael Terry (mterry)]

Sorry this took me so long. :(

Approved, thanks for your work and putting up with my changes and delays!

review: Approve

=== modified file 'help/C/backup-auto.page'
--- help/C/backup-auto.page	2011-08-28 00:50:59 +0000
+++ help/C/backup-auto.page	2013-07-17 21:23:25 +0000
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <page xmlns="http://projectmallard.org/1.0/"
-      type="topic"
+      type="topic" style="task"
       id="backup-auto">
 <info>
   <desc>Give yourself peace of mind</desc>

=== modified file 'help/C/backup-first.page'
--- help/C/backup-first.page	2011-05-06 21:59:19 +0000
+++ help/C/backup-first.page	2013-07-17 21:23:25 +0000
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <page xmlns="http://projectmallard.org/1.0/"
-      type="topic"
+      type="topic" style="task"
       id="backup-first">
 <info>
   <desc>Start now</desc>

=== modified file 'help/C/contribute.page'
--- help/C/contribute.page	2011-06-13 18:55:47 +0000
+++ help/C/contribute.page	2013-07-17 21:23:25 +0000
@@ -2,7 +2,7 @@
 <page xmlns="http://projectmallard.org/1.0/"
       xmlns:its="http://www.w3.org/2005/11/its"
       its:version="1.0"
-      type="topic"
+      type="topic"  style="task"
       id="contribute">
 <info>
   <desc>Help make <app>Déjà Dup</app> better</desc>

=== modified file 'help/C/credits.page'
--- help/C/credits.page	2011-06-28 13:36:58 +0000
+++ help/C/credits.page	2013-07-17 21:23:25 +0000
@@ -2,7 +2,7 @@
 <page xmlns="http://projectmallard.org/1.0/"
       xmlns:its="http://www.w3.org/2005/11/its"
       its:version="1.0"
-      type="topic"
+      type="topic" style="tip"
       id="credits">
 <info>
   <desc>Meet the team</desc>
@@ -10,7 +10,7 @@
 </info>
 <title>Credits</title>
 
-<section>
+<section id="development-credits">
 <title>Development</title>
 <list>
 <item its:translate="no"><p><link href="mailto:[e-mail]">Andrew Fister</link></p></item>
@@ -21,7 +21,7 @@
 </list>
 </section>
 
-<section>
+<section id="documentation-credits">
 <title>Documentation</title>
 <list>
 <item its:translate="no"><p><link href="mailto:[e-mail]">Michael Terry</link></p></item>
@@ -29,7 +29,7 @@
 </list>
 </section>
 
-<section>
+<section id="art-credits">
 <title>Art</title>
 <list>
 <item its:translate="no"><p><link href="mailto:[e-mail]">Andreas Nilsson</link></p></item>
@@ -39,7 +39,7 @@
 </list>
 </section>
 
-<section>
+<section id="translation-credits">
 <title>Translation</title>
 <code>translator-credits</code>
 </section>

=== added directory 'help/C/figures'
=== added file 'help/C/figures/deja-dup-icon.png'
Binary files help/C/figures/deja-dup-icon.png	1970-01-01 00:00:00 +0000 and help/C/figures/deja-dup-icon.png	2013-07-17 21:23:25 +0000 differ
=== modified file 'help/C/index.page'
--- help/C/index.page	2011-04-21 09:30:07 +0000
+++ help/C/index.page	2013-07-17 21:23:25 +0000
@@ -3,8 +3,11 @@
       xmlns:its="http://www.w3.org/2005/11/its"
       its:version="1.0"
       type="guide"
+      style="2column task"
       id="index">
 <info>
+  <title type="link">Backup Help</title>
+    <title type="text">Backup Help</title>
   <credit type="author maintainer" its:translate="no">
     <name>Michael Terry</name>
     <email>[e-mail]</email>
@@ -13,7 +16,11 @@
   <license href="http://creativecommons.org/licenses/by-sa/3.0/"><p>Creative Commons Attribution-Share Alike 3.0 Unported License</p></license>
 </info>
 
-<title>Backup Help</title>
+  <title>
+    <media type="image" mime="image/png" src="figures/deja-dup-icon.png">
+    </media>
+    Backup Help
+  </title>
 
 <section id="backup" style="2column">
   <title>Backing Up</title>

=== modified file 'help/C/license.page'
--- help/C/license.page	2011-04-30 02:37:05 +0000
+++ help/C/license.page	2013-07-17 21:23:25 +0000
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <page xmlns="http://projectmallard.org/1.0/"
-      type="topic"
+      type="topic" style="tip"
       id="license">
 <info>
   <desc>Know your rights</desc>

=== modified file 'help/C/prefs.page'
--- help/C/prefs.page	2013-02-05 15:55:29 +0000
+++ help/C/prefs.page	2013-07-17 21:23:25 +0000
@@ -1,7 +1,7 @@
 <page xmlns="http://projectmallard.org/1.0/"
       xmlns:its="http://www.w3.org/2005/11/its"
       its:version="1.0"
-      type="topic"
+      type="topic" style="task"
       id="prefs">
 <info>
   <desc>Adjust your backup settings</desc>
@@ -11,7 +11,7 @@
   <terms>
     <item>
       <title><gui>Automatic backups</gui></title>
-      <p>Turn this option on to have <app>Déjà Dup</app> automatically back up for you. This is recommended so that you don’t forget to do it yourself. Backups are more useful the more recent they are, so it is important to regularly back up.</p>
+      <p>Turn this option on to have <app>Déjà Dup</app> automatically back up for you. This is recommended so that you don’t forget to do it yourself. Backups are more useful the more recent they are, so it is important to back up regularly.</p>
     </item>
     <item>
       <title><gui>Backup location</gui></title>
@@ -20,7 +20,7 @@
         <item>
           <title>Cloud Services</title>
           <p>The first few backup locations are cloud storage services provided by various companies. For a small fee, they hold your data for you. A cloud service like this is recommended because it is an easy way to keep your data offsite (meaning out of your home: in case of disaster or theft, your data will still be safe).</p>
-          <note style="warning"><p>These services costs money.  Read their rates carefully before using them.</p></note>
+          <note style="warning"><p>These services cost money.  Read their rates carefully before using them.</p></note>
         </item>
         <item>
           <title>Remote Servers</title>

=== modified file 'help/C/restore-full.page'
--- help/C/restore-full.page	2011-07-22 13:15:59 +0000
+++ help/C/restore-full.page	2013-07-17 21:23:25 +0000
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <page xmlns="http://projectmallard.org/1.0/"
-      type="topic"
+      type="topic" style="task"
       id="restore-full">
 <info>
   <desc>Recover from total system failure</desc>

=== modified file 'help/C/restore-lost.page'
--- help/C/restore-lost.page	2011-07-22 13:15:59 +0000
+++ help/C/restore-lost.page	2013-07-17 21:23:25 +0000
@@ -2,7 +2,7 @@
 <page xmlns="http://projectmallard.org/1.0/"
       xmlns:its="http://www.w3.org/2005/11/its"
       its:version="1.0"
-      type="topic"
+      type="topic" style="task"
       id="restore-lost">
 <info>
   <desc>Restore a file that is no longer present</desc>

=== modified file 'help/C/restore-revert.page'
--- help/C/restore-revert.page	2011-08-15 18:21:37 +0000
+++ help/C/restore-revert.page	2013-07-17 21:23:25 +0000
@@ -2,7 +2,7 @@
 <page xmlns="http://projectmallard.org/1.0/"
       xmlns:its="http://www.w3.org/2005/11/its"
       its:version="1.0"
-      type="topic"
+      type="topic" style="task"
       id="restore-revert">
 <info>
   <desc>Restore a previous version of a file</desc>

=== modified file 'help/C/restore-worst-case.page'
--- help/C/restore-worst-case.page	2011-06-28 13:36:58 +0000
+++ help/C/restore-worst-case.page	2013-07-17 21:23:25 +0000
@@ -2,7 +2,7 @@
 <page xmlns="http://projectmallard.org/1.0/"
       xmlns:its="http://www.w3.org/2005/11/its"
       its:version="1.0"
-      type="topic"
+      type="topic" style="task"
       id="restore-worst-case">
 <info>
   <desc>What to do if you can’t restore your files</desc>

=== modified file 'help/C/support.page'
--- help/C/support.page	2011-05-06 21:59:19 +0000
+++ help/C/support.page	2013-07-17 21:23:25 +0000
@@ -2,7 +2,7 @@
 <page xmlns="http://projectmallard.org/1.0/"
       xmlns:its="http://www.w3.org/2005/11/its"
       its:version="1.0"
-      type="topic"
+      type="topic" style="tip"
       id="support">
 <info>
   <desc>Get more help</desc>