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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
This was Dirk's mistake when applying the patch.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
1) Several layout changes including banner.
2) Stylistic revision of part of textr.
3) Addition of text to dive computer upload section.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
A first try on documenting the companion app and explanation on how to use
it combined with Subsurface.
Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
1) Inserted section on Information Box on dive profile
2) Iserted short section on import from Mares Dive Organiser
3) Corrections to spelling and style not included in previous commits.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
References to literature on gradient factors changed (see dive profile
section, also preferences section)
Section on preference settings added.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
I have added a section about importing dives from other electronic
sources. There are some potential problems, because I know that the
intercation with divelogs.de is not yet fully functional
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
This starts mostly from scratch. It removes big chunkgs of the old manual,
the old pictures and starts with new visuals and new descriptions. A lot
more work is needed, but it's a good start.
Signed-off-by: Willem Ferguson <willem@willem-Precision-M4700.(none)>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
This is working for me, but requires a bit more testing. To build,
run:
qmake [options]
Where options might be:
V=1 disable "silent" build
LIBDCDEVEL=1 use side-by-side libdivecomputer
INCLUDEPATH+=xxx add -Ixxx (e.g., INCLUDEPATH+=/usr/local/marble/include)
LIBS+=xxx add xxx to the linker flags (e.g. LIBS+=-L/usr/local/marble/lib)
or any other qmake option, including debug and release options
If your distribution is already using qtchooser in place of qmake, you
may need to pass an extra option to qmake to select the a
cross-build. For example:
qmake -qt=i686-w64-mingw32-qt4
If your distribution is not yet using qtchooser, then you need to file
a bug report requesting it and you need to run the full path to qmake.
Note:
- there are some ### left in the buildsystem
Signed-off-by: Thiago Macieira <thiago@macieira.org>
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>
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>
- 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>
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>
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>
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>
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>
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>
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>
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>
- 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>
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>
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>
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>
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>
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>
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>
- 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>
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>
- 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>
...to avoid generating the HTMLDOC target even if it needs not to.
Signed-off-by: Cristian Ionescu-Idbohrn <cristian.ionescu-idbohrn@axis.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
- 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>
- 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>
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>
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>
- 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>
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>
- 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>
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>
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>
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>
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>
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>
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>
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>
- 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>
- 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>
- 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>
- 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>
- 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>
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>
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>
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>
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>
* '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
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>
Cleanup of the layout
Changed line-length to 74
Added chapter 11. How to find the Device Name
Added Appendix A: Supported divecomputers
Signed-off-by: Jacco van Koll <jacco.van.koll@gmail.com>