aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/user-manual.txt
AgeCommit message (Collapse)Author
2021-08-18update Changelog and user manualGravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2021-06-03cleanup: don't use colons in file namesGravatar Dirk Hohndel
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-03-24User manual: Create new cylinder typeGravatar willemferguson
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-11documentation: gentle nudge back to standardized US-EnglishGravatar Dirk Hohndel
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-11Update to desktop user manualGravatar willemferguson
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-02-26Describe CCR changes in documentationGravatar Robert C. Helling
Signed-off-by: Robert C. Helling <helling@atdotde.de>
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-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-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-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-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-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-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-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-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>
2019-05-05Desktop user manual update: dive site managementGravatar willemferguson
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-04-16Write dive data as video subtitlesGravatar Robert C. Helling
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-03-05User manual: Text for Filter ToolGravatar willemferguson
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-02-10Changes to user manual (V4.8.4)Gravatar willemferguson
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-07Export profile imageGravatar Robert C. Helling
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-05Add button to toggle deco info in info boxGravatar Robert C. Helling
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-05Explain surface GF value in user manualGravatar Robert C. Helling
Signed-off-by: Robert C. Helling <helling@atdotde.de>
2019-02-01facebook: remove the featute from the code baseGravatar Lubomir I. Ivanov
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>
2018-11-01user-manual: add notes about state of BTLE on WindowsGravatar Lubomir I. Ivanov
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-09-23User manual: describe the DC shortcut buttonsGravatar Dirk Hohndel
It would be great to have a corresponding screen shot. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2018-09-18Documentation: tiny fix in US user manualGravatar Jan Mulder
Commit a4f04589c7d did forget to delete 1 line related the Companion app. Deleted here. Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2018-09-16user manual: additional updates and new imagesGravatar willemferguson
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-16Manual entry of export anonymizationGravatar Robert C. Helling
This should be accompanied by an updated screen shot. Signed-off-by: Robert C. Helling <helling@atdotde.de>
2018-09-16user manual: update dates and add latest HTMLGravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>