Commit graph

175 commits

Author SHA1 Message Date
Tim Wootton
cad0d45fe1 Splits long lines in manual
This allows patches to be read more easily
This prevents the lines longer than 998 error in git send-email
Breaks lines at somewhere near 80 chars where possible

Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-19 07:23:11 -08:00
Tim Wootton
ecc33e6375 Adds unhide to profile menu context menu
Unhide menu is only shown when hidden events exist.
Also updates relavent manual section.

Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-18 14:07:41 -08:00
Willem Ferguson
43385eb31a The info icon of the manual got mislaid somewhere
Here it is.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-16 09:46:18 -08:00
Dirk Hohndel
e87fba995b User manual: new banner image
This reflects the Qt version (and again matches the one on the web site).

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-15 06:46:41 -08:00
Tim Wootton
cd0a90014d Doc, and 1 more typo
Also added line-break as I ran into:

"patch contains a line longer than 998 characters
warning: no patches were sent"

so that shouldn't happen next time.

cheers,

Tim

From afb5fdfa2eff86ab2913e8f2a6f195c0cee3c13e Mon Sep 17 00:00:00 2001
From: Tim Wootton <tim@tee-jay.demon.co.uk>
Date: Sat, 14 Dec 2013 00:31:12 +0000
Subject: [PATCH] Doc, and 1 more typo

Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-13 17:12:59 -08:00
Tim Wootton
d16398d752 User manual: correct various typos and spellings
1) Corrects various typos and spellings
2) Standardises on infrared over infra-red (both were found)
3) Standrdises on colour over color (both were found) as most
   of the manual seems to use UK English spelling

Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-13 17:10:00 -08:00
Tim Wootton
70b2359a42 User manual: sync divenotes & equipment sections
Brings the changes that were made to Dive Notes and Equipment
under the Manual Entry section into the Imported from DC section
was well, while preserving the imported from DC specific stuff.

Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-13 15:10:10 -08:00
Tim Wootton
f9c0fd7f32 User manual: shortcut keys also depend on language
Notes dependancy of shortcut keys on language as well as OS.
Writes Operating System in full not abbr.
More fully describes how to spot a shortcut key in the menu

Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-13 15:09:50 -08:00
Tim Wootton
efa01dc94c User manual: Add space after punctuation
Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-13 15:07:59 -08:00
Willem Ferguson
c5e51e845c Usermanual final edit before Version 4.0
1) Many typos and lexical problems improved or corrected
2) Information for Heinrichs Weikamp DR5 moved to Appendix B
3) Small changes to images.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-13 13:02:42 -08:00
Sergey Starosek
7752e598c6 Fix broken image link
Rename .kpg -> .jpg

Signed-off-by: Sergey Starosek <sergey.starosek@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-12 13:10:48 -08:00
Dirk Hohndel
b3f800d9fb User manual: small fixes
Once again use 'selected' and 'highlighted' consistently.
Use the correct units for the vertical speed during a dive. 30 m/s would
be more than just red :-)

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-12 19:53:55 +01:00
Dirk Hohndel
586c7fbd90 User manual: update importing dive log data from other software
Minor changes and slight reorganization.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-12 19:38:47 +01:00
Dirk Hohndel
deead2a613 User manual: update the section on importing data from dive computer
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-12 19:03:18 +01:00
Dirk Hohndel
c698218ca3 User manual: updates of the initial sections on manual data entry
Also changed the term :weighting system" to "weight system".

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-12 18:53:10 +01:00
Dirk Hohndel
4ed4a32a5f User manual: consistently use second person to address the user
We kept switching between the somewhat impersonal 'one' and the much more
friendly 'you' to address the user. This commit changed all occurances
that I found to 'you' and adjusted the grammar around it.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-12 18:15:42 +01:00
Dirk Hohndel
1476ca6ccd User manual: minor changes to the Start Using the Program section
Be more precise with selected dive vs. highlighted dives.
Avoid some redundancy.
Mention shortcut keys.
Discuss the different locations of the Main Menu and the fact that the
screen shots were taken on a Ubuntu system.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-12 18:15:39 +01:00
Dirk Hohndel
f970aacf37 User manual: slightly reword the introduction
we should focus on the typical user, so start with platforms that we have
binaries for

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-12 18:15:35 +01:00
Dirk Hohndel
b87cfa9666 User manual: complete the language preference section
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-12 03:17:34 +01:00
Tim Wootton
4d7e6430e8 User manual: add stub for Language Preferences
Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-12 03:13:38 +01:00
Tim Wootton
415e8bd877 User manual: Add section about Profile Pane context menu
Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-12 03:13:37 +01:00
Tim Wootton
0f23e3f04c User manual: correct typo in Uemis Zurich section
Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-12 03:13:22 +01:00
Tim Wootton
ea895fbecc User manual: Fixes one broken italics
Italics marker needed to come after the 's to work properly

Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-11 16:27:52 +01:00
Tim Wootton
17e53b4d8e User manual: added troughs to peaks in profile description
Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-11 16:27:41 +01:00
Tim Wootton
a16a245e58 User manual: remove ter from below Stats Tab section
Found the word "ter" below this para, assume it's not
supposed to be there.

Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-11 16:27:29 +01:00
Tim Wootton
edfa3ba810 User manual: use charge rather than load when referring to battery
Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-10 22:39:41 +01:00
Tim Wootton
aa34ca814d User manual: remove imperative not to save
It's ok to save as you go, just not required.

Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-10 22:38:46 +01:00
Willem Ferguson
52a168d7ff Manual update
Replaced graphics for Import from Divelogs.de to reflect latest UI schanges.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-10 14:38:58 +01:00
Sergey Starosek
12981030a5 Fix asciidoc CSS path
Both JS and CSS resources need to be embedded into HTML

