Documentation: Merge/update french user-manual translation

Merge/update french user-manual translation.

Signed-off-by: Guillaume GARDET <guillaume.gardet@free.fr>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>

1 files changed, 234 insertions, 68 deletions

diff --git a/Documentation/user-manual_fr.txt b/Documentation/user-manual_fr.txt
index 6fbcdabc3..2a023f563 100644
--- a/Documentation/user-manual_fr.txt
+++ b/Documentation/user-manual_fr.txt
@@ -1014,6 +1014,18 @@ imported dive log in the _Subsurface_ *Dive List*. Some other formats, not
 accessible through the Import dialogue are also supported, as explained
 below.
 
+==== Importing from Heinrichs Weikamp OSTC Tools
+
+_OSTC Tools_ is a Microsoft-based suite of dive download and dive management
+tools for the OSTC family of dive computers. _OSTC Tools_ downloads dive
+data from the dive computer and stores it as a binary file with file
+extension _.dive_ . Subsurface can directly import these files when using
+the universal import dialogue. From the dropdown list at the bottom right
+select _All files_.  This makes the _OSTC Tools_ dive logs visible in the
+file list panel. Select one or more dive, then click the _Open_ button. The
+OSTC dives are shown in the *Dive List* panel.
+
+
 ==== Importing from Mares Dive Organiser V2.1
 
 Since Mares utilise proprietary Windows software not compatible with
@@ -1652,6 +1664,60 @@ tab only shows the file names of the photos. This is normal behaviour.  If,
 later, the external drive with the photos is connected again, the photos can
 be seen in the normal way.
 
+[[Moving_images]]
+==== Moving photographs among directories, hard disks or computers
+
+After a photograph has been loaded into _Subsurface_ and associated with a specific dive, the directory
+ where the photo lies is stored, allowing _Subsurface_ to find the photograph when the dive is
+ opened again. If the photo or the whole photo collection is moved to another drive or to a different
+ machine, it is unlikely that the directory structure will remain identical to that of the original uploaded
+ photo. When this happens, _Subsurface_ looks for the photos at their original location before they were moved,
+ cannot find them and therefore cannot display them. Because, after moving photos, large numbers of photos
+ may need to be deleted and re-imported from the new location, _Subsurface_ has a mechanism that eases the
+ process of updating the directory information for each photo: automatic updates using fingerprints.
+
+When a photo is loaded into _Subsurface_, a fingerprint for the image is calculated and stored with the
+ other reference information for that photo. After moving a photo collection (that has already been loaded
+ into _Subsurface_) to a different directory, disk or computer, _Subsurface_ can  perform the
+ following steps:
+
+- look through a particular directory (and all its subdirectories recursively)
+  where photos have been moved
+ to,
+
+- calculate fingerprints for all photos in this directory, and
+
+- if there is a match between a calculated fingerprint and the one originally
+  calculated when a photo was
+ loaded into _Subsurface_ (even if the original file name has changed), to
+ automatically update the directory information so that _Subsurface_ can find
+ the photo in the new moved directory.
+
+This is achieved by selecting from the Main Menu: _File ->      Find moved images_. This brings up a window within
+ which the NEW directory of the photos needs to be specified. Select the appropriate directory and click
+ the _Scan_ button towards the bottom right of the panel. The process may require several minutes to
+ complete, after which _subsurface_ will show the appropriate photographs when a particular dive is opened.
+
+
+[[Image_fingerprint_upgrade]]
+****
+*Upgrading existing photo collections without fingerprints*
+[icon="images/icons/important.png"]
+[IMPORTANT]
+
+Software for the automated update of existing photo collections is under
+developement. Currently single dives must be upgraded one at a time. Select
+the toolbar button on the *Dive profile* panel that enables the display of
+images. The thumbnails of images are shown on the dive profile. Then open
+the dive and change anything in the *Notes* panel that brings up the blue
+edit bar at the top of the notes panel to save the edits. For instance, add
+a space character at the end of the _Notes_ text box and immediately delete
+that space character. Select the optio _Apply changes_ in the blue edit bar
+to save the dive information.  Fingerprints are calculated while saving this
+specific dive.
+
+****
+
 
 === Logging special types of dives
 
@@ -2305,9 +2371,9 @@ side of the above figure for a diver using EAN32.
 
 === The Dive List context menu
 
-Many actions within _Subsurface_ are dependent on a context menu used mostly
-to manipulate groups of dives. The context menu is found by selecting a dive
-or a group of dives and then right-clicking.
+Several actions on either a single dive or a group of dives can be performed
+using the Dive List Context Menu, found by selecting either a single dive or
+a group of dives and then right-clicking.
 
 image::images/ContextMenu.jpg["Figure: Context Menu", align="center"]
 
