Commit graph

188 commits

Author SHA1 Message Date
Robert C. Helling
02d5d436d2 EAD/END explanation in user manual.
E is for "equivalent".

Signed-off-by: Robert C. Helling <helling@atdotde.de>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-03-31 11:51:54 -07:00
Willem Ferguson
69b000dcff User manual: Updates to sections 6 and 10-13
These are updates that are not version 4.1 dependent, but many linguistic
and logical edits are made, as are edits for consistency.
No substantive material has been removed or added.
This text is ready for V4.1

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-03-27 10:58:22 -07:00
Lakshman
17e493735b Minor edits to updated section-3 documentation
Patch provided by Willem Ferguson, "0002-Updates-to-Section-3-of-
the-user-manual" addresses large number of typos and inconsistencies
in the previous documentation of section 3. This patch makes some
additional corrections on top of the provided patch, and also removes
the trailing whitespaces brought in with the provided patch.

Signed-off-by: Lakshman Anumolu <acrlakshman@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-03-25 08:13:26 -07:00
Willem Ferguson
b95304f424 Updates to Section 3 of the user manual
Section 3 is quite a long section. Ten of the screen shots are replaced.
Large numbers of typos and inconsistencies are corrected.
A few sentences are included e.g when dealing with the Subsurface Companion.
Section dealing with creating libdivecomputer dump files has been reorganised
slightly.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-03-25 08:12:54 -07:00
Willem Ferguson
f7709ec4a3 User manual: Changes to sections 1 and 2
The text for these two sections has been corrected and updated
in order to be ready for the release of V4.1. The very first
paragraph of the manual is expanded substantially.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-03-17 10:54:08 -07:00
Willem Ferguson
0f7dfcee26 User manual: Update sections 4 and 5
A new figure is included to reflect the actions of the new profile buttons
on the calculated ceilings.

A number of small edits on sections 4 and 5 of the user manual are done.
These sections are now finalised for the new release.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-03-15 22:17:59 -07:00
Willem Ferguson
f4d56ddf6f Revision of Profile part of manual
The last figures in the manual using the Unity desktop have been replaced
with equivalent figures using Gnome 3. There should now be no figures
remaining from Unity.

This is a revision of the profile part of the manual in the light of the
changes for V4.1. Text has been moved around, some new text added or
rewritten. Graphics has been replaced to reflect the UI for V4.1,
including Tomaz's button bar and Louisa's new buttons for that bar.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-03-14 15:31:37 -07:00
Dirk Hohndel
4e468d6475 User manual: gps coordinates are tied to location names
While it seems obvious that you need a named dive site in order to track
its coordinates, apparently people try to have no location name but
distinct coordinates which at this time we do not support.

See #440

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-22 08:57:03 -08:00
Dirk Hohndel
4fad2c9172 User manual: Give credit where it's due
Willem has been maintaining the user manual for quite a while and at this
point is the main author, so he should be listed first.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-22 08:56:57 -08:00
Willem Ferguson
853ce0bbef User manual: Style and grammar updates
This is an edit for style and grammar for the manual section dealing with
downloads from DC. This section has also been expanded to cover all the
controls in the downloads panel.

Signed-off-by: Willem Ferguson <willem@willem-Precision-M4700.(none)>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-18 08:46:42 -08:00
Willem Ferguson
6496f4eb61 User manual: grammar and stylistic revision
This commit was jointly authored by Pedro Neves and Willem Ferguson.
Pedro added a FAQ section to the manual. Many long lines of text were
broken into shorter lines.

Signed-off-by: Willem Ferguson <willem@willem-Precision-M4700.(none)>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-13 22:38:06 -08:00
Willem Ferguson
af8c44fa22 User manual: small updates
The section on the main menu descriptions has been changed a little bit to
reflect the current menu structure.

The section dealing with exprt from other dive software has been changed
to appear more user friendly, with three new icons.

Signed-off-by: Willem Ferguson <willem@willem-Precision-M4700.(none)>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-11 12:36:37 -08:00
Willem Ferguson
cb7a87faef User manual: reorganize text on importing from other dive log software
Change and shorten in some places the section dealing with data import
from foreign software.

Create Appendix C, containing information on data export from foreign
packages.

Signed-off-by: Willem Ferguson <willem@willem-Precision-M4700.(none)>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 06:46:51 -08:00
Willem Ferguson
3217201bb7 User manual: replace some images, minor updates
Except for the images involving the dive profile, all the images now are
from Gnome 3. Images for dive profile awaits finalisation of the new dive
profile.

Small changes to the text of the manual have been done, the most important
of which is that dealing with using the unified import dialogue of
Subsurface.

Signed-off-by: Willem Ferguson <willem@willem-Precision-M4700.(none)>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-05 09:28:39 -08:00
Willem Ferguson
2f582f4fb1 User manual: Small text updates and new screenshots
This adds Gnome-based screenshots to the manual for most of the images not
involving the profile. More of the images remain to be done.

I rewrote small sections of the text to reflect some of the recent
changes. Several images still need to be replaced. The profile images will
be done once the profile panel has been finalised. Some text also still
needs working.

Signed-off-by: Willem Ferguson <willem@willem-Precision-M4700.(none)>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-31 09:16:17 -08:00
Miika Turkia
c4c7d85fb5 Adding some supported divelogs to importing info
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-25 06:53:04 -08:00
Miika Turkia
4b46385d64 Typo fixes on user manual
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-25 06:53:04 -08:00
Miika Turkia
f2a1171b15 Add manual CSV log import to UserManual
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-25 06:53:04 -08:00
Miika Turkia
ac290a923c CSV import instructions improved
Importing CSV files has changed slightly since writing this manual.
Updating accordingly. A typo fix as well (comma separated *values*).

Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-25 06:53:04 -08:00
Tim Wootton
07c116ecd2 Add ISO 6709 co-ordinates to manual
And fix a typo

Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-15 15:10:55 +07:00
Tim Wootton
df1391fde2 Adds Boris' Full Screen mode to the manual
Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-15 15:08:36 +07:00
Miika Turkia
ffe53224a2 Fix typo
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-06 20:48:24 +08:00
Dirk Hohndel
7771158c82 Prepare for 4.0.1 release
Small updates to README, ReleaseNotes, user manual.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-03 03:18:59 -08:00
Miika Turkia
54c8ae3a48 Update manual to reflect CSV import numbering
Patch f4db392a changed CSV import to use field numbers instead of
indexes. Thus removing the now incorrect description of numbering from
user manual. Note, that screenshot should be updated as well.

Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-29 04:24:07 -08:00
Willem Ferguson
c8e4ce9b81 User manual: update
1) Text about libdivecomputer log and dump files
2) Text about coordinate formats acceptable
3) Text about CSV import
4) Minor reorganisation of TOC

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-25 12:46:10 -08:00
Willem Ferguson
ebffd75a79 User manual: updates
Correct error in manual
Add some short text in sections dealing with equipment.

[Dirk Hohndel: clean up whitespace & regenerate the html file]

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-23 09:40:11 -08:00
Cristian Ionescu-Idbohrn
5b8586405f Correct small typo.
Signed-off-by: Cristian Ionescu-Idbohrn <cristian.ionescu-idbohrn@axis.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-23 09:33:07 -08:00
Cristian Ionescu-Idbohrn
73a8996609 Make XML and PDF version of user manual build again
Removing the offending tags in Documentation/user-manual.txt makes it
build.

Signed-off-by: Cristian Ionescu-Idbohrn <cristian.ionescu-idbohrn@axis.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-21 08:29:43 -08:00
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
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