aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/user-manual.txt
AgeCommit message (Collapse)Author
2020-01-06update CHANGELOG and insert placeholder in user manualGravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2019-11-28Add current GF to infoboxGravatar Robert C. Helling
As per request from users on scubaforum.com, this adds the current gradient factor to the deco information of the infobox. Up to now, this information was only graphically represented in the pressure bar graph and the heatmap. This gives a numerical value. Signed-off-by: Robert C. Helling <helling@atdotde.de>
2019-10-31Planner: Add option to treat O2 as narcoticGravatar Robert C. Helling
When computing the best mix for a target depth, for helium, one can either require that the partial pressure of N2 is the same as at the target depth or the partial pressure of N2 plus O2. Signed-off-by: Robert C. Helling <helling@atdotde.de>
2019-08-08Desktop user manual: dc managementGravatar willemferguson
The relevant text in the present manual is obsolete. Update the text dealing with dive profiles from several sive computers for one specific dive. One image is added. Deal with creating a new cylinder type. Signed-off-by: willemferguson <willemferguson@zoology.up.ac.za>
2019-07-13user manual: update the bundled html versionGravatar Dirk Hohndel
And fix the date to say July. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2019-07-12Updates to user manual (update 3 of 3)Gravatar willemferguson
Replace four images in section 5.2.5 Update text to reflect the undo mechanism. This mostly involved removing obsolete text. Signed-off-by: willemferguson <willemferguson@zoology.up.ac.za>
2019-07-12User manual: updates to undo descriptionGravatar Dirk Hohndel
And some trailing space removal. The text on editing dives hopefully is more accurate and easier to understand. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2019-07-06Update user manual (2 of 3)Gravatar willemferguson
Small updates and corrections to existing text Replaced four images to reflect the current UI Signed-off-by: willemferguson <willemferguson@zoology.up.ac.za>
2019-06-26User manual update (update 1 of 3)Gravatar willemferguson
Text has been added for the undo facility and for the specification of atmospheric pressure. Two images added. Signed-off-by: willemferguson <willemferguson@zoology.up.ac.za>
2019-06-03Update usermanualGravatar Robert C. Helling
... to reflect new wording of menu entry. Signed-off-by: Robert C. Helling <helling@atdotde.de>
2019-05-29Extended user manual explanation of green ceilingGravatar Robert C. Helling
as a response on a recent discussion on scuba board. Signed-off-by: Robert C. Helling <helling@atdotde.de>
2019-05-05Desktop user manual update: dive site managementGravatar willemferguson
Include text about dive site management. 5 new figures are introduced. Writing this enabled me to appreciate just how much time must have gone into writing the code. Signed-off-by: willemferguson <willemferguson@zoology.up.ac.za>
2019-04-16Write dive data as video subtitlesGravatar Robert C. Helling
This commit adds an entry to the dive media context menu which offers to write a subtitle file. This creates an .ass file for the selected videos. In an attempt to to clutter the screen too much, don't show irrelevant entries (zero temperature or NDL and show TTS only for dives with stops). VLC is able to show these subtitles directly, they can be integrated into the video file with ffmpeg. Signed-off-by: Robert C. Helling <helling@atdotde.de>
2019-03-05User manual: Text for Filter ToolGravatar willemferguson
The description of the Filter tool is brought up to date. One image is replaced elsewhere in the manual to reflect the new Subsurface window top bar that indicates number of dives. In total, 4 images added and text for user-manual updated. The location of the filter text in the usermanual has been changed. Signed-off-by: willemferguson <willemferguson@zoology.up.ac.za>
2019-02-10Changes to user manual (V4.8.4)Gravatar willemferguson
1) remove Facebook integration (Dirk) 2) rewrite section about filter (Dirk) 3) insert section about bailout checkbox (Robert) 4) finalise section about surface GF in info box (Robert) 5) add export of profile graphic to .png (Robert) 6) update import of dives using universal import dialog (Miika) 7) some typos corrected and Robert's requests implemented 8) Factual info as wellas typos and corrections raised by Miika and Dirk Signed-off-by: willemferguson <willemferguson@zoology.up.ac.za>
2019-02-07Export profile imageGravatar Robert C. Helling
With Facebook support gone, we should offer a way to export the profile image. This has been part of the TeX support but this makes it explicit. Signed-off-by: Robert C. Helling <helling@atdotde.de>
2019-02-05Add button to toggle deco info in info boxGravatar Robert C. Helling
The info box can get longish. Offer the user to turn off display of deco information (surface GF and individual ceilings). Signed-off-by: Robert C. Helling <helling@atdotde.de>
2019-02-05Explain surface GF value in user manualGravatar Robert C. Helling
Signed-off-by: Robert C. Helling <helling@atdotde.de>
2019-02-01facebook: remove the featute from the code baseGravatar Lubomir I. Ivanov
Remove from: - unit tests - desktop widgets - preferences - core intergration - cmakefiles - build scripts - icons - docs Also remove the plugins and social network integration. Signed-off-by: Lubomir I. Ivanov <neolit123@gmail.com>
2018-11-01user-manual: add notes about state of BTLE on WindowsGravatar Lubomir I. Ivanov
Add an "important" message that the support is experimental and that the latest version of Windows 10 and drivers is needed. Signed-off-by: Lubomir I. Ivanov <neolit123@gmail.com>
2018-09-23User manual: describe the DC shortcut buttonsGravatar Dirk Hohndel
It would be great to have a corresponding screen shot. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2018-09-18Documentation: tiny fix in US user manualGravatar Jan Mulder
Commit a4f04589c7d did forget to delete 1 line related the Companion app. Deleted here. Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2018-09-16user manual: additional updates and new imagesGravatar willemferguson
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-16Manual entry of export anonymizationGravatar Robert C. Helling
This should be accompanied by an updated screen shot. Signed-off-by: Robert C. Helling <helling@atdotde.de>
2018-09-16user manual: update dates and add latest HTMLGravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2018-09-16User manual: get rid of Companion app textsGravatar Jan Mulder
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-16User manual: update menu sectionGravatar Jan Mulder
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-15user manual: some more photos -> media replacementsGravatar Berthold Stoeger
Signed-off-by: Berthold Stoeger <bstoeger@mail.tuwien.ac.at> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2018-09-15user manual: updates for media supportGravatar willemferguson
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-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>