Commit graph

657 commits

Author SHA1 Message Date
Miika Turkia
e3580eda6f Fix user-manual syntax to work with a2x
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
2017-11-04 14:22:09 +01:00
Lubomir I. Ivanov
0a1c559c15 documentation: remove the --win32* arguments
Signed-off-by: Lubomir I. Ivanov <neolit123@gmail.com>
2017-11-03 07:49:11 -07:00
Salvador Cuñat
215f61175d mobile-manual_es: Update translation to daac80b7 2017-10-28 13:10:13 +02:00
Dirk Hohndel
2c67b387ea Update the rendered version of Spanish Subsurface-mobile manual
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2017-10-25 07:17:09 +02:00
Jan Mulder
daac80b7bd user-manual: 1 letter typo
dice -> dive

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-10-21 20:53:37 +02:00
Jan Mulder
9c2e3768ec user manual: re-correct pSCR wording
Unsure where and why this got changed in the update to 4.7.

In pSCR world, the gas that is currently driving the rebreater is
called a "driving gas". This is not per definition backgas, as any
gas can be plugged in by means of a swichblock.

Further. The gas that is trown away (typically 10%) is released
from the unit at inhale of the diver. Yes, this may sound weird
to the average OC diver, but it is like that. It's by design.

All this wisdom from a GUE trained RB80 diver :-)

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-10-21 20:53:37 +02:00
Dirk Hohndel
deeeaf09f9 Try to be consistent with American spelling
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2017-10-21 14:13:47 -04:00
Willem Ferguson
f489af22c1 User manual spelling errors
I finaly got a a spelling checker that operates on asciidoc files.
I am relieved that this only found about a dozen spelling errors
in the whole text.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2017-10-21 14:10:55 -04:00
Willem Ferguson
957ff68814 Small edits to user manual V4.7
Small edits, typos and responses to comments of other developers.
One image replaced.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2017-10-21 14:09:37 -04:00
Guillaume GARDET
cbfef6e367 Documentation: Merge and update french translations
Signed-off-by: Guillaume GARDET <guillaume.gardet@free.fr>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2017-10-21 06:11:19 -04: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
Dirk Hohndel
3f5396efdd Update bundled HTML user manual
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2017-10-20 16:28:07 -04:00
Jan Mulder
ab6d9405aa user manual: typos and whitespace
Updating the UM in NL, and carefully scrutenizing all changes
made in the base English version, I found some trivial typos and
some trailing whitespace (that my atom editor nicely removes).

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-10-20 16:10:59 -04:00
Jan Mulder
8dbf46fe8f user manual: re-correct pSCR wording
Unsure where and why this got changed in the update to 4.7.

In pSCR world, the gas that is currently driving the rebreater is
called a "driving gas". This is not per definition backgas, as any
gas can be plugged in by means of a swichblock.

Further. The gas that is trown away (typically 10%) is released
from the unit at inhale of the diver. Yes, this may sound weird
to the average OC diver, but it is like that. It's by design.

All this wisdom from a GUE trained RB80 diver :-)

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-10-20 16:10:59 -04:00
Jan Mulder
eb838b79ca user manual NL: update
TDB

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-10-20 16:10:59 -04: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
Salvador Cuñat
59845c1343 mobile-manual_es.txt: updates up to 8b01758e
Update spanish translation of mobile-manual to git 8b01758e of the
english version.
2017-10-18 19:16:43 +03:00
Guillaume GARDET
ae87985b8f Documentation: Merge and update french translations
Signed-off-by: Guillaume GARDET <guillaume.gardet@free.fr>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2017-10-16 05:37:21 -04:00
Guillaume GARDET
aa7e78611e Documentation: Merge and update french translations
Signed-off-by: Guillaume GARDET <guillaume.gardet@free.fr>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2017-10-14 04:00:54 -07:00
Dirk Hohndel
f7d120e39c Update bundled versiomn of the Subsurface-mobile manual
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2017-10-11 16:49:40 -07:00
Dirk Hohndel
8b01758ecf Subsurface-mobile user manual: many small adjustments
Tweak some of the explanations, expand a few sections a bit more, overall try
to make the user manual even more comprehensive.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2017-10-11 16:47:09 -07:00
Dirk Hohndel
c942f32633 Subsurface-mobile user manual: spelling corrections
Some of these are undeniably typos, others (sorry) are simply en-US
updates for consistency.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2017-10-11 16:47:09 -07:00
Dirk Hohndel
26ba57d3a8 Update included version of mobile user manual
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2017-10-11 05:57:51 -07:00
Willem Ferguson
99418b09c6 Update Subsurface-mobile user manual for v2
Many updates for the new UI and new features.
Completely replaced all the pictures.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2017-10-11 05:51:15 -07:00
Robert C. Helling
e903c6bd1a Paragraph in manual about off-gassing
The VPM-B model assumes off-gassing only happens during ascent
which for us are that part of the dive where dp->entered is
false. This is wrong for dives with manually entered waypoints
in the ascent, as discussed in

See #601.

Signed-off-by: Robert C. Helling <helling@atdotde.de>
2017-09-29 01:02:55 +03:00
Philippe Massart
9dd8726d12 Updated French documentation
This is a manually created single commit to incorporate the changes in
https://github.com/Subsurface-divelog/subsurface/pull/502

Closes #502

[Dirk Hohndel:]
I was able to manually merge that branch but it created a complete mess
out of the tree and brought several dozen commits in a second time, so
I gave up and instead created this single commit.

Signed-off-by: Philippe Massart <philippe@philmassart.net>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2017-09-20 09:25:46 -07:00
Philippe Massart
987fadcfb5 French documentation translation
Mostly documentation about manually added dive.

Signet-off-by: Philippe Massart <philippe@philmassart.net>
2017-07-11 22:18:00 +09:00
Philippe Massart
271a57b2ff French translation (more to come) 2017-07-11 22:18:00 +09:00
Willem Ferguson
a5bb8ae2b7 Update Subsurface-mobile user manual
[Dirk Hohndel: collapsed all of the commits into one]

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2017-07-08 14:38:29 -07:00
Guillaume GARDET
2693735bb7 Documentation: Merge and update french translations
Signed-off-by: Guillaume GARDET <guillaume.gardet@free.fr>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2017-07-04 07:48:28 -07: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
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