diff --git a/Documentation/user-manual.html.git b/Documentation/user-manual.html.git index c4b5f7a57..79b8e462f 100644 --- a/Documentation/user-manual.html.git +++ b/Documentation/user-manual.html.git @@ -446,7 +446,7 @@ asciidoc.install(3);

Manual authors: Willem Ferguson, Jacco van Koll, Dirk Hohndel, Reinout Hoornweg, Linus Torvalds, Miika Turkia, Amit Chaudhuri, Jan Schubert, Salvador Cuñat, Pedro Neves, Stefan Fuchs

-

Version 4.7, May 2018

+

Version 4.8, September 2018

Welcome as a user of Subsurface, an advanced dive logging program with extensive infrastructure to describe, organize, interpret and print scuba and free dives. Subsurface offers many advantages over other similar @@ -1361,10 +1361,9 @@ dive site name in the Notes tab.

Once the dive location data have been saved, the dive on the Dive List has a globe icon immediately to the left of the location name of a particular dive.

-

(3): Obtain the coordinates using either the Subsurface-Mobile App or the Subsurface Companion App on an +

(3): Obtain the coordinates using the Subsurface-mobile App on an Android or iPhone device with GPS and if the dive site coordinates - were stored using one of these apps. - Click here for more information

+ were stored using one of this app.

This is performed by:

1) Taking the mobile device along on the dive boat / liveabord while automatically collecting dive site coordinate information.

-

2) Uploading the coordinates from the mobile device to the Subsurface Internet server.

-

3) Syncronising the dives in the Subsurface dive list with the coordinates stored -on the Subsurface Internet server.

-

Subsurface has two tools for achieving this:

-
-

Both of these applications perform the collection of dive site coordinates and -the synchronisation with dives in the Subsurface dive list. However, the Companion App -is not being further developed and has largely been replaced by the Subsurface-mobile -app. While the Companion app serves exclusively to collect dive site coordinates and -to make these available to the Subsurface desktop version, Subsurface-mobile performs -many of the functions of the desktop version, including the management and viewing of dive -information. Below, we describe how to perform the above three steps using each of the two -mobile apps.

-

For information on using the Subsurface Companion App, click here.

+

2) Adding collected coordinate information to the dives using the Subsurface-mobile app.

+

3) Syncronising the logbook with the Subsurface cloud using the Subsurface-mobile app.

+

Existing users might still be using the legacy Companion app. However, the Companion App +hasn’t been under development in several years and has now been removed from both Android +and iOS app stores. The functionality is fully integrated into Subsurface-mobile. +Please note that the old GPS fix internet service will be shut down by the end 2018 at which +point the Companion app will no longer be usable. Please switch to Subsurface-mobile instead.

5.4.1. Storing and and using GPS locations using Subsurface-mobile

@@ -2215,14 +2196,6 @@ of GPS positions.

After the dive, stop the automated recording of GPS locations

Select the menu option Disable location service at the bottom of the Subsurface-mobile GPS menu.

-
-
-
Upload the GPS locations onto the Subsurface Internet server.
-

N.B.: Uploading the GPS locations to the Internet can only take place if the mobile -device has reliable access to the Internet, either via a cellular network or -via a wifi connection. If the Internet is not accessible from the dive site(s), -then GPS uploading can only take place after the dive or after the dive trip, -when an Internet connection has been re-established.

From the Subsurface-mobile main menu, select GPSUpload GPS data. The locations are uploaded.

@@ -2241,387 +2214,39 @@ performing the collection of GPS data and for managing, uploading and synchronising this information.

-
-

5.4.2. Importing GPS coordinates with the Subsurface Companion App for mobile phones

-

Using the Subsurface Companion App on an Android device or -iPhone with GPS, the coordinates -for the diving -location can be automatically passed to the Subsurface dive log. The Companion App -stores dive locations on a dedicated Internet server. Subsurface can collect -the locations from the server. -To do this:

-
-
Create a Companion App account
-
    -
  • -

    -Register on the Subsurface companion web page. - A confirmation email with instructions and a personal DIVERID will be sent, - a long number enabling access to the file server and Companion App capabilities. -

    -
  • -
  • -

    -Download the app from - Google Play Store - or from - F-Droid. -

    -
  • -
-
-
-
Using the Subsurface companion app on an Android smartphone
-

On first use the app has three options:

-
    -
  • -

    -Create a new account. Equivalent to registering in the Subsurface companion - page using an Internet browser. You can request a DIVERID using this option, - but it’s supplied via email and followed up by interaction with the - Subsurface companion web page to - activate the account. -

    -
  • -
  • -

    -Retrieve an account. If you forget your DIVERID you will receive an email - to recover the ID string. -

    -
  • -
  • -

    -Use an existing account. You are prompted for your DIVERID. The app saves - this DIVERID and doesn’t ask for it again unless you use the Disconnect menu - option (see below). -

    -
  • -
-
-
@@ -2124,31 +2123,13 @@ a smaller file to make sure everything works.
- - -
-Important -In the Subsurface main program, the DIVERID should also be entered on the -Default Preferences -panel, by selecting File → Preferences → General from the main menu -in Subsurface itself. -This helps synchronization between Subsurface and the Companion App.
-
-

Creating new dive locations

-

Now you are ready to get a dive position and -send it to the server. The Android -display looks like the left hand image (A) below, but without any dives.

-

Touch the + icon at the top right to add a new dive site. A menu -with 3 options shows:

-
-
-
-FIGURE: Companion App, add location using map -
-
-
-

List of dive locations

-

The main screen shows a list of dive locations, each with a name, date and -time (see A below). Some locations may have an arrow-up icon over the selection box to the left -showing they need to be uploaded to the server. You -can select individual dive locations from the list. A selected location has a -check mark in the selection box on the left. Group operations (like Delete or Send) -are performed on several selected locations.

-

Dive locations in this list can be viewed in two ways: a list of locations or a -map showing them. The display mode (List or Map) is changed by -selecting Dives at the top left of the screen (see A below) and then selecting -the display mode. The display mode can be changed either from the list -of locations or from the map (see B below). Upon selecting a location (on the list -or on the map), an editing -panel opens (see C below) where the dive description or other details may be changed.

-
-
-FIGURE: Companion App, add location using map -
-
-

Upon selecting a dive (not selecting the check box), the -name given to it, date/time and GPS coordinates are shown with two options at the top -of the screen:

-
-

Uploading dive locations

-

There are several ways to send locations to the server. -The easiest is simply -selecting the locations (See A below) and then touching the right arrow at the -top right of the screen.

-
- - - -
-Important -Be careful! The trash icon on the right means exactly what it should; -it deletes the selected dive location(s).
-
-
-
-FIGURE: Screen shots (A-B) of companion app -
-
-

After a dive trip using the Companion App, all dive locations are ready to be -downloaded to a Subsurface dive log (see below).

-

Settings on the Companion App

-

Selecting the Settings menu option results in the right hand image above (B).

-

Server and account

-
-

Synchronisation

-
-

Background service

-

Instead of entering an unique dive location, you can leave the service running -in the background, allowing a continuous collection of GPS locations.

-

The settings below define the behavior of the service:

-
-
- - - -
-Tip -How does the background service work? Assuming the diver sets 5 minutes and 50 -meters in the settings above, the app will start by recording a location at the current -location, followed by another one at every 5 minutes or every time one moves 50 m -from previous location. -If subsequent locations are within a radius of 50 meters from the previous one, -a new location is not saved. If the diver is not moving, only one location is saved. -If the diver is moving, a trace of the route is obtained by saving a -location every 50 meters.
-
-

Other

-
-

Search

-

Search the saved dive locations by name or by date and time.

-

Start service

-

Starts the background service following the previously defined settings.

-

Disconnect

-