@@ -2350,23 +2416,28 @@ respect to the lowest sequence number to be used.  Completing this operation
 results in new sequence numbers (based on date/time)  for the dives in the
 *Dive List* panel.
 
+One can also renumber a few selected dives in the dive list. Select the
+dives that need renumbering. Right-click on the selected list and use the
+Dive List Context Menu to perform the renumbering. A popup window appears
+requiring the user to specify the starting number for the renumbering
+process.
+
 [[S_Group]]
 === Grouping dives into trips and manipulating trips
 
 For regular divers, the dive list can rapidly become very long. _Subsurface_
 can group dives into _trips_. It performs this by grouping dives that have
-date/times that are not separated in time by more than two days, thus
-creating a single heading for each diving trip represented in the dive
-log. Below is an ungrouped dive list (*A*, on the left) as well as the
-corresponding grouped dive list comprising five dive trips (*B*, on the
-right):
+date/times not separated in time by more than two days, thus creating a
+single heading for each diving trip represented in the dive log. Below is an
+ungrouped dive list (*A*, on the left) as well as the corresponding grouped
+dive list comprising five dive trips (*B*, on the right):
 
 image::images/Group2.jpg["Figure: Grouping dives", align="center"]
 
 Grouping into trips allows a rapid way of accessing individual dives without
 having to scan a long lists of dives. In order to group the dives in a dive
-list, (from the Main Menu) users must select _Log -> Autogroup_. The *Dive
-List* panel now shows only the titles for the trips.
+list, (from the Main Menu) select _Log -> Autogroup_. The *Dive List* panel
+now shows only the titles for the trips.
 
 ==== Editing the title and associated information for a particular trip
 
@@ -2390,16 +2461,16 @@ the trip.
 
 ==== Collapsing or expanding dive information for different trips
 
-If a user right-clicks after selecting a particular trip in the dive list,
-the resulting context menu allows several possibilities to expand or
-collapse dives within trips. This includes expanding all trips, collapsing
-all trips and collapsing all trips except the selected one.
+After selecting a particular trip in the dive list, the context menu allows
+several possibilities to expand or collapse dives within trips. This
+includes expanding all trips, collapsing all trips and collapsing all trips
+except the selected one.
 
 ==== Merging dives from more than one trip into a single trip
 
-By right-clicking on a selected trip title in the *Dive List* panel, a
-context menu shows up that allows the merging of trips by either merging of
-the selected trip with the trip below or with the trip above.
+After selecting a trip title, the context menu allows the merging of trips
+by either merging the selected trip with the trip below or with the trip
+above.(Merge trip with trip below; Merge trip with trip above)
 
 ==== Splitting a single trip into more than one trip
 
@@ -2428,14 +2499,14 @@ duration.
 Users can unlink dives from the trip to which they belong. In order to do
 this, select and right-click the relevant dives to bring up the context
 menu. Then select the option *Remove dive(s)  from trip*. The dive(s) now
-appear immediately above the trip to which they belonged.
+appear immediately above or below the trip to which they belonged, depending
+on the date and time of the unliked dive.
 
 ==== Add a dive to the trip immediately above
 
 Selected dives can be moved from the trip to which they belong and placed
-within the trip immediately above the currently active trip. To do this,
-select and right-click the dive(s) to bring up the context menu, and then
-select *Add dive(s) to trip immediately above*.
+within a separate trip. To do this, select and right-click the dive(s) to
+bring up the context menu, and then select *Create new trip above*.
 
 ==== Shift the start time of dive(s)
 
@@ -2446,7 +2517,7 @@ and right-click the dive(s) to be adjusted. This action brings up the
 context menu on which the *Shift times* option should be selected. User must
 then specify the time (in hours and minutes) by which the dives should be
 adjusted and click on the option indicating whether the time adjustment
-should be forwards or backwards.
+should be ealier or later.
 
 ==== Merge dives into a single dive
 
@@ -2462,6 +2533,15 @@ dives that were merged:
 
 image::images/MergedDive.png["Example: Merged dive", align="center"]
 
+==== Undo dive manipulations
+
+Important actions on dives or trips, described above, can be undone or
+redone.  This includes: _delete dives_, _merge dives_, _renumber dives_ and
+_shift dive times_.  To do this after performing any of these actions, from
+the *Main Menu* select _Edit_. This brings up the possibility to _Undo_ or
+_Redo_ an action.
+
+
 [[S_Filter]]
 === Filtering the dive list
 
