mifr/subsurface
1
0
Fork 0
mirror of https://github.com/subsurface/subsurface.git synced 2024-12-03 15:43:09 +00:00
Code Issues Projects Releases Packages Wiki Activity
subsurface/Documentation/user-manual.html.git

3277 lines
143 KiB
Text
Raw Normal View History

Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.8" />
<title></title>
<style type="text/css">
/*
* compact_subsurface.css, a special style sheet for Subsurface,
* modified by Willem Ferguson and derived from:
* compact.css, version 1.3 by Alex Efros <powerman@powerman.name>
* Licence: Public Domain
*
* Usage: asciidoc -a theme=compact_subsurface ...
*/
* { padding: 0; margin: 0; }
img { border: 0; }
/*** Layout ***/
body { margin: 10px 20px; }
#header br { display: none; }
#revnumber { display: block; }
#toc { margin: 1em 0; }
.toclevel2 { margin-left: 1em; }
.toclevel3 { margin-left: 2em; }
#footer { margin-top: 2em; }
#preamble .sectionbody,
h2,
h3,
h4,
h5 { margin: 1em 0 0 0; }
.admonitionblock,
.listingblock,
.sidebarblock,
.exampleblock,
.tableblock,
.literalblock { margin: 1em 0; }
.admonitionblock td.icon { padding-right: 0.5em; }
.admonitionblock td.content { padding-left: 0.5em; }
.listingblock .content { padding: 0.5em; }
.sidebarblock > .content { padding: 0.5em; }
.exampleblock > .content { padding: 0 0.5em; }
.tableblock caption { padding: 0 0 0.5em 0; }
.tableblock thead th,
.tableblock tbody td,
.tableblock tfoot td { padding: 0 0.5em; }
.quoteblock { padding: 0 2.0em; }
.paragraph { margin: 1em 0 0 0; }
.sidebarblock .paragraph:first-child,
.exampleblock .paragraph:first-child,
.admonitionblock .paragraph:first-child { margin: 0; }
.ulist, .olist, .dlist, .hdlist, .qlist { margin: 1em 0; }
li .ulist, li .olist, li .dlist, li .hdlist, li .qlist,
dd .ulist, dd .olist, dd .dlist, dd .hdlist, dd .qlist { margin: 0; }
ul { margin-left: 1.5em; }
ol { margin-left: 2em; }
dd { margin-left: 3em; }
td.hdlist1 { padding-right: 1em; }
/*** Fonts ***/
body { font-family: Verdana, sans-serif; }
#header { font-family: Arial, sans-serif; }
#header h1 { font-family: Arial, sans-serif; }
#footer { font-family: Georgia, serif; }
#email { font-size: 0.85em; }
#revnumber { font-size: 0.75em; }
#toc { font-size: 0.9em; }
#toctitle { font-weight: bold; }
#footer { font-size: 0.8em; }
h2, h3, h4, h5, .title { font-family: Arial, sans-serif; }
h2 { font-size: 1.5em; }
.sectionbody { font-size: 0.85em; }
.sectionbody .sectionbody { font-size: inherit; }
h3 { font-size: 159%; } /* 1.35em */
h4 { font-size: 141%; } /* 1.2em */
h5 { font-size: 118%; } /* 1em */
.title { font-size: 106%; /* 0.9em */
font-weight: bold;
}
tt, .monospaced { font-family: monospace; font-size: 106%; } /* 0.9em */
dt, td.hdlist1, .qlist em { font-family: Times New Roman, serif;
font-size: 118%; /* 1em */
font-style: italic;
}
.tableblock tfoot td { font-weight: bold; }
/*** Colors and Backgrounds ***/
h1 { color: #527bbd; border-bottom: 2px solid silver; }
#footer { border-top: 2px solid silver; }
h2 { color: #527bbd; border-bottom: 2px solid silver; }
h3 { color: #5D7EAE; border-bottom: 2px solid silver; }
h3 { display: inline-block; }
h4,h5 { color: #5D7EAE; }
.admonitionblock td.content { border-left: 2px solid silver; }
.listingblock .content { background: #f4f4f4; border: 1px solid silver; border-left: 5px solid #e0e0e0; }
.sidebarblock > .content { background: #ffffee; border: 1px solid silver; border-left: 5px solid #e0e0e0; }
.exampleblock > .content { border-left: 2px solid silver; }
.quoteblock { border-left: 5px solid #e0e0e0; }
.tableblock table {
border-collapse: collapse;
border-width: 3px;
border-color: #527bbd;
}
.tableblock table[frame=hsides] { border-style: solid none; }
.tableblock table[frame=border] { border-style: solid; }
.tableblock table[frame=void] { border-style: none; }
.tableblock table[frame=vsides] { border-style: none solid; }
.tableblock table[rules=all] tbody tr *,
.tableblock table[rules=rows] tbody tr * {
border-top: 1px solid #527bbd;
}
.tableblock table[rules=all] tr *,
.tableblock table[rules=cols] tr * {
border-left: 1px solid #527bbd;
}
.tableblock table tbody tr:first-child * {
border-top: 1px solid white; /* none don't work here... %-[] */
}
.tableblock table tr *:first-child {
border-left: none;
}
.tableblock table[frame] thead tr *,
.tableblock table[frame] thead tr * {
border-top: 1px solid white;
border-bottom: 2px solid #527bbd;
}
.tableblock table tr td p.table,
.tableblock table tr td p.table * {
border: 0px;
}
tt, .monospaced { color: navy; }
li { color: #a0a0a0; }
li > * { color: black; }
span.aqua { color: aqua; }
span.black { color: black; }
span.blue { color: blue; }
span.fuchsia { color: fuchsia; }
span.gray { color: gray; }
span.green { color: green; }
span.lime { color: lime; }
span.maroon { color: maroon; }
span.navy { color: navy; }
span.olive { color: olive; }
span.purple { color: purple; }
span.red { color: red; }
span.silver { color: silver; }
span.teal { color: teal; }
span.white { color: white; }
span.yellow { color: yellow; }
span.aqua-background { background: aqua; }
span.black-background { background: black; }
span.blue-background { background: blue; }
span.fuchsia-background { background: fuchsia; }
span.gray-background { background: gray; }
span.green-background { background: green; }
span.lime-background { background: lime; }
span.maroon-background { background: maroon; }
span.navy-background { background: navy; }
span.olive-background { background: olive; }
span.purple-background { background: purple; }
span.red-background { background: red; }
span.silver-background { background: silver; }
span.teal-background { background: teal; }
span.white-background { background: white; }
span.yellow-background { background: yellow; }
span.big { font-size: 2em; }
span.small { font-size: 0.6em; }
span.underline { text-decoration: underline; }
span.overline { text-decoration: overline; }
span.line-through { text-decoration: line-through; }
/*** Misc ***/
.admonitionblock td.icon { vertical-align: top; }
.attribution { text-align: right; }
ul { list-style-type: disc; }
ol.arabic { list-style-type: decimal; }
ol.loweralpha { list-style-type: lower-alpha; }
ol.upperalpha { list-style-type: upper-alpha; }
ol.lowerroman { list-style-type: lower-roman; }
ol.upperroman { list-style-type: upper-roman; }
.hdlist td { vertical-align: top; }
</style>
<script type="text/javascript">
/*<![CDATA[*/
var asciidoc = { // Namespace.
/////////////////////////////////////////////////////////////////////
// Table Of Contents generator
/////////////////////////////////////////////////////////////////////
/* Author: Mihai Bazon, September 2002
* http://students.infoiasi.ro/~mishoo
*
* Table Of Content generator
* Version: 0.4
*
* Feel free to use this script under the terms of the GNU General Public
* License, as long as you do not remove or alter this notice.
*/
/* modified by Troy D. Hanson, September 2006. License: GPL */
/* modified by Stuart Rackham, 2006, 2009. License: GPL */
// toclevels = 1..4.
toc: function (toclevels) {
function getText(el) {
var text = "";
for (var i = el.firstChild; i != null; i = i.nextSibling) {
if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
text += i.data;
else if (i.firstChild != null)
text += getText(i);
}
return text;
}
function TocEntry(el, text, toclevel) {
this.element = el;
this.text = text;
this.toclevel = toclevel;
}
function tocEntries(el, toclevels) {
var result = new Array;
var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
// Function that scans the DOM tree for header elements (the DOM2
// nodeIterator API would be a better technique but not supported by all
// browsers).
var iterate = function (el) {
for (var i = el.firstChild; i != null; i = i.nextSibling) {
if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
var mo = re.exec(i.tagName);
if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
}
iterate(i);
}
}
}
iterate(el);
return result;
}
var toc = document.getElementById("toc");
if (!toc) {
return;
}
// Delete existing TOC entries in case we're reloading the TOC.
var tocEntriesToRemove = [];
var i;
for (i = 0; i < toc.childNodes.length; i++) {
var entry = toc.childNodes[i];
if (entry.nodeName.toLowerCase() == 'div'
&& entry.getAttribute("class")
&& entry.getAttribute("class").match(/^toclevel/))
tocEntriesToRemove.push(entry);
}
for (i = 0; i < tocEntriesToRemove.length; i++) {
toc.removeChild(tocEntriesToRemove[i]);
}
// Rebuild TOC entries.
var entries = tocEntries(document.getElementById("content"), toclevels);
for (var i = 0; i < entries.length; ++i) {
var entry = entries[i];
if (entry.element.id == "")
entry.element.id = "_toc_" + i;
var a = document.createElement("a");
a.href = "#" + entry.element.id;
a.appendChild(document.createTextNode(entry.text));
var div = document.createElement("div");
div.appendChild(a);
div.className = "toclevel" + entry.toclevel;
toc.appendChild(div);
}
if (entries.length == 0)
toc.parentNode.removeChild(toc);
},
/////////////////////////////////////////////////////////////////////
// Footnotes generator
/////////////////////////////////////////////////////////////////////
/* Based on footnote generation code from:
* http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
*/
footnotes: function () {
// Delete existing footnote entries in case we're reloading the footnodes.
var i;
var noteholder = document.getElementById("footnotes");
if (!noteholder) {
return;
}
var entriesToRemove = [];
for (i = 0; i < noteholder.childNodes.length; i++) {
var entry = noteholder.childNodes[i];
if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
entriesToRemove.push(entry);
}
for (i = 0; i < entriesToRemove.length; i++) {
noteholder.removeChild(entriesToRemove[i]);
}
// Rebuild footnote entries.
var cont = document.getElementById("content");
var spans = cont.getElementsByTagName("span");
var refs = {};
var n = 0;
for (i=0; i<spans.length; i++) {
if (spans[i].className == "footnote") {
n++;
var note = spans[i].getAttribute("data-note");
if (!note) {
// Use [\s\S] in place of . so multi-line matches work.
// Because JavaScript has no s (dotall) regex flag.
note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
spans[i].innerHTML =
"[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
"' title='View footnote' class='footnote'>" + n + "</a>]";
spans[i].setAttribute("data-note", note);
}
noteholder.innerHTML +=
"<div class='footnote' id='_footnote_" + n + "'>" +
"<a href='#_footnoteref_" + n + "' title='Return to text'>" +
n + "</a>. " + note + "</div>";
var id =spans[i].getAttribute("id");
if (id != null) refs["#"+id] = n;
}
}
if (n == 0)
noteholder.parentNode.removeChild(noteholder);
else {
// Process footnoterefs.
for (i=0; i<spans.length; i++) {
if (spans[i].className == "footnoteref") {
var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
href = href.match(/#.*/)[0]; // Because IE return full URL.
n = refs[href];
spans[i].innerHTML =
"[<a href='#_footnote_" + n +
"' title='View footnote' class='footnote'>" + n + "</a>]";
}
}
}
},
install: function(toclevels) {
var timerId;
function reinstall() {
asciidoc.footnotes();
if (toclevels) {
asciidoc.toc(toclevels);
}
}
function reinstallAndRemoveTimer() {
clearInterval(timerId);
reinstall();
}
timerId = setInterval(reinstall, 500);
if (document.addEventListener)
document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
else
window.onload = reinstallAndRemoveTimer;
}
}
asciidoc.install(3);
/*]]>*/
</script>
</head>
<body class="article">
<div id="header">
</div>
<div id="content">
<div class="imageblock" style="text-align:center;">
<div class="content">
<img src="images/Subsurface4Banner.png" alt="Banner" />
</div>
</div>
<div class="paragraph"><p><span class="big">USER MANUAL</span></p></div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p><strong>Manual authors</strong>: Jacco van Koll, Dirk Hohndel, Reinout Hoornweg, Linus
Torvalds,
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
Miika Turkia, Amit Chaudhuri, Jan Schubert, Willem Ferguson, Salvador Cuñat</p></div>
Prepare for 4.0.1 release Small updates to README, ReleaseNotes, user manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-03 11:18:59 +00:00
<div class="paragraph"><p><span class="blue"><em>Version 4.0.1, January 2014</em></span></p></div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="paragraph"><p>Welcome as a user of <em>Subsurface</em>, an advanced dive logging programme with
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
extensive infrastructure to describe, organise, interpret and print scuba
and free dives.
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<em>Subsurface</em> binaries are available for Windows PCs (Win XP or later), Intel
based Macs (OS/X) and many Linux distributions. <em>Subsurface</em> can be built for
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
many more hardware platforms and software environments where Qt and
libdivecomputer are available.</p></div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="paragraph"><p>The scope of this document is the use of the <em>Subsurface</em> program. To install
the software, consult the <em>Downloads</em> page on the
<a href="http://subsurface.hohndel.org/"><em>Subsurface</em> web site</a>.
Please discuss issues with this program by sending an email to
<a href="mailto:subsurface@hohndel.org">our mailing list</a> and report bugs at
<a href="http://trac.hohndel.org">our bugtracker</a>. For instructions on how to build the
software and (if needed) its dependencies please consult the INSTALL file
included with the source code.</p></div>
<div class="paragraph"><p><strong>Audience</strong>: Recreational Scuba Divers, Free Divers, Tec Divers, Professional
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
Divers</p></div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div id="toc">
<div id="toctitle">Table of Contents</div>
<noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript>
</div>
<div class="sect1">
<h2 id="S_StartUsing">1. Start Using the Program</h2>
<div class="sectionbody">
<div class="paragraph"><p>The <em>Subsurface</em> window is usually divided into four panels and has a <strong>Main
Menu</strong> (File Import Log View Filter Help) at the top of the window (for Windows
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
and Linux) or the top of the screen (for Mac and Ubuntu Unity). The four panels are:</p></div>
<div class="paragraph"><p>1) The <strong>Dive List</strong> to the bottom left containing a list of all the dives in the
user&#8217;s
dive log. A dive can be selected and highlighted on the dive list by clicking on
it. In most situations the cursor up/down keys can be used to switch
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
between dives.</p></div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>2) The <strong>Dive Map</strong> to the bottom right, showing the user&#8217;s dive sites on a world
map
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
and centred on the site of the last selected dive.</p></div>
<div class="paragraph"><p>3) The <strong>Dive Info</strong> to the top left, giving more detailed information on the
selected dive, including some statistics for the selected dive or for all
highlighted dive(s).</p></div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>4) The <strong>Dive Profile</strong> to the top right, showing a graphical dive profile of the
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
highlighted dive in the dive list.</p></div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>The dividers can be dragged between panels in order to change the size of any of
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
the panels. <em>Subsurface</em> remembers the position of the dividers, so the next
time <em>Subsurface</em> starts it uses the positions of the dividers when the program
was executed previously.</p></div>
<div class="paragraph"><p>If one dive is selected, the dive location, detailed information and profile of
the <em>selected dive</em> are shown in the respective panels. On the other hand, if
one highlights more than one dive the last highlighted dive is the <em>selected
dive</em>, but summary data of all <em>highlighted dives</em> is shown in the <strong>Stats</strong> tab
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
of the <strong>Dive Info</strong> panel (maximum, minimum and average depths, durations, water
temperatures and SAC; total time and number of dives selected).</p></div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="imageblock" id="S_ViewPanels" style="text-align:center;">
<div class="content">
<img src="images/main_window.jpg" alt="The Main Window" />
</div>
</div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>The user can determine which of the four panels are displayed by selecting the
<strong>View</strong> option on the main menu. This option gives the user several choices of
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
display:</p></div>
<div class="paragraph"><p><strong>All</strong>: show all four of the panels as in the screenshot above.</p></div>
<div class="paragraph"><p><strong>Divelist</strong>: Show only the Dive List.</p></div>
<div class="paragraph"><p><strong>Profile</strong>: Show only the Dive Profile of the selected dive.</p></div>
<div class="paragraph"><p><strong>Info</strong>: Show only the Dive Notes about the last selected dive and statistics for
all highlighted dives.</p></div>
<div class="paragraph"><p><strong>Globe</strong>: Show only the world map, centred on the last selected dive.</p></div>
<div class="paragraph"><p>Like many other functions that can be accessed via the Main Menu, these options
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
can be triggered using keyboard shortcuts as well. The shortcuts for a
particular system
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
are shown with an underline in the menu entries. Since different Operating
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
Systems and the user chosen language may cause <em>Subsurface</em> to use different
shortcut keys they will not be listed here in the user manual.</p></div>
<div class="paragraph"><p>When the program is started for the first time, it shows no information at all.
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
This is because the program doesn&#8217;t have any dive information available. In the
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
following sections, the procedures to create a new logbook will be described.</p></div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</div>
</div>
<div class="sect1">
<h2 id="S_NewLogbook">2. Creating a new logbook</h2>
<div class="sectionbody">
<div class="paragraph"><p>Select <em>File &#8594; New Logbook</em> from the main menu. All existing dive data are
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
cleared so that new information can be added. If there is unsaved data in an
open logbook, <em>Subsurface</em> the user will be asked if the open logbook will be
saved before a new logbook is created.</p></div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</div>
</div>
<div class="sect1">
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<h2 id="S_GetInformation">3. How to obtain dive information to store in the user&#8217;s logbook</h2>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="sectionbody">
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>There are several ways in which dive information can be added to a logbook:</p></div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="olist arabic"><ol class="arabic">
<li>
<p>
Enter dive information by hand. This is typically useful if the diver did not
use a dive computer and dives were recorded in a written logbook.
</p>
</li>
<li>
<p>
Import dive information directly from a dive computer if it is supported by
<em>Subsurface</em>. The latest list of dive computers supported by <em>Subsurface</em> can
be found at:
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<a href="http://subsurface.hohndel.org/documentation/supported-dive-computers/">
Supported dive computers</a>.
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</p>
</li>
<li>
<p>
Import dive information from another data base or file format. This is
discussed in more detail below.
</p>
</li>
</ol></div>
<div class="sect2">
<h3 id="S_EnterData">3.1. Entering dive information by hand</h3>
<div class="paragraph"><p>This is usually the approach for dives without a dive computer. The basic record
of information within <em>Subsurface</em> is a dive. The most important information
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
in a simple dive logbook usually includes dive type, date, time, duration,
depth, the names of your dive buddy and of the dive master or dive guide, and
some remarks about the dive. <em>Subsurface</em> can store much more information
than this for each dive. In order to add a dive to a dive log, select <em>Log
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
&#8594; Add Dive</em> from the Main Menu. The program then shows three panels to enter
information for a dive: two tabs in the <strong>Info</strong> panel (<strong>Dive Notes</strong> and
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<strong>Equipment</strong>), as well as the <strong>profile</strong> panel that displays a graphical profile
of each dive. These panels are respectively marked <span class="red">A</span>, <span class="red">B</span> and
<span class="red">C</span>
in the figure below. Each of these tabs will now be explained for data entry.</p></div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="imageblock" style="text-align:center;">
<div class="content">
<img src="images/AddDive1.jpg" alt="FIGURE: Add dive" />
</div>
</div>
<div class="sect3">
<h4 id="_dive_notes">3.1.1. Dive Notes</h4>
<div class="paragraph"><p>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
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
the dive is being edited. If one clicks on the <strong>Dive Notes</strong> tab, the following
fields are visible:</p></div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="imageblock" style="text-align:center;">
<div class="content">
<img src="images/AddDive2.jpg" alt="FIGURE: The Dive Notes tab" />
</div>
</div>
<div class="paragraph"><p>The <strong>Starttime</strong> field reflects the date and the time of the dive. By clicking
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
the down-arrow on the right of that field a calendar will be displayed from
which
one can choose the correct date. 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.</p></div>
<div class="paragraph"><p><strong>Air and water temperatures</strong>: the air and water temperatures during the
dive can be typed directly on the fields to the right of the Starttime.
Temperature units are not needed, as they will be automatically supplied by
<em>Subsurface</em>. Only the numerical value must be
typed by the user (The units selected in the <em>Preferences</em>
will determine whether metric or imperial units are used).</p></div>
<div class="paragraph"><p><strong>Location</strong>: Here the name of the dive site can be entered, e.g. "Tihany, Lake
Balaton,
Hungary". Auto completion of location names will make this easier if one
frequently dives at the same sites.</p></div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="paragraph"><p><strong>Coordinates</strong>: The geographic coordinates of the dive site should be entered
here. These can come from three sources:</p></div>
<div class="olist loweralpha"><ol class="loweralpha">
<li>
<p>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
One can find the coordinates on the world map in the bottom right hand
part
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
of the Subsurface window. The map displays a green bar indicating "No location
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
data - Move the map double-click to set the location". Upon a double-click
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
at the appropriate place, the green bar disappears and the coordinates are
stored.
</p>
</li>
<li>
<p>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
The coordinates can be obtained from the <em>Subsurface</em> Companion app if the
user has an Android device with GPS and if the coordinates of the dive site
were stored using that device.
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<a href="#S_Companion">Click here for more information</a>
</p>
</li>
Prepare for 4.0.1 release Small updates to README, ReleaseNotes, user manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-03 11:18:59 +00:00
<li>
<p>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
The coordinates can be entered by hand if they are known, using one of
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
four formats with latitude followed by longitude:
Prepare for 4.0.1 release Small updates to README, ReleaseNotes, user manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-03 11:18:59 +00:00
</p>
<div class="literalblock">
<div class="content">
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
<pre><code>ISO 6709 Annex D format e.g. 30°13'28.9"N 30°49'1.5"E
Degrees and decimal minutes, e.g. N30° 13.49760' , E30° 49.30788'
Prepare for 4.0.1 release Small updates to README, ReleaseNotes, user manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-03 11:18:59 +00:00
Degrees minutes seconds, e.g. N30° 13' 29.8" , E30° 49' 1.5"
Decimal degrees, e.g. 30.22496 , 30.821798</code></pre>
</div></div>
</li>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</ol></div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>Southern hemisphere latitudes are given with a <strong>S</strong>, e.g. S30°, or with a
negative value, e.g. -30.22496. Similarly western longitudes are given with a
<strong>W</strong>, e.g. W07°, or with a negative value, e.g. -7.34323.</p></div>
<div class="paragraph"><p><strong>Divemaster</strong>: 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
the current logbook.</p></div>
<div class="paragraph"><p><strong>Buddy</strong>: In this field one can enter the name(s) of the buddy / buddies
(separated by commas) who accompanied the user on the dive. Auto completion
based on the list of buddies in the current logbook is offered.</p></div>
<div class="paragraph"><p><strong>Suit</strong>: The type of diving suit that was used for the dive can be entered here.
Just as with the
other items, auto completion of the suit description is available.</p></div>
<div class="paragraph"><p><strong>Rating</strong>: In this field, users can provide a subjective overall rating of the
dive on a 5-point scale by clicking the appropriate star on the rating scale.</p></div>
<div class="paragraph"><p><strong>Visibility</strong>: As with the previous item, users can provide a rating of
visibility during the dive on a 5-point scale by clicking the appropriate star.</p></div>
<div class="paragraph"><p><strong>Tags</strong>: Tags that describe the type of dive performed may
be entered here (separated by commas). Examples of common tags are boat, drift,
training, cave etc. <em>Subsurface</em> has many built-in tags. Auto completion is once again offered.
For instance, if, for instance, <code>cav</code> was typed, then the tags <strong>cave</strong> and <strong>cavern</strong> are
shown for the user to choose from.</p></div>
<div class="paragraph"><p><strong>Notes</strong>: Any additional information can be typed here.</p></div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="paragraph"><p>The <strong>Save</strong> and <strong>Cancel</strong> buttons are used to save all the information for tabs in
the info panel and in the dive profile panel, so there&#8217;s no need to use them
until ALL other information has been added. Here is an example of a completed
Dive Notes panel:</p></div>
<div class="imageblock" style="text-align:center;">
<div class="content">
<img src="images/CompletedDiveInfo.jpg" alt="FIGURE: A completed Dive Notes tab" />
</div>
</div>
</div>
<div class="sect3">
<h4 id="_equipment">3.1.2. Equipment</h4>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>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
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
box at the top of the panel:</p></div>
<div class="imageblock" style="text-align:center;">
<div class="content">
<img src="images/BlueEditBar.jpg" alt="Blue edit bar" />
</div>
</div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>indicates that the dive is being edited. This is a highly interactive part of
<em>Subsurface</em> and the information on
cylinders and gases (entered here) affects the behaviour of the dive profile
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
(top right-hand panel).</p></div>
<div class="paragraph"><p><strong>Cylinders</strong>: The cylinder information is entered through a dialogue that looks
like this:</p></div>
<div class="imageblock" style="text-align:center;">
<div class="content">
<img src="images/CylinderDataEntry1.jpg" alt="FIGURE:Initial cylinder dialogue" />
</div>
</div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>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.</p></div>
<div class="paragraph"><p>The user starts by selecting a cylinder type on the left-hand side of the
table. To select a cylinder, the user must click in the <strong>cylinder type</strong> box.
This brings up a list button that can be used to display a dropdown list of
cylinders:</p></div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="imageblock" style="text-align:center;">
<div class="content">
<img src="images/CylinderDataEntry2.jpg" alt="FIGURE:The cylinder drop-down list button" />
</div>
</div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>This drop-down list can then be used to select the cylinder type that was used
for this dive. The
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
<strong>Size</strong> of the cylinder as well as its working pressure (<strong>WorkPress</strong>) will
automatically be shown in the dialogue.</p></div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>Next, the user must indicate the starting pressure and the ending pressure of
the
gas used during the dive. The unit of pressure (metric/imperial) corresponds
to the setting in the preferences.</p></div>
<div class="paragraph"><p>Finally, the user should type in the gas mixture used. If air
was used, a value of 21% can be entered on this field, or the field might be
left blank. If nitrox or trimix were used, their percentages of oxygen and/or
helium must be specified.
Any inappropriate fields should be left empty. After typing the information for
the cylinder, press <em>ENTER</em> on the keyboard or click
outside the cell that contains the cursor. Information for any additional
cylinders can be added by using the + button at the top right hand. Following
is an example of a complete description for a
dive made using two cylinders (air and EAN50):</p></div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="imageblock" style="text-align:center;">
<div class="content">
<img src="images/CylinderDataEntry3.jpg" alt="FIGURE: a completed cylinder dive information table" />
</div>
</div>
<div class="paragraph"><p><strong>Weights</strong>: Information about the weight system used during a dive can be entered
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
using a dialogue very similar to that of the cylinder information. If the user
clicks the + button on the top right of the weights dialogue, the table looks
like this:</p></div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="imageblock" style="text-align:center;">
<div class="content">
<img src="images/WeightsDataEntry1.jpg" alt="FIGURE: The Weights dialogue" />
</div>
</div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>If one then clicks on the <strong>Type</strong> field, a drop-down list becomes accessible
through a down-arrow:</p></div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="imageblock" style="text-align:center;">
<div class="content">
<img src="images/WeightsDataEntry2.jpg" alt="FIGURE: Weights type drop-down list button" />
</div>
</div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>This drop-down list can then be used to select the type of weight system. In
the <strong>Weight</strong>
field, the weight used during the dive must be typed. After typing the
information
for the weight system the user must either press <em>ENTER</em> on the keyboard or
click outside the
User manual: updates Correct error in manual Add some short text in sections dealing with equipment. [Dirk Hohndel: clean up whitespace & regenerate the html file] Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-22 16:59:30 +00:00
cell that contains the cursor. It is possible to enter
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
information for more than one weight system by adding an additional system using
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
the + button on the top right hand. Weight systems can be deleted using the
dustbin icon on the left hand. Here is an example of information for a dive
with two types of weights: integrated and a weight belt:</p></div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="imageblock" style="text-align:center;">
<div class="content">
<img src="images/WeightsDataEntry3.jpg" alt="FIGURE: A completed weights information table" />
</div>
</div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>There&#8217;s NO need to click the <em>Save</em> button before the dive
profile has beeb completed.</p></div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</div>
<div class="sect3">
<h4 id="_creating_a_dive_profile">3.1.3. Creating a Dive Profile</h4>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>The <strong>Dive Profile</strong> (a graphical representation of the depth of the dive as a
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
function of time) is indicated in the panel on the top right hand of the
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<em>Subsurface</em> window. When a dive is manually added to a logbook, <em>Subsurface</em>
presents a default dive profile that needs to be modified to best represent the
dive being described:</p></div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="imageblock" style="text-align:center;">
<div class="content">
<img src="images/DiveProfile1.jpg" alt="FIGURE: Initial dive profile" />
</div>
</div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p><em>Modifying the dive profile</em>: When the cursor is moved around the dive profile,
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
its position is indicated by two red lines as shown below. The depth and time
that the cursor represents are indicated, respectively on the left hand and
bottom axes. The units (metric/imperial) on the axes are determined by the
User manual: updates Correct error in manual Add some short text in sections dealing with equipment. [Dirk Hohndel: clean up whitespace & regenerate the html file] Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-22 16:59:30 +00:00
<strong>preference</strong> settings. The dive profile itself comprises several
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
line segments demarcated by waypoints (white dots on the profile, as shown
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
above). The default dive depth is 15 m.
If the dive depth was 21 m then the user needs to drag the appropriate waypoints
downwards to represent 21 m. To add a waypoint, double-click on
any line segment.
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
To remove a waypoint, right-click on it and choose "Remove this point" from the
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
context menu. The user will also need to drag the waypoints to represent an
accurate
time duration for the dive. Below is a dive profile that represents a dive
to 21 m for 31 min, followed by a 3 minute safety stop at 5 m.</p></div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="imageblock" style="text-align:center;">
<div class="content">
<img src="images/DiveProfile2.jpg" alt="FIGURE: Edited dive profile" />
</div>
</div>
<div class="paragraph"><p><em>Specifying the gas composition:</em> The gas composition used is clearly indicated
along the line segments of the dive profile. This defaults to the first gas
mixture specified in the <strong>Equipment</strong> tab, which was air in the case of the
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
profile illustrated above. The gas mixtures of segments of the dive profile can
be edited. This is done by clicking on the particular
waypoint and selecting the appropriate gas from the context menu. Changing
the gas for a waypoint affects the gas shown in the segment <em>to the left</em> of
that
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
waypoint. Note that only the gases defined in the <strong>Equipment</strong> tab appear in the
context menu:</p></div>
<div class="imageblock" style="text-align:center;">
<div class="content">
<img src="images/DiveProfile3.jpg" alt="FIGURE: Gas composition context menu" />
</div>
</div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>Below is the profile of a dive to 21 m for 31 min with a switch from air to
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
EAN40 on the ascent. In this case the first cylinder in the <strong>Equipment</strong> tab
contained air and the second cylinder contained EAN40.</p></div>
<div class="imageblock" style="text-align:center;">
<div class="content">
<img src="images/DiveProfile4.jpg" alt="FIGURE: Completed dive profile" />
</div>
</div>
</div>
<div class="sect3">
<h4 id="_saving_the_hand_entered_dive_information">3.1.4. Saving the hand-entered dive information</h4>
<div class="paragraph"><p>The information entered in the <strong>Dive Notes</strong> tab, the <strong>Equipment</strong> tab as well as
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
the <strong>Dive Profile</strong> can now be saved in the user&#8217;s logbook by using the two
buttons
on the top right hand of the Dive Notes tab. If the <em>Save</em> button is clicked,
the dive data
are saved in the current logbook. If the <em>Cancel</em> button is clicked, the newly
entered
dive data are discarded. When exiting <em>Subsurface</em> the user will be prompted
once more to save the logbook with the new dive(s).</p></div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</div>
</div>
<div class="sect2">
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<h3 id="S_ImportDiveComputer">3.2. Importing new dive information from a Dive Computer</h3>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="sect3">
<h4 id="_connecting_and_importing_data_from_a_dive_computer">3.2.1. Connecting and importing data from a dive computer.</h4>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>The use of dive computers allows the collection of a large amount of
information about
each dive, e.g. a detailed record of depth, duration, rates of ascent/descent
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
and of gas partial pressures. <em>Subsurface</em> can capture this information and
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
present it as part of the dive information, using dive
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
information from a wide range of dive computers. The latest list of supported
dive computers can be found at:
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<a href="http://subsurface.hohndel.org/documentation/supported-dive-computers/">
Supported dive computers</a>.</p></div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="admonitionblock">
<table><tr>
<td class="icon">
<img src="images/icons/warning2.png" alt="Warning" />
</td>
<td class="content">Several dive computers consume more power when they are in their
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
PC-Communication mode. <strong>This could drain the dive computer&#8217;s battery</strong>. We
therefore
recommend that the user checks if the dive computer is charged when
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
connected to the USB port of a PC. For example, several Suunto and Mares dive
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
computers do not recharge through the USB connection. The users should refer to
the dive computer&#8217;s manual
if they are unsure whether the dive computer will recharge or drain its batteries
while connected to the USB port.</td>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</tr></table>
</div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>To import dive information from a dive computer to a computer with
<em>Subsurface</em>,
it is necessary that the two pieces of equipment communicate with one another.
This
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
involves setting up the communications port (or mount point) of the computer
with <em>Subsurface</em> that communicates with the dive computer. In order to set up
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
this communication, one needs to find the appropriate information to
instruct
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<em>Subsurface</em> where and how to import the dive information. <strong>Appendix A</strong> provides
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
the technical information to help the user achieving this for different
operating
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
systems and <strong>Appendix B</strong> has dive computer specific information.</p></div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>After this, the dive computer can be hooked up to the user&#8217;s PC, which can be
achieved by following these steps:</p></div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="ulist"><ul>
<li>
<p>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
The interface cable should be connected to a free USB port (or the Infrared
or Bluetooth connection set up as described later in this manual)
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</p>
</li>
<li>
<p>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
The dive computer should be placed into PC Communication mode.
(Users should refer to the manual of their specific dive computer)
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</p>
</li>
<li>
<p>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
In <em>Subsurface</em>, from the Main Menu, the user must select <em>Import &#8594; Import
From Dive Computer</em>.
Dialogue <strong>A</strong> in the figure below appears:
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</p>
</li>
</ul></div>
<div class="imageblock" style="text-align:center;">
<div class="content">
<img src="images/ImportFromDC1.jpg" alt="FIGURE: Download dialogue 1" />
</div>
</div>
<div class="paragraph"><p>Dive computers tend to keep a certain number of dives in their memory, even
though these dives have already been imported to <em>Subsurface</em>. For that reason
<em>Subsurface</em> only imports dives that have not been uploaded before. This makes
the download process faster on most dive computers and also saves battery power
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
of the dive computer (at least for those not charging while connected via USB).
If, for some reason, the user wishes to import ALL dives from the dive computer,
even though some may already be in the logbook, then the the check box labeled
<em>Force download of all dives</em> can be ticked.</p></div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="ulist"><ul>
<li>
<p>
The dialogue has two drop-down lists, <strong>Vendor</strong> and <strong>Dive Computer</strong>. On the
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<strong>vendor</strong> drop-down list the user must select the make of the computer, e.g.
Suunto, Oceanic,
Uwatec, Mares. On the <strong>Dive Computer</strong> drop-down list, the model name of
the dive computer must be selected, e.g. D4 (Suunto), Veo200 (Oceanic), or Puck
(Mares).
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</p>
</li>
<li>
<p>
The <strong>Device or Mount Point</strong> drop-down list contains the USB or Bluetooth port
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
name that <em>Subsurface</em> needs in order to communicate with the dive computer.
The appropriate port name must be selected. Consult <strong>Appendix A</strong>
and <strong>Appendix B</strong> for
technical details on how to find the appropriate port information for a
particular dive
computer and, in some cases, how to do the correct settings to the operating
system of the computer on which <em>Subsurface</em> is running.
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</p>
</li>
<li>
<p>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
The <em>OK</em> button must then be clicked. Dialogue <strong>B</strong> in the figure above
appears.
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
</p>
</li>
<li>
<p>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
With communication established, one can see how the data is
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 <em>Download</em> 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
downloadable data there is until all data have been downloaded). When the
download of the dive information is complete, all the imported dives appear
in the Dive List, sorted by date and time. One can then disconnect and
switch off the dive
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
computer to conserve its battery power.
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
If a particular dive is selected, the Dive Profile panel shows an informative
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
graph of dive depth against time for that particular dive.
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</p>
</li>
<li>
<p>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
If there is a problem in communicating with the dive computer, an error
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
message will be shown, similar to this text: "Unable to open /dev/ttyUSB0 Mares
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
(Puck Pro)". Refer to the text in the box below.
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</p>
</li>
</ul></div>
Prepare for 4.0.1 release Small updates to README, ReleaseNotes, user manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-03 11:18:59 +00:00
<div class="sidebarblock">
<div class="content">
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="admonitionblock">
<table><tr>
<td class="icon">
<img src="images/icons/important.png" alt="Important" />
</td>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<td class="content">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 the battery
must be charged or replaced.
3) 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?
4) Consult <strong>Appendix A</strong> and make sure that the correct Mount Point
was specified (see above).
5) On Unix-like operating systems, does the user have write permission to the
USB port? If not, users should consult appendix <strong>A</strong>.</td>
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
</tr></table>
</div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>If the <em>Subsurface</em> computer does not recognise the USB adaptor by
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
showing an appropriate device name next to the Mount Point, then there is a
possibility that the cable or USB adaptor is faulty. A faulty cable is the most
common cause of communication failure between dive computer and <em>Subsurface</em>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
computer. It is also possible that the <em>Subsurface</em> computer is missing
data, one should perform a download with the following
Prepare for 4.0.1 release Small updates to README, ReleaseNotes, user manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-03 11:18:59 +00:00
two check boxes checked in the download dialogue discussed above:</p></div>
<div class="literalblock">
<div class="content">
<pre><code>Save libdivecomputer logfile
Save libdivecomputer dumpfile</code></pre>
</div></div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>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 <em>Subsurface</em>
dive log is kept. <strong>Important:</strong> After downloading, no dives are shown in the
<strong>Dive List</strong> but two files are created in the folder selected above:</p></div>
Prepare for 4.0.1 release Small updates to README, ReleaseNotes, user manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-03 11:18:59 +00:00
<div class="literalblock">
<div class="content">
<pre><code>subsurface.log
subsurface.bin</code></pre>
</div></div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>These files should be send to the <em>Subsurface</em> mail list:
<em>subsurface@hohndel.org</em> with a
request for the files to be analysed. One should provide the dive computer
make and model
as well as contextual information about the dives recorded on the dive computer.</p></div>
Prepare for 4.0.1 release Small updates to README, ReleaseNotes, user manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-03 11:18:59 +00:00
</div></div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</div>
<div class="sect3">
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<h4 id="S_EditDiveInfo">3.2.2. Updating the dive information imported from the dive computer.</h4>
<div class="paragraph"><p>The information from the dive computer is not complete and more
details must be added in order to have a more complete record of the dives. To
do this,
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
the <strong>Dive Notes</strong> and the <strong>Equipment</strong> tabs on the top left hand of the
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<em>Subsurface</em> window should be used.</p></div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</div>
<div class="sect3">
<h4 id="_dive_notes_2">3.2.3. Dive Notes</h4>
<div class="paragraph"><p>The date and time of the dive, gas mixture and perhaps water temperature is
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
shown as obtained from the dive computer, but the user needs to add some
additional information by hand in order to have a more complete dive record.
The message in a blue box at
the top of the panel indicates that the dive is being edited. If the user
clicks on the <strong>Dive Notes</strong> tab, the following fields are
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
visible:</p></div>
<div class="imageblock" style="text-align:center;">
<div class="content">
<img src="images/AddDive3.jpg" alt="FIGURE: The Dive Notes tab" />
</div>
</div>
<div class="paragraph"><p>The <strong>Starttime</strong> field reflects the date and the time of the dive, as supplied by
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
the dive computer. It should therefore not be necessary to edit this, but one
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
could make changes by clicking the down-arrow on the right of that field to
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
display a calendar from which the correct date can be chosen. The hour and
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
minutes values can also be edited by clicking on each of them in the text box
and by overtyping the information displayed.</p></div>
<div class="paragraph"><p><strong>Air/water temperatures</strong>: Air and water temperatures during the dive are shown
in these fields to the right of the Starttime. Many dive computers supply water
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
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
automatically supplied by
<em>Subsurface</em> (according to the <em>Preferences</em>, metric or imperial units will
be used).</p></div>
<div class="paragraph"><p><strong>Location</strong>: In this field one should type in text that describes the site
where the dive was performed, e.g. "Tihany, Lake Balaton, Hungary". the required drivers to interact with the download cable and connected dive
computer.</p></div>
<div class="paragraph"><p>If all the above points are in order and there is a failure to download the
dive
Auto completion of location names will
make this easier when a user frequently dives at the same sites.</p></div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="paragraph"><p><strong>Coordinates</strong>: The geographic coordinates of the dive site should be entered
here. These can come from three sources:</p></div>
<div class="olist loweralpha"><ol class="loweralpha">
<li>
<p>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
The user can find the coordinates on the world map in the bottom right hand
part
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
of the Subsurface window. The map displays a green bar indicating "No location
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
data - move the map and double-click to set the location". Double-click
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
at the appropriate place, the green bar disappears and the coordinates are
stored.
</p>
</li>
<li>
<p>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
The user can obtain the coordinates from the <em>Subsurface</em> Companion app if
an Android device with GPS was used and the if the coordinates of the dive site
were stored using that device.
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<a href="#S_Companion">Click here for more information</a>
</p>
</li>
Prepare for 4.0.1 release Small updates to README, ReleaseNotes, user manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-03 11:18:59 +00:00
<li>
<p>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
The coordinates can be entered by hand if they are known, using one of
Prepare for 4.0.1 release Small updates to README, ReleaseNotes, user manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-03 11:18:59 +00:00
three formats with latitude followed by longitude:
</p>
<div class="literalblock">
<div class="content">
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<pre><code>ISO 6709 Annex D format e.g. 30°13'28.9"N 30°49'1.5"E
Degrees and decimal minutes, e.g. N30° 13.49760' , E30° 49.30788'
Prepare for 4.0.1 release Small updates to README, ReleaseNotes, user manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-03 11:18:59 +00:00
Degrees minutes seconds, e.g. N30° 13' 29.8" , E30° 49' 1.5"
Decimal degrees, e.g. 30.22496 , 30.821798</code></pre>
</div></div>
</li>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</ol></div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>Southern hemisphere latitudes are given with a <strong>S</strong>, e.g. S30°, or with a
negative value, e.g. -30.22496. Similarly western longitudes are given with a
<strong>W</strong>, e.g. W07°, or with a negative value, e.g. -7.34323.</p></div>
<div class="paragraph"><p><strong>Divemaster</strong>: The name of the dive master or dive guide for this dive should be
entered in this field.
This field offers auto completion based on the list of dive masters in
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
the current logbook.</p></div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p><strong>Buddy</strong>: In this field, one enters the name(s) of the buddy / buddies
(separated with commas) who accompanied him/her on the
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
dive. Auto completion based on the list of buddies in the current logbook is
offered.</p></div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p><strong>Suit</strong>: Here the type of diving suit used for the dive can be entered.
Auto completion of the suit description is available.</p></div>
<div class="paragraph"><p><strong>Rating</strong>: One can provide a subjective overall rating of the dive on a
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
5-point scale by clicking the appropriate star on the rating scale.</p></div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p><strong>Visibility</strong>: Similarly, one can provide a rating of visibility during the
dive on a
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
5-point scale by clicking the appropriate star.</p></div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p><strong>Tags</strong>: Tags that describe the type of dive performed can be entered
here (separated by commas). Examples of common tags are boat, drift, training,
cave, etc.
<em>Subsurface</em> has many built-in tags. If the user starts typing a tag, the
program
will list the tags that correspond to the typing. For instance, if the user
typed
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<code>cav</code>, then the tags <strong>cave</strong> and <strong>cavern</strong> are shown for the user to choose from.</p></div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p><strong>Notes</strong>: Any additional information for the dive can be entered here.</p></div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="paragraph"><p>The <strong>Save</strong> and <strong>Cancel</strong> buttons are used to save all the information for tabs
in the info panel and in the dive profile panel, so there&#8217;s no need to use them
until ALL other information has been added. Here is an example of a completed
Dive Notes panel:</p></div>
<div class="imageblock" style="text-align:center;">
<div class="content">
<img src="images/CompletedDiveInfo.jpg" alt="FIGURE: A completed Dive Notes tab" />
</div>
</div>
</div>
<div class="sect3">
<h4 id="_equipment_2">3.2.4. Equipment</h4>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>The Equipment tab allows one to enter information about the type of
cylinder and gas used as well as the weights used for the dive. The
message in a blue box at the top of the panel:</p></div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="imageblock" style="text-align:center;">
<div class="content">
<img src="images/BlueEditBar.jpg" alt="FIGURE: Blue edit bar" />
</div>
</div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>indicates that the dive is being edited.This is a highly interactive part of
<em>Subsurface</em> and the information on
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
cylinders and gases (entered here) determines the behaviour of the dive profile
(top right-hand panel).</p></div>
<div class="paragraph"><p><strong>Cylinders</strong>: The cylinder information is entered through a dialogue that looks
like this:</p></div>
<div class="imageblock" style="text-align:center;">
<div class="content">
<img src="images/CylinderDataEntry1.jpg" alt="FIGURE: Initial cylinder dialogue" />
</div>
</div>
<div class="paragraph"><p>In most cases <em>Subsurface</em> obtains the gas used from the dive computer and
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
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.</p></div>
<div class="paragraph"><p>The user should start by selecting a cylinder type on the left-hand side of the
table. To select a cylinder, the <strong>cylinder type</strong> box should be clicked. This
brings up a list button that can be used to display a dropdown list of
cylinders:</p></div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="imageblock" style="text-align:center;">
<div class="content">
<img src="images/CylinderDataEntry2.jpg" alt="FIGURE: The cylinder drop-down list button" />
</div>
</div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>The drop-down list can then be used to select the cylinder type that was used
for this dive. The
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<strong>Size</strong> of the cylinder as well as its working pressure (<strong>WorkPress</strong>) will
automatically be shown in the dialogue.</p></div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>Next one must 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.</p></div>
<div class="paragraph"><p>Finally, the user must type in the gas mixture used. If air was used, the
value of 21% can be entered here or this field can be left blank. If nitrox or
trimix were used, their percentages of oxygen and/or helium should be entered.
Any inappropriate fields should be left empty. After typing the
information for the cylinder,
either press <em>ENTER</em> on the keyboard or click outside the cell
that contains
the cursor. Information for any additional cylinders can be added by using the<br />
button at the top right hand. Following is an example of a complete description
for a dive using two cylinders (air and EAN40):</p></div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="imageblock" style="text-align:center;">
<div class="content">
<img src="images/CylinderDataEntry3.jpg" alt="FIGURE: a completed cylinder dive information table" />
</div>
</div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p><strong>Weights</strong>: Information about the weight system used can be entered
using a dialogue very similar to that of the cylinder information. If one
clicks
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
the + button on the top right of the weights dialogue, the table looks like
this:</p></div>
<div class="imageblock" style="text-align:center;">
<div class="content">
<img src="images/WeightsDataEntry1.jpg" alt="FIGURE:The Weights dialogue" />
</div>
</div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>By clicking on the <strong>Type</strong> field, a drop-down list becomes accessible through a
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
down-arrow:</p></div>
<div class="imageblock" style="text-align:center;">
<div class="content">
<img src="images/WeightsDataEntry2.jpg" alt="FIGURE:Weights type drop-down list button" />
</div>
</div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>The drop-down list can then be used to select the type of weight system
used during the dive. In the <strong>Weight</strong>
field, type in the amount of weight used during the dive. After
specifying the weight
system, the user can either press <em>ENTER</em> on the keyboard or click outside the
cell with the cursor.
It is possible to enter information for more than one weight system by adding
an additional system
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
using the + button on the top right hand. Weight systems can be deleted using
the dustbin icon on the left hand. Here is an example of information for a dive
with two types of weights: integrated and a weight belt:</p></div>
<div class="imageblock" style="text-align:center;">
<div class="content">
<img src="images/WeightsDataEntry3.jpg" alt="FIGURE: A completed weights information table" />
</div>
</div>
</div>
<div class="sect3">
<h4 id="_saving_the_updated_dive_information">3.2.5. Saving the updated dive information</h4>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>The information entered in the <strong>Dive Notes</strong> tab and the <strong>Equipment</strong> tab can be
saved with all the other information of the dives in the user&#8217;s logbook by
using the
two buttons on the top right hand of the <strong>Dive Notes</strong> tab. If the <em>Save</em> button
is clicked,
the dive data are saved. If the <em>Cancel</em> button is clicked, then the newly
entered dive data are
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
deleted, although the dive profile obtained from the dive computer will be
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
retained. When the user exits <em>Subsurface</em> there is a final prompt to confirm
that the new data should be saved.</p></div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</div>
</div>
<div class="sect2">
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<h3 id="_importing_dive_information_from_other_digital_data_sources_or_other_data">3.3. Importing dive information from other digital data sources or other data</h3>
<div class="paragraph"><p>formats</p></div>
<div class="paragraph" id="S_ImportingAlienDiveLogs"><p>If a user has been diving for some time, it&#8217;s possible that several dives were
logged using other dive log software. All this information needs not
be typed by hand into <em>Subsurface</em>, because these divelogs can probably be
imported onto <em>Subsurface</em>. <em>Subsurface</em> will import divelogs from a range of
other
dive log software. While some software is supported natively, for others the
user will have to
export the logbook(s) to an intermediate format so that they can then be imported
by <em>Subsurface</em>.
Currently, <em>Subsurface</em> supports importing CSV log files from several sources.
APD LogViewer, XP5 and Sensus 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
configuring the CSV import.
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<em>Subsurface</em> can also import UDDF and UDCF files that are used by some divelog
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
software and some divecomputers, like the Heinrichs &amp; Weikamp DR5. Finally,
for some divelog software like Mares Dive Organiser it is currently suggested to
import the logbooks first into a webservice like <em>divelogs.de</em> and then import
them from there with
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<em>Subsurface</em>, as divelogs.de supports a few additional logbook formats that
<em>Subsurface</em> currently cannot parse.</p></div>
<div class="paragraph"><p>When importing dives, <em>Subsurface</em> 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
beginning time of the dives to be significantly different) <em>Subsurface</em>
will not create duplicate entries.</p></div>
<div class="sect3">
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
<h4 id="_using_the_universal_import_dialogue">3.3.1. Using the universal import dialogue</h4>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph" id="Unified_import"><p>Importing dives from other software is performed through a universal interface
that is activated by selecting <em>Import</em> from the Main Menu, then clicking on
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
<em>Import Log Files</em>. This brings up the dialogue <strong>A</strong> below.</p></div>
<div class="imageblock" style="text-align:center;">
<div class="content">
<img src="images/Import1.jpg" alt="FIGURE: Import dialogue: step 1" />
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</div>
</div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>Towards the bottom right is a dropdown selector with a default label
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
of <em>Dive Log Files</em> which gives access to the different types of direct imports
available, as in dialogue <strong>B</strong>, above. Currently these are:</p></div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="ulist"><ul>
<li>
<p>
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
XML-formatted dive logs
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</p>
</li>
<li>
<p>
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
UDDF-formatted dive logs
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</p>
</li>
<li>
<p>
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
UDCF-formatted dive logs
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</p>
</li>
<li>
<p>
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
JDiveLog
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</p>
</li>
<li>
<p>
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
Suunto Dive Manager (DM3 and DM4)
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</p>
</li>
<li>
<p>
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
MacDive (XML)
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</p>
</li>
<li>
<p>
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
DivingLog 5.0 (XML)
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</p>
</li>
<li>
<p>
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
Kenozooid (UDDF)
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</p>
</li>
<li>
<p>
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
CSV (text-based and spreadsheet-based) dive logs.
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</p>
</li>
</ul></div>
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
<div class="paragraph"><p>Selecting the appropriate file in the file list of the dialogue opens
the imported dive log in the <em>Subsurface</em> <strong>Dive List</strong>. A few other formats, not
accessible through the Import dialogue are also supported, as explained below.</p></div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</div>
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
<div class="sect3">
<h4 id="_importing_from_mares_dive_organiser_v2_1">3.3.2. Importing from Mares Dive Organiser V2.1</h4>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>Since Mares utilise proprietory Microsoft software not compatible with
multi-platform software, these dive logs cannot be directly imported into
<em>Subsurface</em>. Mares dive logs need to be imported using a three-step process,
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
using <em>www.divelogs.de</em> as a mechanism to extract the dive information from
the file.</p></div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="ulist"><ul>
<li>
<p>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
The dive log data from Mares Dive Organiser need to be exported to the users
desktop, using
a <em>.sdf</em> file name extension. Users should refer to <a href="#Mares_Export">Appendix
C</a> for more information.
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</p>
</li>
<li>
<p>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
Data should then be imported into <em>www.divelogs.de</em>. One needs to create a user
account in
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
<em>www.divelogs.de</em>, log into that web site, then
select <em>Import Logbook &#8594; Dive Organiser</em> from the menu on the left hand side.
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
The instructions must be carefully followed to transfer the dive information
(in <em>.sdf</em> format) from the Dive Organiser data base to <em>www.divelogs.de</em>.
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</p>
</li>
<li>
<p>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
Finally, the instructions below should be followed in order to import dives
from <em>divelogs.de</em> to <em>Subsurface</em>.
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</p>
</li>
</ul></div>
</div>
<div class="sect3">
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
<h4 id="S_ImportingDivelogsDe">3.3.3. Importing dives from <strong>divelogs.de</strong></h4>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="paragraph"><p>The import of dive information from <em>divelogs.de</em> is simple, using a single
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
dialogue box. The <em>Import&#8594;Import form Divelogs.de</em> option should be selected
from the Main Menu. This
brings up a dialogue box (see figure on left [<strong>A</strong>] below). one then needs to enter a
user-ID and password for <em>divelogs.de</em> into the appropriate fields and then
select
the <em>Download</em> button. Download from <em>divelogs.de</em> starts immediately,
displaying a progress bar in the dialogue box. At the and of the download, the
succes status is indicated (see figure on the right [<strong>B</strong>], below). The
<em>Apply</em> button should then be selected. The imported dives appear in the
<em>Subsurface</em> <strong>Dive List</strong> panel.</p></div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="imageblock" style="text-align:center;">
<div class="content">
<img src="images/Divelogs1.jpg" alt="FIGURE:Download from Divelogs.de" />
</div>
</div>
</div>
<div class="sect3">
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
<h4 id="S_ImportingCSV">3.3.4. Importing dives in CSV format</h4>
Prepare for 4.0.1 release Small updates to README, ReleaseNotes, user manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-03 11:18:59 +00:00
<div class="paragraph"><p>Sometimes dive computers export dive information as files with
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
<em>comma-separated values</em> (.CSV). For example, the APD Inspiration and Evolution
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
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 <em>Subsurface</em>.
CSV files are normally organised into
a single line that provides the headers of the data columns, followed by the
data, one record per line. CSV files can be opened with a normal text editor.
Following is a highly simplified and shortened example of a CSV file from an
APD rebreather:</p></div>
Prepare for 4.0.1 release Small updates to README, ReleaseNotes, user manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-03 11:18:59 +00:00
<div class="literalblock">
<div class="content">
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<pre><code> 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</code></pre>
Prepare for 4.0.1 release Small updates to README, ReleaseNotes, user manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-03 11:18:59 +00:00
</div></div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>Note that each title may comprise more than one word; for instance
<em>Dive Time (s)</em> in the above data example. Before being able to import the data
to <em>Subsurface</em> one first needs to know:</p></div>
Prepare for 4.0.1 release Small updates to README, ReleaseNotes, user manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-03 11:18:59 +00:00
<div class="olist loweralpha"><ol class="loweralpha">
<li>
<p>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
Which character separates the different columns within a single line of
data? This field separator should be either a comma (,) or a TAB character.
This can be determined by opening the file with a text editor. If it is
comma-delimited, then the comma
characters between the values are clearly visible. If no commas are evident and
the numbers are aligned,
the file is probably TAB-delimited (i.e. it uses a TAB as a field separator, as
in the above example).
Prepare for 4.0.1 release Small updates to README, ReleaseNotes, user manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-03 11:18:59 +00:00
</p>
</li>
<li>
<p>
Which data columns need to be imported into <em>Subsurface</em>?. The Dive Time and
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
Depth columns 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:
Prepare for 4.0.1 release Small updates to README, ReleaseNotes, user manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-03 11:18:59 +00:00
</p>
<div class="literalblock">
<div class="content">
<pre><code>Time: column 1
Depth: column 2
Temperature: column 5
ppO2: column 4</code></pre>
</div></div>
</li>
</ol></div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>Armed with this information, importing it into <em>Subsurface</em> is a
straightforward process. User should select
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
<em>Import&#8594;Import Log Files</em> from the main menu. In the appearing file
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
selection menu, users need to select one or more CSV files. Its format is
detected by the file
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
extension, and a common configuration dialog is presented for all the
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
files with a CSV extension. The configuration dialog is like the following:</p></div>
Prepare for 4.0.1 release Small updates to README, ReleaseNotes, user manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-03 11:18:59 +00:00
<div class="imageblock" style="text-align:center;">
<div class="content">
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
<img src="images/Import_CSV1.jpg" alt="FIGURE: CSV download dialogue" />
Prepare for 4.0.1 release Small updates to README, ReleaseNotes, user manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-03 11:18:59 +00:00
</div>
</div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>Then the user must specify the name of the CSV file or select it from the
browser button on the right.
Prepare for 4.0.1 release Small updates to README, ReleaseNotes, user manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-03 11:18:59 +00:00
There are pre-configured definitions for some dive computers, e.g. the APD
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
rebreathers. If the user&#8217;s dive computer is on this list, it should be selected
using the dropdown
box labeled <em>Pre-configured imports</em>. Finally the <em>OK</em> should be clicked and
the dive will be imported and listed in the <strong>Dive List</strong> tab of <em>Subsurface</em>.</p></div>
<div class="paragraph"><p>If the dive computer is not on the pre-configured list, the user must
select the <em>Field
Separator</em> (TAB or comma) for the particular CSV file, using the appropriate
dropdown list. and indicate which columns in the CSV file
contain which data
variables. For each data column used for import, the user must check the
appropriate check box
Prepare for 4.0.1 release Small updates to README, ReleaseNotes, user manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-03 11:18:59 +00:00
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
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
the image. Having performed the column specification, select the <em>OK</em> button
and the dive will be imported and listed in the <strong>Dive List</strong> tab of <em>Subsurface</em>.</p></div>
Prepare for 4.0.1 release Small updates to README, ReleaseNotes, user manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-03 11:18:59 +00:00
</div>
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
<div class="sect3">
<h4 id="S_ImportingManualCSV">3.3.5. Importing dives from manually kept CSV file</h4>
<div class="paragraph"><p>If one keeps dive logs in a spreadsheet, there is an option to import
those dives as well. Spreadsheet data, exported as a CSV file, can
be imported to <em>Subsurface</em>. When importing manually
kept log files, the information needed is quite different as we are
importing only metadata, not profile samples.</p></div>
<div class="paragraph"><p>Similarly to importing dives in CSV format (see above), one needs to
know the internal format
of the CSV data to import.</p></div>
<div class="olist loweralpha"><ol class="loweralpha">
<li>
<p>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
Which character separates the different columns within a single line of
data? This
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
should be either a comma (,), semicolon (;) or a TAB
character, and could be determined by opening the file with a text
editor. If it is comma-delimited, then the comma
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
characters between the values are clearly visible. If no commas are evident and
the data
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
are in clear columns, the file
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
is probably TAB-delimited (i.e. it uses a TAB as a field separator, as in the
above example).
A recommended field separator for the export is tab, as commas might be used in
the
field values themselves.
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
</p>
</li>
<li>
<p>
Which columns need to be imported into <em>Subsurface</em>?. We do not
currently have any mandatory input fields, but some, e.g. dive duration
are crucial for the log file to make any sense. Possible options
can be seen in the image below and one should include all the
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
fields available in both your log file and in the Subsurface
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
import.
</p>
</li>
<li>
<p>
Units used for depth, weight and temperature. We consider depth to be
either feet or meters, weight kilograms or pounds and temperature either
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
Celsius or Fahrenheit. However, the users can only select <em>Metric</em> or
<em>Imperial</em> in the Preferences tab of <em>Subsurface</em>.. No mixture of unit s
ystems is allowed for the different fields.
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
</p>
</li>
</ol></div>
<div class="paragraph"><p>Importing manually kept CSV log files is quite straight forward, but
there might be many fields and counting the field numbers is error
prone. Therefore validation of the data to be imported is critical.</p></div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>To import the dives, one must select <em>Import&#8594;Import Log Files</em> from the menu
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
bar. If the CSV option in the dropdown list is selected and the file list
includes file names ending with .CSV, one can select the
<em>Manual dives</em> tab that will bring up the following configuration dialog:</p></div>
<div class="imageblock" style="text-align:center;">
<div class="content">
<img src="images/Import_CSV2.jpg" alt="FIGURE: Download dialog for Manual CSV logs" />
</div>
</div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>The input fields can be configured as appropriate, and when everything is done
the <em>OK</em> button should be selected to perform the import. New dives should
appear in the <strong>Dive List</strong> area of <em>Subsurface</em>.</p></div>
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
</div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</div>
<div class="sect2">
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<h3 id="S_Companion">3.4. Importing GPS coordinates with the Subsurface Companion app for mobile</h3>
<div class="paragraph"><p>phones
If the user has an Android device with GPS, the coordinates for the diving
location can be obtained and automatically passed to Subsurface
divelog. To do this, one needs to:</p></div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="ulist"><ul>
<li>
<p>
Register on the <a href="http://api.hohndel.org/login/">Subsurface companion web page</a>.
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
A confirmation mail with instructions and a personal <strong>DIVERID</strong> will be send together with
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
a long number that gives access to the companion app capabilities.
</p>
</li>
<li>
<p>
Download the app from
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<a href="https://play.google.com/store/apps/details?id=org.subsurface">Google Play Store</a>
or
from
<a href="http://f-droid.org/repository/browse/?fdfilter=subsurface&amp;fdid=org.subsurface">F-Droid</a>.
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</p>
</li>
</ul></div>
<div class="sect3">
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<h4 id="_using_the_subsurface_companion_app_on_a_smartphone">3.4.1. Using the Subsurface companion app on a smartphone</h4>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="paragraph"><p>On first use the app has three options:</p></div>
<div class="ulist"><ul>
<li>
<p>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<em>Create a new account.</em> Equivalent to registering in <em>Subsurface</em> companion
page.
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</p>
</li>
<li>
<p>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<em>Retrieve an account.</em> If users forgot their DIVERID they will receive an email
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
to recover the number.
</p>
</li>
<li>
<p>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<em>Use an existing account.</em> Users are prompted for their DIVERID. The app saves
this DIVERID and does not ask for it again unless one uses the <em>Disconnect</em> menu
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
option (see below).
</p>
</li>
</ul></div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>Now one is ready to get a dive position and send it to the server. The Android
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
display will look like the left hand image (A) below, but without any dive.</p></div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>Touching the "+" icon on the top right to add a new dive site. Users will be
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
prompted for a place name (or asked to activate the GPS if it was turned off).
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
The main screen shows a list of dive locations, each with a name, date and
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
time. Some dives may have an arrow-up icon on the selection box to the left (see
image B in the middle, below) indicating that they require upload to the server.</p></div>
<div class="paragraph"><p>There are several ways to send dives to the server; the easiest is by simply
selecting the dive. See middle image below (B):</p></div>
<div class="imageblock" style="text-align:center;">
<div class="content">
<img src="images/Companion.jpg" alt="FIGURE: Screen shots (A-C) of companion app" />
</div>
</div>
<div class="paragraph"><p>Touching the right arrow will send it to the server.</p></div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<img src="images/icons/important.png" alt="Important" />
</td>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<td class="content">Users must be careful, as the trash icon on the right means exactly what it is supposed to mean,
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
it deletes the dive location(s).</td>
</tr></table>
</div>
<div class="paragraph"><p>The new dive points are now stored on the server and can be downloaded to the
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<em>Subsurface</em> dive log whenever users upload or add dives to <em>Subsurface</em>.
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
After a dive trip using the Companion app, all dive locations are ready to be
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
saved on a Subsurface dive log (see below).</p></div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="sect4">
<h5 id="_settings_on_the_companion_app">Settings on the Companion app</h5>
<div class="paragraph"><p>Selecting the <em>Settings</em> menu option results in the right hand image above &#169;.</p></div>
</div>
<div class="sect4">
<h5 id="_server_and_account">Server and account</h5>
<div class="ulist"><ul>
<li>
<p>
<em>Web-service URL.</em> This is predefined (<a href="http://api.hohndel.org/">http://api.hohndel.org/</a>)
</p>
</li>
<li>
<p>
<em>User ID.</em> Obtained by registering as indicated above. The easiest way to
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
obtain it is simply to copy and paste from the confirmation mail but, of
course, users can also type this information.
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</p>
</li>
</ul></div>
</div>
<div class="sect4">
<h5 id="_synchronization">Synchronization</h5>
<div class="ulist"><ul>
<li>
<p>
<em>Synchronize on startup.</em> If selected, dives in the Android device and those
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
on the web service will synchronize each time the app is started.
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</p>
</li>
<li>
<p>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<em>Upload new dives.</em> If selected, each time the user adds a dive location it will
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
automatically be sent to the server.
</p>
</li>
</ul></div>
</div>
<div class="sect4">
<h5 id="_background_service">Background service</h5>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>Instead of entering a unique dive location, users can leave the service running
in the background of their device, thus allowing the continuous collection of GPS locations.</p></div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="paragraph"><p>The settings below define the behaviour of the service:</p></div>
<div class="ulist"><ul>
<li>
<p>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<em>Min duration.</em> In minutes. The app will try to get a position each X minutes
until it&#8217;s stopped by the user.
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</p>
</li>
<li>
<p>
<em>Min distance.</em> In meters. Minimum distance between two position fixes.
</p>
</li>
<li>
<p>
<em>Name template.</em> The name the app will use when saving the position fixes.
</p>
</li>
</ul></div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<img src="images/icons/info.jpg" alt="Tip" />
</td>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<td class="content"><em>How does the background service work?</em> Assuming that the user set 5 minutes and 50
meters in the settings above, the app will start by taking a fix at the current location,
followed by another one
at every 5 minutes. If this 2nd (3rd, 4th &#8230;) location is within a radius of 50
meters from the previous one, then this new fix is not saved. If the user is not moving,
only one fix is saved, but if the user is moving, then a trace of the journey is obtained,
by saving each new position at every 5 minutes.</td>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</tr></table>
</div>
</div>
<div class="sect4">
<h5 id="_other">Other</h5>
<div class="ulist"><ul>
<li>
<p>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<em>Mailing List.</em> The mail box for <em>Subsurface</em>. Users can send an email to the
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
Subsurface mailing list.
</p>
</li>
<li>
<p>
<em>Subsurface website.</em> A link to the URL of Subsurface web
</p>
</li>
<li>
<p>
<em>Version.</em> Displays the current version of the companion app.
</p>
</li>
</ul></div>
</div>
<div class="sect4">
<h5 id="_search">Search</h5>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>Here one can search one&#8217;s saved dive locations by the name or by date and hour.</p></div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</div>
<div class="sect4">
<h5 id="_start_service">Start service</h5>
<div class="paragraph"><p>Initiates the <em>background service</em> depending on the previously defined settings.</p></div>
</div>
<div class="sect4">
<h5 id="_disconnect">Disconnect</h5>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>This is a badly named option. It disconnects the app from the server by
resetting the user ID in the app, showing the first screen where an account
can be created, retrieve the ID for an existing account or use the users own
ID. The disconnect option
is useful if a user&#8217;s Android device was used to download the dive positions
of another registered diver.</p></div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</div>
<div class="sect4">
<h5 id="_send_all_locations">Send all locations</h5>
<div class="paragraph"><p>This option sends all locations stored in the Android device to the server.</p></div>
</div>
</div>
<div class="sect3">
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<h4 id="_downloading_dive_locations_to_a_subsurface_divelog">3.4.2. Downloading dive locations to a Subsurface divelog</h4>
<div class="paragraph"><p>Download dive(s) from a dive computer or enter them manually into
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<em>Subsurface</em> before obtaining the GPS coordinates from the server. The download
dialog can be reached via <em>Ctrl+G</em> or from the <em>Subsurface</em> Main Menu <em>Import
&#8594; Import GPS data from Subsurface Service</em>, resulting in the image on the
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
left (<strong>A</strong>), below. On first use the DIVERID text box will be blank. Users must provide their
DIVERID and then select the <em>Download</em> button to initiate the download process. When this
is completed, users will see the screen on the right (<strong>B</strong>), below:</p></div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="imageblock" style="text-align:center;">
<div class="content">
<img src="images/DownloadGPS.jpg" alt="FIGURE: Downloading Companion app GPS data" />
</div>
</div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>Note that the <em>Apply</em> button is now active. By clicking on it, users can update the locations
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
of the newly entered or uploaded dives in <em>Subsurface</em> which applies the
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
coordinates and names entered on the app for all the new dives that match the
date-times of the uploaded GPS localities.</p></div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="admonitionblock">
<table><tr>
<td class="icon">
<img src="images/icons/info.jpg" alt="Note" />
</td>
<td class="content">Features, issues and tips._ Since <em>Subsurface</em> matches GPS locations from the
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
Android device and dive information from the dive computer based on date-time
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
data, automatic assignment of GPS data to dives is dependent on agreement of
date and time between these two devices. If there is a large difference between
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
the time in the dive computer and the time in the Android device,
<em>Subsurface</em> is unable to identify the dive matching a location and nothing
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
happens. Similar date-times may be not always be possible. A dirty hack is
manually editing the date-time of a dive in Subsurface&#8217;s Dive List <em>before</em>
downloading the GPS data and then to edit the date-time back again <em>after</em>
downloading GPS data.</td>
</tr></table>
</div>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_obtaining_more_information_about_dives_entered_into_the_logbook">4. Obtaining more information about dives entered into the logbook</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_the_strong_dive_info_strong_tab_for_individual_dives">4.1. The <strong>Dive Info</strong> tab (for individual dives)</h3>
<div class="paragraph"><p>The Dive Info tab gives some summary information about a particular dive that
has been selected in the <strong>Dive List</strong>. Useful information here includes the
surface interval before the dive, the maximum and mean depths of the dive, the
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
gas volume consumed, the surface air consumption (SAC) and the number of oxygen
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
toxicity units (OTU) incurred.</p></div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="admonitionblock">
<table><tr>
<td class="icon">
<img src="images/icons/info.jpg" alt="Note" />
</td>
<td class="content">Gas consumption and SAC calculations:
<em>Subsurface</em> calculates SAC and Gas consumption taking in account gas
incompressibility, particularly at tank pressures above 200 bar, making them more accurate.
Users should refer to <a href="#SAC_CALCULATION">Appendix D</a> for more information.</td>
</tr></table>
</div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</div>
<div class="sect2">
<h3 id="_the_strong_stats_strong_tab_for_groups_of_dives">4.2. The <strong>Stats</strong> tab (for groups of dives)</h3>
<div class="paragraph"><p>The Stats tab gives summary statistics for more than one dive, assuming that
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
more than one dive have been selected in the <strong>Dive List</strong> using the standard
Ctrl-click or Shift-click of the mouse. If only one
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
dive has been selected, figures pertaining to only that dive are given. This tab
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
shows the number of dives selected, the total amount of dive time in these
dives,
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
as well as the minimum, maximum and mean for the dive duration, dive depth,
water temperature and surface air consumption (SAC).</p></div>
</div>
<div class="sect2">
<h3 id="S_DiveProfile">4.3. The <strong>Dive Profile</strong></h3>
<div class="imageblock" style="text-align:center;">
<div class="content">
<img src="images/Profile2.png" alt="Typical dive profile" />
</div>
</div>
<div class="paragraph"><p>Of all the panels in <em>Subsurface</em>, the Dive Profile contains the most detailed
information about each dive. The main item in the Dive profile is the graph of
dive depth as a function of time. In addition to the obvious information of
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
the depth it also shows the ascent and descent rates compared to the recommended
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
speed of going up or down in the water column. This information is given using
different colours:</p></div>
<div class="tableblock">
<table rules="all"
width="100%"
frame="border"
cellspacing="0" cellpadding="4">
<col width="33%" />
<col width="33%" />
<col width="33%" />
<tbody>
<tr>
<td align="left" valign="top"><p class="table"><strong>Colour</strong></p></td>
<td align="left" valign="top"><p class="table"><strong>Descent speed (m/min)</strong></p></td>
<td align="left" valign="top"><p class="table"><strong>Ascent speed (m/min)</strong></p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">Red</p></td>
<td align="left" valign="top"><p class="table">&gt; 30</p></td>
<td align="left" valign="top"><p class="table">&gt; 18</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">Orange</p></td>
<td align="left" valign="top"><p class="table">18 - 30</p></td>
<td align="left" valign="top"><p class="table">9 - 18</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">Yellow</p></td>
<td align="left" valign="top"><p class="table">9 - 18</p></td>
<td align="left" valign="top"><p class="table">4 - 9</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">Light green</p></td>
<td align="left" valign="top"><p class="table">1.5 - 9</p></td>
<td align="left" valign="top"><p class="table">1.5 - 4</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">Dark green</p></td>
<td align="left" valign="top"><p class="table">&lt; 1.5</p></td>
<td align="left" valign="top"><p class="table">&lt; 1.5</p></td>
</tr>
</tbody>
</table>
</div>
<div class="paragraph"><p>The profile also includes depth readings for the peaks and troughs in the graph.
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
Thus, users should see the depth of the deepest point and other peaks. Mean depth
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
is marked with a horizontal red line.</p></div>
<div class="paragraph"><p>The <strong>air consumption</strong> graph displays the tank pressure and its change during the
dive. The air consumption takes depth into account so that even when manually
entering the start and end pressures the graph is not a straight line.
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
Similarly to the depth graph the slope of the tank pressure gives the user information
about the
momentary SAC rate (Surface Air Consumption) when using an air integrated dive computer.
Here the colour
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
coding is not relative to some absolute values but relative to the average
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
normalised air consumption during the dive. So areas that are red or orange
indicate
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
times of increased normalized air consumption while dark green reflects times
when the diver was using less gas than average. The colour coding is obviously
only possible when a tank sensor is connected and tank pressure readings during
the dive are available.</p></div>
<div class="paragraph"><p><strong>Water temperature</strong> is displayed with its own blue line with temperature values
placed adjacent to significant changes.</p></div>
<div class="paragraph"><p>It is possible to <strong>zoom</strong> into the profile graph. This is done either by using
the scroll wheel / scroll gesture of your mouse or trackpad. By default
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<em>Subsurface</em> always shows a profile area large enough for at least 30 minutes
and 30m
(100ft) – this way short or shallow dives are intuitively recognizable;
something
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
that free divers clearly won’t care about.</p></div>
<div class="imageblock" style="text-align:center;">
<div class="content">
<img src="images/MeasuringBar.png" alt="FIGURE: Measuring Bar" />
</div>
</div>
<div class="paragraph"><p>Measurements of <strong>depth differences</strong> can be achieved by using the button with
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
two vertical bars at the right of the dive profile panel (users should refer to
the above figure,
bottom right). The measurement is done by dragging the red dots to the two points
on the dive profile that the user wishes to measure. Information is then given
along the line connecting the
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
two red dots.</p></div>
<div class="paragraph"><p>The dive profile can include further information that is typically more
interesting for tec divers. Enabling these is described in the section entitled
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<em>Setting up Preferences</em>. Basically, users can include graphs of the <strong>partial
pressures</strong>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
of O2, N2, and He during the dive as well as a calculated and dive computer
reported deco ceilings (only visible for deep, long, or repetitive dives). The
partial pressure graphs are added below the profile data, the calculated ceiling
is shown as a green overlay on top of the dive profile. Above the profile the
currently used gradient factors are shown (e.g. GF 35/75). Please note that
these are NOT the gradient factors in use by the dive computer in question,
but the gradient factors used by <em>Subsurface</em> to calculate deco obligations
during the dive.</p></div>
<div class="paragraph"><p>The graph can also include the dive computer reported <strong>ceiling</strong> (or more
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
precisely, the first deco stop that the dive computer recorded – users are reminded that not
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
all dive computers record this information and make it available for download;
for example all of the Suunto dive computers fail to make this very useful data
available to divelog software). Because of the differences in used algorithms
and amount of data available (and factors taken into consideration) at the time
of the calculation it is unlikely that both of these are the same; this can be
true even if the same algorithm and <em>gradient factors</em> (see below) are used.
It is also quite common that <em>Subsurface</em> calculates a ceiling for
non-decompression dives when the dive computer stayed in non-deco mode during
the whole dive (represented by the <span class="green">dark green</span> section in the profile
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
at the beginning of this section). This is caused by the fact that
<em>Subsurface’s</em>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
calculations describe the deco obligation at that point in time during a dive,
while dive computers usually take the upcoming ascent into account. During the
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
ascent some excess Nitrogen (and possibly Helium) are already breathed off so
even
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
though the diver technically encountered a ceiling at depth, the dive still does
not require an explicit deco stop. This feature allows dive computers to offer
longer non-stop bottom time.</p></div>
<div class="paragraph"><p>For a more detailed explanation of <em>gradient factors</em>, use the following links:</p></div>
<div class="ulist"><ul>
<li>
<p>
<a href="http://www.tek-dive.com/portal/upload/M-Values.pdf">Understanding M-values, by Erik Baker, 1988, <em>Immersed</em> Vol. 3, No. 3.</a>
</p>
</li>
<li>
<p>
<a href="http://www.rebreatherworld.com/general-and-new-to-rebreather-articles/5037-gradient-factors-for-dummies.html">Gradient factors for dummies, by Kevin Watts</a>
</p>
</li>
</ul></div>
</div>
<div class="sect2">
<h3 id="_the_dive_profile_context_menu">4.4. The Dive Profile context menu</h3>
<div class="paragraph"><p>The context menu for the Dive Profile is accessed by right-clicking while the
mouse cursor is over the Dive Profile panel. The menu allows the creation of
Bookmarks or Gas Change Event markers other than the ones that might have been
imported from a Dive Computer. Markers are placed against the depth profile line
and with the time of the event set by where the mouse cursor was when the right
mouse button was initially clicked to bring up the menu. Gas Change events
open a further selection of which gas is being switched to, the list based on
the available gases defined in the Equipment Tab. By right-clicking while over
an existing marker, the menu extends adding options to allow deletion of the
marker or to allow all markers of that type to be hidden. Hidden events can be
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
restored to view by selecting Unhide all events from the context menu.</p></div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</div>
<div class="sect2">
<h3 id="_the_strong_information_box_strong">4.5. The <strong>Information Box</strong></h3>
<div class="paragraph"><p>The Information box displays a large range of information pertaining to the dive
profile. Normally the Information Box is located to the top left of the <strong>Dive
Profile</strong> panel. If the mouse points outside of the <strong>Dive Profile</strong> panel, then
only the top line of the Information Box is visible (see left-hand part of
figure (A) below). The Information Box can be moved around in the <strong>Dive Profile</strong>
panel by click-dragging it with the mouse so that it is not obstructing
important detail. The position of the Information Box is saved and used again
during subsequent dive analyses.</p></div>
<div class="imageblock" style="text-align:center;">
<div class="content">
<img src="images/InfoBox2.jpg" alt="Figure: Information Box" />
</div>
</div>
<div class="paragraph"><p>The moment the mouse points inside the <strong>Dive Profile</strong> panel, it expands and
shows many data items. In this situation, the data reflect the time point along
the dive profile indicated by the mouse (see right-hand part of figure (B) above
where the Information Box reflects the situation at the position of the cursor
[arrow] in that image). Therefore, moving the cursor in the horizontal
direction allows the Information Box to show information for any point along the
dive profile.
In this mode, the Information Box gives extensive statistics about depth, gas
and ceiling characteristics of the particular dive. These include: Time period
into the dive (indicated by a @), depth, cylinder pressure (P), temperature,
ascent/descent rate, surface air consumption (SAC), oxygen partial pressure,
maximum operating depth, effective air depth (EAD), effective narcotic depth
(END), equivalent air density depth (EADD), decompression requirements at that
instant in time (Deco), time to surface (TTS), the calculated ceiling, as well
as the calculated ceiling for several Bühlmann tissue compartments.</p></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_organising_the_logbook_manipulating_groups_of_dives">5. Organising the logbook (Manipulating groups of dives)</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_the_dive_list_context_menu">5.1. The Dive List context menu</h3>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>Many actions within <em>Subsurface</em> are dependent on a context menu used
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
mostly to manipulate groups of dives. The context menu is found by selecting
a dive or a group of dives and then right-clicking.</p></div>
<div class="imageblock" style="text-align:center;">
<div class="content">
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
<img src="images/ContextMenu.jpg" alt="Figure: Context Menu" />
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</div>
</div>
<div class="paragraph"><p>The context menu is used in many manipulations described below.</p></div>
</div>
<div class="sect2">
<h3 id="S_Renumber">5.2. Renumbering the dives</h3>
<div class="paragraph"><p>Dives are normally numbered incrementally from non-recent dives (low sequence
numbers) to recent dives (having the highest sequence numbers). The numbering
of the dives is not always consistent. For instance, when non-recent dives are
added to the dive list the numbering does not automatically follow on because
of the dives that are more recent in date/time than the newly-added dive that
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
has an older date/time. Therefore, one may sometimes need to renumber the dives.
This is performed by selecting (from the Main Menu) <em>Log &#8594; Renumber</em>. Users are
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
given a choice with respect to the lowest sequence number to be used.
Completing this operation results in new sequence numbers (based on date/time)
for the dives in the <strong>Dive List</strong> panel.</p></div>
</div>
<div class="sect2">
<h3 id="S_Group">5.3. Grouping dives into trips and manipulating trips</h3>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>For regular divers, the dive list can rapidly become very long. <em>Subsurface</em>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
can group dives into <em>trips</em>. It performs this by grouping dives that have
date/times that are not separated in time by more than two days, thus creating
a single heading for each diving trip represented in the dive log. Below is an
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
ungrouped dive list (<strong>A</strong>, on the left) as well as the corresponding grouped dive
list comprising five dive trips (<strong>B</strong>, on the right):</p></div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="imageblock" style="text-align:center;">
<div class="content">
<img src="images/Group2.jpg" alt="Figure: Grouping dives" />
</div>
</div>
<div class="paragraph"><p>Grouping into trips allows a rapid way of accessing individual dives without
having to scan long lists of dives. In order to group the dives in a dive list,
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
(from the Main Menu) users must select <em>Log &#8594; Autogroup</em>. The <strong>Dive List</strong> panel now shows
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
only the titles for the trips.</p></div>
<div class="sect3">
<h4 id="_viewing_the_dives_during_a_particular_trip">5.3.1. Viewing the dives during a particular trip</h4>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>Once when the dives have been grouped into trips, users can expand one or more
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
trips by clicking the arrow-head on the left of each trip title. This expands
the selected trip, revealing the individual dives performed during the trip.</p></div>
</div>
<div class="sect3">
<h4 id="_editing_the_title_and_associated_information_for_a_particular_trip">5.3.2. Editing the title and associated information for a particular trip</h4>
<div class="paragraph"><p>Normally, in the dive list, minimal information is included in the trip title.
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
More information about a trip can be added by selecting its trip title from
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
the dive list. This shows a <strong>Trip Notes</strong> tab in the <strong>Dive Notes</strong> panel. Here
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
users can add or edit information about the date/time, the trip location and any
other general comments about the trip as a whole (e.g. the dive company that was
dived with, the general weather during the trip, etc.). After entering this
information, users should select <strong>Save</strong> from the buttons at the top right of the <strong>Trip Notes</strong>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
tab. The trip title in the <strong>Dive List</strong> panel should now reflect some of the
edited information.</p></div>
</div>
<div class="sect3">
<h4 id="_collapsing_or_expanding_dive_information_for_different_trips">5.3.3. Collapsing or expanding dive information for different trips</h4>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>If a user right-clicks after selecting a particular trip in the dive list, the
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
resulting context menu allows several possibilities to expand or collapse dives
within trips. This includes expanding all trips, collapsing all trips and
collapsing all trips except the selected one.</p></div>
</div>
<div class="sect3">
<h4 id="_merging_dives_from_more_than_one_trip_into_a_single_trip">5.3.4. Merging dives from more than one trip into a single trip</h4>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>By right-clicking on a selected trip title in the <strong>Dive List</strong> panel, a
context menu shows up that allows the merging of trips by either merging of the selected trip
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
with the trip below or with the trip above.</p></div>
</div>
<div class="sect3">
<h4 id="_splitting_a_single_trip_into_more_than_one_trip">5.3.5. Splitting a single trip into more than one trip</h4>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>If a trip includes five dives, the user can split this trip into two trips (trip 1:
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
top 3 dives; trip 2: bottom 2 dives) by selecting and right-clicking the top
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
three dives. The resulting context menu allows the user to create a new trip by
choosing the option <strong>Create new trip above</strong>. The top three dives are then
grouped
into a separate trip. The figures bellow show the selection and context menu on the left (A) and
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
the completed action on the right (B):</p></div>
<div class="imageblock" style="text-align:center;">
<div class="content">
<img src="images/SplitDive3a.jpg" alt="FIGURE: Split a trip into 2 trips" />
</div>
</div>
</div>
</div>
<div class="sect2">
Prepare for 4.0.1 release Small updates to README, ReleaseNotes, user manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-03 11:18:59 +00:00
<h3 id="_manipulating_single_dives">5.4. Manipulating single dives</h3>
<div class="sect3">
<h4 id="_delete_a_dive_from_the_dive_log">5.4.1. Delete a dive from the dive log</h4>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="paragraph"><p>Dives can be permanently deleted from the dive log by selecting and
right-clicking them to bring up the context menu, and then selecting <strong>Delete
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
dive(s)</strong>. Typically this would apply to a case where a user wishes to delete
workshop
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
calibration dives of the dive computer or dives of extremely short duration.</p></div>
</div>
Prepare for 4.0.1 release Small updates to README, ReleaseNotes, user manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-03 11:18:59 +00:00
<div class="sect3">
<h4 id="_unlink_a_dive_from_a_trip">5.4.2. Unlink a dive from a trip</h4>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>Users can unlink dives from the trip to which they belong. In order to do this,
users should select and right-click
the relevant dives to bring up the context menu. Then the option <strong>Remove dive(s)
from trip</strong> should be selected.
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
The dives that have been unlinked now appear immediately above the trip to
which they belonged.</p></div>
</div>
Prepare for 4.0.1 release Small updates to README, ReleaseNotes, user manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-03 11:18:59 +00:00
<div class="sect3">
<h4 id="_add_a_dive_to_the_trip_immediately_above">5.4.3. Add a dive to the trip immediately above</h4>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="paragraph"><p>Selected dives can be moved from the trip to which they belong and placed within
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
the trip immediately above the currently active trip. To do this, users must select
and right-click
the dives to bring up the context menu, and then select <strong>Add dive(s) to trip
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
immediately above</strong>.</p></div>
</div>
Prepare for 4.0.1 release Small updates to README, ReleaseNotes, user manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-03 11:18:59 +00:00
<div class="sect3">
<h4 id="_shift_the_start_time_of_dive_s">5.4.4. Shift the start time of dive(s)</h4>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="paragraph"><p>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
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
computer has an erroneous time. In order to do this, user must select and right-click
the dive(s) to be
adjusted. This action brings up the context menu on which the <strong>Shift times</strong>
option should be selected. User must then specify the
time
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
(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.</p></div>
</div>
Prepare for 4.0.1 release Small updates to README, ReleaseNotes, user manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-03 11:18:59 +00:00
<div class="sect3">
<h4 id="_merge_dives_into_a_single_dive">5.4.5. Merge dives into a single dive</h4>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="paragraph"><p>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
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
computer and appearing as different dives in the <strong>Dive List</strong> panel. Users can
merge these dives onto a single dive by selecting the appropriate dives,
right-clicking them to bring up the context menu and then selecting <strong>Merge selected
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
dives</strong>. It may be necessary to edit the dive information in the <strong>Dive Notes</strong>
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
panel to reflect events or conditions that apply to the merged dive. The figure
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
below shows the depth profile two such dives that were merged:</p></div>
<div class="imageblock" style="text-align:center;">
<div class="content">
<img src="images/MergedDive.png" alt="Example: Merged dive" />
</div>
</div>
</div>
</div>
</div>
Prepare for 4.0.1 release Small updates to README, ReleaseNotes, user manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-03 11:18:59 +00:00
</div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="sect1">
Prepare for 4.0.1 release Small updates to README, ReleaseNotes, user manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-03 11:18:59 +00:00
<h2 id="S_ExportLog">6. Exporting the dive log or parts of the dive log</h2>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="sectionbody">
<div class="paragraph"><p>A dive log can be saved in two formats:</p></div>
<div class="ulist"><ul>
<li>
<p>
<em>Subsurface</em> XML format. This is the native format used by <em>Subsurface</em>.
</p>
</li>
<li>
<p>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
Universal Dive Data format (UDDF). User should refer to <a href="http://uddf.org">http://uddf.org</a> for more information.
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
UDDF is a generic format that enables communication among many dive computers
and computer programs.
</p>
</li>
</ul></div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>In order to save the WHOLE dive log (i.e. all trips and dives), <strong>File</strong> should be selected
from the Main menu. To save in <em>Subsurface</em> XML format, users should select <em>File &#8594; Save
as</em>. To save in UDDF format, the <em>File &#8594; Export UDDF</em> option should be selected.</p></div>
<div class="paragraph"><p>In order to save only one or more dives or one or two trips, users can select the
appropriate dives or trips in the <strong>Dive List</strong> panel and then right-click the
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
selected dives to bring up the context menu. To save in <em>Subsurface</em> XML
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
format, users should select <em>Save as</em> from the context menu. To save in UDDF format, users should select
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<em>Export as UDDF</em> from the context menu.</p></div>
</div>
</div>
<div class="sect1">
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<h2 id="S_PrintDivelog">7. Printing a dive log</h2>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="sectionbody">
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p><em>Subsurface</em> provides a simple interface to print a whole dive log or only a
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
few selected dives, including dive profiles and other contextual information.</p></div>
<div class="paragraph"><p>Before printing, two decisions are required:</p></div>
<div class="ulist"><ul>
<li>
<p>
Should the whole dive log be printed or only part of it? If only part of the
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
dive log is required, then the user must select the required dives from the <strong>Dive List</strong> panel.
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</p>
</li>
<li>
<p>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
What gas partial pressure information is required on the dive profile? Users should select
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
the appropriate information from the Main Menu: <em>File&#8594;Preferences&#8594;Graph</em>.
</p>
</li>
</ul></div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>Now the print options should be selected to match the user&#8217;s needs. To do this, user should select <em>File&#8594;Print</em> from
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
the Main menu. The following dialogue appears (see the image on the left [A],
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
below).</p></div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>Under <em>Print type</em> users need to select one of three options:</p></div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="ulist"><ul>
<li>
<p>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
Print the Dive List: to do this, <em>Table Print</em> should be selected.
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</p>
</li>
<li>
<p>
Print the full dive records (dive profiles and all other information) at 6
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
dives per printed page: to do this, users should select <em>6 dives per page</em>.
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</p>
</li>
<li>
<p>
Print the full dive records (dive profiles and all other information) at 2
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
dives per printed page: to do this, users should select <em>2 dives per page</em>.
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</p>
</li>
</ul></div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>Under <em>Print options</em> users need to select:</p></div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="ulist"><ul>
<li>
<p>
Printing only the dives that have been selected from the dive list prior to
activating the print dialogue, achieved by checking the box <em>Print only
selected dives</em>.
</p>
</li>
<li>
<p>
Printing in colour, achieved by checking the box with <em>Print in color</em>.
</p>
</li>
</ul></div>
<div class="paragraph"><p>The <em>Ordering</em> affects the layout of the page (or part of it) for each dive.
The dive profile could be printed at the top of each dive, with the textual
information underneath, or it could be printed with the textual information at
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
the top with the dive profile underneath. Users should select the appropriate option in the
print dialogue. See the image on the right (<strong>B</strong>), above which has a layout with
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
text above the dive profile.</p></div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>Users can <em>Preview</em> the printed page by selecting the <em>Preview</em> button on the
dialogue. After preview, changes to the options in the print dialogue can be
made, resulting in a layout that fits personal taste.</p></div>
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
<div class="imageblock" style="text-align:center;">
<div class="content">
<img src="images/PrintDiveLog.jpg" alt="FIGURE: Print dialogue" />
</div>
</div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>Next, select the <em>Print</em> button in the dialogue. This activates the regular print
dialogue used by the user operating system (image [<strong>B</strong>] in the middle, above),
allowing them to choose a printer and to set its properties (image [<strong>C</strong>] on the right,
above).
It is important to set the print resolution of the printer to an appropriate value by
changing
the printer properties. Finally, users can print their dives. Below is a (rather small)
example of
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
the output for one particular page.</p></div>
<div class="imageblock" style="text-align:center;">
<div class="content">
<img src="images/Printpreview.jpg" alt="FIGURE: Print preview page" />
</div>
</div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</div>
</div>
<div class="sect1">
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<h2 id="S_Preferences">8. Setting user <strong>Preferences</strong> for <em>Subsurface</em></h2>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="sectionbody">
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>There are several settings within <em>Subsurface</em> that the users can specify. These
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
are found when selecting <em>File&#8594;Preferences</em>. The settings are performed in
four groups: <strong>Defaults</strong>, <strong>Units</strong>, <strong>Graph</strong> and <strong>Language</strong>. All four sections
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
operate on the same principles: the user must specify the settings the are to be changed, then
these changes are saved using the <strong>Apply</strong> button. After applying all the new settings users can then
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
leave the settings panel by selecting <strong>OK</strong>.</p></div>
<div class="sect2">
Prepare for 4.0.1 release Small updates to README, ReleaseNotes, user manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-03 11:18:59 +00:00
<h3 id="_defaults">8.1. Defaults</h3>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="paragraph"><p>There are four settings in the <strong>Defaults</strong> panel:</p></div>
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
<div class="imageblock" style="text-align:center;">
<div class="content">
<img src="images/Preferences1.jpg" alt="FIGURE: Preferences defaults page" />
</div>
</div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="ulist"><ul>
<li>
<p>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<strong>Lists and tables</strong>: Here one can specify the font type and font size of the
Dive Table panel. By decreasing the font size of the Dive table, users can see more dives on a screen.
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</p>
</li>
<li>
<p>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<strong>Dives</strong>: Here one need to specify the directory and file name of one&#8217;s
electronic dive log book(s). This is a file with filename extension .xml. When
launched, <em>Subsurface</em> will then automatically load the specified dive log book.
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</p>
</li>
<li>
<p>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<strong>Display invalid</strong>: Dives can be marked as invalid (when a user wishes to hide
dives that he/she don&#8217;t consider valid dives, e.g. pool dives, but still want to
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
keep them in the dive log). This controls whether those dives are displayed in
the dive list.
</p>
</li>
<li>
<p>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<strong>Use Default cylinder</strong>: Here users can specify the default cylinder listed in
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
the <strong>Equipment</strong> tab of the <strong>Dive Notes</strong> panel.
</p>
</li>
</ul></div>
</div>
<div class="sect2">
Prepare for 4.0.1 release Small updates to README, ReleaseNotes, user manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-03 11:18:59 +00:00
<h3 id="_units">8.2. Units</h3>
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
<div class="imageblock" style="text-align:center;">
<div class="content">
<img src="images/Preferences2.jpg" alt="FIGURE: Preferences Units page" />
</div>
</div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>Here user can choose between metric and imperial units of depth, pressure,
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
volume, temperature and mass. By selecting the Metric or Imperial radio button
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
at the top, users can specify that all units are in the chosen measurement system.
Alternatively, if one selects the <strong>Personalise</strong> radio button, units can be selected
independently, with some units in the metric system and other in the imperial.</p></div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</div>
<div class="sect2">
Prepare for 4.0.1 release Small updates to README, ReleaseNotes, user manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-03 11:18:59 +00:00
<h3 id="_graph">8.3. Graph</h3>
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
<div class="imageblock" style="text-align:center;">
<div class="content">
<img src="images/Preferences3.jpg" alt="FIGURE: Preferences Graph page" />
</div>
</div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="paragraph"><p>This panel allows two type of selections:</p></div>
<div class="ulist"><ul>
<li>
<p>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<strong>Show</strong>: Here users can specify the amount of information shown as part of
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
the dive profile:
</p>
<div class="ulist"><ul>
<li>
<p>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
Gas pressure graphs: <em>Subsurface</em> can display the nitrogen, oxygen and the helium partial pressures during
the dive. For each of these graphs users can specify a threshold value on the right-hand side of the
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
panel. If any of the graphs go above this threshold level, the graph is
highlighted in red, indication that the threshold value has been exceeded (see
figure below).
</p>
</li>
<li>
<p>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
Ceiling: Ascent ceilings arise when a direct ascent to the surface increases
the risk of a diver suffering from decompression sickness (DCS) and it is necessary to either ascend
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
slower or to perform decompression stop(s) before ascending to the surface.
<em>Subsurface</em> can indicate these ceilings above which the diver should not ascend
at a particular point in time (see the green-shaded areas in the figure in the
section on <a href="#S_DiveProfile">Dive Profiles</a>) and in the figure below:
</p>
<div class="ulist"><ul>
<li>
<p>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
If the <strong>Calculated ceiling</strong> option is checked, then a ceiling is shown if it exists for
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
a particular dive (<strong>A</strong> in figure below)
</p>
</li>
<li>
<p>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
If the <strong>show all tissues</strong> option is checked, the ceiling is shown for the tissue
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
compartments following the Bühlmann model (<strong>B</strong> in figure below).
</p>
</li>
<li>
<p>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
If the <strong>3m increments</strong> option is checked, then the ceiling is indicated in 3 m increments
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
(<strong>C</strong> in figure below).
</p>
</li>
<li>
<p>
If the dive computer itself calculates a ceiling and makes it available to
<em>Subsurface</em> during upload of dives, this can be
shown by checking <strong>Dive computer reported ceiling</strong> and it can be drawn in red by
checking <strong>Draw ceiling red</strong>.
</p>
</li>
</ul></div>
</li>
<li>
<p>
If a <em>Maximum operating depth (MOD)</em> or an <em>Equivalent air depth (EAD)</em>
applies to a dive profile, these can be shown by checking the appropriate boxes.
</p>
</li>
<li>
<p>
If a <em>Maximum partial pressure of oxygen (maxPPO2)</em> applies to dives, then
this can be specified in the appropriate text box. In addition, if a
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<em>no-decompression limit (NDL)</em> is to be shown in the <strong>info</strong> box, then users must check the
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
appropriate box.
</p>
</li>
</ul></div>
</li>
</ul></div>
<div class="imageblock" style="text-align:center;">
<div class="content">
<img src="images/Ceilings.png" alt="Figure: Ceiling with 3m resolution" />
</div>
</div>
<div class="ulist"><ul>
<li>
<p>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<strong>Misc</strong>: Here users can set the <em>gradient factors</em> used while diving. GF_Low is
the gradient factor at deep and GF_High is used just below the surface.
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
At intermediate depths gradient factors between GF_Low and GF_High are used.
Gradient factors add conservatism to the nitrogen exposure during a dive, in a
similar way that many dive computers have a conservatism setting. The lower
the value of a gradient factor, the more conservative the calculations are with
respect to nitrogen loading and the deeper the ascent ceilings are. Gradient
factors of 25/60 are considered conservative and values of 60/90 are considered
harsh. Checking <strong>GFLow at max depth</strong> box causes GF_Low to be used at the
deepest depth of a dive. For more information see:
</p>
<div class="ulist"><ul>
<li>
<p>
<a href="http://www.tek-dive.com/portal/upload/M-Values.pdf">Understanding M-values by Erik Baker, , <em>Immersed</em> Vol. 3, No. 3.</a>
</p>
</li>
<li>
<p>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<a href="http://www.rebreatherworld.com/general-and-new-to-rebreather-articles/5037-gradient-factors-for-dummies.html">Gradient factors for dummies, by Kevin Watts</a>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</p>
</li>
</ul></div>
</li>
</ul></div>
</div>
<div class="sect2">
Prepare for 4.0.1 release Small updates to README, ReleaseNotes, user manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-03 11:18:59 +00:00
<h3 id="_languages">8.4. Languages</h3>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="paragraph"><p>A checkbox allows one to use the <em>System Default</em> language which in most cases
will be the correct setting; with this <em>Subsurface</em> simply runs in the same
language / country settings as the underlying OS. If this is for some reason
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
undesirable users can uncheck this checkbox and pick a language / country
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
combination from the list of included localizations.</p></div>
</div>
</div>
</div>
<div class="sect1">
Prepare for 4.0.1 release Small updates to README, ReleaseNotes, user manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-03 11:18:59 +00:00
<h2 id="_description_of_the_subsurface_main_menu_items">9. Description of the Subsurface Main Menu items</h2>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="sectionbody">
<div class="paragraph"><p>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.</p></div>
<div class="sect2">
Prepare for 4.0.1 release Small updates to README, ReleaseNotes, user manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-03 11:18:59 +00:00
<h3 id="_file">9.1. File</h3>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="ulist"><ul>
<li>
<p>
<a href="#S_NewLogbook"><em>New Logbook</em></a> - Close the currently open dive logbook and
clear all dive information.
</p>
</li>
<li>
<p>
<em>Open logbook</em> - This opens the file manager in order to select a dive
logbook to open.
</p>
</li>
<li>
<p>
<em>Save</em> - Save the dive logbook that is currently open.
</p>
</li>
<li>
<p>
<em>Save as</em>: - Save the current logbook or the currently selected dives within
the present logbook under a different filename.
</p>
</li>
<li>
<p>
<em>Close</em> - Close the dive logbook that is currently open.
</p>
</li>
<li>
<p>
<a href="#S_ExportLog"><em>Export UDDF</em></a> - Export the currently open dive logbook (or
the selected dives in the logbook) in UDDF format.
</p>
</li>
<li>
<p>
<a href="#S_PrintDivelog"><em>Print</em></a> - Print the currently open logbook.
</p>
</li>
<li>
<p>
<a href="#S_Preferences"><em>Preferences</em></a> - Set the <em>Subsurface</em> preferences.
</p>
</li>
<li>
<p>
<em>Quit</em> - Quit <em>Subsurface</em>.
</p>
</li>
</ul></div>
</div>
<div class="sect2">
Prepare for 4.0.1 release Small updates to README, ReleaseNotes, user manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-03 11:18:59 +00:00
<h3 id="_import">9.2. Import</h3>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="ulist"><ul>
<li>
<p>
<a href="#S_ImportDiveComputer"><em>Import from dive computer</em></a> - Import dive information
from a dive computer.
</p>
</li>
<li>
<p>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<a href="#Unified_import"><em>Import Files</em></a> - Import dive information from a file in
in a <em>Subsurface</em>-compatible format.
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</p>
</li>
<li>
<p>
<a href="#S_Companion"><em>Import GPS data from Subsurface Service</em></a> - Load GPS
coordinates from the <em>Subsurface</em> mobile phone app.
</p>
</li>
<li>
<p>
<a href="#S_ImportingDivelogsDe"><em>Import from Divelogs.de</em></a> - Import dive information
from <em>www.Divelogs.de</em>.
</p>
</li>
</ul></div>
</div>
<div class="sect2">
Prepare for 4.0.1 release Small updates to README, ReleaseNotes, user manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-03 11:18:59 +00:00
<h3 id="_log">9.3. Log</h3>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="ulist"><ul>
<li>
<p>
<a href="#S_EnterData"><em>Add Dive</em></a> - Manually add a new dive to the <strong>Dive List</strong> panel.
</p>
</li>
<li>
<p>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<a href="#S_Renumber"><em>Renumber</em></a> - Renumber the dives listed in the <strong>Dive List</strong>
panel.
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</p>
</li>
<li>
<p>
<a href="#S_Group"><em>Auto Group</em></a> - Group the dives in the <strong>Dive List</strong> panel into dive
trips.
</p>
</li>
<li>
<p>
<em>Edit Device Names</em> - Edit the names of dive computers.
</p>
</li>
</ul></div>
</div>
<div class="sect2">
Prepare for 4.0.1 release Small updates to README, ReleaseNotes, user manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-03 11:18:59 +00:00
<h3 id="_view">9.4. View</h3>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="ulist"><ul>
<li>
<p>
<a href="#S_ViewPanels"><em>All</em></a> - View the four main <em>Subsurface</em> panels
simmultaneously.
</p>
</li>
<li>
<p>
<a href="#S_ViewPanels"><em>Dive List</em></a> - View only the <strong>Dive List</strong> panel.
</p>
</li>
<li>
<p>
<a href="#S_ViewPanels"><em>Profile</em></a> - View only the <strong>Dive Profile</strong> panel.
</p>
</li>
<li>
<p>
<a href="#S_ViewPanels"><em>Info</em></a> - View only the <strong>Dive Notes</strong> panel.
</p>
</li>
<li>
<p>
<a href="#S_ViewPanels"><em>Globe</em></a> - View only the <strong>World Map</strong> panel.
</p>
</li>
<li>
<p>
<em>Yearly Statistics</em> - Display summary statistics about dives during the last
year.
</p>
</li>
<li>
<p>
<em>Prev DC</em> - Switch to next dive computer.
</p>
</li>
<li>
<p>
<em>Next DC</em> - Switch to previous dive computer.
</p>
</li>
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
<li>
<p>
<em>Full Screen</em> - Toggles Full Screen mode.
</p>
</li>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</ul></div>
</div>
<div class="sect2">
Prepare for 4.0.1 release Small updates to README, ReleaseNotes, user manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-03 11:18:59 +00:00
<h3 id="_filter">9.5. Filter</h3>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="ulist"><ul>
<li>
<p>
<em>Select Events</em> - This option is not implemented yet.
</p>
</li>
</ul></div>
</div>
<div class="sect2">
Prepare for 4.0.1 release Small updates to README, ReleaseNotes, user manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-03 11:18:59 +00:00
<h3 id="_help">9.6. Help</h3>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="ulist"><ul>
<li>
<p>
<em>About Subsurface</em> - Show a panel with the version number of <em>Subsurface</em> as
well as licensing information.
</p>
</li>
<li>
<p>
<em>User Manual</em> - Open a window showing this user manual.
</p>
</li>
</ul></div>
</div>
</div>
</div>
<div class="sect1">
Prepare for 4.0.1 release Small updates to README, ReleaseNotes, user manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-03 11:18:59 +00:00
<h2 id="_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.</h2>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="sectionbody">
<div class="sect2">
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<h3 id="_make_sure_that_the_os_has_the_required_drivers_installed">10.1. Make sure that the OS has the required drivers installed</h3>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="admonitionblock">
<table><tr>
<td class="icon">
<img src="images/icons/drivers.jpg" alt="Note" />
</td>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<td class="content">The operating system of the desktop computer needs the appropriate drivers in
order to communicate with the dive computer in whichever way the dive
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
computer prefers (e.g. bluetooth, USB, infrared).</td>
</tr></table>
</div>
<div class="ulist"><ul>
<li>
<p>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
On Linux this means users need to have the correct kernel
module loaded. Most distributions will do this automatically.
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</p>
</li>
<li>
<p>
On Windows, the OS should offer to download the correct
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
driver once the user connects the dive computer to the USB port.
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</p>
</li>
<li>
<p>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
On a Mac users sometimes have to manually hunt for the correct
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
driver. For example the correct driver for the Mares Puck
devices can be found as Mac_OSX_VCP_Driver.zip at
</p>
</li>
</ul></div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p><a href="http://www.silabs.com/support/pages/support.aspx?ProductFamily=USB+Bridges">http://www.silabs.com/support/pages/support.aspx?ProductFamily=USB+Bridges</a></p></div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</div>
<div class="sect2">
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
<h3 id="S_HowFindDeviceName">10.2. How to Find the Device Name for USB devices and set its write permission</h3>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="admonitionblock">
<table><tr>
<td class="icon">
<img src="images/icons/usb.jpg" alt="Note" />
</td>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<td class="content">When a user connects the dive computer by using a USB connector, usually
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<em>Subsurface</em> will either propose a drop down list that contains the
correct device name (or mount point for the Uemis Zurich), or it will
disable the device select drop down if no device name is needed at
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
all. In the rare cases where this doesn&#8217;t work, here are some
instructions on ways to find out what the device name is:</td>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</tr></table>
</div>
<div class="paragraph"><div class="title">On Windows:</div><p>Simply try COM1, COM2, etc. The drop down list should contain all connected COM
devices.</p></div>
<div class="paragraph"><div class="title">On MacOS:</div><p>The drop down box should find all connected dive computers.</p></div>
<div class="paragraph"><div class="title">On Linux:</div><p>Try the following:</p></div>
<div class="ulist"><ul>
<li>
<p>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
Disconnect the USB cable from the dive computer
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</p>
</li>
<li>
<p>
Open a terminal
</p>
</li>
<li>
<p>
Type the command: <em>dmesg</em> and press enter
</p>
</li>
<li>
<p>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
Plug in the USB cable of the dive computer
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</p>
</li>
<li>
<p>
Type the command: <em>dmesg</em> and press enter
</p>
</li>
</ul></div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>Within the terminal, users should see a message similar to this one:</p></div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="literalblock">
<div class="content">
<pre><code>usb 2-1.1: new full speed USB device number 14 using ehci_hcd
usbcore: registered new interface driver usbserial
USB Serial support registered for generic
usbcore: registered new interface driver usbserial_generic
usbserial: USB Serial Driver core
USB Serial support registered for FTDI USB Serial Device
ftdi_sio 2-1.1:1.0: FTDI USB Serial Device converter detected
usb 2-1.1: Detected FT232BM
usb 2-1.1: Number of endpoints 2
usb 2-1.1: Endpoint 1 MaxPacketSize 64
usb 2-1.1: Endpoint 2 MaxPacketSize 64
usb 2-1.1: Setting MaxPacketSize 64
usb 2-1.1: FTDI USB Serial Device converter now attached to ttyUSB3
usbcore: registered new interface driver ftdi_sio
ftdi_sio: v1.6.0:USB FTDI Serial Converters Driver</code></pre>
</div></div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>Users can see that in the third line from the bottom, the USB adapter is
detected and is connected to <code>ttyUSB3</code>. This information can now be used in
the import settings as <code>/dev/ttyUSB3</code>. This directs Subsurface to the correct
USB port.</p></div>
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
<div class="paragraph"><p>Ensuring you have write permission to the USB serial port:</p></div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>On Unix-like operating systems the USB ports can only be accessed by users who
are members
of the <code>dialout</code> group. If one is not root, one may not be a member of
that group and
will not be able to use the USB port. Let us assume one&#8217;s username is <em>johnB</em>.</p></div>
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
<div class="ulist"><ul>
<li>
<p>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
As root, type: <code>usermod -a -G dialout johnB</code> (Ubuntu users: <code>sudo -a -G
dialout johnB</code>)
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
This makes johnB a member of the <code>dialout</code> group.
</p>
</li>
<li>
<p>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
Type: <code>id johnB</code> This lists all the groups that johnB belongs to and
verifies that
the appropriate group membership has been created. The <code>dialout</code> group should
be listed
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
among the different IDs.
</p>
</li>
</ul></div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>With the appropriate device name (e.g. <code>dev/ttyUSB3</code>) and with write permission
to the USB
port, the dive computer interface can connect and one should be able to import
dives.</p></div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</div>
<div class="sect2">
Prepare for 4.0.1 release Small updates to README, ReleaseNotes, user manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-03 11:18:59 +00:00
<h3 id="S_HowFindBluetoothDeviceName">10.3. Setting up bluetooth enabled devices</h3>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="admonitionblock">
<table><tr>
<td class="icon">
<img src="images/icons/bluetooth.jpg" alt="Note" />
</td>
<td class="content">For dive computers communicating through bluetooth like the Heinrichs
Weikamp Frog or the Shearwater Predator and Petrel there is a
different procedure to get the devices name to communicate with
<em>Subsurface</em>. In general it consists of these steps:</td>
</tr></table>
</div>
<div class="ulist"><ul>
<li>
<p>
enable bluetooth on your computer
</p>
</li>
<li>
<p>
pairing the device
</p>
</li>
</ul></div>
<div class="paragraph"><p>Do not forget to set your divecomputer in Bluetooth or upload mode before
Paring and Downloading logs. If you use a Shearwater Predator/Petrel just select
<em>Dive Log &#8594; Upload Log</em> and wait until you see the <em>Wait PC</em> message.</p></div>
<div class="paragraph"><div class="title">On Windows:</div><p>Bluetooth is most likely already enabled. For pairing the device choose
Control Panel&#8594;Bluetooth Devices&#8594;Add Wireless Device
This should bring up a dialog showing your dive computer (in Bluetooth mode) and
allowing to pair it. For bluetooth pairing of your dive computer refer to the
manufacturer&#8217;s user guide. The dive computer should then show up in the list of
Bluetooth devices and you may then right click on it and choose Properties&#8594;COM
Ports to identify the port used for your dive computer. If there are several
ports listed, use the one saying "Outgoing" instead of "Incoming".</p></div>
<div class="paragraph"><p>For downloading to <em>Subsurface</em>, the drop down list should contain this COM
port already. If not, enter it manually.</p></div>
<div class="paragraph"><p>Note: If you have issues downloading from your dive computer in other software
afterwards try to remove the pairing with your dive computer.</p></div>
<div class="paragraph"><div class="title">On MacOS:</div><p>Click on the Bluetooth symbol in the menu bar and select <em>Set up
Bluetooth Device&#8230;</em>. Make sure that your dive computer is in upload
mode; it should then show up in the list of devices. Select it and go
through the pairing process. This step should only be needed once for
initial setup.</p></div>
<div class="paragraph"><p>Once the pairing is completed the correct device will be shown in the
<em>Device or Mount Point</em> drop down in the <em>Subsurface</em> <strong>Import</strong> dialog.</p></div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><div class="title">On Linux</div><p>Ensure bluetooth is enabled on the <em>Subsurface</em> computer.
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
On most common distributions this should be true out of the box. If not then
depending on your system, running <code>initd</code> or <code>systemd</code>. This might be different
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
and also involve loading modules specific to your hardware. In case your system
is
running <code>systemd</code>, manually run <code>sudo systemctl start bluetooth.service</code> to
enable
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
it, in case of <code>initd</code>, run something like <code>sudo rc.config start bluetoothd</code> or
<code>sudo /etc/init.d/bluetooth start</code>.</p></div>
<div class="paragraph"><p>Pairing should be straight forward. Using Gnome3 for instance will show a
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
bluetooth icon in the upper right corner of the desktop where one selects <em>Set
up New Device</em>. This should show a dialog where one can select the
dive computer (in bluetooth mode) and pair it. For issues with PIN
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
setting try manually setting <em>0000</em>.</p></div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>One may also use a manual approach by using such commands:</p></div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="ulist"><ul>
<li>
<p>
<code>sudo hciconfig</code> - shows the bluetooth devices available on your
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
computer (not dive computer), most likely one will see a hci0, if not
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
try <em>sudo hcitool -a</em> to see inactive devices and try to run <em>sudo
hciconfig hci0 up</em> to bring them up
</p>
</li>
<li>
<p>
<code>sudo hcitool scanning</code>- use this to get a list of bluetooth enabled
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
client devices, look for the dive computer and remember the MAC
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
address shown there
</p>
</li>
<li>
<p>
<code>sudo bluez-simple-agent hci0 10:00:E8:C4:BE:C4</code> - this will pair
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
the dive computer with the bluetooth stack of the <em>Subsurface</em> computer, copy/paste
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
the MAC address from the output of <em>hcitool scanning</em>
</p>
</li>
</ul></div>
<div class="paragraph"><p>Unfortunately on Linux binding to a communication device has to be done
manually by running:</p></div>
<div class="ulist"><ul>
<li>
<p>
<code>sudo rfcomm bind /dev/rfcomm0 10:00:E8:C4:BE:C4</code> - bind the dive
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
computer to a communication device in the desktop computer, in case rfcomm is
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
already taken just use rfcomm1 or up, please copy/paste the MAC address
from the output of <em>hcitool scanning</em>, the MAC shown in here will not
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
work.
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</p>
</li>
</ul></div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>For downloading dives in Subsurface one then has to specify <code>/dev/rfcomm0</code>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
as device name to use.</p></div>
</div>
</div>
</div>
<div class="sect1">
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<h2 id="_appendix_b_dive_computer_specific_information_for_importing_dive">11. APPENDIX B: Dive Computer specific information for importing dive</h2>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="sectionbody">
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>information.</p></div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="sect2">
Prepare for 4.0.1 release Small updates to README, ReleaseNotes, user manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-03 11:18:59 +00:00
<h3 id="S_ImportUemis">11.1. Import from a Uemis Zurich</h3>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="admonitionblock">
<table><tr>
<td class="icon">
<img src="images/icons/iumis.jpg" alt="Note" />
</td>
User manual: updates Correct error in manual Add some short text in sections dealing with equipment. [Dirk Hohndel: clean up whitespace & regenerate the html file] Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-22 16:59:30 +00:00
<td class="content">Things are very similar to a normal USB-connected dive computer when
downloading dives from a Uemis Zurich
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
dive computer (one of the ones that recharge when
connected to the USB port). The main difference is that one does not enter a
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
device name, but instead the location where the UEMISSDA file system is
mounted once you connect the dive computer. On Windows this is a drive letter (
often <em>E:</em> or <em>F:</em>), on a Mac this is
<em>/Volumes/UEMISSDA</em> and on Linux systems this differs depending on the
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
distribution. On Fedora it usually is
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<em>/var/run/media/&lt;your_username&gt;/UEMISSDA</em>. In all cases <em>Subsurface</em>
should suggest the correct location in the drop down list.</td>
</tr></table>
</div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>Once onehas selected this as device name one can download the
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
dives from the Uemis Zurich. One technical issue with the Uemis Zurich
download implementation (this is a firmware limitation, not a
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<em>Subsurface</em> issue) is that one cannot download more than about 40-50
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
dives without running out of memory on the SDA. This will usually only
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
happen the very first time one downloads dives from the Uemis Zurich -
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
normally when downloading at the end of a day or even after a dive
trip, the capacity is sufficient. If <em>Subsurface</em> displays an error
that the dive computer ran out of space the solution is straight
forward. Disconnect the SDA, turn it off and on again, and reconnect
it. You can now retry (or start a new download session) and the
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
download will continue where it stopped previously. One
may have to do this more than once, depending on how many dives are
stored on the dive computer.</p></div>
<div class="paragraph"><p>At this point <em>Subsurface</em> downloads most of the information
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
stored on the SDA, including information about dive spots and
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
equipment. Buddy information is not yet downloadable.</p></div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</div>
<div class="sect2">
Prepare for 4.0.1 release Small updates to README, ReleaseNotes, user manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-03 11:18:59 +00:00
<h3 id="S_ImportingDR5">11.2. Importing dives from Heinrichs Weikamp DR5</h3>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="admonitionblock">
<table><tr>
<td class="icon">
<img src="images/icons/HW_DR5.jpg" alt="Note" />
</td>
<td class="content">When mounted as a USB drive the Heinrichs Weikamp DR5 saves a single UDDF file
for every dive.
Mark all the dives you&#8217;d like to import or open.
Note: The DR5 does not seem to store gradient factors nor deco information, so
for <em>Subsurface</em> it is not possible to display them. Adjust the gradient
factors in the Tec Settings in <em>Subsurface</em> to generate a deco overlay in the _
Subsurface_ <strong>Dive Profile</strong> panel
to get deco displayed but please note that the deco calculated by <em>Subsurface</em>
will most likely differ from the one displayed on the DR5.</td>
</tr></table>
</div>
</div>
<div class="sect2">
Prepare for 4.0.1 release Small updates to README, ReleaseNotes, user manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-03 11:18:59 +00:00
<h3 id="_import_from_shearwater_predator_using_bluetooth">11.3. Import from Shearwater Predator using bluetooth</h3>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
<div class="admonitionblock">
<table><tr>
<td class="icon">
<img src="images/icons/predator.jpg" alt="Note" />
</td>
<td class="content">Using a Shearwater Predator you may be able to pair Bluetooth but then encounter
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
issues when downloading, showing errors like <em>Slip RX: unexp. SLIP END</em> on the
Predator.
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
This might also be seen, when using other dive log software and operating
systems than Linux. We have no detailed idea about the source and how to fix
this, but it is reported to be solved sometimes by one of these steps:</td>
</tr></table>
</div>
<div class="ulist"><ul>
<li>
<p>
use the bluetooth dongle which came with the Shearwater Predator instead of
the built-in one of your computer
</p>
</li>
<li>
<p>
switch to different bluetooth drivers for your hardware
</p>
</li>
<li>
<p>
switch off WiFi while using Bluetooth
</p>
</li>
</ul></div>
</div>
</div>
</div>
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
<div class="sect1">
<h2 id="_appendix_c_exporting_dive_log_information_from_external_dive_log_software">12. APPENDIX C: Exporting Dive log information from external dive log software.</h2>
<div class="sectionbody">
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>The import of dive log data from external dive log software is mostly performed
using
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
the dialogue found by selecting <em>Import</em> from the Main Menu, then clicking on
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<em>Import Log Files</em>. This is a single-step process, more information about which
can be found
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
<a href="#Unified_import">here.</a>
However, in some cases, a two-step process may be required:</p></div>
<div class="ulist"><ul>
<li>
<p>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
Export the forieign dive log data to format that is accessible from
<em>Subsurface</em>.
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
</p>
</li>
<li>
<p>
Import the accessible dive log data into <em>Subsurface</em>.
</p>
</li>
</ul></div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p>This appendix provides some information about approaches to export dive log
data from foreign
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
dive log software. The procedures below mostly apply to Linux and/or Windows.</p></div>
<div class="sect2">
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<h3 id="S_ImportingDivesSuunto">12.1. Exporting dives from <strong>Suunto Divemanager (DM3 and DM4)</strong></h3>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<img src="images/icons/suuntologo.jpg" alt="Note" />
</td>
<td class="content">Divemanager 3 (DM3) is an older version of the Suunto software. More recent
Suunto dive computers use Divemanager 4 (DM4). The
two versions of Divemanager use different methods and different file naming
conventions to export dive log data.</td>
</tr></table>
</div>
<div class="paragraph"><p><strong>Divemanager 3 (DM3):</strong></p></div>
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
<div class="ulist"><ul>
<li>
<p>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
Start <em>Suunto Divemanager 3</em> and log in with the name containing the logs
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
</p>
</li>
<li>
<p>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
Do not start the import wizard to import dives from the dive computer.
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
</p>
</li>
<li>
<p>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
In the navigation tree on the left side of the program-window, select the appropriate
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
dives.
</p>
</li>
<li>
<p>
Within the list of dives, select the dives you would like to import later:
</p>
<div class="ulist"><ul>
<li>
<p>
To select certain dives: hold <em>ctrl</em> and click the dive
</p>
</li>
<li>
<p>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
To select all dives: Select the first dive, hold down shift and
select the
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
last dive
</p>
</li>
</ul></div>
</li>
<li>
<p>
With the dives marked, use the program menu <em>File &#8594; Export</em>
</p>
</li>
<li>
<p>
The export pop-up will show
</p>
</li>
<li>
<p>
Within this pop-up, there is one field called Export Path.
</p>
<div class="ulist"><ul>
<li>
<p>
Click the browse button next to the field Export Path
</p>
<div class="ulist"><ul>
<li>
<p>
A file-manager like window pops up
</p>
</li>
<li>
<p>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
Navigate to the directory or storing the
Divelog.SDE file
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
</p>
</li>
<li>
<p>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
Optionally change the name of the file for saving
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
</p>
</li>
<li>
<p>
Click <em>Save</em>
</p>
</li>
</ul></div>
</li>
<li>
<p>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
Back in the Export pop-up, press the button <em>Export</em>
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
</p>
</li>
</ul></div>
</li>
<li>
<p>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
The dives are now exported to the file Divelogs.SDE.
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
</p>
</li>
</ul></div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="paragraph"><p><strong>Divemanager 4 (DM4):</strong></p></div>
<div class="paragraph"><p>To import divelog from <em>Suunto DM4</em>, one needs to locate the DM4 database
where the dives are stored. the user can either look for the original
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
database or take a backup of the dives. Both methods are described here.</p></div>
<div class="paragraph"><p>Locating the Suunto DM4 database:</p></div>
<div class="ulist"><ul>
<li>
<p>
Start Suunto DM4
</p>
</li>
<li>
<p>
Select <em>Help &#8594; About</em>
</p>
</li>
<li>
<p>
Click <em>Copy</em> after text <em>Copy log folder path to clipboard</em>
</p>
</li>
<li>
<p>
Now open Windows Explorer
</p>
</li>
<li>
<p>
Paste the address to the path box at the top of the File Explorer
</p>
</li>
<li>
<p>
The database is called DM4.db
</p>
</li>
</ul></div>
<div class="paragraph"><p>Backing up Suunto DM4:</p></div>
<div class="ulist"><ul>
<li>
<p>
Start Suunto DM4
</p>
</li>
<li>
<p>
Select <em>File - Create backup</em>
</p>
</li>
<li>
<p>
From the file menu select the location and name for the backup, we&#8217;ll
use DM4 in here with the default extension .bak
</p>
</li>
<li>
<p>
Click <em>Save</em>
</p>
</li>
<li>
<p>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
The dives are now exported to the file DM4.bak
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
</p>
</li>
</ul></div>
</div>
<div class="sect2">
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<h3 id="_exporting_from_mares_dive_organiser_v2_1">12.2. Exporting from Mares Dive Organiser V2.1</h3>
<div class="admonitionblock" id="Mares_Export">
<table><tr>
<td class="icon">
<img src="images/icons/mareslogo.jpg" alt="Note" />
</td>
<td class="content">Mares Dive Organiser is a Microsoft application. The dive log is kept as a
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
Microsoft SQL Compact Edition data base with a .SDF filename extension. The
data base includes all Dive Organiser-registered divers on the particular
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
computer and all Mares dive computers used. The safest way to obtain a copy
of the dive data base is to export the information to another compatible format
which can be imported into <em>Subsurface</em>.</td>
</tr></table>
</div>
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
<div class="ulist"><ul>
<li>
<p>
Within Dive Organiser, select
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<em>Database &#8594; Backup</em> from the main menu and back up the data base to the desk
top.
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
This creates a zipped file DiveOrganiserxxxxx.dbf.
</p>
</li>
<li>
<p>
Rename the file to
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
DiveOrganiserxxxxx.zip. Inside the zipped directory is a file
<em>DiveOrganiser.sdf</em>.
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
</p>
</li>
<li>
<p>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
Extract the <em>.sdf</em> file from the zipped folder to your Desktop.
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
</p>
</li>
</ul></div>
</div>
<div class="sect2">
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<h3 id="S_ImportingDivinglog">12.3. Exporting dives from <strong>DivingLog 5.0</strong></h3>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<img src="images/icons/divingloglogo.jpg" alt="Note" />
</td>
<td class="content">Unfortunately DivingLog XML files give us no
indication on the preferences set on one&#8217;s system. So in order for
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
<em>Subsurface</em> to be able to successfully import XML files from DivingLog
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
one first needs to ensure that DivingLog is configured
to use the Metric system (one can easily change this in <em>File &#8594;
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
Preferences &#8594; Units and Language</em> by clicking the <em>Metric</em>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
button). Then do the following:</td>
</tr></table>
</div>
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
<div class="ulist"><ul>
<li>
<p>
In Divinglog open the <em>File &#8594; Export &#8594; XML</em> menu
</p>
</li>
<li>
<p>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
Select the dives to export
User manual: update html file shipped with git repository Every once in a while I need to update this so people building from source who don't have asciidoc installed still have a reasonably current manual. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-07 14:53:01 +00:00
</p>
</li>
<li>
<p>
Click on the export button and select the filename
</p>
</li>
</ul></div>
</div>
</div>
</div>
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
<div class="sect1">
<h2 id="_appendix_d_faqs">13. APPENDIX D: FAQs.</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_subsurface_appears_to_miscalculate_gas_consumption_and_sac">13.1. Subsurface appears to miscalculate gas consumption and SAC</h3>
<div class="paragraph" id="SAC_CALCULATION"><p>Not really. What happens is that subsurface actually calculates gas
consumption differently - and better - than you expect.
In particular, it takes the incompressibility of the gas into account.
Traditionally, Gas consumption and SAC should be:
<code>consumption = tank size x (start pressure - end pressure)</code></p></div>
<div class="paragraph"><p>and that&#8217;s true for an ideal gas, and it&#8217;s what you get taught in dive theory.
But an "ideal gas" doesn&#8217;t actually exist, and real gases actually don&#8217;t compress
linearly with pressure. Also, you are missing the fact that one atmosphere of
pressure isn&#8217;t actually one bar.
So the <strong>real</strong> calculation is:</p></div>
<div class="paragraph"><p><code>consumption = (amount_of_air_at_beginning - amount_of_air_at_end)</code></p></div>
<div class="paragraph"><p>where the amount of air is <strong>not</strong> just "tank size times pressure in bar".
It&#8217;s a combination of: "take compressibility into account" (which is a fairly
small issue under 220 bar - you&#8217;ll see more differences when you do high-pressure
tanks with 300bar) and "convert bar to atm" (which is the majority of your discrepancy).
Remember: one ATM is ~1.013 bar, so without the compressibility, your gas use is:</p></div>
<div class="paragraph"><p><code>12.2*((220-100)/1.013)</code></p></div>
<div class="paragraph"><p>which is about 1445, not 1464. So there was 19 l too much in your simple
calculation that ignored the difference between 1 bar and one ATM.
The compressibility does show up above 200 bar, and takes that 1445 down
about eight liters more, so you really did use only about 1437 l of air at surface pressure.
The math details can be seen in dive.c:</p></div>
<div class="paragraph"><p><code>surface_volume_multiplier().</code></p></div>
<div class="paragraph"><p>The "if (bar &gt; 200) bar = .." part is the compressibility - it&#8217;s an approximation,
but it&#8217;s a reasonably good one, and closer to reality than not doing it.
You can get the numbers you expect if you remove that, and turn the function into just:</p></div>
<div class="paragraph"><p><code>return pressure.mbar / 1000.0;</code></p></div>
<div class="paragraph"><p>but that would actually be wrong.
So be happy: your SAC really is better than your calculations indicated.
Or be sad: your cylinder contains less air than you thought it did.
And as mentioned, the "contains less air than you thought it did" really
starts becoming much more noticeable at high pressure. A 400 bar really does not
contain twice as much air as a 200 bar one. At lower pressures, air acts pretty much like an ideal gas.</p></div>
</div>
<div class="sect2">
<h3 id="_some_dive_profiles_have_time_discrepances_with_the_recorded_samples_from_my_dive_computer_8230">13.2. Some dive profiles have time discrepances with the recorded samples from my dive computer&#8230;</h3>
<div class="paragraph"><p><em>Subsurface</em> ends up ignoring surface time for many things (average depth, divetime, SAC, etc).
For example, if you end up doing a weight check (deep enough to trigger the "dive started")
but then come back up and wait five minutes for your buddies, your dive computer may say
that your dive is 50 minutes long - because you have fifty minutes worth of samples - but
subsurface will say it&#8217;s 45 minutes - because you were actually diving for 45 minutes.
It&#8217;s even more noticeable if you do things like divemastering the initial OW dives, when
you may stay in the water for a long time, but spend most of it at the surface. And then
you don&#8217;t want that to count as some kind of long dive”.</p></div>
</div>
</div>
</div>
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</div>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Updated user manual html file Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-14 06:41:36 +00:00
Last updated 2014-02-13 22:37:50 PST
Include the user-manual.html file in the git tree This way when building Subsurface asciidoc is not necessary at all - except if you want to work on the user manual and want to see the result of your work. Previously the build wouldn't fail without asciidoc, but there would be no working user manual when pressing F1 from within the application. This solves the problem by shipping the HTML file with the sources. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 21:48:46 +00:00
</div>
</div>
</body>
</html>
Reference in a new issue Copy permalink