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>
Backport to 4.4.1 because of unresolved merge conflicts from f1f0294
Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
The manuals all will need a careful read.
The changes to use lsb-release and the PCLinuxOS specific files got lost
because I didn't want to try to rewite this in the middle of a merge.
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Conflicts:
Documentation/50-pot/subsurface-manual.pot
Documentation/fr/po/subsurface-manual.fr.po
Documentation/user-manual.txt
Documentation/user-manual_es.txt
Documentation/user-manual_fr.html.git
Documentation/user-manual_fr.txt
Documentation/user-manual_ru.html.git
Documentation/user-manual_ru.txt
file.c
qthelper.cpp
subsurface.pro
subsurfacesysinfo.cpp
xslt/DiveLog.xslt
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#827Fixes#828
Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
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>
Facebook integration.
Damn, my last patch is always late for the release.
Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Refactored the parsing logic to make it more solid (no more guessing) and
more flexible (support more formats).
Added a test for checking that.
Fixed a few warnings.
[Dirk Hohndel: some changes to coding style]
Signed-off-by: Patrick Valsecchi <patrick@thus.ch>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
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>
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#827Fixes#828
Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Facebook integration.
Damn, my last patch is always late for the release.
Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Refactored the parsing logic to make it more solid (no more guessing) and
more flexible (support more formats).
Added a test for checking that.
Fixed a few warnings.
[Dirk Hohndel: some changes to coding style]
Signed-off-by: Patrick Valsecchi <patrick@thus.ch>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
This file is straight from WordPress and therefore has the odd mixed
markup of WordPress. Some HTML, some shortcodes and the super annoying
"oh, <p> ... </p> is too complicated, let's pretend that line breaks are a
better way to do this" logic that I hate more than any other WordPress
oddity...
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
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>
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>
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>
Fix four unresolved references in the user-manual
Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
changing Appendix B/C headers to follow the same wording.
also changed appendix title as using the same word twice in the same
line just doesn't look right to me.
Signed-off-by: Krzysztof Arentowicz <k.arentowicz@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Update french translation of user-manual and POT file.
Signed-off-by: Guillaume GARDET <guillaume.gardet@free.fr>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
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>
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>
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>
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>
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>
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>
More french user manual tranlsation and POT file update.
Signed-off-by: Guillaume GARDET <guillaume.gardet@free.fr>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
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>
This patch fix indentation for list item to comply to asciidoc format.
This also fix po4a translation tool usage.
Signed-off-by: Guillaume GARDET <guillaume.gardet@free.fr>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Add initial support to French (fr) translation of user-manual.
Note that it is not perfect, since the po4a tool loose some list item
indexes during PO to ASCIIDOC conversion (see asciidoc warning messages
during user manual generation).
Signed-off-by: Guillaume GARDET <guillaume.gardet@free.fr>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
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>
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>
I should just have trusted Willem in commit dae0c9dffb ("User manual
update"). He got it right and I misedited his patch.
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
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>
At least on Ubuntu systems an edit of a group membership takes effect only
after logging out and in of that user, if this user is currently logged in.
Signed-off-by: Thomas Maisl <exp-12004@maisl.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
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>
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>
- 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>
Generation of PDF document fails if accented characters are used in
references.
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
These files are left behind when creating PDF fails
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Includes Extra data tab, show cylinders button, and Dc configuration.
Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Replace four more figures.
Replacement complete up to end of section:
Import data from dive computer.
Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Let's use implicit anchor for the Appendix A. This will get rid of
compilation error when trying to create PDF version of the user manual.
(Otherwise all the other links to Appendix A would have to be updated.)
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
This update concerns:
Import of dive logs from Suunto DM5
Configuration of dive computers
Description of main menu items
One figure has been added
Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Update to user manual text, including Cylinder bar at bottom of profile as well as
Extra Data tab.
A few smaller sentence-level updates scattered throughout the text
New pictures.
Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Includes the dive list filters and modifications on tissues graph.
Corrects a typpo.
Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
The only place where I'm not sure if there are unintended sideeffects of
changing over to the new domain is QCoreApplication::setOrganizationDomain
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Covers CCR APD and Poseidon divelogs and importing. Already changed
by the time of writing this commit, at least twice.
Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Somehow I forgot to submit this back in October.
Includes the gases pressures bar graph.
Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Few smaller changes to text dealing with tissue pressures graph
Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
This is a first stab at some text detailing the import
and handling of CCR dives within Subsurface. Three figures
added.
Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za>Kind
regards,
willem
From da16229327331731794b356b8e8504a4cd160634 Mon Sep 17 00:00:00 2001
From: willem ferguson <willemferguson@zoology.up.ac.za>
Date: Sun, 16 Nov 2014 15:50:44 +0200
Subject: [PATCH] Update user manual with CCR instructions
This is a first stab at some text detailing the import
and handling of CCR dives within Subsurface. Three figures
added.
Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
The gas pressure bar graph that has recently been added to the
Information Box on the dive profile is described here.
Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
This patch adds detail to the sections that deal with the modification
of existing dive plans as well as for the copy and paste of dive
information from one dive into other dives.
Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Text describing how to edit more than one dive that are selected in
the dive list.
Notice how I take nearly 20 lines to describe something that Linus
described effectively and succinctly in 4 lines.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Madification in text to reflect change in UI after the dustbin icon
has been moved in thumbnails of photos.
Two images in the manual were replaced.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
This text addresses issues about the deletion of photos using the
Photos tab. It also deals with interpreting information regarding
photos laocated on an external drive that is not connected to the PC.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Correction of a critical typo in the user manual
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Minor grammatical and stylistic text adjustsments, following quite a
few changes to the text by several contributors over the last two weeks.
Four images are replaced to reflect the latest UI, and also to
reflect the Gnome 3 rendering. These relate to
the specification of cylinder gas in the Equipment Tab.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Picture shows dive to 20m in 30 min. so text should state the same
Signed-off-by: Sergey Starosek <sergey.starosek@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Translation is almost done section-by-section for easier tracking of
further changes to master copy. It probably needs some re-styling but
not for 4.2.
Signed-off-by: Sergey Starosek <sergey.starosek@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
It seems that anchors cannot be placed on paragraphs when writing
Spanish asciidoc. Thus setting them for section headers. Also remove
new line from image tag.
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
I modified Tim Wooton's text, among others doing it in the writing
style of the manual (e.g. no second person).
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Possible wording for the survey bit
Is this the right place to put it?
Will probably need an image, but that would be better from Willem's
environment for the look to be consistent.
Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Describe that used cylinders cannot be deleted and first cylinder is
used implicitly.
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Describe the editing mode only once when going through entering dive
information by hand and not when describing each tab.
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Mention what is used by default for time and date when creating a new
dive. (And fix upper case elsewhere.)
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Some of the text dealing with Dropbox acces was misplaced
(Thank you, Salva)
This corrects that issue.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Text and an image were changed in order to reflect the
removal of images from the dive profile.
The text concerning Dropbox acces was reorganised.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
I thought it might be fun to use the archetypal characters here
http://en.wikipedia.org/wiki/Alice_and_Bob
It'll also be handy to use Bob if we ever need an example of
an underweighted diver ;-)
Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
All dive log movements are made on the local copy, then uploaded to
Dropbox server when there is an avaliable internet conection.
Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Multi-dive stats no longer include avg. depth
Picture was above, not below
Several minor corrections
Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Even though its Synchronization in the menu (in the base language
anyway) elsewhere thoughout the manual we use the en_GB spelling.
Use "into" rather than "onto" subsurface
Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Make descriptions of field editing consistent between the manually
added and DC imported sections. I preferred the DC section wording
on ratings.
Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Some minor readability tweaks.
Repeats wanrning about co-ordinates without Location name, all the
other info on co-ordinates was cut-pasted from the manual dive
entry section, but this bit was missing.
Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Corrects a typo
Removes a repetition
Closes a bracket
Adds extra info on use of the suit field
Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Referring to software as "Microsoft software" implies it's written
by Microsoft, which I don't think the Mares Dive Organizer is.
Microsoft still needs to stay for SQL Compact Edition which is theirs
but I think "Windows software" is the better description for the rest.
For consistency I think this works for refering to the OS too, as we
use Mac, not Apple, and Linux not Canonical.
Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
It appears that new lines are not allowed on image declarations on user
manual.
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Compile of the user manual failed on XML validation due to typo on the
link.
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Some other dive log programs present storage of dive logs on the Internet
as an important feature. Therefore this text.
One image was added.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
This patch performs the following to the user manual:
1) Remove text refering to cursor position indications on the depth
and time axes of the dive profile panel (not present in V4.2).
2) Revise dialogue and image for the printing of a dive log, taking
into account the new feature for 1 dive/page.
3) Added a paragraph to the text dealing with printing of dive plans,
detailing the approach to print dive plans after they have been saved
in the Dive List. This is done at the end of the text dealing
with the dive planner.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
This patch updates the user manual in the following respects:
1) Add section dealing with modifying the categories of information
shown in the Dive List. (A figure added)
2) Add section on filtering the Dive Listfor a particulr sive site,
using Ctl-F.
3) Add section describing the addition of bookmarks
(a figure added)
4) Two sentences dealing with the 30-minute time limit for
including photos onto the dive profile (dives > 30min of
the dive are not shown).
5) A few small changes, mostly typos.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Sections 6 and 9.3 of the user manual has some problems with the
ascii-doc code for maintaining the prper alignment of subheadings.
This patch corrects the asciidoc markup code to solve this
problem
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Tiny updates to Relnotes and README, include the latest formatted manual,
change the version in the project file
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Changes to user manual to rplace three images, as pointed out by Sergey.
Small changes to text of manual to reflect blue editing bar UI.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
This patch contains some updates to the user manual to reflect the new
images that were submitted previously. The updates include:
1) Moving the "Load Photos" section to the section daling with the input
of dive information (photos qualify as additional dive information).
2) Changing the wording around the new button in the tool bar.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Replacement figures for user manual
Here are 12 replacement figures for the user manual to bring the
figures
in line with the current UI. This relates to the updated profile
toolbar
and manual dive profile entry. I did not change any text of the manual.
That will happen tomorrow evening.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
From 85413b967c02738d47f0b7779613f33cc7898c17 Mon Sep 17 00:00:00 2001
From: Willem Ferguson <willemferguson@zoology.up.ac.za>
Date: Wed, 16 Jul 2014 07:26:43 +0200
Subject: [PATCH 4/4] Replacement figures for user manual
Here are 12 replacement figures for the user manual to bring the figures
in line with the current UI. This relates to the updated profile toolbar
and manual dive profile entry. I did not change any text of the manual.
That will happen tomorrow evening.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Updates translation and correct some typpos.
Includes Planner, Photographs and HTML export.
Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
This patch updated the export section in the user manual.
Some changes to the description of the HTML export options.
Signed-off-by: Gehad elrobey <gehadelrobey@gmail.com>
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
The user manual was spell-checked against the Oxford Dictionary.
Almost all the joined words, e.g. checkbox, dropdown, were
kept, but divelog was changed to dive log. Quite a few tyops
and spelling errors corrected.
A short section on dive plan evaluation was deleted on Robert's
suggestion.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Several updates are implemented here.
1) Updates to the dive planner section, following excellent
suggestions from Rob.
2) Updates reflecting the date picker, including hitting ESC
to close the calendar.
3) The edit of device names.
4) Several small or typographic edits
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
This patch updates the section on Preferences to accommodate
the newer additions to this Panel.
(Three images removed, five images inserted)
The section dealing with the desciption of all the main menu items
is updated.
One small change to the FAQ section.
A few small typo edits elsewhere in manual.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
This patch updates the information about dive log export.
Export to Worldmap, as well as to HTML are covered.
Small typo corrections elsewhere in the manual.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
This patch adds text and figures to the user manual, explaining how to
add photographs to the dive profile.
A 2-sentence paragraph was added to the dive planner text, detailing
planning for repetitive dives.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Text for the dive planner has been added to the user manual.
This includes two new images.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Lets just use pO₂ instead of PO2, ppO2, ppO₂, PO₂.
They all mean the same, but it's better to be
consistent
Signed-off-by: Henrik Brautaset Aronsen <subsurface@henrik.synth.no>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
We tried to copy the .html.git file from the out of tree build dir, not
from the source dir.
Signed-off-by: Anton Lundin <glance@acc.umu.se>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Spanish translation for the user manual as of 4.1 tagged english version.
Trimmed to 80 columns except where this could break links and affect the
html conversion.
Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
This correctly enables the planner on the new profile,
but it doesn't triggers the correct paint on the canvas.
[Dirk Hohndel: remove other remnants of the disabled planner as well]
Signed-off-by: Tomaz Canabrava <tomaz.canabrava@intel.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
A general review of the documentation has found more spelling errors.
Signed-off-by: Jeremiah Mahler <jmmahler@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
A last few changes before 4.1.
The first figure in "Using Companion app" needs a third part.
This was inserted. Which, in turn, affected the last figure
in that section. So that was also changed accordingly.
Few tiny changes to text to clean up references to figures.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
These adiitions and changes were made in accordance with the screenshots
provided by Venkatesh and Salvador and after managing to actually run the
companion app on my phone. Large parts of the text of this section have
been changed in accordance with the Companion V2 interface. Two graphics
were changed.
After Version 2 has stabilised, some more adaptation of the text will be
required.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Document the new "add" menu capabilities, partially as there are features still not
functional.
Documents the new feature with GPX files imports.
Corrects a typo.
Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Mention the option to export in CSV format in our user manual.
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
- Add hyperlinks to references to Appendices A and B in the text
- Be consistent with use of numbered lists and bullets:
-- Use numbered lists where order is important (e.g. a set of instructions)
-- Use bullets where isn't doesn't matter (e.g. a list of features)
Signed-off-by: Rick Walsh <rickmwalsh@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Minor update of manual for consistency in terminology and improved style
including the section describing the companion app. No images were affected.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Subsurface companion is, basically, the same from last Subsurface release,
it's only been added with the map feature which is depicted here.
Distance between positions takes precedence over time between them, so you
can have positions faster than one each period set in the "Min Duration"
setting. Actually this setting seems useless as you won't have a fix each
period if distance is under "Min distance".
Lesser changes in manual involving Background Service, the dificulty on
matching times and little personal recomendations.
[Dirk Hohndel: minor language changes]
Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
1) Two of the major screen images were replaced to reflect the current
screen layout with the new features of the profile toolbar.
2) The heart rate button is depicted and desribed.
3) Minute changes to the text of the manual to accompany the above changes.
4) The Uwatec Galileo image is re-inserted in the icons folder. Somewhere
it got lost.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
These updates reflect the discussion and small changes that were made to the
Preferences section and the Export-to-Worldmap features over the last week.
1) A few small changes made to the text of the Preferences section.
2) Two images replaced in the Preferences section.
3) Expansion of description of Export to Worldmap option of the menu system.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
This introduces ifdef control structures in the manual too, so we can
continue to develop both the planner and its manual, until its ready for
release.
Signed-off-by: Anton Lundin <glance@acc.umu.se>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
1. New section added on IrDA and communicating with the Uwatec Galileo dive computers.
2. Sections 7 to 9 of manual updated to reflect current version. Three figures updated.
3. New section added to reflect the dive planner. This is only a skeleton
awaiting better description when the dive planner is more mature. Added
2 figures within this new section.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
These are updates that are not version 4.1 dependent, but many linguistic
and logical edits are made, as are edits for consistency.
No substantive material has been removed or added.
This text is ready for V4.1
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Patch provided by Willem Ferguson, "0002-Updates-to-Section-3-of-
the-user-manual" addresses large number of typos and inconsistencies
in the previous documentation of section 3. This patch makes some
additional corrections on top of the provided patch, and also removes
the trailing whitespaces brought in with the provided patch.
Signed-off-by: Lakshman Anumolu <acrlakshman@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Section 3 is quite a long section. Ten of the screen shots are replaced.
Large numbers of typos and inconsistencies are corrected.
A few sentences are included e.g when dealing with the Subsurface Companion.
Section dealing with creating libdivecomputer dump files has been reorganised
slightly.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
The text for these two sections has been corrected and updated
in order to be ready for the release of V4.1. The very first
paragraph of the manual is expanded substantially.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
A new figure is included to reflect the actions of the new profile buttons
on the calculated ceilings.
A number of small edits on sections 4 and 5 of the user manual are done.
These sections are now finalised for the new release.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
The last figures in the manual using the Unity desktop have been replaced
with equivalent figures using Gnome 3. There should now be no figures
remaining from Unity.
This is a revision of the profile part of the manual in the light of the
changes for V4.1. Text has been moved around, some new text added or
rewritten. Graphics has been replaced to reflect the UI for V4.1,
including Tomaz's button bar and Louisa's new buttons for that bar.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
If you're doing a non-local build, it would get saved in the source
dir. Then qmake would complain that it couldn't find it in the target
dir.
Signed-off-by: Thiago Macieira <thiago@macieira.org>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
While it seems obvious that you need a named dive site in order to track
its coordinates, apparently people try to have no location name but
distinct coordinates which at this time we do not support.
See #440
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Willem has been maintaining the user manual for quite a while and at this
point is the main author, so he should be listed first.
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
This is an edit for style and grammar for the manual section dealing with
downloads from DC. This section has also been expanded to cover all the
controls in the downloads panel.
Signed-off-by: Willem Ferguson <willem@willem-Precision-M4700.(none)>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
This commit was jointly authored by Pedro Neves and Willem Ferguson.
Pedro added a FAQ section to the manual. Many long lines of text were
broken into shorter lines.
Signed-off-by: Willem Ferguson <willem@willem-Precision-M4700.(none)>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
The section on the main menu descriptions has been changed a little bit to
reflect the current menu structure.
The section dealing with exprt from other dive software has been changed
to appear more user friendly, with three new icons.
Signed-off-by: Willem Ferguson <willem@willem-Precision-M4700.(none)>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Every once in a while I need to update this so people building from source
who don't have asciidoc installed still have a reasonably current manual.
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Change and shorten in some places the section dealing with data import
from foreign software.
Create Appendix C, containing information on data export from foreign
packages.
Signed-off-by: Willem Ferguson <willem@willem-Precision-M4700.(none)>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Except for the images involving the dive profile, all the images now are
from Gnome 3. Images for dive profile awaits finalisation of the new dive
profile.
Small changes to the text of the manual have been done, the most important
of which is that dealing with using the unified import dialogue of
Subsurface.
Signed-off-by: Willem Ferguson <willem@willem-Precision-M4700.(none)>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
This adds Gnome-based screenshots to the manual for most of the images not
involving the profile. More of the images remain to be done.
I rewrote small sections of the text to reflect some of the recent
changes. Several images still need to be replaced. The profile images will
be done once the profile panel has been finalised. Some text also still
needs working.
Signed-off-by: Willem Ferguson <willem@willem-Precision-M4700.(none)>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Importing CSV files has changed slightly since writing this manual.
Updating accordingly. A typo fix as well (comma separated *values*).
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Patch f4db392a changed CSV import to use field numbers instead of
indexes. Thus removing the now incorrect description of numbering from
user manual. Note, that screenshot should be updated as well.
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
1) Text about libdivecomputer log and dump files
2) Text about coordinate formats acceptable
3) Text about CSV import
4) Minor reorganisation of TOC
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Correct error in manual
Add some short text in sections dealing with equipment.
[Dirk Hohndel: clean up whitespace & regenerate the html file]
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Removing the offending tags in Documentation/user-manual.txt makes it
build.
Signed-off-by: Cristian Ionescu-Idbohrn <cristian.ionescu-idbohrn@axis.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
This way when building Subsurface asciidoc is not necessary at all - except if
you want to work on the user manual and want to see the result of your work.
Previously the build wouldn't fail without asciidoc, but there would be no
working user manual when pressing F1 from within the application. This solves
the problem by shipping the HTML file with the sources.
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
This allows patches to be read more easily
This prevents the lines longer than 998 error in git send-email
Breaks lines at somewhere near 80 chars where possible
Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Unhide menu is only shown when hidden events exist.
Also updates relavent manual section.
Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Also added line-break as I ran into:
"patch contains a line longer than 998 characters
warning: no patches were sent"
so that shouldn't happen next time.
cheers,
Tim
From afb5fdfa2eff86ab2913e8f2a6f195c0cee3c13e Mon Sep 17 00:00:00 2001
From: Tim Wootton <tim@tee-jay.demon.co.uk>
Date: Sat, 14 Dec 2013 00:31:12 +0000
Subject: [PATCH] Doc, and 1 more typo
Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
1) Corrects various typos and spellings
2) Standardises on infrared over infra-red (both were found)
3) Standrdises on colour over color (both were found) as most
of the manual seems to use UK English spelling
Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Brings the changes that were made to Dive Notes and Equipment
under the Manual Entry section into the Imported from DC section
was well, while preserving the imported from DC specific stuff.
Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Notes dependancy of shortcut keys on language as well as OS.
Writes Operating System in full not abbr.
More fully describes how to spot a shortcut key in the menu
Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
1) Many typos and lexical problems improved or corrected
2) Information for Heinrichs Weikamp DR5 moved to Appendix B
3) Small changes to images.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Once again use 'selected' and 'highlighted' consistently.
Use the correct units for the vertical speed during a dive. 30 m/s would
be more than just red :-)
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
We kept switching between the somewhat impersonal 'one' and the much more
friendly 'you' to address the user. This commit changed all occurances
that I found to 'you' and adjusted the grammar around it.
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Be more precise with selected dive vs. highlighted dives.
Avoid some redundancy.
Mention shortcut keys.
Discuss the different locations of the Main Menu and the fact that the
screen shots were taken on a Ubuntu system.
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Italics marker needed to come after the 's to work properly
Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Found the word "ter" below this para, assume it's not
supposed to be there.
Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Replaced graphics for Import from Divelogs.de to reflect latest UI schanges.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Both JS and CSS resources need to be embedded into HTML
Signed-off-by: Sergey Starosek <sergey.starosek@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Pedantic Tim says "Barring waterproof device, most of us won't
be entering these fields during the dive." ;-)
Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
1) Added Main Menu items description
2) Added Divelogs.de description
3) Removed paragraph defining EAD & END
4) Several typos corrected
5) Positions of several figures standardised to align="central"
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Apparently some version os asciidoc don't support the --theme option.
Work around this by using -a theme='theme' instead.
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Updates summary of main menu entries to those in the new GUI
Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
As pointed out in commit 23ce727 by Dirk and remembered Jan, there are different
meanings for EAD and END depending on organisations. Let's explain a bit the one
Subsurface has choosen, as this is confusing, even while translating the acronyms.
Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
The Makefile changes were authored by Dirk, the CSS is based on a public
domain CSS file and authored by Willem
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
This was Dirk's mistake when applying the patch.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
1) Several layout changes including banner.
2) Stylistic revision of part of textr.
3) Addition of text to dive computer upload section.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
A first try on documenting the companion app and explanation on how to use
it combined with Subsurface.
Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
1) Inserted section on Information Box on dive profile
2) Iserted short section on import from Mares Dive Organiser
3) Corrections to spelling and style not included in previous commits.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
References to literature on gradient factors changed (see dive profile
section, also preferences section)
Section on preference settings added.
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
I have added a section about importing dives from other electronic
sources. There are some potential problems, because I know that the
intercation with divelogs.de is not yet fully functional
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
This starts mostly from scratch. It removes big chunkgs of the old manual,
the old pictures and starts with new visuals and new descriptions. A lot
more work is needed, but it's a good start.
Signed-off-by: Willem Ferguson <willem@willem-Precision-M4700.(none)>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
This is working for me, but requires a bit more testing. To build,
run:
qmake [options]
Where options might be:
V=1 disable "silent" build
LIBDCDEVEL=1 use side-by-side libdivecomputer
INCLUDEPATH+=xxx add -Ixxx (e.g., INCLUDEPATH+=/usr/local/marble/include)
LIBS+=xxx add xxx to the linker flags (e.g. LIBS+=-L/usr/local/marble/lib)
or any other qmake option, including debug and release options
If your distribution is already using qtchooser in place of qmake, you
may need to pass an extra option to qmake to select the a
cross-build. For example:
qmake -qt=i686-w64-mingw32-qt4
If your distribution is not yet using qtchooser, then you need to file
a bug report requesting it and you need to run the full path to qmake.
Note:
- there are some ### left in the buildsystem
Signed-off-by: Thiago Macieira <thiago@macieira.org>
