mifr/subsurface
1
0
Fork 0
mirror of https://github.com/subsurface/subsurface.git synced 2025-02-19 22:16:15 +00:00
Code Issues Projects Releases Packages Wiki Activity

User manual spelling errors

Browse source 
I finaly got a a spelling checker that operates on asciidoc files.
I am relieved that this only found about a dozen spelling errors
in the whole text.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
This commit is contained in:
Willem Ferguson 2017-10-21 19:30:31 +02:00 • committed by Dirk Hohndel
parent 957ff68814
commit f489af22c1
1 changed files with 31 additions and 29 deletions
Download patch file Download diff file Expand all files Collapse all files

60
Documentation/user-manual.txt
View file

@ -443,7 +443,7 @@ Check the following:
USB port? If not, consult USB port? If not, consult
xref:_appendix_a_operating_system_specific_information_for_importing_dive_information_from_a_dive_computer[Appendix A] xref:_appendix_a_operating_system_specific_information_for_importing_dive_information_from_a_dive_computer[Appendix A]
If the _Subsurface_ computer does not recognize the USB adaptor by If the _Subsurface_ computer does not recognize the USB adapter by
showing an appropriate device name next to the Mount Point, then there is a showing an appropriate device name next to the Mount Point, then there is a
possibility the cable or USB adaptor is faulty. A faulty cable is the most possibility the cable or USB adaptor is faulty. A faulty cable is the most
common cause of communication failure between a dive computer and _Subsurface_. common cause of communication failure between a dive computer and _Subsurface_.
@ -499,7 +499,7 @@ four steps:
Select the Download dialogue by selecting Select the Download dialogue by selecting
_Import -> Import from dive computer_ from the *Main Menu*. After checking the _Import -> Import from dive computer_ from the *Main Menu*. After checking the
box labelled _"Choose Bluetooth download mode"_, the dialogue below appears. box labeled _"Choose Bluetooth download mode"_, the dialogue below appears.
===== On Linux or MacOS: ===== On Linux or MacOS:
@ -507,8 +507,10 @@ image::images/DC_import_Bluetooth.jpg["FIGURE: Download Bluetooth",align="center
Although the _Subsurface_ Bluetooth interface is intended to function without Although the _Subsurface_ Bluetooth interface is intended to function without
Bluetooth pairing at the operating system level, it is always prudent to follow up Bluetooth pairing at the operating system level, it is always prudent to follow up
initial Bluetooth pairing problems by pairing the Bluetooth dive computer with the _Subsurface_ computer using the operating system services of the desktop computer. Delete all initial Bluetooth pairing problems by pairing the Bluetooth dive computer with
existing pairings and start by scanning for Bluetooth devices from an empty list (on the desktop) of Bluetooth devices. Once _Subsurface_ has recognised the Bluetooth dive the _Subsurface_ computer using the operating system services of the desktop computer. Delete all
existing pairings and start by scanning for Bluetooth devices from an empty list
(on the desktop) of Bluetooth devices. Once _Subsurface_ has recognised the Bluetooth dive
computer, subsequent divelog downloads are likely to be simple. computer, subsequent divelog downloads are likely to be simple.
On the _Linux_ or _MacOS_ platforms the name On the _Linux_ or _MacOS_ platforms the name
@ -719,7 +721,7 @@ Double-click on the blue bar below the new dive location name. The blue bar disa
the globe icon on the right-hand of the location name text box turns blue. In the Dive Map part of the _Subsurface_ window, a world map appears (image C above). Click on the the globe icon on the right-hand of the location name text box turns blue. In the Dive Map part of the _Subsurface_ window, a world map appears (image C above). Click on the
blue globe icon to the right of the dive site name in the _Notes_ panel (image B above). This opens a window for entering the details of the new dive location (image A below). blue globe icon to the right of the dive site name in the _Notes_ panel (image B above). This opens a window for entering the details of the new dive location (image A below).
The globe icon changes to indicate that the location data are being edited. The only important The globe icon changes to indicate that the location data are being edited. The only important
data here are the geographic coordinates of the dive location. data here are the geographic coordinates of the dive location.
image::images/Globe_image2.jpg["FIGURE:Location creation panel",align="center"] image::images/Globe_image2.jpg["FIGURE:Location creation panel",align="center"]
@ -1158,7 +1160,7 @@ progress.
Open the website at: Open the website at:
_https://thetheoreticaldiver.org/rch-cgi-bin/smtk2ssrf.pl_ _https://thetheoreticaldiver.org/rch-cgi-bin/smtk2ssrf.pl_
This is a no-frills This is a no-frills
web service for converting _SmartTrak_ dive logs to _Subsurface_. Select the browse button. This allows web service for converting _SmartTrak_ dive logs to _Subsurface_. Select the browse button. This allows
@ -1323,11 +1325,11 @@ dive information for four dives using a comma as a field separator:
The above data are not easily read by a human. Here is the same information in TAB-delimited format: The above data are not easily read by a human. Here is the same information in TAB-delimited format:
Dive site Dive date Time Dive_duration Dive_depth Dive buddy Dive site Dive date Time Dive_duration Dive_depth Dive buddy
Illovo Beach 2012-11-23 10:45 46:15 18.4 John Smith Illovo Beach 2012-11-23 10:45 46:15 18.4 John Smith
Key Largo 2012-11-24 09:12 34:15 20.4 Jason McDonald Key Largo 2012-11-24 09:12 34:15 20.4 Jason McDonald
Wismar Baltic 2012-12-01 10:13 35:27 15.4 Dieter Albrecht Wismar Baltic 2012-12-01 10:13 35:27 15.4 Dieter Albrecht
Pulau Weh 2012-12-20 09:46 55:56 38.6 Karaeng Bontonompo Pulau Weh 2012-12-20 09:46 55:56 38.6 Karaeng Bontonompo
It is clear why many people prefer the TAB-delimited format to the comma-delimited format. The It is clear why many people prefer the TAB-delimited format to the comma-delimited format. The
disadvantage is that you cannot see disadvantage is that you cannot see
@ -2069,7 +2071,7 @@ for more complete information. Use that software to download the dive data into
a known directory. From the main menu of _Subsurface_, select _Import -> Import a known directory. From the main menu of _Subsurface_, select _Import -> Import
log files_ to bring up the xref:Unified_import[universal import dialogue]. As log files_ to bring up the xref:Unified_import[universal import dialogue]. As
explained in that section, the bottom right explained in that section, the bottom right
hand of the import dialogue contains a dropdown list (labled _Filter:_) of appropriate devices hand of the import dialogue contains a dropdown list (labeled _Filter:_) of appropriate devices
that currently include (Poseidon) MkVI or APD log viewer files. Import for other that currently include (Poseidon) MkVI or APD log viewer files. Import for other
CCR equipment is under active development. Having selected the appropriate CCR format and CCR equipment is under active development. Having selected the appropriate CCR format and
the directory where the original dive logs have been stored from the CCR dive the directory where the original dive logs have been stored from the CCR dive
@ -2175,7 +2177,7 @@ Poseidon MkVI and APD equipment can be found in xref:_appendix_b_dive_computer_s
The Dive Map has a number of buttons useful for manipulation several aspects of a dive. These are: The Dive Map has a number of buttons useful for manipulation several aspects of a dive. These are:
[icon="images/icons/MapViewMode.jpg"] [icon="images/icons/MapViewMode.jpg"]
[NOTE] [NOTE]
Select this button to show the Dive Map as a satellite image or as a Google Maps Select this button to show the Dive Map as a satellite image or as a Google Maps
representation. representation.
@ -2345,11 +2347,11 @@ values are dependent on the composition of the breathing gas. The EAD
is the depth of a hypothetical air dive that has the same partial is the depth of a hypothetical air dive that has the same partial
pressure of nitrogen as the current depth of the nitrox dive at pressure of nitrogen as the current depth of the nitrox dive at
hand. A nitrox dive leads to the same decompression obligation as an hand. A nitrox dive leads to the same decompression obligation as an
air dive to the depth equalling the EAD. The END is the depth of a air dive to the depth equaling the EAD. The END is the depth of a
hypothetical air dive that has the same sum of partial pressures of hypothetical air dive that has the same sum of partial pressures of
the narcotic gases nitrogen and oxygen as the current trimix dive. A the narcotic gases nitrogen and oxygen as the current trimix dive. A
trimix diver can expect the same narcotic effect as a diver breathing trimix diver can expect the same narcotic effect as a diver breathing
air diving at a depth equalling the END. air diving at a depth equaling the END.
Figure (*B*) above shows an information box with a nearly complete set of data. Figure (*B*) above shows an information box with a nearly complete set of data.
@ -2460,7 +2462,7 @@ Show the partial pressure of *nitrogen* during the dive.
[icon="images/icons/He.jpg"] [icon="images/icons/He.jpg"]
[NOTE] [NOTE]
Display of the partial pressure of *helium* during the dive. Display of the partial pressure of *helium* during the dive.
This is only important to divers using Trimix, Helitrox or similar breathing gasses. This is only important to divers using Trimix, Helitrox or similar breathing gases.
The *air consumption* graph displays the tank pressure and its change during the The *air consumption* graph displays the tank pressure and its change during the
dive. The air consumption takes depth into account so that even when manually dive. The air consumption takes depth into account so that even when manually
@ -2475,7 +2477,7 @@ indicate
times of increased normalized air consumption while dark green reflects times times of increased normalized air consumption while dark green reflects times
when the diver was using less gas than average. when the diver was using less gas than average.
When in planner mode, the SAC is set to be constant during the bottom part When in planner mode, the SAC is set to be constant during the bottom part
of the dive as well during decompression. Therefore, when planning a dive, of the dive as well during decompression. Therefore, when planning a dive,
the color is a representation of the breathing gas density. the color is a representation of the breathing gas density.
@ -2600,7 +2602,7 @@ for more details on the different elements of this graph.
Image *B* shows a gradient of unique colours, spanning the whole range of inert gas pressures. Image *B* shows a gradient of unique colours, spanning the whole range of inert gas pressures.
It is possible to map the height of each of the dark green vertical bars of *A* to a It is possible to map the height of each of the dark green vertical bars of *A* to a
colour in *B*. For instance, the fastest (leftmost) dark green verical bar in *A* has colour in *B*. For instance, the fastest (leftmost) dark green vertical bar in *A* has
a height corresponding to the medium green part of *B*. The height of this bar can therefore be summarised a height corresponding to the medium green part of *B*. The height of this bar can therefore be summarised
using a medium green colour. Similarly, the highest dark green bar in *A* is as high using a medium green colour. Similarly, the highest dark green bar in *A* is as high
as the yellow part of *B*. The 14 remaining tissue pressure bars in *A* can also be as the yellow part of *B*. The 14 remaining tissue pressure bars in *A* can also be
@ -2731,7 +2733,7 @@ just before or after the dive, or of landscapes as seen from the boat.
[icon="images/icons/inAndOutPhoto.png"] [icon="images/icons/inAndOutPhoto.png"]
[NOTE] [NOTE]
This dive has photographs taken both during the dive and immdiately before or after the dive. This dive has photographs taken both during the dive and immediately before or after the dive.
[[S_Renumber]] [[S_Renumber]]
=== Renumbering the dives === Renumbering the dives
@ -3619,7 +3621,7 @@ the nitrogen load incurred during previous dives.
- Define the depth of the dive by dragging the waypoints (white dots) on the dive profile or - Define the depth of the dive by dragging the waypoints (white dots) on the dive profile or
(even better) defining the appropriate depths using the table under _Dive planner points_ as (even better) defining the appropriate depths using the table under _Dive planner points_ as
desribed under the previous heading. If described under the previous heading. If
this is a multilevel dive, set the appropriate dive depths to represent the dive plan by adding this is a multilevel dive, set the appropriate dive depths to represent the dive plan by adding
waypoints to the dive profile or by adding appropriate dive planner points to the _Dive Planner Points_ waypoints to the dive profile or by adding appropriate dive planner points to the _Dive Planner Points_
table. _Subsurface_ will automatically extend the bottom section of the dive to the maximum table. _Subsurface_ will automatically extend the bottom section of the dive to the maximum
@ -3716,7 +3718,7 @@ the limit of the gas supply but that an appropriate reserve is kept
for unforeseen circumstances. for unforeseen circumstances.
For technical diving, this reserve can be up to 66% of the total available gas. For technical diving, this reserve can be up to 66% of the total available gas.
In addition to calculating the total gas consumption for every cylinder the planner provides one way In addition to calculating the total gas consumption for every cylinder the planner provides one way
of calculating the recommended volume of bottom gas which is needed for safe asscent to the of calculating the recommended volume of bottom gas which is needed for safe ascent to the
first deco gas change depth or the surface. This procedure is called the "minimum gas" or "rock bottom" first deco gas change depth or the surface. This procedure is called the "minimum gas" or "rock bottom"
consideration and it is used by various (but not all) consideration and it is used by various (but not all)
technical diving organisations. See the text below for a detailed explanation. technical diving organisations. See the text below for a detailed explanation.
@ -3825,10 +3827,10 @@ This indicates:
The planner also estimates the *minimum gas* pressure required for safe ascent after an event that causes the dive The planner also estimates the *minimum gas* pressure required for safe ascent after an event that causes the dive
to be aborted. The calculation assumes that in worst case an out of gas (OoG) to be aborted. The calculation assumes that in worst case an out of gas (OoG)
situation occurs at the end of the planned bottom time at maximum depth. This OoG event forces situation occurs at the end of the planned bottom time at maximum depth. This OoG event forces
the buddy team the share the gas of one diver and thet they require an additional period of time at maximum depth to solve the problem at hand. the buddy team the share the gas of one diver and that they require an additional period of time at maximum depth to solve the problem at hand.
In addition the combined SAC of both divers is increased by an estimated factor compared to the SAC factor of a single diver under normal conditions. In addition the combined SAC of both divers is increased by an estimated factor compared to the SAC factor of a single diver under normal conditions.
The result of the minimum gas calculation for the bottom gas is printed to the planner output. No automatic checks are performed based on this result. The result of the minimum gas calculation for the bottom gas is printed to the planner output. No automatic checks are performed based on this result.
The feature only gives valid results for simple, rectengular shaped single The feature only gives valid results for simple, rectangular shaped single
level dive profiles. For multi level dives one would need to check every leg of the profile independently. level dive profiles. For multi level dives one would need to check every leg of the profile independently.
There are two selector boxes on the left of the _Dive plan details_: There are two selector boxes on the left of the _Dive plan details_:
@ -3852,7 +3854,7 @@ This indicates:
* The number of bars of back gas required for a safe ascent (90 bars in the example above). * The number of bars of back gas required for a safe ascent (90 bars in the example above).
* The delta-value: number of bars of back gas available at the end of the bottom section of the dive, _over and above_ the minimum * The delta-value: number of bars of back gas available at the end of the bottom section of the dive, _over and above_ the minimum
gas requirement (80 bars in the above example). A positive delta reflects a safe plan; a negative delta indicates insufficient gas for a gas requirement (80 bars in the above example). A positive delta reflects a safe plan; a negative delta indicates insufficient gas for a
safe ascent. safe ascent.
**** ****
[icon="images/icons/warning2.png"] [icon="images/icons/warning2.png"]
@ -3870,11 +3872,11 @@ _Open circuit_ in the dropdown list.
The parameters of the pSCR dive can be set by selecting _File -> Preferences -> Profile_ The parameters of the pSCR dive can be set by selecting _File -> Preferences -> Profile_
from the main menu, where the gas consumption calculation takes into account the pSCR dump from the main menu, where the gas consumption calculation takes into account the pSCR dump
ratio (default 1:10) as well as the metabolic rate. The calculation also takes the oxygen drop ratio (default 1:10) as well as the metabolic rate. The calculation also takes the oxygen drop
accross the mouthpiece of the rebreather into account. If the across the mouthpiece of the rebreather into account. If the
pO~2~ drops below what is considered safe, a warning appears in the _Dive plan pO~2~ drops below what is considered safe, a warning appears in the _Dive plan
details_. A typical pSCR cylinder setup is very similar to an open circuit dive; details_. A typical pSCR cylinder setup is very similar to an open circuit dive;
one or more drive cilinders, possibly with different bottom and decompression one or more drive cylinders, possibly with different bottom and decompression
gasses, including gas switches during the dive like in open circuit diving. gases, including gas switches during the dive like in open circuit diving.
Therefore, the setup of the _Available gases_ and the _Dive planner points_ tables Therefore, the setup of the _Available gases_ and the _Dive planner points_ tables
are very similar to that of a open circuit dive plan, described above. However, no oxygen setpoints are very similar to that of a open circuit dive plan, described above. However, no oxygen setpoints
are specified for pSCR dives. Below is a dive plan for a pSCR dive. The dive is comparable are specified for pSCR dives. Below is a dive plan for a pSCR dive. The dive is comparable
@ -3971,11 +3973,11 @@ In order to do this:
real-life dive from the _dive computer_. real-life dive from the _dive computer_.
- In the _Dive List_, highlight the dive plan as well as the data for the real dive - In the _Dive List_, highlight the dive plan as well as the data for the real dive
and merge the two dives, making use of the Dive List Context Menu and merge the two dives, making use of the Dive List Context Menu
(available by righ-clicking a dive). (available by right-clicking a dive).
The text version of the dive plan is appended to the Notes in the _Notes Tab_. With this The text version of the dive plan is appended to the Notes in the _Notes Tab_. With this
merged dive highlighted in the _Dive List_, switch merged dive highlighted in the _Dive List_, switch
between the planned profile and the real-life profile using the righ-arrow/left-arrow keyboard keys. between the planned profile and the real-life profile using the right-arrow/left-arrow keyboard keys.
== Running _Subsurface_ from the command-line == Running _Subsurface_ from the command-line
_Subsurface_ can be launched from the command-line to set some specialised settings or as _Subsurface_ can be launched from the command-line to set some specialised settings or as