aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation
AgeCommit message (Collapse)Author
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>
2013-12-13User manual: Add space after punctuationGravatar Tim Wootton
Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-13Usermanual final edit before Version 4.0Gravatar Willem Ferguson
1) Many typos and lexical problems improved or corrected 2) Information for Heinrichs Weikamp DR5 moved to Appendix B 3) Small changes to images. Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-12Fix broken image linkGravatar Sergey Starosek
Rename .kpg -> .jpg Signed-off-by: Sergey Starosek <sergey.starosek@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-12User manual: small fixesGravatar Dirk Hohndel
Once again use 'selected' and 'highlighted' consistently. Use the correct units for the vertical speed during a dive. 30 m/s would be more than just red :-) Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-12User manual: update importing dive log data from other softwareGravatar Dirk Hohndel
Minor changes and slight reorganization. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-12User manual: update the section on importing data from dive computerGravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-12User manual: updates of the initial sections on manual data entryGravatar Dirk Hohndel
Also changed the term :weighting system" to "weight system". Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-12User manual: consistently use second person to address the userGravatar Dirk Hohndel
We kept switching between the somewhat impersonal 'one' and the much more friendly 'you' to address the user. This commit changed all occurances that I found to 'you' and adjusted the grammar around it. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-12User manual: minor changes to the Start Using the Program sectionGravatar Dirk Hohndel
Be more precise with selected dive vs. highlighted dives. Avoid some redundancy. Mention shortcut keys. Discuss the different locations of the Main Menu and the fact that the screen shots were taken on a Ubuntu system. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-12User manual: slightly reword the introductionGravatar Dirk Hohndel
we should focus on the typical user, so start with platforms that we have binaries for Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-12User manual: complete the language preference sectionGravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-12User manual: add stub for Language PreferencesGravatar Tim Wootton
Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-12User manual: Add section about Profile Pane context menuGravatar Tim Wootton
Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-12User manual: correct typo in Uemis Zurich sectionGravatar Tim Wootton
Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-11User manual: Fixes one broken italicsGravatar Tim Wootton
Italics marker needed to come after the 's to work properly Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-11User manual: added troughs to peaks in profile descriptionGravatar Tim Wootton
Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-11User manual: remove ter from below Stats Tab sectionGravatar Tim Wootton
Found the word "ter" below this para, assume it's not supposed to be there. Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-10User manual: use charge rather than load when referring to batteryGravatar Tim Wootton
Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-10User manual: remove imperative not to saveGravatar Tim Wootton
It's ok to save as you go, just not required. Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-10Manual updateGravatar Willem Ferguson
Replaced graphics for Import from Divelogs.de to reflect latest UI schanges. Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-10Fix asciidoc CSS pathGravatar Sergey Starosek
Both JS and CSS resources need to be embedded into HTML Signed-off-by: Sergey Starosek <sergey.starosek@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-10Usermanual updateGravatar Willem Ferguson
- Print divelog added - Typos corrected. Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-09Remove possible dual meaning in Divemaster and Buddy.Gravatar Tim Wootton
Pedantic Tim says "Barring waterproof device, most of us won't be entering these fields during the dive." ;-) Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-09Removes imperative to not save-as-you-go.Gravatar Tim Wootton
Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-09Updated user manualGravatar Willem Ferguson
1) Added Main Menu items description 2) Added Divelogs.de description 3) Removed paragraph defining EAD & END 4) Several typos corrected 5) Positions of several figures standardised to align="central" Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-09Fix possible compatibility issue with asciidocGravatar Dirk Hohndel
Apparently some version os asciidoc don't support the --theme option. Work around this by using -a theme='theme' instead. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-09Missing images for the manualGravatar Willem Ferguson
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-09Update to manualGravatar Willem Ferguson
- Companion app added - Figures updated & reorganised - Small amount of reorganisation of text - Typos corrected Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-09Removes unnecessary references to number of elements inGravatar Tim Wootton
the date field Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-09Updates main menu entriesGravatar Tim Wootton
Updates summary of main menu entries to those in the new GUI Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-09Replaced writing email to, with sending an email toGravatar Tim Wootton
Seems to read better as "sending an email to" Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-08Clarification on EAD and END meaning in SubsurfaceGravatar Salvador Cuñat
As pointed out in commit 23ce727 by Dirk and remembered Jan, there are different meanings for EAD and END depending on organisations. Let's explain a bit the one Subsurface has choosen, as this is confusing, even while translating the acronyms. Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-08Add compact style to the DocumentationGravatar Willem Ferguson
The Makefile changes were authored by Dirk, the CSS is based on a public domain CSS file and authored by Willem Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-07Fixing a few typos in DocumentationGravatar Werner Macho
Signed-off-by: Werner Macho <werner.macho@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
generated by cgit v1.2.3-70-g09d2 (git 2.47.0) at 2024-12-27 18:58:38 +0000