Commit graph

507 commits

Author SHA1 Message Date
willemferguson
126decac6b User manual: Create new cylinder type
Adds text and 5 images, detailing how to create a new cylinder type.
This appears to be a perrenial problem, often appearing on the mail
list.

Signed-off-by: willemferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2021-03-24 09:47:50 -07:00
Dirk Hohndel
9686b4cf74 documentation: gentle nudge back to standardized US-English
Just changing the two user manuals. This also includes a couple other spell
fixes as well as one small adjustment regardinf IrDA support on Linux (which
has been gone for a while now).

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2021-03-11 08:12:40 -08:00
willemferguson
d75a051721 Update to desktop user manual
Add section dealing with statistics restricted graphing.
Add section dealing with lack of IrDA support on new OSs
Do spell check of complete text.

Signed-off-by: willemferguson <willemferguson@zoology.up.ac.za>
2021-03-11 16:23:36 +02:00
Robert C. Helling
fb11f8efa6 Describe CCR changes in documentation
Signed-off-by: Robert C. Helling <helling@atdotde.de>
2021-02-26 08:42:30 -08:00
Dirk Hohndel
41df39fdbe user manual: make the style more personal
Style is always tricky. This is really complex material. This attempts
to slightly personalize the language and make it less academic sounding,
while not removing any of the attention to detail and actual content of
this manual section.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2021-02-09 08:10:47 -08:00
Dirk Hohndel
b923526f04 user manual: fix typo in manual text
This isn't about 'depth variables', but about continuous vs categorical variables.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2021-02-09 08:10:47 -08:00
Dirk Hohndel
7a188cf7fe user manual: introduce the two variables as 'base' and 'data'
Instead of adding these names later, use them right from the start.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2021-02-09 08:10:47 -08:00
Dirk Hohndel
9ab481e927 user manual: get ready for 5.0
While version numbers are really rather random, we decided that with the
new statistics feature we will change the version number to 5.0.
Reflect that in the manual.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2021-02-09 08:10:47 -08:00
willemferguson
a0f740763b Subsurface Desktop user manual: Statistics panel
Update the user manual to take into account the statistics tool.
This is a first attempt.

Signed-off-by: willemferguson <willemferguson@zoology.up.ac.za>
2021-02-08 08:23:01 -08:00
willemferguson
d183e93bad Subsurface User manual update: Filter
This adds text to the user manual pertaining to the filter tool.
2 Figures removed, 7 figures added.

Signed-off-by: willemferguson <willemferguson@zoology.up.ac.za>
2020-10-03 10:39:00 -07:00
James Wobser
4f3b26f9b6 Implement Seac SeacSync databaser parser.
Dives for the seac action computer are imported by the seacsync
program into two tables in an sqlite3 database.

The dive information is read from the headers_dive table.
The dive_data table is then queried for each dive to get samples.

The seac action computer is the only current supported computer
by the seacsync program. It only supports two gas mixes, so the
parser will toggle between two cylinders whenever it detects a
change in the active O2 mix.

Dive start time is stored in UTC with a timezone offset.
A helper function to read this was added to qthelper.

Default cases have been added to some switch statements
to assist in future development for other dive types and
salinity.

Example database has been added to ./dives/TestDiveSeacSync.db

Signed-off-by: James Wobser <james.wobser@gmail.com>
2020-09-04 15:54:08 +03:00
Dirk Hohndel
862fcdf8ea documentation: remove two remaining references to the survey
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2020-05-05 18:48:46 -07:00
Monty Taylor
f37f428762 cleanup: capitalize use dc
It was suggested in a review of a previous patchset that we should
capitalize the use of "use dc" to "Use DC" - but if we were going
to do that we should do it everywhere, not just in the one place.

This is the followup to do that.

Signed-off-by: Monty Taylor <mordred@inaugust.com>
2020-05-05 10:23:18 -07:00
Monty Taylor
7a9214575e cleanup: Change Salty to Brackish
In the code, the difference between SALTYWATER and SALTWATER is hard
to see. More importantly, in the UI - Brackish is the word for water
that has more salt that freshwater but less salt that seawater. The
docs already use the word to clarify what is meant.
2020-05-05 08:25:21 -07:00
Monty Taylor
95e6792c4f Grantlee: Add salinity and water type to grantlee variables
These can be useful in a printed divelog, especially if the
log entry is also showing weight and exposure suit.

Signed-off-by: Monty Taylor <mordred@inaugust.com>
2020-05-05 17:31:47 +03:00
Dirk Hohndel
da953fa18a move GitHub url to the Subsurface org
Instead of using the Subsurface-divelog user on GitHub, we now use an org that
was generously donated to us.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2020-04-26 16:36:30 -07:00
willemferguson
eb6dfd3745 Change to user-manual (Dive export)
This brings the user manual in line with the recent changes to the
layout of the export panel.

