From 7771158c82c0d9da51d417e9c0a2d69c9dce4818 Mon Sep 17 00:00:00 2001 From: Dirk Hohndel Date: Fri, 3 Jan 2014 03:18:59 -0800 Subject: Prepare for 4.0.1 release Small updates to README, ReleaseNotes, user manual. Signed-off-by: Dirk Hohndel --- Documentation/user-manual.html.git | 223 ++++++++++++++++++++++++++++--------- 1 file changed, 169 insertions(+), 54 deletions(-) (limited to 'Documentation/user-manual.html.git') diff --git a/Documentation/user-manual.html.git b/Documentation/user-manual.html.git index 4188483d4..2c0869777 100644 --- a/Documentation/user-manual.html.git +++ b/Documentation/user-manual.html.git @@ -410,7 +410,7 @@ asciidoc.install(3);

USER MANUAL

Manual authors: Jacco van Koll, Dirk Hohndel, Reinout Hoornweg, Linus Torvalds, Miika Turkia, Amit Chaudhuri, Jan Schubert, Willem Ferguson, Salvador Cuñat

-

Version 4.0, December 2013

+

Version 4.0.1, January 2014

Welcome as a user of Subsurface, an advanced dive logging programme with extensive infrastructure to describe, organise and interpret scuba and free dives. Subsurface binaries are available for Windows PCs (Win XP or later), Intel @@ -566,12 +566,6 @@ here. These can come from three sources:

  1. -You can enter the coordinates by hand if you happen to know what they are. -You need to enter them as decimal degrees, e.g: N30° 13.49760' , E30° 49.30788'. -

    -
    2. -
  2. -

    You can find the coordinates on the world map in the bottom right hand part of the Subsurface window. The map displays a green bar indicating "No location data - move the map and double-click to set the location". Upon a double-click @@ -587,7 +581,21 @@ using that device. Click here for more information

    3. +
  3. +

    +One can enter the coordinates by hand if they are known, using one of +three formats with latitude followed by longitude: +

    +
    +
    +
    Degrees and decimal minutes, e.g: N30° 13.49760' , E30° 49.30788'
+Degrees minutes seconds, e.g. N30° 13' 29.8" , E30° 49' 1.5"
+Decimal degrees, e.g. 30.22496 , 30.821798
    +
    +
+

Southern hemisphere latitudes are given with a S, e.g. S30°, or with a negative +value, e.g. -30.22496

Divemaster: Enter the name of the dive master or dive guide for this dive. Again, this field offers auto completion based on the list of dive masters in the current logbook.

@@ -860,18 +868,18 @@ Click the OK button.

If there is a problem in communicating with your dive computer, an error message will be shown, similar to this text: "Unable to open /dev/ttyUSB0 Mares -(Puck Pro)". In this case, consult Appendix A for information specific to the -operating system of your Subsurface computer and consult Appendix B for -information specific to some dive computers. +(Puck Pro)", see the text in the box below.

+
+
-
Important In the case of communication failure then check the following: +Check the following: 1) Is the dive computer still in PC-communication or Upload mode? 2) Is the battery of the dive computer fully charged? If not then charge or replace the battery. @@ -886,6 +894,28 @@ computer. It is also possible that your Subsurface computer is missing drivers to interact with the download cable and connected dive computer.
+

If all the above points are in order and there is a failure to download the dive data, +then perform a download with the following +two check boxes checked in the download dialogue discussed above:

+
+
+
Save libdivecomputer logfile
+Save libdivecomputer dumpfile
+
+

When checking each of these boxes, the user is prompted to select a folder to save +the file into. The default folder is the one in which the Subsurface dive log is +kept. After downloading, no dives are shown in the Dive List but two files are created +in the folder selected above:

+
+
+
subsurface.log
+subsurface.bin
+
+

Send these files to the Subsurface mail list: subsurface@hohndel.org and +request that the files be analysed, providing your dive computer make and model +as well as contextual information about the dives recorded on the dive +computer.

+

  • @@ -951,12 +981,6 @@ here. These can come from three sources:

  1. -You can enter the coordinates by hand if you happen to know what they are. -You need to enter them as decimal degrees, e.g: N30° 13.49760', E30° 49.30788'. -

    -
    2. -
  2. -

    You can find the coordinates on the world map in the bottom right hand part of the Subsurface window. The map displays a green bar indicating "No location data - move the map and double-click to set the location". Upon a double-click @@ -972,7 +996,21 @@ using that device. Click here for more information

    3. +
  3. +

    +One can enter the coordinates by hand if they are known, using one of +three formats with latitude followed by longitude: +

    +
    +
    +
    Degrees and decimal minutes, e.g: N30° 13.49760' , E30° 49.30788'
+Degrees minutes seconds, e.g. N30° 13' 29.8" , E30° 49' 1.5"
+Decimal degrees, e.g. 30.22496 , 30.821798
    +
    +
+

Southern hemisphere latitudes are given with a S, e.g. S30°, or with a negative +value, e.g. -30.22496.

