Commit graph

109 commits

Author SHA1 Message Date
Robert C. Helling
4c8355aba0 User manual: TeX export
Explain how to use the TeX export

Signed-off-by: Robert C. Helling <helling@atdotde.de>
2017-01-10 23:03:49 -08:00
Willem Ferguson
a6f9a37831 User manual updates
Update:
1) Text dealing with SmartTrak import. Move text, some corrections,
   add image.
2) Text dealing with command-line arguments.

A few other small changes.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2017-01-07 07:19:12 -08:00
Willem Ferguson
208f4f2166 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@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2017-01-06 20:45:41 -08:00
Willem Ferguson
91a13ae09c User manual routine update (3)
This is the third update of the user manual. Mostly last section
before appendices. Still some work remains in this part,
dependent on queries to questions I raised.

The images for the preferences section are replaced.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-11-09 06:25:11 -08:00
Rick Walsh
3f060c5c28 User manual: replace heatmap comparison graphic
The new heatmap graphic reflects how the heatmap is now displayed. Also update
text describing graphic.

Signed-off-by: Rick Walsh <rickmwalsh@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-11-05 12:53:35 -07:00
Willem Ferguson
6bee4babd3 Routine maintenance of user manual (2)
Episode 2 of current round of maintenance.
Two images replaced with three new images.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-11-05 12:53:18 -07:00
Willem Ferguson
b478d75303 User-manual: More updated to heat map
Changes to the heatmap image in the user manual as well as some small changes
to sync the text with the new image.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-10-27 20:37:46 -07:00
Willem Ferguson
a0179e0e57 User-manual: Heat map
1) Replace the existing graphics for explaining the heat map.
2) Update the text for explaining the heat map.
These changes with substantial input from Rick Walsh.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-10-27 20:37:32 -07:00
Willem Ferguson
1801a6888f Subsurface User Manual: Update section dealing with heat map. Move section about Information Box lower down in user manual.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-10-11 22:03:40 -07:00
Rick Walsh
fbcf4b9bd3 User manual: actually add new images
Signed-off-by: Rick Walsh <rickmwalsh@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-10-03 07:59:40 -07:00
Rick Walsh
f2ed9ede77 User manual: include tissue heatmap graphics
Signed-off-by: Rick Walsh <rickmwalsh@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-09-27 21:34:15 -07:00
Willem Ferguson
9803d7acde User manual update: Subsurface-mobile
Subsurface user manual update: Subsurface-mobile

Provide text for the use of Subsurface-mobile to collect
GPS positions, upload these and sync the stored GPS positions
with dives in the dive list. Two images added.

This is in addition to documentation for the Companion App.

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

From f2062208b1cc76743280428227e8a31e51732dc9 Mon Sep 17 00:00:00 2001
From: Willem Ferguson <willemferguson@zoology.up.ac.za>
Date: Sun, 19 Jun 2016 14:29:19 +0200
Subject: [PATCH 4/4] Subsurface user manual update: Subsurface-mobile

Provide text for the use of Subsurface-mobile to collect
GPS positions, upload these and sync the stored GPS positions
with dives in the dive list.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-06-20 18:40:00 -07:00
Willem Ferguson
c9081e5975 Corrections to user manual
Replace one icon and correct text to show an image.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-06-18 11:22:56 -07:00
Willem Ferguson
95b997c469 User Manual update
Update section of user manual dealing with searching the manual
and following links in the manual.
Repaired one omage, added a second

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-06-18 11:22:56 -07:00
Willem Ferguson
dffd2857f6 User manual updates
1) Delete duplicate or unused images in Documentation/images directory
2) Add text to describe user manual viewer functionality
3) Add image to explain 2) above
4) Add text to explanation of TTS toolbar button (Thank you very much, Davide!)
5) Update image showing display of TTS toolbar button

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-10-19 09:46:02 -07:00
Willem Ferguson
846a4ce319 User manual update: Facebook
1) Update the image relating to fb access
2) Update the text relating to fb access
3) Update text about imgae fingerprints
4) Replace 6 more images to reflect latest UI

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-10-13 07:50:15 -07:00
Willem Ferguson
b2deb28f58 User manual updates: Dive site management and others
1) Update the text on dive site management to make it cohesive.
2) Update text on recreational dive planning.
3) Replace one image for rectreational dive planning.
4) Perform several small changes to correct inaccuracies
   or inconsistencies pointed out by Sergey.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-10-12 12:54:56 -07:00