@@ -2474,12 +2554,12 @@ dives with a particular buddy.
 To open the filter, select _Log -> Filter divelist_ from the main menu. This
 opens the _Filter Panel_ at the top of the _Subsurface_ window. Three icons
 are located at the top right hand of the filter panel. The _Filter Panel_
-can be reset (i.e. all current filters cleared) by selecting the *+*. The
-_Filter Panel_ may also be minimised by selecting the middle icon. When
-minimised, only these three icons are shown.  The panel can be maximised by
-clicking the icon that minimised the panel. The filter may also be reset and
-closed by selecting the button with the flag.  An example of the _Filter
-Panel_ is shown in the figure below.
+can be reset (i.e. all current filters cleared) by selecting the *yellow
+angled arrow*. The _Filter Panel_ may also be minimised by selecting the
+*green up-arrow". When minimised, only these three icons are shown.  The
+panel can be maximised by clicking the icon that minimised the panel. The
+filter may also be reset and closed by selecting the *red button* with the
+white cross.  An example of the _Filter Panel_ is shown in the figure below.
 
 image::images/Filterpanel.jpg["Figure: Filter panel", align="center"]
 
@@ -2492,14 +2572,13 @@ check list results in the tags check list being reduced to "_cave_" and
 "_cavern_". Filtering of the check list enables the rapid finding of search
 terms for filtering the dive list.
 
-To activate filtering of the dive list, the check box of at least one item
-in one of the four check lists needs to be checked. The dive list is then
-shortened to include only the dives that pertain to the selection criteria
-specified in the check lists.  The four check lists work as a filter with
-_AND_ operators, Subsurface filters therefore for _cave_ as a tag AND _Joe
-Smith_ as a buddy; but the filters within a category are inclusive -
-filtering for _cave_ and _boat_ shows those dives that have either one or
-both of these tags.
+To activate filtering of the dive list, check at least tone check box in one
+of the four check lists. The dive list is then shortened to include only the
+dives that pertain to the criteria specified in the check lists.  The four
+check lists work as a filter with _AND_ operators, Subsurface filters
+therefore for _cave_ as a tag AND _Joe Smith_ as a buddy; but the filters
+within a category are inclusive - filtering for _cave_ and _boat_ shows
+those dives that have either one OR both of these tags.
 
 [[S_ExportLog]]
 == Exporting the dive log or parts of the dive log
@@ -2856,6 +2935,7 @@ the dive profile:
 
 ** _Show unused cylinders in Equipment Tab_: This checkbox allows display of information about unused cylinders when viewing the *Equipment Tab*. Conversely, if this box is not checked, and any cylinders entered using the *Equipment Tab* are not used (e.g. there was no gas switch to such a cylinder), then these cylinders are omitted from that list.
 
+[[GradientFactors_Ref]]
 ** _Show average depth_: Activating this checkbox causes _Subsurface_ to draw a grey line across
    the dive profile, indicating the mean depth of the dive up to a particular point in time during
    that dive. Normally this is a u-shaped line indicating the deepest average depth just before the
@@ -2998,19 +3078,20 @@ messages about the dive plan are printed.
 image::images/PlannerWindow1_f20.jpg["FIGURE: Dive planner startup window", align="center"]
 
 
-=== Open circuit dives as an example of dive planning
+=== Open circuit dives
 
--  Towards the left bottom of the planner (circled in blue in the image below)
-   is a dropbox with three options. Select the appropriate one of these:
+-  Towards the centre bottom of the planner (circled in blue in the image
+   above) is a dropbox with three options. Select the appropriate one of these:
  ** Open Circuit (the default)
  ** CCR
  ** pSCR
 
+- Choose the Open Circuit option.
 - In the top left-hand area of the planning screen, ensure that the constant
-  dive parameters are appropriate. These are: Start date and time of the dive,
-  Atmospheric Pressure and Altitude above sea level of the dive site. The
-  atmospheric pressure can also be entered as an altitude in metres, assuming
-  an atmospheric pressure of 1.013 bar.
+  dive parameters are appropriate. These are: Start date and time of the
+  intended dive, Atmospheric Pressure and Altitude above sea level of the dive
+  site. The atmospheric pressure can also be entered as an altitude in metres,
+  assuming a sea-level atmospheric pressure of 1.013 bar.
 
 - In the table labeled _Available Gases_, add the information of the cylinders
   to be used as well as the gas composition within that cylinder. This is done
