On Sun, 2010-02-21 at 16:16 -0600, Shaun McCance wrote: > On Sun, 2010-02-21 at 15:39 +0000, Bruce Cowan wrote: > > Here's a patch that fixes a few grammar issues. I don't really know how > > Mallard works, so bear with me if I did anything incorrectly. > > > > I'd be happy to review any other documentation now, or in the future. > > Thanks Bruce. A lot of really good fixes in there. > A few comments: > > > - Activities are stored in an SQLite database, located > + Activities are stored in a SQLite database, located at > Whether to use "an" or "a" is tricky here, because there are > two common pronunciations of SQL. I tend to say "es que el", > and hence "es que el lite", so I would use "an". But if you > say "sequel" and "sequelite", then "a" is correct. (The "at", > of course, is a correct addition regardless.)
I'd say it as "es que el" as well, and I notice the SQLite website uses "an". > - News go here. > + News goes here. > Correct fix, but I wonder if we should just nix this section > until there's real content. I know I tell people to stub > early and often, but when we're preparing for releases, we > should start scrubbing the unfinished stubs. Yes, I just did that for completeness really. > + doing something else for the last seven minutes. Relative times work > + only without end times — that is — for the most recent activity. > A comma should follow "that is" in pretty much any case. As > for what should precede it, read a dozen different style guides > and you'll get two dozen different answers. Maybe we could just > recast the whole thing as "Relative times only work for ongoing > activity without an end time." I'd have used a comma looking at it again. However, the way you've phrased it is better, so I've used it. > + day. Start by entering the first activity and check the "in progress" > Style guide actually says never to use "check" as a verb, and > to use "select" instead. "and select <gui>in progress</gui> > for the end time" Ah right, I was a wee bit over-zealous in the en_US there, especially considering I'm Scottish. The review wasn't as thorough as it should have been, I rushed it a bit. Attached is an updated patch with all the changes, and some new ones. I'm not too sure about the "on the fly" bits still. -- Bruce Cowan <[email protected]>
>From 282ddb4624c163b89cfe55f267e954e01e46fb4e Mon Sep 17 00:00:00 2001 From: Bruce Cowan <[email protected]> Date: Sun, 21 Feb 2010 21:35:32 +0000 Subject: [PATCH] Grammar review of documentation --- help/C/backup.page | 4 ++-- help/C/index.page | 2 +- help/C/input.page | 24 ++++++++++++------------ help/C/merge.page | 12 ++++++------ help/C/reports.page | 12 ++++++------ help/C/statistics.page | 6 +++--- 6 files changed, 30 insertions(+), 30 deletions(-) diff --git a/help/C/backup.page b/help/C/backup.page index 95c8ad0..f292eb7 100644 --- a/help/C/backup.page +++ b/help/C/backup.page @@ -8,10 +8,10 @@ <title>Backup</title> <p> - Activities are stored in an SQLite database, located + Activities are stored in an SQLite database, located at <file>~/.local/share/hamster-applet/hamster.db</file>. The file can be backed up and restored on the go. - Application will reload the data automatically after a short while. + The application will reload the data automatically after a short while. </p> <note style="info"> <p> diff --git a/help/C/index.page b/help/C/index.page index 89e2ead..d332219 100644 --- a/help/C/index.page +++ b/help/C/index.page @@ -6,7 +6,7 @@ <section id="this-release"> <title>What's new in this release</title> <p> - News go here. + News goes here. </p> </section> diff --git a/help/C/input.page b/help/C/input.page index fceb32f..cf99437 100644 --- a/help/C/input.page +++ b/help/C/input.page @@ -8,45 +8,45 @@ <title>Input</title> <p> - To start tracking, type in activity name in the input box and hit + To start tracking, type in the activity name in the input box and hit the <key>Enter</key> key. - There are few tricks however, that will allow you to specify more detail on + There are a few tricks that will allow you to specify more detail on the fly: </p> <steps> - <item><p>Use @ symbol to add category</p></item> - <item><p>Everything after a comma "," will be stored in the description field</p></item> - <item><p>To specify time on the fly, enter it as first in the input box.</p></item> + <item><p>Use the @ symbol to add a category</p></item> + <item><p>Everything after a comma (,) will be stored in the description field</p></item> + <item><p>To specify time on the fly, enter it first in the input box</p></item> </steps> <p> - Few examples: + A few examples: </p> <example> <code>12:30-12:45 watering flowers</code> - <p>Forgot to note the important act of watering flowers over the lunch.</p> + <p>Forgot to note the important act of watering flowers over lunch.</p> </example> <example> <code>tomat...@garden, digging holes</code> <p> Need more tomatoes in the garden. Digging holes is purely informational, - so added it as a description + so added it as a description. </p> </example> <example> <code>-7 existentialism, thinking about the vastness of the universe</code> <p> Corrected information by informing application that I've been - onto something else for last seven minutes. Relative times work - only without end times - that is - for the most recent activity. + doing something else for the last seven minutes. Relative times only + work for ongoing activities without an end time. </p> </example> <p> On top of that you can add tags in the tag input field. - Tags are delimited by comma. Hitting <key>Tab</key> when the suggestion - box shows up, will complete input to the first matching tag. + Tags are delimited by a comma. Press the <key>Tab</key> when the suggestion + box appears to complete the input to the first matching tag. </p> </page> diff --git a/help/C/merge.page b/help/C/merge.page index c309b28..6d1a7ed 100644 --- a/help/C/merge.page +++ b/help/C/merge.page @@ -8,18 +8,18 @@ <title>Splitting activities</title> <p> - <app>Time Tracker</app> does it's best to avoid overlaps in the activities. - If you create an activity in the middle of an existing activity. The former - will be split into two. In other cases of overlapping - the previous entries + <app>Time Tracker</app> does its best to avoid overlaps in activities. + If you create an activity in the middle of an existing activity, the former + will be split into two. In other cases of overlapping, the previous entries will be shrunk. </p> <note style="info"> <p> - Merging aspect can come handy when entering information for the whole - day. Start by entering the first activity and tick the "in progress" + Merging can become handy when entering information for the whole + day. Start by entering the first activity and select the "in progress" check box for the end time. For the next activity again set just the start time and mark it as ongoing. Observe how the end time of the - previous activity get's adjusted to the start time of the new one. + previous activity gets adjusted to the start time of the new one. Repeat the process until happy! </p> </note> diff --git a/help/C/reports.page b/help/C/reports.page index 19eaf0f..098d65c 100644 --- a/help/C/reports.page +++ b/help/C/reports.page @@ -3,14 +3,14 @@ id="reports"> <info> <link type="guide" xref="index"/> - <desc>Get data out of Time Tracker</desc> + <desc>Get data out of Time Tracker.</desc> </info> <title>Report and export</title> <p> Apart from the HTML format that is offered by default in the Save report - dialog, format drop-down allows to choose TSV (Tab Separated Values, good for - spreadsheets), XML and iCal formats. + dialog, the format drop-down allows you to choose TSV (Tab Separated Values, good for + spreadsheets), XML, and iCal formats. </p> <p> For programmatic access, there is D-Bus API, that can be introspected @@ -19,9 +19,9 @@ <note style="info"> <p> - The really fastest way to get the data "out" of the Time Tracker, is by generatic the - HTML report, while holding the <key>Ctrl</key> key down, select all the - needed cells, and then copy/pasting them in the target application. + The fastest way to get the data "out" of the Time Tracker is by generating a + HTML report. While holding the <key>Ctrl</key> key down, select all the + needed cells, and then copy and paste them into the target application. </p> </note> </page> diff --git a/help/C/statistics.page b/help/C/statistics.page index 582a9bb..ee897f6 100644 --- a/help/C/statistics.page +++ b/help/C/statistics.page @@ -3,14 +3,14 @@ id="statistics"> <info> <link type="guide" xref="index"/> - <desc>Word on interpretation of statistics.</desc> + <desc>Note on interpretation of statistics.</desc> </info> <title>Statistics</title> <p> - The results, that are accessible, via the + The results that are accessible via the <gui style="button">Show Statistics</gui> link are experimental and - they are interpretation of the facts. Interpretation that should be compared + they are an interpretation of the facts. This interpretation should be compared with your own observations. Patches are welcome. </p> <p> -- 1.7.0
_______________________________________________ gnome-doc-list mailing list [email protected] http://mail.gnome.org/mailman/listinfo/gnome-doc-list
