summaryrefslogtreecommitdiffstats
path: root/Documentation
AgeCommit message (Collapse)Author
2017-07-11French documentation translationGravatar Philippe Massart
Mostly documentation about manually added dive. Signet-off-by: Philippe Massart <philippe@philmassart.net>
2017-07-11French translation (more to come)Gravatar Philippe Massart
2017-07-08Update Subsurface-mobile user manualGravatar Willem Ferguson
[Dirk Hohndel: collapsed all of the commits into one] Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2017-07-04Documentation: Merge and update french translationsGravatar Guillaume GARDET
Signed-off-by: Guillaume GARDET <guillaume.gardet@free.fr> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2017-05-27PATCH - Refplace the figures in user manualGravatar Willem Ferguson
Replace the figures in the user manual section that deals with preferences selections. Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2017-05-26Reflect the gas density display in the user manualGravatar Robert C. Helling
Signed-off-by: Robert C. Helling <helling@atdotde.de>
2017-04-22Update bundled user manual HTML filesGravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2017-04-22Update spanish translation of user manual to english 441260b8Gravatar Salvador Cuñat
2017-04-18FAQ: update section on Bluetooth on LinuxGravatar Rick Walsh
Setting up an RFCOMM connection has not been required for a long time. Reported-by: Stephen Hemminger <stephen@networkplumber.org> Signed-off-by: Rick Walsh <rickmwalsh@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2017-04-12Add Dutch user manual HTML fileGravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2017-04-12user manual: five trivial typosGravatar Jan Mulder
five trivial typos corrected Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-04-12user manual: some more graph -> profile renamesGravatar Jan Mulder
And found some more graph -> profile strings to be renamed. Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-04-12user manual: sync command line optionsGravatar Jan Mulder
Sync the command line opions with 4.6.3 (added win32log) Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-04-12user manual: print a dive planGravatar Jan Mulder
Removed 2nd occurrence of the fact that a dive can be printed in the planner using the print button. Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-04-12NL: incorporate user manual in buildGravatar Jan Mulder
Add the nwe NL user manual to the build process. Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-04-12NL: first edition of usermanual translated to DutchGravatar Jan Mulder
First edition of usermanual translated to Dutch. Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-24user manual: Preferences Defaults renamed to GeneralGravatar Jan Mulder
See commit 25dcee139e. Preferences Defaults renamed to General. Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-24user manaul: Preferences Graph renamed to profileGravatar Jan Mulder
See commit 6305361d1477. Graph is renamed to Profile. Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-24user manual: pSCR diving is similar to OC, not CCRGravatar Jan Mulder
See also commit acb38c9e00f2. pSCR is with respect to cylinder planning very similar to OC planning. Obviously, the SAC is much (max. 8x for counterlung ration 1:10) lower, but multiple gasses are common (in all but recreational pSCR diving). Changed the wording to reflect this. Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-24user manual: weird and incorrect paragraphGravatar Jan Mulder
from the planner section the follwing paragraph is weird and partially incorrect: These changes should reflect the cylinders and gas compositions defined in the table with _Available Gases_. If two or more gases are used, automatic gas switches will be suggested during the ascent to the surface. These changes can be deleted by right-clicking the gas change and manually creating a gas change by right-clicking on the appropriate waypoint. Yes: during the ascent, gas switches are automatically planned (not suggested). These can't be deleted by right-clicking (as there are no real waypoints associated with the gas switches). And futher. To delete a gas change you have to manually create one? Solution: refrase paragraph. Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-24user manual: waypoints on profile can be moved using arrow keysGravatar Jan Mulder
Add a sentence in the central section on manual profile entry that waypoints can also be moved by keyboard (arrows). Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-24user manual: do not repeatGravatar Jan Mulder
Just said that we do not need to plan the ascent. Removed the 2nd ocurrence. Also: trivial typo corrected Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-24user manual: p02 setting in Available Gases dialog is not possibleGravatar Jan Mulder
The manual suggests that in the Available Gases dialog of the planner, setting of pO2 is possible. This is not the case, and changed the text accordingly. Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-24user manual: set of small changes in planner textGravatar Jan Mulder
Mostly typos and some wording change due to change of UI from working pressure to starting pressure. And some subscripts changed, some correction, some style. Now all are in ~2~ format. Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-24user manual: section is called ProxyGravatar Jan Mulder
Section is called Proxy and nor Proxy Type (which is attribute in the section). Simple incorrect wording fixed. Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-24user manual: changed unclear wording (network preferences)Gravatar Jan Mulder
The old wording suggests that your ISP has something to do with the Subsurface cloud or companion app. This is not right, so did a little rewrite. Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-24user manual: typoGravatar Jan Mulder
trivial 1 letter typo. Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
2017-03-24user manual: spell O2 correctlyGravatar Jan Mulder
Spell (p)O2 correctly with a subscript. Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
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 dive computer configure screendumpGravatar Jan Mulder
The currect one was too old, and not in line with the current 4.6.3 situation. 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-13htttp > httpGravatar Martin Měřinský
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ý