Commit graph

522 commits

Author SHA1 Message Date
willem ferguson
a5bebe3ba8 User-manual: Unresolved references
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-30 17:08:42 -08:00
Miika Turkia
a6d9a559c1 Document iPhone companion app
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-01-30 09:56:07 -08:00
Krzysztof Arentowicz
3b3a99ca4e User manual: lets try to be consistent with import/export headers
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-30 07:54:59 -08:00
Robert C. Helling
3788168114 User manual additions for rebreather modes
...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-30 07:18:06 -08:00
Guillaume GARDET
f291eb6a79 Documentation: update french translation
Update french translation of user-manual and POT file.

Signed-off-by: Guillaume GARDET <guillaume.gardet@free.fr>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-01-29 07:27:27 -08:00
willem ferguson
d136651d12 User-manual: Update figures for section on dive planner
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-29 06:55:13 -08:00
willem ferguson
15dad0714e User-manual: replace images
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-29 06:54:23 -08:00
Krzysztof Arentowicz
64ef4c2e8d User manual: add note about xdeep data import
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-28 09:36:08 -08:00
willem ferguson
bc7d233365 User manual: Tying up loose ends
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-27 22:58:38 -08:00
willem ferguson
0a0e930f03 User manual updates (part 3 of 3)
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-27 22:58:21 -08:00
willem ferguson
2516752cab Updates to user-manual (2 of 3)
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-26 09:25:02 -08:00
Guillaume GARDET
74260dabe8 Documentation: Update translation (fr)
More french user manual tranlsation and POT file update.

Signed-off-by: Guillaume GARDET <guillaume.gardet@free.fr>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-01-26 07:29:16 -08:00
willem ferguson
47c5a28fb0 Updates to user-manual
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-25 12:02:13 -08:00
Guillaume GARDET
55d6f63820 Documentation: Update french (fr) translation
Update french (fr) translation and POT file.

