aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation
AgeCommit message (Collapse)Author
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-19Cleanup more and rearrange targets.Gravatar Cristian Ionescu-Idbohrn
Signed-off-by: Cristian Ionescu-Idbohrn <cristian.ionescu-idbohrn@axis.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-19Improved maitainability.Gravatar Cristian Ionescu-Idbohrn
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-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>
2013-02-17Moving common information to Import introductionGravatar Miika Turkia
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-17Added import info for MacDiveGravatar Miika Turkia
Signed-off-by: Miika Turkia <miika.turkia@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-17Tweaking download textsGravatar Miika Turkia
Signed-off-by: Miika Turkia <miika.turkia@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-17TyposGravatar Miika Turkia
Signed-off-by: Miika Turkia <miika.turkia@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-17Consistent way of writing divelogGravatar Miika Turkia
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-17Requirements can also be filled with existing logsGravatar Miika Turkia
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-16Documentation: Update "Import new dives from your divecomputer"Gravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-16Documentation: update "Import new dives from a Uemis Zurich"Gravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-16Documentation: update "how to find the Device NameGravatar Dirk Hohndel
- 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-16Documentation: update list of supported divecomputersGravatar Dirk Hohndel
Taken directly from the libdivecomputer website... Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-16Documentation: rewrite the Introduction for 3.0Gravatar Dirk Hohndel
Just trying to reflect the reality a bit better. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-16Documentation: Update version and authorsGravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-16Update to user-manual: log-menuGravatar Reinout Hoornweg
- 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-16Update to user-manual: SettingUpPreferencesGravatar Reinout Hoornweg
- 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-16Update to user-manual: ViewInfoStatsGravatar Reinout Hoornweg
- 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-16Update to user-manual: EditEquipmentInfoGravatar Reinout Hoornweg
- 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-16Update to user-manual: EditDiveInfoGravatar Reinout Hoornweg
- 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-16Update to user-manual: ViewingLogsGravatar Reinout Hoornweg
- 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-16Update to user-manual: StartUsingGravatar Reinout Hoornweg
- 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-16Update to user-manual: IntroductionGravatar Reinout Hoornweg
- 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-16Update documentation to remove SDE unpacking sectionGravatar Dirk Hohndel
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-07Documentation update for driver installation on OSXGravatar Amit Chaudhuri
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>
2012-10-22Add Uemis section to the user manualGravatar Dirk Hohndel
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-21Quick attempt to update the documentation for 2.1Gravatar Dirk Hohndel
This needs a lot more work, but it's a start. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2012-03-22user-manual: fix a few annoying typosGravatar Miklos Vajna
Signed-off-by: Miklos Vajna <vmiklos@vmiklos.hu>
2012-01-01More AsciiDoc updatesGravatar Dirk Hohndel
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-01Update asciidoc headers and deal with internal linksGravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2012-01-01First try at converting user-manual to AsciiDocGravatar Linus Torvalds
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>
2011-12-27Merge branches 'windows', 'docs' and 'forlinus' of ↵Gravatar Linus Torvalds
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-26Version 0.0.7 of user manualGravatar Jacco van Koll
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-26There's a difference between "it's" and "its"Gravatar Henrik Brautaset Aronsen
Just sayin' Signed-off-by: Henrik Brautaset Aronsen <subsurface@henrik.synth.no>
2011-12-24Fix incorrect utf-8 in Documentation/user-manual.txtGravatar Cristian Ionescu-Idbohrn
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-23Version 0.0.6 of user manualGravatar Jacco van Koll
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>