tick QM prototype docum

This commit is contained in:
Philip Sargent 2022-07-21 01:34:44 +03:00
parent 3fa5a8d28f
commit 5400851722

View File

@ -64,6 +64,17 @@ It has been retired because the mapping software packages it used were terminall
<p>QMs all use <a href="../survey/qm.html">the same QM description conventions</a>.
<h4>troggle/parsers/survex.py</a></h4>
<p>Troggle <em>troggle/parsers/survex.py</em> currently parses and stores all the QMs it finds in survex files. The tables where the data
is put are listed in <a href="datamodel.html">the current data model</a>. For ticking them off we have only protoype code: adding an extra line
in the survex file of the format
<code><pre>QMnn TICK date comment</pre></code>
e.g.
<code><pre>QM15 TICK 2022-07-20 This is a dummy ticked QM</pre></code>
as illustrated in
<a href="/cave/qms/1623-258/2015-15Aflashh2">2015-15A</a>
in <a href="/survexfile/caves-1623/258/flashhard2.svx">258/flashhard2.svx</a>.
<h4 id="qms.py">troggle/parsers/qms.py</a></h4>
<p>Troggle currently reports QMs separately collated for three historic caves and also imports all the QMs inside survex files.
Thus a recent cave such as 1623-264 (Balkh&ouml;hle) will only show QMs imported from the survex files:
@ -170,9 +181,6 @@ The 2019 copies are online in /expofiles/:
This will work on all survex *.svx files even those which have not yet been run through the troggle import process.
<p>Phil says (13 April 2020): <em>"The generated files are not meant to be served by the webserver, it's a tool for people to run locally. Someone could modify it to create HTML output (or post-process the CSV output to do the same), but that is work still to be done."</em>
<h4>troggle/parsers/survex.py</a></h4>
<p>Troggle <em>troggle/parsers/survex.py</em> currently parses and stores all the QMs it finds in survex files. The tables where the data
is put are listed in <a href="datamodel.html">the current data model</a> but there is no code (or even a design) for ticking them off.
<h4>troggle archeology</a></h4>