Commit graph

789 commits

Author SHA1 Message Date
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
Miika Turkia
6f750da063 Updating user documentation to reflect current version
Most of the new stuff from UI perspective should now be documented.
Bumped also the doc version number optimistically.

Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-05-02 08:32:05 -07:00
Amit Chaudhuri
29be221bd8 Reorganise view menus and file import.
Move the view submenu to a top level location.

Alter the wording of File|Import to drop XML qualifier; we import more
formats than this.

Signed-off-by: Amit Chaudhuri <amit.k.chaudhuri@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-03-08 08:48:52 -08:00
Miika Turkia
eee29f2187 DM4 import user documentation update
Instructions how to find the effective database file from DM4, using
this method there is no need to rename the backup as the original file
works as is when found from a random directory structure.

Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-03-07 10:27:52 -08:00
Amit Chaudhuri
f3e7b1ad68 Trivial change to documentation
The user-manual.txt file limits its own scope to usage and points to a
non-existant "build manual." Make clear that we really mean the README file.

Signed-off-by: Amit Chaudhuri <amit.k.chaudhuri@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-03-05 07:43:41 -08:00
Miika Turkia
a94f7807f8 Limited support for Suunto DM4 import
Basic functionality is implemented but at least support for multiple
cylinders is missing. Event/alarm support is only partial.

Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-03-04 22:08:03 -08:00
chrislewis915@gmail.com
a6a487306e Some Small Documentation Changes
- Made a few small changes to user-manual.txt to inprove readability
  in English
- Made reference to Map Provider selection in 'Preferences'

Signed-off-by: chris <chrislewis915@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-03-04 22:06:57 -08:00
Dirk Hohndel
a5a3e0a72e Update README, ReleaseNotes and Makefile for 3.0.2
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-03-03 23:49:32 -08:00
Jan Schubert
93eeb03d67 Extending user manual
Adding UDDF support for DR5, kenozooid and in general, fixed some things, updated to 3.0.2

Signed-off-by: Jan Schubert <Jan.Schubert@GMX.li>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-03-03 16:01:49 -08:00
Dirk Hohndel
e5f2f3e65f Better Bluetooth device support on Mac
We now show the correct device name for Bluetooth connected dive computers in
the drop down menu in the Download dialog.

This also updates the corresponding chapter in user manual.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-28 07:43:31 -08:00
Jan Schubert
4dc14c9051 Documentation: Add Mac related info to the bluetooth section
Signed-off-by: Jan Schubert <Jan.Schubert@GMX.li>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-28 05:25:50 -08:00
Cristian Ionescu-Idbohrn
f04d9c5656 Small typo correction.
One 'r' removed.

Signed-off-by: Cristian Ionescu-Idbohrn <cristian.ionescu-idbohrn@axis.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-27 07:41:40 -08:00
Jan Schubert
16d9f3007f Documentation: fixed some typos in bluettoth part of user manual
[Dirk Hohndel: some fixes of the fixes...]

Signed-off-by: Jan Schubert <Jan.Schubert@GMX.li>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-26 13:03:54 -08:00
Dirk Hohndel
fd9a927ded Update versions to 3.0.1
almost forgot

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-26 12:57:59 -08:00
Jan Schubert
bd6a33f4bc Documentation: add pictures for Bluetooth setup
Signed-off-by: Jan Schubert <Jan.Schubert@GMX.li>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-26 12:50:39 -08:00
Dirk Hohndel
ea57927554 Documentation: update formatting
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-26 12:44:41 -08:00
Jan Schubert
e687e81ca4 extend user manual for setting up bluetooth communication.
This extends the user manual for setting up bluetooth communication.

Signed-off-by: Jan Schubert <Jan.Schubert@GMX.li>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-26 12:39:09 -08:00
Jan Schubert
906803b80f Documentation: add information for Bluetooth connected devices
[Dirk Hohndel: did some reformatting and rewriting]

Signed-off-by: Jan Schubert <Jan.Schubert@GMX.li>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-26 10:04:09 -08:00
Dirk Hohndel
0b5c48ee4e Documentation: DivingLog needs to be set to Metric prior to export
Since their XML file gives us no information as to the measurement system
used we need to ask the user to explicitly set it to metric before they
create the XML file.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-26 09:26:09 -08:00
Dirk Hohndel
5bc56c9c7e Documentation: add brief section about DivingLog export
Fixes #63

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-25 09:23:39 -08:00
Dirk Hohndel
fb70834a30 Documentation: correct the meaning of different colors in profile
In commit 0f31b71c3588 ("User documentation - describe the dive profile")
the description of the depth profile coloring was incorrect.

