Moving online systems overview and computing manual pages

This commit is contained in:
Philip Sargent 2020-04-09 19:13:18 +01:00
parent 940412b6a0
commit beeca2cc25
14 changed files with 27 additions and 249 deletions

View File

@ -89,7 +89,7 @@
<p>The large mass of cave descriptions have been taken from guidebook descriptions or exploration reports by the above authors, or translated from publications of groups listed under <a href="../others/index.htm">Other Groups</a>. We'd like to thank the librarian of the F&eacute;d&eacute;ration Belgique de Sp&eacute;l&eacute;ologie for supplying photocopies of articles, and Jill Gates (ULSA and NPC) for help with translation.</p> <p>The large mass of cave descriptions have been taken from guidebook descriptions or exploration reports by the above authors, or translated from publications of groups listed under <a href="../others/index.htm">Other Groups</a>. We'd like to thank the librarian of the F&eacute;d&eacute;ration Belgique de Sp&eacute;l&eacute;ologie for supplying photocopies of articles, and Jill Gates (ULSA and NPC) for help with translation.</p>
<p>Certain parts of the <a href="../handbook/index.htm">Expedition Handbook</a> are derived from earlier documents used by other clubs, most especially the <a href="http://www.oucc.org.uk/">Oxford University Caving Club</a>. This particularly includes the <a href="../handbook/rescue.htm">Rescue guide</a>, which owes much to Gavin Lowe. <!--If you are browsing locally, you may also find a mirror of the well-illustrated <a href="../handbook/3rdparty/sherry/srtrig.htm" _mce_href="../handbook/3rdparty/sherry/srtrig.htm">SRT rigging guide</a> produced by Sherry Mayo with contributions from Mark Bown. If that link doesn't work, (which it won't if you are browsing over the "real" internet), then the original is <a href="http://www.cavepage.magna.com.au/cave/SRTrig.html" _mce_href="http://www.cavepage.magna.com.au/cave/SRTrig.html">here</a>.--> <!-- For some reason the server hosting that site is case-sensitive for file names. Yes, I know this is ludicrous. --></p> <p>Certain parts of the <a href="../handbook/index.htm">Expedition Handbook</a> are derived from earlier documents used by other clubs, most especially the <a href="http://www.oucc.org.uk/">Oxford University Caving Club</a>. This particularly includes the <a href="../handbook/rescue.htm">Rescue guide</a>, which owes much to Gavin Lowe. <!--If you are browsing locally, you may also find a mirror of the well-illustrated <a href="../handbook/3rdparty/sherry/srtrig.htm" _mce_href="../handbook/3rdparty/sherry/srtrig.htm">SRT rigging guide</a> produced by Sherry Mayo with contributions from Mark Bown. If that link doesn't work, (which it won't if you are browsing over the "real" internet), then the original is <a href="http://www.cavepage.magna.com.au/cave/SRTrig.html" _mce_href="http://www.cavepage.magna.com.au/cave/SRTrig.html">here</a>.--> <!-- For some reason the server hosting that site is case-sensitive for file names. Yes, I know this is ludicrous. --></p>
<p>The editors would like to thank the discoverers of Kaninchenh&ouml;hle for finding a cave so complex that hypertext seemed the only way to build a usable guidebook description. Without the start that this gave, the website might never have come about. Andy Waddington started the major rewrite of the description in an effort to understand the cave without having to make the sacrifice of going underground. The endless questions that this provoked stimulated Wookey and others to join the work. HTML provides the means to keep linking in new bits of material interminably and Wookey provided the stimulus to make it more cohesive by finding the space on a real web site. We'd also like to thank everyone who has browsed these pages and made constructive comments or reported bugs.</p> <p>The editors would like to thank the discoverers of Kaninchenh&ouml;hle for finding a cave so complex that hypertext seemed the only way to build a usable guidebook description. Without the start that this gave, the website might never have come about. Andy Waddington started the major rewrite of the description in an effort to understand the cave without having to make the sacrifice of going underground. The endless questions that this provoked stimulated Wookey and others to join the work. HTML provides the means to keep linking in new bits of material interminably and Wookey provided the stimulus to make it more cohesive by finding the space on a real web site. We'd also like to thank everyone who has browsed these pages and made constructive comments or reported bugs.</p>
<p><a name="maintainers"></a>Finally, both exploration and documentation continue. The editors welcome your <!-- a href="../../fdback.htm" -->feedback on the existing site or contributions of writing or photographs of the area. In recent years maintenance of the website has been to some extent devolved, so that members of the expedition have responsibility for documenting their own finds; see the <a href="../handbook/onlinesystems.html">online systems manual</a>. Nonetheless all the kudos for creating the edifice should go to the two original editors, both of whom are still working on the site:</p> <p><a name="maintainers"></a>Finally, both exploration and documentation continue. The editors welcome your <!-- a href="../../fdback.htm" -->feedback on the existing site or contributions of writing or photographs of the area. In recent years maintenance of the website has been to some extent devolved, so that members of the expedition have responsibility for documenting their own finds; see the <a href="../handbook/computing/onlinesystems.html">online systems manual</a>. Nonetheless all the kudos for creating the edifice should go to the two original editors, both of whom are still working on the site:</p>
<p>Andy Waddington<br /> mail: &lt;expo (at) pennine.ddns.me.uk&gt;<br /> Andy's own <a href="http://blogs.waddingtons.info/andrew/">blog pages</a></p> <p>Andy Waddington<br /> mail: &lt;expo (at) pennine.ddns.me.uk&gt;<br /> Andy's own <a href="http://blogs.waddingtons.info/andrew/">blog pages</a></p>
<p>Wookey<br /> mail: &lt;Wookey (at) wookware.org&gt;<br /> Wookey's own <a href="http://wookware.org/">homepage</a></p> <p>Wookey<br /> mail: &lt;Wookey (at) wookware.org&gt;<br /> Wookey's own <a href="http://wookware.org/">homepage</a></p>
<hr /> <hr />

