Commit graph

144 commits

Author SHA1 Message Date
willemferguson
a0f740763b Subsurface Desktop user manual: Statistics panel
Update the user manual to take into account the statistics tool.
This is a first attempt.

Signed-off-by: willemferguson <willemferguson@zoology.up.ac.za>
2021-02-08 08:23:01 -08:00
willemferguson
d183e93bad Subsurface User manual update: Filter
This adds text to the user manual pertaining to the filter tool.
2 Figures removed, 7 figures added.

Signed-off-by: willemferguson <willemferguson@zoology.up.ac.za>
2020-10-03 10:39:00 -07:00
willemferguson
eb6dfd3745 Change to user-manual (Dive export)
This brings the user manual in line with the recent changes to the
layout of the export panel.

Signed-off-by: willemferguson <willemferguson@zoology.up.ac.za>
2020-04-19 09:28:26 -07:00
willemferguson
56a3377367 Changes to user manual for version 4.9.4
Six images are changed and several changes are made to the text of the user manual

Signed-off-by: willemferguson <willemferguson@zoology.up.ac.za>
2020-04-18 09:50:13 -07:00
willemferguson
92ea29ebcb Updates to user manual
Add an image that was lost in the latest updates.
Add text about checking of hand-entered coordinates.

Signed-off-by: willemferguson <willemferguson@zoology.up.ac.za>
2020-02-08 10:26:07 -08:00
willemferguson
996798ae3b Update User Manual: Preferences
Provide text and 12 images to describe the preference system
for Subsurface. Several within-document links updated.

Signed-off-by: willemferguson <willemferguson@zoology.up.ac.za>
2020-01-26 16:04:49 -08:00
willemferguson
e9778e7a48 User Manual updates: changed to UI
Replace 11 images in the user manual to reflect latest changes
in the UI (Notes tab, Equipment tab, Information tab).
Change text in user manual.

Signed-off-by: willemferguson <willemferguson@zoology.up.ac.za>
2020-01-26 16:04:49 -08:00
willemferguson
9a562f221a Desktop user manual: dc management
The relevant text in the present manual is obsolete. Update
the text dealing with dive profiles from several sive computers
for one specific dive. One image is added.

Deal with creating a new cylinder type.

Signed-off-by: willemferguson <willemferguson@zoology.up.ac.za>
2019-08-08 09:05:09 -07:00
willemferguson
db550fab57 Updates to user manual (update 3 of 3)
Replace four images in section 5.2.5
Update text to reflect the undo mechanism. This mostly involved removing
obsolete text.

Signed-off-by: willemferguson <willemferguson@zoology.up.ac.za>
2019-07-12 12:52:04 -07:00
willemferguson
eefaae35b3 Update user manual (2 of 3)
Small updates and corrections to existing text
Replaced four images to reflect the current UI

Signed-off-by: willemferguson <willemferguson@zoology.up.ac.za>
2019-07-06 11:25:59 -07:00
willemferguson
230f3846fa User manual update (update 1 of 3)
Text has been added for the undo facility and for the specification
of atmospheric pressure.

Two images added.

Signed-off-by: willemferguson <willemferguson@zoology.up.ac.za>
2019-06-26 06:46:58 +08:00
willemferguson
563137fcd6 Desktop user manual update: dive site management
Include text about dive site management. 5 new figures
are introduced. Writing this enabled me to appreciate just how
much time must have gone into writing the code.

Signed-off-by: willemferguson <willemferguson@zoology.up.ac.za>
2019-05-05 09:06:17 -07:00
willemferguson
e4a1991e0c User manual: Text for Filter Tool
The description of the Filter tool is brought up to date.
One image is replaced elsewhere in the manual to reflect the
new Subsurface window top bar that indicates number of dives.
In total, 4 images added and text for user-manual updated.
The location of the filter text in the usermanual has been
changed.

Signed-off-by: willemferguson <willemferguson@zoology.up.ac.za>
2019-03-05 13:03:13 -08:00
willemferguson
56e667f05f Changes to user manual (V4.8.4)
1) remove Facebook integration (Dirk)
2) rewrite section about filter (Dirk)
3) insert section about bailout checkbox (Robert)
4) finalise section about surface GF in info box (Robert)
5) add export of profile graphic to .png (Robert)
6) update import of dives using universal import dialog (Miika)
7) some typos corrected and Robert's requests implemented
8) Factual info as wellas typos and corrections raised by
   Miika and Dirk

Signed-off-by: willemferguson <willemferguson@zoology.up.ac.za>
2019-02-10 22:50:28 +01:00
Robert C. Helling
c9d8b4f605 Add button to toggle deco info in info box
The info box can get longish. Offer the user to turn
off display of deco information (surface GF and
individual ceilings).

