Commit graph

148 commits

Author SHA1 Message Date
Willem Ferguson
1786148d31 User manual: Add section on dive log storage in the cloud using dropbox
Some other dive log programs present storage of dive logs on the Internet
as an important feature. Therefore this text.
One image was added.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-29 09:18:32 -07:00
Willem Ferguson
a0098a830c User Manual: Changes to Print Dive and Print Dive Plan
This patch performs the following to the user manual:

1) Remove text refering to cursor position indications on the depth
   and time axes of the dive profile panel (not present in V4.2).
2) Revise dialogue and image for the printing of a dive log, taking
   into account the new feature for 1 dive/page.
3) Added a paragraph to the text dealing with printing of dive plans,
   detailing the approach to print dive plans after they have been saved
   in the Dive List. This is done at the end of the text dealing
   with the dive planner.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-25 07:16:08 -07:00
Willem Ferguson
796d0a98f9 User manual: Add text as well as figures.
This patch updates the user manual in the following respects:
1) Add section dealing with modifying the categories of information
   shown in the Dive List. (A figure added)
2) Add section on filtering the Dive Listfor a particulr sive site,
   using Ctl-F.
3) Add section describing the addition of bookmarks
   (a figure added)
4) Two sentences dealing with the 30-minute time limit for
   including photos onto the dive profile (dives > 30min of
   the dive are not shown).
5) A few small changes, mostly typos.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-24 12:54:14 -07:00
Willem Ferguson
c2d9d3f475 User manual: Replace figure
Replace an Ubutu-based figure (we stick to Gnome).

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-24 07:35:09 -07:00
Willem Ferguson
a1b085324e User manual: Replace CSV import image
Replace the CSV import image to reflect recent changes.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-18 10:16:23 -07:00
Willem Ferguson
40a9b316b2 User manual: updates
Changes to user manual to rplace three images, as pointed out by Sergey.
Small changes to text of manual to reflect blue editing bar UI.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-18 10:15:53 -07:00
Willem Ferguson
82fc95d693 User manual: Updated text
This patch contains some updates to the user manual to reflect the new
images that were submitted previously. The updates include:
1) Moving the "Load Photos" section to the section daling with the input
   of dive information (photos qualify as additional dive information).
2) Changing the wording around the new button in the tool bar.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-16 23:08:50 -07:00
Willem Ferguson
004b9d72c5 Replacement figures for user manual
Replacement figures for user manual

     Here are 12 replacement figures for the user manual to bring the
figures
     in line with the current UI. This relates to the updated profile
toolbar
     and manual dive profile entry. I did not change any text of the manual.
     That will happen tomorrow evening.

     Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>

From 85413b967c02738d47f0b7779613f33cc7898c17 Mon Sep 17 00:00:00 2001
From: Willem Ferguson <willemferguson@zoology.up.ac.za>
Date: Wed, 16 Jul 2014 07:26:43 +0200
Subject: [PATCH 4/4] Replacement figures for user manual

Here are 12 replacement figures for the user manual to bring the figures
in line with the current UI. This relates to the updated profile toolbar
and manual dive profile entry. I did not change any text of the manual.
That will happen tomorrow evening.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-16 09:22:02 -07:00
Willem Ferguson
de8dbf2dad Updates to user manual: Preferences and Main menu
This patch updates the section on Preferences to accommodate
the newer additions to this Panel.
(Three images removed, five images inserted)

The section dealing with the desciption of all the main menu items
is updated.

One small change to the FAQ section.

A few small typo edits elsewhere in manual.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-06-29 08:36:07 -07:00
Willem Ferguson
f1f16b224b User manual: add more about dive log export.
This patch updates the information about dive log export.
Export to Worldmap, as well as to HTML are covered.

Small typo corrections elsewhere in the manual.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-06-28 16:01:59 -07:00
Willem Ferguson
dd9d68a359 User manual: Load photographs
This patch adds text and figures to the user manual, explaining how to
add photographs to the dive profile.

