Commit graph

509 commits

Author SHA1 Message Date
Dirk Hohndel
ed9e5fe0f3 Don't use CRLF in documentation files
Suggested-by: Linus Torvalds <torvalds@linux-foundation.org>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-03-16 07:46:47 -07:00
Salvador Cuñat
27524248cc mobile-manual - Update authors, dates and so
Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-03-13 12:46:43 -07:00
Salvador Cuñat
b7848cc9c9 Spanish translation for mobile-manual.txt
[Dirk Hohndel: also added an html version]

Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-03-13 12:46:17 -07:00
Guillaume GARDET
c8df5625d4 Documentation: add mobile user manual to POT/PO management and update french translation of user-manual and mobile-manual
Signed-off-by: Guillaume GARDET <guillaume.gardet@free.fr>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-03-12 06:46:03 -08:00
Dirk Hohndel
d1247ba19c Small update to the mobile user manual
Also switch the mobile user manual html over to something created on my
machine and (as usual) named .html.git

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-03-10 09:00:31 -08:00
Willem Ferguson
a9b33e53ce Mobile - Update user manual for Subsurface-mobile
This replaces eight images and brings the text of the manual
up to date.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-03-09 11:08:55 -08:00
Dirk Hohndel
04f3a6f8d5 Rewrite the Subsurface-mobile user manual
This brings the text closer to the current version of Subsurface-mobile,
but a lot more fine tuning will be required (and of course the images need
to be updated to reflect the current UI).

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-03-04 11:38:01 -08:00
Lubomir I. Ivanov
f2fa087b3b user-manual.txt: mention some more Grantlee variables
With the recent refactoring of the DiveHelperObject class, some
more Q_PROPERTIES were added and can be used with the Grantlee engine.
We expose some of the additions to the user via the manual.

Signed-off-by: Lubomir I. Ivanov <neolit123@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-02-29 07:33:47 -08:00
Willem Ferguson
bc84d280b8 Mobile user-manual: Add text that explains action button
4 small images added.

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

From 43f260e7aa2be9af43c9250f75cad05a141f9d1e Mon Sep 17 00:00:00 2001
From: Willem Ferguson <willemferguson@zoology.up.ac.za>
Date: Tue, 9 Feb 2016 12:25:24 +0200
Subject: [PATCH 2/2] [PATCH] Mobile user-manual: add section explaining action
 button

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-02-09 10:55:23 -08:00
Willem Ferguson
ec9aad4487 Short first attempt at a user manual for Subsurface-mobile
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2016-02-08 08:22:39 -08:00
Miika Turkia
1f4d02a861 Improve group information on USB device
As the group can be something else than dialout on some systems, mention
this on user manual.

Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-12-28 08:28:15 -08:00
Dirk Hohndel
86765774dc Update the bundled htlm user manual
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-12-16 06:37:43 -08:00
Pedro Neves
e87e0bbba7 Corrected a typo in the User Manual
Signed-off-by: Pedro Neves <nevesdiver@gmail.com>

A small typo was corrected.
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-12-16 06:35:54 -08:00
Lubomir I. Ivanov
794d4e88be user-manual.txt: modifications related to Grantlee variables
This patch adds the new variables to the Grantlee section
of the user manual, which were recently added, code wise.

The patch also cleans the descriptions of some of
the already present varaibles and fixes a couple of typos
in the process.

Signed-off-by: Lubomir I. Ivanov <neolit123@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-12-02 09:21:52 -08:00
Dirk Hohndel
3413dc30e5 User manual: add missing empty line
This way the ASCIIDOC works as expected and creates the numbered list.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-11-28 13:01:47 -08:00
Wendie Fisher
bbf03fd50f Last set of updates to the user manual in this round
Once again focus on language and readability.

Signed-off-by: Wendie Fisher <wendie@divedad.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-11-23 14:48:52 -08:00
Wendie Fisher
1b0938034e Next batch of language updates for the user manual
Signed-off-by: Wendie Fisher <wendie@divedad.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-11-12 11:08:44 -08:00
Wendie Fisher
81f1238ab9 Updates to the user manual
Small changes to the language to make it easier to read.

