expoweb/handbook/logbooks.html

126 lines
6.2 KiB
HTML

<html>
<head>
<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. All these logbook entries are then typed into a laptop (often the expo laptop)
which is then synchronised the version control system.
<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>If you are at basecamp, then it is an excellent idea to
<b>type your logbook trip report</b> instead of writing it by hand - see <a href=#type">below</a>.
<p>The contents of both the topcamp logbook and the basecamp logbook are typed into the same
"logbook.html" file for archiving. The drawings are scanned and stored in the same place, and hand-edited
into the logbook.html file after expo finished.
<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>
<h3 =id="type">Typing just your trip report</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.
<h3>Adding your trip to the logbook online file</h3>
<p>If you are using the <em>expo laptop</em> just edit this file:
<pre>
/home/expoweb/years/2018/logbook.html
</pre>
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>Recommended procedure</a></h3>
<p>
Rather than editing logbook.html when you type up your trip, it is a much better
idea to type up your trip(s) in a separate file, e.g. "logbook-mynewtrip.txt", and store it in the same
place on the <em>expo laptop</em>, i.e.
<pre>
/home/expoweb/years/2018/
</pre>
<p>or email it to a nerd if you are sitting at a different laptop.
<h3>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>
<pre>
&lt;div class="tripdate" id="t2007-07-12B"&gt;2007-07-12&lt;/div&gt;
&lt;div class="trippeople"&gt;&lt;u&gt;Jenny Black&lt;/u&gt;, Olly Betts&lt;/div&gt;
&lt;div class="triptitle"&gt;Top Camp - Setting up 76 bivi&lt;/div&gt;
&lt;div class="timeug"&gt;T/U 10 mins&lt;/div&gt;
</pre>
<p>Note that 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>T/U stands for "Time Underground" in hours (6 minutes would be "0.1 hours").
<hr />
<h3>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>
<pre>
===2009-07-21|204 - Rigging entrance series| Becka Lawson, Emma Wilson, Jess Stirrups, Tony Rooke===
&lt;Text of logbook entry&gt;
T/U: Jess 1 hr, Emma 0.5 hr
</pre>
<hr />
<ul id="links">
<li><a href="index.htm">Expedition Handbook</a>
</ul>
</body>
</html>