Commit graph

277 commits

Author SHA1 Message Date
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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