Signed-off-by: Guillaume GARDET <guillaume.gardet@free.fr>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-01-25 07:25:48 -08:00
Miika Turkia
d47191a3a6 A short comment of Atomic Logbook to user manual
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-01-25 07:17:55 -08:00
Guillaume GARDET
218a1a317e Documentation: Fix user-manual.txt indentation to comply to asciidoc format (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-16 06:37:22 +13:00
Guillaume GARDET
dc7397b06e Documentation: Add initial support for French translation
Add initial support to French (fr) translation of user-manual.

Note that it is not perfect, since the po4a tool loose some list item
indexes during PO to ASCIIDOC conversion (see asciidoc warning messages
during user manual generation).

Signed-off-by: Guillaume GARDET <guillaume.gardet@free.fr>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-01-15 09:02:29 +13:00
Guillaume GARDET
b4b08bdcc5 Add POT/PO infrastructure to translate user manual.
Signed-off-by: Guillaume GARDET <guillaume.gardet@free.fr>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-01-15 07:34:17 +13:00
Miika Turkia
344e517956 Need to warn about some more characters on CSV import
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-01-05 11:36:53 -08:00
Miika Turkia
27bfbee4e8 Caveats of CSV import added to documentation
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-01-05 09:14:08 -08:00
Miika Turkia
09f5289271 Fix cross references in user manual
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-01-03 09:45:33 -08:00
Miika Turkia
e49b4b72b7 Fix prev/next anomaly from user manual
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-12-24 06:42:57 -08:00
willem ferguson
a0f7be7585 Changes to user manual to reduce image sizes
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-21 11:00:29 -08:00
willem ferguson
295b9897ce Update to user manual: sidemount and images
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-19 07:13:35 -08:00
Dirk Hohndel
6263857f74 Remove the now duplicated text about creating CSV files
I should just have trusted Willem in commit dae0c9dffb ("User manual
update"). He got it right and I misedited his patch.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-12-17 12:44:17 -08:00
willem ferguson
dae0c9dffb User manual update
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-17 11:44:12 -08:00
Thomas Maisl
eadfb073ba Usermanual - additional info for adding user to dialout-group
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-17 08:22:32 -08:00
Robert C. Helling
4921c28c4d Describe new CCR features in user manual
Signed-off-by: Robert C. Helling <helling@atdotde.de>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-12-17 07:51:57 -08:00
Dirk Hohndel
ad4389aacb Merge branch 'testdoc'
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>

Conflicts:
	Documentation/user-manual.txt
2014-12-16 07:13:46 -08:00
willem ferguson
86d6a1488e Update of user manual to give much more information about CSV dive log import
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-16 07:11:21 -08:00
Salvador Cuñat
1cf3b9a011 Update spanish translation of user manual to english 0e3fb54
Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-12-16 07:07:08 -08:00
Pedro António Neves
0e3fb549bd New images for the user manual
Added 3 more images to the User Manual (Appendix E).
Images illustrate the creation of .CSV file from LibreOffice Calc.

Signed-off-by: Pedro António Neves <nevesdiver@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-12-14 10:08:34 -08:00
Pedro António Neves
9b924b4fdd Updated User Manual to include information on how to add dive data to a new 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-14 10:08:16 -08:00
Salvador Cuñat
38d78062cb Update spanish translation of user manual to english 3c9c1ec
Only update some figures to Fedora 20.

Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-12-14 10:04:22 -08:00
Miika Turkia
3c9c1ec06f Use ascii only IDs in _es manual
Generation of PDF document fails if accented characters are used in
references.

Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-12-13 08:50:08 -08:00
Miika Turkia
cb77d8fca6 Include *.xml for Documentation clean
These files are left behind when creating PDF fails

Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-12-13 08:49:33 -08:00
Willem Ferguson
e7698beea7 User manual: Eight more figures replaced
Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-12-11 04:20:44 -07:00
Salvador Cuñat
55253cc5f7 Update spanish translation of user manual to english b851146
Includes Extra data tab, show cylinders button,  and Dc configuration.

Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-12-09 15:40:25 -07:00
willem ferguson
f152f9e54e Update user manual figures: Ubuntu to Fedora
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-09 11:45:48 -07:00
Miika Turkia
b8511467b3 Fix symbolic links for user manual
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-08 12:34:36 -08:00
Miika Turkia
dd135d0e6c Unify spelling of DivingLog on user manual
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-12-08 08:41:39 -08:00
Miika Turkia
3a704fc93b Typo fixes on user manual
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-12-08 08:41:27 -08:00
Willem Ferguson
b6efcce383 User manual: new images taken from Fedora 20 KDE.
Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-12-08 08:40:28 -08:00
willem ferguson
7e228a6031 User manual update
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-08 08:39:24 -08:00
willem ferguson
a981619b67 User Manual text update
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-12-07 09:41:08 -06:00
Salvador Cuñat
9848760821 Update spanish translation of user manual to english e0c9ebf
Includes the dive list filters and modifications on tissues graph.
Corrects a typpo.

Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-11-19 00:54:22 +00:00
Dirk Hohndel
1723c01603 Replace other references to hohndel.org
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-18 13:13:39 +00:00
Dirk Hohndel
6fafd1c781 Updated the included user manual html files
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-11-17 19:14:33 +00:00
Salvador Cuñat
992e58eaf2 Update spanish translation of user manual to english 7967d2b
Covers CCR APD and Poseidon divelogs and importing.  Already changed
by the time of writing this commit, at least twice.

Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-11-17 14:55:35 +00:00
Salvador Cuñat
651bf5bd69 Update spanish translation of user manual to english 08adb2e
Somehow I forgot to submit this back in October.

Includes the gases pressures bar graph.

Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-11-17 14:55:04 +00:00
Dirk Hohndel
ac9c2ba544 Small modification of the filter description
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-17 09:10:46 +00:00
Willem Ferguson
e0c9ebfb23 User manual: text to explain filter panel
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-17 09:10:32 +00:00
Willem Ferguson
7967d2bec1 User manual: Using CCR equipment with Subsurface.
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-11-16 17:18:18 +00:00
John Van Ostrand
a7771932be User manual: added documentation for tissue graph.
Signed-off-by: John Van Ostrand <john@vanostrand.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-10-30 12:17:49 -07:00
willem ferguson
08adb2efc5 Add description of gas pressure bar graph to user manual
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-10-10 02:37:17 -04:00
Salvador Cuñat
da90c86d61 Update-spanish-translation-of-user-manual-to-english-7bf65e3
Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-09-20 07:15:50 -07:00
willem ferguson
7bf65e3f0b User manual update: Replan, Copy and Paste components.
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-09-11 08:32:02 -07:00
Gehad elrobey
362671352e HTML: Update the user-manual with the new export settings.
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-17 22:58:36 -05:00
Salvador Cuñat
4b22b74091 Update spanish translation of user manual to english 9170fbc
Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-08-11 08:20:25 -07:00
Willem Ferguson
4617225f68 User manual: Text describing simultaneous edit of several dives
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-09 12:04:23 -07:00
Dirk Hohndel
a64dfab6e6 Add latest html files for user manual
These are used when building from source without asciidoc installed.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-08-08 11:37:09 -07:00
Salvador Cuñat
1baa248a9e Update spanish translation of user manual to english c1026f5
And fixes a little typo.

Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-08-08 11:17:28 -07:00
Willem Ferguson
9170fbc383 User manual: Delete images using dustbin icon
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-07 23:54:22 -07:00
Sergey Starosek
fddad4e414 Update russian translation of the user manual
Aligned with english version c1026f5975

Signed-off-by: Sergey Starosek <sergey.starosek@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-08-07 11:22:48 -07:00
Salvador Cuñat
1f585f3e7c Update spanish translation of user manual to english 150783f
Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-08-07 11:22:40 -07:00
Sergey Starosek
f5d9882573 Update russian translation of the user manual
Aligned with english version  150783f180

Signed-off-by: Sergey Starosek <sergey.starosek@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-08-07 08:00:28 -07:00
Willem Ferguson
c1026f5975 User manual: Add text explaining delete of photos from the Photos tab
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-07 08:00:15 -07:00
Robert C. Helling
150783f180 If planner SAC rates are only in l/min don't claim otherwise in the manual
Signed-off-by: Robert C. Helling <helling@atdotde.de>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-08-06 12:26:33 -07:00
Willem Ferguson
b0ead31934 User manual, critical typo
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-06 06:07:00 -07:00
Willem Ferguson
8cea20a684 User Manual: Minor updates to text with 4 image replacements
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-06 06:05:55 -07:00
Cristian Ionescu-Idbohrn
f6bcf4c68d Ignore errors on pdf generation
Signed-off-by: Cristian Ionescu-Idbohrn <cristian.ionescu-idbohrn@axis.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-08-05 09:51:23 -07:00
Salvador Cuñat
b32d22713c Update spanish translation of user manual to english 3c83f72
Includes fixing an image position.

Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-08-04 09:48:11 -07:00
Sergey Starosek
1a8dd659ca User manual: use pO2 = 1.6 bar for deco
Signed-off-by: Sergey Starosek <sergey.starosek@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-08-04 08:49:16 -07:00
Sergey Starosek
3c83f72e79 Minor corrections to user manual
Signed-off-by: Sergey Starosek <sergey.starosek@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-08-04 06:39:40 -07:00
Sergey Starosek
047eb33386 User manual: fix dive depth wording
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-04 06:38:37 -07:00
Sergey Starosek
1fa02bab72 Translate user manual into Russian
Translation is almost done section-by-section for easier tracking of
further changes to master copy. It probably needs some re-styling but
not for 4.2.

Signed-off-by: Sergey Starosek <sergey.starosek@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-08-04 06:36:01 -07:00
Salvador Cuñat
fc75457cc8 user-manual_es.txt Fix one typo
Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-08-03 12:13:59 -07:00
Salvador Cuñat
0cb34f77e0 Update spanish translation of user manual to english a104905
Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-08-03 10:33:20 -07:00
Miika Turkia
8f65d9d8cf Fix some compile issues in Spanish user manual
It seems that anchors cannot be placed on paragraphs when writing
Spanish asciidoc. Thus setting them for section headers. Also remove
new line from image tag.

Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-08-03 10:33:13 -07:00
Cristian Ionescu-Idbohrn
1f43ff5b6f Correct another typo
Signed-off-by: Cristian Ionescu-Idbohrn <cristian.ionescu-idbohrn@axis.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-08-03 10:32:46 -07:00
Cristian Ionescu-Idbohrn
50baf449fc Correct typo
Signed-off-by: Cristian Ionescu-Idbohrn <cristian.ionescu-idbohrn@axis.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-08-03 10:32:37 -07:00
Willem Ferguson
a104905257 User manual: text to explain the user survey
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-02 13:22:52 -07:00
Tim Wootton
568ff9f368 Manual - survey
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-02 13:16:02 -07:00
Salvador Cuñat
7c41efa165 Update spanish translation of user manual to english bfca2dc
Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-08-02 07:06:59 -07:00
Miika Turkia
044e287d90 Some more clarifications and fixes to user manual
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-08-02 07:06:48 -07:00
Miika Turkia
654e0ce9d3 Not possible to delete first cylinder
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-02 07:06:38 -07:00
Miika Turkia
e87f1b63c3 Describe the editing mode only once
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-02 07:06:31 -07:00
Miika Turkia
e21467cbc6 Describe default time and date
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-08-02 07:05:23 -07:00
Willem Ferguson
bfca2dcf51 User manual: misplaced text.
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-31 11:23:45 -07:00
Willem Ferguson
0f03ebee00 User manual: Delete photo, Dropbox access
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>
2014-07-31 11:23:39 -07:00
Miika Turkia
776b7c4697 User manual: Reasoning for importing dives from other log books
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-31 11:23:33 -07:00
Miika Turkia
52bb730b7b User manual: data base -> database
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-31 11:23:29 -07:00
Dirk Hohndel
4cb80986fc Once again, add latest html documentation files to git
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-30 14:29:42 -07:00
Tim Wootton
dbadf79cac Manual - rename the example characters
I thought it might be fun to use the archetypal characters here
http://en.wikipedia.org/wiki/Alice_and_Bob
It'll also be handy to use Bob if we ever need an example of
an underweighted diver ;-)

Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-30 14:27:24 -07:00
Tim Wootton
1b7265d8ae Manual - minor fixes for the bottom sections of the manual
Nearly all done now!

Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-30 14:16:10 -07:00
Willem Ferguson
7f4b05f194 User manual: Four very small corrections and additions
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-30 12:30:07 -07:00
Salvador Cuñat
6de3a2322d Update spanish translation of user manual to english 061f158
Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-30 12:29:19 -07:00
Salvador Cuñat
4358564498 User manual: Little add on Dropbox services.
All dive log movements are made on the local copy, then uploaded to
Dropbox server when there is an avaliable internet conection.

Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-30 12:28:52 -07:00
Tim Wootton
aa4cd34032 User manual: remove avg. depth. relocate picture ref and minor corrections
Multi-dive stats no longer include avg. depth
Picture was above, not below
Several minor corrections

Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-30 08:02:54 -07:00
Tim Wootton
a6d0005e60 User manual: use synchronisation as we do elsewhere and into not onto
Even though its Synchronization in the menu (in the base language
anyway) elsewhere thoughout the manual we use the en_GB spelling.
Use "into" rather than "onto" subsurface

Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-30 08:02:45 -07:00
Tim Wootton
9a75e6b153 User manual: make field edit decriptions consistent
Make descriptions of field editing consistent between the manually
added and DC imported sections. I preferred the DC section wording
on ratings.

Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-30 08:02:36 -07:00
Tim Wootton
0a08e5e903 User manual: some minor readability and repeats locationless GPS warn
Some minor readability tweaks.
Repeats wanrning about co-ordinates without Location name, all the
other info on co-ordinates was cut-pasted from the manual dive
entry section, but this bit was missing.

Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-30 08:02:26 -07:00
Tim Wootton
a9aabe3f27 Corrects a few minor bits in section 3.1.1 of the manual
Corrects a typo
Removes a repetition
Closes a bracket
Adds extra info on use of the suit field

Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-29 22:48:27 -07:00
Tim Wootton
885df3c51f Adds missing highlight and improves readability in Section 1
Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-29 22:47:39 -07:00
Tim Wootton
b63886daf3 Replace most refs to Microsoft with Windows
Referring to software as "Microsoft software" implies it's written
by Microsoft, which I don't think the Mares Dive Organizer is.
Microsoft still needs to stay for SQL Compact Edition which is theirs
but I think "Windows software" is the better description for the rest.
For consistency I think this works for refering to the OS too, as we
use Mac, not Apple, and Linux not Canonical.

Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-29 22:47:20 -07:00
Miika Turkia
4fa8706e25 Tune the introduction paragraph of user manual
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-29 22:42:14 -07:00
Miika Turkia
be99ad728a Fix repetition in user manual
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-29 22:42:08 -07:00
Miika Turkia
248676f705 Image declaration to one line on ES manual
It appears that new lines are not allowed on image declarations on user
manual.

Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-29 15:37:32 -07:00
Miika Turkia
16a730d15c Fix a link on ES user manual
Compile of the user manual failed on XML validation due to typo on the
link.

Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-29 15:37:06 -07:00
Willem Ferguson
1786148d31 User manual: Add section on dive log storage in the cloud using dropbox
Some other dive log programs present storage of dive logs on the Internet
as an important feature. Therefore this text.
One image was added.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-29 09:18:32 -07:00
Salvador Cuñat
fe44bc9041 Update spanish translation of user manual to english a0098a8
Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-26 07:16:30 -07:00
Dirk Hohndel
5b72715244 User manual: update generated html files
This once again just updates the html files for people who build from
source but don't have asciidoc.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-25 07:48:29 -07:00
Salvador Cuñat
ce42e32bce Update spanish translation of user manual to english 796d0a9
Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-25 07:17:40 -07:00
Willem Ferguson
a0098a830c User Manual: Changes to Print Dive and Print Dive Plan
This patch performs the following to the user manual:

1) Remove text refering to cursor position indications on the depth
   and time axes of the dive profile panel (not present in V4.2).