I also fixed some language issue and tried to better describe the zoom
options.

Finally I increased the revision number of the user manual.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-25 07:40:18 -08:00
Miika Turkia
5927542999 User documentation - describe the dive profile
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-25 07:25:41 -08:00
Dirk Hohndel
dab04aa3d5 Documentation: correct mis-spelling
It's the Heinrichs Weikamp Frog, not From.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-22 07:08:48 -08:00
Dirk Hohndel
7f8c78633b Documentation: minor spelling corrections
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-20 22:12:24 -08:00
Dirk Hohndel
91c6d57e32 Correctly capitalize JDiveLog
Suggested-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-20 22:02:40 -08:00
Reinout Hoornweg
2c3327d1b7 Documentation: Consistent spelling of "Buhlmann"
Replaced "Bühlmann" with "Buhlmann".

Signed-off-by: Reinout Hoornweg <reinout@xs4all.nl>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-20 17:17:20 -08:00
Henrik Brautaset Aronsen
b354fc67bc Update user documentation with divelogs.de suffix change
divelogs.de use DLD as suffix, not ZIP

Suggested-by: Rainer Mohr <mail@divelogs.de>
Signed-off-by: Henrik Brautaset Aronsen <subsurface@henrik.synth.no>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-20 12:06:34 -08:00
Reinout Hoornweg
9f5a636c6a Documentation: Formatting "Setting up Preferences"
- Reformatted a few lists-used-as-tables in "setting up Preferences"
  to be real tables.

Signed-off-by: Reinout Hoornweg <reinout@xs4all.nl>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-20 11:59:21 -08:00
Dirk Hohndel
7374f3eaf1 It seems that asciidoc doesn't allow dots in BlockIDs
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-20 11:23:52 -08:00
Henrik Brautaset Aronsen
7da4bc928c Add divelogs.de export info to the manual
Replaces the FIXME's in Miiko's patch

Signed-off-by: Henrik Brautaset Aronsen <subsurface@henrik.synth.no>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-20 11:00:43 -08:00
Miika Turkia
f6debdc183 Add info on importing divelogs.de to user manual
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-20 10:59:16 -08:00
Reinout Hoornweg
18a4d76ca5 Documentation: more tables in "View Info & Stats"
- Even more tables.
- Renamed the chapter to "View Dive Info & Stats" because one of the
  tabs being described is named "Dive Info" and not "Info".

Signed-off-by: Reinout Hoornweg <reinout@xs4all.nl>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-19 15:19:35 -08:00
Cristian Ionescu-Idbohrn
806f4f87e0 Makefile quorks :( Yes we want a 'doc' target for itself...
...to avoid generating the HTMLDOC target even if it needs not to.

Signed-off-by: Cristian Ionescu-Idbohrn <cristian.ionescu-idbohrn@axis.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-19 15:16:41 -08:00
Reinout Hoornweg
bd9503d7c2 Documentation: Updated "Edit Equipment Info"
- More lists converted into tables.
- Minor changes to text.

Signed-off-by: Reinout Hoornweg <reinout@xs4all.nl>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-19 15:16:29 -08:00
Miika Turkia
e544594d9b Documentation: update main windows image
Sent to the list by Miika for inclusion in the user manual...

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-19 13:13:33 -08:00
Reinout Hoornweg
5ad892f590 Documentation: updated section "Edit the Dive Info"
- Made tables of semi-formatted texts.
- Rewrote some of text because the screenshot and table are both
  about the same thing. The screenshot is more important now, the
  table is explanation of screenshot.

Signed-off-by: Reinout Hoornweg <reinout@xs4all.nl>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-19 13:11:21 -08:00
Miika Turkia
95f5098bcb Screenshot for preferences
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-19 09:19:08 -08:00
Miika Turkia
dd42b8d444 Added information about yearly statistics
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-19 09:18:44 -08:00
Miika Turkia
bf47f19605 Removing chapter Adding Equipment info
All this can nowadays be done from the dive editing popup so a separate
chapter describing the editing on info tab is not necessary.

Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-19 09:18:26 -08:00
Miika Turkia
e78f9f9171 A couple of screenshots added
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-19 09:17:42 -08:00
Miika Turkia
8facc61e8f [PATCH] Adding screen captures of dive planning
[Dirk Hohndel: removed the images folder from the Documentation directory
               Makefile clean target]

Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-19 06:55:38 -08:00
Cristian Ionescu-Idbohrn
17638aa7b0 Cleanup more and rearrange targets.
Signed-off-by: Cristian Ionescu-Idbohrn <cristian.ionescu-idbohrn@axis.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-19 06:51:29 -08:00
Cristian Ionescu-Idbohrn
bc98b3f6f2 Improved maitainability.
Cleans up more files.
Got even an 'all' target :)

