# Instructions
# 2019-03-02
# Philip Sargent

Wookey told me to sort out the contents.json files in expofiles/surveyscans/2018/
and these are my notes to remind myself what this entails.
This note was written during August 2018.

The job is to populate the contents.json file in each folder, e.g.

expofiles/surveyscans/2018/2018#03/contents.json

using the following input materials:
- the wallet 2018#03 and the papers inside it. This is in the 2018 lever-arch file.
- the folder in repo 'loser' holding the appropriate .svx files e.g.
  "caves-1623/2017-cucc-24/gshclimb.svx"
- the script expofiles/surveyscans/2018/wallets.py (run by "python wallets.py")

the "wallets.py" script creates index.html files in each folder /2018/2018#nn/
and creates or updates a webpage for each person listed in any of the contents.json files
in the folder/2018/ e.g. "Becka Lawson.html".

The script wallets.py requires that the //loser// repo is populated on the machine that you
run the script on so that it can find the.svx files. Do not run this script on
the expo server itself as the loser repo is in the wrong place and all the .svx files
will be flagged as "not found" (Pauul Fox did this once).

wallets.py now (Feb.2019) takes a command-line argument for the location of the loser repo, e.g.
python wallets.py "/mnt/d/CUCC-Expo/loser/"

Before doing anything else, run wallets.py. This will create empty template contents.json
files in each folder.

You may need to create missing folders,e.g. I just had to create /2018/2018#30 to #32.

Every time you finish entering the data in contents.json in a folder, 
run wallets.py to update the "person" html files and to 
re-generate the index.html file for the 2018 folder as 
a whole (surveyscans/2018/index.html).

But wallets.py does not delete old files which are not regenerated. 
So it is a good idea to delete all the .html files
before running it.

The first difficulty is finding out which cave a wallet describes.. 
The wallet may say "radaghost to blitzkriek"
(or whatever) but without the name of the cave you can't find the .svx files 
as you don't know that you need to look in e.g. loser/caves-1626/2018-dm-07/
Usually this is written by hand on the label of the wallet.

There are ambiguities about how the entries in the contents.json actually lead to
reminder instructions in the html files produced, and this is particularly
difficult for electronic caves where the topo files are missing
and for surface prospecting where it is not clear which of the actions
should be done and thus which products should be produced.

This needs to be documented.

For prospecting and surface surveying it is not clear whether the default folder
for the url link should be repo //loser// surface/1623/allplateau.svx

When there are more than one .svx file there seems to be no way of recording the list 
in contents.json so it is impossible to tell what was done on that trip or whether
there is anything missing. This is especially true if it was electronic and the 
.topo files are missing. Wookey confirms that this ios the case.

wallets.py will not overwrite any contents.json file, it only creates one where one
doesn't exist.

wallets.py also creates an index.html file inside each wallet folder dewcribing the status of this 
folder. This is linked from the index.html file created in /2018/ by the script which 
summarises everything for this year.

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
with the cave name and the right folder prefix for the svx folder 
(in the loser repo) and copy it in to all those wallet folders - overwriting 
the blank template produced by the wallets.py