Changeset 208f4f2 in subsurface


Ignore:
Timestamp:
Jan 6, 2017, 8:45:41 PM (6 weeks ago)
Author:
Dirk Hohndel <dirk@…>
Branches:
master
Children:
c084887
Parents:
aaa46c2
git-author:
Willem Ferguson <willemferguson@…> (01/04/17 07:39:53)
git-committer:
Dirk Hohndel <dirk@…> (01/06/17 20:45:41)
Message:

User manual updates

Update sections on:

1) Facebook integration
2) Events (notifications, warnings,alarms) on dive profile
3) Divelist icons indicating associated photographs

3 images replaced, 4 added.

Signed-off-by: Willem Ferguson <willemferguson@…>
Signed-off-by: Dirk Hohndel <dirk@…>

Location:
Documentation
Files:
6 added
2 deleted
2 edited

Legend:

Unmodified
Added
Removed
  • Documentation/user-manual.txt

    r4e375f56 r208f4f2  
    910910All the selected dives now contain the data initially selected in the original source dive log.
    911911
     912[[S_Bookmarks]]
    912913==== Adding Bookmarks to a dive
    913914
     
    18081809If the external drive with the photos is re-connected, the photos can be seen in the normal way.
    18091810
     1811==== Finding out which dives have associated photos.
     1812Inspecting each individual dive in order to determine whether there are associated photos can be time consuming. There is a
     1813rapid way of seeing which dives have associated photos and which not: activate the _Photos_ checkbox in the dropdown
     1814list obtained by right-clicking on the header bar of the *Divelist*. In the *Divelist*, all dives with associated photographs
     1815have an icon indicating whether the photographs 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 <<S_Divelist_columns, photo icons on the *Divelist*>>.
     1816
    18101817[[S_FindMovedImages]]
    18111818==== Moving photographs among directories, hard disks or computers
     
    18511858
    18521859****
    1853 
    18541860
    18551861=== Logging special types of dives
     
    21582164placed adjacent to significant changes.
    21592165
    2160 
    21612166[[S_InfoBox]]
    21622167==== The *Information Box*
     
    22352240Figure (*B*) above shows an information box with a nearly complete set of data.
    22362241
     2242
    22372243[[S_gas_pressure_graph]]
    22382244===== The Gas Pressure Bar Graph
     
    22952301  The pressures in the fast compartments do not approach the GFHigh value any more and the diver is safer
    22962302  than in the situation indicated in graph *D*.
     2303
     2304==== Computer-reported events during dive
     2305Many dive computers record events during a dive. For instance,
     2306most dive computers report alarms relating to high partial pressures of oxygen,
     2307to rapid ascents or the exceeding of no-deco limits (NDL).
     2308On the other hand, other events are classified as warnings and, for instance, occur when
     2309the remaining gas in a cylinder falls below a predetermined limit, a deep stop needs to be performed or
     2310the need to change gas during multicylinder dives. Some dive computers also report notifications,
     2311e.g. when a safety stop is initiated or terminated or when a predetermined amount of OTUs have been incurred.
     2312The alarms, warnings and notifications differs from one dive computer to another: some dive computers do not
     2313report any of the above events, while others provide an extensive log of events. The reporting of events
     2314is therefore a function of the dive computer used. In addition, _Subsurface_ does not always
     2315have the ability to detect all the events reported by a specific dive computer.
     2316
     2317Events are indicated by symbols on the dive profile. Notifications are shown as a white, round symbol with a letter _i_;
     2318warnings are indicated by a yellow triangle and alarms by a red triangle. By moving the cursor over a symbol,
     2319the explanation is given in the bottom-most line of the _Information Box_ (see image below, where the cursor is positioned
     2320over the alarm that was reported).
     2321
     2322image::images/profile_symbols.jpg["FIGURE: Profile notification symbols",align="center"]
     2323
     2324Some dive computers report _bookmarks_ that the diver has set during the dive. These are indicated as
     2325a small red flag on the profile and are discussed more fully in the section on
     2326<<S_Bookmarks,_inserting bookmarks_>>.
    22972327
    22982328==== The Profile Toolbar
     
    25562586The context menu is used in many functions described below.
    25572587
     2588[[S_Divelist_columns]]
    25582589==== Customizing the columns showed in the *Dive List* panel
    25592590
     
    25622593The default information in the *Dive List* includes, for each dive, Dive_number, Date, Rating, Dive_depth,
    25632594Dive_duration and Dive_location. This information can be controlled and changed by right-clicking on the
    2564 header bar of the *Dive List*. For instance, a right-click on the 'Date' header brings up a list of items
    2565 that can be shown in the dive list (see above). Select an item to be included in the *Dive List* or to be
    2566 deleted (reflected by the check symbols) and the list is immediately updated. Preferences for information
     2595header bar of the *Dive List*, bringing up a list of columns
     2596that can be shown in the dive list (see above). Check an items to be included in the *Dive List*.
     2597The list is immediately updated. Preferences for information
    25672598shown in the *Dive List* are saved and used when _Subsurface_ is re-opened.
     2599
     2600[[S_Photos_divelist]]
     2601
     2602By selecting the _Photos_ checkbox in the dropdown list, an icon is shown indicating whether any photos
     2603are associated with a particular dive. There are three icons:
     2604
     2605[icon="images/icons/duringPhoto.png"]
     2606[NOTE]
     2607This dive has photographs taken during the dive, typically using an underwater camera.
     2608
     2609[icon="images/icons/outsidePhoto.png"]
     2610[NOTE]
     2611This dive has photographs taken immediately before or immediately after the dive. This is useful for
     2612finding photos of dive teams or boats just before/after the dive, whales or other surface animals seen
     2613just before or after the dive, or of landscapes as seen from the boat.
     2614
     2615[icon="images/icons/inAndOutPhoto.png"]
     2616[NOTE]
     2617This dive has photographs taken both during the dive and immdiately before or after the dive.
    25682618
    25692619[[S_Renumber]]
     
    27512801Export of dives to _Facebook_ is handled differently from other types of export because
    27522802a connection to _Facebook_ is required, needing a _Facebook_ userID and password.
    2753 If, from the *Main Menu*, you select _Share on -> Connect to -> Facebook_, a login screen comes up.
    2754 (image *A* to the left, below).  Provide a _Facebook_ userID and password.
    2755 Once logged into to _Facebook_ , the panel
    2756 in image *B*, below is shown, including a _Disconnect from Facebook_ button to close the
    2757 _Facebook_ connection.
    2758 
    2759 image::images/facebook1_f20.jpg["Figure: Facebook login",align="center"]
    2760 
    2761 From the _Subsurface_ window it’s easy to determine whether _Subsurface_ has a valid connection to _Facebook_
    2762 From the *Main Menu*, select _Share on_ (image *A*, below). Normally, the _Facebook_ option is greyed out. But
     2803From the *Main Menu*, select _Share on -> Connect to -> Facebook_ (image *A* below)
     2804A _Facebook_ login screen appears (image *B* below). Provide a _Facebook_ userID and password.
     2805From the _Subsurface_ window it’s easy to determine whether _Subsurface_ has a valid connection to _Facebook_:
     2806from the *Main Menu*, select _Share on_ (image *A*, below). Normally, the _Facebook_ option is greyed out. But
    27632807if there is a connection to _Facebook_, this option is active (i.e. in black color and can be selected).
    27642808
    2765 Having established a login to _Facebook_, transferring a dive profileto a _Facebook_ timeline is easy.
    2766 Ensure that the dive to be transferred to the timeline is shown in the _Subsurface_ *Dive Profile* panel. If, from the *Main Menu*, you
    2767 select _Share on -> Facebook_ (see image *A* below), a dialogue box is shown, determining the amount of additional information transferred along
    2768 with the dive profile (image *B*, below). To transfer a dive profile to _Facebook_, the name of a
    2769 _Facebook_ album is needed. The checkboxes on the left hand side let you decide how much
    2770 additional information should be transferred with the dive profile. This information is shown in the text box
    2771 on the right hand side of the panel (image *B*, below). You can easily edit the message that will be posted
    2772 with the dive profile.  After specifying the additional information and verifying the text, select
    2773 the _OK_ button that triggers the transfer to _Facebook_. After the transfer
     2809Once logged into to _Facebook_ , a panel is shown with a message:
     2810"_To disconnect Subsurface from your Facebook account, use the 'Share on' menu entry_."
     2811Close this message panel.
     2812
     2813image::images/facebook1.jpg["Figure: Facebook login",align="center"]
     2814
     2815Having established a login to _Facebook_, transferring a dive profile to a _Facebook_ timeline is easy.
     2816In the _Subsurface_ *Dive Profile* panel, highlight the dive to be transferred. A dialogue box
     2817is shown, determining the amount of additional information to be transferred
     2818with the dive profile (image *A*, below). To transfer a dive profile to _Facebook_, the name of a
     2819_Facebook_ album is needed. The checkboxes on the left hand side determine how much
     2820additional information is added to the dive profile, shown in the text box
     2821on the right hand side of the panel (image *A*, below). Customise the message that will be posted
     2822with the dive profile by editing any of the information. After specifying additional information
     2823and verifying the text, select the _OK_ button that triggers the transfer to _Facebook_. After the transfer
    27742824is done, an acknowledgement dialogue appears, indicating it was successful.
    27752825
    2776 Both the album created and the post to your timeline will be marked as
    2777 private. In order for friends to be able to see it,
    2778 change its permissions from a regular Facebook login either in a
    2779 browser or a Facebook app.
    2780 
    2781 image::images/facebook2_f20.jpg["Figure: Facebook login",align="center"]
    2782 
    2783 If required, then close the _Facebook_ connection by either closing _Subsurface_ or by selecting _File ->  Preferences ->  Facebook_ from
    2784 the Main Menu, and clicking the appropriate button on the Facebook Preferences panel.
     2826Both the album created and the post to your timeline are marked as
     2827private. In order for friends to be able to see the post,
     2828log into _Facebook_ using a browser or Facebook app and change its permissions.
     2829
     2830image::images/facebook2.jpg["Figure: Facebook data submission",align="center"]
     2831
     2832If required, then close the _Facebook_ connection by selecting, from the *Main Menu*,
     2833_Share on ->  Disconnect from -> Facebook_ (image *B* above).
    27852834
    27862835[[S_Export_other]]
Note: See TracChangeset for help on using the changeset viewer.