Commit graph

239 commits

Author SHA1 Message Date
Willem Ferguson
bbfe20a412 User manual: Spelling, typos
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>
2014-06-30 07:21:01 -07:00
Willem Ferguson
c020cda41b Update of user manual
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>
2014-06-29 09:44:28 -07:00
Willem Ferguson
de8dbf2dad Updates to user manual: Preferences and Main menu
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>
2014-06-29 08:36:07 -07:00
Willem Ferguson
f1f16b224b User manual: add more about dive log export.
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>
2014-06-28 16:01:59 -07:00
Willem Ferguson
dd9d68a359 User manual: Load photographs
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>
2014-06-28 16:01:48 -07:00
Willem Ferguson
2292abd552 User manual: add text for the dive planner
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>
2014-06-28 16:01:38 -07:00
Henrik Brautaset Aronsen
630ec88dd4 Be more consistent in partial pressure naming
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>
2014-06-23 06:48:54 +08:00
Anton Lundin
bd3dd30518 Fix out of tree building without asciidoc
We tried to copy the .html.git file from the out of tree build dir, not
from the source dir.

Signed-off-by: Anton Lundin <glance@acc.umu.se>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-06-08 08:10:10 -07:00
Dirk Hohndel
98dd127f93 User manual: add html version of Spanish manual
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-06-06 10:55:51 -07:00
Dirk Hohndel
20bbff2773 User manual: update Makefile for multi language support
New translations need to be explicitly added to the Makefile

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-06-06 10:54:51 -07:00
Salvador Cuñat
2f1d7c0bdc User manual: Spanish translation
Spanish translation for the user manual as of 4.1 tagged english version.
Trimmed to 80 columns except where this could break links and affect the
html conversion.

Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-06-06 10:20:31 -07:00
Tomaz Canabrava
feff22c222 Planner: Re-enable using the new profile.
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>
2014-05-26 13:17:32 -07:00
Jeremiah Mahler
5702a52078 Documentation spelling errors
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>
2014-05-11 02:00:53 -07:00
Willem Ferguson
eba0790a04 Yet some more changes to Companion part of user manual
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>
2014-05-08 08:19:54 -07:00
Willem Ferguson
0325a42c08 User manual: Updates regarding the companion app
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>
2014-05-07 09:12:15 -07:00
Salvador Cuñat
8de1a73669 User manual: document importing GPX files in companion app
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>
2014-05-05 09:01:42 -07:00
Dirk Hohndel
2dda348bab Getting ready for 4.1 Beta 2
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-04-30 21:36:38 -07:00
Miika Turkia
97e9be1ba6 Add export CSV to user manual
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>
2014-04-30 09:16:01 -07:00
Dirk Hohndel
8539ae6471 User manual: add latest html
This updates the rendered html file for people who build from source but
don't have asciidoc installed.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-04-29 22:09:17 -07:00
Rick Walsh
5775221a4c User manual: formatting changes
- 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>
2014-04-29 22:07:59 -07:00
Willem Ferguson
1e44fecf06 User manual: Minor updates
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>
2014-04-29 22:06:37 -07:00
Salvador Cuñat
48b8cbadf7 User manual: some changes regarding the companion app
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>
2014-04-25 09:02:23 -07:00
Willem Ferguson
24792f402d User manual: Replace some graphics
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-21 08:36:03 -07:00
Willem Ferguson
20bde81023 Small updates to user manual
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-10 09:15:28 -07:00
Anton Lundin
0bf79e216f Use the ENABLE_PLANNER macro in the manual too
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-07 10:17:45 -07:00
Willem Ferguson
57bfa7e353 Update to bring user manual in line for the release of V4.1.
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-04-07 10:16:54 -07:00
Robert C. Helling
02d5d436d2 EAD/END explanation in user manual.
E is for "equivalent".

Signed-off-by: Robert C. Helling <helling@atdotde.de>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-03-31 11:51:54 -07:00
Willem Ferguson
69b000dcff User manual: Updates to sections 6 and 10-13
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-27 10:58:22 -07:00
Dirk Hohndel
dd0c995f2f User manual: Update included .html.git file
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-03-25 08:16:06 -07:00
Lakshman
17e493735b Minor edits to updated section-3 documentation
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-25 08:13:26 -07:00
Willem Ferguson
b95304f424 Updates to Section 3 of the user manual
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-25 08:12:54 -07:00
Willem Ferguson
f7709ec4a3 User manual: Changes to sections 1 and 2
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-17 10:54:08 -07:00
Willem Ferguson
0f7dfcee26 User manual: Update sections 4 and 5
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-15 22:17:59 -07:00
Willem Ferguson
ce6f2cdda4 User manual: Add the missing icons
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-03-15 09:48:49 -07:00
Willem Ferguson
f4d56ddf6f Revision of Profile part of manual
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-03-14 15:31:37 -07:00
Thiago Macieira
3318aefa46 Make sure the user-manual.html output always ends up in $(OUT)
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-25 15:30:38 -08:00
Dirk Hohndel
6fa52f3c34 User manual: update html file
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-22 08:57:20 -08:00
Dirk Hohndel
4e468d6475 User manual: gps coordinates are tied to location names
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-22 08:57:03 -08:00
Dirk Hohndel
4fad2c9172 User manual: Give credit where it's due
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-22 08:56:57 -08:00
Dirk Hohndel
a814a5c904 Updated the included user-manual.html
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-18 08:49:00 -08:00
Willem Ferguson
853ce0bbef User manual: Style and grammar updates
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-18 08:46:42 -08:00
Dirk Hohndel
59f60f39f6 Updated user manual html file
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-13 22:41:36 -08:00
Willem Ferguson
6496f4eb61 User manual: grammar and stylistic revision
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-13 22:38:06 -08:00
Willem Ferguson
af8c44fa22 User manual: small updates
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-11 12:36:37 -08:00
Dirk Hohndel
f7bb377287 User manual: update html file shipped with git repository
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-07 06:53:01 -08:00
Willem Ferguson
cb7a87faef User manual: reorganize text on importing from other dive log software
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-07 06:46:51 -08:00
Willem Ferguson
3217201bb7 User manual: replace some images, minor updates
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-02-05 09:28:39 -08:00
Willem Ferguson
2f582f4fb1 User manual: Small text updates and new screenshots
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-31 09:16:17 -08:00
Miika Turkia
c4c7d85fb5 Adding some supported divelogs to importing info
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-25 06:53:04 -08:00
Miika Turkia
4b46385d64 Typo fixes on user manual
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-25 06:53:04 -08:00