Commit graph

725 commits

Author SHA1 Message Date
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
Robert C. Helling
7c6f30a4b1 Reflect the gas density display in the user manual
Signed-off-by: Robert C. Helling <helling@atdotde.de>
2017-05-26 15:52:04 -07:00
Dirk Hohndel
86d33b96e9 Update bundled user manual HTML files
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2017-04-22 12:45:18 -07:00
Salvador Cuñat
abf5656ce6 Update spanish translation of user manual to english 441260b8 2017-04-22 09:28:23 -07:00
Rick Walsh
541b86e710 FAQ: update section on Bluetooth on Linux
Setting up an RFCOMM connection has not been required for a long time.

Reported-by: Stephen Hemminger <stephen@networkplumber.org>
Signed-off-by: Rick Walsh <rickmwalsh@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2017-04-18 21:15:52 -07:00
Dirk Hohndel
058179a305 Add Dutch user manual HTML file
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2017-04-12 18:08:06 -07:00
Jan Mulder
441260b8bc user manual: five trivial typos
five trivial typos corrected

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-04-12 07:48:39 -07:00
Jan Mulder
fd11aa8248 user manual: some more graph -> profile renames
And found some more graph -> profile strings to be renamed.

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-04-12 07:48:39 -07:00
Jan Mulder
4fae51817a user manual: sync command line options
Sync the command line opions with 4.6.3 (added win32log)

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-04-12 07:48:39 -07:00
Jan Mulder
69cf0cf2e8 user manual: print a dive plan
Removed 2nd occurrence of the fact that a dive can be printed in
the planner using the print button.

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-04-12 07:48:39 -07:00
Jan Mulder
b0c69aa111 NL: incorporate user manual in build
Add the nwe NL user manual to the build process.

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-04-12 07:46:46 -07:00
Jan Mulder
2d5519a35d NL: first edition of usermanual translated to Dutch
First edition of usermanual translated to Dutch.

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-04-12 07:46:46 -07:00
Jan Mulder
6e38619970 user manual: Preferences Defaults renamed to General
See commit 25dcee139e. Preferences Defaults renamed to General.

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-24 09:32:41 -07:00
Jan Mulder
5006fe1c6b user manaul: Preferences Graph renamed to profile
See commit 6305361d14. Graph is renamed to Profile.

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-24 09:32:41 -07:00
Jan Mulder
ede5e70c54 user manual: pSCR diving is similar to OC, not CCR
See also commit acb38c9e00. pSCR is with respect to cylinder planning very
similar to OC planning. Obviously, the SAC is much (max. 8x for counterlung
ration 1:10) lower, but multiple gasses are common (in all but recreational
pSCR diving).

Changed the wording to reflect this.

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-24 09:32:41 -07:00
Jan Mulder
97f7de6165 user manual: weird and incorrect paragraph
from the planner section the follwing paragraph is weird and partially incorrect:

These changes should reflect the cylinders and gas compositions defined in the table
with _Available Gases_. If two or more gases are used, automatic gas switches will be
suggested during the ascent to the surface. These changes can be deleted by
right-clicking the gas change and manually creating a gas change by right-clicking
on the appropriate waypoint.

Yes: during the ascent, gas switches are automatically planned (not suggested). These
can't be deleted by right-clicking (as there are no real waypoints associated with
the gas switches). And futher. To delete a gas change you have to manually create one?

Solution: refrase paragraph.

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-24 09:32:41 -07:00
Jan Mulder
b1673a190a user manual: waypoints on profile can be moved using arrow keys
Add a sentence in the central section on manual profile entry that waypoints
can also be moved by keyboard (arrows).

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-24 09:32:41 -07:00
Jan Mulder
e9f5c8d525 user manual: do not repeat
Just said that we do not need to plan the ascent. Removed the 2nd ocurrence.