Signed-off-by: willemferguson <willemferguson@zoology.up.ac.za>
2020-04-19 09:28:26 -07:00
willemferguson
56a3377367 Changes to user manual for version 4.9.4
Six images are changed and several changes are made to the text of the user manual

Signed-off-by: willemferguson <willemferguson@zoology.up.ac.za>
2020-04-18 09:50:13 -07:00
Dirk Hohndel
9214bdb3c5 documentation: additional explanations around Windows USB drivers
This is adapted from a conversation with Jef.

Suggested-by: Jef Driesen <jef@libdivecomputer.org>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2020-02-27 14:57:59 -08:00
willemferguson
92ea29ebcb Updates to user manual
Add an image that was lost in the latest updates.
Add text about checking of hand-entered coordinates.

Signed-off-by: willemferguson <willemferguson@zoology.up.ac.za>
2020-02-08 10:26:07 -08:00
willemferguson
45c331042b Changes to user manuals
Added text dealing with problems in user cloud registration
and loss of password

Other small edits and corrections to these texts.

Signed-off-by: willemferguson <willemferguson@zoology.up.ac.za>
2020-02-06 08:53:16 -08:00
willemferguson
996798ae3b Update User Manual: Preferences
Provide text and 12 images to describe the preference system
for Subsurface. Several within-document links updated.

Signed-off-by: willemferguson <willemferguson@zoology.up.ac.za>
2020-01-26 16:04:49 -08:00
willemferguson
e9778e7a48 User Manual updates: changed to UI
Replace 11 images in the user manual to reflect latest changes
in the UI (Notes tab, Equipment tab, Information tab).
Change text in user manual.

Signed-off-by: willemferguson <willemferguson@zoology.up.ac.za>
2020-01-26 16:04:49 -08:00
Dirk Hohndel
f1bb2a81ca update CHANGELOG and insert placeholder in user manual
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2020-01-06 07:00:34 +09:00
Robert C. Helling
33e49637ec Add current GF to infobox
As per request from users on scubaforum.com, this adds
the current gradient factor to the deco information of
the infobox. Up to now, this information was only
graphically represented in the pressure bar graph
and the heatmap. This gives a numerical value.

Signed-off-by: Robert C. Helling <helling@atdotde.de>
2019-11-28 12:23:04 -08:00
Robert C. Helling
9c8fbe494d Planner: Add option to treat O2 as narcotic
When computing the best mix for a target depth, for helium, one
can either require that the partial pressure of N2 is the same
as at the target depth or the partial pressure of N2 plus O2.

Signed-off-by: Robert C. Helling <helling@atdotde.de>
2019-10-31 00:30:38 -07:00
willemferguson
9a562f221a Desktop user manual: dc management
The relevant text in the present manual is obsolete. Update
the text dealing with dive profiles from several sive computers
for one specific dive. One image is added.

Deal with creating a new cylinder type.

Signed-off-by: willemferguson <willemferguson@zoology.up.ac.za>
2019-08-08 09:05:09 -07:00
Dirk Hohndel
a721550a3a user manual: update the bundled html version
And fix the date to say July.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2019-07-13 18:44:49 -07:00
willemferguson
db550fab57 Updates to user manual (update 3 of 3)
Replace four images in section 5.2.5
Update text to reflect the undo mechanism. This mostly involved removing
obsolete text.

Signed-off-by: willemferguson <willemferguson@zoology.up.ac.za>
2019-07-12 12:52:04 -07:00
Dirk Hohndel
56c8d5690a User manual: updates to undo description
And some trailing space removal.

The text on editing dives hopefully is more accurate and easier to understand.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2019-07-12 06:49:45 -07:00
willemferguson
eefaae35b3 Update user manual (2 of 3)
Small updates and corrections to existing text
Replaced four images to reflect the current UI

Signed-off-by: willemferguson <willemferguson@zoology.up.ac.za>
2019-07-06 11:25:59 -07:00
willemferguson
230f3846fa User manual update (update 1 of 3)
Text has been added for the undo facility and for the specification
of atmospheric pressure.

Two images added.

Signed-off-by: willemferguson <willemferguson@zoology.up.ac.za>
2019-06-26 06:46:58 +08:00
Robert C. Helling
30f2d16dab Update usermanual
... to reflect new wording of menu entry.

Signed-off-by: Robert C. Helling <helling@atdotde.de>
2019-06-03 19:55:19 +02:00
Robert C. Helling
98ba711bca Extended user manual explanation of green ceiling
as a response on a recent discussion on scuba board.

Signed-off-by: Robert C. Helling <helling@atdotde.de>
2019-05-29 15:04:33 +03:00
willemferguson
563137fcd6 Desktop user manual update: dive site management
Include text about dive site management. 5 new figures
are introduced. Writing this enabled me to appreciate just how
much time must have gone into writing the code.

