Commit graph

454 commits

Author SHA1 Message Date
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
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
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
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
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
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
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
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
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
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
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
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
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
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