Software
-Download this software (short list): +
If you are just typing up logbook entries then you don't need any other software. If you are working with survey data download this software (short list):
- git - version control system
- Survex, including the Aven visualisation tool.
diff --git a/handbook/computing/logbooks-parsing.html b/handbook/computing/logbooks-parsing.html
new file mode 100644
index 000000000..d91b23c10
--- /dev/null
+++ b/handbook/computing/logbooks-parsing.html
@@ -0,0 +1,89 @@
+
+
+
+
+
CUCC Expedition Handbook: Logbook import + + + +CUCC Expedition Handbook
+Logbooks Import
+ + + +Importing the logbook into troggle
+This is usually done after expo but it is in excellent idea to have a nerd do this a couple of times during expo to discover problems while the people are still around to ask. + +
The nerd needs to login to the expo server using their own userid, not the 'expo' userid. The nerd also needs to be in the group that is allowed to do 'sudo'. + +
The nerd needs to do this: +
-
+
- Look at the list of pre-existing old import errors at http://expo.survex.com/admin/core/dataissue/ +The nerd will have to login to the troggle management console to do this, not just the usual troggle login. +
- You need to get the list of people on expo sorted out first. +This is documented in the Folk Update process. +
- Log in to the expo server and run the update script (see below for details) +
- Watch the error messages scroll by, they are more detailed than the messages archived in the old import errors list +
- Edit the logbook.html file to fix the errors. These are usually typos, non-unique tripdate ids or unrecognised people. Some unrecognised people will mean that you have to fix them using the Folk Update process first. +
- Re-run the import script until you have got rid of all the import errors. +
- Pat self on back. Future data managers and people trying to find missing surveys will worship you. +
The procedure is like this. It will be familiar to you because +you will have already done most of this for the Folk Update process. + +
+ +ssh {youruserid}@expo.survex.com +cd ~expo +cd troggle +sudo python databaseReset.py logbooks +It will produce a list of errors like these below, starting with the most recent logbook which will be the one for the expo you are working on. +You can abort the script (Ctrl-C) when you have got the errors for the current expo that you are going to fix +
+ +Loading Logbook for: 2017 + - Parsing logbook: 2017/logbook.html + - Using parser: Parseloghtmltxt +Calculating GetPersonExpeditionNameLookup for 2017 + - No name match for: 'Phil' + - No name match for: 'everyone' + - No name match for: 'et al.' +("can't parse: ", u'\n\n<img src="logbkimg5.jpg" alt="New Topo" />\n\n') + - No name match for: 'Goulash Regurgitation' + - Skipping logentry: Via Ferata: Intersport - Klettersteig - no author for entry + - No name match for: 'mike' + - No name match for: 'Mike'Errors are usually misplaced or duplicated <hr /> tags, names which are not specific enough to be recognised by the parser (though it tries hard) such as "everyone" or "et al." or are simply missing, or a bit of description which has been put into the names section such as "Goulash Regurgitation". + +
The logbooks format
+This is documented on the logbook user-documentation page as even expoers who can do nothing else technical can at least write up their logbook entries. + +
[ Yes this format needs to be re-done using a proper structure:
++<div class="logentry">
+ +</div">Historical logbooks format
+Older logbooks (prior to 2007) were stored as logbook.txt with just a bit of consistent markup to allow troggle parsing.
+ +The formatting was largely freeform, with a bit of markup ('===' around header, bars separating date,
+ +- , and who) which allows the troggle import script to read it correctly. The underlines show who wrote the entry. There is also a format for time-underground info so it can be automagically tabulated. So the format should be:
+ ++===2009-07-21|204 - Rigging entrance series| Becka Lawson, Emma Wilson === + +{Text of logbook entry} + +T/U: Jess 1 hr, Emma 0.5 hr +++Back to Logbooks for Cavers documentation. +
+ + + + diff --git a/handbook/i/logbookpage.jpg b/handbook/i/logbookpage.jpg new file mode 100644 index 000000000..1b65c3db2 Binary files /dev/null and b/handbook/i/logbookpage.jpg differ diff --git a/handbook/logbooks.html b/handbook/logbooks.html index 43e7e3b5f..90b29c940 100644 --- a/handbook/logbooks.html +++ b/handbook/logbooks.html @@ -12,13 +12,12 @@ the base camp logbook or the top camp logbook.-
-
- Why the logbook is so important +
- Why the logbook is so important
- Typing on the Expo Laptop
- Typing on another laptop
- Formatting a typed logbook entry -
- Importing the logbook into troggle (nerds only) - error checking -
- Historical logbookformat (nerds only) +
- Importing the logbook into troggle (nerds only) - and error checking
Why the logbook is important
@@ -31,10 +30,29 @@ do lots of sketches in the logbook. If you mention a cave location, please also write down the cave name somewhere. In 10 years no-one will know where "Lemon Snout" is. -If this is all new to you, please now read Cave data management, -and why we make surveys and then the + + +
+
+If this is all new to you, please now read
+Why we make surveys
+and
+Cave data management,
+and then the
Survey Handbook
+Interim rigging guide
+The logbook is the place where we record the rigging of caves as we discover them. +
When a cave is derigged, +a good way of getting the rope lengths for your rigging guide is to +leave the knots in ropes removed so they can +be measured, but these days our caves are a bit deep +and complicated for this to be feasible. +Although a good survey and details of the belays +can be used to estimate the length of rope needed, this is no substitute for +measuring how much rope it actually took to rig.
+ +The online logbook file
If you are at basecamp, then it is an excellent idea to type the text of your logbook trip report instead of writing it by hand - see below. But still do lots of drawings in the paper logbook. @@ -52,14 +70,13 @@ correlated with survey data done on the same day or by the same people.
- 2018
- 2017
All these logbook entries are then typed into a laptop (often the expo laptop) +
All these scanned handwritten logbook entries are typed into a laptop (often the expo laptop) which is then synchronised the version control system.
The result is a webpage reporting who did what and what was done by whom on expo, e.g. see the 2018 expo report.
Typing just your trip report (at the Expo Laptop)
-If you are at basecamp, then it is an excellent idea to type up your logbook trip report. -You can then print this and stick it in the logbook, adding any sketches by hand. +
As handwriting can be very bad, please try to type the text, print it and stick it in the logbook, adding any sketches by hand. This will save someone (probably you) deciphering your handwriting and typing it up later.
These instructions assume that (a) you are sitting at the expo laptop and that someone who knows @@ -101,8 +118,8 @@ copy it by email or USB stick to another laptop, edit it there and then copy it
If you are using your own laptop then you will need to either:
-
-
- Just type up your trip as a separate file e.g. "logbook-mynewtrip.txt", or just write it in an email, and send it to someone nerdish, or -
- install and learn how to use the version control software. +
- Just type up your trip as a separate file with a useful filename e.g. "logbook-myname-2018-08-03.txt", or just write it in an email, and send it to someone nerdish, or +
- install and learn how to use the version control software. And you will need to synchronise regularly (every day) to ensure that the updates from all the people entering trip data are OK and don't get overwritten by ignorant use of this software.
Note: T/U stands for "Time Underground" in hours (6 minutes would be "0.1 hours").
Note: the <hr /> is significant and used in parsing, it is not just prettiness. -
[ Yes this format needs to be re-done using a proper structure:
-
-<div class="logentry">
-
-</div">
-
Historical logbooks
-Older logbooks (prior to 2007) were stored as logbook.txt with just a bit of consistent markup to allow troggle parsing.
-The formatting was largely freeform, with a bit of markup ('===' around header, bars separating date,
So the format should be:
- -
-===2009-07-21|204 - Rigging entrance series| Becka Lawson, Emma Wilson ===
-
-{Text of logbook entry}
-
-T/U: Jess 1 hr, Emma 0.5 hr
-
-
-Importing the logbook into troggle
-This is usually done after expo but it is in excellent idea to have a nerd do this a couple of times during expo to discover problems while the people are still around to ask. - -
The nerd needs to login to the expo server using their own userid, not the 'expo' userid. The nerd also needs to be in the group that is allowed to do 'sudo'. - -
The nerd needs to do this: -
-
-
- Look at the list of pre-existing old import errors at http://expo.survex.com/admin/core/dataissue/ -The nerd will have to login to the troggle management console to do this, not just the usual troggle login. -
- You need to get the list of people on expo sorted out first. -This is documented in the Folk Update process. -
- Log in to the expo server and run the update script (see below for details) -
- Watch the error messages scroll by, they are more detailed than the messages archived in the old import errors list -
- Edit the logbook.html file to fix the errors. These are usually typos, non-unique tripdate ids or unrecognised people. Some unrecognised people will mean that you have to fix them using the Folk Update process first. -
- Re-run the import script until you have got rid of all the import errors. -
- Pat self on back. Future data managers and people trying to find missing surveys will worship you. -
The procedure is like this. It will be familiar to you because -you will have already done most of this for the Folk Update process. - -
ssh {youruserid}@expo.survex.com
-cd ~expo
-cd troggle
-sudo python databaseReset.py logbooks
-It will produce a list of errors like this, starting with the most recent logbook which will be the one for the expo you are working on. -You can abort the script (Ctrl-C) when you have got the errors for the current expo that you are going to fix -
Loading Logbook for: 2017
- - Parsing logbook: 2017/logbook.html
- - Using parser: Parseloghtmltxt
-Calculating GetPersonExpeditionNameLookup for 2017
- - No name match for: 'Phil'
- - No name match for: 'everyone'
- - No name match for: 'et al.'
-("can't parse: ", u'\n\n<img src="logbkimg5.jpg" alt="New Topo" />\n\n')
- - No name match for: 'Goulash Regurgitation'
- - Skipping logentry: Via Ferata: Intersport - Klettersteig - no author for entry
- - No name match for: 'mike'
- - No name match for: 'Mike'