summaryrefslogtreecommitdiffstats
path: root/Documentation
diff options
context:
space:
mode:
authorGravatar Miika Turkia <miika.turkia@gmail.com>2013-05-01 21:16:33 +0300
committerGravatar Dirk Hohndel <dirk@hohndel.org>2013-05-02 08:32:05 -0700
commit6f750da0637f4cf7fd48b686254994ae3bc03c8f (patch)
treee35531a4b88fd5f5e292424085632677bea5b92d /Documentation
parente9ff76429ec34a6671ce4e4165bf84da728475fb (diff)
downloadsubsurface-6f750da0637f4cf7fd48b686254994ae3bc03c8f.tar.gz
Updating user documentation to reflect current version
Most of the new stuff from UI perspective should now be documented. Bumped also the doc version number optimistically. Signed-off-by: Miika Turkia <miika.turkia@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/images/dive_planning.pngbin36174 -> 37273 bytes
-rw-r--r--Documentation/images/edit_dive_info.pngbin59786 -> 77794 bytes
-rw-r--r--Documentation/images/preferences.pngbin47561 -> 56105 bytes
-rw-r--r--Documentation/images/upload_divelogs_de.pngbin0 -> 17355 bytes
-rw-r--r--Documentation/user-manual.txt48
5 files changed, 45 insertions, 3 deletions
diff --git a/Documentation/images/dive_planning.png b/Documentation/images/dive_planning.png
index 2bf15bf3a..d18cbab62 100644
--- a/Documentation/images/dive_planning.png
+++ b/Documentation/images/dive_planning.png
Binary files differ
diff --git a/Documentation/images/edit_dive_info.png b/Documentation/images/edit_dive_info.png
index b26957442..2f7d09517 100644
--- a/Documentation/images/edit_dive_info.png
+++ b/Documentation/images/edit_dive_info.png
Binary files differ
diff --git a/Documentation/images/preferences.png b/Documentation/images/preferences.png
index d82e8aa6c..c3ae61d16 100644
--- a/Documentation/images/preferences.png
+++ b/Documentation/images/preferences.png
Binary files differ
diff --git a/Documentation/images/upload_divelogs_de.png b/Documentation/images/upload_divelogs_de.png
new file mode 100644
index 000000000..c642ff082
--- /dev/null
+++ b/Documentation/images/upload_divelogs_de.png
Binary files differ
diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt
index f393bf84e..f7fad6e0e 100644
--- a/Documentation/user-manual.txt
+++ b/Documentation/user-manual.txt
@@ -5,6 +5,8 @@ Subsurface 3.0.2 User Manual
:revdate: March 2013
:revnumber: v3.0.2
:revdate: March 2013
+:revnumber: v3.1
+:revdate: May 2013
:toc:
:icons:
:numbered:
@@ -423,6 +425,7 @@ The purpose of the fields is described in the table below:
[width="90%",cols="<33%,67%",options="header"]
|===============================================================================
| Field | Description of field
+| Dive number, date and time | A button with dive number and date that gives a dialog to edit date/time/depth when clicked
| Location | An input where you can enter your new location, or you can choose with the pull-down previous locations
| GPS (WGS84 or GPS format) | An input where you can enter geographic coordinates of the dive site
| Pick on map | A button you can click on to display an interactive map on which you can select the location of the dive site
@@ -431,7 +434,8 @@ The purpose of the fields is described in the table below:
| Rating | A pull-down where you can rate your dive
| Suit | An input where you can track the exposure protection suit you were wearing
| Visibility | A pull-down where you can rate the visibility underwater
-| Air Temp in deg. C | An input where you can enter the air temperature
+| Air Temp in deg. C/F | An input where you can enter the air temperature
+| Dive Tags | Check boxes allowing you to describe the dive (e.g. shore & wreck)
| Notes | A free input where you can enter information about your dive. What you've seen, etc.
|===============================================================================
@@ -863,7 +867,7 @@ be imported to Subsurface either from command line or from GUI.
Export from divelogs.de
^^^^^^^^^^^^^^^^^^^^^^^
- - Login to http://en.divelogs.de with your account
+ - Login to https://en.divelogs.de with your account
- Go to the 'Export Logbook' page
- Choose 'DLD Export of your logbook' and save the resulting yourUserName.DLD file
@@ -940,6 +944,42 @@ Please report your findings for UDDF data from different sources than descibed
in this document at http://trac.hohndel.org[our bugtracker] or send an email to
mailto:subsurface@hohndel.org[our mailing list].
+[[S_Exporting]]
+Exporting dives from Subsurface
+-------------------------------
+
+We currently support exporting the divelog to UDDF format and directly uploading to divelogs.de.
+
+[[S_UploadingDivelogsDe]]
+Uploading Dives to divelogs.de
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Subsurface supports uploading dives directly to divelogs.de. You can upload
+either selected dives or all the dives. When selecting to upload, you are
+presented a simple dialog for user name and password. Note that the password is
+displayed on screen and is stored on configuration file in clear-text.
+
+image::images/upload_divelogs_de.png["Upload to divelogs.de",align="center"]
+
+Note that uploading dives to divelogs.de requires Internet connectivity and cannot be done off-line.
+
+.Uploading selected dives to divelogs.de
+
+Mark the dives to be uploaded in the dive list. Click right mouse button on one
+of the selected dives and select the menu 'Upload dive(s) to divelogs.de'.
+
+.Uploading all dives to divelogs.de
+
+You can of course mark all the dives and upload them using the right mouse
+button menu. However, you can also select menu 'File - Upload to
+divelogs.de...'
+
+[[S_ExportingUDDF]]
+Exporting dives to UDDF
+~~~~~~~~~~~~~~~~~~~~~~~
+
+When you select dives and choose the exporting option from right click menu, you get a dialog asking where to save the file. Similarly when you select the menu 'File - Export UDDF' you can export all the dives to UDDF file of your choosing.
+
[[S_DivePlanning]]
Planning Dives
--------------
@@ -981,7 +1021,7 @@ are familiar with dive planning or use closed circuit rebreathers.
| GFlow | Gradient factor low value affects the ceiling calculation, leave to default if you are not familiar with GF
| GFhigh | Gradient factor high value affects the ceiling calculation, leave to default if you are not familiar GF
| **Ending Depth** | Depth where current segment ends; a different depth from the previous segment creates a transition segment for ascent or descent, keeping the same depth creates a segment at the given depth. By default the planner uses the measurement for length set in the preferences (meters for most users) - this can be overridden by explicitly specifying 'm' or 'ft'.
-| **Segment Time** | Enter time in minutes; segment duration / relative time is indicated by a '+': '+3' or '+3:00' creates a segment that lasts 3 minutes, a bare number like '7' is used for a segment that ends 7 minutes after the start of the dive.
+| **Segment Time** | Enter time in minutes; segment duration / relative time is indicated by a '+': '+3' or '+3:00' creates a segment that lasts 3 minutes, an absolute time is indicated by @ character. Time '@7:30' means that the segment ends 7 minutes and 30 seconds after the start of a dive.
| **Gas Used** | Breathing gas mix used; the parser is reasonably flexible and understands terms like AIR, EAN32, 36% or 15/50 (compressed air, 32% nitrox, 36% nitrox or 15% O₂ / 50% He trimix, respectively); leaving this field empty indicates continued use of the previous gas, air by default
| **CC SetPoint** | SetPoint when diving with a closed circuit rebreather. Leave empty for open circuit dives with standard scuba equipment
|===============================================================================
@@ -1094,6 +1134,8 @@ The file menu is used for the following menu options:
- Save As:: Save your current divelogs or changes you made to your divelogs under a different name
- Close:: Close your current divelog, saving as necessary
- Import File(s):: Import your dives from files exported by other divelogs
+ - Export UDDF:: Export all dives to UDDF format
+ - Upload to divelogs.de Upload all dives to divelogs.de (requires Internet connectivity)
- Print:: Print your current divelog profiles and information about the dive
- Preferences:: Set your preferences as described in <<S_SettingUpPreferences,chapter Setting up Preferences>>
- Quit:: Quit the program