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

docm improvements

Browse Source
This commit is contained in:
Philip Sargent 2021-10-26 18:50:05 +03:00
parent 08a883306a
commit dde7d6f4ee
2 changed files with 32 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
handbook/troggle/scriptscurrent.html
View File

@ -43,6 +43,22 @@ p {
<p><a href="">updatephotos</a> (in the :loser: repo) uses the BINS package to generate photo albums. BINS uses the EXIF data (date, location if available) in the uploaded image files to produce a page showing the information available about the picture. All image meta-data are stored in XML files.
<p>BINS is no longer maintained by its author so expo has taken on the responsibility for keeping it running. (Wookey is in the process of packaging it as a proper debian package).
<h4 id="latex">seshbook, bierbook & protractors</h4>
<p>How these are used once produced is <a href="../bierbook.html">documented in the the handbook</a>
<p>These are LaTeX files and the instructions for how to process them are in each .tex file. The protractors do not change but the others need a configuration file for all the cavers expected to attend expo.
<p>The .tex files are in :expoweb:/documents/. There is a style file also there bierbook-style.sty which is used by both the bierbook and seshbook. Read the readme.txt file which explains which LaTeX packages you need. Build like this:
<p><pre><code>pdflatex.exe -synctex=1 -interaction=nonstopmode -shell-escape bierbook.tex
pdflatex.exe -synctex=1 -interaction=nonstopmode -shell-escape seshbook.tex
</code></pre>
Due to the way LaTeX works out table column witdths, these commands may need to be run several times until a stable output is produced.
The design of these files is intended to confine all changes year to year to the names.txt and dates.txt files, thanks to LaTeX's capability to read an external file and iterate through line by line performing the same action for each name.
<h4 id="gps">make_essentials.sh GPS</h4>
<p>In :expoweb:/noinfo/
<p>Makes essentials.gpx - see <a href="../essentials.html">GPS on expo</a>.
<h4>svx2qm.py, tablize-qms.pl, find-dead-qms.py,qmreader.pl</h4>
See the entire page devoted to the various
<a href="scriptsqms.html">QM scripts</a>.
@ -61,8 +77,6 @@ See the entire page devoted to the various
<p>(Therion files would too, if people inserted "#Ref" comments. In which case the script would need improving.)
<p>Currently the intermediate data it works from has to be hand-generated so a <span style="color:red">proper parsing script needs to be written</span>.
<h4 id="tabular">caves-tabular.html</h4>
<p> This webpage <a href="../../scripts/caves-tabular.html">caves-tabular.html</a> uses a page-specifc JavaScript file TableSort.js which allows the user to resort the table of all the cave data by any of the columns by clicking on it [by Radost]. The exact source of the data in the table is undocumented, but presumably from cavern .3d file export at an unknown date. This may be that generated by <a href="#summ">summarizecave.sh</a> .
@ -76,32 +90,8 @@ See the entire page devoted to the various
<h4 id="surface">make_svx.sh</h4>
<p><span style="color:red">[to be documented]</span>
<h4 id="prosp">make-prospectingguide-new.py and prospecting_guide_short.py</h4>
<p>In :expoweb:/noinfo/prospecting_guide_scripts/
<p>These are now obsolete, replaced by the troggle code (troggle/core/views/prospect.py) that generates
<a href="http://expo.survex.com/prospecting_guide">prospecting_guide</a> on the fly (taking a couple of minutes each time).
<h4 id="latex">seshbook, bierbook & protractors</h4>
<p>How these are used once produced is <a href="../bierbook.html">documented in the the handbook</a>
<p>These are LaTeX files and the instructions for how to process them are in each .tex file. The protractors do not change but the others need a configuration file for all the cavers expected to attend expo.
<p>The .tex files are in :expoweb:/documents/. There is a style file also there bierbook-style.sty which is used by both the bierbook and seshbook. Read the readme.txt file which explains which LaTeX packages you need. Build like this:
<p><pre><code>pdflatex.exe -synctex=1 -interaction=nonstopmode -shell-escape bierbook.tex
pdflatex.exe -synctex=1 -interaction=nonstopmode -shell-escape seshbook.tex
</code></pre>
Due to the way LaTeX works out table column witdths, these commands may need to be run several times until a stable output is produced.
The design of these files is intended to confine all changes year to year to the names.txt and dates.txt files, thanks to LaTeX's capability to read an external file and iterate through line by line performing the same action for each name.
<h4 id="summ">summarizecave.sh</h4>
<p>This runs "cavern" (a commandline tool installed as part of survex) to produce a text (or HTML)
report of the key statistics from the master svx file for a cave
(the one that includes all the svx files for the individual passages).
It is unclear who uses this or for what. It may be the script that generates the input data used by <a href="#tabular">caves-tabular.html</a>
<h4 id="gps">make_essentials.sh GPS</h4>
<p>In :expoweb:/noinfo/
<p>Makes essentials.gpx - see <a href="../essentials.html">GPS on expo</a>.
@ -123,6 +113,20 @@ Also in the :loser:fixedpts/scripts/convert_shx/ folder is a 135-line short scri
<h3 id="inscripts">Old and possibly obsolete scripts</a></h3>
<h4 id="summ">summarizecave.sh</h4>
<p>This runs "cavern" (a commandline tool installed as part of survex) to produce a text (or HTML)
report of the key statistics from the master svx file for a cave
(the one that includes all the svx files for the individual passages).
It is unclear who uses this or for what. It may be the script that generates the input data used by <a href="#tabular">caves-tabular.html</a>
<h4 id="tabular">caves-tabular.html</h4>
<p> This webpage <a href="../../scripts/caves-tabular.html">caves-tabular.html</a> uses a page-specifc JavaScript file TableSort.js which allows the user to resort the table of all the cave data by any of the columns by clicking on it [by Radost]. The exact source of the data in the table is undocumented, but presumably from cavern .3d file export at an unknown date. This may be that generated by <a href="#summ">summarizecave.sh</a> .
<h4 id="prosp">make-prospectingguide-new.py and prospecting_guide_short.py</h4>
<p>In :expoweb:/noinfo/prospecting_guide_scripts/
<p>These are now obsolete, replaced by the troggle code (troggle/core/views/prospect.py) that generates
<a href="http://expo.survex.com/prospecting_guide">prospecting_guide</a> on the fly (taking a couple of minutes each time).
<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

5
handbook/troggle/scriptsother.html
View File

@ -16,8 +16,6 @@
<li><a href="scriptscurrent.html#gps">make_essentials.sh</a> generates GPS tracks and routes for surface walking
<li><a href="scriptscurrent.html#photos">updatephotos</a> generates navigable webpages from annual directories of photo images
<li><a href="scriptscurrent.html#area">make-areaindices.py</a> (unmaintained?)
<li><a href="scriptscurrent.html#prosp">make-prospectingguide-new.py</a> and <a href="">prospecting_guide_short.py</a> <a href="../../noinfo/make-areaindices.py">make-areaindices.py</a> - (unmaintained?)</li><br />
<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
@ -35,13 +33,14 @@
<li><a href="scriptscurrent.html#summ">summarizecave.sh</a> gets .3d file contents using survex
<li><a href="scriptscurrent.html#tabular">caves-tabular.html</a> a re-sortable table of cave data
<li><a href="scriptscurrent.html#js">JavaScript</a> packages are used by some troggle pages. See <a href="serverconfig.html#js">the Expo server page</a>.
<li><a href="scriptscurrent.html#prosp">make-prospectingguide-new.py</a> and <a href="">prospecting_guide_short.py</a> - (obsolete)</li><br />
<li><a href="scriptscurrent.html#makefile">Makefile</a> coordinates running many of these scripts (needs maintenance)
</ul>
<p>There are also scripts running cron jobs on the server to fix file permissions and to periodically tidy <a href="../computing/repos.html">repositories</a>, and example rsync and scp scripts to help manage synchronisation of the expofiles directories which are not under version control.
<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.
<p>Apart from these scripts, troggle in full deployment <a href="serverconfig.html#js">on the server</a> also needs <br>- a running mySQL database, <br>- a running apache webserver and <br>- cgit to display git repos.
<h3 id="inscripts">Old but maybe useful scripts</a></h3>
<ul>