Signed-off-by: Wendie Fisher <wendie@divedad.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-11-06 09:52:30 -08:00
Salvador Cuñat
f2ff2022e6 Update spanish translation of user manual to english eed9a4b
Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-11-01 11:06:50 -08:00
Guillaume GARDET
94207fa8d7 Documentation: update french translation of user-manual
Signed-off-by: Guillaume GARDET <guillaume.gardet@free.fr>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-10-29 08:34:48 -07:00
Sergey Starosek
906b2c2288 Documentation: update russian translation of user manual to english eed9a4b0
Signed-off-by: Sergey Starosek <sergey.starosek@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-10-29 08:33:51 -07:00
Dirk Hohndel
dfc1e36c0e Adjust asciidoc invocation to build latest manual
We shouldn't need to set the stylesdir - instead doing so makes us not
find the toc.css file.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-10-28 07:50:38 +09:00
Willem Ferguson
eed9a4b0f2 User manual updates.
1) Put table of contents as a column on the left-hand side of the page
   instead of as part of the user manual text.
2) Correct a some typoss.
3) Add three sentences to the Bluetooth download section to deal with
   Bluetooth Pass Codes.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-10-27 21:52:33 +09: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
Robert C. Helling
0f63b524a6 Mention Shearwater Nerd
alongside Petrell 2 since this seems to be the same computer internally.

Signed-off-by: Robert C. Helling <helling@atdotde.de>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-10-18 17:37:49 -07:00
Dirk Hohndel
e276ef0998 Another update of user manual html files in git
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-10-14 05:58:13 -07:00
Sergey Starosek
d5e48de567 Documentation: update russian translation of user manual
Signed-off-by: Sergey Starosek <sergey.starosek@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-10-14 05:50:44 -07:00
Sergey Starosek
6817504f95 User manual tidy-up
Signed-off-by: Sergey Starosek <sergey.starosek@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-10-14 05:50:27 -07:00
Salvador Cuñat
37e54f490d Update spanish translation of user manual to english 8d546bc
[Dirk Hohndel: also update the html git version]

Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-10-13 19:28:56 -07:00
Dirk Hohndel
c7c686f730 Update user manual html files included in the sources
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-10-13 13:19:27 -07:00
Guillaume GARDET
409df339b8 Documentation: update french translation of user-manual
Signed-off-by: Guillaume GARDET <guillaume.gardet@free.fr>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-10-13 11:52:23 -07:00
Willem Ferguson
8d546bc8c0 User manual: last changes before V4.5
1) Run a spell checker through the user manual. Only three
   outright typos found!!
2) Correct sentence about reverse name lookup that results in
   dive site name reported in tags field, not in Location field.
   (Sergey, thank you!)

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-10-13 08:46:54 -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
Guillaume GARDET
9689268e35 Documentation: update french translation of user-manual
Signed-off-by: Guillaume GARDET <guillaume.gardet@free.fr>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-10-12 09:51:52 -07:00
Sergey Starosek
bfaf57e1ec Remove UTF BOM from user manual files
Signed-off-by: Sergey Starosek <sergey.starosek@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-10-09 13:12:58 -07:00
Sergey Starosek
2fd42cc1e4 User manual spelling fixes and tidy-up
Signed-off-by: Sergey Starosek <sergey.starosek@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-10-09 13:12:06 -07:00
Sergey Starosek
aff6c3d1ad Documentation: update russian translation of user manual to english b74809b
Signed-off-by: Sergey Starosek <sergey.starosek@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-10-09 13:11:58 -07:00
Guillaume GARDET
f07953ca00 Documentation: update french translation of user-manual
Signed-off-by: Guillaume GARDET <guillaume.gardet@free.fr>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-10-06 00:03:00 +01:00
Salvador Cuñat
1719a7f59e Update spanish translation of user manual to english b74809b
Changes to Bluetooth download section.

Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-10-04 19:03:44 +01:00
Salvador Cuñat
f5a205d3db Update spanish translation of user manual to english 8462ae2
Bluetooth

Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-09-27 06:11:22 -04:00
Willem Ferguson
b74809b62d user manual: Bluetooth douwnload
Clean up the text on the above issue. Many thanks, Claudiu.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-09-27 06:11:05 -04: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
9d1c3942d7 User manual update: Put back manual Bluetooth procedures
Put back the procedures for manually achieving a Bluetooth connection
into APPENDIX A.
Refer to the manual procedures from the text that described the new
built-in Subsurface Bluetooth interface.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-09-24 07:23:14 -07:00
Willem Ferguson
c15c588ef9 User manual systematic review (Part 4)
1) Delete section on mobile application
2) Update Preferences and Menu options sections

No images are added or replaced.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-09-23 20:11:53 -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
Guillaume GARDET
236713efaa Documentation: update french translation of user-manual
Signed-off-by: Guillaume GARDET <guillaume.gardet@free.fr>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-09-22 07:28:03 -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