Commit graph

330 commits

Author SHA1 Message Date
Willem Ferguson
a761a33069 User manual: Bluetooth UI description
1) Inser Bluetooth UI description at end of section dealing with dive download.
2) Delete existing text in appendices that detail pairing a Bluetooth device with
   the Subsurface computer.

One image is added to the manual.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-09-22 19:36:54 -07:00
Willem Ferguson
ce134fb763 User manual update 1) replace three images 2) change text of user manual to reflect the three images correctly
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-09-21 10:16:50 -07:00
Willem Ferguson
d8baaac124 Systematic user manual update (Part 3)
From DiveList section to printing section

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-09-21 10:16:35 -07:00
Willem Ferguson
30d953d4fe User manual: Systematic review (part 2)
As the title says.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-09-16 21:32:22 -07:00
Salvador Cuñat
e945134cc4 Unify use of Bühlmann spelling in user-manual.txt
Also modified user-manual_fr.txt.
Russian and spanish translations didn't have any occurrence of Buehlmann
nor Buhlmann.

Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-09-16 21:16:58 -07:00
Willem Ferguson
91fca9ddd5 Updates: user manual review (part 1)
Systematic review of existing text (part 1)

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-09-16 11:17:20 -07:00
Willem Ferguson
2dd52b4921 User manual update: Cloud services
This ammends the existing text on cloud services.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-09-14 21:01:10 -07:00
Willem Ferguson
d0b26c6e57 User manual update: Dive planner
1) Added text to reflect VPM-B dive planning
2) Replaced 5 images in dive planner chapter.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-09-14 21:01:07 -07:00
Dirk Hohndel
0dd32d3495 Document simplified web access to cloud storage data
The backend now redirects you to the correct URL once you log in with your
email address and password. So all the user needs to know is to go to
https://cloud.subsurface-divelog.org

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-09-10 09:52:21 -07:00
Willem Ferguson
e4c0f3f3e2 User manual update: Location management
1) Add text to cover location management
2) Delete duplicate text for entering dives manually
   and entering dives from a dive computer. The sections dealing
   with location, cylinders, weights, and other items on the Info tab
   were duplicated for these two types of data entry into Subsurface.
   This duplication is now removed.
3) Replace five screen shots

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-09-08 10:06:10 -07:00
Willem Ferguson
384ab944f2 Updates to user manual: dive log printing and APD CCR import
Updates to the APD import interface that Miika has recently completed.
Updates to reflect the new print interface. Added some images and modified
existing text.
Swapped APPENDIX E and APPENDIX F so that FAQs are at end of document.
Updated appendix [F] dealing with customising print templates.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-09-07 07:28:13 -07:00
Dirk Hohndel
8afd5e8bbc A few more version number updates
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-08-31 18:49:13 -07:00
Grace Karanja
7115f6e237 QML UI: Documentation: Introduce the app
Basic documentation on how to log into the app and how to load dives,
view them, edit and save changes.

[Dirk Hohndel: heavily edited commit to remove all the unintended changes]

Signed-off-by: Grace Karanja <gracie.karanja89@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-08-31 15:59:20 -07:00
Gehad elrobey
20c22596f0 Printing: update the user-manual
Add printing description to the user-manual, also add appendix F
which describes how to write a custom template for Subsurface.

Signed-off-by: Lubomir I. Ivanov <neolit123@gmail.com>
Signed-off-by: Gehad elrobey <gehadelrobey@gmail.com>
2015-08-22 18:33:07 +03:00
Miika Turkia
577965cc26 Add FAQ item of missing logs to user manual
[Dirk Hohndel: added corresponding entry to the FAQ]

Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-08-03 22:32:34 -07:00
Salvador Cuñat
75e736a66b User Manual: Slight changes on OSTCTools import
Don't give sensation that OSTCTools is a H&W software, which it isn't.
Little adds on supported DCs and other considerations.

Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-07-27 06:37:34 -07:00
Miika Turkia
25ea932e81 Update user manual to reflect new way of DivingLog import
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-07-23 13:57:24 -07:00
Dirk Hohndel
60bd4288c7 User manual: first stab at documentation of Subsurface cloud storage
This needs screenshots and better wording, but it's a start.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-06-14 15:10:13 -07:00
Rick Walsh
ffa6a23590 Correct default RFCOMM channel in documentation
The default RFCOMM channel is 1, not 0 as previously stated in FAQ and
user manual.  This patch corrects it.

Signed-off-by: Rick Walsh <rickmwalsh@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-05-26 12:14:06 -07:00
willem ferguson
bb68bbcc69 User manual: update section on Bluetooth
User manual: update section dealing with Bluetooth communication
to reflect Rick's recent contribution. Some editing of the text
was performed to conform to Manual style. This section looks MUCH better now.

Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-05-23 14:19:24 -07:00
willem ferguson
0e78915c7e A few small changes to the user manual:
1) Descriptions of main menu items.
2) Windows drivers for the galileo dive computer.

Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-05-18 13:53:51 -07:00
willem ferguson
2894ee0759 User manual update
This adds text to the following sections:
1) Dive planner (Open circuit planning)
2) Dive Planner (Recreational OC planning)
3) Use of hashes to move images between directories
4) Undo/Redo feature of dive list manipulations

One image in planner text is modified.

Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-05-02 11:26:39 -07:00
willem ferguson
b846915f43 User manual update: OSTC Tools integration
Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-05-02 11:26:18 -07:00
willem ferguson
2286bc89de Add text to user manual: Recreational dive planning One figure has been added
Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-04-30 07:18:28 -07:00
willem ferguson
c7c9b0155f Update of user manual text dealing with dive list context menu
As the title says above

Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-04-26 10:32:31 -07:00
Henrik Brautaset Aronsen
961bac9233 Rename the tab "Dive info" to "Info", and "Dive notes" to "Notes"
Signed-off-by: Henrik Brautaset Aronsen <subsurface@henrik.synth.no>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-02-14 11:18:53 -08:00
Sergey Starosek
4817bb2991 Add missing Atomic Aquatics logo
Signed-off-by: Sergey Starosek <sergey.starosek@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-02-10 10:45:46 -08:00
Sergey Starosek
f591ead1ec User manual spelling fixes
Signed-off-by: Sergey Starosek <sergey.starosek@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-02-10 07:22:29 -08:00
willem ferguson
7b44cf2a61 User manual: small updates
A section on multicylinder dives has been added.
Just to warm LongJohnSilver's heart, a short section on pSCR has been added.
Please feel free to add to the pSCR section, LongJohn.
Replaced the sidemount figure with obsolete mean depth line.

Fixes #827
Fixes #828

Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-02-05 11:27:35 -08:00
Patrick Valsecchi
bd9a443793 More tolerant when parsing GPS coordinates.
Refactored the parsing logic to make it more solid (no more guessing) and
more flexible (support more formats).
Added a test for checking that.
Fixed a few warnings.

[Dirk Hohndel: some changes to coding style]

Signed-off-by: Patrick Valsecchi <patrick@thus.ch>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-02-04 10:51:27 -08:00
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
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
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
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
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
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
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