mirror of
https://expo.survex.com/repositories/expoweb/.git/
synced 2025-01-18 08:52:37 +00:00
201 lines
10 KiB
HTML
201 lines
10 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
<title>CUCC Expedition Handbook: The Website</title>
|
|
<link rel="stylesheet" type="text/css" href="../css/main2.css" />
|
|
</head>
|
|
<body>
|
|
<h2 id="tophead">CUCC Expedition Handbook</h2>
|
|
<h1>Logbooks</h1>
|
|
<p>As soon as possible after a trip finishes, a <b>hand-written write-up</b> of the trip is made in the nearest logbook:
|
|
the base camp logbook or the top camp logbook.
|
|
|
|
<ul>
|
|
<li><a href="#why">Why</a> the logbook is so important
|
|
<li><a href="#type">Typing on the <em>Expo Laptop</em></a>
|
|
<li><a href="#another">Typing on another laptop</a>
|
|
<li><a href="#format">Formatting</a> a typed logbook entry
|
|
</br></br>
|
|
<li><a href="#import">Importing</a> the logbook into troggle (nerds only) - error checking
|
|
<li><a href="#history">Historical</a> logbookformat (nerds only)
|
|
</ul>
|
|
|
|
<h3 id="why">Why the logbook is important</h3>
|
|
|
|
<p>The logbook writeup is the oldest and most basic way of recording your trip but it must not be neglected. This is also where you put
|
|
your speculations and ideas for what looks promising and what is obvious but doesn't go: things that are vital to future expoers. And please, please
|
|
do lots of sketches in the logbook.
|
|
|
|
<p>Always, always write the date, <em>your</em> name and the names of other people involved at the top of each entry.
|
|
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.
|
|
|
|
<p>If this is all new to you, please now read <a href="datamgt.html">Cave data management</a>,
|
|
and <a href="survey/why.htm">why we make surveys</a> and then the
|
|
<a href="survey/index.htm">Survey Handbook</a>
|
|
|
|
|
|
<p>If you are at basecamp, then it is an excellent idea to
|
|
<b>type the text of your logbook trip report</b> instead of writing it by hand - see <a href="#type">below</a>. But still do lots of drawings in the paper logbook.
|
|
|
|
|
|
<p>The contents of both the topcamp logbook and the basecamp logbook are typed into the same
|
|
"logbook.html" file for future use in tracking down leads and surveys. The drawings are scanned and stored in the same place, and hand-edited
|
|
into the logbook.html file after expo finished. The typed notes are uploaded into the expo server database and
|
|
correlated with survey data done on the same day or by the same people.
|
|
|
|
|
|
|
|
<p>Recent logbooks:
|
|
<ul>
|
|
<li><a href="../years/2018/logbook.html">2018</a>
|
|
<li><a href="../years/2017/logbook.html">2017</a>
|
|
</ul>
|
|
<p>All these logbook entries are then typed into a laptop (often the expo laptop)
|
|
which is then synchronised the version control system.
|
|
<p>The result is a webpage reporting who did what and what was done by whom on expo,
|
|
e.g. see <a href="http://expo.survex.com/expedition/2018">the 2018 expo report</a>.
|
|
|
|
<h3 =id="type">Typing just your trip report (at the <i>Expo Laptop</i>)</h3>
|
|
<p>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.
|
|
This will save someone (probably you) deciphering your handwriting and typing it up later.
|
|
|
|
<p>These instructions assume that (a) you are sitting at the <em>expo laptop</em> and that someone who knows
|
|
the password has logged in for you (as user "expo"), and (b) that you know nothing about the software
|
|
systems used by expo.
|
|
<ul>
|
|
<li>You will type your trip report as plain text using a text editor.
|
|
<li>You will be typing into a file called something like "logbook-mynewtrip.txt" in the folder "Downloads"
|
|
<li>You will be asking someone nerdy to take this trip report and to edit it into the proper place later.
|
|
</ul>
|
|
|
|
<p>The first challenge is to find how to start up the text editor. The <em>expo laptop</em> is running debian Linux
|
|
with the Gnome 3.2 desktop manager, so click on "Activities" in the top left corner.
|
|
This will bring down a vertical menu of icons down the left hand side of the screen. Hovering
|
|
over the icons brings up a label, and the one you want is at (or near) the bottom with the label "Text editor". Click on it.
|
|
<p>If you are lucky this will bring up an empty window for a new file.
|
|
<br>If you are unlucky it will bring up the previous person's file.
|
|
<p>If it is a new file, save it to the Downloads folder (/home/expo/Downloads) using the "File->Save" menu
|
|
item and give it a sensible name such as "logbook-mynewtrip.txt".
|
|
<p>If it was someone else's file, save it using the "File->Save" menu. Then close the text editor ("File->Close").
|
|
Then start it up again from the vertical icon menu as before.
|
|
<p>Now type in your trip report using whatever format you like, but please leave a blank line between paragraphs.
|
|
|
|
|
|
<h4>Adding your trip to the logbook online file</h4>
|
|
<p>If you are using the <em>expo laptop</em> just edit this file (if you are on expo in 2025):
|
|
|
|
<code>
|
|
/home/expo/expoweb/years/2025/logbook.html
|
|
</code>
|
|
|
|
copy the format you can see other people have used;
|
|
and other people will take care of synchronising it with the version control system.
|
|
|
|
<p>
|
|
<b>DO NOT</b> take a copy of the logbook.html file from the expo laptop,
|
|
copy it by email or USB stick to another laptop, edit it there and then copy it back. That will
|
|
<em>delete other people's work</em>.
|
|
|
|
<p>If you are using your own laptop then you will need to either:
|
|
<ul>
|
|
<li>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
|
|
<li><a href="onlinesystems.html#manual">install and learn how to use</a> 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.
|
|
</ul>
|
|
|
|
<p>Logbooks are typed up and kept in the [expoweb]/years/[nnnn]/ directory as 'logbook.html'.</p>
|
|
|
|
<h3 id="another">Typing on another machine</h3>
|
|
<p>
|
|
Rather than editing logbook.html when you type up your trip, it is a much better
|
|
idea to type up <i>just your trip(s)</i> in a separate file, e.g. "logbook-mynewtrip.txt", and email it to a nerd if you are sitting at a different laptop.
|
|
|
|
|
|
<h3 id="format">Format of the online logbooks</a></h3>
|
|
|
|
|
|
<p>Do whatever you like to try and represent the logbook in html. The only rigid structure is the markup to allow troggle to parse the files into 'trips':</p>
|
|
<code><pre>
|
|
<hr />
|
|
<div class="tripdate" id="t2007-07-12B">2007-07-12</div>
|
|
<div class="trippeople"><u>Jenny Black</u>, Olly Betts</div>
|
|
<div class="triptitle">Top Camp - Setting up 76 bivi</div>
|
|
<div class="timeug">T/U 10 mins</div></pre></code>
|
|
<p>Note: the ID's must be unique, so are generated from 't' plus the trip date plus a,b,c etc.
|
|
when there is more than one trip on a day.</p>
|
|
<p>Note: T/U stands for "Time Underground" in hours (6 minutes would be "0.1 hours").
|
|
<p>Note: the <hr /> is significant and used in parsing, it is not just prettiness.
|
|
|
|
<p>[ Yes this format needs to be re-done using a proper structure:<br>
|
|
<code><pre>
|
|
<div class="logentry"><br>
|
|
<span style="text-decoration: line-through wavy red;"> </span>
|
|
</div"></pre></code>
|
|
it's on the to-do list...]
|
|
<hr />
|
|
<h3 id="history">Historical logbooks</h3>
|
|
<p>Older logbooks (prior to 2007) were stored as logbook.txt with just a bit of consistent markup to allow troggle parsing.</p>
|
|
|
|
<p>The formatting was largely freeform, with a bit of markup ('===' around header, bars separating date, <place> - <description>, 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.</p>
|
|
|
|
<p>So the format should be:</p>
|
|
|
|
<code>
|
|
===2009-07-21|204 - Rigging entrance series| Becka Lawson, Emma Wilson ===
|
|
</br>
|
|
{Text of logbook entry}
|
|
</br>
|
|
T/U: Jess 1 hr, Emma 0.5 hr
|
|
</code>
|
|
|
|
<h3 id="import">Importing the logbook into troggle</a></h3>
|
|
<p>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.
|
|
|
|
<p>The nerd needs to login to the expo server using <em>their own userid</em>, not the 'expo' userid. The nerd also needs to be in the group that is allowed to do 'sudo'.
|
|
|
|
<p>The nerd needs to do this:
|
|
<ol>
|
|
<li>Look at the list of pre-existing old import errors at </br> <a href="http://expo.survex.com/admin/core/dataissue/">http://expo.survex.com/admin/core/dataissue/</a> </br>
|
|
The nerd will have to login to the troggle management console to do this, not just the usual troggle login.
|
|
<li>You need to get the list of people on expo sorted out first. </br>
|
|
This is documented in the <a href="computing/folkupdate.html">Folk Update</a> process.
|
|
<li>Log in to the expo server and run the update script (see below for details)
|
|
<li>Watch the error messages scroll by, they are more detailed than the messages archived in the old import errors list
|
|
<li>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 <a href="computing/folkupdate.html">Folk Update</a> process first.
|
|
<li>Re-run the import script until you have got rid of all the import errors.
|
|
<li>Pat self on back. Future data managers and people trying to find missing surveys will worship you.
|
|
</ol>
|
|
|
|
<p>The procedure is like this. It will be familiar to you because
|
|
you will have already done most of this for the <a href="computing/folkupdate.html">Folk Update</a> process.
|
|
|
|
<pre><code>ssh {youruserid}@expo.survex.com
|
|
cd ~expo
|
|
cd troggle
|
|
sudo python databaseReset.py logbooks
|
|
</code></pre>
|
|
|
|
<p>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
|
|
<pre><code>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'</code></pre>
|
|
<hr />
|
|
|
|
</body>
|
|
</html>
|
|
|