Making the website manual parts of the handbook more useable

This commit is contained in:
Philip Sargent 2018-06-28 18:37:58 +01:00
parent f1d662c9b4
commit 393abbfd06
4 changed files with 77 additions and 55 deletions

View File

@ -34,13 +34,24 @@
<dd><a href="../bcamps.htm">Base camp</a> and <a href="../tcamps.htm">History of high camps</a></dd>
<dt><a href="look4.htm">Prospecting</a></dt>
<dd>The printable <a href="prospecting_guide_short.html">prospecting guide</a> or <a href="/prospecting_guide/">new prospecting guide (slow to load)</a> is essential reading before you wander the plateau stumbling across holes of potential interest. Vast amounts of work have been wasted in the past through inadequate recording. It isn't very much extra work, but ensures that your hard work gains some recognition in the future rather than making lots of tedious work and the cursing of your name... There is a separate page with pictures of surface landmarks for <a href="findit.htm">taking bearings</a>, and a new guide to getting a <a href="survey/gps.htm">GPS fix</a>.</dd>
<dt><a href="survey/index.htm">Surveying</a></dt>
<dd>Once the cave starts to get significant (ie. anything which requires getting changed or rigging), it needs good documentation. This is mostly a matter of doing a cave survey, a guidebook description and usually a surface survey. The first time you go to explore a poorly documented question mark, you will realise how important this is, and it also makes for having a pretty survey on your wall to support your bullshit. For 1998, the surveying guide has been split into easily digestible chunks, including pages specifically intended for people who <a href="survey/what.htm">haven't surveyed before</a>.
This is <a href="../survey.html">Survey data</a>.Therion protractors in <a href="../templates/therion1_250.pdf">1:250</a> and <a href="templates/therion1_500.pdf">1:500</a> scales. Thanks to Martin Budaj for these!</dd>
<dt><a href="phone.htm">Phones</a></dt>
<dd>Once the cave starts to get significant (ie. anything which requires getting changed or rigging), it needs good documentation. This is mostly a matter of <br><br>
<ul>
<li>doing a cave survey,
<li>a guidebook description
<li>photographs of the entrance, and usually
<li>a surface survey.
</ul>
<br>
The first time you go to explore a poorly documented question mark ("QM"), you will realise how important this is, and it also makes for having a pretty survey on your wall to support your bullshit. The surveying guide has been split into easily digestible chunks, including pages specifically intended for people who <a href="survey/what.htm">haven't surveyed before</a>.
<p>
This is <a href="../survey.html">how we survey on Expo</a>.
<p>We use Therion protractors for which we have templates in <a href="../templates/therion1_250.pdf">1:250</a> and <a href="templates/therion1_500.pdf">1:500</a> scales. Thanks to Martin Budaj for these!</dd>
<dt><a href="phone.htm">EXPO Phones</a></dt>
<dd>How to use and update the base camp and top camp mobile phones on expo. (Not your phone.)</dd>
<dt><a href="charging.html">Charging</a></dt>
<dd>How to charge the 14.4V Makita Drill batteries.</dd>

View File

