User manual updates (part 3 of 3)
This patch updates several areas of the manual: 1) The import from dive computer using the new UI panel. 2) The section dealing with exports 3) Many other small changes. Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Before Width: | Height: | Size: 36 KiB After Width: | Height: | Size: 50 KiB |
Before Width: | Height: | Size: 28 KiB After Width: | Height: | Size: 21 KiB |
Before Width: | Height: | Size: 23 KiB After Width: | Height: | Size: 18 KiB |
Before Width: | Height: | Size: 61 KiB |
BIN
Documentation/images/CCR_dive_profile_f20.jpg
Normal file
After Width: | Height: | Size: 36 KiB |
Before Width: | Height: | Size: 4.6 KiB |
Before Width: | Height: | Size: 19 KiB |
Before Width: | Height: | Size: 14 KiB |
Before Width: | Height: | Size: 36 KiB |
Before Width: | Height: | Size: 16 KiB |
Before Width: | Height: | Size: 28 KiB After Width: | Height: | Size: 30 KiB |
BIN
Documentation/images/DC_import_f20.jpg
Normal file
After Width: | Height: | Size: 67 KiB |
Before Width: | Height: | Size: 30 KiB |
Before Width: | Height: | Size: 20 KiB |
Before Width: | Height: | Size: 20 KiB |
Before Width: | Height: | Size: 40 KiB |
Before Width: | Height: | Size: 29 KiB |
Before Width: | Height: | Size: 30 KiB |
Before Width: | Height: | Size: 25 KiB |
Before Width: | Height: | Size: 71 KiB After Width: | Height: | Size: 91 KiB |
|
@ -18,7 +18,7 @@ image::images/Subsurface4Banner.jpg["Banner",align="center"]
|
|||
*Manual authors*: Willem Ferguson, Jacco van Koll, Dirk Hohndel, Reinout Hoornweg,
|
||||
Linus Torvalds, Miika Turkia, Amit Chaudhuri, Jan Schubert, Salvador Cuñat, Pedro Neves
|
||||
|
||||
[blue]#_Version 4.3, December 2014_#
|
||||
[blue]#_Version 4.4, February 2015_#
|
||||
|
||||
|
||||
Welcome as a user of _Subsurface_, an advanced dive logging program with
|
||||
|
@ -64,6 +64,13 @@ 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.
|
||||
|
||||
The user survey
|
||||
---------------
|
||||
In order to develop _Subsurface_ in a way that serves its users in the best possible way,
|
||||
|
@ -169,8 +176,8 @@ in the following sections.
|
|||
xref:S_EnterData[Entering dive information by hand]
|
||||
|
||||
- Import dive log information that has been maintained either as a spreadsheet
|
||||
or as a CSV file. Refer to: xref:S_Appendix_D[APPENDIX D: Exporting a spreadsheet to CSV format]
|
||||
and the text about xref:S_ImportingManualCSV[Importing dives from manually created CSV files] and
|
||||
or as a CSV file. Refer to: xref:S_Appendix_D[APPENDIX D: Exporting a spreadsheet to CSV format] and
|
||||
to xref:S_ImportingCSVDives[Importing dives in CSV format].
|
||||
|
||||
2) If one has dives recorded using a dive computer, the depth profile of the
|
||||
dive and a large amount of additional information can be accessed. These dives
|
||||
|
@ -277,6 +284,11 @@ will cause unexpected behaviour (Subsurface will think that all of these
|
|||
dives have the same location and try to keep their GPS coordinates the
|
||||
same).
|
||||
|
||||
*Dive mode*: This is a dropdown box allowing one to choose the type of dive
|
||||
performed. The options are OC (Open Circuit, the default setting, meant for most recreational dives),
|
||||
Freedive (dive without SCUBA equipment), CCR (Closed-circuit
|
||||
rebreather) and pSCR (Passive semi-closed rebreather).
|
||||
|
||||
*Divemaster*: The name of the dive master or dive guide for this dive can be
|
||||
entered here.
|
||||
Again, this field offers auto completion based on the list of dive masters in
|
||||
|
@ -514,10 +526,11 @@ achieved by following these steps:
|
|||
Dialogue *A* in the figure below appears:
|
||||
|
||||
|
||||
image::images/ImportFromDC1_f20.jpg["FIGURE: Download dialogue 1",align="center"]
|
||||
image::images/DC_import_f20.jpg["FIGURE: Download dialogue 1",align="center"]
|
||||
|
||||
Dive computers tend to keep a certain number of dives in their memory, even
|
||||
though these dives have already been imported to _Subsurface_. For that reason
|
||||
though these dives have already been imported to _Subsurface_. For that reason, if
|
||||
the divecomputer allows this,
|
||||
_Subsurface_ only imports dives that have not been uploaded before. This makes
|
||||
the download process faster on most dive computers and also saves battery power
|
||||
of the dive computer (at least for those not charging while connected via USB).
|
||||
|
@ -556,20 +569,23 @@ _Force download of all dives_.
|
|||
- If the checkbox _Always prefer downloaded dives_
|
||||
has been checked and, during download, dives with identical date-times exist on
|
||||
the dive computer and on the _Subsurface_
|
||||
*Dive List* panel, the record in the _Subsurface_ divelog will be overwritten
|
||||
by the record from the dive computer
|
||||
*Dive List* panel, the dive in the _Subsurface_ divelog will be overwritten
|
||||
by the dive record from the dive computer
|
||||
|
||||
- The checkbox marked _Download into new trip_ ensures that, after upload, the downloaded dives
|
||||
are grouped together as a new trip(s) in the *Dive List*.
|
||||
|
||||
- Do *not* check the checkboxes labelled _Save libdivecomputer logfile_ and
|
||||
_Save libdivecomputer dumpfile_. These are only used as diagnostic tools
|
||||
when problems with downloads are experienced (see below).
|
||||
|
||||
- The _OK_ button must then be clicked. Dialogue *B* in the figure above
|
||||
appears.
|
||||
- Then select the _Download_ button. After successful download, Dialogue *B*
|
||||
in the figure above appears.
|
||||
|
||||
- With communication established, one can see how the data are
|
||||
retrieved from the dive computer.
|
||||
Depending on the make of the dive computer and/or number of recorded dives, this
|
||||
could take some time. The user should be patient. The _Download_ dialogue
|
||||
could take some time. Be patient. The _Download_ dialogue
|
||||
shows a
|
||||
progress bar at the bottom of the dialogue (for some dive computers the
|
||||
progress information could be inaccurate as we cannot determine how much
|
||||
|
@ -582,6 +598,15 @@ _Force download of all dives_.
|
|||
graph of dive depth against time for that particular dive.
|
||||
|
||||
|
||||
After the dives have been downloaded, they appear in a tabular format on the righthand
|
||||
side of the dialogue (see image *B*, above). Each dive comprises a row in the table, with the date, duration
|
||||
and depth shown. Next to each dive is a checkbox: check all the dives that need to
|
||||
be transfered to the *Dive List*. In the case of the image above, the last six dives are
|
||||
checked and will be transfered to the *Dive List*.
|
||||
|
||||
After this has been completed, select the OK button.
|
||||
The checked dives are transfered to the *Dive List*.
|
||||
|
||||
- If there is a problem in communicating with the dive computer, an error
|
||||
message will be shown, similar to this text: "Unable to open /dev/ttyUSB0 Mares
|
||||
(Puck Pro)". Refer to the text in the box below.
|
||||
|
@ -664,17 +689,18 @@ allowing easy identification of devices.
|
|||
[[S_EditDiveInfo]]
|
||||
==== Updating the dive information imported from the dive computer.
|
||||
|
||||
The information from the dive computer is not complete and more
|
||||
details must be added in order to have a fuller record of the dives. To
|
||||
do this,
|
||||
With the uploaded dives in the *Dive List*, the information from the dive
|
||||
computer is not complete and more details must be added in order to have
|
||||
a fuller record of the dives. To do this,
|
||||
the *Dive Notes* and the *Equipment* tabs on the top left hand of the
|
||||
_Subsurface_ window should be used.
|
||||
|
||||
==== Dive Notes
|
||||
|
||||
The date and time of the dive, gas mixture and (often) water temperature is
|
||||
The date and time of the dive, gas mixture and (often) water temperature are usually
|
||||
shown as obtained from the dive computer, but the user needs to add
|
||||
additional information by hand in order to have a more complete dive record.
|
||||
additional information by hand in order to have a more complete dive record. In a few cases,
|
||||
(e.g. APD rebreathers) one also has to provide the date and time of the dive.
|
||||
If the contents of this tab is changed or edited in any way, the message in a blue box at
|
||||
the top of the panel indicates that the dive is being edited. If one
|
||||
clicks on the *Dive Notes* tab, the following fields are
|
||||
|
@ -738,6 +764,11 @@ will cause unexpected behaviour (Subsurface will think that all of these
|
|||
dives have the same location and try to keep their GPS coordinates the
|
||||
same).
|
||||
|
||||
*Dive mode*: This is a dropdown box allowing one to choose the type of dive
|
||||
performed. The options are OC (Open Circuit, the default seting, meant for most recreational dives),
|
||||
Freedive (dive without SCUBA equipment), CCR (Closed-circuit
|
||||
rebreather) and pSCR (Passive semi-closed rebreather).
|
||||
|
||||
*Divemaster*: The name of the dive master or dive guide for this dive should be
|
||||
entered in this field
|
||||
which offers auto completion based on the list of dive masters in
|
||||
|
@ -1018,7 +1049,7 @@ using _www.divelogs.de_ as a mechanism to extract the dive log information.
|
|||
==== Importing dives from *divelogs.de*
|
||||
|
||||
The import of dive information from _divelogs.de_ is simple, using a single
|
||||
dialogue box. The _Import->Import form Divelogs.de_ option should be selected
|
||||
dialogue box. The _Import -> Import from Divelogs.de_ option should be selected
|
||||
from the Main Menu. This
|
||||
brings up a dialogue box (see figure on left [*A*] below). Enter a
|
||||
user-ID and password for _divelogs.de_ into the appropriate fields and then
|
||||
|
@ -1092,7 +1123,7 @@ selection menu, select _CSV files_ (towards the bottom right). This shows all .C
|
|||
directory. Select the file that needs to be imported. A configuration panel
|
||||
appears as depicted below:
|
||||
|
||||
image::images/csv_import1.jpg["FIGURE: CSV download dialogue 1",align="center"]
|
||||
image::images/csv_import1_f20.jpg["FIGURE: CSV download dialogue 1",align="center"]
|
||||
|
||||
Notice that, at the top left, there is a dropdown list containing pre-configured
|
||||
settings for some of the more common dive computers and software packages
|
||||
|
@ -1118,7 +1149,7 @@ the ballooned item labelled "Dive # " and drop it in the blue
|
|||
cell immediately above the white cell containing " # ". This is depicted in
|
||||
the image below.
|
||||
|
||||
image::images/csv_import2.jpg["FIGURE: CSV download dialogue 2",align="center"]
|
||||
image::images/csv_import2_f20.jpg["FIGURE: CSV download dialogue 2",align="center"]
|
||||
|
||||
Continue in this way to ensure that all the column headings in the blue row of
|
||||
cells correspond to the headings listed in the top part of the dialogue. Having
|
||||
|
@ -1127,7 +1158,7 @@ The data from the _CSV_ file are imported and shown in the *Dive List* panel.
|
|||
|
||||
[[S_CSV_Intro]]
|
||||
****
|
||||
*A Diver's Introduction To _CSV_ Files*
|
||||
*A Diver's Introduction to _CSV_ Files*
|
||||
[icon="images/icons/important.png"]
|
||||
[IMPORTANT]
|
||||
|
||||
|
@ -1671,7 +1702,7 @@ the _Preferences_ panel look like this, representing two checkboxes that modify
|
|||
the display of pO~2~ when the appropriate toolbar button on the Dive Profile
|
||||
has been activated.
|
||||
|
||||
image::images/CCR_preferences.jpg["FIGURE: CCR preferences panel",align="center"]
|
||||
image::images/CCR_preferences_f20.jpg["FIGURE: CCR preferences panel",align="center"]
|
||||
|
||||
Checking any of the check boxes allows the display of additional oxygen-related
|
||||
information whenever the pO~2~ toolbar button on the _Profile_ panel is activated.
|
||||
|
@ -1679,7 +1710,7 @@ The first checkbox allows the display of setpoint information. This is a red lin
|
|||
superimposed on the green oxygen partial pressure graph and allows a comparison of the
|
||||
mean measured oxygen partial pressure and the setpoint values, as in the image below.
|
||||
|
||||
image::images/CCR_setpoint.jpg["FIGURE: CCR setpoint and po2 graph",align="center"]
|
||||
image::images/CCR_setpoint_f20.jpg["FIGURE: CCR setpoint and po2 graph",align="center"]
|
||||
|
||||
The second checkbox allows the display of the data from each individual oxygen sensor
|
||||
of the CCR equipment. The data for each sensor is colour-coded as follows:
|
||||
|
@ -1692,7 +1723,7 @@ The mean oxygen pO~2~ is indicated by the green line. This allows the direct com
|
|||
of data from each of the oxygen sensors, useful for detecting abnormally low or erratic
|
||||
readings from a particular sensor.
|
||||
|
||||
image::images/CCR_sensor_data.jpg["FIGURE: CCR sensor data graph",align="center"]
|
||||
image::images/CCR_sensor_data_f20.jpg["FIGURE: CCR sensor data graph",align="center"]
|
||||
|
||||
The setpoint data can be overlaid on the oxygen sensor data by activating both of the above
|
||||
check boxes. Partial pressures for nitrogen (and helium, if applicable) are shown in the
|
||||
|
@ -1710,7 +1741,7 @@ Below is a dive profile for a CCR dive, including an overaly
|
|||
of setpoint and oxygen sensor data, as well as the cylinder pressure data. In this
|
||||
case there is good agreement from the readings of the two oxygen sensors.
|
||||
|
||||
image::images/CCR_dive_profile.jpg["FIGURE: CCR dive profile",align="center"]
|
||||
image::images/CCR_dive_profile_f20.jpg["FIGURE: CCR dive profile",align="center"]
|
||||
|
||||
_Equipment-specific information_: Equipment-specific information gathered by
|
||||
_Subsurface_ is shown in the xref:S_ExtraTab[Extra data tab]. This may include setup information
|
||||
|
@ -2331,21 +2362,13 @@ A dive log or part of it can be saved in three formats:
|
|||
dives. In order to upload dives one has to provide a used ID, so registration with
|
||||
_http://scubadiveshare.com_ is required.
|
||||
|
||||
* _CSV dive profile_, that includes a large amount of detail for each dive, including
|
||||
the depth profile, temperature and pressure information of each dive.
|
||||
|
||||
* _CSV dive details_, that includes the most critical information of the dive
|
||||
profile. Included information of a dive is: dive number, date, time, buddy,
|
||||
duration, depth, temperature and pressure: in short, most of the information
|
||||
that recreational divers enter into written log books.
|
||||
that recreational divers enter into handwritten log books.
|
||||
|
||||
* _Worldmap_ format, an HTML file with a world map upon which each dive and
|
||||
some information about it are indicated. This map is not editable.
|
||||
|
||||
* _Image depths_, which creates a text file that contains the file names of all
|
||||
photos or images attached
|
||||
to any of the selected dives in the _Dive List_, together with the depth under water where
|
||||
of each of those photos were taken.
|
||||
* _CSV dive profile_, that includes a large amount of detail for each dive, including
|
||||
the depth profile, temperature and pressure information of each dive.
|
||||
|
||||
* _HTML_ format, in which the dive(s) are stored in HTML files, readable
|
||||
with an Internet browser. Most modern web browsers are supported, but JavaScript
|
||||
|
@ -2359,6 +2382,19 @@ A dive log or part of it can be saved in three formats:
|
|||
This does away with the need to carry one's original logbook with one
|
||||
when doing dives with dive companies.
|
||||
|
||||
* _Worldmap_ format, an HTML file with a world map upon which each dive and
|
||||
some information about it are indicated. This map is not editable. However, if one selects any
|
||||
of the dive sites on the map, a summary of the dive is available in text, as shown
|
||||
in the image below.
|
||||
|
||||
image::images/mapview_f20.jpg["Figure: HTML Map export view",align="center"]
|
||||
|
||||
|
||||
* _Image depths_, which creates a text file that contains the file names of all
|
||||
photos or images attached
|
||||
to any of the selected dives in the _Dive List_, together with the depth under water where
|
||||
of each of those photos were taken.
|
||||
|
||||
* _General Settings_, under the HTML tab, provides the following options:
|
||||
|
||||
** Subsurface Numbers: if this option is checked, the dive(s) are exported with the
|
||||
|
@ -2541,7 +2577,7 @@ independently, with some units in the metric system and others in imperial.
|
|||
|
||||
=== Graph
|
||||
[[S_CCR_options]]
|
||||
image::images/Pref3.jpg["FIGURE: Preferences Graph page",align="center"]
|
||||
image::images/Pref3_f20.jpg["FIGURE: Preferences Graph page",align="center"]
|
||||
|
||||
[[S_GradientFactors]]
|
||||
This panel allows two type of selections:
|
||||
|
@ -2969,6 +3005,7 @@ dealing with the appropriate operations.
|
|||
- _User Manual_ - Open a window showing this user manual.
|
||||
|
||||
|
||||
|
||||
== APPENDIX A: Operating system specific information for importing dive information from a dive computer.
|
||||
|
||||
=== Make sure that the OS has the required drivers installed
|
||||
|
|