expo/expoweb
1
0
Fork 0
mirror of https://expo.survex.com/repositories/expoweb/.git/ synced 2024-11-25 16:52:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

More wallet documentation and links to troggle reporting

Browse Source
This commit is contained in:
Philip Sargent 2019-04-02 00:54:05 +01:00
parent b50e4d02da
commit e3d530260b
2 changed files with 56 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
handbook/caveentry.html
View File

@ -12,6 +12,8 @@
some of them are a quite mysterious. This page explains what they mean, and how to enter new
caves and entrances, and especially how to add images/surveys so that they appear.</p>
<p>There is a bug in that the 'new entrance' page which fails unless the entrance has been previously created on another cave. This is being fixed (April 2019).
<p>Effectively each field is concatenated to make an HTML
page for the cave (or entrance), so each field may contain arbitrary HTML.</p>
@ -64,7 +66,7 @@
</dl>
<dl>
<dt>unofficial_number</dt>
<dd>(<i>Either this or kataster_number is required</i>). Initial temporary cave ID used until kataster number is allocated. (e.g. 2012-DD-01)</dd>
<dd>(<i>Either this or kataster_number is required</i>). Initial temporary cave ID used until kataster number is allocated. (e.g. 2012-DD-01) If you do not give this (or the kataster_number if issued) then your cave <em>will not appear</em> in the caves list (<a href="http://expo.survex.com/caves">Main Index/caves</a>).</dd>
</dl>
<dl>
<dt>entrance</dt>

74
handbook/survey/onlinewallet.html
View File