View File

@ -52,7 +52,7 @@ are advised to use the <em>Expo laptop</em> first to see how it all works.</p>
<p>Either the <em>Expo laptop</em> or your own laptop will use the version control system to <p>Either the <em>Expo laptop</em> or your own laptop will use the version control system to
synchronise cave data. It's easier to use the <em>Expo laptop</em> as the software is already set up. synchronise cave data. It's easier to use the <em>Expo laptop</em> as the software is already set up.
But if you set up your own computer then you will get a more familiar environment. See But if you set up your own computer then you will get a more familiar environment. See
the <a href="onlinesystems.html">Expo Online Systems Manual</a> for info on how to do that.</p> the <a href="computing/onlinesystems.html">Expo Online Systems Manual</a> for info on how to do that.</p>
<P>Through the miracle of the distributed version control system, everyone can edit the <P>Through the miracle of the distributed version control system, everyone can edit the
data on multiple laptops at the same time and it should all get merged.</p> data on multiple laptops at the same time and it should all get merged.</p>

View File

@ -16,7 +16,7 @@
<ol> <ol>
<li>Register an SSH key</a> with an expo nerd i.e 'get a login'. (see "Key Configuration" below)</li> <li>Register an SSH key</a> with an expo nerd i.e 'get a login'. (see "Key Configuration" below)</li>
<li>Install <a href="#software">git version control software</a> to download ("clone"), view and edit caving data.</li> <li>Install <a href="#software">git version control software</a> to download ("clone"), view and edit caving data.</li>
<li>Clone three <a href="../manual.html#repositories">expo repositories</a> so you have the files on your machine.</li> <li>Clone three <a href="manual.html#repositories">expo repositories</a> so you have the files on your machine.</li>
<li>Install survex, and therion or tunnel for editing cave data. <li>Install survex, and therion or tunnel for editing cave data.
</ol> </ol>
@ -27,7 +27,7 @@ And please <b>write some documentation for the next person</b> in your situation
<h3>Cheat lists and quick reminders</h3> <h3>Cheat lists and quick reminders</h3>
<ul> <ul>
<li>Quick <a href="qstart-git.html">reminders for using git</a> at the command line. <li>Quick <a href="qstart-git.html">reminders for using git</a> at the command line.
<li>Quick <a href="../manual.html#quickstart">reminders for using rsync</a> at the command line. <li>Quick <a href="manual.html#quickstart">reminders for using rsync</a> at the command line.
</ul> </ul>
<h2 id="software">Software</h2> <h2 id="software">Software</h2>
@ -55,7 +55,7 @@ Note that you are loading your <em>private</em> key, the .ppk file, into pageant
<li><a href="winlaptop.html#hard">A Windows laptop for expo</a> - PuTTy and WSL here.</li> <li><a href="winlaptop.html#hard">A Windows laptop for expo</a> - PuTTy and WSL here.</li>
</ul> </ul>
<p>When using Windows please, please be <a href="http://expo.survex.com/handbook/survey/getin.htm#filenames">excessively <p>When using Windows please, please be <a href="http://expo.survex.com/handbook/survey/getin.htm#filenames">excessively
careful when naming files and survex names</a> and be <a href="../manual.html#quickstart">exceptionally careful when using rsync</a>. careful when naming files and survex names</a> and be <a href="manual.html#quickstart">exceptionally careful when using rsync</a>.
<h3>Learning how to use this software</h3> <h3>Learning how to use this software</h3>

