Here is a few corrections/clarifications to user manual. I noticed that we have quite a bit of copy-paste on adding dives (manually and from dive computer). I suggest that for 4.3 release this part is rewritten so that the common description is given only once and the specific sections describe only the part that is different.
miika
From 708eac9d10a798efa8ef2e4e9259d5b7c755825b Mon Sep 17 00:00:00 2001 From: Miika Turkia <miika.tur...@gmail.com> Date: Sat, 2 Aug 2014 09:07:57 +0300 Subject: [PATCH 4/4] Some more clarifications and fixes to user manual Signed-off-by: Miika Turkia <miika.tur...@gmail.com> --- Documentation/user-manual.txt | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt index d8e3898..7fabe84 100644 --- a/Documentation/user-manual.txt +++ b/Documentation/user-manual.txt @@ -564,7 +564,8 @@ Upload mode? must be charged or replaced. - Is the connecting cable faulty? Does the cable work perfectly using other -software? Has it worked before, or is this the first time the cable is being used? +software? Has it worked before, or is this the first time the cable is being used? Are the contacts +on the dive computer and the cable clean? - Consult xref:_appendix_a_operating_system_specific_information_for_importing_dive_information_from_a_dive_computer[Appendix A] @@ -655,8 +656,10 @@ information displayed. *Air/water temperatures*: Air and water temperatures during the dive are shown in these fields to the right of the Start time. Many dive computers supply water temperature information and this field may therefore not require further -editing. If -editing is required, only a value is required, the units of temperature will be +editing. If air temperature is not provided by the dive computer, the first temperature reading +might be used for the air temperature. Generally this is close enough to the real air temperature as +the change in the temperature sensor reading is quite slow to follow the changes in the environment. +If editing is required, only a value is required, the units of temperature will be automatically supplied by _Subsurface_ (according to the _Preferences_, metric or imperial units will be used). @@ -664,7 +667,7 @@ be used). *Location*: In this field one should type in text that describes the site where the dive was performed, e.g. "Tihany, Lake Balaton, Hungary". Auto completion of location names will -make this easier when a user frequently dives at the same sites. +make this easier if one frequently dives at the same sites. *Coordinates*: The geographic coordinates of the dive site should be entered here. These can come from three sources: @@ -761,6 +764,8 @@ In most cases _Subsurface_ obtains the gas used from the dive computer and automatically inserts the gas composition(% oxygen) in the table. The + button at the top right allows the user to add more cylinders for this dive. The dark dustbin icon on the left allows the deletion of information for a cylinder. +Note that it is not possible to delete a cylinder if it is used during the +dive. A cylinder might be implicitly used in the dive, even without a gas change event. The user should start by selecting a cylinder type on the left-hand side of the table. To select a cylinder, the *cylinder type* box should be clicked. This @@ -869,7 +874,7 @@ user has to export the logbook(s) to an intermediate format so that they can then be imported by _Subsurface_. Currently, _Subsurface_ supports importing CSV log files from several sources. -APD LogViewer, XP5 and Sensus files are +APD LogViewer, XP5, Sensus and Seabear files are preconfigured, but because the import is flexible, users can configure their own imports. Manually kept log files (e.g. in spreadsheet) can also be imported by @@ -882,6 +887,10 @@ them from there with _Subsurface_, as divelogs.de supports a few additional logbook formats that _Subsurface_ currently cannot parse. +If other software's log format is support natively on Subsurface, it should be sufficient to select +the log file on the import dialog or just use open log on it. We do support e.g. the import Suunto +Dive Manager and Shearwater SQL databases directly. + When importing dives, _Subsurface_ tries to detect multiple records for the same dive and merges the information as best as it can. If there are no time zone issues (or other reasons that would cause the -- 1.9.1
From 947f6e1fb4c23656f1f574223f7d22107c8f0784 Mon Sep 17 00:00:00 2001 From: Miika Turkia <miika.tur...@gmail.com> Date: Sat, 2 Aug 2014 07:46:11 +0300 Subject: [PATCH 3/4] Not possible to delete first cylinder Describe that used cylinders cannot be deleted and first cylinder is used implicitly. Signed-off-by: Miika Turkia <miika.tur...@gmail.com> --- Documentation/user-manual.txt | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt index 16211be..d8e3898 100644 --- a/Documentation/user-manual.txt +++ b/Documentation/user-manual.txt @@ -294,7 +294,9 @@ image::images/CylinderDataEntry1.jpg["FIGURE:Initial cylinder dialogue",align="c The + button at the top right allows the user to add more cylinders for this dive. The dark dustbin icon on the left allows one to delete information for a -particular cylinder. +particular cylinder. Note that it is not possible to delete a cylinder if it is used during the +dive. One cylinder is implicitly used in the dive, even without a gas change event. Thus the first +cylinder cannot be deleted until another cylinder is created. Start by selecting a cylinder type on the left-hand side of the table. To select a cylinder, click in the *Type* box. -- 1.9.1
From 12f82855e11387403fae7dde729aa52d85598b7c Mon Sep 17 00:00:00 2001 From: Miika Turkia <miika.tur...@gmail.com> Date: Sat, 2 Aug 2014 07:38:55 +0300 Subject: [PATCH 2/4] Describe the editing mode only once Describe the editing mode only once when going through entering dive information by hand and not when describing each tab. Signed-off-by: Miika Turkia <miika.tur...@gmail.com> --- Documentation/user-manual.txt | 22 +++++++++++++--------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt index 9324efa..16211be 100644 --- a/Documentation/user-manual.txt +++ b/Documentation/user-manual.txt @@ -169,12 +169,22 @@ in the figure below. Each of these tabs will now be explained for data entry. image::images/AddDive1.jpg["FIGURE: Add dive",align="center"] +When you click on a field in Dive notes or Equipment panels, you enter *Editing mode*. This is +indicated by the message in the blue box at the top of the _Dive notes_ panel. The same message is +displayed in all the panels under Dive notes, Equipment and so forth when in editing mode. + +//// +Not displaying the edit bar as the Save and Cancel buttons are on reverse order when comparing to +the full screenshot. + +image::images/BlueEditBar.jpg["Blue edit bar",align="center"] +//// + ==== Dive Notes This panel contains the date, time and place information for a particular dive, environmental conditions, co-divers and buddies, as well as some descriptive -information. 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 +information. If one clicks on the *Dive Notes* tab, the following fields are visible: image::images/AddDive2.jpg["FIGURE: The Dive Notes tab",align="center"] @@ -270,13 +280,7 @@ image::images/CompletedDiveInfo.jpg["FIGURE: A completed Dive Notes tab",align=" ==== Equipment The Equipment tab allows the user to enter information about the type of -cylinder and gas used, as well as the weights used for a dive. The message in a -blue -box at the top of the panel: - -image::images/BlueEditBar.jpg["Blue edit bar",align="center"] - -indicates that the dive is being edited. This is a highly interactive part of +cylinder and gas used, as well as the weights used for a dive. This is a highly interactive part of _Subsurface_ and the information on cylinders and gases (entered here) affects the behaviour of the dive profile (top right-hand panel). -- 1.9.1
From 3d9d874f031bda2716b21619011490894fef5288 Mon Sep 17 00:00:00 2001 From: Miika Turkia <miika.tur...@gmail.com> Date: Sat, 2 Aug 2014 07:26:08 +0300 Subject: [PATCH 1/4] Describe default time and date Mention what is used by default for time and date when creating a new dive. (And fix upper case elsewhere.) Signed-off-by: Miika Turkia <miika.tur...@gmail.com> --- Documentation/user-manual.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt index 600e53e..9324efa 100644 --- a/Documentation/user-manual.txt +++ b/Documentation/user-manual.txt @@ -184,13 +184,13 @@ the date, a calendar is displayed from which one can choose the correct date. Press ESC to escape from the calendar. The time values (hour and minutes) can also be edited directly by clicking on each of them in the text box and by overtyping the -information displayed. +information displayed. The default date is today and the time is set one hour to the future. *Air and water temperatures*: the air and water temperatures during the dive can be typed directly on the fields to the right of the Start time. Temperature units are not needed, as they will be automatically supplied by _Subsurface_. Only the numerical value must be -typed by the user (The units selected in the 'Preferences' +typed by the user (the units selected in the 'Preferences' will determine whether metric or imperial units are used). *Location*: Here the name of the dive site can be entered, e.g. "Tihany, Lake -- 1.9.1
_______________________________________________ subsurface mailing list subsurface@hohndel.org http://lists.hohndel.org/cgi-bin/mailman/listinfo/subsurface
