Commit graph

799 commits

Author SHA1 Message Date
Victor Arvidsson
077f078151 Updated user-maunal with new instructions for subtitles.
Signed-off-by: Victor Arvidsson <victarv@gmail.com>
2024-10-27 01:37:04 +13:00
Tim D. Hammer
069f8a5d18 correct re-plan menu label in documentation
The (presumably) older label "Re-plan dive" in the Log menu was replaced with "Edit dive in planner",
but the documentation section "Modifying an existing dive plan" was not updated.

Signed-off-by: Tim D. Hammer <tdhammer@linux.com>
2024-08-26 12:37:29 +12:00
Michael Keller
2d8e343221 Planner: Improve Gas Handling in CCR Mode.
This has become a bit of a catch-all overhaul of a large portion of the
planner - I started out wanting to improve the CCR mode, but then as I
started pulling all the other threads that needed addressing started to
come with it.

Improve how the gas selection is handled when planning dives in CCR
mode, by making the type (OC / CCR) of segments dependent on the gas use
type that was set for the selected gas.
Add a preference to allow the user to chose to use OC gases as diluent,
in a similar fashion to the original implementation.
Hide gases that cannot be used in the currently selected dive mode in
all drop downs.
Include usage type in gas names if this is needed.
Hide columns and disable elements in the 'Dive planner points' table if
they can they can not be edited in the curently selected dive mode.
Visually identify gases and usage types that are not appropriate for the
currently selected dive mode.
Move the 'Dive mode' selection to the top of the planner view, to
accommodate the fact that this is a property of the dive and not a
planner setting.
Show a warning instead of the dive plan if the plan contains gases that
are not usable in the selected dive mode.
Fix the data entry for the setpoint in the 'Dive planner points' table.
Fix problems with enabling / disabling planner settings when switching
between dive modes.
Refactor some names to make them more appropriate for their current
usage.

One point that is still open is to hide gas usage graphs in the planner
profile if the gas isn't used for OC, as there is no way to meaningfully
interpolate such usage.

Signed-off-by: Michael Keller <github@ike.ch>
2024-08-26 12:36:31 +12:00
Michael Keller
291ed9d7e3 Documentation: Update Information on Available Versions in README.md.
Update the information on the available versions of Subsurface in
README.

Also update the documentation to reflect the renaming of `INSTALL` to
`INSTALL.md`.

Signed-off-by: Michael Keller <github@ike.ch>
2024-06-06 16:17:44 +12:00
Michael Keller
8181048611 CICD: Add GitHub Action File for Documentation Processing.
Also add an appropriate branch condition to the actions building
docker images.

Signed-off-by: Michael Keller <github@ike.ch>
2024-02-10 09:32:31 -08:00
Michael Keller
618e38151a CICD: Automate Processing of the Documentation.
Automate processing of the documentation to ensure it is processable.
Also fix some bugs in the existing input files for the documentation and
re-enable linting.

Signed-off-by: Michael Keller <github@ike.ch>
2024-02-10 09:32:31 -08:00
Dirk Hohndel
4197faf1b7 update documentation processing
- fix typo in Makefile
- remove unmaintained Russian translation
- try to fix incompatibilities with current asciidoc version
- update processed files

Unfortunately I wasn't able to figure out one error that stops the linting of
the mobile manual from succeeding - as a result I turned of linting for now
(that's the '-L' flag that was added to a2x)

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2024-02-08 13:26:39 -08:00
Dirk Hohndel
5250a86277 delete ancient FAQ
This file hadn't been touched since 2017.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2024-02-07 15:00:56 -08:00
Michael Keller
129cbf8d95 Documentation: Add Missing Image in CONTRIBUTING.md
Add an image missing in CONTRIBUTING.md.

I found this version from 2015 in the wayback machine. ;-)

Signed-off-by: Michael Keller <github@ike.ch>
2024-02-07 08:41:18 -08:00
Simeon
eea75fc1c4 Removed section about GPS recording from user-manual
The GPS tracker functionality was removed from Subsurface-Mobile a while ago. This commit changes the documentation to reflect the current state of the Subsurface-Mobile application.

Reported-by: Simeon Geiger
Signed-off-by: Simeon Geiger <simeon.geiger@gmail.com>
2024-01-20 09:38:22 -08:00
Michael Keller
5fae7ce7a0 Equipment: Include Unused Tanks in Merge if Preference is Enabled.
Include unused tanks in merges of multiple logs into a single dive if
the 'Show unused cylinders' preference is enabled.
Also rename the preference (in code) to `include_unused_tanks` to
reflect the fact that it is already used in more places than just the
display (exporting, cloning dives).
Simplified the cylinder model to make forced inclusion of unused tanks
dependent on use of the model in planner.
Leaving the persisted name of the preference as `display_unused_tanks`
to avoid resetting this for all users - is there a good way to migrate
preference names?

Signed-off-by: Michael Keller <github@ike.ch>
2023-07-25 11:19:03 +12:00
Michael Keller
ce67c8b902 Desktop: Add a Button to Hide the Infobox in the Dive Profile.
Add a button that allows the user to hide the infobox with statistics
about the point in the dive under the mouse cursor in order to be able
to see the full dive profile unobstructed.

Signed-off-by: Michael Keller <github@ike.ch>
2023-06-25 14:40:23 +02:00
Michael Keller
2aa13ea9d7 Desktop: Add mergeing into the selected dive site.
When editing a dive site in the 'Dive sites' view, add a context menu
entry to allow mergeing of the displayed dive site into the dive site
seleted in the 'Near dive sites' list.
This merge has the opposite direction of the existing 'Merge into
current site' function, which can simplify the workflow when maintaining
a large number of dive sites, as the facilities to sort dive sites in
the 'Dive sites' view does not have a way to sort by location or
proximity.