Also: trivial typo corrected

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-24 09:32:41 -07:00
Jan Mulder
1355687b88 user manual: p02 setting in Available Gases dialog is not possible
The manual suggests that in the  Available Gases dialog of the planner, setting of
pO2 is possible. This is not the case, and changed the text accordingly.

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-24 09:32:41 -07:00
Jan Mulder
d7ba41fe0f user manual: set of small changes in planner text
Mostly typos and some wording change due to change of UI from
working pressure to starting pressure. And some subscripts changed,
some correction, some style. Now all are in ~2~ format.

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-24 09:32:41 -07:00
Jan Mulder
58eeb3f825 user manual: section is called Proxy
Section is called Proxy and nor Proxy Type (which is attribute
in the section).

Simple incorrect wording fixed.

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-24 09:32:41 -07:00
Jan Mulder
94d6b52330 user manual: changed unclear wording (network preferences)
The old wording suggests that your ISP has something to do with
the Subsurface cloud or companion app. This is not right, so did
a little rewrite.

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-24 09:32:41 -07:00
Jan Mulder
9616d7b1f8 user manual: typo
trivial 1 letter typo.

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-24 09:32:41 -07:00
Jan Mulder
6c22585dfc user manual: spell O2 correctly
Spell (p)O2 correctly with a subscript.

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-24 09:32:41 -07:00
Jan Mulder
4f3a8dd693 user manual: code changes influencing manual (Preferences)
Commits 25dcee139 and 6305361d14 change the user interface, and this
needs to be adapted in the user manual too.

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-17 09:36:52 -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
Jan Mulder
8cd2be27ee user manual: update list of supported dive computers to configure
Update the list of supported dive computers to configure. It
was a little out of sync to the code.

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-17 09:36:52 -07:00
Jan Mulder
1097ea1c61 user manual: be less verbose on Dropbox
The section on Dropbox is too verbose to my liking. The Subsurface
manual is not the place to elaborate extensively on something
external as Dropbox.

Removed a section.

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-17 09:36:52 -07:00
Jan Mulder
70aa8d30b1 user manual: dive list instead of dive profile
Selecting dives is done in the dive list, not in the dive profile.
Simple textual mistake.

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-17 09:36:52 -07:00
Jan Mulder
ba6ffc624c user manual: improved wording
Some change of wording. The split of a 10 dive trip in one of 4 and one
of 6 dives is just an example.

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-17 09:36:52 -07:00
Jan Mulder
44046126b0 user manual: remove paragraph
The removed paragraph is not really correct. You do not have to select a trip
to access trip manipulation context menu items, and the behaviour of +/- buttons
is so well known and commonplace that the paragraph before is more than enhough
to explain this trivial feature.

Solution: remove paragraph

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-17 09:36:52 -07:00
Jan Mulder
ad62d8a731 user manual: TTS does not depend on SAC
This one little sentence confuses me: TTS is calculated assuming an ascent
surface air consumption (SAC) for the gas currently used.

Time to surface is a decompression + ascent time calculation only. Obviously, the diver
should plan to have suffient gas for this, but TTS is not a function of SAC. There is
the "remaining air time, RAT) some dive computers can calculate which uses TTS in
combination with SAC to assist the diver to start his ascent, but RAT != TTS.

Solution: remove the confusing sentence.

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-17 09:36:52 -07:00
Jan Mulder
3c2aaaf29c user manual: info box does not change
The info box for the dive profile is said to change to minimal when the
mouse pointer is outside the profile window. Testing this in 4.6.3 shows
that this is not the case. The info box does not change on window leave
of the pointer.

