corecting mistakes in New Cave pages

This commit is contained in:
Philip Sargent
2021-04-14 01:47:41 +01:00
parent 71c86b7b98
commit a646dc3204
5 changed files with 39 additions and 34 deletions

View File

@@ -12,8 +12,10 @@
<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>
<code>&lt;url&gt;1623/4&lt;/url&gt; </code>
at the bottom as this shows that the cave descripition data is in <code>:expoweb:/cave_data/1623-2.html</code>
There will only be an additional description file for large and complex caves.
<!-- it would be nice to find something that colourises this in HTML -->
<pre><code>&lt;!-- Only put one cave in this file --&gt;
@@ -50,8 +52,8 @@ at the bottom as this shows that this file is <code>:expoweb:/cave_data/augstb/4
&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;description_file&gt;&lt;/description_file&gt;
&lt;url&gt;1623/4&lt;/url&gt;
&lt;/cave&gt;
&lt;/body&gt;
&lt;/html&gt;
@@ -59,7 +61,7 @@ at the bottom as this shows that this file is <code>:expoweb:/cave_data/augstb/4
<!-- 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>
looks <a href="http://expo.survex.com/cave/1623-4">like this</a>
<p>An explanation of what the field names mean and how they are used is on
the <a href="caveentryfields.html">cave entry fields</a> page. There is not an exact correspondance between
@@ -81,11 +83,11 @@ the form and the file format however.
<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
files named <tt>:expoweb:/cave_data/{area}-{cavenumber}.html</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>
stored under the area names <tt>:expoweb:/1623/{cavenumber}/ent_photo1.jpg</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>
@@ -93,7 +95,8 @@ the form and the file format however.
<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>
as <tt>cave/{area}/{cavenumber}</tt> on the website even though <em>internally</em> the data
is coming from <tt>cave_data/{area}-{cavenumber}.html and entrance_data/{area}-{cavenumber}.html</tt> </p>
<hr />
<p>Back to the form-filling method
<a href="caveentry.html">the form-filling method</a> guide