aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/user-manual.txt
AgeCommit message (Collapse)Author
2017-03-17user manual: code changes influencing manual (Preferences)Gravatar Jan Mulder
Commits 25dcee139 and 6305361d14 change the user interface, and this needs to be adapted in the user manual too. Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-17user manual: update list of supported dive computers to configureGravatar Jan Mulder
Update the list of supported dive computers to configure. It was a little out of sync to the code. Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-17user manual: be less verbose on DropboxGravatar Jan Mulder
The section on Dropbox is too verbose to my liking. The Subsurface manual is not the place to elaborate extensively on something external as Dropbox. Removed a section. Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-17user manual: dive list instead of dive profileGravatar Jan Mulder
Selecting dives is done in the dive list, not in the dive profile. Simple textual mistake. Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-17user manual: improved wordingGravatar Jan Mulder
Some change of wording. The split of a 10 dive trip in one of 4 and one of 6 dives is just an example. Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-17user manual: remove paragraphGravatar Jan Mulder
The removed paragraph is not really correct. You do not have to select a trip to access trip manipulation context menu items, and the behaviour of +/- buttons is so well known and commonplace that the paragraph before is more than enhough to explain this trivial feature. Solution: remove paragraph Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-17user manual: TTS does not depend on SACGravatar Jan Mulder
This one little sentence confuses me: TTS is calculated assuming an ascent surface air consumption (SAC) for the gas currently used. Time to surface is a decompression + ascent time calculation only. Obviously, the diver should plan to have suffient gas for this, but TTS is not a function of SAC. There is the "remaining air time, RAT) some dive computers can calculate which uses TTS in combination with SAC to assist the diver to start his ascent, but RAT != TTS. Solution: remove the confusing sentence. Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-17user manual: info box does not changeGravatar Jan Mulder
The info box for the dive profile is said to change to minimal when the mouse pointer is outside the profile window. Testing this in 4.6.3 shows that this is not the case. The info box does not change on window leave of the pointer. It might have worked that way before, but it is no big deal, so better to change the manual to reflect the current working. Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-17user manual: pSCR is not driven from back gas by defaultGravatar Jan Mulder
Generalize the wording. pSCRs are typically configured with a swichblock, allowing insertion a any gas in the unit, equivalently with a gas change on open circuit. Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-17user manual: not typically nitroxGravatar Jan Mulder
The fact that a pSCR is typically driven using nitrox is just flat wrong. A pSCR can be considered as universal gas extender for any depth, so any driving gas. Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-17user manual: the sections deals with pSCR so title it like thatGravatar Jan Mulder
As this section (almost exclusively) deals with pSCR reflect that in the title. Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-17user manual: correct left and right clicking and a typoGravatar Jan Mulder
left and right clicking where stated incorrectly, so corrected this. Also, a 1 letter typo on the same area corrected, not justifying a seperate commit. Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-17user manual: cannot edit other characteristicsGravatar Jan Mulder
The edit option of a dive location only allows for edit of the name, not any other attribute. Corrected text. Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-17user manual: the companion app deals with dive locationsGravatar Jan Mulder
The corrected text suggests that the Companion app deals with dives, but it deals with locations of dives. Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-17user manual: correct very unclear/erroneous sentenceGravatar Jan Mulder
It said: Now select the appropriate locations, then select the tab in the upper right, afterAndroid device. Unclear to me, so corrected to what is intended here. Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-17user manual: remove sentenceGravatar Jan Mulder
The sentence: "Check the indicator at the top of the mobile screen for internet activity, indicating the transfer of information" suggests something that is very dependent on specific Android version and esp. settings of the topbar icons. Imho is better to remove this. Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-13Use GFLow, GFHigh (not GFlow, GF Low, GF low).Gravatar Martin Měřinský
2017-03-11PO2 > pO₂Gravatar Martin Měřinský
2017-03-11We use 'setpoint' in UI. Use it also for documentation and comments. No ↵Gravatar Martin Měřinský
semantic change.
2017-03-11Use abbreviations with dots.Gravatar Martin Měřinský
2017-03-11Minimum gas calculation: Ducumentation in user manual (EN)Gravatar Stefan Fuchs
Small paragraph in EN user manual added. Planner screen shots changed and renamed. Signed-off-by: Stefan Fuchs <sfuchs@gmx.de>
2017-03-04dive master > divemasterGravatar Martin Měřinský
2017-03-04user manual: do not repeatGravatar Jan Mulder
Just said the same thing (CSV file can be edited with a text editor). Too verbose imho. Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-04user manual: make the difference between import and open explicitGravatar Jan Mulder
Two different menu path lead to "open a logfile". The File-Open-Logfile and Import-Import Logfile. The first opens a new logbook, and the second adds the data to the current log. Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-04user manual. Add 2 supported import file typesGravatar Jan Mulder
Divesoft dive logs and Poseidon MK VI eCCR dive logs where not listed as supported, but they are. Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-04user manual: downloading hereGravatar Jan Mulder
Lets try to be consistent. A dive computer can be in upload mode, and is uploading, but seen from the host PC, we are downloading. Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-04user manual: try to describe the add of location the way it isGravatar Jan Mulder
The here edited section is confusing. It references double clicking, which does not work in 4.6 (and not sure it ever worked) Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-04user manual: do not repeatGravatar Jan Mulder
Do not repeat the almost same text in the next sentence. When entering a dive location name, auto location of dive site names makes it easy to select an existing dive site name. When typing the name of a dive site, a dropdown list appears showing all sites with similar names. Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-04user manual: date/time instead of only dateGravatar Jan Mulder
Date and time of the dive are two seperate fields. Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-04user manual: correct upload vs downloadGravatar Jan Mulder
When importing from a divecomputer, we are downloading. Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-04User manual: clearify the use of shortcutsGravatar Jan Mulder
The way keybord shortcuts work is confusing. 2 ways are used: - denoted as ctrl-? for some of them - denoted as underlined character in menu items, proabably language dependent, and inconsistent. Despite all this, try to describe it in the manual as it is. Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-04User manual: https where we canGravatar Jan Mulder
http is so 1984 :-) Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-04User manual: manual added gas changes have effect to the rightGravatar Jan Mulder
Manual added gas gas changes have effect to the right of the profile, not as erroneously stated to the left of the point of gas change. Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-04user manual: correct main menu itemsGravatar Jan Mulder
Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-04User manual: minimal Windows 7 from 4.6 onwardsGravatar Jan Mulder
Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-01-12Small update to user-manualGravatar Willem Ferguson
The section for fb export missed one crucial sentence. Added it. Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2017-01-12Subsurface user manual updateGravatar Willem Ferguson
Generate text for: 1) Splitting a dive from the dive list context menu 2) Importing photos from the Internet Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2017-01-10User manual: TeX exportGravatar Robert C. Helling
Explain how to use the TeX export Signed-off-by: Robert C. Helling <helling@atdotde.de>
2017-01-07User manual updatesGravatar Willem Ferguson
Update: 1) Text dealing with SmartTrak import. Move text, some corrections, add image. 2) Text dealing with command-line arguments. A few other small changes. Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2017-01-06User manual updatesGravatar Willem Ferguson
Update sections on: 1) --user= command-line option (several divers using one desktop computer) 2) AV1 and DL7 imports Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2017-01-06User manual updatesGravatar Willem Ferguson
Update sections on: 1) Facebook integration 2) Events (notifications, warnings,alarms) on dive profile 3) Divelist icons indicating associated photographs 3 images replaced, 4 added. Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2017-01-06Add info about SmartTrak importGravatar Salvador Cuñat
Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
2017-01-06Fix some broken linksGravatar Salvador Cuñat
Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
2016-12-30README: Switch from trac & email patches to GitHub PRs & issuesGravatar Henrik Brautaset Aronsen
Ref. http://lists.subsurface-divelog.org/pipermail/subsurface/2016-December/026860.html Signed-off-by: Henrik Brautaset Aronsen <subsurface@henrik.synth.no>
2016-12-04User manual updateGravatar Willem Ferguson
1. Add text dealing with multiple dive computers on a dive. 2. Add text dealing with saving the dive plan with a dive. 3. Update main menu descriptions with respect to above [Dirk Hohndel: small updates for style] Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-11-09User manual routine update (3)Gravatar Willem Ferguson
This is the third update of the user manual. Mostly last section before appendices. Still some work remains in this part, dependent on queries to questions I raised. The images for the preferences section are replaced. Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-11-05User manual: replace heatmap comparison graphicGravatar Rick Walsh
The new heatmap graphic reflects how the heatmap is now displayed. Also update text describing graphic. Signed-off-by: Rick Walsh <rickmwalsh@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-11-05Routine maintenance of user manual (2)Gravatar Willem Ferguson
Episode 2 of current round of maintenance. Two images replaced with three new images. Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-11-01User manual: remove some passive voiceGravatar Dirk Hohndel
This makes the manual a bit more friendly to read... Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-11-01User manual: routine maintenanceGravatar Willem Ferguson
Restore headings, improve sentence readability. Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>