Commit graph

345 commits

Author SHA1 Message Date
Willem Ferguson
eed9a4b0f2 User manual updates.
1) Put table of contents as a column on the left-hand side of the page
   instead of as part of the user manual text.
2) Correct a some typoss.
3) Add three sentences to the Bluetooth download section to deal with
   Bluetooth Pass Codes.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-10-27 21:52:33 +09:00
Willem Ferguson
dffd2857f6 User manual updates
1) Delete duplicate or unused images in Documentation/images directory
2) Add text to describe user manual viewer functionality
3) Add image to explain 2) above
4) Add text to explanation of TTS toolbar button (Thank you very much, Davide!)
5) Update image showing display of TTS toolbar button

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-10-19 09:46:02 -07:00
Robert C. Helling
0f63b524a6 Mention Shearwater Nerd
alongside Petrell 2 since this seems to be the same computer internally.

Signed-off-by: Robert C. Helling <helling@atdotde.de>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-10-18 17:37:49 -07:00
Sergey Starosek
6817504f95 User manual tidy-up
Signed-off-by: Sergey Starosek <sergey.starosek@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-10-14 05:50:27 -07:00
Willem Ferguson
8d546bc8c0 User manual: last changes before V4.5
1) Run a spell checker through the user manual. Only three
   outright typos found!!
2) Correct sentence about reverse name lookup that results in
   dive site name reported in tags field, not in Location field.
   (Sergey, thank you!)

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-10-13 08:46:54 -07:00
Willem Ferguson
846a4ce319 User manual update: Facebook
1) Update the image relating to fb access
2) Update the text relating to fb access
3) Update text about imgae fingerprints
4) Replace 6 more images to reflect latest UI

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-10-13 07:50:15 -07:00
Willem Ferguson
b2deb28f58 User manual updates: Dive site management and others
1) Update the text on dive site management to make it cohesive.
2) Update text on recreational dive planning.
3) Replace one image for rectreational dive planning.
4) Perform several small changes to correct inaccuracies
   or inconsistencies pointed out by Sergey.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-10-12 12:54:56 -07:00
Willem Ferguson
38f2e310f3 User manual: Print dive logs
--001a11c260ce9093a70521eafe5d
Content-Type: text/plain; charset=UTF-8

 [PATCH] User manual: Print dive logs

    This patch replaces two figures in the user manual, concerning the
    printing of dive logs.

    1) Two images are replaced.

    2) The text of the user manual is changed to reflect the latest code.

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

<div dir="ltr"> [PATCH] User manual: Print dive logs<br>    <br>    This patch replaces two figures in the user manual, concerning the<br>    printing of dive logs.<br>    <br>    1) Two images are replaced.<br>    <br>    2) The text of the user manual is changed to reflect the latest code.<br>    <br>    Signed-off-by: Willem Ferguson &lt;<a href="mailto:willemferguson@zoology.up.ac.za">willemferguson@zoology.up.ac.za</a>&gt;<br><br></div>

From 2f0b54fe6e38014b909ed1d9c6acb797921a5158 Mon Sep 17 00:00:00 2001
From: Willem Ferguson <willemferguson@zoology.up.ac.za>
Date: Mon, 12 Oct 2015 18:37:54 +0200
Subject: [PATCH] [PATCH] User manual: Print dive logs

This patch replaces two figures in the user manual, concerning the
printing of dive logs.

1) Two images are replaced.

2) The text of the user manual is changed to reflect the latest code.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-10-12 09:53:07 -07:00
Willem Ferguson
3f457edcf6 User manual: Preferences panels.
Six of the images in the text describing the Preferences are replaced
to reflect the latest code.

One addition image is added, describing georeferencing.

The text of the user manual is updated to reflect the new images.
Many typos are corrected.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-10-12 09:52:56 -07:00
Sergey Starosek
bfaf57e1ec Remove UTF BOM from user manual files
Signed-off-by: Sergey Starosek <sergey.starosek@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-10-09 13:12:58 -07:00
Sergey Starosek
2fd42cc1e4 User manual spelling fixes and tidy-up
Signed-off-by: Sergey Starosek <sergey.starosek@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-10-09 13:12:06 -07:00
Willem Ferguson
b74809b62d user manual: Bluetooth douwnload
Clean up the text on the above issue. Many thanks, Claudiu.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-09-27 06:11:05 -04:00
Claudiu Olteanu
8462ae27b2 User manual update: Bluetooth section
Update the user manual with information about the new Bluetooth
download mode feature.

Signed-off-by: Claudiu Olteanu <olteanu.claudiu@ymail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-09-25 09:57:11 -07:00
Willem Ferguson
9d1c3942d7 User manual update: Put back manual Bluetooth procedures
Put back the procedures for manually achieving a Bluetooth connection
into APPENDIX A.
Refer to the manual procedures from the text that described the new
built-in Subsurface Bluetooth interface.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-09-24 07:23:14 -07:00
Willem Ferguson
c15c588ef9 User manual systematic review (Part 4)
1) Delete section on mobile application
2) Update Preferences and Menu options sections

No images are added or replaced.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-09-23 20:11:53 -07:00
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