From 76dc36ddae94a99140a886cc5d7832bbbf52905f Mon Sep 17 00:00:00 2001 From: Dirk Hohndel Date: Wed, 25 Mar 2020 13:19:01 -0700 Subject: mobile/user-manual: update bundled html Signed-off-by: Dirk Hohndel --- Documentation/mobile-manual-v3.html.git | 189 +++++++++++++++----------------- 1 file changed, 87 insertions(+), 102 deletions(-) (limited to 'Documentation') diff --git a/Documentation/mobile-manual-v3.html.git b/Documentation/mobile-manual-v3.html.git index f6c0a43bf..2a1445d73 100644 --- a/Documentation/mobile-manual-v3.html.git +++ b/Documentation/mobile-manual-v3.html.git @@ -415,24 +415,23 @@ asciidoc.install(3);

1. Introducing Subsurface-mobile

Welcome to Subsurface-mobile, the mobile version of Subsurface, advanced dive logging -software with extensive infrastructure to describe, organize, and interpret scuba +software with extensive infrastructure to display, organize, and interpret scuba and free dives. Subsurface runs on Windows, macOS, most common distributions of Linux. Subsurface-mobile is available for Android and iOS. Both are open-source software (in simple terms that means that there is no commercial interest behind -them, all the sources code needed to build them is available, there are no ads, no one is +them, all the source code needed to build them is available, there are no ads, no one is monetizing your data, etc).

-

Subsurface-mobile is a limited mobile version of Subsurface +

Subsurface-mobile is a limited mobile version of Subsurface, aimed at Android and iOS smartphone and tablet devices. While the desktop version of Subsurface shows much more detailed information -for each dive, the mobile version allows a more accessible dive log on the go, for example -on a dive trip, useful for proving dive experience to dive shops or to review -previous dives. Subsurface-mobile also allows +for each dive, the mobile version allows a more accessible dive log on the go. For example, +you can prove dive experience on a dive trip to dive shops or review +previous dives while on a dive boat. Subsurface-mobile also allows the gathering of GPS locations where dives are performed. Assuming you have a dive computer that is supported by the mobile OS of -your choice, Subsurface-mobile even supports the downloading of dive -information.

+your choice, Subsurface-mobile even supports the downloading of dives from your dive computer.

Users of Subsurface-mobile typically use the -mobile app together with the desktop version of Subsurface, sharing dive information +mobile app together with the desktop version of Subsurface, sharing dive information between the mobile and the desktop versions using a free Subsurface Cloud account. However Subsurface-mobile can also be used independently of the desktop version and does not require the use of cloud storage.