View File

@ -20,7 +20,7 @@
<li>ssh - occasionally, by experts,to fix things when something goes wrong or for major site reconfiguration. <li>ssh - occasionally, by experts,to fix things when something goes wrong or for major site reconfiguration.
</ul> </ul>
Now readthe <a href="../manual.html#manual">Expo data management systems manual</a>. Now readthe <a href="manual.html#manual">Expo data management systems manual</a>.
<hr /> <hr />

View File

@ -41,7 +41,7 @@
<p>Edit folk/folk.csv according to the instructions in the <a href="folkupdate.html">Folk Update process</a> <p>Edit folk/folk.csv according to the instructions in the <a href="folkupdate.html">Folk Update process</a>
</p> </p>
Return to the main <a href="../manual.html">online systems manual</a>. Return to the main <a href="manual.html">online systems manual</a>.
<hr /> <hr />
</body> </body>

View File

@ -3,7 +3,7 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>CUCC Expedition Handbook: Online system overview</title> <title>CUCC Expedition Handbook: Online system overview</title>
<link rel="stylesheet" type="text/css" href="../css/main2.css" /> <link rel="stylesheet" type="text/css" href="../../css/main2.css" />
</head> </head>
<body> <body>
<h2 id="tophead">CUCC Expedition Handbook - Online systems</h2> <h2 id="tophead">CUCC Expedition Handbook - Online systems</h2>
@ -21,30 +21,30 @@ handbook and public website are constructed and managed.
It contains material which will be merged into this online systems manual. It contains material which will be merged into this online systems manual.
<p>These pages listed below have been reviewed recently (2019), and a <p>These pages listed below have been reviewed recently (2019), and a
fuller list of "How do I..." instruction pages are on <a href="index.htm">the handbook opening page</a>. fuller list of "How do I..." instruction pages are on <a href="../index.htm">the handbook opening page</a>.
<ul> <ul>
<li><a href="uploading.html">Uploading your photos</a></li> <li><a href="../uploading.html">Uploading your photos</a></li>
<li><a href="logbooks.html">Uploading typed logbooks</a></li> <li><a href="../logbooks.html">Uploading typed logbooks</a></li>
<li><a href="gpxupload.html">Uploading GPS tracks</a></li> <li><a href="../gpxupload.html">Uploading GPS tracks</a></li>
<li><a href="survey/newcave.html">Recording a new cave discovery</a></li> <li><a href="../survey/newcave.html">Recording a new cave discovery</a></li>
<li><a href="survey/status.html">Monitoring the status of the cave survey workflow during and after expo</a></li> <li><a href="../survey/status.html">Monitoring the status of the cave survey workflow during and after expo</a></li>
</ul> </ul>
<p>The systems manual is being actively edited to extract and simplify documentation. <p>The systems manual is being actively edited to extract and simplify documentation.
<ul> <ul>
<li><a href="computing/newyear.html">Manual: Creating a new 'year' in the system</a></li> <li><a href="newyear.html">Manual: Creating a new 'year' in the system</a></li>
<li><a href="manual.html">Manual: Expo survey data maintenance manual</a></li> <li><a href="manual.html">Manual: Expo survey data maintenance manual</a></li>
<li><a href="manual.html#update">Manual: Updating the cave guidebook descriptions</a></li> <li><a href="manual.html#update">Manual: Updating the cave guidebook descriptions</a></li>
</ul> </ul>
<h2><a id="update">Updating the online systems - overview</a></h2> <h2><a id="update">Updating the online systems - overview</a></h2>
<h3 id="troggle">Troggle - what it is</a></h3> <h3 id="troggle">Troggle - what it is</a></h3>
<p>Troggle runs the expo cave survey data management, presents the data on the website and manages the Expo Handbook. See the <a href="troggle/trogintro.html">troggle intro</a>. <p>Troggle runs the expo cave survey data management, presents the data on the website and manages the Expo Handbook. See the <a href="../troggle/trogintro.html">troggle intro</a>.
<h3>Autogenerated pages</h3> <h3>Autogenerated pages</h3>
<p>Some key sections of the online webpages are autogenerated by scripts or by <p>Some key sections of the online webpages are autogenerated by scripts or by
<a href="#troggle">troggle</a>, and are not static files, <a href="../#troggle">troggle</a>, and are not static files,
so you have to edit the base data, not the generated file (e.g cave so you have to edit the base data, not the generated file (e.g cave
pages, QM (question mark) lists, expo members list, prospecting pages). All pages, QM (question mark) lists, expo members list, prospecting pages). All
autogenerated files say 'This file is autogenerated - do not edit' at autogenerated files say 'This file is autogenerated - do not edit' at
@ -55,7 +55,7 @@ just be overwritten</p>
<p>The primary and recommended way of editing this handbook (and the website generally) is to use <p>The primary and recommended way of editing this handbook (and the website generally) is to use
a laptop which has the version control software installed. The a laptop which has the version control software installed. The
person editing needs to know how to use this software, and also needs to know how to edit raw HTML files person editing needs to know how to use this software, and also needs to know how to edit raw HTML files
using a text editor. The public <a href="exposerver.html">expo server</a> is on a machine far, far away that we only access remotely. using a text editor. The public <a href="../exposerver.html">expo server</a> is on a machine far, far away that we only access remotely.
<p>The <em>Expo laptop</em> has the software installed, so it is best to learn how to do this <p>The <em>Expo laptop</em> has the software installed, so it is best to learn how to do this
when sitting at that laptop. when sitting at that laptop.

