summaryrefslogtreecommitdiffstats
path: root/Documentation/user-manual.txt
AgeCommit message (Collapse)Author
2013-05-08Documentation: USB permissions and planner timesGravatar Robert C. Helling
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-02Updating user documentation to reflect current versionGravatar Miika Turkia
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-03-08Reorganise view menus and file import.Gravatar Amit Chaudhuri
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-07DM4 import user documentation updateGravatar Miika Turkia
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-05Trivial change to documentationGravatar Amit Chaudhuri
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-04Limited support for Suunto DM4 importGravatar Miika Turkia
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-04Some Small Documentation ChangesGravatar chrislewis915@gmail.com
- 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-03Update README, ReleaseNotes and Makefile for 3.0.2Gravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-03-03Extending user manualGravatar Jan Schubert
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-02-28Better Bluetooth device support on MacGravatar Dirk Hohndel
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-28Documentation: Add Mac related info to the bluetooth sectionGravatar Jan Schubert
Signed-off-by: Jan Schubert <Jan.Schubert@GMX.li> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-27Small typo correction.Gravatar Cristian Ionescu-Idbohrn
One 'r' removed. Signed-off-by: Cristian Ionescu-Idbohrn <cristian.ionescu-idbohrn@axis.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-26Documentation: fixed some typos in bluettoth part of user manualGravatar Jan Schubert
[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-26Update versions to 3.0.1Gravatar Dirk Hohndel
almost forgot Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-26Documentation: add pictures for Bluetooth setupGravatar Jan Schubert
Signed-off-by: Jan Schubert <Jan.Schubert@GMX.li> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-26Documentation: update formattingGravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-26extend user manual for setting up bluetooth communication.Gravatar Jan Schubert
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-26Documentation: add information for Bluetooth connected devicesGravatar Jan Schubert
[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-26Documentation: DivingLog needs to be set to Metric prior to exportGravatar Dirk Hohndel
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-25Documentation: add brief section about DivingLog exportGravatar Dirk Hohndel
Fixes #63 Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-25Documentation: correct the meaning of different colors in profileGravatar Dirk Hohndel
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-25User documentation - describe the dive profileGravatar Miika Turkia
Signed-off-by: Miika Turkia <miika.turkia@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-22Documentation: correct mis-spellingGravatar Dirk Hohndel
It's the Heinrichs Weikamp Frog, not From. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-20Documentation: minor spelling correctionsGravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-20Correctly capitalize JDiveLogGravatar Dirk Hohndel
Suggested-by: Miika Turkia <miika.turkia@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-20Documentation: Consistent spelling of "Buhlmann"Gravatar Reinout Hoornweg
Replaced "Bühlmann" with "Buhlmann". Signed-off-by: Reinout Hoornweg <reinout@xs4all.nl> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-20Update user documentation with divelogs.de suffix changeGravatar Henrik Brautaset Aronsen
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-20Documentation: Formatting "Setting up Preferences"Gravatar Reinout Hoornweg
- 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-20It seems that asciidoc doesn't allow dots in BlockIDsGravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-20Add divelogs.de export info to the manualGravatar Henrik Brautaset Aronsen
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-20Add info on importing divelogs.de to user manualGravatar Miika Turkia
Signed-off-by: Miika Turkia <miika.turkia@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-19Documentation: more tables in "View Info & Stats"Gravatar Reinout Hoornweg
- 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-19Documentation: Updated "Edit Equipment Info"Gravatar Reinout Hoornweg
- 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-19Documentation: updated section "Edit the Dive Info"Gravatar Reinout Hoornweg
- 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-19Screenshot for preferencesGravatar Miika Turkia
Signed-off-by: Miika Turkia <miika.turkia@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-19Added information about yearly statisticsGravatar Miika Turkia
Signed-off-by: Miika Turkia <miika.turkia@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-19Removing chapter Adding Equipment infoGravatar Miika Turkia
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-19A couple of screenshots addedGravatar Miika Turkia
Signed-off-by: Miika Turkia <miika.turkia@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-19[PATCH] Adding screen captures of dive planningGravatar Miika Turkia
[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-18Documentation: fixed a few typosGravatar Reinout Hoornweg
- 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-18Documentation: improve layoutGravatar Reinout Hoornweg
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-18Updates to the user-manual: DivePlanningGravatar Reinout Hoornweg
- 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-18Documentation: Chapter structure & header cleanupGravatar Dirk Hohndel
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-18Documentation: small rewrite of the dive planning chapterGravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-18Documentation: attempt consistency in headings and linksGravatar Dirk Hohndel
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-18Documentation: minor rewrite of the Mac Driver appendixGravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-18Documentation: minor spelling and consistency fixesGravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-18Documentation: Briefly explain the download from web serviceGravatar Dirk Hohndel
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-18user manual - planning divesGravatar Miika Turkia
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-17Documentation: apparently dive computer are two wordsGravatar Dirk Hohndel
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>
generated by cgit v1.2.3-70-g09d2 (git 2.47.0) at 2024-12-28 16:03:55 +0000