aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar Lubomir I. Ivanov <neolit123@gmail.com>2015-11-25 21:18:13 +0200
committerGravatar Dirk Hohndel <dirk@hohndel.org>2015-12-02 09:21:52 -0800
commit794d4e88bef13ee3d6e973eb7e9671ebbb8eeac9 (patch)
tree7c6af44e5c1007f4f3a56c7685366024d4d0d8c3
parentc1f8ecd67adb627fee428b73e943c5a7a04b9613 (diff)
downloadsubsurface-794d4e88bef13ee3d6e973eb7e9671ebbb8eeac9.tar.gz
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>
-rw-r--r--Documentation/user-manual.txt25
1 files changed, 16 insertions, 9 deletions
diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt
index 512b65d9d..2b6784661 100644
--- a/Documentation/user-manual.txt
+++ b/Documentation/user-manual.txt
@@ -4215,20 +4215,27 @@ Only a subset of the dive data is exported:
|*Name*|*Description*
|number| (*int*) dive number
|id| (*int*) unique dive ID, should be used to fetch the dive profile
-|date| (*string*) data of the dive
+|date| (*string*) date of the dive
|time| (*string*) time of the dive
|location| (*string*) location of the dive
|duration| (*string*) duration of the dive
|depth| (*string*) depth of the dive
-|divemaster| (*string*) divemaster data
-|buddy| (*string*) buddy data
-|airTemp| (*string*) air temperature of dive
-|waterTemp| (*string*) water temperature of dive
+|divemaster| (*string*) dive master for the dive
+|buddy| (*string*) buddy for the dive
+|airTemp| (*string*) air temperature of the dive
+|waterTemp| (*string*) water temperature of the dive
|notes| (*string*) dive notes
-|rating| (*int*) dive rating ranges from 0 to 5
-|sac| (*string*) sac value
-|tags| (*string*) all dive tags concatenate together
-|gas| (*string*) used gas cylinder
+|rating| (*int*) dive rating which ranges from 0 to 5
+|sac| (*string*) SAC value for the dive
+|tags| (*string*) list of dive tags for the dive
+|gas| (*string*) list of gases used in the dive
+|suit| (*string*) the suit used for the dive
+|cylinders| (*string*) complete information of all used cylinders
+|cylinder0-7| (*string*) information about a specific cylinder
+|weights| (*string*) complete information of all used weight systems
+|weight0-5| (*string*) information about a specific weight system
+|maxcns| (*string*) maxCNS value for the dive
+|otu| (*string*) OTU value for the dive
|=====================
_Subsurface_ also exports *template_options* data. This data must be used as _CSS_ values to provide a dynamically