Willem Ferguson
38f2e310f3 User manual: Print dive logs
--001a11c260ce9093a70521eafe5d
Content-Type: text/plain; charset=UTF-8

 [PATCH] User manual: Print dive logs

    This patch replaces two figures in the user manual, concerning the
    printing of dive logs.

    1) Two images are replaced.

    2) The text of the user manual is changed to reflect the latest code.

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

<div dir="ltr"> [PATCH] User manual: Print dive logs<br>    <br>    This patch replaces two figures in the user manual, concerning the<br>    printing of dive logs.<br>    <br>    1) Two images are replaced.<br>    <br>    2) The text of the user manual is changed to reflect the latest code.<br>    <br>    Signed-off-by: Willem Ferguson &lt;<a href="mailto:willemferguson@zoology.up.ac.za">willemferguson@zoology.up.ac.za</a>&gt;<br><br></div>

From 2f0b54fe6e38014b909ed1d9c6acb797921a5158 Mon Sep 17 00:00:00 2001
From: Willem Ferguson <willemferguson@zoology.up.ac.za>
Date: Mon, 12 Oct 2015 18:37:54 +0200
Subject: [PATCH] [PATCH] User manual: Print dive logs

This patch replaces two figures in the user manual, concerning the
printing of dive logs.

1) Two images are replaced.

2) The text of the user manual is changed to reflect the latest code.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-10-12 09:53:07 -07:00
Willem Ferguson
3f457edcf6 User manual: Preferences panels.
Six of the images in the text describing the Preferences are replaced
to reflect the latest code.

One addition image is added, describing georeferencing.

The text of the user manual is updated to reflect the new images.
Many typos are corrected.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-10-12 09:52:56 -07:00
Claudiu Olteanu
8462ae27b2 User manual update: Bluetooth section
Update the user manual with information about the new Bluetooth
download mode feature.

Signed-off-by: Claudiu Olteanu <olteanu.claudiu@ymail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-09-25 09:57:11 -07:00
Willem Ferguson
a761a33069 User manual: Bluetooth UI description
1) Inser Bluetooth UI description at end of section dealing with dive download.
2) Delete existing text in appendices that detail pairing a Bluetooth device with
   the Subsurface computer.

One image is added to the manual.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-09-22 19:36:54 -07:00
Willem Ferguson
ce134fb763 User manual update 1) replace three images 2) change text of user manual to reflect the three images correctly
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-09-21 10:16:50 -07:00
Willem Ferguson
d0b26c6e57 User manual update: Dive planner
1) Added text to reflect VPM-B dive planning
2) Replaced 5 images in dive planner chapter.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-09-14 21:01:07 -07:00
Willem Ferguson
e4c0f3f3e2 User manual update: Location management
1) Add text to cover location management
2) Delete duplicate text for entering dives manually
   and entering dives from a dive computer. The sections dealing
   with location, cylinders, weights, and other items on the Info tab
   were duplicated for these two types of data entry into Subsurface.
   This duplication is now removed.
3) Replace five screen shots

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-09-08 10:06:10 -07:00
Willem Ferguson
384ab944f2 Updates to user manual: dive log printing and APD CCR import
Updates to the APD import interface that Miika has recently completed.
Updates to reflect the new print interface. Added some images and modified
existing text.
Swapped APPENDIX E and APPENDIX F so that FAQs are at end of document.
Updated appendix [F] dealing with customising print templates.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-09-07 07:28:13 -07:00
Gehad elrobey
4a988aa868 Printing: update user-manual images
Add updated user-manual images, with the new dialog UI.

