aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/user-manual.txt
AgeCommit message (Collapse)Author
2018-07-13[user-manual] Update SmartTrak import informationGravatar Salvador Cuñat
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-04Manual: Adapt description of "find moved images" functionalityGravatar Berthold Stoeger
Adapt description and add example image. Signed-off-by: Berthold Stoeger <bstoeger@mail.tuwien.ac.at>
2018-06-01user-manual: add note that some Grantlee variables need '|safe'Gravatar Lubomir I. Ivanov
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-05-31User Manual: add text for bailout using PSCRGravatar Willem Ferguson
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-28User manual: Add text for dive planning CCR with bailoutGravatar Willem Ferguson
Three images added as well as text. Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
2018-05-17Update user manual for CCR and pSCR dive logsGravatar Willem Ferguson
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-04-11Add a paragraph to the user manual about ICD in infoboxGravatar Robert C. Helling
Signed-off-by: Robert C. Helling <helling@atdotde.de>
2018-01-26Update of some sections of user manual.Gravatar Willem Ferguson
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>
2017-12-01Document background computation of variationsGravatar Robert C. Helling
Update changelog, update user manual, clarify meaning in dive notes. Signed-off-by: Robert C. Helling <helling@atdotde.de>
2017-11-28Rename "tank bar" to "gas bar" in EN documentation sourceGravatar Stefan Fuchs
Signed-off-by: Stefan Fuchs <sfuchs@gmx.de>
2017-11-13Remove option to apply GFlow at maxdepth in documentationGravatar Stefan Fuchs
Option was removed some time ago: 5b080beddef3e08b86eb53448e737b4867a50c1a Signed-off-by: Stefan Fuchs <sfuchs@gmx.de>
2017-11-04Fix user-manual syntax to work with a2xGravatar Miika Turkia
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
2017-11-03documentation: remove the --win32* argumentsGravatar Lubomir I. Ivanov
Signed-off-by: Lubomir I. Ivanov <neolit123@gmail.com>
2017-10-21user-manual: 1 letter typoGravatar Jan Mulder
dice -> dive Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-10-21user manual: re-correct pSCR wordingGravatar Jan Mulder
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-21Try to be consistent with American spellingGravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2017-10-21User manual spelling errorsGravatar Willem Ferguson
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-21Small edits to user manual V4.7Gravatar Willem Ferguson
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-21user manuals: EN and NL, changed for Subsurface-mobileGravatar Jan Mulder
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-20user manual: typos and whitespaceGravatar Jan Mulder
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-20user manual: re-correct pSCR wordingGravatar Jan Mulder
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-20Update to latest user manualGravatar Willem Ferguson
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2017-10-19Desktop user manual update for V4.7Gravatar Willem Ferguson
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-09-29Paragraph in manual about off-gassingGravatar Robert C. Helling
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-05-26Reflect the gas density display in the user manualGravatar Robert C. Helling
Signed-off-by: Robert C. Helling <helling@atdotde.de>
2017-04-12user manual: five trivial typosGravatar Jan Mulder
five trivial typos corrected Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-04-12user manual: some more graph -> profile renamesGravatar Jan Mulder
And found some more graph -> profile strings to be renamed. Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-04-12user manual: sync command line optionsGravatar Jan Mulder
Sync the command line opions with 4.6.3 (added win32log) Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-04-12user manual: print a dive planGravatar Jan Mulder
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-03-24user manual: Preferences Defaults renamed to GeneralGravatar Jan Mulder
See commit 25dcee139e. Preferences Defaults renamed to General. Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-24user manaul: Preferences Graph renamed to profileGravatar Jan Mulder
See commit 6305361d1477. Graph is renamed to Profile. Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-24user manual: pSCR diving is similar to OC, not CCRGravatar Jan Mulder
See also commit acb38c9e00f2. 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-24user manual: weird and incorrect paragraphGravatar Jan Mulder
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-24user manual: waypoints on profile can be moved using arrow keysGravatar Jan Mulder
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-24user manual: do not repeatGravatar Jan Mulder
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-24user manual: p02 setting in Available Gases dialog is not possibleGravatar Jan Mulder
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-24user manual: set of small changes in planner textGravatar Jan Mulder
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-24user manual: section is called ProxyGravatar Jan Mulder
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-24user manual: changed unclear wording (network preferences)Gravatar Jan Mulder
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-24user manual: typoGravatar Jan Mulder
trivial 1 letter typo. Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-24user manual: spell O2 correctlyGravatar Jan Mulder
Spell (p)O2 correctly with a subscript. Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-17user manual: code changes influencing manual (Preferences)Gravatar Jan Mulder
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-17user manual: update list of supported dive computers to configureGravatar Jan Mulder
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-17user manual: be less verbose on DropboxGravatar Jan Mulder
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-17user manual: dive list instead of dive profileGravatar Jan Mulder
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-17user manual: improved wordingGravatar Jan Mulder
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-17user manual: remove paragraphGravatar Jan Mulder
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-17user manual: TTS does not depend on SACGravatar Jan Mulder
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-17user manual: info box does not changeGravatar Jan Mulder
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-17user manual: pSCR is not driven from back gas by defaultGravatar Jan Mulder
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>