@@ -3022,10 +3103,96 @@ image::images/PlannerWindow1_f20.jpg["FIGURE: Dive planner startup window", alig
   the boxes provided in this dialogue. Add additional cylinders by using the
   "+" icon to the top righthand of the dialogue.
 
-- The dialogue indicating _Dive Planner Points_ is usually not used at this
-  stage of the dive planning.
+- The profile of the planned dive can be created in two ways:
+ *  Drag the waypoints (the small white circles) on the existing dive profile in
+    a way to represent the dive. Additional waypoints can be created by
+    double-clicking the existing dive profile. Waypoints can be deleted by
+    right-clicking a particular waypoint and selecting the _delete_ item from
+    the resulting context menu.
+ *  The most efficient way to create a dive profile is to enter the appropriate
+    values into the table marked _Dive planner points_. The first line of the
+    table represents the duration and the final depth of the descent from the
+    surface. Subsequent segments describe the bottom phase of the dive.  The _CC
+    set point_ column is only relevant for closed circuit divers.  The ascent is
+    usually not specified because this is what the planner is supposed to
+    calculate.  Add additional segments to the profile by selecting the "+" icon
+    at the top right hand of the table. Segments entered into the _Dive planner
+    points_ table automatically appear in the *Dive Profile* diagram.
+
+==== Recreational dives
+
+The _Subsurface_ dive planner allows a sophisticated way of planning
+recreational dives, i.e. dives that remain within no-decompression limits.
+The dive planner automatically takes into account the nitrogen load incurred
+in previous dives. But conventional dive tables are also used in a way that
+can take into account previous dives. Why use a dive planner for
+recreational dives? Using recreational dive tables, the maximum depth of a
+dive is taken into acount. However, few dives are undertaken at a constant
+depth corresponding to the maximum depth (i.e. a "square" dive
+profile). This means that dive tables overestimate the nitrogen load
+incurred during previous dives. The _Subsurface_ dive planner calculates
+nitrogen load according to the real dive profiles of all uploaded previous
+dives, in a similar way as dive computers calculate nitrogen load during a
+dive. This mean that the diver gets 'credit' in terms of nitrogen loading
+for not remaining at maximum depth during previous dives, enabling planning
+a longer subsequent dive. For the planner to work it is therefore crucial to
+upload all previous dives onto _Subsurface_ before performing dive planning.
+
+To plan a dive, the appropriate settings need to be defined.
+
+Ensure that the date and time is set to that of the intended dive. This
+allows calculation of the nitrogen load incurred during previous dives.
+
+- Immediately under the heading _Planning_ are two checkboxes _Recreational_
+  and _Safety Stop_.  Check these two boxes.
+
+- Then define the cylinder size, the gas mixture (air or % oxygen) and the
+  starting cylinder pressure in the top left-hand section of the planner under
+  _Available gases_.
+
+- The planner calculates whether the specified cylinder contains enough
+  air/gas to complete the planned dive. In order for this to be realistic,
+  under _Gas options_, specify an appropriate surface air consumption (SAC)
+  rate for _Bottom SAC_. Suitable values are between 15 l/min and 30 l/min,
+  with novice divers or difficult dives requiring SAC rates closer to 30l/min.
+
+- Define the amount of gas that the cylinder must have at the end of the
+  bottom section of the dive just before ascent. A value of 50 bar is often
+  used.
+
+- Define the depth of the dive by dragging the waypoints (white dots) on the
+  dive profile or (even better) defining the appropriate depths using the
+  table under _Dive planner points_ as desribed under the previous heading. If
+  this is a multilevel dive, set the appropriate dive depths to represent the
+  dive plan by adding waypoints to the dive profile or by adding appropriate
+  dive planner points to the _Dive Planner Points_ table.
+
+- The ascent speed can be changed. The default ascent speeds are those
+  considered safe for recreational divers.
+
+The dive profile in the planner indicates the maximum dive time within
+no-deco limits using the Bühlmann ZH-L16 algorithm and the gas and depth
+settings specified as described above. The _Subsurface_ planner allows rapid
+assessment of dive duration as a function of dive depth, given the nitrogen
+load incurred during previous dives. The dive plan includes estimates of the
+amount of air/gas used, depending on the cylinder settings specified under
+_Available gases_. If the initial cylinder pressure is set to 0, the dive
+duration shown is the true no-deco limit (NDL) without taking into account
+gas used during the dive. If the surface above the dive profile is RED it
+means that recreational dive limits are exceeded and either the dive
+duration or the dive depth needs to be reduced.
 
-*The planning is performed in three stages*
+Below is an image of a dive plan for a recreational dive at 30
+metres. Although the no-deco limit (NDL) is 23 minutes, the duration of the
+dive is limited by the amount of air in the cylinder, reflected by the
+information in the text box at the bottom right of the panel.
+
+image::images/rec_diveplan.jpg["FIGURE: A recreational dive plan: setup", align="center"]
+
+==== Non-recreational open circuit dives, including decompression
+
+Non-recreational dive planning involves exceeding the no-deco limits and/or
+using multiple breathing gases.  Such dives are planned in three stages:
 
 *a) Nitrogen management*: This is performed by specifying the rates for descent and ascent,
 as well as the gradient factors (GFLow and GFHigh) under the headings _Rates_ and _Planning_
