expo/expoweb
1
0
Fork 0
mirror of https://expo.survex.com/repositories/expoweb/.git/ synced 2025-12-08 14:54:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

Cave entry - outline documentation plan

Browse Source
This commit is contained in:
Philip Sargent
2020-03-01 22:22:21 +00:00
parent 04f70187b9
commit fefe5cafd6
8 changed files with 426 additions and 133 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
handbook/computing/getsurvex.html
View File

@@ -1,17 +1,18 @@
<!DOCTYPE html>
<html> <html>
<head> <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 Expedition Handboo - Survey software</title> <title>CUCC Expedition Handboo - Survey software</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</h2> <h2 id="tophead">CUCC Expedition Handbook</h2>
<h1>Installing surveying tools</h1> <h1>Installing surveying tools</h1>
<h2>Survex</h2> <h2>Survex</h2>
<p>The main software we use to process cave data and surface surveys is <b>survex</b> <p>The main software we use to process cave data and surface surveys is <strong>survex</strong>
which has been written over several decades by CUCC cavers. which has been written over several decades by CUCC cavers.
The first version was written during the 1990 Expo in Austria in the (old) potato hut. The first version was written during the 1990 Expo in Austria in the old potato hut.
A <a href="survexhistory96.htm">history of survex</a> article was published in Cambridge Underground 1996. It covers the period 1988-1996. A <a href="../survexhistory96.htm">history of survex</a> article was published in Cambridge Underground 1996. It covers the period 1988-1996.
<p>Download the survex package here: <a href="https://survex.com/">www.survex.com</a> and install it. <p>Download the survex package here: <a href="https://survex.com/">www.survex.com</a> and install it.
<p>You will discover that the application installed is actually called "aven" but do not be concerned. <p>You will discover that the application installed is actually called "aven" but do not be concerned.

32
handbook/survey/cavedescription.html Normal file
View File

@@ -0,0 +1,32 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<title>Handbook placeholder page</title>
<link rel="stylesheet" type="text/css" href="../../css/main2.css" />
</head>
<body>
<h2 id="tophead">CUCC Expedition Handbook</h2>
<h1>Placeholder</h1>
<p>This is not the page you were hoping 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 ?
<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>
</ul></li>
<li><a href="../../infodx.htm">Main index</a></li>
<li><a href="../../index.htm">Expo Home</a></li>
<li><a href="https://camcaving.uk">CUCC Home</a></li>
</ul>
</div>
</body>
</html>

218
handbook/survey/caveentry.html
View File

