mirror of
https://expo.survex.com/repositories/expoweb/.git/
synced 2024-11-22 07:11:55 +00:00
Generating more outline troggle documentation
This commit is contained in:
parent
cabf306a56
commit
d4964cb3fb
31
handbook/computing/regular.html
Normal file
31
handbook/computing/regular.html
Normal file
@ -0,0 +1,31 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>CUCC Expedition Handbook: Programmers manual</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../css/main2.css" />
|
||||
</head>
|
||||
<body>
|
||||
<h2 id="tophead">CUCC Expedition Handbook - Online systems</h2>
|
||||
<h1>Expo Data Maintenance - Regular tasks</h1>
|
||||
|
||||
<h2><a id="manual">Regular operations</a></h2>
|
||||
|
||||
|
||||
<p>This page <i>is a checklist</i> who are helping the survey data reduction process during and after expo.
|
||||
|
||||
|
||||
<h3>Wallets and Surveyscans</h3>
|
||||
|
||||
<h3>Tunnel files (Drawings)</h3>
|
||||
|
||||
<h3>Survex files</h3>
|
||||
|
||||
<hr />
|
||||
Annual tasks <a href="newyear.html">New expo year jobs</a>.
|
||||
Return to the main <a href="../manual.html">online systems manual</a>.
|
||||
|
||||
<hr />
|
||||
</body>
|
||||
</html>
|
||||
|
||||
BIN
handbook/i/troggle-tables-small.jpg
Normal file
BIN
handbook/i/troggle-tables-small.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 22 KiB |
|
Before Width: | Height: | Size: 163 KiB After Width: | Height: | Size: 163 KiB |
@ -1,6 +1,7 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>CUCC Expo Rigging Handbook: Typical rebelay</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../css/main2.css" />
|
||||
</head>
|
||||
@ -26,21 +27,5 @@ the rope without attaching an ascender to re-load it.</p>
|
||||
<p class="caption">Photo © Mark Dougherty, 199x</p>
|
||||
|
||||
<hr />
|
||||
<div id="menu">
|
||||
<ul id="links">
|
||||
<li><a href="../index.htm">Expedition Handbook</a>
|
||||
<ul>
|
||||
<li><a href="../rig/rigit.html">Rigging guide</a></li>
|
||||
<li><a href="../survey/index.htm">Surveying guide</a></li>
|
||||
<li><a href="../look4.htm">Prospecting guide</a></li>
|
||||
<li><a href="../rescue.htm">Rescue guide</a></li>
|
||||
<li><a href="../photo.htm">Photography guide</a></li>
|
||||
</ul></li>
|
||||
<li><a href="../../infodx.htm">Main index</a></li>
|
||||
|
||||
<li><a href="../../index.htm">Expo Home</a></li>
|
||||
<li><a href="../../../index.htm">CUCC Home</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@ -2,14 +2,41 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>Handbook Troggle XXX</title>
|
||||
<title>Other scripts supporting troggle</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../css/main2.css" />
|
||||
</head>
|
||||
<body>
|
||||
<h2 id="tophead">CUCC Expedition Handbook</h2>
|
||||
<h1>Handbook Troggle XXX</h1>
|
||||
<p>This is not the page you are looking for.
|
||||
<p>This will be replaced with the information you want as soon as someone gets around to writing it. Why not find out how to do this yourself ?
|
||||
<h1>Other scripts</h1>
|
||||
<p>Apart from these scripts, troggle in full deployment also needs a running mySQL database, a running apache webserver and cgit to display git repos.
|
||||
|
||||
<h3 id="inscripts">Scripts</a></h3>
|
||||
<ul>
|
||||
<li><a href="">wallets.py</a> generates statuspages and to-do list pages for survey data production.
|
||||
<li><a href="">make-folklist.py</a> turns the folk.csv file into a webpage.
|
||||
<li><a href="">updatephotos</a> generates navigable webpages from annual directories of photo images
|
||||
<li><a href="">make_essentials.sh</a> generates GPS tracks and routes for surface walking
|
||||
<li><a href="">make_svx.sh</a> generates surface Survex tracks
|
||||
<li><a href="">svxtrace.py</a> analyses Survex tracks to help find errors
|
||||
<li><a href="">create_dplong_table.py</a> Creates and updates the lengths and depths of all the caves
|
||||
<li><a href="">make-areaindices.py</a> (obsolete?)
|
||||
<li><a href="">make-prospectingguide-new.py</a> and a href="">prospecting_guide_short.py</a> - unmaintained
|
||||
<li><a href="">boe</a> Bank of Expo runs the accounts preceding and during expo
|
||||
<li><a href="">bierbook.tex</a> LaTeX script for generating the bierbook - a new list of names and dates each year
|
||||
<li><a href="">seshbook.tex</a> LaTeX script for generating the seshbook - works from the same list of names
|
||||
<li><a href="">therionpage.tex</a> LaTeX script anbd makefile for generating therion-style protractors
|
||||
</ul>
|
||||
|
||||
<p>There are also scripts running cron jobs on the server to fix file permissions and to periodically tidy repositories, and example rsync and scp scripts to help manage synchronisation of the expofiles directories which are not under version control.
|
||||
|
||||
<h4 id="wallets">Wallets</a></h4>
|
||||
<p><a href="../survey/onlinewallet.html">Online wallets</a> are maintained using the <a href="">wallets.py</a> script, but troggle also imports all the expofiles/surveyscans/ directroies of scanned survey notes.
|
||||
|
||||
<h4 id="folk">Folk</a></h4>
|
||||
<p><a href="../computing/folkupdate.html">Folk update</a> process produces a webpage listing all expo participants but it also runs some validation checks on the input file /folk/folk.csv . Troggle also imports folk.csv so that it knows who everyone is, but errors during the importing are not as easy to see as validation errors printed when running the <a href="">make-folklist.py</a> script.
|
||||
|
||||
<h4 id="photos">Photos</a></h4>
|
||||
<p><a href="">updatephotos</a> uses the BINS package to generate the webpages. 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).
|
||||
|
||||
<hr />
|
||||
Go on to: <a href="trogarch.html">Troggle architecture</a><br />
|
||||
|
||||
@ -2,17 +2,48 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>Handbook Troggle XXX</title>
|
||||
<title>Handbook Troggle Architecture</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../css/main2.css" />
|
||||
</head>
|
||||
<body>
|
||||
<h2 id="tophead">CUCC Expedition Handbook</h2>
|
||||
<h1>Handbook Troggle XXX</h1>
|
||||
<p>This is not the page you are looking for.
|
||||
<p>This will be replaced with the information you want as soon as someone gets around to writing it. Why not find out how to do this yourself ?
|
||||
<h1>Troggle Architecture</h1>
|
||||
|
||||
<h3>Troggle data architecture</h3>
|
||||
<p>
|
||||
The core of troggle is the data architecture: the set of tables into which all the cave survey and expo data is poured and stored. These tables are what enables us to produce a large number of different but consistent reports and views.
|
||||
|
||||
<figure>
|
||||
<a href="../i/troggle-tables.jpg">
|
||||
<img src="../i/troggle-tables-small.jpg" /></a>
|
||||
<figurecaption>
|
||||
</figure>
|
||||
|
||||
<h3>Architecture description</h3>
|
||||
<p>Read the proposal: "<a href="../../documents/troggle_paper.pdf" download>Troggle: a novel system for cave exploration information management</a>", by Aaron Curtis</em>. But remember that this paper is an over-ambitious proposal. Only the core datamanagement features have been built. We have none of the person management features and only two forms: for entering cave and cave entrance data.
|
||||
|
||||
<h3>Troggle parsers and input files</h3>
|
||||
[describe which files they read and which tables they write to. Also say what error messages are likely on import and what to do about them.]
|
||||
<ul>logbooks
|
||||
<li>surveyscans
|
||||
<li>survex files (caves)
|
||||
<li>folk (people)
|
||||
<li>QMs
|
||||
<li>subcaves
|
||||
<li>entrances
|
||||
<li>drawings (tunnel)
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
<h3>Files generated by troggle</h3>
|
||||
<p>There are only two places where this happens. This is where online forms are used to create cave entrance records and cave records. These are created in the database but also exported as files so that when troggle is rebuilt and data reimported the new cave data is there.
|
||||
|
||||
<h3>Helpful tools and scripts</h3>
|
||||
[ALSO talk about useful tools, such as those which interrogate MySQL or sqlite databases directly so that one can see the internals chnage as data is imported]
|
||||
|
||||
<hr />
|
||||
Go on to: <a href="trogarch.html">Troggle architecture</a><br />
|
||||
Go on to: <a href="trognotes.html">Troggle uncategorised notes to be edited</a><br />
|
||||
Return to: <a href="trogintro.html">Troggle intro</a><br />
|
||||
<hr />
|
||||
</body>
|
||||
|
||||
@ -2,17 +2,29 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>Handbook Troggle XXX</title>
|
||||
<title>Handbook Troggle Maintenance</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../css/main2.css" />
|
||||
</head>
|
||||
<body>
|
||||
<h2 id="tophead">CUCC Expedition Handbook</h2>
|
||||
<h1>Handbook Troggle XXX</h1>
|
||||
<p>This is not the page you are looking for.
|
||||
<p>This will be replaced with the information you want as soon as someone gets around to writing it. Why not find out how to do this yourself ?
|
||||
<h1>Troggle - Fixing things that break</h1>
|
||||
<p>The guide to the parser-model-view architecture is in the architecture document.
|
||||
<p><em>This page will describe the usual things that go wrong: the parsers that break when
|
||||
faced with user-generated data and how to fix them. Common error messages. How to set up troggle on a new machine. Copies of the older material where that is illuminating.</em>
|
||||
<p>It concentrates on showing how to find and fix import errors so that the troggle-generated webpages are complete and not full of gaps.
|
||||
<p>Intended audience: Ideally someone who is not a python programmer will be able to use this page to help them fix import errors.
|
||||
<p>Also here we will explain the useful diagnostic pages such as <br>
|
||||
<a href="expo.survex.com/experimental">experimental</a><br>
|
||||
<a href="expo.survex.com/pathsreport">pathsreport</a><br>
|
||||
<a href="expo.survex.com/survey_scans">survey_scans</a><br>
|
||||
<a href="expo.survex.com//admin/core/dataissue/l">/admin/core/dataissue/</a><br>
|
||||
<a href="expo.survex.com/tunneldata">tunneldata</a><br>
|
||||
<a href="expo.survex.com/statistics">statistics</a><br>
|
||||
<a href="expo.survex.com/people">people</a><br>
|
||||
|
||||
<hr />
|
||||
Go on to: <a href="trogarch.html">Troggle architecture</a><br />
|
||||
Go on to: <a href="trognotes.html">Troggle notes to be restructured</a><br />
|
||||
Return to: <a href="trogintro.html">Troggle intro</a><br />
|
||||
<hr />
|
||||
</body>
|
||||
|
||||
@ -12,12 +12,12 @@
|
||||
|
||||
<ul>
|
||||
<li>For day to day cave survey work on the expo laptop, see: the expo <a href="../survey/newcave.html">survey handbook</a>.
|
||||
<li>For survey data management on your laptop: set up <a href="basiclaptop.html">your own laptop</a>.
|
||||
<li>For survey data management on your laptop: set up <a href="../computing/basiclaptop.html">your own laptop</a>.
|
||||
<li>For the history of expo use of computers, see: <a href="../website-history.html">website and troggle history</a>.
|
||||
<li>For troggle maintenance, see: the <a href="../troggle/trogmanual.html">troggle maintainers manual</a>.
|
||||
</ul>
|
||||
|
||||
<h3 id="troggle">Troggle - what it does</a></h3>
|
||||
<h3 id="what">Troggle - what it does</a></h3>
|
||||
|
||||
|
||||
<p>Troggle manages all cave and expo data in a logical and maintainable way
|
||||
@ -35,6 +35,13 @@ The troggle software is written and maintained by expo members.
|
||||
<li><a href="/survey_scans/">expo.survex.com/survey_scans/</a> - List of all scanned original survey notes.
|
||||
<li><a href="/survey_scans/2018%252343/">expo.survex.com/survey_scans/2018%252343/</a> - list of links to scanned notes for wallet #43 during the 2018 expo.
|
||||
</ul>
|
||||
|
||||
<h3 id="where">Troggle - where it gets the data</a></h3>
|
||||
<p>
|
||||
All the data of all kinds is stored in files. When troggle starts up it imports that data from the files. There are other scripts doing useful things (folk, wallets) and these too get their data from files. Troggle is completely unlike any other django installation: it has a database, but the database is rebuilt from files.
|
||||
|
||||
<p>There is never any need to back up or archive the database as it is rebuilt from files. Rebuilding troggle and re-importing all the data takes about half an hour.
|
||||
|
||||
<hr />
|
||||
Go on to:
|
||||
<a href="trogstatus.html">troggle status</a><br />
|
||||
|
||||
@ -18,22 +18,25 @@
|
||||
<li><a href="../computing/regular.html">Regular tasks</a>: housekeeping as surveys are digitised.
|
||||
<li><a href="otherscripts.html">Other scripts</a> - photos, folk, wallets - not integral parts of troggle.
|
||||
<li><a href="trogarch.html">Troggle and database</a> architecture: how it all fits together
|
||||
<li><a href="trogdocm.html">Maintain troggle</a> itself. The code is public on repository <a href="http://expo.survex.com/repositories/">::troggle::</a>
|
||||
<li><a href="trogdesign.html">Design decisions</a>: e.g. new systems for <a href="menudesign.html">website menus</a>
|
||||
<li><a href="trogdocm.html">Maintain troggle</a> itself. The code is public on repository <a href="http://expo.survex.com/repositories/">::troggle::</a>
|
||||
<li><a href="trognotes.html">Uncategorised notes</a> and past speculations
|
||||
</ul>
|
||||
|
||||
<h3 id="troggle">Troggle - what it does</a></h3>
|
||||
<h3 id="troggle">Troggle - why we developed it</a></h3>
|
||||
<p>Troggle..
|
||||
<ol>
|
||||
<li>Coherently publishes expo data by cave, by expedition, by person, by trip or by survey - without requiring duplicate data entry.
|
||||
|
||||
<li>Manages and safely archives the typed and scanned survey data, entrance data, trip records (logbooks) and expo records.
|
||||
<li>Enforces consistency - making it easier to detect mistakes and omissions
|
||||
<li>Publishes the "guidebook descriptions" of caves by a combination of online forms and uploading files.
|
||||
<li>Supports the process of turning scribbled notes into finished cave surveys
|
||||
<li>Reformats all the visible webpages such that they have a coherent style and have a small menu at the top-left
|
||||
<li>Generates prospecting guides so that we don't waste time looking at holes which have already been explored
|
||||
<li>Reformats the webpages such that they have a coherent style and have a small menu at the top-left
|
||||
hand corner. These are the handbook you are reading now and the historic records of past expeditions.
|
||||
|
||||
<li>Providing a way of editing individual pages of the handbook
|
||||
<li>Provides a way of editing individual pages of the handbook
|
||||
for very quick and urgent changes.
|
||||
[This is the "Edit this page" capability; see <a href="../onlinesystems.html#editthispage"> for
|
||||
how to use it</a> and <em>how to tidy up afterwards</em>].
|
||||
|
||||
Loading…
Reference in New Issue
Block a user