@@ -466,7 +465,7 @@ Editing most of the dive log data, e.g. dive-master, buddy,

  • -Recording, storing and applying GPS positions of dives. +Recording, storing and applying GPS positions to dives.

  • @@ -476,14 +475,14 @@ Viewing the locations of recorded GPS positions and of dives

    • -

    These items are discussed in greater detail in the following text.

    +

    These items are discussed in greater detail in the following chapters.

    Subsurface-mobile has some limitations compared to Subsurface:

    • Only a subset of the dive computers supported for download by the desktop version work with Subsurface-mobile. This limitation is -mainly caused by hardware and OS limitations in the two +mainly caused by hardware and OS limitations in the two mobile platforms. On Android, a subset of dive computers that use USB serial cables or a Bluetooth / Bluetooth LE interface are accessible by Subsurface-mobile. On iOS, only Bluetooth LE based @@ -502,7 +501,7 @@ No printing.

    • -No support for media embedded in dive profiles (Subsurface allows to refernce images and video clips directly in the dive profile). +No support for media embedded in dive profiles (Subsurface allows to reference images and video clips directly in the dive profile).

    @@ -511,7 +510,7 @@ No support for media embedded in dive profiles (Subsurface allows to re

    2. Installing Subsurface-mobile on your mobile device

    -

    Find Subsurface-mobile in the Google Play Store or the iTunes Store +

    Find Subsurface-mobile in the Google Play Store or the Apple App Store and install it. For Android devices without access to the Google Play Store APKs can be found in the downloads folder on the Subsurface website.

    @@ -519,9 +518,9 @@ APKs can be found in the downloads folder on the Subsurface website.

    3. Getting Support

    -

    The best place to get support is the Subsurface User Forum. Additionally, Subsurface-mobile allows +

    The best place to get support is the Subsurface User Forum. Additionally, Subsurface-mobile allows you to send a support email by tapping on Ask for support in the Help menu. This will open an -email to our in app support address in the native email client, including the relevant logs.

    +email to our in-app-support address in the native email client, including the relevant logs.

    @@ -533,14 +532,14 @@ This user interface has a slightly different look and feel than many native Andr but we (the developers) feel that it is very easy and intuitive to work with.

    On every screen you have access to the Main menu through a Hamburger button (three short horizontal lines) in the lower left corner. Additionally, the Main menu can be opened by swiping -towards the the right across the left edge of the screen. The entries in the main menu are all explain -starting in section Dive Management

    +towards the right from the very left edge of the screen. The entries in the main menu are all explained +starting in section Dive Management.

    On many pages there is also a Context menu available through a button with three vertical dots in the lower right corner. In the dive list this Context menu can also be opened by tapping and holding a dive or trip header.

    -FIGURE: Action Button +FIGURE: Action Button

    Additionally, at the bottom of many Subsurface-mobile screens is a round @@ -555,10 +554,10 @@ editing dive information, tapping the action button saves the changes while the Android back button can be used to cancel the edit without saving changes.

    The image below indicates some of the important features of the menu system. On the left is the main menu, activated as described above. On the right of the image -are the items of all the sub-menus accessible.

    +are the items of all the sub-menus available.

    -FIGURE: Subsurface-mobile menu system +FIGURE: Subsurface-mobile menu system

    All screenshots in this user manual are currently from the Android @@ -571,7 +570,7 @@ version. The iOS screens look similar.

    When you start Subsurface-mobile for the first time, a Subsurface splash screen is shown while the program loads. On some devices this may take several seconds. Afterwards the Cloud Credentials screen appears -m(see image below on left).

    +(see left image below).

    FIGURE: Mobile credentials screen @@ -588,16 +587,16 @@ on your device. After the first start the dive log will therefore be empty.

    < free Internet cloud storage account for users of Subsurface and Subsurface-mobile. You can use this to store your dive log and to share your data between various computers and devices. The Subsurface team never accesses your dive data without explicit -permission to do so, the data are not used for any purpose other than providing them to the user who +permission to do so, the data are not used for any other purpose than providing them to the user who created them. There are no ads and no harvesting / analysis of the data stored in the Subsurface Cloud storage. There is no monetization whatsoever.

    -

    Subsurface-mobile is sufficient to do full maintenance of a dive log. In addition you can use the +

    Subsurface-mobile is sufficient to fully maintain a dive log. In addition you can use the more advanced features in Subsurface when you have access to a computer while still being able to work with your dive data when only a mobile device is available.

    The dive data in the cloud are cached locally on any device or computer that is connected to the Subsurface Cloud account. -It is easy to create backups of the data (for example in XML format) on the desktop: both mobile -device and desktop keep a local copy of the data so that the dive log is always accessible, even +It is easy to create backups of the data (for example in XML format) on the desktop: both the mobile +device and the desktop keep a local copy of the data so that the dive log is always accessible, even without Internet connection.

    To create a Subsurface Cloud account follow these steps:

    1) Enter an e-mail address and a password in the fields indicated on the screen (see image above). @@ -612,11 +611,11 @@ copy on the mobile device. This avoids long delays or even failure of operations (or no) internet connection, a situation fairly common at many dive sites. Remember to manually sync with the server after making local changes (either by pulling down on the dive list, or by using the manual sync entry in the Dive management menu entry).

    -

    3) If this is a new cloud account, a PIN screen will open (see image on right, above). A PIN is e-mailed +

    3) If this is a new cloud account, a PIN screen will open (see right image above). A PIN is e-mailed to the email address entered in the previous step. Enter this PIN into the field indicated and tap the Register button. After the PIN has been entered it is no longer needed - it just proves that this is indeed your email account.

    -

    At this point a new account for you has been created on the cloud server and access to the cloud is +

    At this point a new account has been created for you on the cloud server and access to the cloud is enabled. In this case the dive list is initially empty. Start entering dives in the dive log or download dive information from a supported dive computer.

    Once registered, Subsurface-mobile remembers the cloud credentials and it is not necessary to @@ -635,12 +634,12 @@ provide these again when launching the program.

    1. -Check carefully that didn’t make a spelling mistake in the email address you provided. You would be surprised how often this is the problem that people encouter, as autocorrect often mangles email addresses. +Check carefully that you didn’t make a spelling mistake in the email address you provided. You would be surprised how often this is the problem that people encounter, as autocorrect often mangles email addresses.

    2. -Check that the return email containing the PIN is not in the SPAM folder of your email client. +Check that the return email containing the PIN is not in the SPAM/Junk folder of your email client.

    3. @@ -655,7 +654,8 @@ If there is still no email containing a PIN, send mail to

      I want to access the Subsurface Cloud storage but I have forgotten my password. How can I reset my password?

    -

    There is a Reset forgotten Subsurface Cloud password entry in the Help menu in Subsurface-mobile, or you can go to the following web address: https://cloud.subsurface-divelog.org/passwordreset

    +

    There is a Reset forgotten Subsurface Cloud password entry in the Help menu in +Subsurface-mobile, or you can go to the password reset website

    Simply enter the same email address that you used during cloud registration and follow the indicated steps. A confirmation email will be sent to your account to prevent abuse of this system.

    @@ -688,7 +688,7 @@ for that dive including the dive profile, notes, and additional information.

    For a dive this allows moving the dive into or out of trips or between trips, deleting the dive or showing the dive on an integrated map viewer (assuming the dive has the necessary GPS information). The context menu also allows access to the undo and redo -system that allows you to step backwards and forwards through recent actions.

    +system that allows you to step backwards and forwards through recent changes.

    For a trip header the context menu gives you an option to edit the trip title (typically the trip location) and some quick notes for the trip.

    @@ -714,18 +714,18 @@ dive list.

    6.2. View a dive

    When you tap on a dive in the Dive List, a Dive Details page with the dive profile -and many important details about the dive is opened. You can use a pich gesture -to zoom into the profile, and tapping with one finger, waiting briefly until -the profile becomes translucent, and then dragging the finger around allows you +and many important details about the dive is opened. You can use a pinch gesture +to zoom into the profile. Tapping and holding with one finger (until +the profile becomes translucent) allows you to pan the profile and see more details in specific parts of the profile.

    You can view other dives by swiping the Details view to the right (for the -previous dive) or to the left (following dive). -Using the Action Bar, it is also possible to delete the dive (tap the dustbin +previous dive) or to the left (next dive). +Using the Action Bar, it is also possible to delete the dive (tap the Trash Icon on the Action Bar) or to view the dive location on an integrated map viewer.

    The context menu (accessible by tapping on the vertical three dots in the lower right corner of the screen) offers additional options to move dives between trips, the same delete and map options already mentioned, and access to the undo and redo facility that allows you to step backwards and -forwards through recent actions.

    +forwards through recent changes.

    6.3. Viewing the location of a dive on a map

    @@ -746,14 +746,14 @@ The dive site is shown in an integrated map viewer.

    FIGURE: Dive edit screen -

    At the bottom of the Dive Details screen the action button is a pencil. -Tapping the pencil button changes the page and enables edit boxes that allow -modifying the existing dive information, e.g. adding text to the dive notes +

    At the bottom of the Dive Details screen, the action button is a pencil. +Tapping the pencil button changes the page and enables editing +the dive details, e.g. adding text to the dive notes or changing the names or values of some of the information (see image on left). -It may be necessary to scroll the window to access all the information. +It may be necessary to scroll the window to access all the available fields. At the bottom of the edit screen is a Save action button. Tap this to save the new information, after which the dive list screen is -updated and shown. To cancel any edits, tap the Android Back Button or +updated and displayed. To cancel any edits, tap the Android Back Button or the application back button at the top left of the screen on iOS.

    @@ -771,20 +771,20 @@ side of the Action Button

    -

    7. Dive Managent

    +

    7. Dive Management

    A central part of Subsurface-mobile is the ability to store the dive log using the Subsurface cloud storage. This provides security against loss or damage of the dive information in a local copy and allows the desktop version of Subsurface to -access changes made using the mobile device. This ability is accessed +access changes made using the mobile device. This feature is accessed through the Dive management option in the main menu.

    7.1. Manually adding a new dive to the dive list

    You can manually add a dive to the existing dive list. On the dive list -tap the "plus" sign in the action bar, or use the -main menu and tap Dive management → Add dive manually. This opens a screen that is -identical to the editing screen discussed above. When a dive is added manually, you +tap the "plus"-icon in the action bar, or use the +main menu and tap Dive management → Add dive manually. This opens a screen that is +identical to the editing screen described above. When a dive is added manually, you cannot directly add a dive profile from a dive computer. However, if you do 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 @@ -793,7 +793,7 @@ The left-hand image below shows a screenshot of a dive being created and the rig the same dive in Details View.

    -FIGURE: Manual dive entry screen +FIGURE: Manual dive entry screen
    @@ -803,7 +803,7 @@ the same dive in Details View.

    the bottom of the Dive List, or you can select Dive management → Download from DC in the main menu. On Android devices, when you plug in a USB serial cable for a dive computer, the Download Page will be opened automatically.

    -

    The download feature in smartphones supports only a limited number of dive computers. On +

    The download feature on smartphones supports only a limited number of dive computers. On Android devices these are typically dive computers using a serial USB interface using a USB OTG cable or a simple USB C-A adapter on newer devices. Android devices also support Bluetooth dive computers that @@ -813,7 +813,9 @@ computers.

    Use the Vendor name and Dive Computer drop-downs to pick the correct dive computer. For instance, when using a Shearwater Petrel dive -computer, the vendor is Shearwater and the product is Petrel(see image on the left, below).

    +computer, the vendor is Shearwater and the product is Petrel(see left image below - +section Start the download).

    +

    TODO: image of DL missing - or link to the 7.2.3 Start the download

    When downloading from multiple different dive computers, shortcut buttons appear below the drop-downs to easily switch between them. In the Settings menu you can remove these buttons, a useful feature for removing buttons of dive @@ -837,14 +839,14 @@ cellspacing="0" cellpadding="4">

    Most current Android devices now have a USB -Type C port and come with a simple A-to-C adapter plug, which allows to plug in +Type C port and come with a simple A-to-C adapter plug, which lets you plug in the dive computer cable into the phone or tablet. For older Android devices with micro USB connector you will need to plug the USB cable used with the dive computer into a USB OTG cable which, in turn, plugs into the micro-USB port. The OTG cable usually has a full-size ("Type A") female receptacle at one end which accommodates the full-sized male plug -of the dive computer USB cable (see image below). This means that two cables are used to connect +of the dive computer USB cable (see image on left). This means that two cables are used to connect the dive computer to the mobile device. Not all Android devices support OTG cables but usually all modern Android devices with a USB C plug can be used with a USB A-to-C adapter.

    @@ -859,7 +861,7 @@ Select the appropriate button. Having connected the USB dive computer to the ensure that the Connection text box shows the corresponding connection. For a small number of dive computers the connection name shows the dive computer vendor, for most only the cable chipset vendor (and USB connection number) is shown. Most users of course only connect one USB dive computer to -their Android device and then things are fairly straight forward. A dialog will pop up and ask if +their Android device and then things are fairly straightforward. A dialog will pop up and ask if you want to use Subsurface-mobile to connect to the device. If you confirm, then Subsurface-mobile will open to the dive computer download screen with the correct connection selected (and if it can deduce the correct dive computer based on the cable used, even that information is already pre-filled).

    @@ -879,10 +881,10 @@ mobile device using Android system tools to achieve pairing. For many Android devices, the Settings → Bluetooth tool of Android is probably appropriate. Subsurface-mobile performs communication using both Bluetooth and Bluetooth-low-energy (BLE). -The appropriate choice of Bluetooth communication is often made by the software and the user need not be concerned with this. +The best choice of Bluetooth communication is often made by the software and the user need not be concerned with this. For dive computers with both Bluetooth and BLE, a separate button is presented on the download screen for each mode of communication, allowing a choice. Use the Connection value to distinguish between the -two options. In the image on the right, below, there are three buttons labeled "Shearwater Petrel 2". These represent two Shearwater Petrel dive computers, one of which can communicate in both Bluetooth as well as BLE. The Connection +two options. In the image on the below right, there are three buttons labeled "Shearwater Petrel 2". These represent two Shearwater Petrel dive computers, one of which can communicate in both Bluetooth as well as BLE. The Connection information indicates that the Petrel with no BLE is selected.

    @@ -892,7 +894,7 @@ having been set up, tap the Download button. Be patient because the dow long dives and a slow BLE connection we have seen download times of 45 minutes or longer. But usually downloading a day’s worth of diving happens reasonably quickly. The downloaded dives appear in the bottom part of the screen, -the most recent dive at the top (see image on right, below).

    +the most recent dive at the top (see right image below).

    Each dive has a check-box on the left hand side, used for selecting which dives you want to add to the Subsurface-mobile dive list: dives that are not checked are ignored. Once you picked the dives you want to add to the dive list, tap the button at the bottom left labeled Accept. The selected dives will @@ -907,11 +909,7 @@ above Edit a dive.

    -

    7.3. Apply GPS fixes

    -

    This is described in the following main section, below.

    -
    -
    -

    7.4. Manually sync the dive log with the Subsurface Cloud

    +

    7.3. Manually sync the dive log with the Subsurface Cloud

    As the name indicates, this ensures that the local changes on the mobile device and changes made by other devices and computers to the data stored in the Subsurface Cloud are synchronized. It is highly recommended to sync with cloud storage after downloading new dives from a dive computer @@ -919,7 +917,7 @@ or manually adding or editing dive information on the mobile device.

    This can also be triggered by pulling down (and briefly holding) the Dive List.

    -

    7.5. Enable cloud auto sync

    +

    7.4. Enable cloud auto sync

    By default Subsurface-mobile runs offline and only syncs the dive list with cloud storage when explicitly told to do so (see the previous entry above). You can choose to always sync with the cloud servers. This is not @@ -934,7 +932,7 @@ In general it is safer to manually sync with the cloud once you are done making Subsurface-mobile.

    -

    7.6. Dive Summary

    +

    7.5. Dive Summary

    The Dive Summary page provides a very simple overview of your diving activities - which can for example be useful when documenting total dive experience and recent dive activity for a dive center at the beginning of a dive trip.

    @@ -943,9 +941,9 @@ It also provides two columns of data for selectable time ranges (by default all and the dives during the last six months.

    -

    7.7. Export

    -

    The Export feature is somewhat experimental. On Andtoid it only allows the upload of your dive list -to two websites (divelogs.de and diveshare). On iOS it also allws local file based exports as Subsurface +

    7.6. Export

    +

    The Export feature is somewhat experimental. On Android it only allows the upload of your dive list +to two websites (divelogs.de and diveshare). On iOS it also allows local file based exports as Subsurface specific XML files (both for dives and dive sites) as well as UDDF.

    Tapping on Next opens an additional page for login information (or a file selection dialog).

    @@ -963,18 +961,21 @@ smartphone as well as by the GPS settings selected within Android/iOS. As of Android V6 select Android Settings → Communication → Location → High accuracy. If the smartphone is taken on the boat during a dive, 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:

    +These locations can then be applied to dives in the dive list as described in following chapters.

    8.1. Configuring the GPS service

    -

    From the Main Menu, select Settings screen which has a section for -configuring the GPS service (image below). GPS location data +

    For most users, the defaults for tracking GPS locations will be +appropriate. If you would like to change them, go to +the Main Menu, select the Settings screen, and open +the Advanced area on that page. Here you will find the section for +configuring the GPS service (see image below). GPS location data are collected at regular intervals, e.g. every 5 minutes, or at regular distances, e.g. after the boat has moved more than 200m, or a combination of both of these approaches. Provide the appropriate information and tap the Back button. The program is now ready to collect GPS positions.

    -FIGURE: GPS configure +FIGURE: GPS configure
    @@ -991,15 +992,15 @@ cellspacing="0" cellpadding="4">
    -FIGURE: GPS start +FIGURE: GPS start

    In the Location menu select Run location service. Subsurface-mobile starts to collect GPS locations automatically, following the preferences specified as described above. While the GPS location service is running, all menus have a GPS symbol at the bottom -of the menu, indicating that the service is active. After return from -the dive trip, deactivate the collection of GPS data by tapping +of the menu, indicating that the service is active. After returning from +the dive, deactivate the collection of GPS data by tapping the option GPS → Disable location service. The GPS symbol at the bottom of all menus disappears.

    Collecting GPS fixes like this is relatively battery intensive and unfortunately @@ -1012,25 +1013,9 @@ to check between dives that the location service is still running.

    -

    8.3. Viewing GPS data

    -

    From the Location menu select Show GPS fixes. This brings -up a list of GPS positions obtained by the location service (image -below). Two actions are possible for each of the locations, enabled by -dragging the right part of a location to the left. This exposes two -options. Tapping the dustbin deletes this particular GPS location. Tapping the -GPS map pin opens up Google Maps with a pin -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.

    -
    -
    -FIGURE: GPS management -
    -
    -
    -
    -

    8.4. Applying GPS data to dives in the dive log

    +

    8.3. Applying GPS data to dives in the dive log

    After running the location service during a dive trip, first either download -the dives from your divecomputer or manually enter the dives into the dive list. +the dives from your dive computer or manually enter the dives into the dive list. Now you can apply the GPS positions to these dives. From the Dive management menu, tap Apply GPS fixes. The dive list contains the start and end times of each dive. Now, Subsurface-mobile applies the first @@ -1038,7 +1023,7 @@ 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.

    -

    8.5. Viewing the locations of all dives in the dive list

    +

    8.4. Viewing the locations of all dives in the dive list

    FIGURE: Map of all dive sites @@ -1058,6 +1043,11 @@ of the different dive sites.

    It is grouped into four sections.

    9.1. General settings section

    +
    +
    +FIGURE: General Settings +
    +

    9.1.1. Changing to a different Subsurface cloud account

    Some users have more than one Subsurface cloud account and have a need to switch between accounts. @@ -1081,11 +1071,6 @@ buttons on the Download from dive computer page.

    9.2. Theme section

    -
    -
    -FIGURE: Settings: Cloud & Theme -
    -

    9.2.1. Color theme

    @@ -1099,12 +1084,12 @@ cellspacing="0" cellpadding="4">
    -FIGURE: GPS start +FIGURE: Theme Settings

    Besides the default blue color scheme, Subsurface-mobile supports two additional color schemes -for users with different tastes (see image above). All screenshots in this user manual shows are -based on the the blue default color scheme. You can pick the pink or dark color scheme from +for users with different tastes (see image on left). All screenshots shown in this user manual are +based on the blue default color scheme. You can pick the pink or dark color scheme from the drop down menu.

    The boxes below show the various color choices in the theme of your choice.

    @@ -1192,7 +1177,7 @@ you to reset the password for your Subsurface Cloud account.

    -- cgit v1.2.3-70-g09d2