summaryrefslogtreecommitdiffstats
path: root/Documentation/user-manual.txt
AgeCommit message (Collapse)Author
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>
2015-02-10User manual spelling fixesGravatar Sergey Starosek
Signed-off-by: Sergey Starosek <sergey.starosek@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-02-05User manual: small updatesGravatar willem ferguson
A section on multicylinder dives has been added. Just to warm LongJohnSilver's heart, a short section on pSCR has been added. Please feel free to add to the pSCR section, LongJohn. Replaced the sidemount figure with obsolete mean depth line. Fixes #827 Fixes #828 Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-02-04More tolerant when parsing GPS coordinates.Gravatar Patrick Valsecchi
Refactored the parsing logic to make it more solid (no more guessing) and more flexible (support more formats). Added a test for checking that. Fixed a few warnings. [Dirk Hohndel: some changes to coding style] Signed-off-by: Patrick Valsecchi <patrick@thus.ch> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-02-04Get ready for Subsurface 4.4Gravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-02-02User manual: modifications to the Facebook informationGravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-02-02User-manual: Add text and images for Facebook intergration 5 images are ↵Gravatar willem ferguson
changed and four more are added. Dirk, please read the paragraph marked *Important* to make sure it does not constitute utter rubbish. Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-01-31User manual: Updates for iphone app for subsurface GPS sereviceGravatar willem ferguson
I did some editing of the image to increase contrast and make the text in the screen shots more readable. In the process I also reduced the size of the image substantially. I have also edited the text somewhat. Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-01-30User-manual: Dive planner textGravatar willem ferguson
I took Robert's contribution describing the dive planner and expanded it a bit, added two more graphics to show CCR and pSCR dive planning, and changed a third image. Moved the section dealing with configuring a dive computer to be in a more logical place, just before the Subsurface Settings. Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-01-30User-manual: Unresolved referencesGravatar willem ferguson
Fix four unresolved references in the user-manual Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-01-30Document iPhone companion appGravatar Miika Turkia
Signed-off-by: Miika Turkia <miika.turkia@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-01-30User manual: lets try to be consistent with import/export headersGravatar Krzysztof Arentowicz
changing Appendix B/C headers to follow the same wording. also changed appendix title as using the same word twice in the same line just doesn't look right to me. Signed-off-by: Krzysztof Arentowicz <k.arentowicz@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-01-30User manual additions for rebreather modesGravatar Robert C. Helling
...in particular for planning rebreather dives. Signed-off-by: Robert C. Helling <helling@atdotde.de> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-01-29User-manual: Update figures for section on dive plannerGravatar willem ferguson
Update the two existing images for the section dealing with the dive planner. This is to make things a little easier for Robert who will be generating some text for this part of the manual. Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-01-29User-manual: replace imagesGravatar willem ferguson
Seven images disappeared from the /images directory. This replaces them. Four more images are converted to fedora/KDE format. This is part of the drive to convert all screenshots to reflect fedora/KDE The only changes in user-manual.txt are the references to the four newly-converted images. Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-01-28User manual: add note about xdeep data importGravatar Krzysztof Arentowicz
Attached. Patch contains an image of xdeep black DC. I asked them if they're ok with using this file in the manual and got the permission. thanks, Krzysiek From 971a244b8f2584bc1c3fc294cf5bb98c22d303be Mon Sep 17 00:00:00 2001 From: Krzysztof Arentowicz <k.arentowicz@gmail.com> Date: Sat, 10 Jan 2015 20:24:22 +0100 Subject: [PATCH] User manual: add note about xDEEP BLACK data import Note is ilustrated by xDEEP BLACK picture by xDEEP. I have aquired a written permision from xDEEP to use this file. Signed-off-by: Krzysztof Arentowicz <k.arentowicz@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-01-27User manual: Tying up loose endsGravatar willem ferguson
As the heading above says. 1) Place user manual option in main menu at the bottom of the Help submenu. It is more easily seen in that position. 2) Replace two images. I forgot one of the images that had been changed to F20 format. 3) A few small changes, including in the systematic description of the main menu. Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-01-27User manual updates (part 3 of 3)Gravatar willem ferguson
This patch updates several areas of the manual: 1) The import from dive computer using the new UI panel. 2) The section dealing with exports 3) Many other small changes. Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-01-26Updates to user-manual (2 of 3)Gravatar willem ferguson
Changes to the user-manual to achieve the following: 1) Remove duplication of CCR information 2) Remove duplication in CSV import information 3) rewrite the section dealing with CSV import. 2 images were added to the user-manual. Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-01-25Updates to user-manualGravatar willem ferguson
These updates concern: Export options for dive logs (File->Export) Preferences panel, especially CCR and pSCR preferences Display of CCR dives. 7 images were either replaced or added. Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-01-25A short comment of Atomic Logbook to user manualGravatar Miika Turkia
Signed-off-by: Miika Turkia <miika.turkia@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-01-16Documentation: Fix user-manual.txt indentation to comply to asciidoc format ↵Gravatar Guillaume GARDET
(also fix po4a translation tool usage) This patch fix indentation for list item to comply to asciidoc format. This also fix po4a translation tool usage. Signed-off-by: Guillaume GARDET <guillaume.gardet@free.fr> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-01-05Need to warn about some more characters on CSV importGravatar Miika Turkia
Signed-off-by: Miika Turkia <miika.turkia@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-01-05Caveats of CSV import added to documentationGravatar Miika Turkia
Signed-off-by: Miika Turkia <miika.turkia@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-01-03Fix cross references in user manualGravatar Miika Turkia
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-12-24Fix prev/next anomaly from user manualGravatar Miika Turkia
Signed-off-by: Miika Turkia <miika.turkia@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-12-21Changes to user manual to reduce image sizesGravatar willem ferguson
Some image sizes were in excess of 200 kB in size. All images larger than 100 kB were reduced in size to below 70 kB. In the process there was a conversion of some images from Unity to F20 KDE. Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-12-19Update to user manual: sidemount and imagesGravatar willem ferguson
1) Add short section dealing with logging of sidemount dives (1 image) 2) Replace three images in section on CSV export from LibeOffice Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-12-17Remove the now duplicated text about creating CSV filesGravatar Dirk Hohndel
I should just have trusted Willem in commit dae0c9dffb7c ("User manual update"). He got it right and I misedited his patch. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-12-17User manual updateGravatar willem ferguson
Small changes throughout the manual. Typos, spelling, rephrasing a few sentences, moving links to other sections, reformatting of paragraphs here and there. Edits to one image. (CSV export from Windows) [Dirk Hohndel: dropped removal of Appendix E from this patch] Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-12-17Usermanual - additional info for adding user to dialout-groupGravatar Thomas Maisl
At least on Ubuntu systems an edit of a group membership takes effect only after logging out and in of that user, if this user is currently logged in. Signed-off-by: Thomas Maisl <exp-12004@maisl.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-12-17Describe new CCR features in user manualGravatar Robert C. Helling
Signed-off-by: Robert C. Helling <helling@atdotde.de> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-12-16Merge branch 'testdoc'Gravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org> Conflicts: Documentation/user-manual.txt
2014-12-16Update of user manual to give much more information about CSV dive log importGravatar willem ferguson
This patch addresses several issues: 1) At the beginning of the manual a section was rewritten, just after "How to open a new log book", to explain to the newby what the different options are for enetering dive data into the Subsurface dive log. 2) A new section "A diver's introduction to CSV files" was written as a boxed section. 3) The section dealing with CSV import from dive computers was shortened because much of the information was transferred to the new section in point 2) above. 4) The section dealing with CSV import from manually kept dive logs was expanded, specifically giving more information about import from manually kept dive logs in spreadsheets. 5) Appendix D was added, detailing CSV export from LibreOffice, OpenOffice and Microsoft Excel. Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-12-14Updated User Manual to include information on how to add dive data to a new ↵Gravatar Pedro António Neves
logbook. - Changed section 4 name to: Storing dive information in the logbook (to keep it in line with the other titles) - Added some introductory text to section 4, together with links to the appropriate sections on the manual - Changed figure Import_CSV2.jpg to reflect date format options - Added an Appendix (E) explaining users how to create a .CSV file from LibreOffice Calc - Added 3 more images to illustrate Appendix E Signed-off-by: Pedro António Neves <nevesdiver@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-12-11User manual: Eight more figures replacedGravatar Willem Ferguson
Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-12-09Update user manual figures: Ubuntu to FedoraGravatar willem ferguson
Replace four more figures. Replacement complete up to end of section: Import data from dive computer. Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-12-08Fix symbolic links for user manualGravatar Miika Turkia
Let's use implicit anchor for the Appendix A. This will get rid of compilation error when trying to create PDF version of the user manual. (Otherwise all the other links to Appendix A would have to be updated.) Signed-off-by: Miika Turkia <miika.turkia@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-12-08Unify spelling of DivingLog on user manualGravatar Miika Turkia
Signed-off-by: Miika Turkia <miika.turkia@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-12-08Typo fixes on user manualGravatar Miika Turkia
Signed-off-by: Miika Turkia <miika.turkia@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-12-08User manual: new images taken from Fedora 20 KDE.Gravatar Willem Ferguson
Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-12-08User manual updateGravatar willem ferguson
This update concerns: Import of dive logs from Suunto DM5 Configuration of dive computers Description of main menu items One figure has been added Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-12-07User Manual text updateGravatar willem ferguson
Update to user manual text, including Cylinder bar at bottom of profile as well as Extra Data tab. A few smaller sentence-level updates scattered throughout the text New pictures. Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-11-18Replace other references to hohndel.orgGravatar Dirk Hohndel
The only place where I'm not sure if there are unintended sideeffects of changing over to the new domain is QCoreApplication::setOrganizationDomain Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-11-17Small modification of the filter descriptionGravatar Dirk Hohndel
This seems more important to explain - it's OR within the column and AND between the columns. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-11-17User manual: text to explain filter panelGravatar Willem Ferguson
Few smaller changes to text dealing with tissue pressures graph Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-11-16User manual: Using CCR equipment with Subsurface.Gravatar Willem Ferguson
This is a first stab at some text detailing the import and handling of CCR dives within Subsurface. Three figures added. Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za>Kind regards, willem From da16229327331731794b356b8e8504a4cd160634 Mon Sep 17 00:00:00 2001 From: willem ferguson <willemferguson@zoology.up.ac.za> Date: Sun, 16 Nov 2014 15:50:44 +0200 Subject: [PATCH] Update user manual with CCR instructions This is a first stab at some text detailing the import and handling of CCR dives within Subsurface. Three figures added. Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-10-30User manual: added documentation for tissue graph.Gravatar John Van Ostrand
Signed-off-by: John Van Ostrand <john@vanostrand.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-10-10Add description of gas pressure bar graph to user manualGravatar willem ferguson
The gas pressure bar graph that has recently been added to the Information Box on the dive profile is described here. Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>