aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation
diff options
context:
space:
mode:
authorGravatar willemferguson <willemferguson@zoology.up.ac.za>2021-03-18 10:33:12 +0200
committerGravatar Dirk Hohndel <dirk@hohndel.org>2021-03-24 09:47:50 -0700
commit126decac6bc240282fea988b5285d9a84d1b296c (patch)
treef7f51b0d98e5d47697ad6434c45bd9d62eb38951 /Documentation
parent7c62f7541cce617d2c2651c0a93353ce03fee115 (diff)
downloadsubsurface-126decac6bc240282fea988b5285d9a84d1b296c.tar.gz
User manual: Create new cylinder type
Adds text and 5 images, detailing how to create a new cylinder type. This appears to be a perrenial problem, often appearing on the mail list. Signed-off-by: willemferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/images/Newcyl-Initial.pngbin0 -> 12298 bytes
-rw-r--r--Documentation/images/Newcyl-create.pngbin0 -> 11558 bytes
-rw-r--r--Documentation/images/Newcyl-final.pngbin0 -> 12330 bytes
-rw-r--r--Documentation/images/Newcyl-name.pngbin0 -> 23556 bytes
-rw-r--r--Documentation/images/Newcyl-selection.pngbin0 -> 19906 bytes
-rw-r--r--Documentation/user-manual.txt51
6 files changed, 41 insertions, 10 deletions
diff --git a/Documentation/images/Newcyl-Initial.png b/Documentation/images/Newcyl-Initial.png
new file mode 100644
index 000000000..00fe58f28
--- /dev/null
+++ b/Documentation/images/Newcyl-Initial.png
Binary files differ
diff --git a/Documentation/images/Newcyl-create.png b/Documentation/images/Newcyl-create.png
new file mode 100644
index 000000000..9870dc603
--- /dev/null
+++ b/Documentation/images/Newcyl-create.png
Binary files differ
diff --git a/Documentation/images/Newcyl-final.png b/Documentation/images/Newcyl-final.png
new file mode 100644
index 000000000..8781f9e8b
--- /dev/null
+++ b/Documentation/images/Newcyl-final.png
Binary files differ
diff --git a/Documentation/images/Newcyl-name.png b/Documentation/images/Newcyl-name.png
new file mode 100644
index 000000000..94ade1345
--- /dev/null
+++ b/Documentation/images/Newcyl-name.png
Binary files differ
diff --git a/Documentation/images/Newcyl-selection.png b/Documentation/images/Newcyl-selection.png
new file mode 100644
index 000000000..306637a26
--- /dev/null
+++ b/Documentation/images/Newcyl-selection.png
Binary files differ
diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt
index fdda952bf..3a4b676cd 100644
--- a/Documentation/user-manual.txt
+++ b/Documentation/user-manual.txt
@@ -922,20 +922,51 @@ options for the entered characters. The
*Size* of the cylinder as well as its working pressure (_Work.press_) will
automatically be shown in the dialog.
-*If your cylinder is not listed:* Maybe the cylinder type you dive with is not listed in the dropdown list. Add a new
-cylinder by selecting any of the existing cylinders in the list and clicking on the
-name of that cylinder. This activates the cursor on the cylinder name. Overtype
-the cylinder name with your new cylinder name and press ENTER on the keyboard. The new
-cylinder name now appears on the dropdown list. Overtyping a cylinder name does not affect
-the name that is being overtyped. Add a size and start pressure for that
-cylinder. The usual convention is that double cylinders are prefixed with a "D" to
-indicate "double". Say for instance you dive a manifolded twinset of two 7 liter steel cylinders. This
-could be named "D7ℓ 232 bar" rather than "14ℓ 232 bar". However, use a rule that works for you.
-
Next, indicate the starting pressure and the ending pressure of the
specified gas during the dive. The unit of pressure (metric/imperial)
corresponds to the settings chosen in the _Preferences_.
+[[S_newcyl]]
+
+
+****
+[icon="images/icons/important.png"]
+[IMPORTANT]
+*MY CYLINDER IS NOT LISTED IN THE DROPDOWN LIST*
+
+Maybe the cylinder type you dive with is not listed in the dropdown list. Let us say that you
+dive with 7-litre twins at 300 bars and these do not appear in the dropdown list. The image below shows
+the _Cylinder table_ as it might appear after selecting the _Equipment_ tab and before specifying
+any cylinder information:
+
+image::images/Newcyl-Initial.png["FIGURE: Initial display of cylinder table",align="center"]
+
+Start by selecting the existing cylinder in the table and clicking on the
+name of that cylinder type. The cylinder type changes to a dropdown box, recognized by the down-arrow
+next to the cylinder name (see image below)
+
+image::images/Newcyl-selection.png["FIGURE: Selecting cylinder name in cylinder table",align="center"]
+
+This activates the cursor on the cylinder type. Overtype the cylinder type with your new cylinder type (image below).
+*Important:* Overtyping a cylinder type does not affect the name that is being overtyped. The usual convention is that
+double cylinders are prefixed with a "D" to indicate "double". In our case we have a manifolded twinset of two
+7-litre 300 bar cylinders. This could be named "D7ℓ 300 bar" rather than "14ℓ 300 bar". However, use a rule that works for you.
+
+image::images/Newcyl-name.png["FIGURE: Typing new cylinder name",align="center"]
+
+and press ENTER on the keyboard. This is a critical step where most users go wrong. Pressing the ENTER key
+is the action that creates a new cylinder type (image below). Merely clicking an adjacent cell in the table does not
+create the new cylinder type.
+
+image::images/Newcyl-create.png["FIGURE: Creating ne cylinder type",align="center"]
+
+The new cylinder type now appears on the dropdown list. Add a size and start pressure for that
+cylinder (image below).
+
+image::images/Newcyl-final.png["FIGURE: Final details for new cylinder type",align="center"]
+
+****
+
Finally, provide the gas mixture used. If air was used, the
value of 21% can be entered into the oxygen box or this field can be left blank. If nitrox or
trimix were used, their percentages of oxygen and/or helium should be entered.