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>
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>
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>
This is a manually created single commit to incorporate the changes in
https://github.com/Subsurface-divelog/subsurface/pull/502Closes#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>
[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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
- 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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
[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>
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>
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>
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>
--001a11c260ce9093a70521eafe5d
Content-Type: text/plain; charset=UTF-8
[PATCH] User manual: Print dive logs
This patch replaces two figures in the user manual, concerning the
printing of dive logs.
1) Two images are replaced.
2) The text of the user manual is changed to reflect the latest code.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
<div dir="ltr"> [PATCH] User manual: Print dive logs<br> <br> This patch replaces two figures in the user manual, concerning the<br> printing of dive logs.<br> <br> 1) Two images are replaced.<br> <br> 2) The text of the user manual is changed to reflect the latest code.<br> <br> Signed-off-by: Willem Ferguson <<a href="mailto:willemferguson@zoology.up.ac.za">willemferguson@zoology.up.ac.za</a>><br><br></div>
From 2f0b54fe6e38014b909ed1d9c6acb797921a5158 Mon Sep 17 00:00:00 2001
From: Willem Ferguson <willemferguson@zoology.up.ac.za>
Date: Mon, 12 Oct 2015 18:37:54 +0200
Subject: [PATCH] [PATCH] User manual: Print dive logs
This patch replaces two figures in the user manual, concerning the
printing of dive logs.
1) Two images are replaced.
2) The text of the user manual is changed to reflect the latest code.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Six of the images in the text describing the Preferences are replaced
to reflect the latest code.
One addition image is added, describing georeferencing.
The text of the user manual is updated to reflect the new images.
Many typos are corrected.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Clean up the text on the above issue. Many thanks, Claudiu.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Update the user manual with information about the new Bluetooth
download mode feature.
Signed-off-by: Claudiu Olteanu <olteanu.claudiu@ymail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Put back the procedures for manually achieving a Bluetooth connection
into APPENDIX A.
Refer to the manual procedures from the text that described the new
built-in Subsurface Bluetooth interface.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
1) Delete section on mobile application
2) Update Preferences and Menu options sections
No images are added or replaced.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
1) Inser Bluetooth UI description at end of section dealing with dive download.
2) Delete existing text in appendices that detail pairing a Bluetooth device with
the Subsurface computer.
One image is added to the manual.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
From DiveList section to printing section
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Also modified user-manual_fr.txt.
Russian and spanish translations didn't have any occurrence of Buehlmann
nor Buhlmann.
Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Systematic review of existing text (part 1)
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
This ammends the existing text on cloud services.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
The backend now redirects you to the correct URL once you log in with your
email address and password. So all the user needs to know is to go to
https://cloud.subsurface-divelog.org
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
1) Add text to cover location management
2) Delete duplicate text for entering dives manually
and entering dives from a dive computer. The sections dealing
with location, cylinders, weights, and other items on the Info tab
were duplicated for these two types of data entry into Subsurface.
This duplication is now removed.
3) Replace five screen shots
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Updates to the APD import interface that Miika has recently completed.
Updates to reflect the new print interface. Added some images and modified
existing text.
Swapped APPENDIX E and APPENDIX F so that FAQs are at end of document.
Updated appendix [F] dealing with customising print templates.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Introducing mobile app
Updating manual version number and date
Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
