mifr/subsurface
1
0
Fork 0
mirror of https://github.com/subsurface/subsurface.git synced 2025-02-19 22:16:15 +00:00
Code Issues Projects Releases Packages Wiki Activity

Mobile user-manual: Add text that explains action button

Browse source 
4 small images added.

     Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>

From 43f260e7aa2be9af43c9250f75cad05a141f9d1e Mon Sep 17 00:00:00 2001
From: Willem Ferguson <willemferguson@zoology.up.ac.za>
Date: Tue, 9 Feb 2016 12:25:24 +0200
Subject: [PATCH 2/2] [PATCH] Mobile user-manual: add section explaining action
 button

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
This commit is contained in:
Willem Ferguson 2016-02-09 12:28:11 +02:00 • committed by Dirk Hohndel
parent 87f62dfaa8
commit bc84d280b8
6 changed files with 101 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

BIN
Documentation/mobile-images/Edit.jpg Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 1.5 KiB

BIN
Documentation/mobile-images/Left.jpg Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 1.1 KiB

BIN
Documentation/mobile-images/LeftRight.jpg Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 1.3 KiB

BIN
Documentation/mobile-images/Quit.jpg Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 1.5 KiB

81
Documentation/mobile-manual.html
View file

@ -539,7 +539,58 @@ the Internet.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_viewing_the_dive_list">5. Viewing the Dive List</h2>
<h2 id="_the_action_button">5. The Action Button</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&#8217;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>
</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
@ -556,7 +607,7 @@ previous dive) or to the left (following dive).</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_editing_dive_details">6. Editing dive details.</h2>
<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
@ -576,7 +627,7 @@ shown. To cancel any edits, tap the Action Button.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_dive_log_management">7. Dive log management</h2>
<h2 id="_dive_log_management">8. 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 on the Internet.
This provides security against loss or damage to the dive information caintained in a local copy of
@ -584,13 +635,13 @@ the dive log. This ability is accessed throug the Action Panel. Drag the Action
(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>
<div class="sect2">
<h3 id="_upload_dive_log_to_the_internet">7.1. Upload dive log to the Internet</h3>
<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>
</div>
<div class="sect2">
<h3 id="_download_dive_log_from_the_internet">7.2. Download dive log from the Internet</h3>
<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;">
@ -600,7 +651,7 @@ the local divelog to be refreshed from the cloud so that the Internet and local
</div>
</div>
<div class="sect2">
<h3 id="_add_dive_manually">7.3. Add dive manually</h3>
<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
@ -610,13 +661,13 @@ details dive view, a profile of the dive is created.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_recording_dive_locations_using_gps">8. Recording dive locations using GPS.</h2>
<h2 id="_recording_dive_locations_using_gps">9. 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>
<div class="sect2">
<h3 id="_setting_up_the_gps">8.1. Setting up the GPS</h3>
<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
@ -631,7 +682,7 @@ 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">8.2. Collecting GPS positions</h3>
<h3 id="_collecting_gps_positions">9.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).
Check this box
@ -641,7 +692,7 @@ 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>
</div>
<div class="sect2">
<h3 id="_storing_the_gps_data">8.3. Storing the GPS data</h3>
<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
@ -650,7 +701,7 @@ 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">8.4. Viewing GPS data</h3>
<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
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
@ -664,12 +715,12 @@ options can be hidden by drawing the GPS record to the right, again using the ha
</div>
</div>
<div class="sect1">
<h2 id="_saving_gps_positions_on_the_internet">9. Saving GPS positions on the Internet</h2>
<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">9.1. Downloading GPS data from the Internet</h3>
<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;">
@ -679,7 +730,7 @@ 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">9.2. Applying GPS data to dives in the dive log</h3>
<h3 id="_applying_gps_data_to_dives_in_the_dive_log">10.2. 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.
@ -695,7 +746,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-08 08:02:33 SAST
2016-02-09 12:16:22 SAST
</div>
</div>
</body>

35
Documentation/mobile-manual.txt
View file

@ -105,6 +105,41 @@ 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.
== The Action Button
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 _Action Button_ indicate
drag movements that are available by dragging the _Action Button_. Arrows indicate
that one or more _Action Screens_ are available(i.e. menus that become visible as side
panels) On the other hand icons inside the _Action Button_ indicate
specific actions that can be performed by tapping the button. Examples of different
formats of the _Action Button_ are presented in the images below:
[icon="mobile-images/Left.jpg"]
[IMPORTANT]
This action button indicates that an _Action Panel_ can be viewed
by dragging the _Action Button_ to the right. Doing this exposes the main _Action Panel_
that allows many actions with respect to one's dive log. The different _Action Panels_
are described below.
[icon="mobile-images/LeftRight.jpg"]
[IMPORTANT]
This action button indicates that one of two different _Action Panels_ can be viewed
by dragging the _Action Button_ either to the right or to the left.
[icon="mobile-images/Edit.jpg"]
[IMPORTANT]
This action button contains an icon that indicates that, in addition to the drag action
described above, one can edit a dive by tapping the _Action Button_.
[icon="mobile-images/Quit.jpg"]
[IMPORTANT]
This action button contains an icon that indicates that, in addition to the drag action
described above, one can abord an edit of dive data by tapping the _Action Button_.
== Viewing the Dive List
Most of the actions of _Subsurface-mobile_ center around the dives on the