Signed-off-by: Lubomir I. Ivanov <neolit123@gmail.com>
Signed-off-by: Gehad elrobey <gehadelrobey@gmail.com>
2015-08-22 18:32:44 +03:00
willem ferguson
2894ee0759 User manual update
This adds text to the following sections:
1) Dive planner (Open circuit planning)
2) Dive Planner (Recreational OC planning)
3) Use of hashes to move images between directories
4) Undo/Redo feature of dive list manipulations

One image in planner text is modified.

Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-05-02 11:26:39 -07:00
willem ferguson
2286bc89de Add text to user manual: Recreational dive planning One figure has been added
Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-04-30 07:18:28 -07:00
Sergey Starosek
4817bb2991 Add missing Atomic Aquatics logo
Signed-off-by: Sergey Starosek <sergey.starosek@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-02-10 10:45:46 -08:00
willem ferguson
31eb65b42b Update screenshots for user-manual
We want to get rid of the dreaded red line.
This gets rid of some of the last Ubuntu screenshots.

Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-02-06 09:50:35 -08:00
willem ferguson
7b44cf2a61 User manual: small updates
A section on multicylinder dives has been added.
Just to warm LongJohnSilver's heart, a short section on pSCR has been added.
Please feel free to add to the pSCR section, LongJohn.
Replaced the sidemount figure with obsolete mean depth line.

Fixes #827
Fixes #828

Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-02-05 11:27:35 -08:00
willem ferguson
6913ff578c User-manual: Add text and images for Facebook intergration 5 images are changed and four more are added.
Dirk, please read the paragraph marked *Important* to make sure
it does not constitute utter rubbish.

Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-02-02 07:10:40 -08:00
willem ferguson
66c4529088 User manual: Updates for iphone app for subsurface GPS serevice
I did some editing of the image to increase contrast and make the text in
the screen shots more readable. In the process I also reduced the size of
the image substantially. I have also edited the text somewhat.

Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-01-31 10:21:59 -08:00
willem ferguson
6ae5c9271d User-manual: Dive planner text
I took Robert's contribution describing the dive planner and expanded it a
bit, added two more graphics to show CCR and pSCR dive planning, and
changed a third image.

Moved the section dealing with configuring a dive computer to be in a more
logical place, just before the Subsurface Settings.

Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-01-30 17:13:08 -08:00
Miika Turkia
a6d9a559c1 Document iPhone companion app
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-01-30 09:56:07 -08:00
willem ferguson
d136651d12 User-manual: Update figures for section on dive planner
Update the two existing images for the section dealing with the
dive planner. This is to make things a little easier for Robert
who will be generating some text for this part of the manual.

Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-01-29 06:55:13 -08:00
willem ferguson
15dad0714e User-manual: replace images
Seven images disappeared from the /images directory. This replaces them.
Four more images are converted to fedora/KDE format. This is part of the
drive to convert all screenshots to reflect fedora/KDE

The only changes in user-manual.txt are the references to the four
newly-converted images.

Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-01-29 06:54:23 -08:00
Krzysztof Arentowicz
64ef4c2e8d User manual: add note about xdeep data import
Attached.
Patch contains an image of xdeep black DC.
I asked them if they're ok with using this file in the manual and got the permission.

thanks,
Krzysiek

From 971a244b8f2584bc1c3fc294cf5bb98c22d303be Mon Sep 17 00:00:00 2001
From: Krzysztof Arentowicz <k.arentowicz@gmail.com>
Date: Sat, 10 Jan 2015 20:24:22 +0100
Subject: [PATCH] User manual: add note about xDEEP BLACK data import

Note is ilustrated by xDEEP BLACK picture by xDEEP.
I have aquired a written permision from xDEEP to use this file.

