expo/expoweb
1
0
Fork 0
mirror of https://expo.survex.com/repositories/expoweb/.git/ synced 2024-11-26 09:11:59 +00:00
Code Issues Packages Projects Releases Wiki Activity
79bfed457f
expoweb/handbook/logbooks.html

172 lines
10 KiB
HTML
Raw Normal View History

Documenting how to add a new year and new people in folk.csv and test that it works by running the databaseRest.py people command
2020-02-21 00:23:59 +00:00
<!DOCTYPE html>
extracting logbook update process into a separate file
2018-07-13 22:55:38 +01:00
<html>
<head>
Documenting how to add a new year and new people in folk.csv and test that it works by running the databaseRest.py people command
2020-02-21 00:23:59 +00:00
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
extracting logbook update process into a separate file
2018-07-13 22:55:38 +01:00
<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>
data entry update
2018-08-17 14:16:36 +01:00
<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:
Documenting how to add a new year and new people in folk.csv and test that it works by running the databaseRest.py people command
2020-02-21 00:23:59 +00:00
the base camp logbook or the top camp logbook.
extracting logbook update process into a separate file
2018-07-13 22:55:38 +01:00
added link to recent logbooks as rquested
2019-07-17 11:26:27 +01:00
<ul>
New Cave data entry process: logbook entry, wallets, survex files,
2020-02-28 16:18:54 +00:00
<li>Why the logbook is so important
Documenting how to add a new year and new people in folk.csv and test that it works by running the databaseRest.py people command
2020-02-21 00:23:59 +00:00
<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>
New Cave data entry process: logbook entry, wallets, survex files,
2020-02-28 16:18:54 +00:00
<li><a href="computing/logbooks-parsing.html">Importing</a> the logbook into troggle (nerds only) - and error checking
added link to recent logbooks as rquested
2019-07-17 11:26:27 +01:00
</ul>
Do not edit logbooks online
2022-06-21 15:39:54 +01:00
<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.
Documenting how to add a new year and new people in folk.csv and test that it works by running the databaseRest.py people command
2020-02-21 00:23:59 +00:00
<h3 id="why">Why the logbook is important</h3>
knitting in docmn for writing logbook entries, fixing old survey methods
2018-08-09 10:31:45 +01:00
<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.
Documenting how to add a new year and new people in folk.csv and test that it works by running the databaseRest.py people command
2020-02-21 00:23:59 +00:00
<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.
New Cave data entry process: logbook entry, wallets, survex files,
2020-02-28 16:18:54 +00:00
<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
Surveying instructions updates
2022-12-10 16:09:19 +00:00
<a href="survey/datamgt.html">Cave data management</a>,
New Cave data entry process: logbook entry, wallets, survex files,
2020-02-28 16:18:54 +00:00
and then the
Documenting how to add a new year and new people in folk.csv and test that it works by running the databaseRest.py people command
2020-02-21 00:23:59 +00:00
<a href="survey/index.htm">Survey Handbook</a>
Rigging Guide now includes Slack chat stuff
2020-07-27 22:04:17 +01:00
<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.
New Cave data entry process: logbook entry, wallets, survex files,
2020-02-28 16:18:54 +00:00
to-do lists updates
2023-02-02 21:50:24 +00:00
<h3 id="type">The online logbook file</h3>
Documenting how to add a new year and new people in folk.csv and test that it works by running the databaseRest.py people command
2020-02-21 00:23:59 +00:00
data entry update
2018-08-17 14:16:36 +01:00
<p>If you are at basecamp, then it is an excellent idea to
Documenting how to add a new year and new people in folk.csv and test that it works by running the databaseRest.py people command
2020-02-21 00:23:59 +00:00
<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.
data entry update
2018-08-17 14:16:36 +01:00
docm improvements
2018-08-11 16:54:55 +01:00
<p>The contents of both the topcamp logbook and the basecamp logbook are typed into the same
Documenting how to add a new year and new people in folk.csv and test that it works by running the databaseRest.py people command
2020-02-21 00:23:59 +00:00
"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>
New Cave data entry process: logbook entry, wallets, survex files,
2020-02-28 16:18:54 +00:00
<p>All these scanned handwritten logbook entries are typed into a laptop (often the expo laptop)
Documenting how to add a new year and new people in folk.csv and test that it works by running the databaseRest.py people command
2020-02-21 00:23:59 +00:00
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>.
Cleaning up contents lists linking to pages deep inside a multistep process
2018-08-11 08:52:47 +01:00
Rigging Guide now includes Slack chat stuff
2020-07-27 22:04:17 +01:00
<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.
Very basic user data input updates - removing mercurial
2019-07-08 19:48:22 +01:00
<h3 =id="type">Typing just your trip report (at the <i>Expo Laptop</i>)</h3>
New Cave data entry process: logbook entry, wallets, survex files,
2020-02-28 16:18:54 +00:00
<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.
data entry update
2018-08-17 14:16:36 +01:00
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.
Completing fomratting for for <!DOCTYPE html> to make sure ann <br> and <hr> are now conformant
2020-03-05 23:23:41 +00:00
<br />If you are unlucky it will bring up the previous person's file.
data entry update
2018-08-17 14:16:36 +01:00
<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.
Documenting how to add a new year and new people in folk.csv and test that it works by running the databaseRest.py people command
2020-02-21 00:23:59 +00:00
<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>
data entry update
2018-08-17 14:16:36 +01:00
copy the format you can see other people have used;
Better instructions for typing in logbook entries
2018-07-17 10:59:48 +01:00
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>.
knitting in docmn for writing logbook entries, fixing old survey methods
2018-08-09 10:31:45 +01:00
<p>If you are using your own laptop then you will need to either:
<ul>
New Cave data entry process: logbook entry, wallets, survex files,
2020-02-28 16:18:54 +00:00
<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
New docum. and logbook/blog update
2022-12-17 18:34:39 +00:00
<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>).
Better instructions for typing in logbook entries
2018-07-17 10:59:48 +01:00
And you will need to synchronise regularly (every day) to
New docum. and logbook/blog update
2022-12-17 18:34:39 +00:00
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.
knitting in docmn for writing logbook entries, fixing old survey methods
2018-08-09 10:31:45 +01:00
</ul>
Better instructions for typing in logbook entries
2018-07-17 10:59:48 +01:00
<p>Logbooks are typed up and kept in the [expoweb]/years/[nnnn]/ directory as 'logbook.html'.</p>
extracting logbook update process into a separate file
2018-07-13 22:55:38 +01:00
Documenting how to add a new year and new people in folk.csv and test that it works by running the databaseRest.py people command
2020-02-21 00:23:59 +00:00
<h3 id="another">Typing on another machine</h3>
docm improvements
2018-08-11 16:54:55 +01:00
<p>
Rather than editing logbook.html when you type up your trip, it is a much better
Very basic user data input updates - removing mercurial
2019-07-08 19:48:22 +01:00
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.
docm improvements
2018-08-11 16:54:55 +01:00
Documenting how to add a new year and new people in folk.csv and test that it works by running the databaseRest.py people command
2020-02-21 00:23:59 +00:00
<h3 id="format">Format of the online logbooks</a></h3>
extracting logbook update process into a separate file
2018-07-13 22:55:38 +01:00
<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>
Documenting how to add a new year and new people in folk.csv and test that it works by running the databaseRest.py people command
2020-02-21 00:23:59 +00:00
<code><pre>
<hr> format
2020-02-24 22:37:53 +00:00
&lt;hr /&gt;
extracting logbook update process into a separate file
2018-07-13 22:55:38 +01:00
&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;
to-do lists updates
2023-02-02 21:50:24 +00:00
&lt;div class="timeug"&gt;T/U 0.2 hrs&lt;/div&gt;</pre></code>
<hr> format
2020-02-24 22:37:53 +00:00
<p>Note: the ID's must be unique, so are generated from 't' plus the trip date plus a,b,c etc.
Better instructions for typing in logbook entries
2018-07-17 10:59:48 +01:00
when there is more than one trip on a day.</p>
to-do lists updates
2023-02-02 21:50:24 +00:00
<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.
Docs on QM code status, troggle redesign
2020-05-14 22:28:13 +01:00
<p>Note: the <var><span style="color:red">&lt;hr /&gt;</span></var> is significant and used in parsing, it is not just prettiness.
New docum. and logbook/blog update
2022-12-17 18:34:39 +00:00
<p>Note: follow this format exactly. No HTML comments or tabs or newlines.
Docs on QM code status, troggle redesign
2020-05-14 22:28:13 +01:00
<p>Note this special format <var>"<span style="color:red">Top Camp - </span>"</var> in the triptitle line:
<code><pre>&lt;div class="triptitle"&gt;<span style="color:red">Top Camp - </span>Setting up 76 bivi&lt;/div&gt;</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.
Rigging Guide now includes Slack chat stuff
2020-07-27 22:04:17 +01:00
<p>Note this special format <var>"<span style="color:red">&lt;u&gt;Jenny Black&lt;/u&gt;</span>"</var> in the trip-people line:
Docs on QM code status, troggle redesign
2020-05-14 22:28:13 +01:00
<code><pre>&lt;div class="trippeople"&gt;<span style="color:red">&lt;u&gt;Jenny Black&lt;/u&gt;</span>, Olly Betts&lt;/div&gt;
</pre></code>
It is necessary that one (and only one) of the people on the trip is set in <span style="color:red">&lt;u&gt;&lt;/u&gt;</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.
Documenting how to add a new year and new people in folk.csv and test that it works by running the databaseRest.py people command
2020-02-21 00:23:59 +00:00
to-do lists updates
2023-02-02 21:50:24 +00:00
<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>&lt;div class="trippeople"&gt;&lt;u&gt;Jenny Black&lt;/u&gt;, Olly Betts, <span style="color:red">*Ol's Mum</span>&lt;/div&gt;
</pre></code>
or
<code><pre>&lt;div class="trippeople"&gt;&lt;u&gt;Jenny Black&lt;/u&gt;, Olly Betts, <span style="color:red">*4 Hungarian Cavers</span>&lt;/div&gt;
</pre></code>
New Cave data entry process: logbook entry, wallets, survex files,
2020-02-28 16:18:54 +00:00
to-do lists updates
2023-02-02 21:50:24 +00:00
<hr />
Go on to <a href="computing/logbooks-parsing.html">Importing logbooks into troggle</a>.
<hr />
extracting logbook update process into a separate file
2018-07-13 22:55:38 +01:00
</body>
</html>
Reference in New Issue Copy Permalink