expoweb/handbook/logbooks.html

80 lines
3.5 KiB
HTML
Raw Normal View History

<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 hand-written write-up 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 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>Where the logbook computer file is kept</h3>
<p>If you are using the <em>expo laptop</em> just edit this file:
<pre>
/home/expoweb/years/2018/logbook.html
</pre>
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, or just write it in an email, and send it to someone nerdish, or
<li><a href="update.htm#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>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>