This is admittedly a badly named option that disconnects the app from the server. -It resets the user ID in the app, showing the first screen where an account -can be created, retrieve the ID for an existing account or use the users own -ID. The Disconnect option -is useful if the Android device was used to download the dive locations -of another registered diver.

-

Send all locations

-

This option sends all locations stored in the Android device to the server.

- -
-
Using the Subsurface companion app on an iPhone to record dive locations
-

The iPhone interface is quite simple. Type the user ID (obtained -during registration) into the space reserved for it, then select "Dive in" -(see left part of the image below) and start collecting dive location information.

-
-
-FIGURE: Using iPhone companion application -
-
-

Dives can be added automatically or manually. In manual mode, a dive location or waypoint is added to the GPS input stream. In automatic -mode, a continuous path of GPS locations is created from which, -after import, Subsurface can select the appropriate GPS -locations based on the times of dives. The default mode for the -iphone is automatic. When adding a dive, the -location service is started automatically and a red bar appears at the bottom -of the screen. After the dive, click on the red -bar to end the location service. While the location -service is running you can only add dives manually.

-

You can edit the site name afterwards by selecting the dive -from the dive list and clicking on the site name. There are no other -editable fields. The dive list is automatically uploaded from the iPhone -to the web service. There is no option to -trigger upload manually.

-

Downloading dive locations to the Subsurface divelog

-

Download dive(s) from a dive computer or enter them manually into -Subsurface before obtaining the GPS coordinates from the server. The download -dialog can be reached via Ctrl+G or from the Subsurface Main Menu Import -→ Import GPS data from Subsurface Service, resulting in the image on the -left (A), below. On first use the DIVERID text box is blank. Provide a -DIVERID, then select the Download button to start the download process, after -which the screen on the right (B) below appears:

-
-
-FIGURE: Downloading Companion app GPS data -
-
-

Note that the Apply button is now active: selecting it updates the locations -of the newly entered or uploaded dives in Subsurface, i.e. it applies the -coordinates and names entered on the app to all the new dives that match the -date-times of the uploaded GPS localities. The names of dive -locations entered within Subsurface (i.e. before downloading the GPS coordinates) have -precedence over downloaded dive locations.

-

Since Subsurface matches GPS locations from the mobile device and dive information from the -dive computer based on date-time data, automatic assignment of GPS data to dives depends -on agreeing date-time information between the two devices. Although Subsurface has -a wide range tolerance, it may not be able to identify the appropriate dive if there is a -large difference between the time in the dive computer and that of the Android device. -This results in no updates.

-

Similar date-times may not always be possible and there may be many reasons for this (e.g. time zones). -Subsurface may also be unable to decide which is the correct position for a dive (e.g. on repetitive -dives while running background service there may be several locations that would be -included in the time range that fit not only the first dive, but one or more subsequent dives as well). -A workaround to manually edit the date-time of a dive in the Subsurface -Dive List before downloading the GPS data and then to change the date-time back again after -downloading GPS data.

-
- - - -
-Note -TIPS:
-
-
-
-
-

5.5. Adding photographs to dives

-

Many (if not most) divers take photographs -during a dive. Subsurface allows the storage and display of photographs for each dive. Photos are -superimposed on the dive profile at the times during the dive when they were taken. They can also be viewed -from the dive profile.

+

5.5. Adding photographs or videos to dives

+

Many (if not most) divers take photographs or videos +during a dive. We term these as media, meaning either photos or videos. Subsurface +allows the storage and display of these media for each dive. Images are +superimposed on the dive profile at the times during the dive when they were taken. Media can be viewed either +from the dive profile or from the Media tab in the Notes Panel. Subsurface allows viewing of photographs +as well as video files in a unified interface.

-

5.5.1. Loading photos and synchronizing between dive computer and camera

+

5.5.1. Loading media and synchronizing between dive computer and camera

Right-click on a dive or on a group of dives on the dive list, bringing up the Dive list context Menu. -Select the appropriate option to import images either from +Select the appropriate option to import media either from file or from the Internet. The system file browser appears. Select the folder and -photographs that need to be loaded into Subsurface and click the Open button.