@ -38,7 +38,7 @@ Creating a new cave...</a> for the full list of steps.
</ul>
<p>but the <em><span style="font-family:monospace">contents.json</span></em> file has another,completely different function:
it is the <b>only online record</b> that connects the wallet number to the cave identifier. So if a future cave surveyor deperately needs
it may be the <b>only online record</b> that connects the wallet number to the cave identifier. So if a future cave surveyor deperately needs
to consult the original cave survey, it can be done by, e.g. <br>
<span style="font-family:monospace">
grep -rl "2018-dm-07" expofiles/surveyscans
@ -46,6 +46,22 @@ grep -rl "2018-dm-07" expofiles/surveyscans
will find and list all the wallets which contain survey data for cave 2018-dm-07 (which is also known as "Homecoming Cave" and which will
have a different Austrian Kataster number issued for it in due course).
<p>The link between a .svx file and the wallet should also be recorded in the .svx file itself using the "*ref:" field, e.g.
<pre>
*ref 2018#06
; the #number is on the clear pocket containing the original notes
</pre>
But sometime in mid-Expo 2015 everyone stopped using the survex template file and so this information was not recorded since then. This will be fixed by hand-editing indue course.
(Note that many old .svx files were processed with an older version of survex which did not suppport this feature and so a comment was used instead.)
<p>Troggle produces very useful auto-generated reports of the status of the wallets and the survex files
<ul>
<li><a href="http://expo.survex.com/survey_scans/">List of all wallets</a> and the survex files produced from them (incomplete due to poor data entry especially since 2015)
<li><a href="http://expo.survex.com/expedition/2018">List of all trips and survex files</a> (scroll down to the bottom of the page) in any one year - includes a link to the logbook fragment for the relevant day
<li><a href="http://expo.survex.com/personexpedition/MichaelSargent/2018">List of trips and surveys</a> by a particular person in a particular year (nothing to do with wallets but added here for completeness).
</ul>
These troggle reports are invaluable for finding data entry errors or other mistakes.
<p> The paper tick-list tracks the following steps for each online wallet:
<ul>
<li><u>Survex</u>
@ -170,6 +186,26 @@ This does not matter for the autogenerated files, but it is vital that it does n
This does mean that this is one of the cases where
it is better to use <span style="font-family:monospace; size=x-small; background-color: lightgray">rsync</span> rather than an FTP client such as Filezilla.
<h4>Naming the included files</h4>
<p>The script detects if there are notesX.jpg planX.jpg and elevX.jpgfiles present, and
produces a reminder/warning if they are not,even if these have all been scanned
and given different names.
<p>
The job of the checker (perhaps on a second pass) if to rename files so that these
warnings disappear.
<h4>Not under version control</h4>
<p>
As all this is not under version control the timestamps of the files are really quite important in figuring things out when someone makes an update mistake.
<p>
So script <span style="font-family:monospace; size=x-small; background-color: lightgray">wallets.py</span> has been fixed so that
<ul>
<li>the generated <span style="font-family:monospace; size=x-small; background-color: lightgray">index.html</span> file in each wallet folder is given the same timestamp as the <span style="font-family:monospace; size=x-small; background-color: lightgray">contents.json</span> file there, <em>not the time of when the script is run</em>. This is unusual but intentional and in practice very helpful.
<li>the script no longer overwrites the <span style="font-family:monospace; size=x-small; background-color: lightgray">contents.json</span> files every time it runs. It only changes that file's timestamp if it actually changes anything in the contents.json file.
</ul>
<h4>Useful rsync scripts</h4>
<p>A copy of useful rsync scripts is kept in a file such as
<span style="font-family:monospace; size=x-small; background-color: lightgray">expo.survex.com/expofiles/rsync2018toserver</span>. Always run it with the -n option first,
to see what overwriting you will do.
@ -187,6 +223,7 @@ different formats. It also
<p>Things it might do in future (if someone gets around to it) include: <br>
- checking the cave number specified matches the folder for the .svx file,<br>
- checking that the *ref: filed in the survex file is the same as the wallet name<br>
- detecting whether there is a description or a list of QMs in the survex file,<br>
- accepting a list of .svx files and not just one (a very common thing),<br>
- checking the name of the cave against the cave number,<br>
@ -257,13 +294,6 @@ in contents.json so it is impossible to tell what was done on that trip or wheth
there is anything missing. This is especially true if it was electronic and the
.topo files are missing. Wookey confirms that this is the case.
NAMING
The script detects if there are notesX.jpg planX.jpg and elevX.jpgfiles present, and
produces a reminder/warning if they are not,even if these have all been scanned
and given different names.
The job of the checker (perhaps on a second pass) if to rename files so that these
warnings disappear.
HINT
When there are a lot on wallets all with the same cave, make your own template
@ -277,26 +307,28 @@ a consolidated to-do list of the last 3 years on the server:
http://expo.survex.com/expofiles/surveyscans/2016-18/index.html
This is a hand-done kludge and only the first level of links works - which is to the individual person's page.
the lists for the last 3 years individually and all the links are working for each wallet page: both local links to your PC and to the right location of the .svx files on the troggle server.
the lists for the last 3 years individually and all the links are working for each wallet page:
both local links to your PC and to the right location of the .svx files on the troggle server.
http://expo.survex.com/expofiles/surveyscans/2016/index.html
http://expo.survex.com/expofiles/surveyscans/2017/index.html
http://expo.survex.com/expofiles/surveyscans/2018/index.html
and all the names of people have been hand-edited in the .json files to be consistent and identical.
2015 will be done soon.
Changes to script wallets.py
----------------------------
As all this is not under version control the timestamps of the files were probably quite important in figuring things out when someone makes an update mistake.
So script wallets.py is modified so that
- the generated index.html file in each wallet folder is given
the same timestamp as the contents.json file there,
- the script no longer overwrites the contents.json files every
time it runs. It only changes the timestamp if it actually changes anything.
2015 has now been done stand-alone but there is no consolidated report for 2015-18 yet.
The big task was editing everyone's names to be exactly the same version of the name as used in other years.
For 2014 and earlier one needs to do a lot more data entry. The contents.json files for 2014 and earlier do not say who the people were on the trip. So we would need to work from the original plastic wallets (and the scanned drawings and notes – which are incomplete) to enter that data. This is probably not worth doing except maybe for specific critical connections.
For 2014 and earlier one needs to do a lot more data entry. The contents.json files for 2014 and earlier do not say who the
people were on the trip. So we would need to work from the svx files (where they contain the *ref: wallet ID),
original plastic wallets (and the scanned drawings and notes – which are incomplete) to enter that data.
This is made much easier by the troggle reports
http://expo.survex.com/survey_scans/
http://expo.survex.com/expedition/2014
http://expo.survex.com/survey/2018%2330
This is probably not worth doing except maybe for specific critical connections.
The script runs without errors on each of the years 1999-2014, but the results are less useful, e.g. see
http://expo.survex.com/expofiles/surveyscans/1999/