diff options
| author |  Willem Ferguson <willemferguson@zoology.up.ac.za> | 2015-10-19 17:45:53 +0200 |
|---|---|---|
| committer |  Dirk Hohndel <dirk@hohndel.org> | 2015-10-19 09:46:02 -0700 |
| commit | dffd2857f62ccbdb9a1329c4915717dbc60e0909 (patch) | |
| tree | 8a23fc904065215105f040a40287fb408eb20d35 /Documentation | |
| parent | 5902a1aace98783cd38abdc2c439c6c1042e80b7 (diff) | |
| download | subsurface-dffd2857f62ccbdb9a1329c4915717dbc60e0909.tar.gz | |
User manual updates
1) Delete duplicate or unused images in Documentation/images directory
2) Add text to describe user manual viewer functionality
3) Add image to explain 2) above
4) Add text to explanation of TTS toolbar button (Thank you very much, Davide!)
5) Update image showing display of TTS toolbar button
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Diffstat (limited to 'Documentation')
21 files changed, 28 insertions, 7 deletions
diff --git a/Documentation/images/AddDive1_f20.jpg b/Documentation/images/AddDive1_f20.jpg Binary files differdeleted file mode 100644 index 414795d6d..000000000 --- a/Documentation/images/AddDive1_f20.jpg +++ /dev/null diff --git a/Documentation/images/AddDive2_f20.jpg b/Documentation/images/AddDive2_f20.jpg Binary files differdeleted file mode 100644 index 4e65dac94..000000000 --- a/Documentation/images/AddDive2_f20.jpg +++ /dev/null diff --git a/Documentation/images/AddDive2_f22.jpg b/Documentation/images/AddDive2_f22.jpg Binary files differdeleted file mode 100644 index a19e24b7e..000000000 --- a/Documentation/images/AddDive2_f22.jpg +++ /dev/null diff --git a/Documentation/images/AddDive3_f20.jpg b/Documentation/images/AddDive3_f20.jpg Binary files differdeleted file mode 100644 index 790458345..000000000 --- a/Documentation/images/AddDive3_f20.jpg +++ /dev/null diff --git a/Documentation/images/BlueEditBar_f20.jpg b/Documentation/images/BlueEditBar_f20.jpg Binary files differdeleted file mode 100644 index 5b9ab2a97..000000000 --- a/Documentation/images/BlueEditBar_f20.jpg +++ /dev/null diff --git a/Documentation/images/CCR_dive_profile_f20.jpg b/Documentation/images/CCR_dive_profile_f20.jpg Binary files differdeleted file mode 100644 index fd0f23990..000000000 --- a/Documentation/images/CCR_dive_profile_f20.jpg +++ /dev/null diff --git a/Documentation/images/Ceilings.png b/Documentation/images/Ceilings.png Binary files differdeleted file mode 100644 index 55e53abf1..000000000 --- a/Documentation/images/Ceilings.png +++ /dev/null diff --git a/Documentation/images/CompletedDiveInfo_f20.jpg b/Documentation/images/CompletedDiveInfo_f20.jpg Binary files differdeleted file mode 100644 index d173febcd..000000000 --- a/Documentation/images/CompletedDiveInfo_f20.jpg +++ /dev/null diff --git a/Documentation/images/DiveProfile4_f20.jpg b/Documentation/images/DiveProfile4_f20.jpg Binary files differdeleted file mode 100644 index 9df2b9a55..000000000 --- a/Documentation/images/DiveProfile4_f20.jpg +++ /dev/null diff --git a/Documentation/images/Gas_dialogue1_f20.jpg b/Documentation/images/Gas_dialogue1_f20.jpg Binary files differdeleted file mode 100644 index 4e304a200..000000000 --- a/Documentation/images/Gas_dialogue1_f20.jpg +++ /dev/null diff --git a/Documentation/images/Gas_dialogue2_f20.jpg b/Documentation/images/Gas_dialogue2_f20.jpg Binary files differdeleted file mode 100644 index 098ea3266..000000000 --- a/Documentation/images/Gas_dialogue2_f20.jpg +++ /dev/null diff --git a/Documentation/images/ImportFromDC1_f20.jpg b/Documentation/images/ImportFromDC1_f20.jpg Binary files differdeleted file mode 100644 index a38a33cf8..000000000 --- a/Documentation/images/ImportFromDC1_f20.jpg +++ /dev/null diff --git a/Documentation/images/InfoBox2.jpg b/Documentation/images/InfoBox2.jpg Binary files differindex 5b443fa37..64c843289 100644 --- a/Documentation/images/InfoBox2.jpg +++ b/Documentation/images/InfoBox2.jpg diff --git a/Documentation/images/PrintDiveLog.jpg b/Documentation/images/PrintDiveLog.jpg Binary files differdeleted file mode 100644 index 8ff972dd7..000000000 --- a/Documentation/images/PrintDiveLog.jpg +++ /dev/null diff --git a/Documentation/images/Print_stats_f22.jpg b/Documentation/images/Print_stats_f22.jpg Binary files differdeleted file mode 100644 index 1f75b78f6..000000000 --- a/Documentation/images/Print_stats_f22.jpg +++ /dev/null diff --git a/Documentation/images/Subsurface4Banner.png b/Documentation/images/Subsurface4Banner.png Binary files differdeleted file mode 100644 index ce0743130..000000000 --- a/Documentation/images/Subsurface4Banner.png +++ /dev/null diff --git a/Documentation/images/field_options.jpg b/Documentation/images/field_options.jpg Binary files differdeleted file mode 100644 index 9827d3ef9..000000000 --- a/Documentation/images/field_options.jpg +++ /dev/null diff --git a/Documentation/images/main_window_f20.jpg b/Documentation/images/main_window_f20.jpg Binary files differdeleted file mode 100644 index a1f2bc8c0..000000000 --- a/Documentation/images/main_window_f20.jpg +++ /dev/null diff --git a/Documentation/images/tissues.jpg b/Documentation/images/tissues.jpg Binary files differdeleted file mode 100644 index bac1456f0..000000000 --- a/Documentation/images/tissues.jpg +++ /dev/null diff --git a/Documentation/images/usermanualfunctions.jpg b/Documentation/images/usermanualfunctions.jpg Binary files differnew file mode 100644 index 000000000..fe19ea8b4 --- /dev/null +++ b/Documentation/images/usermanualfunctions.jpg diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt index fc87e3a90..6ce4921f7 100644 --- a/Documentation/user-manual.txt +++ b/Documentation/user-manual.txt @@ -64,14 +64,32 @@ Divers toc::[] -[[S_UserSurvey]] + Using this manual ----------------- -When opened from within _Subsurface_, this manual does not have external controls. However, -a _SEARCH_ function is important. This is activated by pressing control-F or command-F on -the keyboard. A text box appears at the bottom of the window. Use this to search for -any term in the manual. +When opened from within _Subsurface_, this manual does not have external controls for +paging or selecting previous pages. However, two facilities are provided: + +- The _SEARCH_ function is activated by pressing control-F or command-F on +the keyboard. A text box appears at the bottom right-handof the window (see image below). +For instance, if one typed the word "_weights_" into the search text box, this word will +be searched for throughout this user manual. To the right of the search text box are two arrows pointing +up and down. Selecting these allow finding, respectively, the previous and the next occurence of +the term being searched for. + +image::images/usermanualfunctions.jpg["User manual functions",align="center"] + +- _PREVIOUS/NEXT LINK_. One can move between links (underlined words allowing one to +jump to specific sections in this user manual) by right-clicking on the text of the manual. +This brings up a context menu for jumping to previous links selected while reading the manual +(see image above). For instance if a link in the manual has been selected, then the option +to _Go Back_ shows the text at the last link that was selected (similar to the Previous Page +button in most web browsers). Conversely the _Go Forward_ option enables jumping to the +text perused before selecting the _Go Back_ option. The _Reload_ option causes the complete +user manual to be reladed into the user manual window. + +[[S_UserSurvey]] The user survey --------------- In order to develop _Subsurface_ in a way that serves its users in the best possible way, @@ -2189,13 +2207,16 @@ risk of exposure to the dangers associated with oxygen toxicity. [icon="images/icons/NDL.jpg"] [NOTE] -Clicking this button causes the Information Box to display the *No-deco Limit (NDL)* or the +Clicking this button causes the Information Box to display either the *No-deco Limit (NDL)* or the *Total Time to Surface (TTS)*. NDL is the time duration that a diver can continue with a dive, given the present depth, that does not require decompression (that is, before an ascent ceiling appears). Once one has exceeded the NDL and decompression is required (that is, there is an ascent ceiling above the diver, then TTS gives the number of minutes required before the diver can surface. TTS includes ascent time as well as decompression -time. +time. TTS is calculated assuming an ascent surface air consumption (SAC) for +the gas currently used. Even if the profile contains several gas +switches, TTS at a specific moment during the dive is calculated using the current gas. +For TTS longer than 2 hours, it is not accurately calculated and Subsurface only indicates _TTS > 2h_. [icon="images/icons/SAC.jpg"] [NOTE] |
