summaryrefslogtreecommitdiffstats
path: root/Documentation/user-manual.txt
AgeCommit message (Collapse)Author
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>
2014-09-11User manual update: Replan, Copy and Paste components.Gravatar willem ferguson
This patch adds detail to the sections that deal with the modification of existing dive plans as well as for the copy and paste of dive information from one dive into other dives. Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-08-17HTML: Update the user-manual with the new export settings.Gravatar Gehad elrobey
Signed-off-by: Gehad elrobey <gehadelrobey@gmail.com> Signed-off-by: Miika Turkia <miika.turkia@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-08-09User manual: Text describing simultaneous edit of several divesGravatar Willem Ferguson
Text describing how to edit more than one dive that are selected in the dive list. Notice how I take nearly 20 lines to describe something that Linus described effectively and succinctly in 4 lines. Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-08-07User manual: Delete images using dustbin iconGravatar Willem Ferguson
Madification in text to reflect change in UI after the dustbin icon has been moved in thumbnails of photos. Two images in the manual were replaced. Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-08-07User manual: Add text explaining delete of photos from the Photos tabGravatar Willem Ferguson
This text addresses issues about the deletion of photos using the Photos tab. It also deals with interpreting information regarding photos laocated on an external drive that is not connected to the PC. Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-08-06If planner SAC rates are only in l/min don't claim otherwise in the manualGravatar Robert C. Helling
Signed-off-by: Robert C. Helling <helling@atdotde.de> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-08-06User manual, critical typoGravatar Willem Ferguson
Correction of a critical typo in the user manual Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-08-06User Manual: Minor updates to text with 4 image replacementsGravatar Willem Ferguson
Minor grammatical and stylistic text adjustsments, following quite a few changes to the text by several contributors over the last two weeks. Four images are replaced to reflect the latest UI, and also to reflect the Gnome 3 rendering. These relate to the specification of cylinder gas in the Equipment Tab. Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-08-04User manual: use pO2 = 1.6 bar for decoGravatar Sergey Starosek
Signed-off-by: Sergey Starosek <sergey.starosek@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-08-04Minor corrections to user manualGravatar Sergey Starosek
Signed-off-by: Sergey Starosek <sergey.starosek@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-08-04User manual: fix dive depth wordingGravatar Sergey Starosek
Picture shows dive to 20m in 30 min. so text should state the same Signed-off-by: Sergey Starosek <sergey.starosek@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-08-03Correct typoGravatar Cristian Ionescu-Idbohrn
Signed-off-by: Cristian Ionescu-Idbohrn <cristian.ionescu-idbohrn@axis.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-08-02User manual: text to explain the user surveyGravatar Willem Ferguson
I modified Tim Wooton's text, among others doing it in the writing style of the manual (e.g. no second person). Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-08-02Manual - surveyGravatar Tim Wootton
Possible wording for the survey bit Is this the right place to put it? Will probably need an image, but that would be better from Willem's environment for the look to be consistent. Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-08-02Some more clarifications and fixes to user manualGravatar Miika Turkia
Signed-off-by: Miika Turkia <miika.turkia@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-08-02Not possible to delete first cylinderGravatar Miika Turkia
Describe that used cylinders cannot be deleted and first cylinder is used implicitly. Signed-off-by: Miika Turkia <miika.turkia@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-08-02Describe the editing mode only onceGravatar Miika Turkia
Describe the editing mode only once when going through entering dive information by hand and not when describing each tab. Signed-off-by: Miika Turkia <miika.turkia@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-08-02Describe default time and dateGravatar Miika Turkia
Mention what is used by default for time and date when creating a new dive. (And fix upper case elsewhere.) Signed-off-by: Miika Turkia <miika.turkia@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-31User manual: misplaced text.Gravatar Willem Ferguson
Some of the text dealing with Dropbox acces was misplaced (Thank you, Salva) This corrects that issue. Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-31User manual: Delete photo, Dropbox accessGravatar Willem Ferguson
Text and an image were changed in order to reflect the removal of images from the dive profile. The text concerning Dropbox acces was reorganised. Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>