Signed-off-by: Robert C. Helling <helling@atdotde.de>
2019-02-05 14:18:14 +01:00
Lubomir I. Ivanov
a1ffe115cf facebook: remove the featute from the code base
Remove from:
- unit tests
- desktop widgets
- preferences
- core intergration
- cmakefiles
- build scripts
- icons
- docs

Also remove the plugins and social network integration.

Signed-off-by: Lubomir I. Ivanov <neolit123@gmail.com>
2019-02-01 17:16:43 -08:00
Jan Mulder
d3f66bad6d User Manual: scale recently changed image
The MobileGpsMenu.jpg image was way to big in the generated html and pdf
versions of the manual. Corrected here.

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2018-09-17 11:14:31 +02:00
willemferguson
9037df76be user manual: additional updates and new images
These changes complete (I hope) the updates to the user manual to reflect
the use of media including video. Nine images are replaced.
Some more updates in the user-manual.txt to reflect on video files
and not only photographs.

Signed-off-by: willemferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2018-09-16 08:17:01 -07:00
Willem Ferguson
7f5d73acb4 User Manual: replace screendumps
Replace a very outdated screendump related to Preferences-Network,
and one for the new anonimize export option.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2018-09-16 07:51:56 -07:00
Jan Mulder
a4f04589c7 User manual: get rid of Companion app texts
Tried to strip all referencews to the companion app. Including a remark of
end-of-life of the GPS webservice end 2018. Also fixed a screendump from
mobile, for the removed menu items of the GPS service.

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2018-09-16 07:51:39 -07:00
willemferguson
4e5621dff4 user manual: updates for media support
This updates the user manual with text on the addition of and
viewing of media, including video files.

5 images are replaced

Signed-off-by: willemferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2018-09-15 18:16:52 -07:00
Berthold Stoeger
f3db298465 Manual: Adapt description of "find moved images" functionality
Adapt description and add example image.

Signed-off-by: Berthold Stoeger <bstoeger@mail.tuwien.ac.at>
2018-07-04 02:27:36 +08:00
Willem Ferguson
294c3bcfd1 User Manual: add text for bailout using PSCR
As the title says.

A few tiny other changes to the user manual as well.
Corrected a some typos (Thanks, @neolit123).

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
2018-05-31 21:08:22 +03:00
Willem Ferguson
e021fc21ea User manual: Add text for dive planning CCR with bailout
Three images added as well as text.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
2018-05-28 21:50:01 +03:00
Willem Ferguson
773ee0d990 Update user manual for CCR and pSCR dive logs
Update the text pertaining to CCR and pSCR dive logs to include the
changes with respect to:
1) Colour of CCR setpoint graph and pSCR OC-equivalen pO2 graph.
2) Display of bailout information on dive logs.
3) Preferences tab allowing setting pertaining to the above.

This is the first of a few PRs with updates to the user manual
relating to CCR and pSCR dives.

Correct some typos.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
2018-05-17 17:32:24 +03:00
Willem Ferguson
75cf43b0b9 Update of some sections of user manual.
Rewrite some parts text dealing with dive planner as well as
using the Photos tab.

Replace 7 images to reflect new features of the UI.

Add some text to the user manual on planning recreationa dives.

Replace one image and add another image.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
2018-01-26 21:50:29 +02:00
Jan Mulder
f566b8b597 user manuals: EN and NL, changed for Subsurface-mobile
Small set of changes to both the NL and EN user manuals.
1) Corrected screendumps of the mobile app to version 2 of the app.
2) Corrected the removed checkbox in the main menu to a normal
menu item in the GPS menu for the location service.

So, nothing more than some maintenance.

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-10-21 10:20:36 +02:00
Willem Ferguson
a99c5f8a06 Add missing icons for user manual
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2017-10-20 15:29:33 -04:00
Willem Ferguson
cd555f9dac Update to latest user manual
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2017-10-20 14:13:26 -04:00
Willem Ferguson
305a35a48c Desktop user manual update for V4.7
The text of the user manual is updated in the following sections:
1) Bluetooth downloads
2) Using the new Dive Map tool of Lubomir
3) SmartTrak import using Robert's web service
4) Several details about the planner, including plan variations and minimum gas

11 images  were replaced or added.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2017-10-19 06:40:50 -04:00
Willem Ferguson
c2930919af PATCH - Refplace the figures in user manual
Replace the figures in the user manual section that deals with preferences
selections.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2017-05-27 07:34:06 -07:00
Jan Mulder
4a067bde1b user manual: update dive computer configure screendump
The currect one was too old, and not in line with the current 4.6.3
situation.

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-17 09:36:52 -07:00
Stefan Fuchs
af96ec5d04 Minimum gas calculation: Ducumentation in user manual (EN)
Small paragraph in EN user manual added.
Planner screen shots changed and renamed.