Signed-off-by: Cristian Ionescu-Idbohrn <cristian.ionescu-idbohrn@axis.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-19 06:50:20 -08:00
Reinout Hoornweg
866a9f0a0f Documentation: fixed a few typos
- Suunto Viper is actually Vyper.
  I actually used to own both a Vyper and a Vyper Air, so I care. :-)
- Fixed a few other small typos.

Signed-off-by: Reinout Hoornweg <reinout@xs4all.nl>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-18 15:18:39 -08:00
Reinout Hoornweg
453c48f0ab Documentation: improve layout
Added headers, borders, etc. to the table in "Viewing and completing
your logs".

Signed-off-by: Reinout Hoornweg <reinout@xs4all.nl>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-18 14:54:35 -08:00
Reinout Hoornweg
51cac900aa Updates to the user-manual: DivePlanning
- Added some more text to Miika's great start describing the planner.
- Tried doing something more with the formatting options asciidoc give us.

[Dirk Hohndel: merged with my earlier changes to the same section]

Signed-off-by: Reinout Hoornweg <reinout@xs4all.nl>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-18 13:28:25 -08:00
Dirk Hohndel
55cb953922 Documentation: Chapter structure & header cleanup
Most everything was a top level chapter - this tries to impose some
structure. It also moves the "finding the device" section closer to where
it should be in the logical flow.

This also made the header more "asciidoc compliant" and added the other
significant authors to the list.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-18 12:39:33 -08:00
Dirk Hohndel
182a02b2db Documentation: small rewrite of the dive planning chapter
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-18 12:17:36 -08:00
Dirk Hohndel
f3b6e09d09 Documentation: attempt consistency in headings and links
This changes the capitalization of headings and aims to get a consistent
style of internal links. Linking to chapter numbers is very fragile as
asciidoc sadly doesn't support this in an automated fashion - so instead
we reference chapter titles (also manual, but at least less fragile when
chapters are inserted)

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-18 11:49:44 -08:00
Dirk Hohndel
8362a22f9f Documentation: minor rewrite of the Mac Driver appendix
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-18 11:25:37 -08:00
Dirk Hohndel
f52486e4e1 Documentation: minor spelling and consistency fixes
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-18 11:21:06 -08:00
Dirk Hohndel
a351aa6dbc Documentation: Briefly explain the download from web service
This sounds rather lame as the app hasn't been released but it is too
useful to not have it in 3.0

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-18 11:14:23 -08:00
Miika Turkia
fbde4b1783 user manual - planning dives
The attached patch is the ugly start for dive planning. Hopefully
someone will enhance it from and add whatever essential is missing.

miika

From 2d51a56489fde7086032fb5efeeea6e9032ec1ba Mon Sep 17 00:00:00 2001
From: Miika Turkia <miika.turkia@gmail.com>
Date: Mon, 18 Feb 2013 19:04:14 +0530
Subject: [PATCH] Instructions for basic dive planning

Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-18 10:25:55 -08:00
Dirk Hohndel
65aba97c55 Documentation: apparently dive computer are two words
We use "divecomputer" in many places and while that is a data structure in
Subsurface it apparently is not a word.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-17 20:55:27 -08:00
Miika Turkia
3afd971e4a Moving common information to Import introduction
Writing an introductory chapter for the divelog import and moving
relevant content to it

Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-17 11:11:01 -08:00
Miika Turkia
fa08ef2ee3 Added import info for MacDive
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-17 11:10:39 -08:00
Miika Turkia
85063200a0 Tweaking download texts
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-17 11:10:26 -08:00
Miika Turkia
aefe9c952e Typos
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-17 11:10:10 -08:00
Miika Turkia
37747b2dd2 Consistent way of writing divelog
Use a single form when writing divelog (same syntax as in About box)

Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-17 11:09:47 -08:00
Miika Turkia
3bd6b08e23 Requirements can also be filled with existing logs
It is not an absolute requirement to download directly from the dive
computer but we also support importing logs from certain log formats.

Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-17 11:09:18 -08:00
Dirk Hohndel
f65afb9800 Documentation: Update "Import new dives from your divecomputer"
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-16 22:26:11 -08:00
Dirk Hohndel
95b0c0646d Documentation: update "Import new dives from a Uemis Zurich"
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-16 22:21:47 -08:00
Dirk Hohndel
eabb2d117b Documentation: update "how to find the Device Name
- mention the improved drop down
- clarify the the explanation is for Linux and give brief intro for
Windows and MacOS

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-16 22:16:30 -08:00
Dirk Hohndel
3ef8e7c246 Documentation: update list of supported divecomputers
Taken directly from the libdivecomputer website...

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-16 21:59:10 -08:00
Dirk Hohndel
fc60d37761 Documentation: rewrite the Introduction for 3.0
Just trying to reflect the reality a bit better.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-16 15:31:07 -08:00
Dirk Hohndel
2706c48277 Documentation: Update version and authors
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-16 15:27:46 -08:00
Reinout Hoornweg
165e0aacb1 Update to user-manual: log-menu
- Added menu entries for webservices, device nicknames and the divemap.