Signed-off-by: Sergey Starosek <sergey.starosek@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-10 14:38:45 +01:00
Willem Ferguson
9545745c90 Usermanual update
- Print divelog added
- Typos corrected.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-10 10:15:30 +01:00
Tim Wootton
85fd75ad51 Remove possible dual meaning in Divemaster and Buddy.
Pedantic Tim says "Barring waterproof device, most of us won't
be entering these fields during the dive." ;-)

Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-09 22:44:58 +01:00
Tim Wootton
afe065744f Removes imperative to not save-as-you-go.
Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-09 22:44:25 +01:00
Willem Ferguson
8b74ffc35b Updated user manual
1) Added Main Menu items description
2) Added Divelogs.de description
3) Removed paragraph defining EAD & END
4) Several typos corrected
5) Positions of several figures standardised to align="central"

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-09 21:38:16 +01:00
Dirk Hohndel
4675ab0617 Fix possible compatibility issue with asciidoc
Apparently some version os asciidoc don't support the --theme option.
Work around this by using -a theme='theme' instead.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-09 16:12:36 +01:00
Willem Ferguson
9156bd0efb Missing images for the manual
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-09 16:05:51 +01:00
Willem Ferguson
3a49ad6ba5 Update to manual
- Companion app added
- Figures updated & reorganised
- Small amount of reorganisation of text
- Typos corrected

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-09 13:54:11 +01:00
Tim Wootton
e7a657c72b Removes unnecessary references to number of elements in
the date field

Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-09 10:14:50 +01:00
Tim Wootton
2f3d18d001 Updates main menu entries
Updates summary of main menu entries to those in the new GUI

Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-09 10:14:43 +01:00
Tim Wootton
21e14933ac Replaced writing email to, with sending an email to
Seems to read better as "sending an email to"

Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-09 10:14:27 +01:00
Salvador Cuñat
f84e4ef4ee Clarification on EAD and END meaning in Subsurface
As pointed out in commit 23ce727 by Dirk and remembered Jan, there are different
meanings for EAD and END depending on organisations.  Let's explain a bit the one
Subsurface has choosen,  as this is confusing, even while translating the acronyms.

Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-08 16:14:17 +01:00
Willem Ferguson
d84f397790 Add compact style to the Documentation
The Makefile changes were authored by Dirk, the CSS is based on a public
domain CSS file and authored by Willem

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-08 07:50:34 +01:00
Werner Macho
939aafa73f Fixing a few typos in Documentation
Signed-off-by: Werner Macho <werner.macho@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-07 07:23:45 -08:00
Dirk Hohndel
32264cf393 Explain invalid dive option in preferences
Just trying to fill in minor gaps.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-06 11:53:01 -08:00
Dirk Hohndel
157827c71b Capitalize Subsurface in the documentation
This is a small detail but we should try to be consistent there.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-06 11:50:35 -08:00
Willem Ferguson
710fba9aa6 Add images missing from previous commit
This was Dirk's mistake when applying the patch.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-06 11:44:14 -08:00
Willem Ferguson
75e8b1eeff Usermanual update.
1) Several layout changes including banner.
2) Stylistic revision of part of textr.
3) Addition of text to dive computer upload section.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-06 10:59:55 -08:00
Salvador Cuñat
c7a4bb185c Companion app and downloading GPS coordinates from web service
A first try on documenting the companion app and explanation on how to use
it combined with Subsurface.

Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-06 09:22:13 -08:00
Willem Ferguson
fb169db292 Updates to user manual
1) Inserted section on Information Box on dive profile
2) Iserted short section on import from Mares Dive Organiser
3) Corrections to spelling and style not included in previous commits.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-05 14:11:17 -08:00
Sergey Starosek
fe713d37f4 User manual spelling fixes
Signed-off-by: Sergey Starosek <sergey.starosek@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-05 07:31:07 -08:00
Willem Ferguson
07c63c511b subsurface user manual update
References to literature on gradient factors changed (see dive profile
section, also preferences section)

Section on preference settings added.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-04 12:22:06 -08:00