aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation
AgeCommit message (Collapse)Author
2017-01-02Update spanish translation of user manual to english b5f0a4a0Gravatar Salvador Cuñat
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>
2016-12-31Fix a bunch of typosGravatar Salvador Cuñat
Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
2016-12-31Update spanish translation of user manual to english 91a13aeGravatar Salvador Cuñat
Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
2016-12-30README: Switch from trac & email patches to GitHub PRs & issuesGravatar Henrik Brautaset Aronsen
Ref. http://lists.subsurface-divelog.org/pipermail/subsurface/2016-December/026860.html Signed-off-by: Henrik Brautaset Aronsen <subsurface@henrik.synth.no>
2016-12-04Documentation: update/merge french translationsGravatar Guillaume GARDET
Signed-off-by: Guillaume GARDET <guillaume.gardet@free.fr> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-12-04User manual updateGravatar Willem Ferguson
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>
2016-11-09Update bundled user-manual HTML filesGravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-11-09Update spanish translation of user manual to english 3f060c5Gravatar Salvador Cuñat
- 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>
2016-11-09User manual routine update (3)Gravatar Willem Ferguson
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>
2016-11-05User manual: replace heatmap comparison graphicGravatar Rick Walsh
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>
2016-11-05Routine maintenance of user manual (2)Gravatar Willem Ferguson
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>
2016-11-01User manual: remove some passive voiceGravatar Dirk Hohndel
This makes the manual a bit more friendly to read... Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-11-01User manual: routine maintenanceGravatar Willem Ferguson
Restore headings, improve sentence readability. Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-10-27User-manual: More updated to heat mapGravatar Willem Ferguson
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>
2016-10-27User-manual: Heat mapGravatar Willem Ferguson
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>
2016-10-20Updates to the text of the user manual that deals with heat maps.Gravatar Willem Ferguson
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-10-11Subsurface User Manual: Update section dealing with heat map. Move section ↵Gravatar Willem Ferguson
about Information Box lower down in user manual. Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-10-11Documentation: Merge french translationsGravatar Guillaume GARDET
Signed-off-by: Guillaume GARDET <guillaume.gardet@free.fr> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-10-03User manual: actually add new imagesGravatar Rick Walsh
Signed-off-by: Rick Walsh <rickmwalsh@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-09-27User manual: include tissue heatmap graphicsGravatar Rick Walsh
Signed-off-by: Rick Walsh <rickmwalsh@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-09-27Document the heat map in the manual.Gravatar Robert C. Helling
Signed-off-by: Robert C. Helling <helling@atdotde.de> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-09-04Update Subsurface-mobile manual stored in gitGravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-09-04Update Subsurface-mobile manualGravatar Dirk Hohndel
Correctly differentiate Android and iOS features. Adapt style to be generally in the second person. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-08-17scripts: run all scripts with -eGravatar Anton Lundin
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>
2016-08-10User manual: fix typoGravatar Rick Walsh
Signed-off-by: Rick Walsh <rickmwalsh@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-08-10User manual: describe cylinder fields Deco switch at, Bot MOD and MNDGravatar Rick Walsh
Signed-off-by: Rick Walsh <rickmwalsh@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-07-23Documentation: update french translation of user-manual and mobile-manualGravatar Guillaume GARDET
Signed-off-by: Guillaume GARDET <guillaume.gardet@free.fr> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-07-23Remove unused image from mobile user manualGravatar Willem Ferguson
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-06-20User manual update: Subsurface-mobileGravatar Willem Ferguson
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>
2016-06-20Tuning the mobile-manualGravatar Miika Turkia
Signed-off-by: Miika Turkia <miika.turkia@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-06-20Enable creation of mobile-manualGravatar Miika Turkia
Signed-off-by: Miika Turkia <miika.turkia@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-06-18Corrections to user manualGravatar Willem Ferguson
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>
2016-06-18User Manual updateGravatar Willem Ferguson
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>
2016-06-18Update to mobile user manualGravatar Willem Ferguson
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>
2016-06-18Update to user manual for Subsurface-mobile with ten additional images.Gravatar Willem Ferguson
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-03-16Don't use CRLF in documentation filesGravatar Dirk Hohndel
Suggested-by: Linus Torvalds <torvalds@linux-foundation.org> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-03-13mobile-manual - Update authors, dates and soGravatar Salvador Cuñat
Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-03-13Spanish translation for mobile-manual.txtGravatar Salvador Cuñat
[Dirk Hohndel: also added an html version] Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-03-12Documentation: add mobile user manual to POT/PO management and update french ↵Gravatar Guillaume GARDET
translation of user-manual and mobile-manual Signed-off-by: Guillaume GARDET <guillaume.gardet@free.fr> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-03-10Small update to the mobile user manualGravatar Dirk Hohndel
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>
2016-03-09Mobile - Update user manual for Subsurface-mobileGravatar Willem Ferguson
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>
2016-03-04Rewrite the Subsurface-mobile user manualGravatar Dirk Hohndel
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>
2016-02-29user-manual.txt: mention some more Grantlee variablesGravatar Lubomir I. Ivanov
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>
2016-02-09Mobile user-manual: Add text that explains action buttonGravatar Willem Ferguson
4 small images added. Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> From 43f260e7aa2be9af43c9250f75cad05a141f9d1e Mon Sep 17 00:00:00 2001 From: Willem Ferguson <willemferguson@zoology.up.ac.za> Date: Tue, 9 Feb 2016 12:25:24 +0200 Subject: [PATCH 2/2] [PATCH] Mobile user-manual: add section explaining action button Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-02-08Short first attempt at a user manual for Subsurface-mobileGravatar Willem Ferguson
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-12-28Improve group information on USB deviceGravatar Miika Turkia
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>
2015-12-16Update the bundled htlm user manualGravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-12-16Corrected a typo in the User ManualGravatar Pedro Neves
Signed-off-by: Pedro Neves <nevesdiver@gmail.com> A small typo was corrected. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-12-02user-manual.txt: modifications related to Grantlee variablesGravatar Lubomir I. Ivanov
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>
2015-11-28User manual: add missing empty lineGravatar Dirk Hohndel
This way the ASCIIDOC works as expected and creates the numbered list. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>