It might have worked that way before, but it is no big deal, so better to
change the manual to reflect the current working.

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-17 09:36:52 -07:00
Jan Mulder
acb38c9e00 user manual: pSCR is not driven from back gas by default
Generalize the wording. pSCRs are typically configured with a swichblock,
allowing insertion a any gas in the unit, equivalently with a gas change
on open circuit.

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-17 09:36:52 -07:00
Jan Mulder
0398af341d user manual: not typically nitrox
The fact that a pSCR is typically driven using nitrox is just flat wrong. A
pSCR can be considered as universal gas extender for any depth, so any driving gas.

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-17 09:36:52 -07:00
Jan Mulder
5a8f884390 user manual: the sections deals with pSCR so title it like that
As this section (almost exclusively) deals with pSCR reflect
that in the title.

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-17 09:36:52 -07:00
Jan Mulder
87860291c1 user manual: correct left and right clicking and a typo
left and right clicking where stated incorrectly, so corrected this.

Also, a 1 letter typo on the same area corrected, not justifying a seperate commit.

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-17 09:36:52 -07:00
Jan Mulder
1eec41b6cf user manual: cannot edit other characteristics
The edit option of a dive location only allows for edit of the name,
not any other attribute. Corrected text.

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-17 09:36:52 -07:00
Jan Mulder
0c688a4d19 user manual: the companion app deals with dive locations
The corrected text suggests that the Companion app deals with dives, but
it deals with locations of dives.

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-17 09:36:52 -07:00
Jan Mulder
97ee1dd3a0 user manual: correct very unclear/erroneous sentence
It said: Now select the appropriate locations, then select the
tab in the upper right, afterAndroid device.

Unclear to me, so corrected to what is intended here.

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-17 09:36:52 -07:00
Jan Mulder
6a6cc7af40 user manual: remove sentence
The sentence: "Check the indicator at the top of the mobile screen for
internet activity, indicating the transfer of information" suggests something
that is very dependent on specific Android version and esp. settings of the
topbar icons.

Imho is better to remove this.

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-17 09:36:52 -07:00
Martin Měřinský
8e1dec434b htttp > http 2017-03-13 10:28:06 -07:00
Martin Měřinský
3d89914633 Use GFLow, GFHigh (not GFlow, GF Low, GF low). 2017-03-13 10:28:06 -07:00
Martin Měřinský
8761247722 PO2 > pO₂ 2017-03-11 08:10:10 -08:00
Martin Měřinský
95d5771513 We use 'setpoint' in UI. Use it also for documentation and comments. No semantic change. 2017-03-11 08:09:07 -08:00
Martin Měřinský
dcf2542215 Use abbreviations with dots. 2017-03-11 08:09:07 -08: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
Martin Měřinský
869a7fcfcc dive master > divemaster 2017-03-04 12:08:17 -08:00
Jan Mulder
7f4b0079f8 user manual: do not repeat
Just said the same thing (CSV file can be edited with a text editor). Too
verbose imho.

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-04 12:07:12 -08:00
Jan Mulder
d380795deb user manual: make the difference between import and open explicit
Two different menu path lead to "open a logfile". The File-Open-Logfile
and Import-Import Logfile. The first opens a new logbook, and the second adds the
data to the current log.

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-04 12:07:12 -08:00
Jan Mulder
69277afa0e user manual. Add 2 supported import file types
Divesoft dive logs and Poseidon MK VI eCCR dive logs where not listed
as supported, but they are.

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-04 12:07:12 -08:00
Jan Mulder
3c2f2c6988 user manual: downloading here
Lets try to be consistent. A dive computer can be in upload mode, and is uploading, but
seen from the host PC, we are downloading.

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-04 12:07:12 -08:00
Jan Mulder
c5bae2ea5a user manual: try to describe the add of location the way it is
The here edited section is confusing. It references double clicking,
which does not work in 4.6 (and not sure it ever worked)

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-04 12:07:12 -08:00
Jan Mulder
c204eefaae user manual: do not repeat
Do not repeat the almost same text in the next sentence.

When entering a dive location name, auto location of
dive site names makes it easy to select an existing dive site name.

