Commit graph

145 commits

Author SHA1 Message Date
Tim Wootton
85fd75ad51 Remove possible dual meaning in Divemaster and Buddy.
Pedantic Tim says "Barring waterproof device, most of us won't
be entering these fields during the dive." ;-)

Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-09 22:44:58 +01:00
Tim Wootton
afe065744f Removes imperative to not save-as-you-go.
Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-09 22:44:25 +01:00
Willem Ferguson
8b74ffc35b Updated user manual
1) Added Main Menu items description
2) Added Divelogs.de description
3) Removed paragraph defining EAD & END
4) Several typos corrected
5) Positions of several figures standardised to align="central"

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-09 21:38:16 +01:00
Dirk Hohndel
4675ab0617 Fix possible compatibility issue with asciidoc
Apparently some version os asciidoc don't support the --theme option.
Work around this by using -a theme='theme' instead.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-09 16:12:36 +01:00
Willem Ferguson
9156bd0efb Missing images for the manual
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-09 16:05:51 +01:00
Willem Ferguson
3a49ad6ba5 Update to manual
- Companion app added
- Figures updated & reorganised
- Small amount of reorganisation of text
- Typos corrected

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-09 13:54:11 +01:00
Tim Wootton
e7a657c72b Removes unnecessary references to number of elements in
the date field

Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-09 10:14:50 +01:00
Tim Wootton
2f3d18d001 Updates main menu entries
Updates summary of main menu entries to those in the new GUI

Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-09 10:14:43 +01:00
Tim Wootton
21e14933ac Replaced writing email to, with sending an email to
Seems to read better as "sending an email to"

Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-09 10:14:27 +01:00
Salvador Cuñat
f84e4ef4ee Clarification on EAD and END meaning in Subsurface
As pointed out in commit 23ce727 by Dirk and remembered Jan, there are different
meanings for EAD and END depending on organisations.  Let's explain a bit the one
Subsurface has choosen,  as this is confusing, even while translating the acronyms.

Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-08 16:14:17 +01:00
Willem Ferguson
d84f397790 Add compact style to the Documentation
The Makefile changes were authored by Dirk, the CSS is based on a public
domain CSS file and authored by Willem

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-08 07:50:34 +01:00
Werner Macho
939aafa73f Fixing a few typos in Documentation
Signed-off-by: Werner Macho <werner.macho@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-07 07:23:45 -08:00
Dirk Hohndel
32264cf393 Explain invalid dive option in preferences
Just trying to fill in minor gaps.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-06 11:53:01 -08:00
Dirk Hohndel
157827c71b Capitalize Subsurface in the documentation
This is a small detail but we should try to be consistent there.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-06 11:50:35 -08:00
Willem Ferguson
710fba9aa6 Add images missing from previous commit
This was Dirk's mistake when applying the patch.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-06 11:44:14 -08:00
Willem Ferguson
75e8b1eeff Usermanual update.
1) Several layout changes including banner.
2) Stylistic revision of part of textr.
3) Addition of text to dive computer upload section.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-06 10:59:55 -08:00
Salvador Cuñat
c7a4bb185c Companion app and downloading GPS coordinates from web service
A first try on documenting the companion app and explanation on how to use
it combined with Subsurface.

Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-06 09:22:13 -08:00
Willem Ferguson
fb169db292 Updates to user manual
1) Inserted section on Information Box on dive profile
2) Iserted short section on import from Mares Dive Organiser
3) Corrections to spelling and style not included in previous commits.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-05 14:11:17 -08:00
Sergey Starosek
fe713d37f4 User manual spelling fixes
Signed-off-by: Sergey Starosek <sergey.starosek@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-05 07:31:07 -08:00
Willem Ferguson
07c63c511b subsurface user manual update
References to literature on gradient factors changed (see dive profile
section, also preferences section)

Section on preference settings added.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-04 12:22:06 -08:00
Willem Ferguson
7c8e95e1b5 Update to user manual
Made changes to dive profile section.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-03 13:13:01 -08:00
Willem Ferguson
83766db87b A further update to the user manual
I have added a section about importing dives from other electronic
sources. There are some potential problems, because I know that the
intercation with divelogs.de is not yet fully functional

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-02 06:54:20 -08:00
Willem Ferguson
795992b1f7 Update to user manual, adding several sections and some graphics
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-01 07:44:59 -08:00
Willem Ferguson
5948aa5650 A first update of subsurface V4.0 manual
This starts mostly from scratch. It removes big chunkgs of the old manual,
the old pictures and starts with new visuals and new descriptions. A lot
more work is needed, but it's a good start.

Signed-off-by: Willem Ferguson <willem@willem-Precision-M4700.(none)>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-11-19 09:40:14 -08:00
Thiago Macieira
67e49d6480 Implement a qmake-based build for Subsurface
This is working for me, but requires a bit more testing. To build,
run:
  qmake [options]

Where options might be:
  V=1               disable "silent" build
  LIBDCDEVEL=1      use side-by-side libdivecomputer
  INCLUDEPATH+=xxx  add -Ixxx (e.g., INCLUDEPATH+=/usr/local/marble/include)
  LIBS+=xxx         add xxx to the linker flags (e.g. LIBS+=-L/usr/local/marble/lib)
  or any other qmake option, including debug and release options

If your distribution is already using qtchooser in place of qmake, you
may need to pass an extra option to qmake to select the a
cross-build. For example:

  qmake -qt=i686-w64-mingw32-qt4

