aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation
AgeCommit message (Collapse)Author
2013-06-30Fixing typos and syntax from User ManualGravatar Miika Turkia
There was emphasising and bolding instructions in wrong order when combined. At least on my system this must be started with *+ and ended with +*. (There was also two cases when the ending was in same order as starting also spoiling the XML syntax.) These prevented XML validation thus terminating the compilation of the final documentation. I fixed also a bunch of typos while at it. Signed-off-by: Miika Turkia <miika.turkia@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-06-29Preparing for 3.1.1 and doc updatesGravatar Dirk Hohndel
This updates the versions to 3.1.1, does some minor doc cleanup for consistency and adds the suggestion to submit the output of subsurface --version in bug reports and the udev rules to blacklist dive computers in Modem Manager (as suggested by Bearsch). Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-06-29Add troubleshooting instructions to user manualGravatar Miika Turkia
Let's cover at least the most common problem (modem manager interfering) and also have instructions of how to dump debug log from the transfer. Signed-off-by: Miika Turkia <miika.turkia@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-05-17Updates to the lists of supported dive computersGravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-05-17Documentation: improve instructions for upload to divelogs.dev3.1Gravatar Dirk Hohndel
Suggested-by: Peter Konings <peter.l.e.konings@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-05-16Documentation: update divelogs.de export explanationGravatar Dirk Hohndel
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-15Documentation: more tweaks/additions to "Viewing and Completing Your Logs"Gravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-05-15Documentation: describe trips in the dive listGravatar Dirk Hohndel
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-15Documentation: multiple small corrections and improvementsGravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-05-15Documentation: add explanation on editing events in the dive profileGravatar Dirk Hohndel
Context menu to remove events or add bookmarks or gas change events. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-05-15Addition / change to the user manualGravatar Thomas Maisl
- 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-15Documentation: update reference to 6m stop in dive plannerGravatar Dirk Hohndel
Thanks to Miika we have an updated screenshot Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-05-15New dive planning screenshot with 6m stop in itGravatar Miika Turkia
Signed-off-by: Miika Turkia <miika.turkia@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-05-14Documentation: update regarding dive computer device drop down listGravatar Dirk Hohndel
This reflects the change made in commit bf34940bc5e4 ("Conditionally enable the device combo box."). Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-05-14Hardware updates for README, ReleaseNotes.txt and user-manualGravatar Dirk Hohndel
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-13Documentation: update "The Menu and Sub-Menus"Gravatar Dirk Hohndel
Complete rewrite of the 'Filter' and 'Help' sections. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-05-13Documentation: update "Web Service and Companion App"Gravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-05-13Documentation: update "Planning Dives"Gravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-05-13Documentation: update "Exporting Dives from Subsurface"Gravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-05-13Documentation: update "Setting up Preferences"Gravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-05-13Documentation: update "View Dive Info & Stats"Gravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-05-13Documentation: update "Viewing and Completing Your Logs"Gravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-05-13Documentation: update "Import New Dives..."Gravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-05-13Documentation: update "Start Using the Program"Gravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-05-13Documentation: update "Requirements"Gravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-05-13Documentation: update version number and "Introduction"Gravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
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>
generated by cgit v1.2.3-70-g09d2 (git 2.49.0) at 2025-04-11 06:46:23 +0000