When typing the name of a dive site,
a dropdown list appears showing all sites with similar names.

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-04 12:07:12 -08:00
Jan Mulder
84d34e8b22 user manual: date/time instead of only date
Date and time of the dive are two seperate fields.

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-04 12:07:12 -08:00
Jan Mulder
f5b98557d4 user manual: correct upload vs download
When importing from a divecomputer, we are downloading.

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-04 12:07:12 -08:00
Jan Mulder
ebac9ea6ce User manual: clearify the use of shortcuts
The way keybord shortcuts work is confusing. 2 ways are used:
- denoted as ctrl-? for some of them
- denoted as underlined character in menu items, proabably language
dependent, and inconsistent.

Despite all this, try to describe it in the manual as it is.

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-04 12:07:12 -08:00
Jan Mulder
8c559409c6 User manual: https where we can
http is so 1984 :-)

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-04 12:07:12 -08:00
Jan Mulder
77a611d562 User manual: manual added gas changes have effect to the right
Manual added gas gas changes have effect to the right of the profile, not as erroneously
stated to the left of the point of gas change.

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-04 12:07:12 -08:00
Jan Mulder
57f4ae2fce user manual: correct main menu items
Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-04 12:07:12 -08:00
Jan Mulder
c663bed4a3 User manual: minimal Windows 7 from 4.6 onwards
Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-04 12:07:12 -08:00
Dirk Hohndel
120ea25b6a Update Russian user manual
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2017-02-28 22:22:53 -08:00
Sergey Starosek
78150a4ed5 Re-align sections to fix asciidoc HTML conversion
Also minor spelling fixes.

Signed-off-by: Sergey Starosek <sergey.starosek@gmail.com>
2017-02-13 21:46:40 -08:00
Sergey Starosek
049866df02 Update russian translation of user manual for v4.6
Signed-off-by: Sergey Starosek <sergey.starosek@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2017-02-12 11:24:31 -08:00
Guillaume GARDET
7c8461a328 Documentation: Merge and update french translations
Signed-off-by: Guillaume GARDET <guillaume.gardet@free.fr>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2017-02-03 07:50:38 -08:00
Dirk Hohndel
17ecb11900 Update bundled user manual HTML for English and Spanish
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2017-01-16 03:46:07 -08:00
Guillaume GARDET
a8b09f60d1 Documentation: update/merge french translations
Signed-off-by: Guillaume GARDET <guillaume.gardet@free.fr>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2017-01-16 03:37:43 -08:00
Salvador Cuñat
c99aaaa323 user-manual_es-update to english 28e73f2b
Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
2017-01-15 06:52:32 -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
28e73f2ba1 Small update to user-manual
The section for fb export missed one crucial sentence. Added it.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2017-01-12 21:12:02 -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
Willem Ferguson
8f972c97e9 Subsurface user manual update
Generate text for:
1) Splitting a dive from the dive list context menu
2) Importing photos from the Internet

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2017-01-12 21:11:54 -08:00
Salvador Cuñat
6637aee114 user-manual_es-update to english 4c8355ab
Tex export

Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
2017-01-12 14:16:29 -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
Salvador Cuñat
9b31033030 user-manual_es-Update translation to english a6f9a378
Also fix two images broken links, fix a trailing white space an fixes
a text block formatting.

Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
2017-01-08 09:36:20 -08:00
Salvador Cuñat
9dd7de3027 user-manual_es-Update to english c0848879
-SmartTrak import
-Dives with photos associated
-DC events description
-Changes to Fb integration
-Multiple users in Subsurface

Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
2017-01-07 07:20:23 -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
c084887939 User manual updates
Update sections on:
1) --user= command-line option (several divers using one desktop computer)
2) AV1 and DL7 imports

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2017-01-06 20:45:48 -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
Salvador Cuñat
4e375f56a8 Add info about SmartTrak import
Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
2017-01-06 14:16:33 -08:00
Salvador Cuñat
2fe69eadbf Fix some broken links
Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
2017-01-06 14:16:33 -08:00
Salvador Cuñat
6e694a52e2 Update spanish translation of user manual to english b5f0a4a0
Additions about merging more than one DC profile and/or planned profile
to a real dive.