+media that need to be loaded into Subsurface and click the Open button. Towards the +bottom of the file browser is a filter that allows showing media (photos and videos), +only photographs, only videos, or all files. Choose the appropriate option.

FIGURE: Load images option
-

If photos are imported from the Internet, provide a URL pointing to a single photograph. -If the URL points to a directory, no images are imported: photos from the Internet -need to be imported one at a time. If photos are loaded from the Internet, Subsurface -assumes there is an Internet connection each time this photo is viewed within +

If media are imported from the Internet, provide a URL pointing to a single media. +If the URL points to a directory, no images are imported: images from the Internet +need to be imported one at a time. If media are loaded from the Internet, Subsurface +assumes there is an Internet connection each time this item is viewed within Subsurface.

-

Having selected the local folder or Internet image to be imported, the time synchronization dialog appears (see image below). The time +

Having selected the local folder or Internet image to be imported, the time +synchronization dialog appears (see image below). The time synchronization is not perfect between the dive computer used during a dive and the camera used during that same dive. These two devices -often differ by several minutes. Subsurface attempts to synchronize these two devices -so that the exact times of photographs can be used to position photographs on +often differ by several minutes. Subsurface attempts to synchronize them +so that the exact times of media can be used to position media on the dive profile.

Subsurface synchronizes camera with dive computer in three ways:

    @@ -2641,7 +2266,7 @@ the dive profile.

setting tool immediately under the heading Shift times of image(s) by, in the image below. If the camera time is 7 minutes later than that of the dive computer, set the time setting tool to a value of 00:07 and select the Earlier radio button. - This is appropriate, since the photos need to be shifted + This is appropriate, since the media need to be shifted 7 minutes earlier (camera is 7 minutes ahead of dive computer). Ignore any "AM" or "PM" suffix in that tool. Click the OK button and synchronization is done.

@@ -2678,23 +2303,53 @@ the dive profile.

FIGURE: Synchronization dialog
-

If the timestamp of a photograph is more than 30 minutes before or after the dive, it is not placed on -the dive profile (see the red warning in the image above). However, If the appropriate checkbox is selected (see image above) these images can still be placed on the Photos tab of the Notes panel so that all photos associated with a dive are visible, including photos taken before or after the dive.

+

If the timestamp of a photograph or video is more than 30 minutes before or after the dive, it is not placed on +the dive profile (see the red warning in the image above). However, If the appropriate checkbox is +selected (see image above) these images can still be placed on the Media tab of the Notes panel +so that all media associated with a dive are visible, including images taken before or after the dive.

-

5.5.2. Viewing the photos

-

After the images have been loaded, they appear in two places:

+

5.5.2. Viewing the media

+
+
+

Ensuring that thumbnails are created for video files