@@ -3055,7 +3222,6 @@ _Drop to first depth_ is activated, then the descent phase of the planned
 dive will be at the maximal descent rate specified in the _Rates_ section of
 the dive setup.
 
-
 *b) Oxygen management*: In the *Gas Options* part of the dive specification, the maximum partial
 pressure for oxygen needs to be specified for the
 bottom part of the dive (_bottom po2_) as well as for the decompression part of the dive (_deco po2_).
@@ -3152,6 +3318,25 @@ INCLUDES the transition time to get to that level. However, if the _Display
 transition in deco_ option is checked, the transitions are shown separately
 from the segment durations at a particular level.
 
+=== Planning pSCR dives
+
+To plan a dive using a passive semi-closed rebreather (pSCR), select _pSCR_ rather than
+_Open circuit_ in the dropdown list.
+The parameters of the pSCR diver can be set by selecting  _File ->   Preferences ->   Graph_
+from the main menu, where the gas consumption calculation takes into account the pSCR dump
+ratio (default 10:1) as well as the metabolism rate. The calculation also takes the oxygen drop
+accross the mouthpiece of the rebreather into account. If the
+pO~2~ drops below what is considered a save value, a warning appears in the _Dive plan
+details_. A typical pSCR configuration is with a single cylinder and one or more bail-out
+cylinders. Therefore the setup of the _Available gases_ and the _Dive planner points_ tables
+are very similar to that of a CCR dive plan, described above. However, no oxygen setpoints
+are specified for pSCR dives. Below is a dive plan for a pSCR dive. The dive is comparable
+to that of the CCR dive above, but note the longer ascent duration due to the lower oxygen
+in the loop due to the oxygen drop across the mouthpiece of the pSCR equipment.
+
+image::images/Planner_pSCR1_f20.jpg["FIGURE: Planning a pSCR dive: setup", align="center"]
+
+
 === Planning CCR dives
 
 To plan a dive using a closed circuit rebreather, select the _CCR_ option in
@@ -3176,25 +3361,6 @@ image::images/Planner_CCR1_f20.jpg["FIGURE: Planning a CCR dive: setup", align="
 Note that, in the _Dive plan details_, the gas consumption for a CCR segment
 is not calculated, so gas consumptions of 0 litres are the norm.
 
-=== Planning pSCR dives
-
-To plan a dive using a passive semi-closed rebreather (pSCR), select _pSCR_ rather than
-_Open circuit_ in the dropdown list.
-The parameters of the pSCR diver can be set by selecting  _File ->   Preferences ->   Graph_
-from the main menu, where the gas consumption calculation takes into account the pSCR dump
-ratio (default 10:1) as well as the metabolism rate. The calculation also takes the oxygen drop
-accross the mouthpiece of the rebreather into account. If the
-pO~2~ drops below what is considered a save value, a warning appears in the _Dive plan
-details_. A typical pSCR configuration is with a single cylinder and one or more bail-out
-cylinders. Therefore the setup of the _Available gases_ and the _Dive planner points_ tables
-are very similar to that of a CCR dive plan, described above. However, no oxygen setpoints
-are specified for pSCR dives. Below is a dive plan for a pSCR dive. The dive is comparable
-to that of the CCR dive above, but note the longer ascent duration due to the lower oxygen
-in the loop due to the oxygen drop across the mouthpiece of the pSCR equipment.
-
-image::images/Planner_pSCR1_f20.jpg["FIGURE: Planning a pSCR dive: setup", align="center"]
-
-
 [[S_Replan]]
 === Modifying an existing dive plan
 
@@ -3717,8 +3883,8 @@ naming conventions to export dive log data.
    appropriate dives.
 4. Within the list of dives, select the dives you would like to import later:
 	* To select certain dives: hold 'ctrl' and click the dive
-	* To select all dives: Select the first dive, hold down shift and
-          select the last dive
+	* To select all dives: Select the first dive, hold down shift and select the
+	  last dive
 5. With the dives marked, use the program menu _File -> Export_
 6. The export pop-up will show. Within this pop-up, there is one field called
    'Export Path'.