aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation
AgeCommit message (Collapse)Author
2021-02-09user manual: make the style more personalGravatar Dirk Hohndel
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-09user manual: fix typo in manual textGravatar Dirk Hohndel
This isn't about 'depth variables', but about continuous vs categorical variables. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2021-02-09user manual: introduce the two variables as 'base' and 'data'Gravatar Dirk Hohndel
Instead of adding these names later, use them right from the start. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2021-02-09user manual: get ready for 5.0Gravatar Dirk Hohndel
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-08Subsurface Desktop user manual: Statistics panelGravatar willemferguson
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>
2020-10-03Subsurface User manual update: FilterGravatar willemferguson
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-09-04Implement Seac SeacSync databaser parser.Gravatar James Wobser
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-05-05documentation: remove two remaining references to the surveyGravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2020-05-05documentation: revert switch to asciidoctorGravatar Dirk Hohndel
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-05documentation: fix makefileGravatar Dirk Hohndel
This one was my fault, not Willems (since I edited his commit). Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2020-05-05documentation/mobile-manual: create a merged v3 manualGravatar Willem Ferguson
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-05cleanup: capitalize use dcGravatar Monty Taylor
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-05cleanup: Change Salty to BrackishGravatar Monty Taylor
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-05Grantlee: Add salinity and water type to grantlee variablesGravatar Monty Taylor
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-04Mobile user manual updateGravatar willemferguson
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-04-26move GitHub url to the Subsurface orgGravatar Dirk Hohndel
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-19documentation: update bundled HTML user manualGravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2020-04-19Change to user-manual (Dive export)Gravatar willemferguson
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-18Changes to user manual for version 4.9.4Gravatar willemferguson
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-03-31mobile/user-manual: update to remove reference to 'map it' buttonGravatar Dirk Hohndel
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-27mobile/user-manual: update bundled htmlGravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2020-03-27mobile/user-manual: add hyperlinks where usefulGravatar Dirk Hohndel
Suggested-by: Martin de Weger <martin@deweger.org> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2020-03-27mobile/user-manual: small language tweaksGravatar Crawford Currie
[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-24mobile/user-manual: some tuning of the textGravatar Miika Turkia
Signed-off-by: Miika Turkia <miika.turkia@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2020-03-24mobile/user-manual: typo fixesGravatar Miika Turkia
Signed-off-by: Miika Turkia <miika.turkia@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2020-03-23macOS: still issues with mixed case namesGravatar Dirk Hohndel
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-23Subsurface-mobile v3 user manualGravatar Dirk Hohndel
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-16Mobile user manual: some updates for Subsurface-mobile 3.0Gravatar Dirk Hohndel
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-11Grammar: replaces 'indexes' by 'indices'Gravatar Robert C. Helling
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-02-27documentation: additional explanations around Windows USB driversGravatar Dirk Hohndel
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-18mobile/user-manual: additional changes for style and FTDI supportGravatar Dirk Hohndel
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-18mobile/user-manual: add short section about Dive DetailsGravatar Dirk Hohndel
This includes comments on how to zoom and pan the profile. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2020-02-08Updates to user manualGravatar willemferguson
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-06Changes to user manualsGravatar willemferguson
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-01-26Update User Manual: PreferencesGravatar willemferguson
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-26User Manual updates: changed to UIGravatar willemferguson
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-06update CHANGELOG and insert placeholder in user manualGravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2019-11-28Add current GF to infoboxGravatar Robert C. Helling
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-10Mobile: Add CHANGELOG and user manual updateGravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2019-10-31Planner: Add option to treat O2 as narcoticGravatar Robert C. Helling
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-21Small update to the mobile manualGravatar Dirk Hohndel
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-08-08Desktop user manual: dc managementGravatar willemferguson
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-07-13user manual: update the bundled html versionGravatar Dirk Hohndel
And fix the date to say July. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2019-07-12Updates to user manual (update 3 of 3)Gravatar willemferguson
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-12User manual: updates to undo descriptionGravatar Dirk Hohndel
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-06Update user manual (2 of 3)Gravatar willemferguson
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-06-26User manual update (update 1 of 3)Gravatar willemferguson
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-22Update user-manual_es.txt to commit 30f2d16daGravatar Salvador Cuñat
Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
2019-06-03Update usermanualGravatar Robert C. Helling
... to reflect new wording of menu entry. Signed-off-by: Robert C. Helling <helling@atdotde.de>
2019-05-29Extended user manual explanation of green ceilingGravatar Robert C. Helling
as a response on a recent discussion on scuba board. Signed-off-by: Robert C. Helling <helling@atdotde.de>