Commit graph

381 commits

Author SHA1 Message Date
Dirk Hohndel
06e2dde508 Get ready for Subsurface 4.4
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-02-04 07:54:44 -08:00
Salvador Cuñat
636376f591 Update spanish translation of user manual to english 66c4529
Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-02-03 14:40:30 -08:00
Guillaume GARDET
fdb736c1e1 Documentation: update french translation
Update french translation of user-manual and merge latest user-manual updates.

Signed-off-by: Guillaume GARDET <guillaume.gardet@free.fr>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-02-03 07:19:24 -08:00
Dirk Hohndel
b71ee970db Add the FAQ to the git repository
This file is straight from WordPress and therefore has the odd mixed
markup of WordPress. Some HTML, some shortcodes and the super annoying
"oh, <p> ... </p> is too complicated, let's pretend that line breaks are a
better way to do this" logic that I hate more than any other WordPress
oddity...

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-02-02 08:27:25 -08:00
Dirk Hohndel
06a899bb96 User manual: modifications to the Facebook information
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-02-02 07:20:00 -08:00
willem ferguson
6913ff578c User-manual: Add text and images for Facebook intergration 5 images are 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-02-02 07:10:40 -08:00
Salvador Cuñat
55810fb032 Update spanish translation of user manual to english 47c5a28f
Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-02-01 09:12:05 -08:00
willem ferguson
66c4529088 User manual: Updates for iphone app for subsurface GPS serevice
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-31 10:21:59 -08:00
willem ferguson
6ae5c9271d User-manual: Dive planner text
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-30 17:13:08 -08:00
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