logbook documn update

This commit is contained in:
2023-01-27 01:02:05 +00:00
parent 738818d205
commit 89b3603db5
2 changed files with 12 additions and 10 deletions

View File

@@ -81,8 +81,8 @@ which takes between 300s and 15 minutes on the server.
<h3 id="history">Historical logbooks format</h3> <h3 id="history">Historical logbooks format</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>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>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. </p>
<p>There were also several previous (different) styles of using HTML. The one we are using now is the 5th variant. These older variants are steadily being reformatted into the current HTML format so that we only need to maintain the code for one parser. <p>There were also several previous (different) styles of using HTML. The one we are using now is the 5th variant. These older variants were eventually all reformatted into the current HTML format so that now (Jan. 2023) we only need to maintain the code for one parser.
<!-- <!--
<p>So the format should be:</p> <p>So the format should be:</p>

View File

@@ -55,8 +55,9 @@ which is different for every machine as we have no recommended standard setup.
<h3>Use with Common Social Media</h3> <h3>Use with Common Social Media</h3>
<p>The 2019 expo was documented on two different blogs and the content has still not got copied into <p>The 2019 expo was documented on two different blogs and the content has still not got copied into
our own expo logbooks. One of these is UK caving, and for one post the caver used an ephemeral location for our own expo logbooks. One of these is UK caving, and for one post the caver used an ephemeral
the illutrating photographs - which were very good. We have these archived on expofiles somewhere. location for the illutrating photographs - which were very good. We have these archived on expofiles
somewhere. [We now have a documented, but convoluted, procedure for managing this, see <a href="/handbook/computing/log-blog-parsing.html">log-blog-parsing</a>.]
<p>We seem to have lost the expo twitter account credentials. <p>We seem to have lost the expo twitter account credentials.
<p>We have an expo Facebook account. <p>We have an expo Facebook account.
<p>We used to use Slack and (in 2022) use Trello for expo organisation. We have moved from Slack to <p>We used to use Slack and (in 2022) use Trello for expo organisation. We have moved from Slack to
@@ -64,7 +65,7 @@ Element, which we can archive ourseleves, and maybe we can use Kanboard (ditto)
<h2 id="badly">Things Troggle Does Badly</h2> <h2 id="badly">Things Troggle Does Badly</h2>
<h3>Managing periople's names</h3> <h3>Managing people's names</h3>
<p>As of 2022, there are 15 people troggle can't cope with at all because their name is not structured as <p>As of 2022, there are 15 people troggle can't cope with at all because their name is not structured as
"Forename Surname": where it is only two words and each begins with a capital letter (with no other punctuation, "Forename Surname": where it is only two words and each begins with a capital letter (with no other punctuation,
capital letters or other names or initials). See the design document <a href="namesredesign.html">handling people's names properly</a>. capital letters or other names or initials). See the design document <a href="namesredesign.html">handling people's names properly</a>.
@@ -75,17 +76,18 @@ namespace of the form is different from where the cave description will be actua
the A HREF tags and IMG SRC tags correct for the referenced passage text and photos, and also to relevant the A HREF tags and IMG SRC tags correct for the referenced passage text and photos, and also to relevant
bits of logbook, is unnecessarily convoluted. bits of logbook, is unnecessarily convoluted.
<p>This needs a small but significant re-design. <p>This needs a small but significant re-design.
<p>We have an incresing number of "pending" caves where we have some data about them, but nobody has written even the beginnings of a cave description file. See the pending list from the most recent import in <a href="/dataissues">caves</a>.
<h3>Consistency Checking between Input Sources</h3> <h3>Consistency Checking between Input Sources</h3>
<p>We have a manual, offline, poorly-documented script <a <p>We have a manual, offline, poorly-documented script <a
href="scriptscurrent.html#survex">check-svx.sh</a> which does some checks on survex files' *ref wallet href="scriptscurrent.html#survex">check-xml.sh</a> which does some checks on Tunnel file references
references. We have a similar thing <var>check-xml.sh</var> that checks Tunnel file references to survex to survex files. We have the beginnings of a parser to do the same for Therion drawings. These are
files. We have the beginnings of a parser to do the same for Therion drawings. These are currently currently no better than proof-of-concept and need to be rewritten in troggle.
no better than proof-of-concept and need to be rewritten in troggle.
<p>We could do with reports that identify survex files with no equivalent logbook entry (which would show <p>We could do with reports that identify survex files with no equivalent logbook entry (which would show
up all the ARGE surveys, but we could filter those out). up all the ARGE surveys, but we could filter those out).
<p>We could do with finding drawn-up Tunnel and Therio files with no documented link to their source data <p>We could do with finding drawn-up Tunnel and Therion files with no documented link to their source data
in survex files. in survex files.
<p>We have an imperfect report <a href="/therionissues">therionissues</a> on references within in Therion files
<p>We could do with better reports on survex files which have neved been drawn up ("tunnelled"). <p>We could do with better reports on survex files which have neved been drawn up ("tunnelled").
<h3>Online Wallet Management</h3> <h3>Online Wallet Management</h3>