Signed-off-by: Krzysztof Arentowicz <k.arentowicz@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-01-28 09:36:08 -08:00
willem ferguson
bc7d233365 User manual: Tying up loose ends
As the heading above says.
1) Place user manual option in main menu at the bottom of the Help submenu.
   It is more easily seen in that position.
2) Replace two images. I forgot one of the images that had been changed to F20 format.
3) A few small changes, including in the systematic description of the main menu.

Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-01-27 22:58:38 -08:00
willem ferguson
0a0e930f03 User manual updates (part 3 of 3)
This patch updates several areas of the manual:
1) The import from dive computer using the new UI panel.
2) The section dealing with exports
3) Many other small changes.

Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-01-27 22:58:21 -08:00
willem ferguson
2516752cab Updates to user-manual (2 of 3)
Changes to the user-manual to achieve the following:
1) Remove duplication of CCR information
2) Remove duplication in CSV import information
3) rewrite the section dealing with CSV import.

2 images were added to the user-manual.

Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-01-26 09:25:02 -08:00
willem ferguson
47c5a28fb0 Updates to user-manual
These updates concern:
Export options for dive logs (File->Export)
Preferences panel, especially CCR and pSCR preferences
Display of CCR dives.
7 images were either replaced or added.

Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-01-25 12:02:13 -08:00
willem ferguson
a0f7be7585 Changes to user manual to reduce image sizes
Some image sizes were in excess of 200 kB in size. All images larger
than 100 kB were reduced in size to below 70 kB. In the process there
was a conversion of some images from Unity to F20 KDE.

Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-12-21 11:00:29 -08:00
willem ferguson
295b9897ce Update to user manual: sidemount and images
1) Add short section dealing with logging of sidemount dives (1 image)
2) Replace three images in section on CSV export from LibeOffice

Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-12-19 07:13:35 -08:00
willem ferguson
dae0c9dffb User manual update
Small changes throughout the manual. Typos, spelling, rephrasing
a few sentences, moving links to other sections, reformatting of
paragraphs here and there.

Edits to one image. (CSV export from Windows)

[Dirk Hohndel: dropped removal of Appendix E from this patch]

Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-12-17 11:44:12 -08:00
Dirk Hohndel
ad4389aacb Merge branch 'testdoc'
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>

Conflicts:
	Documentation/user-manual.txt
2014-12-16 07:13:46 -08:00
willem ferguson
86d6a1488e Update of user manual to give much more information about CSV dive log import
This patch addresses several issues:
1) At the beginning of the manual a section was rewritten, just after
   "How to open a new log book", to explain to the newby what the
   different options are for enetering dive data into the Subsurface
   dive log.
2) A new section "A diver's introduction to CSV files" was written as
   a boxed section.
3) The section dealing with CSV import from dive computers was
   shortened because much of the information was transferred to
   the new section in point 2) above.
4) The section dealing with CSV import from manually kept dive
   logs was expanded, specifically giving more information
   about import from manually kept dive logs in spreadsheets.
5) Appendix D was added, detailing CSV export from LibreOffice,
   OpenOffice and Microsoft Excel.

Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-12-16 07:11:21 -08:00
Pedro António Neves
0e3fb549bd New images for the user manual
Added 3 more images to the User Manual (Appendix E).
Images illustrate the creation of .CSV file from LibreOffice Calc.

Signed-off-by: Pedro António Neves <nevesdiver@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-12-14 10:08:34 -08:00
Pedro António Neves
9b924b4fdd Updated User Manual to include information on how to add dive data to a new logbook.
- Changed section 4 name to: Storing dive information in the logbook (to keep it in line with the other titles)

- Added some introductory text to section 4, together with links to the appropriate sections on the manual

- Changed figure Import_CSV2.jpg to reflect date format options

- Added an Appendix (E) explaining users how to create a .CSV file from LibreOffice Calc

- Added 3 more images to illustrate Appendix E

Signed-off-by: Pedro António Neves <nevesdiver@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-12-14 10:08:16 -08:00
Willem Ferguson
e7698beea7 User manual: Eight more figures replaced
Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-12-11 04:20:44 -07:00