Signed-off-by: willemferguson <willemferguson@zoology.up.ac.za>
2019-05-05 09:06:17 -07:00
Robert C. Helling
52105e5217 Write dive data as video subtitles
This commit adds an entry to the dive media context
menu which offers to write a subtitle file. This
creates an .ass file for the selected videos.

In an attempt to to clutter the screen too much, don't
show irrelevant entries (zero temperature or
NDL and show TTS only for dives with stops).

VLC is able to show these subtitles directly, they
can be integrated into the video file with ffmpeg.

Signed-off-by: Robert C. Helling <helling@atdotde.de>
2019-04-16 20:38:19 +02:00
willemferguson
e4a1991e0c User manual: Text for Filter Tool
The description of the Filter tool is brought up to date.
One image is replaced elsewhere in the manual to reflect the
new Subsurface window top bar that indicates number of dives.
In total, 4 images added and text for user-manual updated.
The location of the filter text in the usermanual has been
changed.

Signed-off-by: willemferguson <willemferguson@zoology.up.ac.za>
2019-03-05 13:03:13 -08:00
willemferguson
56e667f05f Changes to user manual (V4.8.4)
1) remove Facebook integration (Dirk)
2) rewrite section about filter (Dirk)
3) insert section about bailout checkbox (Robert)
4) finalise section about surface GF in info box (Robert)
5) add export of profile graphic to .png (Robert)
6) update import of dives using universal import dialog (Miika)
7) some typos corrected and Robert's requests implemented
8) Factual info as wellas typos and corrections raised by
   Miika and Dirk

Signed-off-by: willemferguson <willemferguson@zoology.up.ac.za>
2019-02-10 22:50:28 +01:00
Robert C. Helling
fe4a230245 Export profile image
With Facebook support gone, we should offer a way to export
the profile image. This has been part of the TeX support
but this makes it explicit.

Signed-off-by: Robert C. Helling <helling@atdotde.de>
2019-02-07 16:06:43 +01:00
Robert C. Helling
c9d8b4f605 Add button to toggle deco info in info box
The info box can get longish. Offer the user to turn
off display of deco information (surface GF and
individual ceilings).

Signed-off-by: Robert C. Helling <helling@atdotde.de>
2019-02-05 14:18:14 +01:00
Robert C. Helling
2eebbfa3a4 Explain surface GF value in user manual
Signed-off-by: Robert C. Helling <helling@atdotde.de>
2019-02-05 14:18:14 +01:00
Lubomir I. Ivanov
a1ffe115cf facebook: remove the featute from the code base
Remove from:
- unit tests
- desktop widgets
- preferences
- core intergration
- cmakefiles
- build scripts
- icons
- docs

Also remove the plugins and social network integration.

Signed-off-by: Lubomir I. Ivanov <neolit123@gmail.com>
2019-02-01 17:16:43 -08:00
Lubomir I. Ivanov
7e6ef4287c user-manual: add notes about state of BTLE on Windows
Add an "important" message that the support is experimental
and that the latest version of Windows 10 and drivers is needed.

Signed-off-by: Lubomir I. Ivanov <neolit123@gmail.com>
2018-11-01 11:44:41 -07:00
Dirk Hohndel
5b74fe1dc5 User manual: describe the DC shortcut buttons
It would be great to have a corresponding screen shot.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2018-09-23 11:49:30 -07:00
Jan Mulder
2a47e60c8c Documentation: tiny fix in US user manual
Commit a4f04589c7 did forget to delete 1 line related the
Companion app. Deleted here.

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2018-09-18 10:37:21 -07:00
willemferguson
9037df76be user manual: additional updates and new images
These changes complete (I hope) the updates to the user manual to reflect
the use of media including video. Nine images are replaced.
Some more updates in the user-manual.txt to reflect on video files
and not only photographs.

Signed-off-by: willemferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2018-09-16 08:17:01 -07:00
Robert C. Helling
84480aa201 Manual entry of export anonymization
This should be accompanied by an updated screen shot.

Signed-off-by: Robert C. Helling <helling@atdotde.de>
2018-09-16 08:10:44 -07:00
Dirk Hohndel
9e8afe90d9 user manual: update dates and add latest HTML
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2018-09-16 08:04:24 -07:00
Jan Mulder
a4f04589c7 User manual: get rid of Companion app texts
Tried to strip all referencews to the companion app. Including a remark of
end-of-life of the GPS webservice end 2018. Also fixed a screendump from
mobile, for the removed menu items of the GPS service.

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2018-09-16 07:51:39 -07:00
Jan Mulder
3ce75739b7 User manual: update menu section
Update menu section for removes menu options. And fixed a lefover
edit in this area.

Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2018-09-16 07:47:02 -07:00