Signed-off-by: Stefan Fuchs <sfuchs@gmx.de>
2017-03-11 08:01:35 -08:00
Willem Ferguson
fd9885e13d replace image for TeX export
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2017-01-13 08:01:04 -08:00
Willem Ferguson
eb8ff36f3c Replace image in user manual
Replace image reflecting dive export formats to show the current options.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2017-01-12 21:11:59 -08:00
Robert C. Helling
4c8355aba0 User manual: TeX export
Explain how to use the TeX export

Signed-off-by: Robert C. Helling <helling@atdotde.de>
2017-01-10 23:03:49 -08:00
Willem Ferguson
a6f9a37831 User manual updates
Update:
1) Text dealing with SmartTrak import. Move text, some corrections,
   add image.
2) Text dealing with command-line arguments.

A few other small changes.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2017-01-07 07:19:12 -08:00
Willem Ferguson
208f4f2166 User manual updates
Update sections on:

1) Facebook integration
2) Events (notifications, warnings,alarms) on dive profile
3) Divelist icons indicating associated photographs

3 images replaced, 4 added.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2017-01-06 20:45:41 -08:00
Willem Ferguson
91a13ae09c User manual routine update (3)
This is the third update of the user manual. Mostly last section
before appendices. Still some work remains in this part,
dependent on queries to questions I raised.

The images for the preferences section are replaced.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-11-09 06:25:11 -08:00
Rick Walsh
3f060c5c28 User manual: replace heatmap comparison graphic
The new heatmap graphic reflects how the heatmap is now displayed. Also update
text describing graphic.

Signed-off-by: Rick Walsh <rickmwalsh@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-11-05 12:53:35 -07:00
Willem Ferguson
6bee4babd3 Routine maintenance of user manual (2)
Episode 2 of current round of maintenance.
Two images replaced with three new images.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-11-05 12:53:18 -07:00
Willem Ferguson
b478d75303 User-manual: More updated to heat map
Changes to the heatmap image in the user manual as well as some small changes
to sync the text with the new image.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-10-27 20:37:46 -07:00
Willem Ferguson
a0179e0e57 User-manual: Heat map
1) Replace the existing graphics for explaining the heat map.
2) Update the text for explaining the heat map.
These changes with substantial input from Rick Walsh.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-10-27 20:37:32 -07:00
Willem Ferguson
1801a6888f Subsurface User Manual: Update section dealing with heat map. Move section about Information Box lower down in user manual.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-10-11 22:03:40 -07:00
Rick Walsh
fbcf4b9bd3 User manual: actually add new images
Signed-off-by: Rick Walsh <rickmwalsh@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-10-03 07:59:40 -07:00
Rick Walsh
f2ed9ede77 User manual: include tissue heatmap graphics
Signed-off-by: Rick Walsh <rickmwalsh@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-09-27 21:34:15 -07:00
Willem Ferguson
9803d7acde User manual update: Subsurface-mobile
Subsurface user manual update: Subsurface-mobile

Provide text for the use of Subsurface-mobile to collect
GPS positions, upload these and sync the stored GPS positions
with dives in the dive list. Two images added.

This is in addition to documentation for the Companion App.

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

From f2062208b1cc76743280428227e8a31e51732dc9 Mon Sep 17 00:00:00 2001
From: Willem Ferguson <willemferguson@zoology.up.ac.za>
Date: Sun, 19 Jun 2016 14:29:19 +0200
Subject: [PATCH 4/4] Subsurface user manual update: Subsurface-mobile

Provide text for the use of Subsurface-mobile to collect
GPS positions, upload these and sync the stored GPS positions
with dives in the dive list.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-06-20 18:40:00 -07:00
Willem Ferguson
c9081e5975 Corrections to user manual
Replace one icon and correct text to show an image.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-06-18 11:22:56 -07:00
Willem Ferguson
95b997c469 User Manual update
Update section of user manual dealing with searching the manual
and following links in the manual.
Repaired one omage, added a second

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-06-18 11:22:56 -07:00
Willem Ferguson
dffd2857f6 User manual updates
1) Delete duplicate or unused images in Documentation/images directory
2) Add text to describe user manual viewer functionality
3) Add image to explain 2) above
4) Add text to explanation of TTS toolbar button (Thank you very much, Davide!)
5) Update image showing display of TTS toolbar button

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-10-19 09:46:02 -07:00