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

documenting old scripts

Browse Source
This commit is contained in:
Philip Sargent 2020-04-23 01:13:10 +01:00
parent ac1affc097
commit 9370441561
4 changed files with 31 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
handbook/computing/regular.html
View File

@ -30,13 +30,17 @@ from phones are a bit variable in how they do EOL characters.
<h3>Tunnel files (Drawings)</h3>
<h3>QMs</h3>
<p>As the caves get written up, run <a href="scriptsqms.html">svx2qm.py</a> and <a href="scriptsqms.html">find-dead-qms.py</a> to check that the QMs have all be entered correctly into the svx files and that thecave descriptions have been updated with (a) the new open QMs and (b) the old closed QMs.
<h3>Survex files</h3>
Look at the <a href="svxvalid.html">valid SVX refs</a> page to check that new svx files properly reference the wallet folders, and create the wallet folder link back to the svx if the contents.json file in the wallet folder needs updating.
<h3>Folk</h3>
<p>During prep. for the new expo the folklist will be updated with all the new people expected, but after expo the mugshots and blurb text for the new people will need to be added. See <a href="folkupdate.html">folkupdate</a> for the procedure.
<hr />
Annual tasks <a href="newyear.html">New expo year jobs</a>.
Annual tasks <a href="newyear.html">New expo year jobs</a>.<br />
Return to the main <a href="manual.html">online systems manual</a>.
<hr />

24
handbook/troggle/otherscripts.html
View File

@ -21,14 +21,14 @@
<li><a href="../bankofexpo.html">boe</a> Bank of Expo (perl) runs the accounts preceding and during expo
<li><a href="scriptscurrent.html#latex">bierbook.tex</a> LaTeX script for generating the bierbook - a new list of names and dates each year
<li><a href="scriptscurrent.html#latex">seshbook.tex</a> LaTeX script for generating the seshbook - works from the same list of names
<li><a href="scriptscurrent.html#latex">therionpage.tex</a> LaTeX script anbd makefile for generating therion-style protractors</li><br />
<li><a href="scriptscurrent.html#latex">therionpage.tex</a> LaTeX script and makefile for generating therion-style protractors</li><br />
<li><a href="scriptscurrent.html#latex">wallets.py</a> generates statuspages and to-do list pages for survey data production.
<li><a href="scriptsqms.html#svx2qm">svx2qm.py</a> extracts QMs from the survex files
<li><a href="scriptsqms.html#tabqms">tablize-qms.pl</a> turns the list of QMs extracted into an HTML file
<li><a href="scriptsqms.html">svx2qm.py</a> extracts QMs from the survex files (and <a href="scriptsqms.html">find-dead-qms.py</a>)
<li><a href="scriptsqms.html">tablize-qms.pl</a> turns the list of QMs extracted into an HTML file
<li><a href="scriptscurrent.html#surface">make_svx.sh</a> generates surface Survex tracks
<li><a href="scriptscurrent.html#svxtrace">svxtrace.py</a> analyses Survex tracks to help find errors
<li><a href="scriptscurrent.html#survex">chk-refs.sh</a> analyses Survex files and wallets files to find reference errors</li><br />
<li><a href="scriptscurrent.html#loser1624">convert.py</a> Scripts working on Loser-1624 Uebersicht_2011.svx</li>
<li><a href="scriptscurrent.html#cavestats">cavestats</a> extracts overall lengths and depths from all the survex files
<li><a href="scriptscurrent.html#makefile">Makefile</a> coordinates running many of these scripts (needs maintenance)
</ul>
@ -37,17 +37,19 @@
<p>Apart from these scripts, troggle in full deployment also needs <br>- a running mySQL database, <br>- a running apache webserver and <br>- cgit to display git repos.
<h3 id="inscripts">Old and possibly obsolete scripts</a></h3>
<h3 id="inscripts">Old but maybe useful scripts</a></h3>
<ul>
<li><a href="scriptscurrent.html#glossary">make-glossary.pl</a> - used while documenting very complex caves (161 and 204).
We may need this again for Tunnocks/Balkon.
<li><a href="scriptsqms.html#find-dead-qms">find-dead-qms.py</a> - several QM scripts and intermediate files
<li><a href="scriptscurrent.html#alljs">make-alljs.py</a> - extracts legs and entrances
<li><a href="scriptscurrent.html#indxl4">make-indxal4.pl</a> - obsolete
<li><a href="scriptscurrent.html#logbk">logbk.pl</a> - obsolete
<li><a href="scriptscurrent.html#alljs">make-alljs.py</a> - extracts legs and entrances - still used?
<li><a href="scriptscurrent.html#indxl4">make-indxal4.pl</a> - is this obsolete?
</ul>
<p>There were perl and python scripts scattered through the :drawings: and :loser: (svx files) repos. Not all of the functions in these scripts have been recreated in more recent scripts or programmed into troggle.
The old scripts have been collected into /scripts or /noinfo in the :expoweb: repository.
<h3 id="obs">Obsolete scripts</a></h3>
<ul>
<li><a href="scriptscurrent.html#logbk">logbk.pl</a> - 2004 - obsolete. Replaced by troggle import parsers.</li>
</ul>
<p>There are perl and python scripts scattered through the :drawings: and :loser: (svx files) repos. Not all of the functions in these scripts have been recreated in more recent scripts or programmed into troggle.
<h3 id="newscript">When you write a script</a></h3>
<p>Any script that generates an HTML file should insert <em>&lt;meta name="keywords" content="NOEDIT"&gt;</em>
in the HTML header. Then when troggle renders the page it will not allow the user to edit the generated page. See <a href="../computing/hbmanual1.html">handbook editing</a> for a fuller explanation of troggle post-processing.

7
handbook/troggle/scriptscurrent.html
View File

@ -122,6 +122,13 @@ The design of these files is intended to confine all changes year to year to the
<p>This function is now done by the troggle input parsers.
<p><span style="color:red">[to be documented - for historic interest only]</span>
<h4 id="loser1624">Loser-1624 scripts</h4>
<p>
In /scripts/noinfo/scripts/loser-caves1624-raw-data/ there is convert.py and split.sh which operate on
Uebersicht_2011.svx doing coinversions on a dataset generated from dataset generated from CaveRenderer.
</p>
<hr />
Return to: <a href="otherscripts.html">Other scripts</a><br />

10
handbook/troggle/scriptsqms.html
View File

@ -79,9 +79,11 @@ find -name '*.svx' | xargs qms/svx2qm.py --format csv
</code></pre>
and --format human produces a simple text format.
<p>
<b>
FINISH - the 2019 copies are online HERE and HERE
</b>
The 2019 copies are online in /expofiles/:
<a href="/expofiles/writeups/2019/qms2019.txt">qms2019.txt</a> and
<a href="/expofiles/writeups/2019/qms2019.csv">qms2019.csv</a>.
<p>
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>
@ -90,7 +92,7 @@ This will work on all survex *.svx files even those which have not yet been run
<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> including structure for ticking them off.
<p>There is not yet a troggle report listing the QMs.
<h2>QMs - other oddments</h2>
<h2>QMs - monitoring progress</h2>
<h4 id="find-dead-qms">find-dead-qms.py</h4>
<p>This finds references to <em>completed</em> qms in the qm.csv files in the cave folders (/1623/ etc.) in the :expoweb: repository. It looks to see which QMs have been completed but where there is not yet a matching text in the cave description.