If your distribution is not yet using qtchooser, then you need to file
a bug report requesting it and you need to run the full path to qmake.

Note:
 - there are some ### left in the buildsystem

Signed-off-by: Thiago Macieira <thiago@macieira.org>
2013-10-08 23:29:33 -07:00
Dirk Hohndel
de8bfe9bc3 Crude hack to stop the build from failing without asciidoc
This could be made much more elegant. For now it serves its purpose.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-08-05 17:22:11 +02:00
Dirk Hohndel
582d1157ed Updates to the lists of supported dive computers
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-05-17 22:33:49 -07:00
Dirk Hohndel
082ec43eea Documentation: improve instructions for upload to divelogs.de
Suggested-by: Peter Konings <peter.l.e.konings@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-05-17 10:28:53 -07:00
Dirk Hohndel
59a0c5cdcd Documentation: update divelogs.de export explanation
Thanks to commit 347019272a57 ("Hide user password in Upload to
divelogs.de dialog") we no longer show the password on screen.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-05-16 17:49:01 -07:00
Dirk Hohndel
d6f279a415 Documentation: more tweaks/additions to "Viewing and Completing Your Logs"
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-05-15 22:39:19 -07:00
Dirk Hohndel
3a37554f35 Documentation: describe trips in the dive list
Both autogroup and manual creation of trips is explained. Once the user
looks at manual creation, the other trip manipulation options should be
fairly self-explanatory.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-05-15 22:31:56 -07:00
Dirk Hohndel
5b97344b83 Documentation: multiple small corrections and improvements
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-05-15 22:22:20 -07:00
Dirk Hohndel
6766c56220 Documentation: add explanation on editing events in the dive profile
Context menu to remove events or add bookmarks or gas change events.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-05-15 21:33:26 -04:00
Thomas Maisl
ac82837a68 Addition / change to the user manual
- give an introduction to the dive list and explain some behaviour of dive
  list to new users
- a small clarification regarding the used Buhlmann-algorithm

Signed-off-by: Thomas Maisl <exp-122004@maisl.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-05-15 16:53:03 -04:00
Dirk Hohndel
935273c9e7 Documentation: update reference to 6m stop in dive planner
Thanks to Miika we have an updated screenshot

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-05-15 01:20:55 -04:00
Miika Turkia
f330942804 New dive planning screenshot with 6m stop in it
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-05-15 01:15:51 -04:00
Dirk Hohndel
04c69c9eb2 Documentation: update regarding dive computer device drop down list
This reflects the change made in commit bf34940bc5e4 ("Conditionally
enable the device combo box.").

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-05-14 19:52:55 -04:00
Dirk Hohndel
ff417cb140 Hardware updates for README, ReleaseNotes.txt and user-manual
Decided to split OSTC3 and Petrel in the ReleaseNotes (as the Petrel was
already supported in 3.0) and added the Suunto DX as well.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-05-14 05:44:28 -04:00
Dirk Hohndel
bf5113fb2f Documentation: update "The Menu and Sub-Menus"
Complete rewrite of the 'Filter' and 'Help' sections.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-05-13 17:29:13 -05:00
Dirk Hohndel
95f9ba800b Documentation: update "Web Service and Companion App"
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-05-13 17:17:13 -05:00
Dirk Hohndel
ca0bad84f8 Documentation: update "Planning Dives"
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-05-13 17:06:36 -05:00
Dirk Hohndel
0fe1c316d6 Documentation: update "Exporting Dives from Subsurface"
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-05-13 16:46:18 -05:00
Dirk Hohndel
ca185cd9d9 Documentation: update "Setting up Preferences"
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-05-13 14:22:48 -05:00
Dirk Hohndel
a9d10617fb Documentation: update "View Dive Info & Stats"
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-05-13 13:38:10 -05:00
Dirk Hohndel
14f18ea9f2 Documentation: update "Viewing and Completing Your Logs"
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-05-13 13:32:33 -05:00
Dirk Hohndel
45ea280366 Documentation: update "Import New Dives..."
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-05-13 13:22:41 -05:00
Dirk Hohndel
c7919c3f05 Documentation: update "Start Using the Program"
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-05-13 11:01:40 -07:00
Dirk Hohndel
5cb7e22a9d Documentation: update "Requirements"
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-05-13 11:01:32 -07:00
Dirk Hohndel
f8403b6f05 Documentation: update version number and "Introduction"
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-05-13 11:01:23 -07:00
Robert C. Helling
a5b8687003 Documentation: USB permissions and planner times
Fix permissions on Ubuntu and relative instead of absolute default times
in planner

This contains two changes: One documents the fact that in the planner the
default for time is relative and an absolute time needs an @ sign.

The other hopefully explains how to solve permission problems for USB
devices on Ubuntu: I am told, an USB dongle that pretends to be a serial
port by default does not have the required permissions for the standard
user to write. The transfer then fails with an 'obscure' error message.
The transfer works if subsurface is run by root (which obviously is a bad
idea) or with chmod.  Unfortunately, at least Ubuntu 'fixes' permissions
on reboot. So one either has to fiddle with this (seems to be more
complicated) or add the user to the group 'dialout" which gets write
permissions to serial lines.

This is in theory. I don't have access to an Ubuntu installation to see if
all this is indeed the case. That's why I did not send the patch in the
past. But I think this is still better than what we have so far.

Signed-off-by: Robert C. Helling <helling@atdotde.de>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-05-08 12:24:18 -07:00