@ -1,4 +1,3 @@
<html>
<head>
<title>CUCC Expedition Handbook: The Website</title>
@ -79,9 +78,12 @@ processes that a maintainer would want to do.</p>
<li><a href="#photos">Uploading photos</a></li>
<li><a href="#tickingoff">Ticking off QMs</a></li>
<li><a href="#surveystatus">Maintaining the survey status table</a></li>
<li><a href="#history">History</a></li>
<li><a href="#automation">Automation</a></li>
</ol>
Appendices:
<ul>
<li><a href="website-history">History of the website</a></li>
</ul>
<h3><a id="usernamepassword">Getting a username and password</a></h3>
@ -148,21 +150,24 @@ below for details on that.</p>
<tt>hg clone http://expo.survex.com/repositories/home/expo/expoweb/</tt> (read-only)
</dd>
</dl>
<dl>
<dt>expofiles (all the big files and documents)</dt>
<p>Photos, scans (logbooks, drawn-up cave segments) (This was about
60GB of stuff in 2017 which you probably don't actually need locally) To sync
60GB of stuff in 2017 which you probably don't actually need locally).<p> To sync
the files from the server to local expofiles directory:</p>
<p><tt>rsync -av expo@expo.survex.com:expofiles /home/expo</tt></p>
<p>To sync the local expofiles directory back to the server:</p>
<p><tt>rsync --dry-run --delete-after -a /home/expo/expofiles expo@expo.survex.com</tt></p>
then CHECK that the list of files it produces matches the ones you absolutely intend to delete forever! ONLY THEN do:
<p><tt>rsync -av /home/expo/expofiles expo@expo.survex.com:</tt></p>
<p>(do be <b>incredibly</b> careful not to delete piles of stuff then rsync back, or to get the directory level of the command wrong - as it'll all get deleted on the server too, and we may not have backups!). It's <b>absolutely vital</b>Use rsync --dry-run --delete-after -a first to check what would be deleted. If you are using rsync from a Windows machine you will <em>not</em> get all the files as some filenames are incompatible with Windows: see more detail under <a href="Mercurialinwindows">Using Mercurial/TortoiseHg in Windows</a> below.</p>
<p>(We have an issue with rsync not using the appropriate user:group attributes for files pushed back to the server. This may not cause any problems, but watch out for it.)</p>
</dl>
<h3><a id="editingthewebsite">Editing the website</a></h3>
<p>To edit the website fully, you need a Mercurial client such as TortoiseHg. 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 dynamically-generated pages can not be edited in this way, but forms are provided for some page-types like 'caves'.</p>
@ -221,7 +226,7 @@ changes are pending) and then "hg commit" in the directory
<h3><a id="Mercurialinwindows">Using Mercurial/TortoiseHg in Windows</a></h3>
<p>Read the instructions for setting up TortoiseHG in <a href="tortoise/tortoise-win.htm">Aled's Windows 101</a>.
<p>Read the instructions for setting up TortoiseHG in <a href="tortoise/tortoise-win.htm">Tortoise-on-Windows</a>.
<p>In Windows: install Mercurial and TortoiseHg of the relevant flavour from <a href="https://tortoisehg.bitbucket.io/">https://tortoisehg.bitbucket.io/</a> (ignoring antivirus/Windows warnings). This will install a submenu in your Programs menu)</p>
<p>To start cloning a repository: first create the folders you need for the repositories you are going to use, e.g. D:\CUCC-Expo\loser and D:\CUCC-Expo\expoweb. Then start TortoiseHg Workbench from your Programs menu, click File -> Clone repository, a dialogue box will appear. In the Source box type</p>
@ -297,30 +302,23 @@ T/U: Jess 1 hr, Emma 0.5 hr
<h3><a id="photos">Uploading photos and GPS tracks</a></h3>
<p>Photos are stored in the general file area of the site under <a
<p>Photos are stored in the general file area of the site under <br /><a
href="http://expo.survex.com/expofiles/photos/">http://expo.survex.com/expofiles/photos/</a></p>
<p>GPS tracks over the surface of the plateau (GPX files from your handheld GPS or phone) are stored in the general file area of the site under <a
<p>GPS tracks over the surface of the plateau (GPX files from your handheld GPS or phone) are stored in the general file area of the site under <br /><a
href="http://expo.survex.com/expofiles/gpslogs/">http://expo.survex.com/expofiles/gpslogs/</a></p>
<p>
They are each organised by year, and by photographer (walker). Please use directory
names like 2014/YourName (i.e no spaces, CamelCase for names).</p>
They are each organised by year, and by photographer (walker). </p>
<p>They are viewed at <a
<p>They are much more conveniently viewed at <br /> <a
href="http://expo.survex.com/photos/">http://expo.survex.com/photos/</a><br />
or<br />
<a href="http://expo.survex.com/gpslogs/">http://expo.survex.com/gpslogs/</a><br />
because the website scripts create a much friendlier interface
</p>
The directory names are like this: "2014/YourName/" (i.e no spaces, CamelCase for names).
<p>Photos and GPS tracks can be uploaded in 2 basic ways:
<ol>
<li>Rsync,scp,sftp as user 'expo' to expo.survex.com, into the directory expofiles/photos/&lt;year&gt;/&lt;PhotographerName&gt;</li>
<li>Webdav upload to special dir http://expo.survex.com/expofiles/uploads/&lt;year&gt;/&lt;PhotographerName&gt;</li>
</ol></p>
<p>See <a href="uploading.html">Photo/File Upload Instructions</a> for
using webdav/webfolders or winscp from your browser or with other
tools, on various OSes.</p>
<p>See <a href="uploading.html">Photo/GPS/File Upload Instructions</a> for instructions on intalling and using software to do this uploading - for all types of operating system.</p>
<h3><a id="tickingoff">Ticking off QMs</a></h3>
@ -333,23 +331,6 @@ tools, on various OSes.</p>
<p>This is generated by the script tablizebyname-csv.pl from the input file Surveys.csv</p>
<h3><a id="history">History</a></h3>
<p>The CUCC Website was originally created by Andy Waddington in the early 1990s and was hosted by Wookey. The VCS was CVS. The whole site was just static HTML, carefully designed to be RISCOS-compatible (hence the short 10-character filenames) as both Wadders and Wookey were RISCOS people then. Wadders wrote a huge amount of info collecting expo history, photos, cave data etc.</p>
<p>Martin Green added the SURVTAB.CSV file to contain tabulated data for many caves around 1999, and a script to generate the index pages from it. Dave Loeffler added scripts and programs to generate the prospecting maps in 2004. The server moved to Mark Shinwell's machine in the early 2000s, and the VCS was updated to subversion.</p>
<p>In 2006 Aaron Curtis decided that a more modern set of generated, database-based pages made sense, and so wrote Troggle. This uses Django to generate pages. This reads in all the logbooks and surveys and provides a nice way to access them, and enter new data. 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. Work on Troggle still continues sporadically.</p>
<p>After expo 2009 the VCS was updated to hg, because a DVCS 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>
<p>The site was moved to Julian Todd's seagrass server (in 2010), but the change from a 32-bit to 64-bit machine broke the website autogeneration code,
which was only fixed in early 2011, allowing the move to complete. The
data has been split into 3 separate repositories: the website,
troggle, the survey data, the tunnel data. Seagrass was turned off at
the end of 2013, and the site has been hosted by Sam Wenham at the
university since Feb 2014.</p>
<h3 id="automation">Automation on expo.survex.com</h3>

View File

@ -0,0 +1,28 @@
<html>
<head>
<title>CUCC Expedition Handbook: Website History</title>
<link rel="stylesheet" type="text/css" href="../css/main2.css" />
</head>
<body>
<h2 id="tophead">CUCC Expedition Handbook</h2>
<h1>EXPO WebsiteHistory</h1>
<p>The CUCC Website was originally created by Andy Waddington in the early 1990s and was hosted by Wookey. The VCS was CVS. The whole site was just static HTML, carefully designed to be RISCOS-compatible (hence the short 10-character filenames) as both Wadders and Wookey were RISCOS people then. Wadders wrote a huge amount of info collecting expo history, photos, cave data etc.</p>
<p>Martin Green added the SURVTAB.CSV file to contain tabulated data for many caves around 1999, and a script to generate the index pages from it. Dave Loeffler added scripts and programs to generate the prospecting maps in 2004. The server moved to Mark Shinwell's machine in the early 2000s, and the VCS was updated to subversion.</p>
<p>In 2006 Aaron Curtis decided that a more modern set of generated, database-based pages made sense, and so wrote Troggle. This uses Django to generate pages. This reads in all the logbooks and surveys and provides a nice way to access them, and enter new data. 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. Work on Troggle still continues sporadically.</p>
<p>After expo 2009 the VCS was updated to hg, because a DVCS 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>
<p>The site was moved to Julian Todd's seagrass server (in 2010), but the change from a 32-bit to 64-bit machine broke the website autogeneration code,
which was only fixed in early 2011, allowing the move to complete. The
data has been split into 3 separate repositories: the website,
troggle, the survey data, the tunnel data. Seagrass was turned off at
the end of 2013, and the site has been hosted by Sam Wenham at the
university since Feb 2014.</p>
Return to<br>
<a href="update.html">Website update</a><br>
<a href="expodata.html">Website developer information</a><br>
<hr>

View File

@ -38,21 +38,7 @@ the Expo username and password can download the whole dataset <a
href="noinfo/all.3d">here</a> for the 3d files and <a
href="noinfo/all.tgz">here</a> for the Survex files.<sup><a id="fn1ref"
href="#footnote1">1</a></sup></p>
<p>At the moment survey data is being made available gradually on a
cave-by-cave basis; the first batch of caves are those under active exploration
by CUCC as of summer 2004, namely <a
href="1623/204/204.html">Steinbr&uuml;ckenh&ouml;hle</a> (1623/204), <a
href="1623/234/234.html">Hauchh&ouml;hle</a> (1623/234) and <a
href="1623/76/76.htm"> Eislufth&ouml;hle</a> (1623/76).</p>
<h3>Drawn-up surveys</h3>
<p>Final copies of surveys of various vintages are sprinkled throughout the
site, linked from the description pages of the caves they correspond to. Of
current interest are the plans of <a
href="1623/204/204.html">Steinbr&uuml;ckenh&ouml;hle</a>, <a
href="1623/234/234.html">Hauchh&ouml;hle</a>, and <a
href="1623/76/76.htm"> Eislufth&ouml;hle</a>.</p>
<h3>Working area</h3>
@ -70,6 +56,22 @@ tar archive compressed with GZIP; on Unix systems this can be decompressed with
href="http://www.winzip.org">WinZip</a> or an equivalent tool (such as the
freeware <i>WinImp</i>).</p>
<h3>Status</h3>
<p>Survey data is being made available gradually on a
cave-by-cave basis and is now nearly complete - except for recent discoveries. The first batch of caves were those under active exploration
by CUCC as of summer 2004, namely <a
href="1623/204/204.html">Steinbr&uuml;ckenh&ouml;hle</a> (1623/204), <a
href="1623/234/234.html">Hauchh&ouml;hle</a> (1623/234) and <a
href="1623/76/76.htm"> Eislufth&ouml;hle</a> (1623/76).</p>
<h3>Drawn-up surveys</h3>
<p>Final copies of surveys of various vintages are sprinkled throughout the
site, linked from the description pages of the caves they correspond to. Of
current interest are the plans of <a
href="1623/204/204.html">Steinbr&uuml;ckenh&ouml;hle</a>, <a
href="1623/234/234.html">Hauchh&ouml;hle</a>, and <a
href="1623/76/76.htm"> Eislufth&ouml;hle</a>.</p>
<hr />