+
+ + + +
+Important +Within a panel Subsurface represents media by means of thumbnails (i.e. small versions of images +that allows listing many images. For a photograph, a thumbnail can easily be +created because the image is well defined. But, since a video comprises many images, the question arises of +which image should be used for the thumbnail. Two actions are required to create thumbnails of videos:
+
  • -the Photos tab of the Notes panel (left part of image below). +The appropriate settings need to be set in the Preferences. +

    +
  • +
  • +

    +The program ffmpeg needs to be installed in the computer that runs Subsurface. +

    +
  • +
+

Full details are provided in APPENDIX F.

+
+

After the media have been loaded, they appear in two places:

+
FIGURE: Full-screen photo on dive profile @@ -2731,54 +2386,53 @@ can also be deleted using the Photos tab (see text below).

-

5.5.3. The Photos tab

-

Photographs associated with a dive are shown as thumbnails in the Photos tab of the Notes -panel. Photos taken in rapid succession during a dive (therefore sometimes with large -overlap on the dive profile) can easily be accessed in the Photos tab. This tab serves as -a tool for individually accessing the photos of a dive, while the stubs on the dive profile -show when during a dive a photo was taken. The size of the thumbnails in the Photos tab can be changed using +

5.5.3. The Media tab

+

Media associated with a dive are shown as thumbnails in the Media tab of the Notes +Panel. Media taken in rapid succession during a dive (therefore sometimes with large +overlap on the dive profile) can easily be accessed in the Media tab. This tab serves as +a tool for individually accessing the media of a dive, while the stubs on the dive profile +show when during a dive when a photo/video was taken. The size of the thumbnails in the Media tab can be changed using the Zoom level slider at the bottom of the panel. Single-click a thumbnail in -the Photos panel to select a photo. Double-click a thumbnail to view the full-sized image, -overlaying the Subsurface window. Delete a photo from the Photos panel by selecting -it (single-click) and then by pressing the Del key on the keyboard. This removes the photo BOTH -from the Photos tab as well as the dive profile.

+the Media panel to select a photo/video. Double-click a thumbnail to view the full-sized image +or play the video, overlaying the Subsurface window. Delete media from the Media panel by selecting +it (single-click) and then by pressing the Del key on the keyboard. This removes it BOTH +from the Media tab as well as the dive profile.

-

5.5.4. Photos on an external hard disk

-

Most underwater photographers store photos on an external drive. If such a drive can be mapped by the operating system -(almost always the case) the photos can be directly accessed by Subsurface. This eases the interaction -between Subsurface and an external repository of photos. When associating a dive profile with photos from an +

5.5.4. Media on an external hard disk

+

Most underwater photographers store media on an external drive. If such a drive can be mapped by the operating system +(almost always the case) the media can be directly accessed by Subsurface. This eases the interaction +between Subsurface and an external repository of media. When associating a dive profile with media from an external drive, the normal procedure of selection and synchronization (see text above) is used. -After the external drive has been disconnected, Subsurface cannot access these photos any more. -If the display of photos is activated (using the toolbox icon to the left of the Dive Profile), the -program shows a small white dot where each photo should be on the dive profile. -In addition the Photos tab shows only the file names of the photos. -If the external drive with the photos is re-connected, the photos can be seen in the normal way.

+After the external drive has been disconnected, Subsurface cannot access these media any more. +If the display of media is activated (using the toolbox icon to the left of the Dive Profile), the +program shows only the thumbnails and the images cannot be viewed at full-screen size. +If the external drive with the media is re-connected, the media can be seen in the normal way.

-

5.5.5. Finding out which dives have associated photos.

-

Inspecting each individual dive in order to determine whether there are associated photos can be time consuming. There is a -rapid way of seeing which dives have associated photos and which not: activate the Photos checkbox in the dropdown -list obtained by right-clicking on the header bar of the Divelist. In the Divelist, all dives with associated photographs -have an icon indicating whether the photographs were taken during the dive, just before/after the dive or both during and before/after the dive. +

5.5.5. Finding out which dives have associated media.

+

Inspecting each individual dive in order to determine whether there are associated media can be time consuming. There is a +rapid way of seeing which dives have associated media and which not: activate the Media checkbox in the dropdown +list obtained by right-clicking on the header bar of the Divelist. In the Divelist, all dives with associated media +have an icon indicating whether the media were taken during the dive, just before/after the dive or both during and before/after the dive. More information is provided in the section dealing with photo icons on the Divelist.

-

5.5.6. Moving photographs among directories, hard disks or computers

-

After a photograph has been loaded into Subsurface and associated with a specific dive, -Subsurface saves the directory path where the photo lies as well as the file name of the photo, +

5.5.6. Moving media among directories, hard disks or computers

+

After a photograph or video has been loaded into Subsurface and associated with a specific dive, +Subsurface saves the path to the directory where the media lie as well as the file name of the each photo/video, in order to find it when the dive is opened again. -If the photo or the whole photo collection is moved to another drive or to a different - machine, the path to the photo changes. Now, Subsurface looks for the photos at their original location before they were moved, - cannot find them and cannot display them. Because, after moving photos, large numbers of photos - may need to be deleted and re-imported from the new location, Subsurface can locate the photos based on their filename and path.

+If the media or the whole media collection is moved to another drive or to a different + machine, the path to the media changes. Now, Subsurface looks for the photos/videos at their original location before they were moved, +cannot find them and cannot display them. Because, after moving media, large numbers of files + may need to be deleted and re-imported from the new disk, Subsurface can locate the media based on their filename and path.

This is done by selecting from the Main Menu: File → Find moved images. This brings up a window within which the searching of the images can be controlled. The search is started by clicking on Select folder and scan. -Since photos taken with different cameras might have the same filename, the names of the parent folders are likewise compared. +Since recorded during different dive trips might have the same filename, the names of the parent folders are likewise compared. Therefore, the root folder of the NEW picture collection should be chosen. For finer control, it is possible to search -only for photographs of the currently selected dive(s) by selecting the appropriate option.

-

After the searching has finished, the original filenames and the new locations of the photographs will be shown. -The matching parts of the paths are emphasized. Photographs that are found at their known positions are +only for media of the currently selected dive(s) by selecting the appropriate option.

+

After the searching has completed, the original filenames and the new locations of the photographs will be shown. +The matching parts of the paths are emphasized. Media that are found at their known positions are not listed. The proposed changes can be applied by clicking Apply or rejected by clicking Cancel.

@@ -3647,11 +3301,13 @@ two red dots. Note -Photographs that have been added to a dive can be shown on the profile +Photographs and videos that have been added to a dive can be shown on the profile by selecting -the Show-photo button. The position of a photo on the profile -shows the exact time when this photo was taken. If this button is not active, -the photos are hidden. +the Show-media button. The position of a photo on the profile +shows the exact time when this photo was taken. +The runtime of videos is represented by a bar if Subsurface was able to +extract this information from the video file. +If this button is not active, the photos are hidden.

The profile can also include the dive computer reported ceiling (more @@ -3903,14 +3559,14 @@ header bar of the Dive List, bringing up a list of columns that can be shown in the dive list (see above). Check an items to be included in the Dive List. The list is immediately updated. Preferences for information shown in the Dive List are saved and used when Subsurface is re-opened.

-

By selecting the Photos checkbox in the dropdown list, an icon is shown indicating whether any photos +

By selecting the Media checkbox in the dropdown list, an icon is shown indicating whether any media are associated with a particular dive. There are three icons:

- +
Note This dive has photographs taken during the dive, typically using an underwater camera.This dive has photographs or videos taken during the dive, typically using an underwater camera.
@@ -3918,8 +3574,8 @@ are associated with a particular dive. There are three icons:

Note -This dive has photographs taken immediately before or immediately after the dive. This is useful for -finding photos of dive teams or boats just before/after the dive, whales or other surface animals seen +This dive has photographs or videos taken immediately before or immediately after the dive. This is useful for +finding photos/media of dive teams or boats just before/after the dive, whales or other surface animals seen just before or after the dive, or of landscapes as seen from the boat.
@@ -3928,7 +3584,7 @@ just before or after the dive, or of landscapes as seen from the boat. Note -This dive has photographs taken both during the dive and immediately before or after the dive. +This dive has photographs or videos taken both during the dive and immediately before or after the dive.
@@ -4073,11 +3729,11 @@ dive at points during the dive where the depth is less than a metre.

7.4.7. Load image(s) from file(s)

-

This topic is discussed in the section: Adding photographs to dives.

+

This topic is discussed in the section: Adding photographs or videos to dives.

7.4.8. Load image from web

-

This topic is discussed in the section: Adding photographs to dives.

+

This topic is discussed in the section: Adding photographs or videos to dives.

7.4.9. Undo dive manipulations

@@ -4282,9 +3938,9 @@ Universal Dive Data Format (UDDF). Refer to http://uddf.org fo
  • Image depths, which creates a text file that contains the file names of all - photos or images attached + photos or videos attached to any of the selected dives in the Dive List, together with the depth underwater where - of each of those photos was taken. + of each of those photos/videos was taken.

  • @@ -4709,7 +4365,7 @@ apply the new preferences, select Cancel.

  • There are several headings in the General panel:

    -FIGURE: Preferences general page +FIGURE: Preferences general page
  • +Video thumbnails: In generating thumbnails for videos associated with dives, Subsurface + needs to have the appropriate information (see section on View Images). Three preferences need to be set + as explained in APPENDIX F. These are: a) switch on thumbnails, b) specify + the location of the ffmpeg program and c) set the place within video where the thumbnail needs + to be obtained from. +

    +
  • +
  • +

    Clear all settings: As indicated in the button below this heading, all settings are cleared and set to default values.

    @@ -4986,7 +4651,7 @@ effect.

    13.5. Network

    This panel facilitates communication between Subsurface and data sources on the Internet. This is important, for instance, when Subsurface needs to communicate with web -services such as Cloud storage, the Subsurface Companion app or when you want to communicate through a proxy.

    +services such as Cloud storage, or when you want to communicate through a proxy.

    FIGURE: Preferences Network page @@ -5027,20 +4692,13 @@ from your ISP.
  • -
  • -

    -Subsurface web service: When you subscribe to the Subsurface web service, a very - long and hard-to-remember userID is issued. This is the place to save that userID. By - checking the option Save User ID locally?, you ensure a local copy of that userID is saved. -

    -
  • 13.6. Georeference

    Subsurface provides a geo-lookup service (that is, given the coordinates of a dive site) derived from a click on the Dive Map panel at the bottom right of the Subsurface window, or from a GPS instrument or -from the Subsurface Companion app). A search on the Internet is done to find +from the Subsurface-Mobile app). A search on the Internet is done to find the name of the closest known location. This function only works if Subsurface has an Internet connection. The preference of the dive site name can be configured, e.g. Country/State/City or City/State/Country (see image below).

    @@ -5940,7 +5598,7 @@ dealing with the appropriate operations.

  • -Take cloud storage online - +Cloud storage online - Switch between the online version of the logbook, and the locally stored one.

  • @@ -5966,7 +5624,7 @@ dealing with the appropriate operations.

  • -Find moved images - If photos taken during dives have been moved to +Find moved images - If photos/videos taken during dives have been moved to a different disk or directory, locate them and link them to the appropriate dives.

  • @@ -6009,12 +5667,6 @@ The Edit option allows one to undo or redo an action, e.g. deleting dives.
  • -Import GPS data from Subsurface web service - Load GPS - coordinates from the Subsurface mobile phone app. -

    -
  • -
  • -

    Import from Divelogs.de - Import dive information from www.Divelogs.de.

    @@ -6031,11 +5683,6 @@ The Edit option allows one to undo or redo an action, e.g. deleting dives.
  • -Edit dive - Edit a dive where the profile was entered by hand and not from a dive computer. -

    -
  • -
  • -

    Plan Dive - Plan dives.

  • @@ -7654,10 +7301,67 @@ render as much dives as possible:
    -

    22. APPENDIX F: FAQs.

    +

    22. APPENDIX F: Setting up video thumbnails.

    -

    22.1. Subsurface appears to miscalculate gas consumption and SAC

    +

    22.1. Setting up the appropriate thumbnails for videos that are associated with dives.

    +

    In handling video associated with dives, Subsurface needs to create a thumbnail for each video that can be shown +either on the dive profile or in the Media tab. By default this is a nonspecific placeholder thumbnail. +To see thumbnails that represent individual videos, Subsurface uses an external program calle FFmpeg. +To create thumbnails for videos, do two things:

    +
      +
    1. +

      +Install FFmpeg on the computer that runs Subsurface. The program can be downloaded from the FFmpeg web site: +https://www.ffmpeg.org/download.html. Most Linux distributions ship with an ffmpeg package and therefore do not need an additional download. +

      +
        +
      • +

        +On Windows, put the ffmpeg.exe file in the directory containing the Subsurface executable. +On Mac and Linux, make sure the ffmpeg command is in the path. This should be the case for +FFmpeg installed from official packages. +

        +
      • +
      +
    2. +
    3. +

      +In the General tab of the Preferences, set the preferences for generating video thumbnails. This is achieved by: +

      +
        +
      • +

        +Checking the Extract video thumbnails box. If Subsurface fails to load the FFmpeg executable, +this option will be turned off. Re-enable it after successfully installing FFmpeg. +

        +
      • +
      • +

        +Specifying the path to the FFmpeg executable. +

        +
      • +
      • +

        +Choose the position in the video where Subsurface +should try to extract the thumbnail. The left-most and right-most positions of the Extract at position +slider signify the beginning and the end of the video, respectively. Note that if Subsurface cannot +determine the length of the video (this can be the case for AVI files), the first frame +of the video will be used. +

        +
      • +
      +
    4. +
    +

    This should complete the setup of video thumbnails and they should now appear on the dive profile and in the Media tab.

    +
    +
    +
    +
    +

    23. APPENDIX G: FAQs.

    +
    +
    +

    23.1. Subsurface appears to miscalculate gas consumption and SAC

    Question: I dived with a 12.2 l tank, starting with 220 bar and ending with 100 bar, and I calculate a different SAC compared what Subsurface calculates. Is Subsurface miscalculating?

    Answer: Not really. What happens is that Subsurface actually calculates gas @@ -7688,7 +7392,7 @@ starts becoming much more noticeable at high pressure. A 400 bar really does not contain twice as much air as a 200 bar one. At lower pressures, air acts pretty much like an ideal gas.

    -

    22.2. Some dive profiles have time discrepancies with the recorded samples from my dive computer…

    +

    23.2. Some dive profiles have time discrepancies with the recorded samples from my dive computer…

    Subsurface ends up ignoring surface time for many things (average depth, divetime, SAC, etc). Question: Why do dive durations in my dive computer differ from that given by Subsurface?

    Answer: For example, if you end up doing a weight check (deep enough to trigger the "dive started") @@ -7700,7 +7404,7 @@ you may stay in the water for a long time, but spend most of it at the surface. you don’t want that to count as some kind of long dive”.

    -

    22.3. Some dive profiles are missing from the download

    +

    23.3. Some dive profiles are missing from the download

    Question: I cannot download all my dives, only the most recent ones, even though my dive computer’s manual states that it records history of e.g. 999 dives? @@ -7724,7 +7428,7 @@ cannot be salvaged after being overwritten by new dives.

    diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt index 60c11ffcf..788324447 100644 --- a/Documentation/user-manual.txt +++ b/Documentation/user-manual.txt @@ -1,10 +1,10 @@ -// Subsurface 4.5 User Manual +// Subsurface 4.8 User Manual // ========================== // :author: Manual authors: Jacco van Koll, Dirk Hohndel, Reinout Hoornweg, // Linus Torvalds, Miika Turkia, Amit Chaudhuri, Jan Schubert, Willem // Ferguson, Salvador Cuñat, Pedro Neves -// :revnumber: 4.7 -// :revdate:October 2017 +// :revnumber: 4.8.2 +// :revdate:September 2018 :icons: :toc2: :toc-placement: manual @@ -19,7 +19,7 @@ image::images/Subsurface4Banner.jpg["Banner",align="center"] Linus Torvalds, Miika Turkia, Amit Chaudhuri, Jan Schubert, Salvador Cuñat, Pedro Neves, Stefan Fuchs -[blue]#_Version 4.7, May 2018_# +[blue]#_Version 4.8, September 2018_# Welcome as a user of _Subsurface_, an advanced dive logging program with extensive infrastructure to describe, organize, interpret and print scuba