A 2-sentence paragraph was added to the dive planner text, detailing
planning for repetitive dives.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-06-28 16:01:48 -07:00
Willem Ferguson
2292abd552 User manual: add text for the dive planner
Text for the dive planner has been added to the user manual.
This includes two new images.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-06-28 16:01:38 -07:00
Willem Ferguson
eba0790a04 Yet some more changes to Companion part of user manual
A last few changes before 4.1.
The first figure in "Using Companion app" needs a third part.
This was inserted. Which, in turn, affected the last figure
in that section. So that was also changed accordingly.

Few tiny changes to text to clean up references to figures.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-05-08 08:19:54 -07:00
Willem Ferguson
0325a42c08 User manual: Updates regarding the companion app
These adiitions and changes were made in accordance with the screenshots
provided by Venkatesh and Salvador and after managing to actually run the
companion app on my phone. Large parts of the text of this section have
been changed in accordance with the Companion V2 interface. Two graphics
were changed.

After Version 2 has stabilised, some more adaptation of the text will be
required.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-05-07 09:12:15 -07:00
Willem Ferguson
24792f402d User manual: Replace some graphics
1) Two of the major screen images were replaced to reflect the current
   screen layout with the new features of the profile toolbar.
2) The heart rate button is depicted and desribed.
3) Minute changes to the text of the manual to accompany the above changes.
4) The Uwatec Galileo image is re-inserted in the icons folder. Somewhere
   it got lost.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-04-21 08:36:03 -07:00
Willem Ferguson
20bde81023 Small updates to user manual
These updates reflect the discussion and small changes that were made to the
Preferences section and the Export-to-Worldmap features over the last week.

1) A few small changes made to the text of the Preferences section.
2) Two images replaced in the Preferences section.
3) Expansion of description of Export to Worldmap option of the menu system.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-04-10 09:15:28 -07:00
Willem Ferguson
57bfa7e353 Update to bring user manual in line for the release of V4.1.
1. New section added on IrDA and communicating with the Uwatec Galileo dive computers.
2. Sections 7 to 9 of manual updated to reflect current version. Three figures updated.
3. New section added to reflect the dive planner. This is only a skeleton
awaiting better description when the dive planner is more mature. Added
2 figures within this new section.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-04-07 10:16:54 -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
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
ce6f2cdda4 User manual: Add the missing icons
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-03-15 09:48:49 -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
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
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
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
25a9c23635 Update screenshot for CSV import
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
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
d72be58395 Replace figure of main screen with one that shows the main menu. Previous fig did not show manin manu.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-24 07:07:45 -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
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
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
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
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
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
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
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
Willem Ferguson
83766db87b A further update to the user manual
I have added a section about importing dives from other electronic
sources. There are some potential problems, because I know that the
intercation with divelogs.de is not yet fully functional

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-02 06:54:20 -08:00
Willem Ferguson
795992b1f7 Update to user manual, adding several sections and some graphics
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-01 07:44:59 -08:00
Willem Ferguson
5948aa5650 A first update of subsurface V4.0 manual
This starts mostly from scratch. It removes big chunkgs of the old manual,
the old pictures and starts with new visuals and new descriptions. A lot
more work is needed, but it's a good start.

Signed-off-by: Willem Ferguson <willem@willem-Precision-M4700.(none)>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-11-19 09:40:14 -08:00
Miika Turkia
f330942804 New dive planning screenshot with 6m stop in it
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-05-15 01:15:51 -04:00
Miika Turkia
6f750da063 Updating user documentation to reflect current version
Most of the new stuff from UI perspective should now be documented.
Bumped also the doc version number optimistically.

Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-05-02 08:32:05 -07:00
Jan Schubert
bd6a33f4bc Documentation: add pictures for Bluetooth setup
Signed-off-by: Jan Schubert <Jan.Schubert@GMX.li>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-26 12:50:39 -08:00
Miika Turkia
e544594d9b Documentation: update main windows image
Sent to the list by Miika for inclusion in the user manual...

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-19 13:13:33 -08:00
Miika Turkia
95f5098bcb Screenshot for preferences
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-19 09:19:08 -08:00
Miika Turkia
e78f9f9171 A couple of screenshots added
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-19 09:17:42 -08:00
Miika Turkia
8facc61e8f [PATCH] Adding screen captures of dive planning
[Dirk Hohndel: removed the images folder from the Documentation directory
               Makefile clean target]

Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-19 06:55:38 -08:00