aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation
AgeCommit message (Collapse)Author
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-22[user-manual_es] Update to english 2a47e60c8Gravatar Salvador Cuñat
Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
2018-09-19User manual: update bundled HTMLGravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2018-09-18Documentation: major update of NL user manualGravatar Jan Mulder
As the base EN user manual went forward, the NL translation was hardly updated fror almost a year. Do I took all the changes over this period and corrected the NL translation accordingly. So, its synced and up-to-date to version 4.8.2 of the software (assuming the EN version is). Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
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-17User Manual: scale recently changed imageGravatar Jan Mulder
The MobileGpsMenu.jpg image was way to big in the generated html and pdf versions of the manual. Corrected here. Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2018-09-16user manual: one more update to the latest HTMLGravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
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: replace screendumpsGravatar Willem Ferguson
Replace a very outdated screendump related to Preferences-Network, and one for the new anonimize export option. Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Jan Mulder <jlmulder@xs4all.nl> 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-09-15Update HTML versions of user manualsGravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2018-09-15Manuals: fix asciidoc errorsGravatar Dirk Hohndel
These caused easy to miss build failures when creating HTML versions. 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-09user-manual: Update Spanish translation to f3db29846Gravatar Salvador Cuñat
Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
2018-07-09user-manual: Update Spanish translation to English 220905422Gravatar Salvador Cuñat
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-26Documentation: update french manualsGravatar Guillaume GARDET
Signed-off-by: Guillaume GARDET <guillaume.gardet@opensuse.org> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
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-02-07Documentation: update french translation of manualsGravatar Guillaume GARDET
2018-02-07Fixed typos in russian translation of manual.Gravatar Roman Romanchuk
Signed-off-by: Roman Romanchuk <roman.romanchuk@me.com>
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-04Add pre-rendered mobile-manual.html.gitGravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2017-12-04Subsurface-mobile user manual updateGravatar Dirk Hohndel
Describe the slightly different (but now far more similar) feature sets between Android and iOS. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
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-28Documentation: Merge and update french translationsGravatar Guillaume GARDET
Signed-off-by: Guillaume GARDET <guillaume.gardet@free.fr>
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-28mobile-manual_es: Update translation to daac80b7Gravatar Salvador Cuñat
2017-10-25Update the rendered version of Spanish Subsurface-mobile manualGravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
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-21Documentation: Merge and update french translationsGravatar Guillaume GARDET
Signed-off-by: Guillaume GARDET <guillaume.gardet@free.fr> 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-20Update bundled HTML user manualGravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
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>