Commit graph

103 commits

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