2) Revise dialogue and image for the printing of a dive log, taking
   into account the new feature for 1 dive/page.
3) Added a paragraph to the text dealing with printing of dive plans,
   detailing the approach to print dive plans after they have been saved
   in the Dive List. This is done at the end of the text dealing
   with the dive planner.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-25 07:16:08 -07:00
Dirk Hohndel
f8d19d83a3 User manual: update generated html files
This once again just updates the html files for people who build from
source but don't have asciidoc.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-24 13:49:13 -07:00
Willem Ferguson
796d0a98f9 User manual: Add text as well as figures.
This patch updates the user manual in the following respects:
1) Add section dealing with modifying the categories of information
   shown in the Dive List. (A figure added)
2) Add section on filtering the Dive Listfor a particulr sive site,
   using Ctl-F.
3) Add section describing the addition of bookmarks
   (a figure added)
4) Two sentences dealing with the 30-minute time limit for
   including photos onto the dive profile (dives > 30min of
   the dive are not shown).
5) A few small changes, mostly typos.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-24 12:54:14 -07:00
Dirk Hohndel
3cf59fbd12 User manual: update generated html files
This just updates the html files for people who build from source but
don't have asciidoc.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-24 07:38:01 -07:00
Salvador Cuñat
a7c4e7f831 Update spanish translation of user manual to english 3e66948
Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-24 07:35:57 -07:00
Willem Ferguson
c2d9d3f475 User manual: Replace figure
Replace an Ubutu-based figure (we stick to Gnome).

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-24 07:35:09 -07:00
Willem Ferguson
6509201c1e User manual: correct asciidoc markup for proper alignment of subheadings
Sections 6 and 9.3 of the user manual has some problems with the
ascii-doc code for maintaining the prper alignment of subheadings.
This patch corrects the asciidoc markup code to solve this
problem

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-24 07:34:25 -07:00
Sergey Starosek
6f146e8e8d Minor changes to user manual
Signed-off-by: Sergey Starosek <sergey.starosek@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-24 07:29:20 -07:00
Dirk Hohndel
359613210b Getting read for Beta 2
Tiny updates to Relnotes and README, include the latest formatted manual,
change the version in the project file

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-18 18:00:28 -07:00
Willem Ferguson
3e669481f6 User manual: small changes to reflect changes in CSV import dialog.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-18 10:16:46 -07:00
Willem Ferguson
a1b085324e User manual: Replace CSV import image
Replace the CSV import image to reflect recent changes.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-18 10:16:23 -07:00
Willem Ferguson
40a9b316b2 User manual: updates
Changes to user manual to rplace three images, as pointed out by Sergey.
Small changes to text of manual to reflect blue editing bar UI.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-18 10:15:53 -07:00
Salvador Cuñat
8fae0b6af8 Update spanish translation for user-manual.txt to 82fc95d
[Dirk Hohndel: added the html.git file]

Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-17 07:26:28 -07:00
Dirk Hohndel
d73d98c032 User manual: add latest html files to git tree
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-16 23:09:01 -07:00
Willem Ferguson
82fc95d693 User manual: Updated text
This patch contains some updates to the user manual to reflect the new
images that were submitted previously. The updates include:
1) Moving the "Load Photos" section to the section daling with the input
   of dive information (photos qualify as additional dive information).
