Picture shows dive to 20m in 30 min. so text should state the same
Signed-off-by: Sergey Starosek <sergey.starosek@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
I modified Tim Wooton's text, among others doing it in the writing
style of the manual (e.g. no second person).
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Possible wording for the survey bit
Is this the right place to put it?
Will probably need an image, but that would be better from Willem's
environment for the look to be consistent.
Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Describe that used cylinders cannot be deleted and first cylinder is
used implicitly.
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Describe the editing mode only once when going through entering dive
information by hand and not when describing each tab.
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Mention what is used by default for time and date when creating a new
dive. (And fix upper case elsewhere.)
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Some of the text dealing with Dropbox acces was misplaced
(Thank you, Salva)
This corrects that issue.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Text and an image were changed in order to reflect the
removal of images from the dive profile.
The text concerning Dropbox acces was reorganised.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
I thought it might be fun to use the archetypal characters here
http://en.wikipedia.org/wiki/Alice_and_Bob
It'll also be handy to use Bob if we ever need an example of
an underweighted diver ;-)
Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
All dive log movements are made on the local copy, then uploaded to
Dropbox server when there is an avaliable internet conection.
Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Multi-dive stats no longer include avg. depth
Picture was above, not below
Several minor corrections
Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Even though its Synchronization in the menu (in the base language
anyway) elsewhere thoughout the manual we use the en_GB spelling.
Use "into" rather than "onto" subsurface
Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Make descriptions of field editing consistent between the manually
added and DC imported sections. I preferred the DC section wording
on ratings.
Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Some minor readability tweaks.
Repeats wanrning about co-ordinates without Location name, all the
other info on co-ordinates was cut-pasted from the manual dive
entry section, but this bit was missing.
Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Corrects a typo
Removes a repetition
Closes a bracket
Adds extra info on use of the suit field
Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Referring to software as "Microsoft software" implies it's written
by Microsoft, which I don't think the Mares Dive Organizer is.
Microsoft still needs to stay for SQL Compact Edition which is theirs
but I think "Windows software" is the better description for the rest.
For consistency I think this works for refering to the OS too, as we
use Mac, not Apple, and Linux not Canonical.
Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Some other dive log programs present storage of dive logs on the Internet
as an important feature. Therefore this text.
One image was added.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
This patch performs the following to the user manual:
1) Remove text refering to cursor position indications on the depth
and time axes of the dive profile panel (not present in V4.2).
2) Revise dialogue and image for the printing of a dive log, taking
into account the new feature for 1 dive/page.
3) Added a paragraph to the text dealing with printing of dive plans,
detailing the approach to print dive plans after they have been saved
in the Dive List. This is done at the end of the text dealing
with the dive planner.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
This patch updates the user manual in the following respects:
1) Add section dealing with modifying the categories of information
shown in the Dive List. (A figure added)
2) Add section on filtering the Dive Listfor a particulr sive site,
using Ctl-F.
3) Add section describing the addition of bookmarks
(a figure added)
4) Two sentences dealing with the 30-minute time limit for
including photos onto the dive profile (dives > 30min of
the dive are not shown).
5) A few small changes, mostly typos.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Sections 6 and 9.3 of the user manual has some problems with the
ascii-doc code for maintaining the prper alignment of subheadings.
This patch corrects the asciidoc markup code to solve this
problem
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Changes to user manual to rplace three images, as pointed out by Sergey.
Small changes to text of manual to reflect blue editing bar UI.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
This patch contains some updates to the user manual to reflect the new
images that were submitted previously. The updates include:
1) Moving the "Load Photos" section to the section daling with the input
of dive information (photos qualify as additional dive information).
2) Changing the wording around the new button in the tool bar.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
This patch updated the export section in the user manual.
Some changes to the description of the HTML export options.
Signed-off-by: Gehad elrobey <gehadelrobey@gmail.com>
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
The user manual was spell-checked against the Oxford Dictionary.
Almost all the joined words, e.g. checkbox, dropdown, were
kept, but divelog was changed to dive log. Quite a few tyops
and spelling errors corrected.
A short section on dive plan evaluation was deleted on Robert's
suggestion.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Several updates are implemented here.
1) Updates to the dive planner section, following excellent
suggestions from Rob.
2) Updates reflecting the date picker, including hitting ESC
to close the calendar.
3) The edit of device names.
4) Several small or typographic edits
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
This patch updates the section on Preferences to accommodate
the newer additions to this Panel.
(Three images removed, five images inserted)
The section dealing with the desciption of all the main menu items
is updated.
One small change to the FAQ section.
A few small typo edits elsewhere in manual.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
This patch updates the information about dive log export.
Export to Worldmap, as well as to HTML are covered.
Small typo corrections elsewhere in the manual.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
This patch adds text and figures to the user manual, explaining how to
add photographs to the dive profile.
A 2-sentence paragraph was added to the dive planner text, detailing
planning for repetitive dives.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Text for the dive planner has been added to the user manual.
This includes two new images.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Lets just use pO₂ instead of PO2, ppO2, ppO₂, PO₂.
They all mean the same, but it's better to be
consistent
Signed-off-by: Henrik Brautaset Aronsen <subsurface@henrik.synth.no>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
This correctly enables the planner on the new profile,
but it doesn't triggers the correct paint on the canvas.
[Dirk Hohndel: remove other remnants of the disabled planner as well]
Signed-off-by: Tomaz Canabrava <tomaz.canabrava@intel.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
A general review of the documentation has found more spelling errors.
Signed-off-by: Jeremiah Mahler <jmmahler@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
A last few changes before 4.1.
The first figure in "Using Companion app" needs a third part.
This was inserted. Which, in turn, affected the last figure
in that section. So that was also changed accordingly.
Few tiny changes to text to clean up references to figures.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
These adiitions and changes were made in accordance with the screenshots
provided by Venkatesh and Salvador and after managing to actually run the
companion app on my phone. Large parts of the text of this section have
been changed in accordance with the Companion V2 interface. Two graphics
were changed.
After Version 2 has stabilised, some more adaptation of the text will be
required.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Document the new "add" menu capabilities, partially as there are features still not
functional.
Documents the new feature with GPX files imports.
Corrects a typo.
Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Mention the option to export in CSV format in our user manual.
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
- Add hyperlinks to references to Appendices A and B in the text
- Be consistent with use of numbered lists and bullets:
-- Use numbered lists where order is important (e.g. a set of instructions)
-- Use bullets where isn't doesn't matter (e.g. a list of features)
Signed-off-by: Rick Walsh <rickmwalsh@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Minor update of manual for consistency in terminology and improved style
including the section describing the companion app. No images were affected.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Subsurface companion is, basically, the same from last Subsurface release,
it's only been added with the map feature which is depicted here.
Distance between positions takes precedence over time between them, so you
can have positions faster than one each period set in the "Min Duration"
setting. Actually this setting seems useless as you won't have a fix each
period if distance is under "Min distance".
Lesser changes in manual involving Background Service, the dificulty on
matching times and little personal recomendations.
[Dirk Hohndel: minor language changes]
Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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 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>
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>
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>
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>
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>
- 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>
- 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>