Signed-off-by: Reinout Hoornweg <reinout@xs4all.nl>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-16 15:21:54 -08:00
Reinout Hoornweg
7b0608e90a Update to user-manual: SettingUpPreferences
- The manual now mentions the different tabs for General and Tec settings.
- New options since previous release are added to the manual.
- Defaults for thresholds and GFlow/GFhigh are mentioned.

Signed-off-by: Reinout Hoornweg <reinout@xs4all.nl>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-16 15:21:09 -08:00
Reinout Hoornweg
e75d8fa2c0 Update to user-manual: ViewInfoStats
- Added visibility, air temperature and air pressure.
- Fixed a typo and missing "min/avg".

Signed-off-by: Reinout Hoornweg <reinout@xs4all.nl>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-16 15:21:01 -08:00
Reinout Hoornweg
3b9aa991ce Update to user-manual: EditEquipmentInfo
- Gasmix isn't just about nitrox anymore.

Signed-off-by: Reinout Hoornweg <reinout@xs4all.nl>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-16 15:20:45 -08:00
Reinout Hoornweg
1ec3cb6696 Update to user-manual: EditDiveInfo
- Added new fields (like GPS, Pick on map, Visibility, Air Temp)

Signed-off-by: Reinout Hoornweg <reinout@xs4all.nl>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-16 15:20:21 -08:00
Reinout Hoornweg
f2f761da74 Update to user-manual: ViewingLogs
- Added more information fields in the list.
- Added note that shown information may vary depending on settings.

Signed-off-by: Reinout Hoornweg <reinout@xs4all.nl>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-16 15:19:54 -08:00
Reinout Hoornweg
0299868cca Update to user-manual: StartUsing
- Subservice 3.0 *does* automatically load previously saved data.
- The menu has the option "Planner" now.
- Fixed a typo.

Signed-off-by: Reinout Hoornweg <reinout@xs4all.nl>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-16 15:19:41 -08:00
Reinout Hoornweg
8be0e4c178 Update to user-manual: Introduction
- Increased version number.
  - Replaced "Viper" with "Vyper".

Signed-off-by: Reinout Hoornweg <reinout@xs4all.nl>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-16 15:18:12 -08:00
Dirk Hohndel
c963dc2c2c Update documentation to remove SDE unpacking section
Our documentation explained in detail how to unpack Suunto DM export
files. This is no longer necessary as we now unzip them while opening
them.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-16 13:48:56 -08:00
Amit Chaudhuri
7705ee3565 Documentation update for driver installation on OSX
Helping people to find the right drivers.

Signed-off-by: Amit Chaudhuri <amit.k.chaudhuri@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-07 20:56:57 +11:00
Dirk Hohndel
8f8942f315 Add Uemis section to the user manual
This gives some information on some of the oddities when downloading from
a Uemis Zurich.

Also run a spell checker against the user manual.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2012-10-22 20:53:04 -07:00
Dirk Hohndel
ef3b557297 Quick attempt to update the documentation for 2.1
This needs a lot more work, but it's a start.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2012-10-21 00:43:03 -07:00
Miklos Vajna
a738108549 user-manual: fix a few annoying typos
Signed-off-by: Miklos Vajna <vmiklos@vmiklos.hu>
2012-03-22 12:34:41 +01:00
Dirk Hohndel
0915d2e691 More AsciiDoc updates
Add missing internal links

Work on better visual representation of structured data