View File

@ -29,7 +29,7 @@ find . -not -type d -exec file "{}" ";" | grep CRLF >crlf.txt
<hr /> <hr />
Annual tasks <a href="newyear.html">New expo year jobs</a>. Annual tasks <a href="newyear.html">New expo year jobs</a>.
Return to the main <a href="../manual.html">online systems manual</a>. Return to the main <a href="manual.html">online systems manual</a>.
<hr /> <hr />
</body> </body>

View File

@ -135,7 +135,7 @@ to <a href="https://blog.shvetsov.com/2010/03/making-pageant-automatically-load-
<li><a href="https://tortoisehg.readthedocs.io/en/latest/quick.html">Quick Start guide to TortoiseHg</a>. <li><a href="https://tortoisehg.readthedocs.io/en/latest/quick.html">Quick Start guide to TortoiseHg</a>.
</ul> </ul>
<p>When using Windows please, please be <a href="http://expo.survex.com/handbook/survey/getin.htm#filenames">excessively careful when naming files and survex names</a> and be <a href="../manual.html#quickstart">exceptionally careful when using rsync</a>. <p>When using Windows please, please be <a href="http://expo.survex.com/handbook/survey/getin.htm#filenames">excessively careful when naming files and survex names</a> and be <a href="manual.html#quickstart">exceptionally careful when using rsync</a>.
<p>The handbook has documents where it is necessary to use scp or sftp to manage large files in 'expofiles'. <p>The handbook has documents where it is necessary to use scp or sftp to manage large files in 'expofiles'.
See <a href="../upload-expert.html">Experts: Uploading files</a>, See <a href="../upload-expert.html">Experts: Uploading files</a>,

View File