@@ -1,143 +1,109 @@
<!DOCTYPE html>
<html> <html>
<head> <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 Expedition Handbook: Cave entry field</title> <title>CUCC Expedition Handbook: Cave data entry</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</h2> <body>
<h2 id="tophead">CUCC Expedition Handbook - New Cave data</h2>
<h1>Creating a new cave in the online system</h1>
<h1>Cave entry page fields</h1> <h2>Great, I have discovered a new cave...</h2>
<p>There are a lot of fields on the 'new/edit cave' page and the 'new/edit entrance' page and <p>If you have not come to this page from the sequence starting at <a href="newcave.html">Starting a New Cave"</a> then go and read that first.
some of them are a quite mysterious. This page explains what they mean, and how to enter new
caves and entrances, and especially how to add images/surveys so that they appear.</p>
<p>There is a bug in that the 'new entrance' page which fails unless the entrance has been previously created on another cave. This is being fixed (April 2019). <li>This page outlines the next step of the process. Each part of it is documented separately.
<!-- Yes we need some proper context-marking here, breadcrumb trails or something.
Maybe a colour scheme for just this sequence of pages
-->
</ul>
<h2>Process</h2>
<p>
This page and those following describe the process for creating new
caves and entrances, and especially how to add images/surveys so that they appear correctly online.</p>
</p>
<h3>Two ways of creating a new cave in the online system</h3>
<ul>
<li>Filling in the online form</li>
<li>Editing a file and uploading it</li>
</ul>
<p>For experienced people creating a batch of small caves the file upload & import process is quicker. Most people won't use this method
for their first cave so it is documented separately in <a href="newcavefile.html">new cave file method</a>.
<p>In other words you can either add caves (or entrances) using the web-interface
or you can check out the 'expoweb' repository using the version control system and just edit the files.</p>
<p>Effectively each field is concatenated to make an HTML <p>Nevertheless you will find it useful when filling out the form for the first time
page for the cave (or entrance), so each field may contain arbitrary HTML.</p> to have some idea what is going on behind the scenes. So you are recommended to have a quick look
at the <a href="newcavefile.html">new cave file method</a> even if you have no intention of using it.
</p>
<h2>Recommended procedure</h2>
<p>You can either add caves (or entrances) using the web-interface, clicking on 'New Cave') or <p>
'New Entrance'), or you can check out the 'expoweb' repository and just edit the files.</p> You will find the process a lot easier to follow if you Edit an existing cave first, because then you can see all the necesary
fields filled in. You can then fill out the form for your new cave using that as an example to follow. But of course be
very careful not to actually chenge anything on the form you have open for editing.
</p>
<h3>New Cave form</h3>
<p>The links to follow to open up the "New Cave" form or the "Edit Cave" forms are
somewhat obscure. <!--We should change this! -->
Go to the main cave index page which lists all the caves: <a href="/caves">Cave Index</a>
and right at the bottom of the page (you will need to scroll down) it says<br />
<a href="/cave/new/">New Cave</a>.<br /> But don't click on it yet, first we will edit an old cave.
</p>
<h2>File layout</h2> <h3>Edit Cave form</h3>
<p>The caves in our site are stored as XML files under <tt>noscript/cave_data</tt> and in <p>
files named <tt>area-cavenumber</tt>. Entrances are correspondingly First make sure that you are logged-in to the troggle website. You almost certainly are already,
in <tt>noscript/entrance_data</tt> files, with the same naming convention, except that if but if you are trying this on a new machine this can catch you out. Go to
there is more than one entrance they have a,b,c suffixes. Any associated files, usually photos and surveys, are <a href="https://expo.survex.com/accounts/login/">expo.survex.com/accounts/login/</a>.
stored under the area names <tt>1623</tt> or <tt>1626</tt>, then the cavenumber. An The username is "expo" and the password is the usual "{cavey}:{beery}" one.
understanding of this file layout is very important when writing the html so that images </p>
appear as the URLs in the XML file should be relative URLs to the cave page, which appears <ul>
as <i>area/cavenumber</i>.</p> <li>
Now open the cave page for an existing cave, e.g. <a href="http://expo.survex.com/augstb/4.htm">augstb-4</a>.
</li>
<li>
Now you can see that at the top there is a bullet point link labelled "Edit" -
this is for editing entrances so don't touch it.</li>
<li>
What you need is the line saying
<a href="http://expo.survex.com/cave/1623-4/edit/" >"Edit this cave"</a> at the bottom of the top left-hand menu.
It has a little icon of a pen next to it.</li>
<li>Click on it. A form appears.</li>
<li>
Scroll down the page - it is a long form - and look at the"Description file" and "Url" fields.
These are the critical fields to get right when you create your own cave using the New Cave form.
</li>
</ul>
<p>Effectively each field on the form is concatenated between tags to make an XML
page for the cave (or entrance). So each field you fill in on the form may contain arbitrary HTML. Be careful!</p>
<p>An example will make clear how this works</p> <h3>Gotchas</h3>
<p>TODO - example of the filelayout</p> <p>There is a problem in that when you create a cave for the first time it doesn't know about the cave, so the drop-down
menu of caves does not include itself.
So a new entrance has to be assigned to an existing cave (which is in the drop-down), and edited correctly later once troggle has
fully
absorbed the existence of your new cave.
<h3>Detailed walk-through of an example</h3>
<p>TO BE DONE</p>
<h2>Attaching additional scanned surveys</h2>
<p>TO BE DONE</p>
<h2>List of New Cave/Cave_data fields</h2> <h2>List of New Cave/Cave_data fields</h2>
<dl> <p>The full list of fields is documented: <a href="caveentryfields.html">the full list of data-entry fields</a> when creating a cave.
<dt>non_public</dt>
<dd>'False' or 'True'. True if the cave should only be visible to logged-in users. Caves
are normally public, so enter 'False' unless you know otherwise.</dd>
</dl>
<dl>
<dt>caveslug</dt>
<dd>(<i>Required</i>). Internal I.D. used to refer to this cave in entrance data files. Typically the same as the filebase (e.g. 1623-195). Matches the </dd>
</dl>
<dl>
<dt>area</dt>
<dd>(<i>Required</i>).The Kataster area (always 1623 or 1626). It's important to get this right, especially
if near the border between the two areas. 1623 is our main area, but the border is not too far beyond the Stone
Bridge so since 2014 some of our caves are in 1626.</dd>
</dl>
<dl>
<dt>area</dt>
<dd>Yes - there really are two different fields, both called 'area'. Bonkers. This second
one is the CUCC-defined areas shown in <a href="/areas.htm">this plan</a>.</dd>
</dl>
<dl>
<dt>kataster_code</dt>
<dd>The length/depth code used in the Austrian kataster. This may be autogenerated if you
don't enter one.</dd>
</dl>
<dl>
<dt>kataster_number</dt>
<dd>(<i>Either this or unofficial_number is required</i>). Offical number in Austrian kataster if one has been allocated.</dd>
</dl>
<dl>
<dt>unofficial_number</dt>
<dd>(<i>Either this or kataster_number is required</i>). Initial temporary cave ID used until kataster number is allocated. (e.g. 2012-DD-01) If you do not give this (or the kataster_number if issued) then your cave <em>will not appear</em> in the caves list (<a href="http://expo.survex.com/caves">Main Index/caves</a>).</dd>
</dl>
<dl>
<dt>entrance</dt>
<dd>Enclosing tag for each entrance, containing an entranceslug ID and a letter (if more than one entrance)</dd>
</dl>
<dl>
<dt>entranceslug</dt>
<dd>Internal ID to refer to each entrance instance in the entrance files (typically the same as that filename (e.g. 1623-161a). Matches the 'slug' field in the entrance file.</dd>
</dl>
<dl>
<dt>letter</dt>
<dd>Leave blank for single-entrance cave. If there is more than one entrace then the letter needs to be given. Generally matches the entranceslug ID.</dd>
</dl>
<dl>
<dt>explorers</dt>
<dd>Club (CUCC) and year(s) of exploration. To distinguish from caves explored by foreign groups. Names can be given too if it was a small cave.</dd>
</dl>
<dl>
<dt>underground_description</dt>
<dd>Underground description. (description of approach and entrance goes in entrance file). For a small cave this will be the entire description. For larger caves it will be the front page of the description, or a short intro, containing links to other pages with the cave description in, or even nothing but a link.</dd>
</dl>
<dl>
<dt>equipment</dt>
<dd>For a small cave, summary of gear needed to descend. For longer caves it could be blank, a table, or just refer to the description/topos. Leave blank if this info is in the description.</dd>
</dl>
<dl>
<dt>references</dt>
<dd>References to documentation. Could be Journal articles or Logbook entries. Can be links if the docs are online.</dd>
</dl>
<dl>
<dt>survey</dt>
<dd>Drawn-up surveys. Scans of paper surveys or images/PDFs of electronic surveys. Should include HTML to display current plan and elevation, with links to larger versions (See section on URLs and files). Could list links to multiple years of survey, or even a separate survey page if it's complicated enough.</dd>
</dl>
<dl>
<dt>kataster_status</dt>
<dd>Normally empty but can be used for notes on process of getting cave into Austrian kataster. (e.g. 'Too small to be in Kataster', 'Number applied for on 'date', awaiting allocated number).</dd>
</dl>
<dl>
<dt>underground_centre_line</dt>
<dd>'In dataset' if it is in the survex dataset. Blank if not, or notes about status such as 'surveyed, but no entrance fix so not yet in dataset'.</dd>
</dl>
<dl>
<dt>notes</dt>
<dd>Normally empty, but place for anything else that should be noted, such as info on cave maybe being a duplicate, or lost.</dd>
</dl>
<dl>
<dt>length</dt>
<dd>Cave length. Can be left blank and system should fill it in automatically from survey data (it doesn't yet)</dd>
</dl>
<dl>
<dt>depth</dt>
<dd>Cave depth. Can be left blank and system should fill it in automatically from survey data (it doesn't yet)</dd>
</dl>
<dl>
<dt>extent</dt>
<dd>Cave extent(as defined by survex. Not very useful. Best left blank and system could fill it in automatically from survey data (it doesn't yet). We should probably scrap this field.</dd>
</dl>
<dl>
<dt>survex_file</dt>
<dd>Name of top-level survey file for this cave. Relative to the 'loser' survex repository. So for most caves that's &quot;caves/cavenum/cavnum.svx&quot;. (e.g. caves/204/204.svx</dd>
</dl>
<dl>
<dt>description_file</dt>
<dd>Name of top-level description file for this cave, when a separate file is used. Otherwise blank.</dd>
</dl>
<dl>
<dt>url</dt>
<dd>(<i>Required</i>). URL of this cave. i.e the URL this cave appears at on the website. Normally <tt>area/cavenum.html</tt>, e.g ('1623/165.html')</dd>
</dl>
<hr />
<p>Back to the previous page in this sequence
<a href="newrig.html">New rigging guide</a>.
<br />Now go the the next page in this sequence <a href="cavedescription.html">Write the full cave descriptions with diagrams</a>.
<hr />
</body> </body>
<html> <html>

128
handbook/survey/caveentryfields.html Normal file
View File

@@ -0,0 +1,128 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>CUCC Expedition Handbook: Cave entry field</title>
<link rel="stylesheet" type="text/css" href="../../css/main2.css" />
</head>
<body>
<h2 id="tophead">CUCC Expedition Handbook</h2>
<h1>Cave entry page fields</h1>
<p>There are a lot of fields on the 'new/edit cave' page and the 'new/edit entrance' page and
some of them are a quite mysterious. This page explains what they mean.</p>
<p>
Instructions on how to enter the data for new
caves and entrances, and especially how to add images/surveys so that they appear properly,
is to be found on the sequence of pages <a href="caveentry.html">starting here</a>.
</p>
<h2>List of New Cave/Cave_data fields</h2>
<dl>
<dt>non_public</dt>
<dd>'False' or 'True'. True if the cave should only be visible to logged-in users. Caves
are normally public, so enter 'False' unless you know otherwise.</dd>
</dl>
<dl>
<dt>caveslug</dt>
<dd>(<i>Required</i>). Internal I.D. used to refer to this cave in entrance data files. Typically the same as the filebase (e.g. 1623-195). Matches the </dd>
</dl>
<dl>
<dt>area</dt>
<dd>(<i>Required</i>).The Kataster area (always 1623 or 1626). It's important to get this right, especially
if near the border between the two areas. 1623 is our main area, but the border is not too far beyond the Stone
Bridge so since 2014 some of our caves are in 1626.</dd>
</dl>
<dl>
<dt>area</dt>
<dd>Yes - there really are two different fields, both called 'area'. Bonkers. This second
one is the CUCC-defined areas shown in <a href="/areas.htm">this plan</a>.</dd>
</dl>
<dl>
<dt>kataster_code</dt>
<dd>The length/depth code used in the Austrian kataster. This may be autogenerated if you
don't enter one.</dd>
</dl>
<dl>
<dt>kataster_number</dt>
<dd>(<i>Either this or unofficial_number is required</i>). Offical number in Austrian kataster if one has been allocated.</dd>
</dl>
<dl>
<dt>unofficial_number</dt>
<dd>(<i>Either this or kataster_number is required</i>). Initial temporary cave ID used until kataster number is allocated. (e.g. 2012-DD-01) If you do not give this (or the kataster_number if issued) then your cave <em>will not appear</em> in the caves list (<a href="http://expo.survex.com/caves">Main Index/caves</a>).</dd>
</dl>
<dl>
<dt>entrance</dt>
<dd>Enclosing tag for each entrance, containing an entranceslug ID and a letter (if more than one entrance)</dd>
</dl>
<dl>
<dt>entranceslug</dt>
<dd>Internal ID to refer to each entrance instance in the entrance files (typically the same as that filename (e.g. 1623-161a). Matches the 'slug' field in the entrance file.</dd>
</dl>
<dl>
<dt>letter</dt>
<dd>Leave blank for single-entrance cave. If there is more than one entrace then the letter needs to be given. Generally matches the entranceslug ID.</dd>
</dl>
<dl>
<dt>explorers</dt>
<dd>Club (CUCC) and year(s) of exploration. To distinguish from caves explored by foreign groups. Names can be given too if it was a small cave.</dd>
</dl>
<dl>
<dt>underground_description</dt>
<dd>Underground description. (description of approach and entrance goes in entrance file). For a small cave this will be the entire description. For larger caves it will be the front page of the description, or a short intro, containing links to other pages with the cave description in, or even nothing but a link.</dd>
</dl>
<dl>
<dt>equipment</dt>
<dd>For a small cave, summary of gear needed to descend. For longer caves it could be blank, a table, or just refer to the description/topos. Leave blank if this info is in the description.</dd>
</dl>
<dl>
<dt>references</dt>
<dd>References to documentation. Could be Journal articles or Logbook entries. Can be links if the docs are online.</dd>
</dl>
<dl>
<dt>survey</dt>
<dd>Drawn-up surveys. Scans of paper surveys or images/PDFs of electronic surveys. Should include HTML to display current plan and elevation, with links to larger versions (See section on URLs and files). Could list links to multiple years of survey, or even a separate survey page if it's complicated enough.</dd>
</dl>
<dl>
<dt>kataster_status</dt>
<dd>Normally empty but can be used for notes on process of getting cave into Austrian kataster. (e.g. 'Too small to be in Kataster', 'Number applied for on 'date', awaiting allocated number).</dd>
</dl>
<dl>
<dt>underground_centre_line</dt>
<dd>'In dataset' if it is in the survex dataset. Blank if not, or notes about status such as 'surveyed, but no entrance fix so not yet in dataset'.</dd>
</dl>
<dl>
<dt>notes</dt>
<dd>Normally empty, but place for anything else that should be noted, such as info on cave maybe being a duplicate, or lost.</dd>
</dl>
<dl>
<dt>length</dt>
<dd>Cave length. Can be left blank and system should fill it in automatically from survey data (it doesn't yet)</dd>
</dl>
<dl>
<dt>depth</dt>
<dd>Cave depth. Can be left blank and system should fill it in automatically from survey data (it doesn't yet)</dd>
</dl>
<dl>
<dt>extent</dt>
<dd>Cave extent(as defined by survex. Not very useful. Best left blank and system could fill it in automatically from survey data (it doesn't yet). We should probably scrap this field.</dd>
</dl>
<dl>
<dt>survex_file</dt>
<dd>Name of top-level survey file for this cave. Relative to the 'loser' survex repository. So for most caves that's &quot;caves/cavenum/cavnum.svx&quot;. (e.g. caves/204/204.svx</dd>
</dl>
<dl>
<dt>description_file</dt>
<dd>Name of top-level description file for this cave, when a separate file is used. Otherwise blank.</dd>
</dl>
<dl>
<dt>url</dt>
<dd>(<i>Required</i>). URL of this cave. i.e the URL this cave appears at on the website. Normally <tt>area/cavenum.html</tt>, e.g ('1623/165.html')</dd>
</dl>
<hr />
<p>Back to <a href="caveentry.html">Cave data entry</a>
<hr />
</body>
<html>

32
handbook/survey/nerd.html Normal file
View File

@@ -0,0 +1,32 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<title>Handbook placeholder page</title>
<link rel="stylesheet" type="text/css" href="../../css/main2.css" />
</head>
<body>
<h2 id="tophead">CUCC Expedition Handbook</h2>
<h1>Placeholder</h1>
<p>This is not the page you were hoping 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 ?
<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>
</ul></li>
<li><a href="../../infodx.htm">Main index</a></li>
<li><a href="../../index.htm">Expo Home</a></li>
<li><a href="https://camcaving.uk">CUCC Home</a></li>
</ul>
</div>
</body>
</html>

102
handbook/survey/newcavefile.html Normal file
View File

@@ -0,0 +1,102 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<title>Handbook placeholder page</title>
<link rel="stylesheet" type="text/css" href="../../css/main2.css" />
</head>
<body>
<h2 id="tophead">CUCC Expedition Handbook</h2>
<h1>Cave data file</h1>
<p>These files live in <span style="font-family: monospace">::expoweb::/cave_data/</span>
<p>The example full format below is of a very simple cave with hardly any fields filled in. The most vital field is
<code>&lt;url&gt;augstb/4.htm&lt;/url&gt; </code>
at the bottom as this shows that this file is <code>::expoweb::/cave_data/augstb/4.htm</code>
<!-- it would be nice to find something that colourises this in HTML -->
<pre><code>&lt;!-- Only put one cave in this file --&gt;
&lt;!-- If you edit this file, make sure you update the websites database --&gt;
&lt;html lang="en"&gt;
&lt;head&gt;
&lt;meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/&gt;
&lt;/head&gt;
&lt;body&gt;
&lt;cave&gt;
&lt;non_public&gt;True&lt;/non_public&gt;
&lt;caveslug&gt;1623-4&lt;/caveslug&gt;
&lt;official_name&gt;Ritscherbachh&ouml;hle&lt;/official_name&gt;
&lt;area&gt;1623&lt;/area&gt;
&lt;area&gt;11&lt;/area&gt;
&lt;kataster_code&gt;1/T(W) +&lt;/kataster_code&gt;
&lt;kataster_number&gt;4&lt;/kataster_number&gt;
&lt;unofficial_number&gt;&lt;/unofficial_number&gt;
&lt;entrance&gt;
&lt;entranceslug&gt;1623-4&lt;/entranceslug&gt;
&lt;letter&gt;&lt;/letter&gt;
&lt;/entrance&gt;
&lt;explorers&gt;H&ouml;hlenforschervereinigung Altaussee, 1937&lt;/explorers&gt;
&lt;underground_description&gt;&lt;/underground_description&gt;
&lt;equipment&gt;&lt;/equipment&gt;
&lt;references&gt;&lt;/references&gt;
&lt;survey&gt;Plan at 1:100 by Alfred Auer, 1968 &lt;/survey&gt;
&lt;kataster_status&gt;&lt;/kataster_status&gt;
&lt;underground_centre_line&gt;&lt;/underground_centre_line&gt;
&lt;notes&gt;&lt;/notes&gt;
&lt;length&gt;12.3m&lt;/length&gt;
&lt;depth&gt;1.07m&lt;/depth&gt;
&lt;extent&gt;&lt;/extent&gt;
&lt;survex_file&gt;&lt;/survex_file&gt;
&lt;description_file&gt;augstb/4.htm&lt;/description_file&gt;
&lt;url&gt;augstb/4.htm&lt;/url&gt;
&lt;/cave&gt;
&lt;/body&gt;
&lt;/html&gt;
</code></pre>
<!-- Yes we should not be using the <tt> "teletype" tag as it is deprecated. -->
<p>As you can see, this is an XML tag format similar to HTML but with tags defined to hold cave survey data. These files are processed by troggle in real-time to produce an HTML file on the fly which is sent to your browser so that it
looks <a href="http://expo.survex.com/augstb/4.htm">like this</a>
<p>When you fill in the online form you creating a file just like the one above: troggle takes the input data from the form and creates the file. Troggle also stores the cave information in it's live memory when you use the form method.
<p>If instead of using the form you create the file by hand and upload it to the server you will also need find a nerd to run the cave import procedure before troggle "knows" that the cave exists.
<h3>Cave entrances</h3>
<p>There is <a href="newentrancefile.html">an exactly analogous file</a> for cave entrances except that those files live in <span style="font-family: monospace">::expoweb::/entrance_data/</span>
<h2>File layout</h2>
<p>The caves in our site are stored as XML files in the directory <tt>::expoweb::/cave_data</tt> and in
files named <tt>::expoweb::/cave_data/{area}-{cavenumber}</tt>. Entrances are correspondingly
in <tt>::expoweb::/entrance_data</tt> files, with the same naming convention, except that if
there is more than one entrance they have a,b,c suffixes, e.g. <tt>::expoweb::/<b>entrance</b>_data/{area}-{cavenumber}b</tt>
<p></p>Any <em>associated files</em>, usually photos and surveys, are
stored under the area names <tt>::expoweb::/1623/{cavenumber}</tt> or <tt>::expoweb::/1626/{cavenumber}</tt>
Note that this is a different naming convention: caves and entrances have the {area} as <em>
part of the file name
</em>
whereas associated files have the {area} <em>as a directory</em> in which the files are stored.
<p>An
understanding of this file layout is very important when filling in the forms or writing the tags so that images
appear on the final published website. The URLs in the XML file <em>should be relative URLs</em> to the cave page, which <em>appears</em>
as <tt>cave/{area}/{cavenumber}</tt> on the website even though <em>internally</em> they are <tt>cave_data/{area}-{cavenumber}</tt> </p>
<hr />
<p>Back to the form-filling method
<a href="caveentry.html">the form-filling method</a> guide
<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>
</ul></li>
<li><a href="../../infodx.htm">Main index</a></li>
<li><a href="../../index.htm">Expo Home</a></li>
<li><a href="https://camcaving.uk">CUCC Home</a></li>
</ul>
</div>
</body>
</html>

32
handbook/survey/newentrancefile.html Normal file
View File

@@ -0,0 +1,32 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<title>Handbook placeholder page</title>
<link rel="stylesheet" type="text/css" href="../../css/main2.css" />
</head>
<body>
<h2 id="tophead">CUCC Expedition Handbook</h2>
<h1>Placeholder</h1>
<p>This is not the page you were hoping 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 ?
<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>
</ul></li>
<li><a href="../../infodx.htm">Main index</a></li>
<li><a href="../../index.htm">Expo Home</a></li>
<li><a href="https://camcaving.uk">CUCC Home</a></li>
</ul>
</div>
</body>
</html>

4
handbook/survey/newrig.html
View File

@@ -37,8 +37,8 @@ which were made underground which were stored in the survey wallet and scanned t
<hr /> <hr />
<p>Back to the previous page in this sequence <a href="drawup.htm">Drawing up your survey"</a>. <p>Back to the previous page in this sequence <a href="drawup.htm">Drawing up your survey</a>.
<br />Now go the the next page in this sequence <a href="newcaveform.html">Filling in the "New Cave" form</a>. <br />Now go the the next page in this sequence <a href="caveentry.html">Creating a new cave in the online system</a>.
<hr /> <hr />
</body> </body>
</html> </html>