summaryrefslogtreecommitdiffstats
path: root/Documentation
AgeCommit message (Collapse)Author
2014-07-24User manual: update generated html filesGravatar Dirk Hohndel
This once again just updates the html files for people who build from source but don't have asciidoc. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-24User manual: Add text as well as figures.Gravatar Willem Ferguson
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>
2014-07-24User manual: update generated html filesGravatar Dirk Hohndel
This just updates the html files for people who build from source but don't have asciidoc. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-24Update spanish translation of user manual to english 3e66948Gravatar Salvador Cuñat
Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-24User manual: Replace figureGravatar Willem Ferguson
Replace an Ubutu-based figure (we stick to Gnome). Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-24User manual: correct asciidoc markup for proper alignment of subheadingsGravatar Willem Ferguson
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>
2014-07-24Minor changes to user manualGravatar Sergey Starosek
Signed-off-by: Sergey Starosek <sergey.starosek@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-18Getting read for Beta 2Gravatar Dirk Hohndel
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>
2014-07-18User manual: small changes to reflect changes in CSV import dialog.Gravatar Willem Ferguson
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-18User manual: Replace CSV import imageGravatar Willem Ferguson
Replace the CSV import image to reflect recent changes. Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-18User manual: updatesGravatar Willem Ferguson
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>
2014-07-17Update spanish translation for user-manual.txt to 82fc95dGravatar Salvador Cuñat
[Dirk Hohndel: added the html.git file] Signed-off-by: Salvador Cuñat <salvador.cunat@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-16User manual: add latest html files to git treeGravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-16User manual: Updated textGravatar Willem Ferguson
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>
2014-07-16Replacement figures for user manualGravatar Willem Ferguson
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>
2014-07-09Translation update as of 29f19c37b0de.Gravatar Salvador Cuñat
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>
2014-07-04Typo fixes on User ManualGravatar Miika Turkia
Signed-off-by: Miika Turkia <miika.turkia@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-04Minor edits on HTML export (User Manual)Gravatar Miika Turkia
Signed-off-by: Miika Turkia <miika.turkia@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-04User manual: HTML export updateGravatar Gehad elrobey
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>
2014-06-30User manual: Spelling, typosGravatar Willem Ferguson
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>
2014-06-29Update of user manualGravatar Willem Ferguson
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>
2014-06-29Updates to user manual: Preferences and Main menuGravatar Willem Ferguson
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>
2014-06-28User manual: add more about dive log export.Gravatar Willem Ferguson
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>
2014-06-28User manual: Load photographsGravatar Willem Ferguson
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>
2014-06-28User manual: add text for the dive plannerGravatar Willem Ferguson
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>
2014-06-23Be more consistent in partial pressure namingGravatar Henrik Brautaset Aronsen
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>
2014-06-08Fix out of tree building without asciidocGravatar Anton Lundin
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>
2014-06-06User manual: add html version of Spanish manualGravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-06-06User manual: update Makefile for multi language supportGravatar Dirk Hohndel
New translations need to be explicitly added to the Makefile Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-06-06User manual: Spanish translationGravatar Salvador Cuñat
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>
2014-05-26Planner: Re-enable using the new profile.Gravatar Tomaz Canabrava
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>
2014-05-11Documentation spelling errorsGravatar Jeremiah Mahler
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>
2014-05-08Yet some more changes to Companion part of user manualv4.1Gravatar Willem Ferguson
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>
2014-05-07User manual: Updates regarding the companion appGravatar Willem Ferguson
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>
2014-05-05User manual: document importing GPX files in companion appGravatar Salvador Cuñat
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>
2014-04-30Getting ready for 4.1 Beta 2Gravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-04-30Add export CSV to user manualGravatar Miika Turkia
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>
2014-04-29User manual: add latest htmlGravatar Dirk Hohndel
This updates the rendered html file for people who build from source but don't have asciidoc installed. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-04-29User manual: formatting changesGravatar Rick Walsh
- 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>
2014-04-29User manual: Minor updatesGravatar Willem Ferguson
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>
2014-04-25User manual: some changes regarding the companion appGravatar Salvador Cuñat
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>
2014-04-21User manual: Replace some graphicsGravatar Willem Ferguson
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>
2014-04-10Small updates to user manualGravatar Willem Ferguson
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>
2014-04-07Use the ENABLE_PLANNER macro in the manual tooGravatar Anton Lundin
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>
2014-04-07Update to bring user manual in line for the release of V4.1.Gravatar Willem Ferguson
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>
2014-03-31EAD/END explanation in user manual.Gravatar Robert C. Helling
E is for "equivalent". Signed-off-by: Robert C. Helling <helling@atdotde.de> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-03-27User manual: Updates to sections 6 and 10-13Gravatar Willem Ferguson
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>
2014-03-25User manual: Update included .html.git fileGravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-03-25Minor edits to updated section-3 documentationGravatar Lakshman
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>
2014-03-25Updates to Section 3 of the user manualGravatar Willem Ferguson
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>