aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/user-manual.txt
AgeCommit message (Collapse)Author
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>
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-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>
2015-11-23Last set of updates to the user manual in this roundGravatar Wendie Fisher
Once again focus on language and readability. Signed-off-by: Wendie Fisher <wendie@divedad.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-11-12Next batch of language updates for the user manualGravatar Wendie Fisher
Signed-off-by: Wendie Fisher <wendie@divedad.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-11-06Updates to the user manualGravatar Wendie Fisher
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>
2015-10-27User manual updates.Gravatar Willem Ferguson
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>
2015-10-19User manual updatesGravatar Willem Ferguson
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>
2015-10-18Mention Shearwater NerdGravatar Robert C. Helling
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>
2015-10-14User manual tidy-upGravatar Sergey Starosek
Signed-off-by: Sergey Starosek <sergey.starosek@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-10-13User manual: last changes before V4.5Gravatar Willem Ferguson
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>
2015-10-13User manual update: FacebookGravatar Willem Ferguson
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>
2015-10-12User manual updates: Dive site management and othersGravatar Willem Ferguson
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>
2015-10-12User manual: Print dive logsGravatar Willem Ferguson
--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 &lt;<a href="mailto:willemferguson@zoology.up.ac.za">willemferguson@zoology.up.ac.za</a>&gt;<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>
2015-10-12User manual: Preferences panels.Gravatar Willem Ferguson
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>
2015-10-09Remove UTF BOM from user manual filesGravatar Sergey Starosek
Signed-off-by: Sergey Starosek <sergey.starosek@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-10-09User manual spelling fixes and tidy-upGravatar Sergey Starosek
Signed-off-by: Sergey Starosek <sergey.starosek@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-09-27user manual: Bluetooth douwnloadGravatar Willem Ferguson
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>
2015-09-25User manual update: Bluetooth sectionGravatar Claudiu Olteanu
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>
2015-09-24User manual update: Put back manual Bluetooth proceduresGravatar Willem Ferguson
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>
2015-09-23User manual systematic review (Part 4)Gravatar Willem Ferguson
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>
2015-09-22User manual: Bluetooth UI descriptionGravatar Willem Ferguson
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>
2015-09-21User manual update 1) replace three images 2) change text of user manual to ↵Gravatar Willem Ferguson
reflect the three images correctly Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-09-21Systematic user manual update (Part 3)Gravatar Willem Ferguson
From DiveList section to printing section Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-09-16User manual: Systematic review (part 2)Gravatar Willem Ferguson
As the title says. Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-09-16Unify use of Bühlmann spelling in user-manual.txtGravatar Salvador Cuñat
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>
2015-09-16Updates: user manual review (part 1)Gravatar Willem Ferguson
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>
2015-09-14User manual update: Cloud servicesGravatar Willem Ferguson
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>
2015-09-14User manual update: Dive plannerGravatar Willem Ferguson
1) Added text to reflect VPM-B dive planning 2) Replaced 5 images in dive planner chapter. Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-09-10Document simplified web access to cloud storage dataGravatar Dirk Hohndel
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>
2015-09-08User manual update: Location managementGravatar Willem Ferguson
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>
2015-09-07Updates to user manual: dive log printing and APD CCR importGravatar Willem Ferguson
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>
2015-08-31A few more version number updatesGravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-08-31QML UI: Documentation: Introduce the appGravatar Grace Karanja
Basic documentation on how to log into the app and how to load dives, view them, edit and save changes. [Dirk Hohndel: heavily edited commit to remove all the unintended changes] Signed-off-by: Grace Karanja <gracie.karanja89@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-08-22Printing: update the user-manualGravatar Gehad elrobey
Add printing description to the user-manual, also add appendix F which describes how to write a custom template for Subsurface. Signed-off-by: Lubomir I. Ivanov <neolit123@gmail.com> Signed-off-by: Gehad elrobey <gehadelrobey@gmail.com>
2015-08-03Add FAQ item of missing logs to user manualGravatar Miika Turkia
[Dirk Hohndel: added corresponding entry to the FAQ] Signed-off-by: Miika Turkia <miika.turkia@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-07-27User Manual: Slight changes on OSTCTools importGravatar Salvador Cuñat
Don't give sensation that OSTCTools is a H&W software, which it isn't. Little adds on supported DCs and other considerations. Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-07-23Update user manual to reflect new way of DivingLog importGravatar Miika Turkia
Signed-off-by: Miika Turkia <miika.turkia@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-06-14User manual: first stab at documentation of Subsurface cloud storageGravatar Dirk Hohndel
This needs screenshots and better wording, but it's a start. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-05-26Correct default RFCOMM channel in documentationGravatar Rick Walsh
The default RFCOMM channel is 1, not 0 as previously stated in FAQ and user manual. This patch corrects it. Signed-off-by: Rick Walsh <rickmwalsh@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-05-23User manual: update section on BluetoothGravatar willem ferguson
User manual: update section dealing with Bluetooth communication to reflect Rick's recent contribution. Some editing of the text was performed to conform to Manual style. This section looks MUCH better now. Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-05-18A few small changes to the user manual:Gravatar willem ferguson
1) Descriptions of main menu items. 2) Windows drivers for the galileo dive computer. Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-05-02User manual updateGravatar willem ferguson
This adds text to the following sections: 1) Dive planner (Open circuit planning) 2) Dive Planner (Recreational OC planning) 3) Use of hashes to move images between directories 4) Undo/Redo feature of dive list manipulations One image in planner text is modified. Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-05-02User manual update: OSTC Tools integrationGravatar willem ferguson
Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-04-30Add text to user manual: Recreational dive planning One figure has been addedGravatar willem ferguson
Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-04-26Update of user manual text dealing with dive list context menuGravatar willem ferguson
As the title says above Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-02-14Rename the tab "Dive info" to "Info", and "Dive notes" to "Notes"Gravatar Henrik Brautaset Aronsen
Signed-off-by: Henrik Brautaset Aronsen <subsurface@henrik.synth.no> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-02-10Add missing Atomic Aquatics logoGravatar Sergey Starosek
Signed-off-by: Sergey Starosek <sergey.starosek@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>