And fix some typos.

Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
2017-01-02 13:04:52 -08:00
Salvador Cuñat
43d98c0ca2 Fix a bunch of typos
Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
2016-12-31 01:06:00 +01:00
Salvador Cuñat
5e78144a4a Update spanish translation of user manual to english 91a13ae
Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
2016-12-31 01:05:18 +01:00
Henrik Brautaset Aronsen
b5f0a4a025 README: Switch from trac & email patches to GitHub PRs & issues
Ref. http://lists.subsurface-divelog.org/pipermail/subsurface/2016-December/026860.html

Signed-off-by: Henrik Brautaset Aronsen <subsurface@henrik.synth.no>
2016-12-30 14:24:22 -08:00
Guillaume GARDET
cac40bd659 Documentation: update/merge french translations
Signed-off-by: Guillaume GARDET <guillaume.gardet@free.fr>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-12-04 05:37:02 +09:00
Willem Ferguson
a5dd6d1519 User manual update
1. Add text dealing with multiple dive computers on a dive.
2. Add text dealing with saving the dive plan with a dive.
3. Update main menu descriptions with respect to above

[Dirk Hohndel: small updates for style]

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-12-04 05:36:28 +09:00
Dirk Hohndel
97be5fda2c Update bundled user-manual HTML files
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-11-09 06:25:11 -08:00
Salvador Cuñat
36b014024c Update spanish translation of user manual to english 3f060c5
- Subsurface-mobile
- Heatmap
- Heavy maintenance on english version
- fix some typos

Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-11-09 06:25:11 -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
Dirk Hohndel
654c15faa7 User manual: remove some passive voice
This makes the manual a bit more friendly to read...

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-11-01 09:34:47 -07:00
Willem Ferguson
48807dfdb5 User manual: routine maintenance
Restore headings, improve sentence readability.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-11-01 09:34:34 -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
9ed5a5bfe9 Updates to the text of the user manual that deals with heat maps.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-10-20 21:13:43 -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
Guillaume GARDET
f9e6a3ecc6 Documentation: Merge french translations
Signed-off-by: Guillaume GARDET <guillaume.gardet@free.fr>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-10-11 21:54:10 -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
Robert C. Helling
434c27525a Document the heat map in the manual.
Signed-off-by: Robert C. Helling <helling@atdotde.de>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-09-27 21:32:32 -07:00
Dirk Hohndel
285c3a9b66 Update Subsurface-mobile manual stored in git
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-09-04 11:19:04 -07:00
Dirk Hohndel
3f78283895 Update Subsurface-mobile manual
Correctly differentiate Android and iOS features.
Adapt style to be generally in the second person.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-09-04 09:53:24 -07:00
Anton Lundin
04d8d7cb13 scripts: run all scripts with -e
Run all scripts with -e so they exit as soon as something breaks. That
way the build stops at the first error, not some other error.