2) Changing the wording around the new button in the tool bar.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-16 23:08:50 -07:00
Willem Ferguson
004b9d72c5 Replacement figures for user manual
Replacement figures for user manual

     Here are 12 replacement figures for the user manual to bring the
figures
     in line with the current UI. This relates to the updated profile
toolbar
     and manual dive profile entry. I did not change any text of the manual.
     That will happen tomorrow evening.

     Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>

From 85413b967c02738d47f0b7779613f33cc7898c17 Mon Sep 17 00:00:00 2001
From: Willem Ferguson <willemferguson@zoology.up.ac.za>
Date: Wed, 16 Jul 2014 07:26:43 +0200
Subject: [PATCH 4/4] Replacement figures for user manual

Here are 12 replacement figures for the user manual to bring the figures
in line with the current UI. This relates to the updated profile toolbar
and manual dive profile entry. I did not change any text of the manual.
That will happen tomorrow evening.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-16 09:22:02 -07:00
Salvador Cuñat
8066334070 Translation update as of 29f19c37b0.
Updates translation and correct some typpos.
Includes Planner, Photographs and HTML export.

Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-09 08:55:12 -07:00
Miika Turkia
f7f8c0b1b2 Typo fixes on User Manual
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-04 06:35:15 -07:00
Miika Turkia
29f19c37b0 Minor edits on HTML export (User Manual)
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-04 06:35:11 -07:00
Gehad elrobey
8baa228b12 User manual: HTML export update
This patch updated the export section in the user manual.

