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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
