expo/expoweb
1
0
Fork 0
mirror of https://expo.survex.com/repositories/expoweb/.git/ synced 2024-11-22 07:11:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

update handbook with new URL style

Browse Source
This commit is contained in:
Philip Sargent 2023-11-03 00:08:52 +02:00
parent 24554b21ea
commit c85897a881
3 changed files with 11 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
handbook/survey/caveentry.html
View File

@ -117,9 +117,9 @@ The username is "expo" and the password is the usual "{cavey}:{beery}" one.
</p>
<ul>
<li>
Now open the cave page for an existing cave, e.g. <a href="/1623/172.htm">Plateauh&ouml;hle 172</a>.
Now open the cave page for an existing cave, e.g. <a href="/1623/172/172.html">Plateauh&ouml;hle 172</a>.
</li>
<li>Now you are looking at the description of the cave. Take a moment to look at the URL in the title bar of your browser: the URL is <var>/1623/172.htm</var>. Remember this, we will come back to it.
<li>Now you are looking at the description of the cave. Take a moment to look at the URL in the title bar of your browser: the URL is <var>/1623/172/172.html</var>. Remember this, we will come back to it.
<li>
Now you can see a new option saying
<a href="1623-4/edit/" >"Edit this cave"</a> at the bottom of the top left-hand menu.
@ -138,10 +138,10 @@ The username is "expo" and the password is the usual "{cavey}:{beery}" one.
<ul>
<li>The cave nearby: <a href="/1623/171/171.html">Plateauh&ouml;hle 171</a>.
<li>Here you can see that it has two entrances.
<li>Take a note of the URL: <var>/1623/171/171.htm</var>. Aha. Not quite the same is it.
<li>Take a note of the URL: <var>/1623/171/171.html</var>.
<li>Now go the left-hand menu and click on "Edit this cave"
<li>You can see that both entrances are listed at the bottom of the form, and that the URL field matches the one you saw for the cave description: <var>/1623/171/171.htm</var>.
<li>The reason the URL has a different structure is that cave 171 has a lot of photographs associated with it (unlike 172), and these photos have been put in a separate folder /171/ .
<li>You can see that both entrances are listed at the bottom of the form, and that the URL field matches the one you saw for the cave description: <var>/1623/171/171.html</var>.
<li>Cave 171 has a lot of photographs associated with it (unlike 172), and these photos have been put in a separate folder /171/ . This is why we have what appeared to be a redundant part of the URL in the other cave: if there are photos, we need somewhere to put them.
<li>This cave also has a correct link to a survex file under the heading "Survex File"
Click on <a href="/survexfile/caves-1623/171/171.svx">This survex file</a> and you can see the names and details of the survey done in 2016 by Jenny and Olly.
Click on '3d download' in the cave description page and you will open the centreline in 3d on your computer - if you have survex installed (which you should do: Olly wrote it and he will be upset if you don't).
@ -150,12 +150,6 @@ The username is "expo" and the password is the usual "{cavey}:{beery}" one.
<p>Behind the scenes, you are editing different .xml files for the cave and for each entrance.
Troggle collects these together 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>
<h3>Gotcha</h3>
<p>When creating a new cave you have just discovered, you can't create the entrance the first time you are on the form.
<p>Create the cave, click the Submit button to save it to the system.
<p>The next page will be your cave page as if you had clicked on its name in the "<a href="/caves">Caves</a>" page.
<p>Now you can now click on "New Entrance" at the bottom of the description page to create and edit the entrance details.
<h2>List of New Cave/Cave_data fields</h2>
@ -169,6 +163,5 @@ So each field you fill in on the form may contain arbitrary HTML. Be careful!</p
<hr />
</body>
<hr /></body>
<html>

7
handbook/survey/caveentryfields.html
View File

@ -18,12 +18,11 @@
</p>
<h3>Only two fields are essential</h3>
<p>There are only two essential fields which must be there before the Submit button will work:
<h3>Only one field is essential</h3>
<p>There is only one essential field which must be there before the Submit button will work:
<ul>
<li><b>caveslug</b> e.g. 1623-195 or 1623-2012-dd-01
<li><b>url</b> e.g. 1623/195 or 1623/2012-dd-01
</ul>
<p>See below for explanations.
@ -134,7 +133,7 @@
</dl>
<dl>
<dt>url</dt>
<dd>(<i>Required</i>). URL of this cave. i.e the URL this cave appears at on the website. This is not a pre-existing thing, you are defining it here for the first time. This will be the url that is the public face of the troggle-produced cave description. Usually it has been <tt>area/cavenum.html</tt> e.g '1623/165.html' in the past, for compatibility with pre-troggle files. For new caves at least it should be <tt>area/cavenum</tt> e.g '1623/291'</dd>.
<dd>(<i>No longer required</i>). URL of this cave. i.e the URL this cave appears at on the website. It is now fixed as <tt>area/cavenum/cavenum.html</tt> e.g '1623/165/165.html' or '1626/2023-BL-10/2023-BL10.html'. This is no longer something the user inputs and it is ignored during file import if it is there</dd>.
</dl>
<h3>Template files for bulk entry</h3>
<p>

6
handbook/survey/newcavefile.html
View File

@ -11,9 +11,7 @@
<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;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>
<p>The example full format below is of a very simple cave with hardly any fields filled in.
There will only be an additional description file for large and complex caves.
@ -53,7 +51,7 @@ There will only be an additional description file for large and complex caves.
&lt;extent&gt;&lt;/extent&gt;
&lt;survex_file&gt;&lt;/survex_file&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;