Some changes to the description of the HTML export options.

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-07-04 06:34:55 -07:00
Willem Ferguson
bbfe20a412 User manual: Spelling, typos
The user manual was spell-checked against the Oxford Dictionary.
Almost all the joined words, e.g. checkbox, dropdown, were
kept, but divelog was changed to dive log. Quite a few tyops
and spelling errors corrected.

A short section on dive plan evaluation was deleted on Robert's
suggestion.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-06-30 07:21:01 -07:00
Willem Ferguson
c020cda41b Update of user manual
Several updates are implemented here.

1) Updates to the dive planner section, following excellent
suggestions from Rob.

2) Updates reflecting the date picker, including hitting ESC
to close the calendar.

3) The edit of device names.

4) Several small or typographic edits

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-06-29 09:44:28 -07:00
Willem Ferguson
de8dbf2dad Updates to user manual: Preferences and Main menu
This patch updates the section on Preferences to accommodate
the newer additions to this Panel.
(Three images removed, five images inserted)

The section dealing with the desciption of all the main menu items
is updated.

One small change to the FAQ section.

A few small typo edits elsewhere in manual.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-06-29 08:36:07 -07:00
Willem Ferguson
f1f16b224b User manual: add more about dive log export.
This patch updates the information about dive log export.
Export to Worldmap, as well as to HTML are covered.

Small typo corrections elsewhere in the manual.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-06-28 16:01:59 -07:00
Willem Ferguson
dd9d68a359 User manual: Load photographs
This patch adds text and figures to the user manual, explaining how to
add photographs to the dive profile.

A 2-sentence paragraph was added to the dive planner text, detailing
planning for repetitive dives.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-06-28 16:01:48 -07:00
Willem Ferguson
2292abd552 User manual: add text for the dive planner
Text for the dive planner has been added to the user manual.
This includes two new images.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-06-28 16:01:38 -07:00
Henrik Brautaset Aronsen
630ec88dd4 Be more consistent in partial pressure naming
Lets just use pO₂ instead of PO2, ppO2, ppO₂, PO₂.
They all mean the same, but it's better to be
consistent

Signed-off-by: Henrik Brautaset Aronsen <subsurface@henrik.synth.no>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-06-23 06:48:54 +08:00
Anton Lundin
bd3dd30518 Fix out of tree building without asciidoc
We tried to copy the .html.git file from the out of tree build dir, not
from the source dir.

