diff options
Diffstat (limited to 'Documentation')
16 files changed, 343 insertions, 287 deletions
diff --git a/Documentation/mobile-images/Edit.jpg b/Documentation/mobile-images/Edit.jpg Binary files differdeleted file mode 100644 index 16873c13c..000000000 --- a/Documentation/mobile-images/Edit.jpg +++ /dev/null diff --git a/Documentation/mobile-images/Left.jpg b/Documentation/mobile-images/Left.jpg Binary files differdeleted file mode 100644 index 803737806..000000000 --- a/Documentation/mobile-images/Left.jpg +++ /dev/null diff --git a/Documentation/mobile-images/LeftRight.jpg b/Documentation/mobile-images/LeftRight.jpg Binary files differdeleted file mode 100644 index a1409f908..000000000 --- a/Documentation/mobile-images/LeftRight.jpg +++ /dev/null diff --git a/Documentation/mobile-images/Quit.jpg b/Documentation/mobile-images/Quit.jpg Binary files differdeleted file mode 100644 index 4a450865d..000000000 --- a/Documentation/mobile-images/Quit.jpg +++ /dev/null diff --git a/Documentation/mobile-images/actionbutton.jpg b/Documentation/mobile-images/actionbutton.jpg Binary files differnew file mode 100644 index 000000000..7cdef795d --- /dev/null +++ b/Documentation/mobile-images/actionbutton.jpg diff --git a/Documentation/mobile-images/createdive.jpg b/Documentation/mobile-images/createdive.jpg Binary files differnew file mode 100644 index 000000000..6da7c14d9 --- /dev/null +++ b/Documentation/mobile-images/createdive.jpg diff --git a/Documentation/mobile-images/divelist.jpg b/Documentation/mobile-images/divelist.jpg Binary files differindex b8db72dd8..165a9e941 100644 --- a/Documentation/mobile-images/divelist.jpg +++ b/Documentation/mobile-images/divelist.jpg diff --git a/Documentation/mobile-images/editdive.jpg b/Documentation/mobile-images/editdive.jpg Binary files differindex 36daac3d7..43bd21083 100644 --- a/Documentation/mobile-images/editdive.jpg +++ b/Documentation/mobile-images/editdive.jpg diff --git a/Documentation/mobile-images/gpsmanagement.jpg b/Documentation/mobile-images/gpsmanagement.jpg Binary files differindex c441b4e7c..6a160e254 100644 --- a/Documentation/mobile-images/gpsmanagement.jpg +++ b/Documentation/mobile-images/gpsmanagement.jpg diff --git a/Documentation/mobile-images/gpssetup.jpg b/Documentation/mobile-images/gpssetup.jpg Binary files differindex ca30bf7d2..6021ce0e3 100644 --- a/Documentation/mobile-images/gpssetup.jpg +++ b/Documentation/mobile-images/gpssetup.jpg diff --git a/Documentation/mobile-images/landingscreen.jpg b/Documentation/mobile-images/landingscreen.jpg Binary files differindex 1141b0f2b..143eb69ec 100644 --- a/Documentation/mobile-images/landingscreen.jpg +++ b/Documentation/mobile-images/landingscreen.jpg diff --git a/Documentation/mobile-images/managedive.jpg b/Documentation/mobile-images/managedive.jpg Binary files differdeleted file mode 100644 index 4383a0305..000000000 --- a/Documentation/mobile-images/managedive.jpg +++ /dev/null diff --git a/Documentation/mobile-images/map.jpg b/Documentation/mobile-images/map.jpg Binary files differdeleted file mode 100644 index c1712cbda..000000000 --- a/Documentation/mobile-images/map.jpg +++ /dev/null diff --git a/Documentation/mobile-images/menu.jpg b/Documentation/mobile-images/menu.jpg Binary files differnew file mode 100644 index 000000000..db906088b --- /dev/null +++ b/Documentation/mobile-images/menu.jpg diff --git a/Documentation/mobile-manual.html b/Documentation/mobile-manual.html index cdbf3d1d9..3758ff54b 100644 --- a/Documentation/mobile-manual.html +++ b/Documentation/mobile-manual.html @@ -413,33 +413,24 @@ asciidoc.install(3); <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="paragraph"><p><span class="blue"><em>Beta release, February 2016</em></span></p></div> -<div class="admonitionblock"> -<table><tr> -<td class="icon"> -<img src="./images/icons/important.png" alt="Important" /> -</td> -<td class="content">For this BETA release it is critical that users report any problems -with the use of the mobile software. After all, one of the objectives -of a beta release is to distribute the software to a broader circle -of users using different Android devices and configurations in order to -iron out any bugs, errors or inconsistencies. Please report -such issues by email to <a href="mailto:subsurface@subsurface-divelog.org">subsurface@subsurface-divelog.org</a></td> -</tr></table> -</div> -<div class="paragraph"><p>Welcome as a user of <em>Subsurface</em>, an advanced dive logging program with +<div class="paragraph"><p><span class="blue"><em>Beta release, March 2016</em></span></p></div> +<div class="paragraph"><p>Welcome as a user of <em>Subsurface</em>, advanced dive logging software with extensive infrastructure to describe, organize, interpret and print scuba and free dives. <em>Subsurface</em> offers many advantages over other similar software solutions, including compatibility with Windows, Mac-OS/X, Linux (many -distributions) as well as Android. In addition, <em>Subsurface</em> allows downloading dive -information from most dive computers. <em>Subsurface</em> software is open-source.</p></div> +distributions) and Android (iOS under development). In addition, <em>Subsurface</em> is +open-source software that allows downloading dive +information from most dive computers.</p></div> <div class="sect1"> <h2 id="_introducing_subsurface_mobile">1. Introducing Subsurface-mobile</h2> <div class="sectionbody"> -<div class="paragraph"><p><em>Subsurface-mobile</em> is an extension of <em>Subsurface</em> that runs on laptop and +<div class="paragraph"><p><em>Subsurface-mobile</em> is an extension of <em>Subsurface</em> on laptop and tabletop computers. It runs on Android smartphone and tablet devices and is a -tool for viewing or sharing dive information at dive sites. It also allows +tool for viewing or sharing dive information at dive sites where a larger +computer is not useful. <em>Subsurface-mobile</em> also allows the gathering of GPS locations where dives are performed.</p></div> +<div class="paragraph"><p>A version of <em>Subsurface-mobile</em> for iOS is under development but not yet +ready for testing.</p></div> <div class="paragraph"><p>While <em>Subsurface-mobile</em> allows one to enter and save dive information using an Android device, users of <em>Subsurface-mobile</em> typically use the mobile app as an extension of the laptop/desktop version of <em>Subsurface</em>. @@ -448,7 +439,8 @@ can be shared by the Android version as well as the desktop version. While the desktop version of <em>Subsurface</em> shows much more detailed information for each dive, the mobile version allows one to have a more accessible dive log on a dive trip, useful for proving dive experience to dive shops or to review -previous dives. <em>Subsurface-mobile</em> allows one to:</p></div> +previous dives.</p></div> +<div class="paragraph"><p><em>Subsurface-mobile</em> allows one to:</p></div> <div class="ulist"><ul> <li> <p> @@ -488,14 +480,19 @@ View the localities of recorded GPS positions and of dives </p> </li> </ul></div> -<div class="paragraph"><p>These items are discussed in greater detail in the following text.</p></div> +<div class="paragraph"><p>These items are discussed in greater detail in the following text. +What <em>Subsurface-mobile</em> does not support (at this time) is downloading +dive data directly from a dive computer. That still has to happen with +<em>Subsurface</em> on a desktop or laptop computer. We are investigating ways +to support downloading from a subset of the supported dive computers on +Android devices, but this is not yet ready for testing.</p></div> </div> </div> <div class="sect1"> <h2 id="_installing_em_subsurface_mobile_em_on_an_android_device">2. Installing <em>Subsurface-mobile</em> on an Android device</h2> <div class="sectionbody"> -<div class="paragraph"><p>Install <em>Subsurface-mobile</em> from the Google -Play Store. Search for <em>Subsurface-mobile</em> and install it.</p></div> +<div class="paragraph"><p>Find <em>Subsurface-mobile</em> in the <em>Google +Play Store</em>. Search for <em>Subsurface-mobile</em> and install it.</p></div> </div> </div> <div class="sect1"> @@ -503,26 +500,27 @@ Play Store. Search for <em>Subsurface-mobile</em> and install it.</p></div> <div class="sectionbody"> <div class="paragraph"><p>Upon starting <em>Subsurface-mobile</em> for the first time, a Subsurface splash screen is shown while the program loads. On some devices this -may take several seconds. After loading, the <em>landing screen</em> appears -(see image on left, below). There are three options.</p></div> +may take several seconds. After loading, the <em>Cloud Credentials screen</em> appears +(see image below).</p></div> <div class="imageblock" style="text-align:center;"> <div class="content"> <img src="mobile-images/landingscreen.jpg" alt="FIGURE: Mobile landing screen" /> </div> </div> <div class="paragraph"><p>Since <em>Subsurface</em> is largely dependent on a dive log saved on the Internet, -select the top option "Connect to Cloudstorage" and enter an email address -and password for access to the <em>Subsurface</em> Internet storage server. If -you do not have credentials to log in, this is obtained through the -desktop version of <em>Subsurface</em>. When entering a password, it is possible to check +provide a user-ID and password for access to the <em>Subsurface Cloud</em>. These +credentials are obtained by opening the desktop version of <em>Subsurface</em> and +by clicking <em>File → Preferences → Network</em>, explained in detail in the +user manual for the <em>Subsurface</em> desktop version. Once the account has +been created and verified using the desktop version one can use <em>Subsurface-mobile</em>.</p></div> +<div class="paragraph"><p>When entering a password, it is possible to check a checkbox that enables the text of the password to be shown. Checking the check box labelled "Remember" allows <em>Susburface-mobile</em> to keep the -credentials for subsequent logins (see image on right, above). -Having entered the credentials, tap "Save". -<em>Subsurface-mobile</em> attempts to download the existing dive log from the -Internet server. Appropriate messages are shown onscreen. Finally -a list of dives are shown (image on left, below).</p></div> -<div class="paragraph"><p>For the beta release, do not choose the options "Transfer from dive computer" or "Add dive manually"</p></div> +credentials for subsequent logins (see image above). +Having entered the credentials, tap the disk icon at the bottom of the screen. +<em>Subsurface-mobile</em> attempts to download the existing dive log from the_Subsurface_ cloud +server. Appropriate messages are shown onscreen. Finally +a list of dives are shown.</p></div> </div> </div> <div class="sect1"> @@ -530,95 +528,112 @@ a list of dives are shown (image on left, below).</p></div> <div class="sectionbody"> <div class="paragraph"><p>Once the dive list has been downloaded from the Internet, <em>Subsurface-mobile</em> keeps a local -copy on the Android device. This means that, if there is no Internet connection +copy on the mobile device. This means that, if there is no Internet connection at a dive site, one can still access the local copy and view and manipulate dive information. If there is Internet connectivity, <em>Subsurface-mobile</em> accesses the Internet-based dive log to verify that the local copy is still the -same as the Internet-stored copy. If not, the local copy is synchronised with the version on -the Internet.</p></div> +same as the Internet-stored copy. If not, the local copy and the copy on +the server are synchronised.</p></div> </div> </div> <div class="sect1"> -<h2 id="_the_action_button">5. The Action Button</h2> +<h2 id="_a_few_remarks_about_the_user_interface">5. A Few Remarks About The User Interface</h2> <div class="sectionbody"> -<div class="paragraph"><p>At the bottom of of most Subsurface-mobile screens is a round button that provides -information and enables several actions. The Action Button often has one -or more triangular arrow points. Arrows alongside the <em>Action Button</em> indicate -drag movements that are available by dragging the <em>Action Button</em>. Arrows indicate -that one or more <em>Action Screens</em> are available(i.e. menus that become visible as side -panels) On the other hand icons inside the <em>Action Button</em> indicate -specific actions that can be performed by tapping the button. Examples of different -formats of the <em>Action Button</em> are presented in the images below:</p></div> -<div class="admonitionblock"> -<table><tr> -<td class="icon"> -<img src="mobile-images/Left.jpg" alt="Important" /> -</td> -<td class="content">This action button indicates that an <em>Action Panel</em> can be viewed -by dragging the <em>Action Button</em> to the right. Doing this exposes the main <em>Action Panel</em> -that allows many actions with respect to one’s dive log. The different <em>Action Panels</em> -are described below.</td> -</tr></table> -</div> -<div class="admonitionblock"> -<table><tr> -<td class="icon"> -<img src="mobile-images/LeftRight.jpg" alt="Important" /> -</td> -<td class="content">This action button indicates that one of two different <em>Action Panels</em> can be viewed -by dragging the <em>Action Button</em> either to the right or to the left.</td> -</tr></table> -</div> -<div class="admonitionblock"> -<table><tr> -<td class="icon"> -<img src="mobile-images/Edit.jpg" alt="Important" /> -</td> -<td class="content">This action button contains an icon that indicates that, in addition to the drag action -described above, one can edit one or more fields by tapping the <em>Action Button</em>.</td> -</tr></table> -</div> -<div class="admonitionblock"> -<table><tr> -<td class="icon"> -<img src="mobile-images/Quit.jpg" alt="Important" /> -</td> -<td class="content">This action button contains an icon that indicates that, in addition to the drag action -described above, one can abord or an edit of dive data by tapping the <em>Action Button</em>.</td> -</tr></table> +<div class="paragraph"><p>At the bottom of many Subsurface-mobile screens is a round button that provides for +several actions and which allows the selection of the main affirmative action +(see image above and image below). +On Android devices, use the Android Back +button for "cancel", "discard" or "back" actions. For example, when +editing dive information, tapping the action button saves the changes, the +Android back button can be used to cancel the edit without saving changes.</p></div> +<div class="imageblock" style="text-align:center;"> +<div class="content"> +<img src="mobile-images/actionbutton.jpg" alt="FIGURE: Action Button" /> </div> </div> +<div class="paragraph"><p>Instead of the more traditional "hamburger" menu button in the top left or +right corner of the screen to open menus, <em>Subsurface-mobile</em> uses a +different user interaction philosophy based on the Kirigami framework +developed by the Plasma developers. To open the main menu one has +three options:</p></div> +<div class="ulist"><ul> +<li> +<p> +Tap on the right-arrow symbol in the lower left corner of the screen + (easy to reach for hand held devices) +</p> +</li> +<li> +<p> +Swipe towards the right across the left edge of the screen +</p> +</li> +<li> +<p> +Drag the action button visible on most screens with the main action to + the right +</p> +</li> +</ul></div> +<div class="imageblock" style="text-align:center;"> +<div class="content"> +<img src="mobile-images/menu.jpg" alt="FIGURE: Dive management subpanel" /> +</div> +</div> +<div class="paragraph"><p>The images above indicate some of the important features of the menu system. +On the left is the main menu that is activated as described above. In the middle is +the menu that opens if one taps the <em>GPS</em> option on the main menu. On the right is +the menu that opens if one taps the <em>Manage Dives</em> option on the main menu.</p></div> +<div class="paragraph"><p>Similarly, the context menu (currently only available on the dive details screen) can be +opened one of these three ways:</p></div> +<div class="ulist"><ul> +<li> +<p> +Tap on the left-arrow symbol in the lower right corner of the screen +</p> +</li> +<li> +<p> +Swipe to the left across the right edge of the screen +</p> +</li> +<li> +<p> +Drag the action button to the left +</p> +</li> +</ul></div> +</div> </div> <div class="sect1"> <h2 id="_viewing_the_dive_list">6. Viewing the Dive List</h2> <div class="sectionbody"> <div class="paragraph"><p>Most of the actions of <em>Subsurface-mobile</em> center around the dives on the -dive list. One can scroll up and down the dive list. Tapping a dive on -the list brings up a display of <em>Details View</em> for that dive. -This includes the dive profile as well as additional information and notes -(see image on right, below).</p></div> -<div class="paragraph"><p>One can view other dives by swiping the <em>Details view</em> to the right (for the -previous dive) or to the left (following dive).</p></div> +dive list. While the dive list is loading from the cloud, +a message appears at the bottom of the screen, indicating that the cloud is +being accessed (see image on left, below). Once the list is loaded one can scroll up and down. +Tapping a dive on the list brings up a display of <em>Details View</em> for that dive (see image on right below). +This includes the dive profile as well as additional information and notes.</p></div> <div class="imageblock" style="text-align:center;"> <div class="content"> <img src="mobile-images/divelist.jpg" alt="FIGURE: Dive list screen" /> </div> </div> +<div class="paragraph"><p>One can view other dives by swiping the <em>Details view</em> to the right (for the +previous dive) or to the left (following dive).</p></div> </div> </div> <div class="sect1"> <h2 id="_editing_dive_details">7. Editing dive details.</h2> <div class="sectionbody"> -<div class="paragraph"><p>At the bottom of the screen an <em>Action Button</em> -allows aditional actions with respect to a dive that is being shown. In the -details screen (image on right, above) the action button shows a pencil. +<div class="paragraph"><p>At the bottom of the dive details screen the <em>Action Button</em> contains a pencil (image on right, above). Tapping the button brings up a panel with edit boxes that allows one to change the existing dive information, e.g. adding text to the dive notes or changing the names or values of some of the information (see image below). It may be necessary to scroll the window to access all the information. -At the bottom of the edit screen is a "Save" button. Tap this to save +At the bottom of the edit screen is a <em>Save</em> action button. Tap this to save the new information. Having saved the data, the dive list screen is -shown. To cancel any edits, tap the Action Button.</p></div> +updated and shown. To cancel any edits, tap the Android Back Button.</p></div> <div class="imageblock" style="text-align:center;"> <div class="content"> <img src="mobile-images/editdive.jpg" alt="FIGURE: Dive edit screen" /> @@ -627,54 +642,86 @@ shown. To cancel any edits, tap the Action Button.</p></div> </div> </div> <div class="sect1"> -<h2 id="_dive_log_management">8. Dive log management</h2> +<h2 id="_adding_a_new_dive_to_the_dive_list">8. Adding a new dive to the dive list</h2> +<div class="sectionbody"> +<div class="paragraph"><p>It is also possible to add an additional dive to the existing dive list. On the +main menu tap <em>Manage dives → Add dive manually</em>. This opens a screen that is +identical to the editing screen discussed above. When a dive is added manually, one +cannot directly add a dive profile from a dive computer. However, if one does not use a +dive computer, the duration, depth and several other bits of information about +the new dive can be entered. The <em>Action button</em> at the bottom of the screen +contains a disk symbol. Tap this to save the new dive. To cancel any edits, tap the Android Back Button. +The left-hand image below shows a screenshot of a dive being created and the right-hand image shows +the same dive in <em>Details View</em>.</p></div> +<div class="imageblock" style="text-align:center;"> +<div class="content"> +<img src="mobile-images/createdive.jpg" alt="FIGURE: Dive edit screen" /> +</div> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_deleting_a_dive">9. Deleting a dive</h2> <div class="sectionbody"> -<div class="paragraph"><p>A central part of <em>Subsurface-mobile</em> is the ability to store the dive log on the Internet. +<div class="paragraph"><p>The <em>details view</em> of a dive has a context menu on the right-hand side that can be activated as described above +(e.g. by tapping the arrow icon at the bottom right of the screen or by dragging the <em>Action Button</em> to the left). +The context menu has a single item: "Delete dive". If this option is tapped, the dive shown in the <em>Details View</em> +is deleted. One has a brief opportunity to undo the delete by tapping the <em>undo</em> message that appears at the bottom of +the screen. If the <em>undo</em> message is not tapped, the dive is deleted.</p></div> +</div> +</div> +<div class="sect1"> +<h2 id="_dive_log_management">10. Dive log management</h2> +<div class="sectionbody"> +<div class="paragraph"><p>A central part of <em>Subsurface-mobile</em> is the ability to store the dive +log using the <em>Subsurface</em> cloud storage. This provides security against loss or damage to the dive information caintained in a local copy of -the dive log. This ability is accessed throug the Action Panel. Drag the Action Button to the right. -(alternatively tap the Menu button at the top left of the Android screen). -This brings up the Action Panel (image on left, below). Tap the option "Manage dives" (image below in middle).</p></div> +the dive log and allows the desktop version of <em>Subsurface</em> to +access changes made using the mobile device. This ability is accessed +throug the main menu (by dragging the Action Button to the right, or +alternatively tap the right angle button at the bottom left of the screen). + Tap the option <em>Manage dives</em>, enabling a number of options:</p></div> <div class="sect2"> -<h3 id="_upload_dive_log_to_the_internet">8.1. Upload dive log to the Internet</h3> -<div class="paragraph"><p>Assuming that the correct credentials have been specified, one can upload the dives contained on the Androis device -to the Internet by tapping the option "Upload to cloud". This saves the local -copy of the dive log to the cloud.</p></div> +<h3 id="_add_new_dive_manually">10.1. Add new dive manually</h3> +<div class="paragraph"><p>This is described above under the section dealing with the dive list.</p></div> </div> <div class="sect2"> -<h3 id="_download_dive_log_from_the_internet">8.2. Download dive log from the Internet</h3> -<div class="paragraph"><p>In the dive management subpanel, tap the option "Refresh" (image below in middle). This causes -the local divelog to be refreshed from the cloud so that the Internet and local versions are synchronised.</p></div> -<div class="imageblock" style="text-align:center;"> -<div class="content"> -<img src="mobile-images/managedive.jpg" alt="FIGURE: Dive management subpanel" /> -</div> +<h3 id="_upload_dive_log_to_the_em_subsurface_em_cloud_storage">10.2. Upload dive log to the <em>Subsurface</em> cloud storage</h3> +<div class="paragraph"><p>One can upload the dives contained on the mobile device +to the <em>Subsurface</em> cloud storage by tapping the option <em>Upload to cloud</em>. +This synchronizes the local changes to +the dive log with the cloud storage.</p></div> </div> +<div class="sect2"> +<h3 id="_download_dive_log_from_the_cloud_storage">10.3. Download dive log from the cloud storage</h3> +<div class="paragraph"><p>In the dive management subpanel, tap the option <em>Refresh</em>, causing +the local divelog to be refreshed from the cloud so that the cloud +and local versions are synchronised.</p></div> </div> <div class="sect2"> -<h3 id="_add_dive_manually">8.3. Add dive manually</h3> -<div class="paragraph"><p>Dives can easily be entered by hand. This allows one to describe a dive and add it to the dive log. -In the dive management subpanel tap "Add dive manually". The edit screen opens (image above on right). -Fill in all the appropriate information, then tap the "Save" button at the bottom of the screen. It may be -necessary to scroll down to see the "Save" button. The dive is then saved as part of the dive log. In the -details dive view, a profile of the dive is created.</p></div> +<h3 id="_changing_the_login_credentials_on_the_em_subsurface_em_cloud">10.4. Changing the login credentials on the <em>Subsurface</em> cloud</h3> +<div class="paragraph"><p>It may be necessary to change one’s login credentials, for instance if one’s email +address (initially used as a credential) has changed. To change the credentials, +open the main menu and tap <em>Cloud credentials</em>. This opens the setup screen +for specifying new credentials.</p></div> </div> </div> </div> <div class="sect1"> -<h2 id="_recording_dive_locations_using_gps">9. Recording dive locations using GPS.</h2> +<h2 id="_recording_dive_locations_using_gps">11. Recording dive locations using GPS.</h2> <div class="sectionbody"> <div class="paragraph"><p>The fact that most smartphones have GPS facilities allows one to record the locations of dives. One can take the smartphone on the dive boat -during a dive and locations will be automatically recorded at regular intervals.</p></div> +during a dive and locations will be automatically recorded at regular intervals. +These locations can then be applied to dives in the dive list. Here is how it’s done:</p></div> <div class="sect2"> -<h3 id="_setting_up_the_gps">9.1. Setting up the GPS</h3> -<div class="paragraph"><p>Drag the Action Button to the right. This brings up the Action Panel (image -on left, above). Select "Preferences". Now specify the way -in which GPS data need to be automatically collected (image on left, below). One can specify that +<h3 id="_setting_up_the_gps">11.1. Setting up the GPS</h3> +<div class="paragraph"><p>Open the main menu and tap <em>GPS → Preferences</em>. Now specify the way +in which GPS data need to be automatically collected (image on right, below). One can specify that data are collected at regular intervals, e.g. every 10 minutes, or at regular distances, e.g. after the boat has moved more than 200m, or a combination of both of the above approaches. Provide the appropriate information and -tap the "Save" button. The program is now ready to collect GPS positions.</p></div> +tap the <em>Save</em> action button. The program is now ready to collect GPS positions.</p></div> <div class="imageblock" style="text-align:center;"> <div class="content"> <img src="mobile-images/gpssetup.jpg" alt="FIGURE: GPS setup screen" /> @@ -682,47 +729,39 @@ tap the "Save" button. The program is now ready to collect GPS positions.</p></d </div> </div> <div class="sect2"> -<h3 id="_collecting_gps_positions">9.2. Collecting GPS positions</h3> +<h3 id="_collecting_gps_positions">11.2. Collecting GPS positions</h3> <div class="paragraph"><p>Ensure that the GPS on the Android device has been activated. At the bottom -of the Action Panel is a check box "Run location service" (image on right, above). +of the GPS submenu is a check box <em>Run location service</em> (image on left, above). Check this box and <em>Subsurface-mobile</em> starts to collect GPS locations automatically, following the preferences specified as described above. After the dive one can deactivate the collection of GPS data by de-activating -the same check box at the bottom of the Action Panel.</p></div> +the same check box at the bottom of the main menu.</p></div> </div> <div class="sect2"> -<h3 id="_storing_the_gps_data">9.3. Storing the GPS data</h3> -<div class="paragraph"><p>Activate the Action Panel (image on right, above) by drawing the Action Button to the right. -Select the "GPS" option that brings up a submenu of GPS-related actions -(image on left, below). Tap "Upload GPS data" that saves the GPS data -on the <em>Subsurface</em> Internet server. These GPS data are saved separately +<h3 id="_storing_the_gps_data_on_the_em_subsurface_em_cloud">11.3. Storing the GPS data on the <em>Subsurface</em> cloud</h3> +<div class="paragraph"><p>Activate the main menu and select the <em>GPS</em> option that brings up the submenu of GPS-related actions +(image on left, above). Tap <em>Upload GPS data</em> that saves the GPS data +on the <em>Subsurface</em> cloud server. These GPS data are saved <strong>separately</strong> from the other dive log data. All collected GPS data are kept on the Android device, independent of whether they have been uploaded or not.</p></div> </div> <div class="sect2"> -<h3 id="_viewing_gps_data">9.4. Viewing GPS data</h3> -<div class="paragraph"><p>From the GPS submenu (image on left, below) select "Show GPS fixes". This brings +<h3 id="_downloading_gps_data_from_the_em_subsurface_em_cloud">11.4. Downloading GPS data from the <em>Subsurface</em> cloud</h3> +<div class="paragraph"><p>Download the GPS data that have been saved on the cloud by +selecting <em>Download GPS Data</em> from the GPS subpanel.</p></div> +</div> +<div class="sect2"> +<h3 id="_viewing_gps_data">11.5. Viewing GPS data</h3> +<div class="paragraph"><p>From the GPS submenu (image on left, above) select <em>Show GPS fixes</em>. This brings up a list of GPS positions obtained using the location service (image -in middle, below). Two actions are possible for each of the locations, enabled if -one taps the handle (the three horisontal stripes on the right, see image in middle, below) and +on left, below). Two actions are possible for each of the locations, enabled if +one taps the handle (the three horisontal stripes on the right, see image on left, below) and then drags the specific item to the left (image on right, below). This exposes two options. Tapping the dustbin deletes this particular GPS location. Tapping the teardrop-shaped icon (actually a Google Maps pin) opens up Google Maps with a pin -indicating the exact map position of the record being viewed. The two above +indicating the exact map position of the GPS record being viewed. The two above options can be hidden by drawing the GPS record to the right, again using the handle.</p></div> -</div> -</div> -</div> -<div class="sect1"> -<h2 id="_saving_gps_positions_on_the_internet">10. Saving GPS positions on the Internet</h2> -<div class="sectionbody"> -<div class="paragraph"><p>One can save the collected GPS data on the Internet by -selecting "Upload GPS Data" from the GPS submanu (Image on left, below).</p></div> -<div class="sect2"> -<h3 id="_downloading_gps_data_from_the_internet">10.1. Downloading GPS data from the Internet</h3> -<div class="paragraph"><p>One can download the GPS data that have been saved on the Internet by -selecting "Download GPS Data" from the GPS subpanel (Image on left, below).</p></div> <div class="imageblock" style="text-align:center;"> <div class="content"> <img src="mobile-images/gpsmanagement.jpg" alt="FIGURE: GPS management" /> @@ -730,14 +769,14 @@ selecting "Download GPS Data" from the GPS subpanel (Image on left, below).</p>< </div> </div> <div class="sect2"> -<h3 id="_applying_gps_data_to_dives_in_the_dive_log">10.2. Applying GPS data to dives in the dive log</h3> +<h3 id="_applying_gps_data_to_dives_in_the_dive_log">11.6. Applying GPS data to dives in the dive log</h3> <div class="paragraph"><p>Assuming that all the dives have been entered into the dive log or have -been downloaded from the Internet, one can apply the GPS positions to -these dives. GPS positions can therefore only be applied to dives in the dive log. -From the GPS subpanel, tap "Apply GPS fixes" (image on left, above). The dive log contains the start +been downloaded from the <em>Subsurface</em> cloud, one can apply the GPS positions to +these dives. GPS positions can therefore only be applied to dives in the dive list. +From the GPS subpanel, tap <em>Apply GPS fixes</em>. The dive list contains the start and end times of each dive. Now, <em>Subsurface-mobile</em> applies the first GPS position that falls within the dive period of each dive. This results -in a GPS position for each dive that is saved as part of the dive log.</p></div> +in a GPS position for each dive that is saved as part of the dive list.</p></div> </div> </div> </div> @@ -746,7 +785,7 @@ in a GPS position for each dive that is saved as part of the dive log.</p></div> <div id="footer"> <div id="footer-text"> Last updated - 2016-02-09 12:16:22 SAST + 2016-03-09 15:36:14 SAST </div> </div> </body> diff --git a/Documentation/mobile-manual.txt b/Documentation/mobile-manual.txt index 001ac0020..67e06a1c7 100644 --- a/Documentation/mobile-manual.txt +++ b/Documentation/mobile-manual.txt @@ -21,51 +21,51 @@ toc::[] [blue]#_Beta release, March 2016_# -IMPORTANT: For this BETA release it is critical that users report any problems -with the use of the mobile software. After all, one of the objectives -of a beta release is to distribute the software to a broader circle -of users using different Android devices and configurations in order to -iron out any bugs, errors or inconsistencies. Please report -such issues by email to subsurface@subsurface-divelog.org - -Welcome as a user of _Subsurface_, an advanced dive logging program for -desktop and laptop computers with +//IMPORTANT: For this BETA release it is critical that users report any problems +//with the use of the mobile software. After all, one of the objectives +//of a beta release is to distribute the software to a broader circle +//of users using different Android devices and configurations in order to +//iron out any bugs, errors or inconsistencies. Please report +//such issues by email to subsurface@subsurface-divelog.org + +Welcome as a user of _Subsurface_, advanced dive logging software with extensive infrastructure to describe, organize, interpret and print scuba and free dives. _Subsurface_ offers many advantages over other similar -software solutions, including compatibility with Windows, Mac-OS/X, and Linux (many -distributions). _Subsurface_ allows downloading dive -information from most dive computers. _Subsurface_ software is open-source. +software solutions, including compatibility with Windows, Mac-OS/X, Linux (many +distributions) and Android (iOS under development). In addition, _Subsurface_ is +open-source software that allows downloading dive +information from most dive computers. Introducing Subsurface-mobile ----------------------------- -_Subsurface-mobile_ is an extension of _Subsurface_ which runs on Android -smartphone and tablet devices and is a tool for viewing or sharing dive -information at dive sites. It also allows +_Subsurface-mobile_ is an extension of _Subsurface_ on laptop and +tabletop computers. It runs on Android smartphone and tablet devices and is a +tool for viewing or sharing dive information at dive sites where a larger +computer is not useful. _Subsurface-mobile_ also allows the gathering of GPS locations where dives are performed. A version of _Subsurface-mobile_ for iOS is under development but not yet ready for testing. -While _Subsurface-mobile_ allows you to enter and save dive information -on a mobile device, at this point it is designed as -an extension of the laptop/desktop version of _Subsurface_. -To make this possible, you need to store your dive logs in the -_Subsurface_ cloud storage on the Internet, which then makes it possible -to share the dive log between the Android version and the desktop version. +While _Subsurface-mobile_ allows one to enter and save dive information +using an Android device, users of _Subsurface-mobile_ typically use the +mobile app as an extension of the laptop/desktop version of _Subsurface_. +This allows the storage of dive logs on the Internet and which +can be shared by the Android version as well as the desktop version. While the desktop version of _Subsurface_ shows much more detailed information -for each dive, the mobile version allows you to have a more accessible dive log +for each dive, the mobile version allows one to have a more accessible dive log on a dive trip, useful for proving dive experience to dive shops or to review previous dives. -_Subsurface-mobile_ allows you to: +_Subsurface-mobile_ allows one to: -- Download existing dive log information from _Subsurface_ cloud storage. -- View this information on an mobile device. +- Download existing dive log information from the Internet. +- View this information on an Android device. - Edit many of the dive log data fields, e.g. divemaster, buddy, equipment or notes about a dive. -- Manually add new dive records to your dive log. -- Store the updated dive log in the Subsurface cloud. +- Create and add new dive records to one's dive log. +- Store the updated dive log on the Internet. - Record, store and apply GPS positions of dives. - View the localities of recorded GPS positions and of dives on a map. @@ -79,43 +79,35 @@ Android devices, but this is not yet ready for testing. == Installing _Subsurface-mobile_ on an Android device -Install _Subsurface-mobile_ from the Google -Play Store. Search for _Subsurface-mobile_ and install it. - -For the Beta version you still need to opt-in to the beta test at -https://play.google.com/apps/testing/org.subsurfacedivelog.mobile -This will no longer be necessary once the first release has been published -to the play store. +Find _Subsurface-mobile_ in the _Google +Play Store_. Search for _Subsurface-mobile_ and install it. == Using _Subsurface-mobile_ for the first time Upon starting _Subsurface-mobile_ for the first time, a Subsurface -splash screen is shown while the program loads. This -may take several seconds. After loading, the _landing screen_ appears -(see image on left, below). +splash screen is shown while the program loads. On some devices this +may take several seconds. After loading, the _Cloud Credentials screen_ appears +(see image below). image::mobile-images/landingscreen.jpg["FIGURE: Mobile landing screen",align="center"] -Since _Subsurface-mobile_ is largely dependent on a dive log saved in the -_Subsurface_ cloud storage, the first step is connecting to your cloud -storage. Please note that you need to set up your cloud cloud storage -credentials from the full _Subsurface_ application on your desktop or -laptop. Only once the account has been created and verified from there -will you be able to use _Subsurface-mobile_. - -Enter the email address and password that you used when creating your -_Subsurface_ cloud storage account. To make it easier to type in the -password correctly, you can make it visible by checking the corresponding -box. +Since _Subsurface_ is largely dependent on a dive log saved on the Internet, +provide a user-ID and password for access to the _Subsurface Cloud_. These +credentials are obtained by opening the desktop version of _Subsurface_ and +by clicking _File -> Preferences -> Network_, explained in detail in the +user manual for the _Subsurface_ desktop version. Once the account has +been created and verified using the desktop version one can use _Subsurface-mobile_. -Checking the +When entering a password, it is possible to check +a checkbox that enables the text of the password to be shown. Checking the check box labelled "Remember" allows _Susburface-mobile_ to keep the -credentials for subsequent logins (see image on right, above). -Having entered the credentials, tap the "Save" button and the bottom of -the screen. -_Subsurface-mobile_ attempts to download the existing dive log from the -_Subsurface_ cloud storage. Appropriate messages are shown onscreen. Finally -a list of dives are shown (image on left, below). +credentials for subsequent logins (see image above). +Having entered the credentials, tap the disk icon at the bottom of the screen. +_Subsurface-mobile_ attempts to download the existing dive log from the_Subsurface_ cloud +server. Appropriate messages are shown onscreen. Finally +a list of dives are shown. + +//For the beta release, do not choose the options "Transfer from dive computer" or "Add dive manually" == Local copy of the dive log and synchronisation with Internet @@ -130,163 +122,188 @@ the server are synchronised. == A Few Remarks About The User Interface +At the bottom of many Subsurface-mobile screens is a round button that provides for +several actions and which allows the selection of the main affirmative action +(see image above and image below). +On Android devices, use the Android Back +button for "cancel", "discard" or "back" actions. For example, when +editing dive information, tapping the action button saves the changes, the +Android back button can be used to cancel the edit without saving changes. + +image::mobile-images/actionbutton.jpg["FIGURE: Action Button",align="center"] + Instead of the more traditional "hamburger" menu button in the top left or -right corner of the screen to open menues, _Subsurface-mobile_ uses a +right corner of the screen to open menus, _Subsurface-mobile_ uses a different user interaction philosophy based on the Kirigami framework -developed by the Plasme developers. In order to open the main menu you -have three options: +developed by the Plasma developers. To open the main menu one has +three options: -- Tap on the right angle symbol in the lower left corner of the screen - (easy to reach when holding your device in your hand) -- Swipe across the left edge of the screen from the outside +- Tap on the right-arrow symbol in the lower left corner of the screen + (easy to reach for hand held devices) +- Swipe towards the right across the left edge of the screen - Drag the action button visible on most screens with the main action to the right -Similarly, the context menu (only available on a few screens) can be -opened one of these three ways: +image::mobile-images/menu.jpg["FIGURE: Dive management subpanel",align="center"] -- Tap on the left angle symbol in the lower right corner of the screen -- Swipe across the right edge of the screen from the outside -- Drag the action button to the left - -== The Action Button +The images above indicate some of the important features of the menu system. +On the left is the main menu that is activated as described above. In the middle is +the menu that opens if one taps the _GPS_ option on the main menu. On the right is +the menu that opens if one taps the _Manage Dives_ option on the main menu. -At the bottom of of most Subsurface-mobile screens is a round button that provides -the main, affirmative action. On Android devices, use the Android Back -button for "cancel", "discard" or "back" actions. For example, when -editing dive information, tapping the action button saves the changes, the -Android back button can be used to cancel the edit without saving changes. +Similarly, the context menu (currently only available on the dive details screen) can be +opened one of these three ways: +- Tap on the left-arrow symbol in the lower right corner of the screen +- Swipe to the left across the right edge of the screen +- Drag the action button to the left == Viewing the Dive List Most of the actions of _Subsurface-mobile_ center around the dives on the -dive list. One can scroll up and down the dive list. Tapping a dive on -the list brings up a display of _Details View_ for that dive. -This includes the dive profile as well as additional information and notes -(see image on right, below). +dive list. While the dive list is loading from the cloud, +a message appears at the bottom of the screen, indicating that the cloud is +being accessed (see image on left, below). Once the list is loaded one can scroll up and down. +Tapping a dive on the list brings up a display of _Details View_ for that dive (see image on right below). +This includes the dive profile as well as additional information and notes. + +image::mobile-images/divelist.jpg["FIGURE: Dive list screen",align="center"] One can view other dives by swiping the _Details view_ to the right (for the previous dive) or to the left (following dive). -image::mobile-images/divelist.jpg["FIGURE: Dive list screen",align="center"] - == Editing dive details. -At the bottom of the screen an _Action Button_ -allows aditional actions with respect to a dive that is being shown. In the -details screen (image on right, above) the action button shows a pencil. +At the bottom of the dive details screen the _Action Button_ contains a pencil (image on right, above). Tapping the button brings up a panel with edit boxes that allows one to change the existing dive information, e.g. adding text to the dive notes or changing the names or values of some of the information (see image below). It may be necessary to scroll the window to access all the information. -At the bottom of the edit screen is a "Save" button. Tap this to save +At the bottom of the edit screen is a _Save_ action button. Tap this to save the new information. Having saved the data, the dive list screen is -shown. To cancel any edits, tap the Android Back Button. +updated and shown. To cancel any edits, tap the Android Back Button. image::mobile-images/editdive.jpg["FIGURE: Dive edit screen",align="center"] +== Adding a new dive to the dive list + +It is also possible to add an additional dive to the existing dive list. On the +main menu tap _Manage dives -> Add dive manually_. This opens a screen that is +identical to the editing screen discussed above. When a dive is added manually, one +cannot directly add a dive profile from a dive computer. However, if one does not use a +dive computer, the duration, depth and several other bits of information about +the new dive can be entered. The _Action button_ at the bottom of the screen +contains a disk symbol. Tap this to save the new dive. To cancel any edits, tap the Android Back Button. +The left-hand image below shows a screenshot of a dive being created and the right-hand image shows +the same dive in _Details View_. + +image::mobile-images/createdive.jpg["FIGURE: Dive edit screen",align="center"] + +== Deleting a dive + +The _details view_ of a dive has a context menu on the right-hand side that can be activated as described above +(e.g. by tapping the arrow icon at the bottom right of the screen or by dragging the _Action Button_ to the left). +The context menu has a single item: "Delete dive". If this option is tapped, the dive shown in the _Details View_ +is deleted. One has a brief opportunity to undo the delete by tapping the _undo_ message that appears at the bottom of +the screen. If the _undo_ message is not tapped, the dive is deleted. + == Dive log management A central part of _Subsurface-mobile_ is the ability to store the dive -log in the _Subsurface_ cloud storage. +log using the _Subsurface_ cloud storage. This provides security against loss or damage to the dive information caintained in a local copy of -the dive log and allows to access any changes made on the mobile device -from _Subsurface_ on your desktop or laptop. This ability is accessed -throug the main menu. Drag the Action Button to the right, or -alternatively tap the right angle button at the bottom left of the screen. -This brings up the Action Panel (image on left, below). Tap the option "Manage dives" (image below in middle). +the dive log and allows the desktop version of _Subsurface_ to +access changes made using the mobile device. This ability is accessed +throug the main menu (by dragging the Action Button to the right, or +alternatively tap the right angle button at the bottom left of the screen). + Tap the option _Manage dives_, enabling a number of options: + +=== Add new dive manually + +This is described above under the section dealing with the dive list. === Upload dive log to the _Subsurface_ cloud storage -You can simply upload the dives contained on the mobile device -to the _Subsurface_ cloud storage by tapping the option "Upload to cloud". +One can upload the dives contained on the mobile device +to the _Subsurface_ cloud storage by tapping the option _Upload to cloud_. This synchronizes the local changes to the dive log with the cloud storage. -=== Download dive log from the Internet - -In the dive management subpanel, tap the option "Refresh" (image below in middle). This causes -the local divelog to be refreshed from the cloud so that the Internet and local versions are synchronised. +=== Download dive log from the cloud storage +In the dive management subpanel, tap the option _Refresh_, causing +the local divelog to be refreshed from the cloud so that the cloud +and local versions are synchronised. -image::mobile-images/managedive.jpg["FIGURE: Dive management subpanel",align="center"] +=== Changing the login credentials on the _Subsurface_ cloud -=== Add dive manually +It may be necessary to change one's login credentials, for instance if one's email +address (initially used as a credential) has changed. To change the credentials, +open the main menu and tap _Cloud credentials_. This opens the setup screen +for specifying new credentials. -Dives can easily be entered by hand. This allows one to describe a dive and add it to the dive log. -In the dive management subpanel tap "Add dive manually". The edit screen opens (image above on right). -Fill in all the appropriate information, then tap the "Save" button at the bottom of the screen. -The dive is then saved as part of the dive log. In the -details dive view, a profile of the dive is created. == Recording dive locations using GPS. The fact that most smartphones have GPS facilities allows one to record the locations of dives. One can take the smartphone on the dive boat during a dive and locations will be automatically recorded at regular intervals. +These locations can then be applied to dives in the dive list. Here is how it's done: === Setting up the GPS -Drag the Action Button to the right. This brings up the Action Panel (image -on left, above). Select "Preferences". Now specify the way -in which GPS data need to be automatically collected (image on left, below). One can specify that +Open the main menu and tap _GPS -> Preferences_. Now specify the way +in which GPS data need to be automatically collected (image on right, below). One can specify that data are collected at regular intervals, e.g. every 10 minutes, or at regular distances, e.g. after the boat has moved more than 200m, or a combination of both of the above approaches. Provide the appropriate information and -tap the "Save" button. The program is now ready to collect GPS positions. +tap the _Save_ action button. The program is now ready to collect GPS positions. image::mobile-images/gpssetup.jpg["FIGURE: GPS setup screen",align="center"] === Collecting GPS positions Ensure that the GPS on the Android device has been activated. At the bottom -of the Action Panel is a check box "Run location service" (image on right, above). +of the GPS submenu is a check box _Run location service_ (image on left, above). Check this box and _Subsurface-mobile_ starts to collect GPS locations automatically, following the preferences specified as described above. After the dive one can deactivate the collection of GPS data by de-activating -the same check box at the bottom of the Action Panel. +the same check box at the bottom of the main menu. -=== Storing the GPS data +=== Storing the GPS data on the _Subsurface_ cloud -Activate the Action Panel (image on right, above) by drawing the Action Button to the right. -Select the "GPS" option that brings up a submenu of GPS-related actions -(image on left, below). Tap "Upload GPS data" that saves the GPS data -on the _Subsurface_ Internet server. These GPS data are saved separately +Activate the main menu and select the _GPS_ option that brings up the submenu of GPS-related actions +(image on left, above). Tap _Upload GPS data_ that saves the GPS data +on the _Subsurface_ cloud server. These GPS data are saved *separately* from the other dive log data. All collected GPS data are kept on the Android device, independent of whether they have been uploaded or not. +=== Downloading GPS data from the _Subsurface_ cloud + +Download the GPS data that have been saved on the cloud by +selecting _Download GPS Data_ from the GPS subpanel. + === Viewing GPS data -From the GPS submenu (image on left, below) select "Show GPS fixes". This brings +From the GPS submenu (image on left, above) select _Show GPS fixes_. This brings up a list of GPS positions obtained using the location service (image -in middle, below). Two actions are possible for each of the locations, enabled if -one taps the handle (the three horisontal stripes on the right, see image in middle, below) and +on left, below). Two actions are possible for each of the locations, enabled if +one taps the handle (the three horisontal stripes on the right, see image on left, below) and then drags the specific item to the left (image on right, below). This exposes two options. Tapping the dustbin deletes this particular GPS location. Tapping the teardrop-shaped icon (actually a Google Maps pin) opens up Google Maps with a pin -indicating the exact map position of the record being viewed. The two above +indicating the exact map position of the GPS record being viewed. The two above options can be hidden by drawing the GPS record to the right, again using the handle. -== Saving GPS positions on the Internet - -One can save the collected GPS data on the Internet by -selecting "Upload GPS Data" from the GPS submanu (Image on left, below). - -=== Downloading GPS data from the Internet - -One can download the GPS data that have been saved on the Internet by -selecting "Download GPS Data" from the GPS subpanel (Image on left, below). - image::mobile-images/gpsmanagement.jpg["FIGURE: GPS management",align="center"] === Applying GPS data to dives in the dive log Assuming that all the dives have been entered into the dive log or have -been downloaded from the Internet, one can apply the GPS positions to -these dives. GPS positions can therefore only be applied to dives in the dive log. -From the GPS subpanel, tap "Apply GPS fixes" (image on left, above). The dive log contains the start +been downloaded from the _Subsurface_ cloud, one can apply the GPS positions to +these dives. GPS positions can therefore only be applied to dives in the dive list. +From the GPS subpanel, tap _Apply GPS fixes_. The dive list contains the start and end times of each dive. Now, _Subsurface-mobile_ applies the first GPS position that falls within the dive period of each dive. This results -in a GPS position for each dive that is saved as part of the dive log. +in a GPS position for each dive that is saved as part of the dive list. |