Signed-off-by: Anton Lundin <glance@acc.umu.se>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-08-17 21:44:31 -07:00
Rick Walsh
c5ca5c639f User manual: fix typo
Signed-off-by: Rick Walsh <rickmwalsh@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-08-10 15:05:32 -07:00
Rick Walsh
15f02a099c User manual: describe cylinder fields Deco switch at, Bot MOD and MND
Signed-off-by: Rick Walsh <rickmwalsh@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-08-10 15:05:19 -07:00
Guillaume GARDET
0b5ef8b73f Documentation: update french translation of user-manual and mobile-manual
Signed-off-by: Guillaume GARDET <guillaume.gardet@free.fr>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-07-23 10:54:07 +09:00
Willem Ferguson
b66b387215 Remove unused image from mobile user manual
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-07-23 10:51:44 +09: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
Miika Turkia
4ccfda65e7 Tuning the mobile-manual
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-06-20 18:39:54 -07:00
Miika Turkia
58690f3249 Enable creation of mobile-manual
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-06-20 18:39:49 -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
9633a676d9 Update to mobile user manual
Include text on obtaining PIN within Subsurface-mobile.
Replace two images

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
f71a1b88a6 Update to user manual for Subsurface-mobile with ten additional images.
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
Dirk Hohndel
ed9e5fe0f3 Don't use CRLF in documentation files
Suggested-by: Linus Torvalds <torvalds@linux-foundation.org>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-03-16 07:46:47 -07:00
Salvador Cuñat
27524248cc mobile-manual - Update authors, dates and so
Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-03-13 12:46:43 -07:00
Salvador Cuñat
b7848cc9c9 Spanish translation for mobile-manual.txt
[Dirk Hohndel: also added an html version]

Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-03-13 12:46:17 -07:00
Guillaume GARDET
c8df5625d4 Documentation: add mobile user manual to POT/PO management and update french translation of user-manual and mobile-manual
Signed-off-by: Guillaume GARDET <guillaume.gardet@free.fr>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-03-12 06:46:03 -08:00
Dirk Hohndel
d1247ba19c Small update to the mobile user manual
Also switch the mobile user manual html over to something created on my
machine and (as usual) named .html.git

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-03-10 09:00:31 -08:00
Willem Ferguson
a9b33e53ce Mobile - Update user manual for Subsurface-mobile
This replaces eight images and brings the text of the manual
up to date.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-03-09 11:08:55 -08:00
Dirk Hohndel
04f3a6f8d5 Rewrite the Subsurface-mobile user manual
This brings the text closer to the current version of Subsurface-mobile,
but a lot more fine tuning will be required (and of course the images need
to be updated to reflect the current UI).

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-03-04 11:38:01 -08:00
Lubomir I. Ivanov
f2fa087b3b user-manual.txt: mention some more Grantlee variables
With the recent refactoring of the DiveHelperObject class, some
more Q_PROPERTIES were added and can be used with the Grantlee engine.
We expose some of the additions to the user via the manual.

Signed-off-by: Lubomir I. Ivanov <neolit123@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-02-29 07:33:47 -08:00
Willem Ferguson
bc84d280b8 Mobile user-manual: Add text that explains action button
4 small images added.

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

From 43f260e7aa2be9af43c9250f75cad05a141f9d1e Mon Sep 17 00:00:00 2001
From: Willem Ferguson <willemferguson@zoology.up.ac.za>
Date: Tue, 9 Feb 2016 12:25:24 +0200
Subject: [PATCH 2/2] [PATCH] Mobile user-manual: add section explaining action
 button

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-02-09 10:55:23 -08:00
Willem Ferguson
ec9aad4487 Short first attempt at a user manual for Subsurface-mobile
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-02-08 08:22:39 -08:00
Miika Turkia
1f4d02a861 Improve group information on USB device
As the group can be something else than dialout on some systems, mention
this on user manual.

Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-12-28 08:28:15 -08:00
Dirk Hohndel
86765774dc Update the bundled htlm user manual
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-12-16 06:37:43 -08:00
Pedro Neves
e87e0bbba7 Corrected a typo in the User Manual
Signed-off-by: Pedro Neves <nevesdiver@gmail.com>

A small typo was corrected.
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-12-16 06:35:54 -08:00
Lubomir I. Ivanov
794d4e88be user-manual.txt: modifications related to Grantlee variables
This patch adds the new variables to the Grantlee section
of the user manual, which were recently added, code wise.

The patch also cleans the descriptions of some of
the already present varaibles and fixes a couple of typos
in the process.

Signed-off-by: Lubomir I. Ivanov <neolit123@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-12-02 09:21:52 -08:00
Dirk Hohndel
3413dc30e5 User manual: add missing empty line
This way the ASCIIDOC works as expected and creates the numbered list.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-11-28 13:01:47 -08:00
Wendie Fisher
bbf03fd50f Last set of updates to the user manual in this round
Once again focus on language and readability.