@ -1,222 +0,0 @@
<!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 Manual</h1>
<h2><a id="manual">Expo data management programmers' manual</a></h2>
<ul>
<li>This page is for cavers wanting to edit any expo data on their own machine. So that's the website, survey data, or drawn up surveys</li>
<li>This page is <i>not</i> for cavers wanting to know how to type in logbooks or upload photographs or edit data on the expo laptop.
<li>There is another page with more info on <a href="#yourownlaptop">the software expo uses and setting up your own laptop</a>.
</ul>
<p>Editing the expo data management system is an adventure. Learning
it by trial and error is non-trivial. There are lots of things we
could improve about the system, and anyone with some computer nous is
very welcome to muck in. It is slowly getting better organised.</p>
<p>This manual is organized in a how-to sort of style. The categories,
rather than referring to specific elements of the data management system, refer to
processes that a maintainer would want to do.</p>
<p>Note that to display the survey data you will need a copy of the <a href="getsurvex.html">survex</a> software.
<p>Follow these links if you have reached this page by accident and this is what you want to know:
<ul>
<li><a href="uploading.html">How to upload photos</a></li>
<li><a href="logbooks.html">Typing in logbook entries</a></li>
<li><a href="gpxupload.html">Recording the GPS location of a cave</a></li>
<li><a href="survey/index.htm">How to do cave surveying</a></li>
<li><a href="index.htm">List of "How to" pages for everything else</a></li>
</ul>
<h3>Contents of this manual</h3>
<ol>
<li><a href="#usernamepassword">Getting a username, password and key</a></li>
<li><a href="#repositories">The repositories</a></li>
<li><a href="#howitworks">How the data management system works</a></li>
<li><a href="#yourownlaptop">Your own laptop</a></li>
<li><a href="#quickstart">Quick start</a></li>
<li><a href="#editingthedata management system">Modifying the data management system</a></li>
<li><a href="#expowebupdate">The expoweb-update script</a></li>
<li><a href="#cavepages">Updating cave pages</a></li>
<li><a href="#updatingyears">Updating expo year pages</a></li>
<li><a href="#surveystatus">Maintaining the survey status table</a></li>
<li><a href="#menu">Cave pages and handbook menu system</a></li>
</ol>
Appendices:
<ul>
<li><a href="website-history.html">Website history</a> - a history of the data management system up to 2019</li>
<li><a href="c21bs.html">Taking Expo Bullshit into the 21st Century</a> - initial report from 1996</li>
</ul>
<h3><a id="usernamepassword">Getting a username, password and key</a></h3>
<p>You don't need a password to view most things, but you will need one to change them.</p>
<p>Use these credentials for access to the troggle site. The user is 'expo',
with a cavey:beery password. Ask someone if this isn't enough clue for you.
<b>This password is important for security</b>. The whole site <strong>will</strong> get hacked by spammers or worse if you are not careful with it. Use a secure method for passing it on to others that need to know (i.e not unencrypted email), don't publish it anywhere, don't check it in to the data management system by accident. A lot of people use it and changing it is a pain for everyone so do take a bit of care.
</p>
<p>This password is all you need to log in to troggle and to use the troggle control panel (very few people need to do this). But if you want to update webpages (a much more common requirement) or to edit the software itself (very rare), then
you will also need to get a login (register a key with the server). See <a href="computing/keyexchange.html">key-pair setup</a> for details.
<p>Pushing cave data to the ::loser:: and ::drawings:: repositories also needs a key. So cavers entering their cave survey data have to use a machine on which this already set up. These machines are
the <i>expo laptop</i> and the laptop '<i>aziraphale</i>' which live in the potato hut during expo. If you want to use your own laptop then
see <a href="#yourownlaptop">below</a>.
<h3><a id="repositories">The repositories</a></h3>
<p>All the expo data is contained in 4 "repositories" at
expo.survex.com. This is currently hosted on a free virtual server we have blagged on a server farm.
We use a distributed version control system (DVCS) to manage these repositories because this allows simultaneous collaborative
editing and keeps track of all changes so we can roll back and have branches if needed.</p>
<p>The site has been split into four parts:</p>
<ul>
<li><a href="/repositories/home/expo/loser/graph/">loser</a> - the survex cave survey data (hg)</li>
<li><a href="/cgit/drawings/.git/log">drawings</a> - the tunnel and therion cave data and drawings (git)</li>
<li><a href="/repositories/home/expo/expoweb/graph">expoweb</a> - the website pages, handbook, generation scripts (hg)</li>
<li><a href="/cgit/troggle/.git/log">troggle</a> - the database/software part of the survey data management system - see <a href="troggle/trogintro.html">notes on troggle</a> for further explanation (git)</li>
</ul>
<p>We have migrated two of these to git but the other two still use mercurial.
<h4>Mercurial Website Hack 2019</h4>
<p> Currently (December 2019) after commiting and pushing your changes to expoweb to the mercurial server, you will need to
login to expo.survex.com using ssh, cd to /expoweb/ and issue a "<a href="https://www.selenic.com/mercurial/hg.1.html">hg update</a>" command to make your changes noticed by the webserver. This problem will go away before Expo 2020 - we hope - when we finish migrating from mercurial to git.
<p>All the scans, photos, presentations, fat documents and videos are
stored just as files (not in version control) in 'expofiles'. See
below for details on that.</p>
<h3><a id="howitworks">How the data management system works</a></h3>
<p>Troggle runs the expo cave survey data management, presents the data on the website and manages the Expo Handbook. See the <a href="troggle/trogintro.html">troggle intro</a>.
<p>Anything you check in which affects cave data or descriptions won't appear on the site until
the data management system update scripts are run.
This <em>should</em> happen automatically every 30 mins (not since 2017), but you can also kick off a manual update.
See 'The expoweb-update script' below for details.</p>
<p>Also note that the ::expoweb:: web pages and cave data reports you see on the visible website
are not the same as the version-controlled "master" expoweb repo.
So in order that your committed and pushed changes become visible on the website,
they have to be 'pulled' from the repo (on teh server machine) onto the webserver (another place on the same server machine) before your changes are reflected.</p>
<h3><a id="yourownlaptop">Your own laptop</a></h3>
<p>Setting your own laptop so that it can do everything the <i>expo laptop</i> can do is quite a
complicated process. At a minimum you will be an experienced software nerd already and will have git, mercurial and a text editor installed and you will know how to use them.
You will have done the
<a href="computing/keyexchange.html">key-pair setup</a> process - which you can only do entirely on your own if
you have access to the <i>expo laptop</i>.
<p>See <a href="computing/basiclaptop.html">setting up a minimal laptop</a> for a short list of software. This assumes you know how to use it all.
<br />See <a href="computing/yourlaptop.html">setting up your own laptop</a> for the full list of software we use and where to get it.
<p>Note that the instructions are primarily for people using Linux with some help for those using Windows. If you are a Mac user then you are on your own.
<h3><a id="editthispage">Using 'Edit This Page'</a></h3>
<p>This can be used to edit web pages without installing any software or doing any key-pair setup. It even works if your laptop is a Mac.
<p>This is the capability that you can see in the top-left-hand menu on any website page if you <a href="/accounts/login/">log in to troggle</a> using the <a href="#usernamepassword">cavey:beery password</a>.
<p>'Edit This Page' is a troggle capability edits the file served by the webserver but it does not update the copy of the file in the
repository (the invese of the problem described above as 'Mercurial Website Hack'). To properly finish the job you need to
<ul>
<li>
ssh into expo@expo.survex.com (use putty on a Windows machine)
<li>cd to the directory containing the repo you want, i.e. "cd loser" for
cave data or "cd expoweb" for the handbook and visible data management system, which takes you to /home/expo/expoweb
<li>Then run "<a href="https://www.selenic.com/mercurial/hg.1.html">hg status</a>" (to check what
changes are pending),
<li>then "hg diff" to see the changes in detail
(or "hg diff|less" if you know how to use "less" or "more") and
<li>then DO NOT just run '<a href="https://www.selenic.com/mercurial/hg.1.html">hg commit</a>' unless you know how emacs works as it will dump
you into an emacs editing window (C-x C-C is the way to exit emacs). Instead, do
'hg commit -m "found files left over - myName" '
which submits the obligatory comment witht he commit operation.
</ul>
<p>Again, we hope that this issue will go away when we migrate the expoweb repo from mercurial to git before the 2020 Expo.
<h3><a id="../manual/#editingthedata management system">Editing the data management system</a></h3>
<p>To edit the data management system fully, you need to use the version control system
software which is currently git and mercurial.
Some (static text) pages can be edited directly on-line using the 'edit this page link' which you'll
see if you are logged into troggle. In general the dynamically-generated pages, such as those describing
caves which are generated from the cave survey data, can not be edited in this way, but forms are provided
for some types of these like 'caves'.</p>
<h3>Cheat lists and quick reminders</h3>
<p>If you know what you are doing here is the basic info on what's where:<br />
(if you don't know what you're doing, skip to <a href="#editingthedata management system">Editing the data management system</a> below.)
<ul>
<li>Quick <a href="computing/qstart-git.html">reminders for using git</a> at the command line.
<li>Quick <a href="computing/qstart-hg.html">reminders for using mercurial</a> at the command line. (to be removed)
<li>Quick <a href="../manual.html#quickstart">reminders for using rsync</a> at the command line.
</ul>
<p>Simple changes to static HTML files will take effect immediately (or as soon as the hg update hack is done, but this will disappear when we move entirely to git),
but changes to dynamically-generated files - cave descriptions, QM lists etc. -
will not take effect, until a nerd runs the expoweb-update script on the server.</p>
<h3><a id="expowebupdate">The expoweb & drawings import scripts</a></h3>
<p>The import scripts for the cave data are currently (Feb.2020) run manually by a nerd. So if you enter cave data,logbooks or survey scans you won't see the result
until a nerd has been placated.</p>
<h3><a id="cavepages">Updating cave pages</a></h3>
<p>Cave description pages are automatically generated 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
caves</tt> in /expofiles/troggle/ to update the site/database after
editing these files.
Use <tt>python databaseReset.py
</tt> on its own to get a list of command options and brief explanations.</p>
<p>Clicking on 'New cave' (at the bottom of the cave index) lets you enter a new cave. <a href="computing/caveentry.html">Info on how to enter new caves has been split into its own page</a>.</p>
<p>(If you remember something about CAVETAB2.CSV for editing caves, that was
superseded in 2012).</p>
<p>This may be a useful reminder of what is in a survex file <a href="survey/how_to_make_a_survex_file.pdf">how to create a survex file</a>.
<h3><a id="updatingyears">Updating expo year pages</a></h3>
<p>Each year's expo is recorded in the folder</p>
<tt>/expoweb/years/</tt>
<p>which contains a number of files used to manage and record that year's expo. Have a look at
expoweb/years/2018/ for a recent well-documented expo (the weather was good).
Files are added and edited using the version control system for the expoweb repository.</p>
<p>To create a new 'year' for next year's expo see <a href="computing/newyear.html">adding a new year</a>.
<h3><a id="surveystatus">Maintaining the survey status table</a></h3>
<p>See the <a href="survey/onlinewallet.html">documentation</a> on updating the online surveyscans folders using the lever-arch file of plastic wallets.
<h3><a id="menu">Cave pages and handbook menu design</a></h3>
<p>See the <a href="computing/menudesign.html">menu design history and proposals</a>
page on where we are and what we might do to improveand fix menus.
<hr />
</body>
</html>

