Commit graph

754 commits

Author SHA1 Message Date
Dirk Hohndel
3be2455c7b documentation: revert switch to asciidoctor
While this worked well on Mac, it creates odd errors on Linux. This
doesn't seem worth spending too much effort on - so let's just go back
to asciidoc.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2020-05-05 18:48:36 -07:00
Dirk Hohndel
50a89eba66 documentation: fix makefile
This one was my fault, not Willems (since I edited his commit).

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2020-05-05 18:25:57 -07:00
Willem Ferguson
70ebc2bee7 documentation/mobile-manual: create a merged v3 manual
Unintentionally two versions of the mobile manual were created. This brings all
of Willem's changes into the version for Subsurface-mobile v3, and restores the
last version of the v2 mobile manual.

This commit was manually created from a pull request that was signed off by
Willem, given that he wrote most of the text I am copying that SOB into this
commit and will assign authorship to him.

To avoid further confusion, we now have a v2 and a v3 manual, explicitly named.
The corresponding .html.git files were also updated (reflecting our switch to
asciidoctor).

Signed-off-by: willemferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2020-05-05 17:55:02 -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
willemferguson
6066ead0d5 Mobile user manual update
As the heading above says. two images changed.
Short table of contents added.
Add section on dive trip editing and dive list structure.
Added links to video tutorials.

Signed-off-by: willemferguson <willemferguson@zoology.up.ac.za>
2020-05-04 13:38:31 -07: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
Dirk Hohndel
4fd4b75269 documentation: update bundled HTML user manual
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2020-04-19 14:27:54 -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
716c3c3ed5 mobile/user-manual: update to remove reference to 'map it' button
It's still in the screen shot, but I'll fix that some other time.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2020-03-31 08:42:20 -07:00
Dirk Hohndel
76dc36ddae mobile/user-manual: update bundled html
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2020-03-27 12:32:06 -07:00
Dirk Hohndel
851c8c273a mobile/user-manual: add hyperlinks where useful
Suggested-by: Martin de Weger <martin@deweger.org>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2020-03-27 12:32:06 -07:00
Crawford Currie
b0572dd043 mobile/user-manual: small language tweaks
[Dirk Hohndel: added another fix to Crawford's commit]

Signed-off-by: Crawford Currie <curriedot@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2020-03-27 12:31:43 -07:00
Miika Turkia
a8e2aef785 mobile/user-manual: some tuning of the text
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2020-03-24 16:44:26 -07:00
Miika Turkia
5d3f92362d mobile/user-manual: typo fixes
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2020-03-24 16:43:45 -07:00
Dirk Hohndel
0b83971ff9 macOS: still issues with mixed case names
It's 2020. And by default the file system in macOS is still case
insensitive. Right. Of course.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2020-03-23 20:58:49 -07:00
Dirk Hohndel
97c7fad53d Subsurface-mobile v3 user manual
While this is based in large parts on the existing manual, it is a fairly
substantial rewrite with mostly new screenshots.

Includes edits by Rainer Mohr.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2020-03-23 20:48:03 -07:00
Dirk Hohndel
fe9a2ab5c3 Mobile user manual: some updates for Subsurface-mobile 3.0
This needs more work and especially new screen shots, but for now this
covers at least some of the most important changes.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2020-03-16 07:58:20 -07:00
Robert C. Helling
285fa8acbc Grammar: replaces 'indexes' by 'indices'
Grammar-nazi ran

git grep -l 'indexes' | xargs sed -i '' -e 's/indexes/indices/g'

to prevent future wincing when reading the source code.

Unfortunatly, Qt itself is infected as in
QModelIndexList QItemSelection::indexes() const

Signed-off-by: Robert C. Helling <helling@atdotde.de>
2020-03-11 08:26:30 -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
Dirk Hohndel
ddae7e18d8 mobile/user-manual: additional changes for style and FTDI support
Replace passive voice 'one' with active voice 'you'. More strongly articulate
the limitations for FTDI / cable based downloads on mobile devices.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2020-02-18 07:34:46 -08:00
Dirk Hohndel
fda54738f6 mobile/user-manual: add short section about Dive Details
This includes comments on how to zoom and pan the profile.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2020-02-18 07:34:46 -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
Dirk Hohndel
dc95b077d9 Mobile: Add CHANGELOG and user manual update
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2019-11-10 21:59:32 +01: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
Dirk Hohndel
78f914e7f0 Small update to the mobile manual
The edit description wasn't detailed enough to need changing, but I
noticed a reference to behavior that we have disabled.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2019-10-21 15:50:41 -04: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
Salvador Cuñat
21b275c4fd Update user-manual_es.txt to commit 30f2d16da
Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
2019-06-22 11:19:06 -07: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
Salvador Cuñat
186fa6c489 [user-manual_es] Update spanish translation to 563137fcd
Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
2019-05-19 12:00:33 -07: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