mirror of
https://expo.survex.com/repositories/expoweb/.git/
synced 2024-11-30 05:41:56 +00:00
183 lines
12 KiB
HTML
183 lines
12 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>Why 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="computing/logbooks-parsing.html">Importing</a> the logbook into troggle (nerds only) - and error checking
|
|
</ul>
|
|
|
|
<p>Please do NOT use the "Edit this page" capability to edit previous logbooks. The HTML format is not robust enough
|
|
(to be honest all this logbook stuff is a bit of a kludge). See the link above "<a href="computing/logbooks-parsing.html">Importing</a>" as any mistake will crash the import parser.
|
|
Historic logbooks should only be edited by an expert, and the import process should be tested offline before the edited logbook is uploaded to the server.
|
|
|
|
<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>
|
|
<a href="/years/2018/logbook.html#t2018-08-03w"><img src="i/logbookpage.jpg" class="onright"></a>
|
|
If this is all new to you, please now read
|
|
<a href="survey/why.htm"><strong>Why we make surveys</strong></a>
|
|
and
|
|
<a href="survey/datamgt.html">Cave data management</a>,
|
|
and then the
|
|
<a href="survey/index.htm">Survey Handbook</a>
|
|
|
|
<h3>Initial rigging guide</h3>
|
|
<p>The logbook is the place where we record the rigging of caves as we discover them. You will manually copy the notes you made underground into the logbook.
|
|
<p>Writing up this and the final rigging guide is an important part of the Expo cave exploration process and is documented in <a href="survey/newrig.html">a specific "rigging" section</a> the survey handbook.
|
|
|
|
<h4>Type it up</h4>
|
|
<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>If you are up on the plateau, just write it up on your phone. OK you can't sketch diagrams really, but you can include photos easily. Just do it as a n email or a pot.
|
|
<p>We will have an online form for uploading logbook entries (text only, and HTML links to images) for the 2024 expo at <a href="/logbookedit/">/logbookedit/</a>.
|
|
|
|
<h3 =id="type">Typing your trip report - in the UK Caving Blog</h3>
|
|
<p>In recent years we have seen an admirable increase in the number of people writing up their trips and experiences on social media and in particular on the UK Caving blog, see <a href="https://ukcaving.com/board/index.php?topic=25249.0">2019 Blog</a>. But please, please also make a handwritten entry in the logbook saying you have done this so that the text and pictures can be transcribed later. It is too easy to lose these: in 2018 there were two blogs in operation and most people didn't know that.
|
|
|
|
<h3 =id="type">Typing just your trip report (your phone or the <i>Expo Laptop</i>)</h3>
|
|
<p>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.
|
|
|
|
<p>These days, just write up your trip as a message on your phone and post it to the Matrix chat group 'expo' (<a href="https://app.element.io/#/room/#expo:matrix.org">app.element.io/#/room/#expo:matrix.org</a>), or email it to a nerd.
|
|
|
|
<p>Alternatively, if 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. On the Desktop is an icon labelled "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 id="type">The online logbook file</h3>
|
|
|
|
|
|
|
|
<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 scanned handwritten logbook entries are 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>.
|
|
|
|
<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; <em>tell a nerd that you have done this</em>
|
|
so that they can 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 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
|
|
<li>Install and learn how to use the version control software. (This requires a <var><a href="computing//bulkupdatelaptop.html">Bulk Update Laptop</a></var>).
|
|
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. Not recommended until you have been on a previous expo and have helped do the post-expo data tidy afterwards.
|
|
</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 but do keep is <em>simple</em>. Don't try any clever HTML stuff. See the <a href="computing/hbmanual1.html#images">"Edit this Page"</a> instructions for how to insert images and figures.
|
|
|
|
|
|
<p>When writing logbook entries, just use <a href="computing/hbmanual1.html#images">relative URLs</a> to the same folder as your text, e.g. <var>href="mynicepic.jpg"</var> and the image and the logbook HTML will, for a 2017 expo, be put into <var>/years/2017/</var>.
|
|
|
|
<p>One special suggestion: do not use <P> paragraph tags. Well, you can if you like, but they will be stripped out and replaced by double-newlines when the file is parsed. This is because <P> paragraph tags cannot be nested - that is not allowed in HTML - and the fragment you are writing will be merged with other fragments and may be put inside a higher-level paragraph. [This is also true for Cave Description text in <a href="survey/caveentry.html">"Edit this Cave"</a>.]
|
|
|
|
<h4> Logbook-specific HTML</h4>
|
|
<p>
|
|
The only rigid structure is the markup to allow troggle to parse the logbook 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 0.2 hrs</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: <var><span style="color:red">T/U</span></var> stands for "Time Underground" in decimal hours, e.g. "0.2" for 12 minutes (approx.) . We do not parse or collate this information currently.
|
|
<p>Note: the <var><span style="color:red"><hr /></span></var> is significant and used in parsing, it is not just prettiness.
|
|
<p>Note: follow this format exactly. No HTML comments or tabs or newlines.
|
|
|
|
<p>Note this special format <var>"<span style="color:red">Top Camp - </span>"</var> in the triptitle line:
|
|
<code><pre><div class="triptitle"><span style="color:red">Top Camp - </span>Setting up 76 bivi</div></pre></code>
|
|
It denotes the <var>cave</var> or <var>area</var> the trip or activity happened in. It is a word or two separated from the rest of the triptitle with "<var> - </var>" (space-dash-space). Usual values
|
|
for this are "Plateau", "Base camp", "264", "Balkon", "Tunnocks", "Travel" etc.
|
|
|
|
<p>Note this special format <var>"<span style="color:red"><u>Jenny Black</u></span>"</var> in the trip-people line:
|
|
<code><pre><div class="trippeople"><span style="color:red"><u>Jenny Black</u></span>, Olly Betts</div>
|
|
</pre></code>
|
|
It is necessary that one (and only one) of the people on the trip is set in <span style="color:red"><u></u></span> underline format. This is interpreted to mean that this is the author of the logbook entry. If there is no author set, then this is an error and the entry is ignored.
|
|
|
|
<p>If you like, you can put non-expo people in the trip-people line: <var>"<span style="color:red">*Ol's Mum</span>"</var> with a <span style="color:red">*</span> prefix and they will be totally ignored by troggle:
|
|
<code><pre><div class="trippeople"><u>Jenny Black</u>, Olly Betts, <span style="color:red">*Ol's Mum</span></div>
|
|
</pre></code>
|
|
or
|
|
<code><pre><div class="trippeople"><u>Jenny Black</u>, Olly Betts, <span style="color:red">*4 Hungarian Cavers</span></div>
|
|
</pre></code>
|
|
|
|
<hr />
|
|
Go on to <a href="computing/logbooks-parsing.html">Importing logbooks into troggle</a>.
|
|
<hr /></body>
|
|
</html>
|
|
|