Signed-off-by: Michael Keller <github@ike.ch>
2023-05-20 07:24:39 +02:00
Michael Keller
a38ea971a0 Import: Add option to sync time on dive computer download
Add an option for users to sync the dive computer time with the PC time
every time dives are downloaded.
Obviously this will only work on dive computers that have time
synchronisation support in libdivecomputer, for other computers a notice
is logged.
The selection for this option is persisted as a preference.

Signed-off-by: Michael Keller <github@ike.ch>
2023-04-17 07:56:02 -07:00
Michael Andreen
1047937197 user-manual: Update documentation on fixing sensor data
Signed-off-by: Michael Andreen <michael@andreen.dev>
2022-09-03 13:38:34 -07:00
Michael Andreen
dddec0a5b6 user-manual: Add section on moving sensors
Signed-off-by: Michael Andreen <michael@andreen.dev>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2022-03-13 15:03:24 -07:00
Dirk Hohndel
75b2fcc4a4 user-manual: update the bundled html version
This is used if someone builds from source and doesn't have asciidoc
installed.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2022-03-04 12:03:48 -08:00
Jason Bramwell
28a5442944 printing: add gas fractions to print template and user manual
Add additional exported values gasO2, gasHe and gasN2 to be available to the
print template.

Also add these to the user manual as well as document some other missing
variables like surge and chill.

Finally, remove references to Grantlee. While the print template still uses the
syntax that we inherited from Grantlee, we aren't actually using Grantlee
anymore.

Reported-by: Rahul Swaminathan <rahul.swaminathan@gmail.com>
Signed-off-by: Jason Bramwell <jb2cool@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2022-03-04 12:02:35 -08:00
Jason Bramwell
6454c6e6ea user-manual: include doumentation for meandepth print template
Reported-by: Rahul Swaminathan <rahul.swaminathan@gmail.com>
Signed-off-by: Jason Bramwell <jb2cool@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2022-03-04 12:02:30 -08:00
Berthold Stoeger
f4c85eec04 manual: change dive master to dive guide
For consistency with the application.

Signed-off-by: Berthold Stoeger <bstoeger@mail.tuwien.ac.at>
2022-02-15 09:35:43 -08:00
Oliver Schwaneberg
04c5ab0e36 Uemis support: hack around the need to reconnect the Uemis Zurich
When the file system of the Zurich gets full, the only way to continue to
download from it, is to disconnect and reconnect the dive computer (which
resets the FAT file system that it emulates to 'empty').

This solution is rather hacky and weird because it does a hard count down in a
busy loop, but given the narrow use case, this may be acceptable.

This also adds support for the UEMIS_DIVE_OFFSET environment variable that
allows the user to skip dives on the device.

[refactored by Dirk Hohndel]

Signed-off-by: Oliver Schwaneberg <oliver.schwaneberg@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2022-02-15 09:31:35 -08:00
Dirk Hohndel
9891bdc9ee mobile manual: update version and date
Also update the rendered version.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2021-10-30 08:50:30 -07:00
Dirk Hohndel
e454669215 documentation: remove location service reference from mobile manual
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2021-09-13 11:21:34 -07:00
Dirk Hohndel
3faff0b7f0 update Changelog and user manual
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2021-08-18 13:22:02 -07:00
Dirk Hohndel
d0b6e61fc1 update bundled mobile manual html
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2021-06-30 10:58:49 -07:00
Dirk Hohndel
1762ad9472 documentation: update the included html manual
Forgot to do that when updating the user manual the last time.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2021-06-03 08:30:07 -07:00
Dirk Hohndel
49130150cd cleanup: don't use colons in file names
While Subsurface doesn't build on Windows, we shouldn't prevent people
from checking out the sources there...

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2021-06-03 08:25:11 -07:00
Dirk Hohndel
56ffa95459 mobile/user-manual: update date and version
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2021-03-31 10:20:44 -07:00
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
5595a70bd5 documentation: automate creation of web facing manuals
We already had the script to post-process the HTML files in the repo,
but we didn't automate use of that script in the Makefile. The .wp
suffix is misleading and historical (we no longer us WordPress), but
it's what I am used to and I didn't come up with something more obvious
or better.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2021-02-24 12:23:05 -08:00
Willem Ferguson
a651bb4550 mobile/manual: small changes to improve mobile manual
Better image placement, other small changes.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2021-02-24 10:03:12 -08:00
Willem Ferguson
cd8eb274e3 mobile/manual: tuning of header sizes
This makes all the font sizes relative and avoids odd effects on some browsers.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2021-02-24 09:54:43 -08:00
Dirk Hohndel
68c56751c4 mobile/manual: small style change to fit pictures
This way they don't exceed the page size.

This also removes execute bits from a couple of pictures. That's just wrong...

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2021-02-21 12:42:10 -08:00
willemferguson
9da9133372 Mobile user manual update: statistics
As the title says. This is a first pass because I cannot see what it looks like
on the mobile device if it has not been pulled into master. I need to see what
size the images have on the mobile screen and how the organisation of text above
and below the images is rendered. There will definitely be a second PR to refine
the content for the mobile screen and to ensure proper integration of the
statistics section with the overall user manual..

Signed-off-by: willemferguson <willemferguson@zoology.up.ac.za>
2021-02-17 07:21:01 -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
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