Divemaster: Enter the name of the dive master or dive guide for this dive. Again, this field offers auto completion based on the list of dive masters in the current logbook.

@@ -1510,6 +1548,85 @@ Some attributes in your file may not get processed properly. Select Import→Import Files from the Main Menu. Then select the UDDF file to be imported.

+
+

3.3.10. Importing dives in CSV format

+

Sometimes dive computers export dive information as files with +comma-separated variables (.CSV). For example, the APD Inspiration and Evolution +closed circuit rebreather (CCR) systems export dive information in CSV format that +normally contains information about a single dive only. These +files can easily be imported into Subsurface. CSV files are normally organised into +a single line that provides the titles of the data columns, followed by the data, one +record per line. CSV files can be opened with a normal text editor. Here is a highly +simplified and shortened example of a CSV file from an APD rebreather:

+
+
+
Dive Time (s)   Depth (m)       PPO2 - Setpoint (Bar)   PPO2 - C1 Cell 1 (Bar)  Ambient temp. (Celsius)
+0       0.0     0.70    0.81    13.1
+0       1.2     0.70    0.71    13.1
+0       0.0     0.70    0.71    13.1
+0       1.2     0.70    0.71    13.2
+0       1.2     0.70    0.71    13.1
+10      1.6     0.70    0.72    12.7
+20      1.6     0.70    0.71    12.6
+30      1.7     0.70    0.71    12.6
+40      1.8     0.70    0.68    12.5
+50      1.6     0.70    0.68    12.5
+60      2.4     0.70    0.69    12.5
+70      3.5     0.70    0.69    12.4
+80      4.2     0.70    0.72    12.5
+90      4.0     0.70    0.71    12.4
+
+

Note that each title may comprise more than one word, for instance Dive Time (s) +in the above data example. Before being able to import the data to Subsurface one first +needs to know:

+
    +
  1. +

    +Which character separates the different colums within a single line of data? This +field separator should be either a comma (,) or a TAB character. This could be determined +by opening the file with a text editor. If it is commma-delimited, then the comma +characters between the values are clearly visible. If no commas are evident, the file +is probably TAB-delimited (i.e. it uses a TAB as a field separator, as in the above example). +

    +
    2. +
  2. +

    +Which data columns need to be imported into Subsurface?. The Dive Time and +Depth colums are always required. Open the file using a text editor and note the +titles of the columns to be imported and their column positions. For instance +for the above example: +

    +
    +
    +
    Time:           column 1
+Depth:          column 2
+Temperature:    column 5
+ppO2:           column 4
    +
    +
    3. +
+

Armed with this information, the import into Subsurface is straightforward. Select +Import→Import CSV from the main menu. The following dialogue appears:

+
+
+FIGURE: CSV download dialogue +
+
+

Specify the name of the CSV file or select it from the browser button on the right. +There are pre-configured definitions for some dive computers, e.g. the APD +rebreathers. If your dive computer is on this list, select it using the dropdown +box labeled Pre-configured imports, click OK and the dive will be imported and +listed in the Dive List tab of Subsurface.

+

If your dive computer is not on the pre-configured list, then select the Field +Separator (TAB or comma) for your CSV file, using the appropriate +dropdown list. Lastly, indicate which columns in the CSV file contain which data +variables. For each data column used for import, check the appropriate check box +and indicate in which column these data are found. For instance, the image above +corresponds to the dialogue that would apply to the CSV data set described above +the image. Having performed +the column specification, select the OK button and the dive will be imported and +listed in the Dive List tab of Subsurface.

+

3.4. Importing GPS coordinates with the Subsurface Companion app for mobile phones

@@ -2027,34 +2144,31 @@ the completed action on the right (B):

- - -
-

6. Manipulating single dives

-
-

6.1. Delete a dive from the dive log

+

5.4. Manipulating single dives

+
+

5.4.1. Delete a dive from the dive log

Dives can be permanently deleted from the dive log by selecting and right-clicking them to bring up the context menu, and then selecting Delete dive(s). Typically this would apply to a case where you wish to delete workshop calibration dives of the dive computer or dives of extremely short duration.

-
-

6.2. Unlink a dive from a trip

+
+

5.4.2. Unlink a dive from a trip

You can unlink dives from the trip to which they belong. Select and right-click the dives to bring up the context menu. Then select Remove dive(s) from trip. The dives that have been unlinked now appear immediately above the trip to which they belonged.

-
-

6.3. Add a dive to the trip immediately above

+
+

5.4.3. Add a dive to the trip immediately above

Selected dives can be moved from the trip to which they belong and placed within the trip immediately above the currently active trip. Select and right-click the dives to bring up the context menu, then select Add dive(s) to trip immediately above.

-
-

6.4. Shift the start time of dive(s)

+
+

5.4.4. Shift the start time of dive(s)