Start creating quoted text (instead of styled text)

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2012-01-01 17:41:05 -08:00
Dirk Hohndel
f10596f68b Update asciidoc headers and deal with internal links
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2012-01-01 16:52:45 -08:00
Linus Torvalds
1a83bf43b6 First try at converting user-manual to AsciiDoc
You can do "make doc" in the main directory to create the html version,
and if you want to play around with it, do "make show" in the
Documentation subdirectory to start firefox on the end result.

It's by no means perfect, but it gives somewhat reasonable results, and
this is enough initial work for people to play around with, I think.

NOTE! You need "asciidoc" installed to do this: it's a python program,
so it should be pretty easy even on non-Linux platforms.  And on Linux,
most distributions package it, so you just have to do something like

	yum install asciidoc

to get it (replace with apt-get/zypper/whatever).

Asciidoc can generate other output too (man-pages, LaTeX, etc), maybe
people want to play with that part too.

Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
2012-01-01 15:12:28 -08:00
Linus Torvalds
a8676438a7 Merge branches 'windows', 'docs' and 'forlinus' of git://git.hohndel.org/subsurface
* 'windows' of git://git.hohndel.org/subsurface:
  Fixes for the Windows installer

* 'docs' of git://git.hohndel.org/subsurface:
  Version 0.0.7 of user manual

* 'forlinus' of git://git.hohndel.org/subsurface:
  Remove unused return value
2011-12-27 09:27:33 -08:00
Jacco van Koll
265fa8ec1f Version 0.0.7 of user manual
Added chapter 14: The menu and sub-menus

Signed-off-by: Jacco van Koll <jko@haringstad.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2011-12-26 16:15:30 -08:00
Henrik Brautaset Aronsen
1511711507 There's a difference between "it's" and "its"
Just sayin'

Signed-off-by: Henrik Brautaset Aronsen <subsurface@henrik.synth.no>
2011-12-26 12:08:34 +01:00
Cristian Ionescu-Idbohrn
4cd67e027c Fix incorrect utf-8 in Documentation/user-manual.txt
Not sure, but us-ascii might have been intended.

Signed-off-by: Cristian Ionescu-Idbohrn <cii@axis.com>
[ And even if you do want to use utf8, you should use it correctly, not
  with this "pick random character" approach  - Linus ]
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
2011-12-24 13:48:54 -08:00
Jacco van Koll
4fe64e95d3 Version 0.0.6 of user manual
Corrected some typo's
Modified chapter 12. Importing dives from JDivelogAdded chapter 13.
Importing dives from Suunto Divemanager 3.*
Added Appendix B: very tiny example script for importing Suunto
Divemanager 3.* xml files

Signed-off-by: Jacco van Koll <jacco.van.koll@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2011-12-23 19:44:56 -08:00
Dirk Hohndel
84f172dccb Add more details to import chapter of user-manual
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2011-12-16 13:11:29 -08:00
Jacco van Koll
4ce4f4441c Version 0.0.5 of user manual
Added chapter 12. Importing dives from JDivelog
Adding some divecomputers to Appendix A

Signed-off-by: Jacco van Koll <jacco.van.koll@gmail.com>
2011-12-16 13:02:50 -08:00
Dirk Hohndel
df12fcf310 Clarify documentation about connecting dive computers
This works rather differently on the different OSs

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2011-12-13 20:16:46 -08:00
Jacco van Koll
8fc7cafa56 Version 0.0.4 of user manual
Cleanup of the layout
Changed line-length to 74
Added chapter 11. How to find the Device Name
Added Appendix A: Supported divecomputers

Signed-off-by: Jacco van Koll <jacco.van.koll@gmail.com>
2011-12-13 19:55:26 -08:00
Dirk Hohndel
269b5c0286 Fixing whitespace, line wrapping
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2011-12-12 14:46:55 -08:00
Jacco van Koll
4a6d3835d0 Version 0.0.3 of user manual
Added missing chapters. Now includes adding information.
2011-12-12 14:37:07 -08:00
Jacco van Koll
52bba5aad9 Version 0.0.2 of user manual
Signed-off-by:    Jacco van Koll <jacco.van.koll@gmail.com>
2011-12-12 12:49:27 -08:00
Dirk Hohndel
636e7b512f Reformat, reorganize and slightly modify user manual
Getting started on better user documentation. Awesome.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2011-12-12 12:18:32 -08:00
Jacco van Koll
a9f6bad5db First draft of user documentation
Signed-off-by: Jacco van Koll <jacco.van.koll@gmail.com>
2011-12-12 12:03:04 -08:00