Commit graph

772 commits

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