View File

@ -46,7 +46,7 @@ All the data of all kinds is stored in files. When troggle starts up it imports
Go on to: Go on to:
<a href="trogstatus.html">troggle status</a><br /> <a href="trogstatus.html">troggle status</a><br />
Return to: Return to:
<a href="../onlinesystems.html">expo online systems overview</a><br /> <a href="../computing/onlinesystems.html">expo online systems overview</a><br />
<hr /> <hr />
</body> </body>
</html> </html>

View File

@ -38,7 +38,7 @@ hand corner. These are the handbook you are reading now and the historic records
<li>Provides 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. for very quick and urgent changes.
[This is the "Edit this page" capability; see <a href="../onlinesystems.html#editthispage"> for [This is the "Edit this page" capability; see <a href="../computing/onlinesystems.html#editthispage"> for
how to use it</a> and <em>how to tidy up afterwards</em>]. how to use it</a> and <em>how to tidy up afterwards</em>].
</ol> </ol>
<hr /> <hr />

View File

@ -32,7 +32,7 @@ can do this by filling-in some online forms. (And managing all the cave suvey da
<li>Providing a secondary way of editing individual pages of the handbook and historic records pages <li>Providing a secondary way of editing individual pages of the handbook and historic records pages
for very quick and urgent changes. for very quick and urgent changes.
This is the "Edit this page" capability; see <a href="../onlinesystems.html#editthispage"> for This is the "Edit this page" capability; see <a href="../computing/onlinesystems.html#editthispage"> for
how to use it</a> and <em>how to tidy up afterwards</em>. how to use it</a> and <em>how to tidy up afterwards</em>.
</ol> </ol>

View File

@ -63,7 +63,7 @@ more straightforward.
<h3>Version control</h3> <h3>Version control</h3>
<p>Another important element of this system was version control. The entire data structure was <p>Another important element of this system was version control. The entire data structure was
stored initially in a <a href="https://en.wikipedia.org/wiki/Concurrent_Versions_System">Concurrent Version System</a> repository, and later migrated to stored initially in a <a href="https://en.wikipedia.org/wiki/Concurrent_Versions_System">Concurrent Version System</a> repository, and later migrated to
<a href="https://en.wikipedia.org/wiki/Apache_Subversion">Subversion</a> [<em>now using a <a href="onlinesystems.html#mercurial">DVCS</a> in 2019</em>]. <a href="https://en.wikipedia.org/wiki/Apache_Subversion">Subversion</a> [<em>now using a <a href="computing/onlinesystems.html#mercurial">DVCS</a> in 2019</em>].
Any edits to the spreadsheets which caused the scripts to fail, breaking the Any edits to the spreadsheets which caused the scripts to fail, breaking the
website, could be easily reversed. website, could be easily reversed.
@ -118,7 +118,7 @@ This reads in all the logbooks and surveys and provides a nice way to access the
It was separate for a while until Martin Green added code to merge the old static pages and It was separate for a while until Martin Green added code to merge the old static pages and
new troggle dynamic pages into the same site. This is now the live system running everything (in 2019). Work on developing Troggle further still continues (see <a href="troggle/trogintro.html">Troggle intro</a>).</p> new troggle dynamic pages into the same site. This is now the live system running everything (in 2019). Work on developing Troggle further still continues (see <a href="troggle/trogintro.html">Troggle intro</a>).</p>
<p>After Expo 2009 the version control system was updated to a <a href="onlinesystems.html#mercurial">DVCS</a> (Mercurial, aka 'hg'), <p>After Expo 2009 the version control system was updated to a <a href="computing/onlinesystems.html#mercurial">DVCS</a> (Mercurial, aka 'hg'),
because a distributed version control system makes a great deal of sense for expo because a distributed version control system makes a great deal of sense for expo
(where it goes offline for a month or two and nearly all the year's edits happen).</p> (where it goes offline for a month or two and nearly all the year's edits happen).</p>
@ -151,7 +151,7 @@ For the current situation see <a href="troggle/trogstatus.html">expo systems sta
<hr /> <hr />
Return to<br /> Return to<br />
<a href="onlinesystems.html">expo online systems overbiew</a><br /> <a href="computing/onlinesystems.html">expo online systems overbiew</a><br />
<hr /> <hr />
</body> </body>

View File

@ -102,7 +102,7 @@ and data-management procedures, the respository software system and manual proce
<li><a href="expofiles/surveys">Full-size surveys</a></li> <li><a href="expofiles/surveys">Full-size surveys</a></li>
<li><a href="expofiles/rigging_topos">Rigging topos</a></li> <li><a href="expofiles/rigging_topos">Rigging topos</a></li>
<li><a href="expofiles/terrain">Terrain models</a></li> <li><a href="expofiles/terrain">Terrain models</a></li>
<li><a href="handbook/onlinesystems.html">Updating data on the server</a> - online systems <li><a href="handbook/computing/onlinesystems.html">Updating data on the server</a> - online systems
(including most of the website and handbook pages). Experts only. (including most of the website and handbook pages). Experts only.
<li><a href="expofiles/tunnelwiki/wiki/pages/Tunnel.html">Tunnel Wiki (documentation)</a></li> <li><a href="expofiles/tunnelwiki/wiki/pages/Tunnel.html">Tunnel Wiki (documentation)</a></li>