Signed-off-by: Wendie Fisher <wendie@divedad.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-11-23 14:48:52 -08:00
Wendie Fisher
1b0938034e Next batch of language updates for the user manual
Signed-off-by: Wendie Fisher <wendie@divedad.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-11-12 11:08:44 -08:00
Wendie Fisher
81f1238ab9 Updates to the user manual
Small changes to the language to make it easier to read.

Signed-off-by: Wendie Fisher <wendie@divedad.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-11-06 09:52:30 -08:00
Salvador Cuñat
f2ff2022e6 Update spanish translation of user manual to english eed9a4b
Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-11-01 11:06:50 -08:00
Guillaume GARDET
94207fa8d7 Documentation: update french translation of user-manual
Signed-off-by: Guillaume GARDET <guillaume.gardet@free.fr>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-10-29 08:34:48 -07:00
Sergey Starosek
906b2c2288 Documentation: update russian translation of user manual to english eed9a4b0
Signed-off-by: Sergey Starosek <sergey.starosek@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-10-29 08:33:51 -07:00
Dirk Hohndel
dfc1e36c0e Adjust asciidoc invocation to build latest manual
We shouldn't need to set the stylesdir - instead doing so makes us not
find the toc.css file.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-10-28 07:50:38 +09:00
Willem Ferguson
eed9a4b0f2 User manual updates.
1) Put table of contents as a column on the left-hand side of the page
   instead of as part of the user manual text.
2) Correct a some typoss.
3) Add three sentences to the Bluetooth download section to deal with
   Bluetooth Pass Codes.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-10-27 21:52:33 +09: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
Robert C. Helling
0f63b524a6 Mention Shearwater Nerd
alongside Petrell 2 since this seems to be the same computer internally.

Signed-off-by: Robert C. Helling <helling@atdotde.de>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-10-18 17:37:49 -07:00
Dirk Hohndel
e276ef0998 Another update of user manual html files in git
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-10-14 05:58:13 -07:00
Sergey Starosek
d5e48de567 Documentation: update russian translation of user manual
Signed-off-by: Sergey Starosek <sergey.starosek@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-10-14 05:50:44 -07:00
Sergey Starosek
6817504f95 User manual tidy-up
Signed-off-by: Sergey Starosek <sergey.starosek@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-10-14 05:50:27 -07:00
Salvador Cuñat
37e54f490d Update spanish translation of user manual to english 8d546bc
[Dirk Hohndel: also update the html git version]

Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-10-13 19:28:56 -07:00
Dirk Hohndel
c7c686f730 Update user manual html files included in the sources
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-10-13 13:19:27 -07:00
Guillaume GARDET
409df339b8 Documentation: update french translation of user-manual
Signed-off-by: Guillaume GARDET <guillaume.gardet@free.fr>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-10-13 11:52:23 -07:00
Willem Ferguson
8d546bc8c0 User manual: last changes before V4.5
1) Run a spell checker through the user manual. Only three
   outright typos found!!
2) Correct sentence about reverse name lookup that results in
   dive site name reported in tags field, not in Location field.
   (Sergey, thank you!)

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-10-13 08:46:54 -07:00
Willem Ferguson
846a4ce319 User manual update: Facebook
1) Update the image relating to fb access
2) Update the text relating to fb access
3) Update text about imgae fingerprints
4) Replace 6 more images to reflect latest UI

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-10-13 07:50:15 -07:00
Willem Ferguson
b2deb28f58 User manual updates: Dive site management and others
1) Update the text on dive site management to make it cohesive.
2) Update text on recreational dive planning.
3) Replace one image for rectreational dive planning.
4) Perform several small changes to correct inaccuracies
   or inconsistencies pointed out by Sergey.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-10-12 12:54:56 -07:00