Signed-off-by: Anton Lundin <glance@acc.umu.se>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-06-08 08:10:10 -07:00
Dirk Hohndel
98dd127f93 User manual: add html version of Spanish manual
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-06-06 10:55:51 -07:00
Dirk Hohndel
20bbff2773 User manual: update Makefile for multi language support
New translations need to be explicitly added to the Makefile

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-06-06 10:54:51 -07:00
Salvador Cuñat
2f1d7c0bdc User manual: Spanish translation
Spanish translation for the user manual as of 4.1 tagged english version.
Trimmed to 80 columns except where this could break links and affect the
html conversion.

Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-06-06 10:20:31 -07:00
Tomaz Canabrava
feff22c222 Planner: Re-enable using the new profile.
This correctly enables the planner on the new profile,
but it doesn't triggers the correct paint on the canvas.

[Dirk Hohndel: remove other remnants of the disabled planner as well]

Signed-off-by: Tomaz Canabrava <tomaz.canabrava@intel.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-05-26 13:17:32 -07:00
Jeremiah Mahler
5702a52078 Documentation spelling errors
A general review of the documentation has found more spelling errors.

Signed-off-by: Jeremiah Mahler <jmmahler@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-05-11 02:00:53 -07:00
Willem Ferguson
eba0790a04 Yet some more changes to Companion part of user manual
A last few changes before 4.1.
The first figure in "Using Companion app" needs a third part.
This was inserted. Which, in turn, affected the last figure
in that section. So that was also changed accordingly.

Few tiny changes to text to clean up references to figures.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-05-08 08:19:54 -07:00
Willem Ferguson
0325a42c08 User manual: Updates regarding the companion app
These adiitions and changes were made in accordance with the screenshots
provided by Venkatesh and Salvador and after managing to actually run the
companion app on my phone. Large parts of the text of this section have
been changed in accordance with the Companion V2 interface. Two graphics
were changed.

After Version 2 has stabilised, some more adaptation of the text will be
required.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-05-07 09:12:15 -07:00
Salvador Cuñat
8de1a73669 User manual: document importing GPX files in companion app
Document the new "add" menu capabilities, partially as there are features still not
functional.
Documents the new feature with GPX files imports.
Corrects a typo.

Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-05-05 09:01:42 -07:00
Dirk Hohndel
2dda348bab Getting ready for 4.1 Beta 2
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-04-30 21:36:38 -07:00
Miika Turkia
97e9be1ba6 Add export CSV to user manual
Mention the option to export in CSV format in our user manual.

Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-04-30 09:16:01 -07:00
Dirk Hohndel
8539ae6471 User manual: add latest html
This updates the rendered html file for people who build from source but
don't have asciidoc installed.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-04-29 22:09:17 -07:00
Rick Walsh
5775221a4c User manual: formatting changes
- Add hyperlinks to references to Appendices A and B in the text

- Be consistent with use of numbered lists and bullets:

-- Use numbered lists where order is important (e.g. a set of instructions)

-- Use bullets where isn't doesn't matter (e.g. a list of features)

Signed-off-by: Rick Walsh <rickmwalsh@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-04-29 22:07:59 -07:00
Willem Ferguson
1e44fecf06 User manual: Minor updates
Minor update of manual for consistency in terminology and improved style
including the section describing the companion app. No images were affected.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-04-29 22:06:37 -07:00
Salvador Cuñat
48b8cbadf7 User manual: some changes regarding the companion app
Subsurface companion is, basically, the same from last Subsurface release,
it's only been added with the map feature which is depicted here.

Distance between positions takes precedence over time between them, so you
can have positions faster than one each period set in the "Min Duration"
setting.  Actually this setting seems useless as you won't have a fix each
period if distance is under "Min distance".

Lesser changes in manual involving Background Service, the dificulty on
matching times and little personal recomendations.

[Dirk Hohndel: minor language changes]

Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-04-25 09:02:23 -07:00
Willem Ferguson
24792f402d User manual: Replace some graphics
1) Two of the major screen images were replaced to reflect the current
   screen layout with the new features of the profile toolbar.
2) The heart rate button is depicted and desribed.
3) Minute changes to the text of the manual to accompany the above changes.
4) The Uwatec Galileo image is re-inserted in the icons folder. Somewhere
   it got lost.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-04-21 08:36:03 -07:00
Willem Ferguson
20bde81023 Small updates to user manual
These updates reflect the discussion and small changes that were made to the
Preferences section and the Export-to-Worldmap features over the last week.

1) A few small changes made to the text of the Preferences section.
2) Two images replaced in the Preferences section.
3) Expansion of description of Export to Worldmap option of the menu system.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-04-10 09:15:28 -07:00
Anton Lundin
0bf79e216f Use the ENABLE_PLANNER macro in the manual too
This introduces ifdef control structures in the manual too, so we can
continue to develop both the planner and its manual, until its ready for
release.

