Documenting the weird and wonderful set of scripts we have

This commit is contained in:
2020-04-11 23:48:36 +01:00
parent 60ce9e0f93
commit 1a7a1a1b64
4 changed files with 177 additions and 30 deletions

View File

@@ -122,10 +122,18 @@ editing and keeps track of all changes so we can roll back and have branches if
<h3><a id="cavepages">Updating cave pages</a></h3>
<span style="color:red">
<p>Cave description pages are automatically generated from a set of
<p>Public cave description pages are automatically generated by troggle from a set of
cave files in noinfo/cave_data/ and noinfo/entrance_data/. These files
are named <area>-<cavenumber>.html (where area is 1623 or 1626). These
files are processed by troggle. Use <tt>python databaseReset.py
are named <area>-<cavenumber>.html (where area is 1623 or 1626).
<p>
Read the survey handbook section on <a href="../survey/caveentry.html">creating a new cave</a> in the system for instructions on how to name caves and the files you use to recoird them.
<p>Cave names do not have leading zeros
They are stored by number/ID in the dataset, not by name.
<p>Caves with a provisional number consisting of a year and a serial number
should be hyphenated, thus 2002-04 not 2002_04 or any of the various other
variants
<p>Use <tt>python databaseReset.py
caves</tt> in /expofiles/troggle/ to update the site/database after
editing these files.
Use <tt>python databaseReset.py

View File

@@ -126,7 +126,7 @@ If a heading is in italics, then there are hidden items.
</dl>
<h3>System Documentation</h3>
<dl>
<dl><!-- 2020-04-11 psargent -->
<dt><!--2020-04-11 psargent-->Document how we generate the SMK overall lengths and stats</dt>
<dd><!--2020-04-11 psargent-->scripts and manual actions in cavern
@@ -159,8 +159,8 @@ If a heading is in italics, then there are hidden items.
<dd><!--2020-04-03 psargent-->REPORT if import surveyscan file failure
<dd><!--2020-04-03 psargent-->Why are so many surveyscan foolder missing after import?
<dd><!--2020-04-03 psargent-->WHY are total lengths of surveyed cave different between expo server and WSL server for 2019 and a few other years only ?
<dt>NOEDIT flag
<dd>Descripe how this is implemented using &lt;meta name="keywords" content="NOEDIT"&gt;
<dt><!-- 2020-04-11 psargent -->NOEDIT flag
<dd><!-- 2020-04-11 psargent -->Describe how this is implemented using &lt;meta name="keywords" content="NOEDIT"&gt;
<dt>Logbook data model: unfilled fields?
<dd><!--2020-04-03 psargent-->'cave' of location field missing on nearly all logbook entroies. Missing from logbook templates. Where is this used and how can we fill it it in? Is it useful?