aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation
AgeCommit message (Collapse)Author
2014-04-21User manual: Replace some graphicsGravatar Willem Ferguson
1) Two of the major screen images were replaced to reflect the current screen layout with the new features of the profile toolbar. 2) The heart rate button is depicted and desribed. 3) Minute changes to the text of the manual to accompany the above changes. 4) The Uwatec Galileo image is re-inserted in the icons folder. Somewhere it got lost. Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-04-10Small updates to user manualGravatar Willem Ferguson
These updates reflect the discussion and small changes that were made to the Preferences section and the Export-to-Worldmap features over the last week. 1) A few small changes made to the text of the Preferences section. 2) Two images replaced in the Preferences section. 3) Expansion of description of Export to Worldmap option of the menu system. Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-04-07Use the ENABLE_PLANNER macro in the manual tooGravatar Anton Lundin
This introduces ifdef control structures in the manual too, so we can continue to develop both the planner and its manual, until its ready for release. Signed-off-by: Anton Lundin <glance@acc.umu.se> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-04-07Update to bring user manual in line for the release of V4.1.Gravatar Willem Ferguson
1. New section added on IrDA and communicating with the Uwatec Galileo dive computers. 2. Sections 7 to 9 of manual updated to reflect current version. Three figures updated. 3. New section added to reflect the dive planner. This is only a skeleton awaiting better description when the dive planner is more mature. Added 2 figures within this new section. Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-03-31EAD/END explanation in user manual.Gravatar Robert C. Helling
E is for "equivalent". Signed-off-by: Robert C. Helling <helling@atdotde.de> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-03-27User manual: Updates to sections 6 and 10-13Gravatar Willem Ferguson
These are updates that are not version 4.1 dependent, but many linguistic and logical edits are made, as are edits for consistency. No substantive material has been removed or added. This text is ready for V4.1 Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-03-25User manual: Update included .html.git fileGravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-03-25Minor edits to updated section-3 documentationGravatar Lakshman
Patch provided by Willem Ferguson, "0002-Updates-to-Section-3-of- the-user-manual" addresses large number of typos and inconsistencies in the previous documentation of section 3. This patch makes some additional corrections on top of the provided patch, and also removes the trailing whitespaces brought in with the provided patch. Signed-off-by: Lakshman Anumolu <acrlakshman@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-03-25Updates to Section 3 of the user manualGravatar Willem Ferguson
Section 3 is quite a long section. Ten of the screen shots are replaced. Large numbers of typos and inconsistencies are corrected. A few sentences are included e.g when dealing with the Subsurface Companion. Section dealing with creating libdivecomputer dump files has been reorganised slightly. Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-03-17User manual: Changes to sections 1 and 2Gravatar Willem Ferguson
The text for these two sections has been corrected and updated in order to be ready for the release of V4.1. The very first paragraph of the manual is expanded substantially. Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-03-15User manual: Update sections 4 and 5Gravatar Willem Ferguson
A new figure is included to reflect the actions of the new profile buttons on the calculated ceilings. A number of small edits on sections 4 and 5 of the user manual are done. These sections are now finalised for the new release. Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-03-15User manual: Add the missing iconsGravatar Willem Ferguson
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-03-14Revision of Profile part of manualGravatar Willem Ferguson
The last figures in the manual using the Unity desktop have been replaced with equivalent figures using Gnome 3. There should now be no figures remaining from Unity. This is a revision of the profile part of the manual in the light of the changes for V4.1. Text has been moved around, some new text added or rewritten. Graphics has been replaced to reflect the UI for V4.1, including Tomaz's button bar and Louisa's new buttons for that bar. Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-25Make sure the user-manual.html output always ends up in $(OUT)Gravatar Thiago Macieira
If you're doing a non-local build, it would get saved in the source dir. Then qmake would complain that it couldn't find it in the target dir. Signed-off-by: Thiago Macieira <thiago@macieira.org> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-22User manual: update html fileGravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-22User manual: gps coordinates are tied to location namesGravatar Dirk Hohndel
While it seems obvious that you need a named dive site in order to track its coordinates, apparently people try to have no location name but distinct coordinates which at this time we do not support. See #440 Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-22User manual: Give credit where it's dueGravatar Dirk Hohndel
Willem has been maintaining the user manual for quite a while and at this point is the main author, so he should be listed first. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-18Updated the included user-manual.htmlGravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-18User manual: Style and grammar updatesGravatar Willem Ferguson
This is an edit for style and grammar for the manual section dealing with downloads from DC. This section has also been expanded to cover all the controls in the downloads panel. Signed-off-by: Willem Ferguson <willem@willem-Precision-M4700.(none)> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-13Updated user manual html fileGravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-13User manual: grammar and stylistic revisionGravatar Willem Ferguson
This commit was jointly authored by Pedro Neves and Willem Ferguson. Pedro added a FAQ section to the manual. Many long lines of text were broken into shorter lines. Signed-off-by: Willem Ferguson <willem@willem-Precision-M4700.(none)> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-11User manual: small updatesGravatar Willem Ferguson
The section on the main menu descriptions has been changed a little bit to reflect the current menu structure. The section dealing with exprt from other dive software has been changed to appear more user friendly, with three new icons. Signed-off-by: Willem Ferguson <willem@willem-Precision-M4700.(none)> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07User manual: update html file shipped with git repositoryGravatar Dirk Hohndel
Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07User manual: reorganize text on importing from other dive log softwareGravatar Willem Ferguson
Change and shorten in some places the section dealing with data import from foreign software. Create Appendix C, containing information on data export from foreign packages. Signed-off-by: Willem Ferguson <willem@willem-Precision-M4700.(none)> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-05User manual: replace some images, minor updatesGravatar Willem Ferguson
Except for the images involving the dive profile, all the images now are from Gnome 3. Images for dive profile awaits finalisation of the new dive profile. Small changes to the text of the manual have been done, the most important of which is that dealing with using the unified import dialogue of Subsurface. Signed-off-by: Willem Ferguson <willem@willem-Precision-M4700.(none)> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-31User manual: Small text updates and new screenshotsGravatar Willem Ferguson
This adds Gnome-based screenshots to the manual for most of the images not involving the profile. More of the images remain to be done. I rewrote small sections of the text to reflect some of the recent changes. Several images still need to be replaced. The profile images will be done once the profile panel has been finalised. Some text also still needs working. Signed-off-by: Willem Ferguson <willem@willem-Precision-M4700.(none)> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-25Adding some supported divelogs to importing infoGravatar Miika Turkia
Signed-off-by: Miika Turkia <miika.turkia@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-25Typo fixes on user manualGravatar Miika Turkia
Signed-off-by: Miika Turkia <miika.turkia@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-25Add manual CSV log import to UserManualGravatar Miika Turkia
Signed-off-by: Miika Turkia <miika.turkia@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-25Update screenshot for CSV importGravatar Miika Turkia
Signed-off-by: Miika Turkia <miika.turkia@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-25CSV import instructions improvedGravatar Miika Turkia
Importing CSV files has changed slightly since writing this manual. Updating accordingly. A typo fix as well (comma separated *values*). Signed-off-by: Miika Turkia <miika.turkia@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-15Add ISO 6709 co-ordinates to manualGravatar Tim Wootton
And fix a typo Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-15Adds Boris' Full Screen mode to the manualGravatar Tim Wootton
Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-06Fix typoGravatar Miika Turkia
Signed-off-by: Miika Turkia <miika.turkia@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-03Prepare for 4.0.1 releasev4.0.1Gravatar Dirk Hohndel
Small updates to README, ReleaseNotes, user manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-29Update manual to reflect CSV import numberingGravatar Miika Turkia
Patch f4db392a changed CSV import to use field numbers instead of indexes. Thus removing the now incorrect description of numbering from user manual. Note, that screenshot should be updated as well. Signed-off-by: Miika Turkia <miika.turkia@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-25User manual: updateGravatar Willem Ferguson
1) Text about libdivecomputer log and dump files 2) Text about coordinate formats acceptable 3) Text about CSV import 4) Minor reorganisation of TOC Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-24Replace figure of main screen with one that shows the main menu. Previous ↵Gravatar Willem Ferguson
fig did not show manin manu. Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-23User manual: updatesGravatar Willem Ferguson
Correct error in manual Add some short text in sections dealing with equipment. [Dirk Hohndel: clean up whitespace & regenerate the html file] Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-23Correct small typo.Gravatar Cristian Ionescu-Idbohrn
Signed-off-by: Cristian Ionescu-Idbohrn <cristian.ionescu-idbohrn@axis.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-21Make XML and PDF version of user manual build againGravatar Cristian Ionescu-Idbohrn
Removing the offending tags in Documentation/user-manual.txt makes it build. Signed-off-by: Cristian Ionescu-Idbohrn <cristian.ionescu-idbohrn@axis.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20Include the user-manual.html file in the git treeGravatar Dirk Hohndel
This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-19Splits long lines in manualGravatar Tim Wootton
This allows patches to be read more easily This prevents the lines longer than 998 error in git send-email Breaks lines at somewhere near 80 chars where possible Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-18Adds unhide to profile menu context menuGravatar Tim Wootton
Unhide menu is only shown when hidden events exist. Also updates relavent manual section. Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-16The info icon of the manual got mislaid somewhereGravatar Willem Ferguson
Here it is. Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-15User manual: new banner imageGravatar Dirk Hohndel
This reflects the Qt version (and again matches the one on the web site). Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-13Doc, and 1 more typoGravatar Tim Wootton
Also added line-break as I ran into: "patch contains a line longer than 998 characters warning: no patches were sent" so that shouldn't happen next time. cheers, Tim From afb5fdfa2eff86ab2913e8f2a6f195c0cee3c13e Mon Sep 17 00:00:00 2001 From: Tim Wootton <tim@tee-jay.demon.co.uk> Date: Sat, 14 Dec 2013 00:31:12 +0000 Subject: [PATCH] Doc, and 1 more typo Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-13User manual: correct various typos and spellingsGravatar Tim Wootton
1) Corrects various typos and spellings 2) Standardises on infrared over infra-red (both were found) 3) Standrdises on colour over color (both were found) as most of the manual seems to use UK English spelling Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-13User manual: sync divenotes & equipment sectionsGravatar Tim Wootton
Brings the changes that were made to Dive Notes and Equipment under the Manual Entry section into the Imported from DC section was well, while preserving the imported from DC specific stuff. Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-13User manual: shortcut keys also depend on languageGravatar Tim Wootton
Notes dependancy of shortcut keys on language as well as OS. Writes Operating System in full not abbr. More fully describes how to spot a shortcut key in the menu Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
generated by cgit v1.2.3-70-g09d2 (git 2.47.0) at 2024-12-28 10:55:16 +0000