Signed-off-by: Anton Lundin <glance@acc.umu.se>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-04-07 10:17:45 -07:00
Willem Ferguson
57bfa7e353 Update to bring user manual in line for the release of V4.1.
1. New section added on IrDA and communicating with the Uwatec Galileo dive computers.
2. Sections 7 to 9 of manual updated to reflect current version. Three figures updated.
3. New section added to reflect the dive planner. This is only a skeleton
awaiting better description when the dive planner is more mature. Added
2 figures within this new section.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-04-07 10:16:54 -07:00
Robert C. Helling
02d5d436d2 EAD/END explanation in user manual.
E is for "equivalent".

Signed-off-by: Robert C. Helling <helling@atdotde.de>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-03-31 11:51:54 -07:00
Willem Ferguson
69b000dcff User manual: Updates to sections 6 and 10-13
These are updates that are not version 4.1 dependent, but many linguistic
and logical edits are made, as are edits for consistency.
No substantive material has been removed or added.
This text is ready for V4.1

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-03-27 10:58:22 -07:00
Dirk Hohndel
dd0c995f2f User manual: Update included .html.git file
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-03-25 08:16:06 -07:00
Lakshman
17e493735b Minor edits to updated section-3 documentation
Patch provided by Willem Ferguson, "0002-Updates-to-Section-3-of-
the-user-manual" addresses large number of typos and inconsistencies
in the previous documentation of section 3. This patch makes some
additional corrections on top of the provided patch, and also removes
the trailing whitespaces brought in with the provided patch.

Signed-off-by: Lakshman Anumolu <acrlakshman@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-03-25 08:13:26 -07:00
Willem Ferguson
b95304f424 Updates to Section 3 of the user manual
Section 3 is quite a long section. Ten of the screen shots are replaced.
Large numbers of typos and inconsistencies are corrected.
A few sentences are included e.g when dealing with the Subsurface Companion.
Section dealing with creating libdivecomputer dump files has been reorganised
slightly.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-03-25 08:12:54 -07:00
Willem Ferguson
f7709ec4a3 User manual: Changes to sections 1 and 2
The text for these two sections has been corrected and updated
in order to be ready for the release of V4.1. The very first
paragraph of the manual is expanded substantially.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-03-17 10:54:08 -07:00
Willem Ferguson
0f7dfcee26 User manual: Update sections 4 and 5
A new figure is included to reflect the actions of the new profile buttons
on the calculated ceilings.

A number of small edits on sections 4 and 5 of the user manual are done.
These sections are now finalised for the new release.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-03-15 22:17:59 -07:00
Willem Ferguson
ce6f2cdda4 User manual: Add the missing icons
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-03-15 09:48:49 -07:00
Willem Ferguson
f4d56ddf6f Revision of Profile part of manual
The last figures in the manual using the Unity desktop have been replaced
with equivalent figures using Gnome 3. There should now be no figures
remaining from Unity.

This is a revision of the profile part of the manual in the light of the
changes for V4.1. Text has been moved around, some new text added or
rewritten. Graphics has been replaced to reflect the UI for V4.1,
including Tomaz's button bar and Louisa's new buttons for that bar.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-03-14 15:31:37 -07:00
Thiago Macieira
3318aefa46 Make sure the user-manual.html output always ends up in $(OUT)
If you're doing a non-local build, it would get saved in the source
dir. Then qmake would complain that it couldn't find it in the target
dir.

Signed-off-by: Thiago Macieira <thiago@macieira.org>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-25 15:30:38 -08:00
Dirk Hohndel
6fa52f3c34 User manual: update html file
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-22 08:57:20 -08:00
Dirk Hohndel
4e468d6475 User manual: gps coordinates are tied to location names
While it seems obvious that you need a named dive site in order to track
its coordinates, apparently people try to have no location name but
distinct coordinates which at this time we do not support.

See #440

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-22 08:57:03 -08:00
Dirk Hohndel
4fad2c9172 User manual: Give credit where it's due
Willem has been maintaining the user manual for quite a while and at this
point is the main author, so he should be listed first.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-22 08:56:57 -08:00
Dirk Hohndel
a814a5c904 Updated the included user-manual.html
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-18 08:49:00 -08:00
Willem Ferguson
853ce0bbef User manual: Style and grammar updates
This is an edit for style and grammar for the manual section dealing with
downloads from DC. This section has also been expanded to cover all the
controls in the downloads panel.

Signed-off-by: Willem Ferguson <willem@willem-Precision-M4700.(none)>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-18 08:46:42 -08:00
Dirk Hohndel
59f60f39f6 Updated user manual html file
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-13 22:41:36 -08:00
Willem Ferguson
6496f4eb61 User manual: grammar and stylistic revision
This commit was jointly authored by Pedro Neves and Willem Ferguson.
Pedro added a FAQ section to the manual. Many long lines of text were
broken into shorter lines.

Signed-off-by: Willem Ferguson <willem@willem-Precision-M4700.(none)>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-13 22:38:06 -08:00
Willem Ferguson
af8c44fa22 User manual: small updates
The section on the main menu descriptions has been changed a little bit to
reflect the current menu structure.

The section dealing with exprt from other dive software has been changed
to appear more user friendly, with three new icons.

