Commit graph

796 commits

Author SHA1 Message Date
Dirk Hohndel
7708492232 user manual: update bundled HTML of Spanish translation
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2018-09-28 15:23:56 -07:00
Dirk Hohndel
f46d914ca8 Update HTML versions of manuals
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2018-09-23 11:49:30 -07:00
Dirk Hohndel
7dbe863f10 User manual: describe the DC shortcut buttons for mobile
It would be great to have a corresponding screen shot.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2018-09-23 11:49:30 -07:00
Dirk Hohndel
5b74fe1dc5 User manual: describe the DC shortcut buttons
It would be great to have a corresponding screen shot.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2018-09-23 11:49:30 -07:00
Salvador Cuñat
1a7d9881af [user-manual_es] Update to english 2a47e60c8
Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
2018-09-22 08:37:15 -07:00
Dirk Hohndel
4fc0d9ee13 User manual: update bundled HTML
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2018-09-19 08:06:03 -07:00
Jan Mulder
a3cf62af8d Documentation: major update of NL user manual
As the base EN user manual went forward, the NL translation was hardly
updated fror almost a year. Do I took all the changes over this period
and corrected the NL translation accordingly. So, its synced and up-to-date
to version 4.8.2 of the software (assuming the EN version is).

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2018-09-18 10:37:21 -07:00
Jan Mulder
2a47e60c8c Documentation: tiny fix in US user manual
Commit a4f04589c7 did forget to delete 1 line related the
Companion app. Deleted here.

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2018-09-18 10:37:21 -07: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
Dirk Hohndel
8fbcb4309b user manual: one more update to the latest HTML
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2018-09-16 08:17:01 -07: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
Robert C. Helling
84480aa201 Manual entry of export anonymization
This should be accompanied by an updated screen shot.

Signed-off-by: Robert C. Helling <helling@atdotde.de>
2018-09-16 08:10:44 -07:00
Dirk Hohndel
9e8afe90d9 user manual: update dates and add latest HTML
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2018-09-16 08:04:24 -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
Jan Mulder
3ce75739b7 User manual: update menu section
Update menu section for removes menu options. And fixed a lefover
edit in this area.

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2018-09-16 07:47:02 -07:00
Berthold Stoeger
3ff756f6de user manual: some more photos -> media replacements
Signed-off-by: Berthold Stoeger <bstoeger@mail.tuwien.ac.at>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2018-09-15 18:17:40 -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
Dirk Hohndel
10c94f1f68 Update HTML versions of user manuals
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2018-09-15 16:07:22 -07:00
Dirk Hohndel
23e97865f6 Manuals: fix asciidoc errors
These caused easy to miss build failures when creating HTML versions.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2018-09-15 16:07:22 -07:00
Salvador Cuñat
3c1b6d9ec1 [user-manual] Update SmartTrak import information
The information on how to build smtk2ssrf was pretty outdated.
Update this information and point to subsurface downloads repo for
windows installer and linux appimage.

Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
2018-07-13 16:18:31 +03:00
Salvador Cuñat
3ec508cdcd user-manual: Update Spanish translation to f3db29846
Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
2018-07-09 15:23:38 -07:00
Salvador Cuñat
f24f99a80a user-manual: Update Spanish translation to English 220905422
Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
2018-07-09 09:25:05 -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
Guillaume GARDET
65e823b21d Documentation: update french manuals
Signed-off-by: Guillaume GARDET <guillaume.gardet@opensuse.org>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2018-06-26 14:26:17 -07:00
Lubomir I. Ivanov
2209054226 user-manual: add note that some Grantlee variables need '|safe'
Grantlee variables need the '|safe' extension, so that they can use
HTML tags. Without it, tags like '<br>' would not be converted to line
breaks - e.g. when exporting planned dive notes.

Add a note about that in the user manual.

Signed-off-by: Lubomir I. Ivanov <neolit123@gmail.com>
2018-06-01 21:38:01 +03: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
Robert C. Helling
ac2ceeafb7 Add a paragraph to the user manual about ICD in infobox
Signed-off-by: Robert C. Helling <helling@atdotde.de>
2018-04-11 21:15:38 +02:00
Guillaume GARDET
6d679931d0 Documentation: update french translation of manuals 2018-02-07 12:58:28 -08:00
Roman Romanchuk
50b35e4272 Fixed typos in russian translation of manual.
Signed-off-by: Roman Romanchuk <roman.romanchuk@me.com>
2018-02-07 10:11:08 +01: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
Dirk Hohndel
ea1256003e Add pre-rendered mobile-manual.html.git
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2017-12-04 22:05:09 -08:00
Dirk Hohndel
76c99de231 Subsurface-mobile user manual update
Describe the slightly different (but now far more similar) feature sets between
Android and iOS.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2017-12-04 22:04:08 -08:00
Robert C. Helling
d8350ef238 Document background computation of variations
Update changelog, update user manual, clarify
meaning in dive notes.

Signed-off-by: Robert C. Helling <helling@atdotde.de>
2017-12-01 15:47:51 -08:00
Stefan Fuchs
d500969918 Rename "tank bar" to "gas bar" in EN documentation source
Signed-off-by: Stefan Fuchs <sfuchs@gmx.de>
2017-11-28 20:22:07 +01:00
Guillaume GARDET
61771264bd Documentation: Merge and update french translations
Signed-off-by: Guillaume GARDET <guillaume.gardet@free.fr>
2017-11-28 13:53:14 +01:00
Stefan Fuchs
fd2e24d145 Remove option to apply GFlow at maxdepth in documentation
Option was removed some time ago:
5b080bedde

Signed-off-by: Stefan Fuchs <sfuchs@gmx.de>
2017-11-13 11:53:55 +01:00
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
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