Sometimes it is necessary to adjust the start time of a dive. This may apply to situations where dives are performed in different time zones or when the dive computer has an erroneous time. Select and right-click the dive(s) to be @@ -2062,8 +2176,8 @@ adjusted. This brings up the context menu. Select Shift times. (in hours and minutes) by which the dives should be adjusted and click on the option indicating whether the time adjustment should be forwards or backwards.

-
-

6.5. Merge dives into a single dive

+
+

5.4.5. Merge dives into a single dive

Sometimes a dive is briefly interrupted, e.g. if a diver returns to the surface for a few minutes, resulting in two or more dives being recorded by the dive computer and appearing as different dives in the Dive List panel. You can @@ -2080,8 +2194,9 @@ below shows the depth profile two such dives that were merged:

+
-

7. Exporting the dive log or parts of the dive log

+

6. Exporting the dive log or parts of the dive log

A dive log can be saved in two formats:

    @@ -2109,7 +2224,7 @@ format, select Save as from the context menu. To save in UDDF format, s
-

8. Printing your dive log

+

7. Printing your dive log

Subsurface provides a simple interface to print your whole dive log or only a few selected dives, including dive profiles and other contextual information.

@@ -2189,7 +2304,7 @@ dive.

-

9. Setting your Preferences for Subsurface

+

8. Setting your Preferences for Subsurface

There are several settings within Subsurface that the user can specify. These are found when selecting File→Preferences. The settings are performed in @@ -2198,7 +2313,7 @@ operate on the same principles: specify the settings you wish to change, then save these using the Apply button. After applying all the new settings you can leave the settings panel by selecting OK.

-

9.1. Defaults

+

8.1. Defaults

There are four settings in the Defaults panel:

  • @@ -2232,7 +2347,7 @@ the Equipment tab of the Dive Notes panel.
-

9.2. Units

+

8.2. Units

Here you can choose between metric and imperial measures of depth, pressure, volume, temperature and mass. By selecting the Metric or Imperial radio button at the top, you can specify that all units are in the chosen measurement system @@ -2241,7 +2356,7 @@ a mixture with some measurements being metric while others are in imperial measures.

-

9.3. Graph

+

8.3. Graph

This panel allows two type of selections:

  • @@ -2355,7 +2470,7 @@ deepest depth of a dive. For more information see:
-

9.4. Languages

+

8.4. Languages

A checkbox allows one to use the System Default language which in most cases will be the correct setting; with this Subsurface simply runs in the same language / country settings as the underlying OS. If this is for some reason @@ -2365,13 +2480,13 @@ combination from the list of included localizations.

-

10. Description of the Subsurface Main Menu items

+

9. Description of the Subsurface Main Menu items

This section describes the functions and operation of the items in the Main Menu of Subsurface. Several of the items below are links to sections of this manual dealing with the appropriate operations.

-

10.1. File

+

9.1. File

  • @@ -2425,7 +2540,7 @@ the selected dives in the logbook) in UDDF format.

-

10.2. Import

+

9.2. Import

  • @@ -2459,7 +2574,7 @@ from www.Divelogs.de.

-

10.3. Log

+

9.3. Log

  • @@ -2485,7 +2600,7 @@ trips.

-

10.4. View

+

9.4. View

  • @@ -2532,7 +2647,7 @@ year.

-

10.5. Filter

+

9.5. Filter

  • @@ -2542,7 +2657,7 @@ year.

-

10.6. Help

+

9.6. Help

  • @@ -2560,10 +2675,10 @@ well as licensing information.

-

11. APPENDIX A: Operating system specific information for importing dive information from a dive computer.

+

10. APPENDIX A: Operating system specific information for importing dive information from a dive computer.

-

11.1. Make sure that your OS has the required drivers installed

+

10.1. Make sure that your OS has the required drivers installed

@@ -2605,7 +2720,7 @@ On a Mac you at times have to manually hunt for the correct
-

11.2. How to Find the Device Name for USB devices

+

10.2. How to Find the Device Name for USB devices

@@ -2675,7 +2790,7 @@ the import settings as /dev/ttyUSB3. Your dive computer interface i connected and you should be able to import your dives.

-

11.3. Setting up bluetooth enabled devices

+

10.3. Setting up bluetooth enabled devices

@@ -2777,10 +2892,10 @@ as device name to use.

-

12. APPENDIX B: Dive Computer specific information for importing dive information.

+

11. APPENDIX B: Dive Computer specific information for importing dive information.

-

12.1. Import from a Uemis Zurich

+

11.1. Import from a Uemis Zurich

@@ -2818,7 +2933,7 @@ stored on the SDA, including information about dive spots and equipment. Buddy information is not yet downloaded.

-

12.2. Importing dives from Heinrichs Weikamp DR5

+

11.2. Importing dives from Heinrichs Weikamp DR5

-

12.3. Import from Shearwater Predator using bluetooth

+

11.3. Import from Shearwater Predator using bluetooth

@@ -2837,7 +2952,7 @@ will most likely differ from the one displayed on the DR5.
@@ -2875,7 +2990,7 @@ switch off WiFi while using Bluetooth
-- cgit v1.2.3-70-g09d2