Signed-off-by: Willem Ferguson <willem@willem-Precision-M4700.(none)>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-11 12:36:37 -08:00
Dirk Hohndel
f7bb377287 User manual: update html file shipped with git repository
Every once in a while I need to update this so people building from source
who don't have asciidoc installed still have a reasonably current manual.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 06:53:01 -08:00
Willem Ferguson
cb7a87faef User manual: reorganize text on importing from other dive log software
Change and shorten in some places the section dealing with data import
from foreign software.

Create Appendix C, containing information on data export from foreign
packages.

Signed-off-by: Willem Ferguson <willem@willem-Precision-M4700.(none)>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 06:46:51 -08:00
Willem Ferguson
3217201bb7 User manual: replace some images, minor updates
Except for the images involving the dive profile, all the images now are
from Gnome 3. Images for dive profile awaits finalisation of the new dive
profile.

Small changes to the text of the manual have been done, the most important
of which is that dealing with using the unified import dialogue of
Subsurface.

Signed-off-by: Willem Ferguson <willem@willem-Precision-M4700.(none)>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-05 09:28:39 -08:00
Willem Ferguson
2f582f4fb1 User manual: Small text updates and new screenshots
This adds Gnome-based screenshots to the manual for most of the images not
involving the profile. More of the images remain to be done.

I rewrote small sections of the text to reflect some of the recent
changes. Several images still need to be replaced. The profile images will
be done once the profile panel has been finalised. Some text also still
needs working.

Signed-off-by: Willem Ferguson <willem@willem-Precision-M4700.(none)>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-31 09:16:17 -08:00
Miika Turkia
c4c7d85fb5 Adding some supported divelogs to importing info
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-25 06:53:04 -08:00
Miika Turkia
4b46385d64 Typo fixes on user manual
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-25 06:53:04 -08:00
Miika Turkia
f2a1171b15 Add manual CSV log import to UserManual
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-25 06:53:04 -08:00
Miika Turkia
25a9c23635 Update screenshot for CSV import
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-25 06:53:04 -08:00
Miika Turkia
ac290a923c CSV import instructions improved
Importing CSV files has changed slightly since writing this manual.
Updating accordingly. A typo fix as well (comma separated *values*).

Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-25 06:53:04 -08:00
Tim Wootton
07c116ecd2 Add ISO 6709 co-ordinates to manual
And fix a typo

Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-15 15:10:55 +07:00
Tim Wootton
df1391fde2 Adds Boris' Full Screen mode to the manual
Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-15 15:08:36 +07:00
Miika Turkia
ffe53224a2 Fix typo
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-06 20:48:24 +08:00
Dirk Hohndel
7771158c82 Prepare for 4.0.1 release
Small updates to README, ReleaseNotes, user manual.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-03 03:18:59 -08:00
Miika Turkia
54c8ae3a48 Update manual to reflect CSV import numbering
Patch f4db392a changed CSV import to use field numbers instead of
indexes. Thus removing the now incorrect description of numbering from
user manual. Note, that screenshot should be updated as well.

Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-29 04:24:07 -08:00
Willem Ferguson
c8e4ce9b81 User manual: update
1) Text about libdivecomputer log and dump files
2) Text about coordinate formats acceptable
3) Text about CSV import
4) Minor reorganisation of TOC

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-25 12:46:10 -08:00
Willem Ferguson
d72be58395 Replace figure of main screen with one that shows the main menu. Previous fig did not show manin manu.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-24 07:07:45 -08:00
Willem Ferguson
ebffd75a79 User manual: updates
Correct error in manual
Add some short text in sections dealing with equipment.

[Dirk Hohndel: clean up whitespace & regenerate the html file]

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-23 09:40:11 -08:00
Cristian Ionescu-Idbohrn
5b8586405f Correct small typo.
Signed-off-by: Cristian Ionescu-Idbohrn <cristian.ionescu-idbohrn@axis.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-23 09:33:07 -08:00
Cristian Ionescu-Idbohrn
73a8996609 Make XML and PDF version of user manual build again
Removing the offending tags in Documentation/user-manual.txt makes it
build.

Signed-off-by: Cristian Ionescu-Idbohrn <cristian.ionescu-idbohrn@axis.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-21 08:29:43 -08:00
Dirk Hohndel
17dfee415a Include the user-manual.html file in the git tree
This way when building Subsurface asciidoc is not necessary at all - except if
you want to work on the user manual and want to see the result of your work.

Previously the build wouldn't fail without asciidoc, but there would be no
working user manual when pressing F1 from within the application. This solves
the problem by shipping the HTML file with the sources.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 16:39:56 -08:00
Tim Wootton
cad0d45fe1 Splits long lines in manual
This allows patches to be read more easily
This prevents the lines longer than 998 error in git send-email
Breaks lines at somewhere near 80 chars where possible

Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-19 07:23:11 -08:00
Tim Wootton
ecc33e6375 Adds unhide to profile menu context menu
Unhide menu is only shown when hidden events exist.
Also updates relavent manual section.

Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-18 14:07:41 -08:00
Willem Ferguson
43385eb31a The info icon of the manual got mislaid somewhere
Here it is.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-16 09:46:18 -08:00