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

updates to new way of using filename - online edit of handbook/survey/caveentryfields.html

Browse Source
This commit is contained in:
Expo on server 2024-06-30 17:56:09 +01:00
parent e8f0d86bd5
commit 5dcc9e6752
1 changed files with 14 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
handbook/survey/caveentryfields.html
View File

@ -18,23 +18,15 @@
</p>
<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
</ul>
<p>See below for explanations.
<h3>Names of identifiers and files</h3>
<p>Today we use CAPITAL LETTERS for cave names, e.g. 2014-MF-03, but <b>lower case</b> for the names of files, e.g. 2014-mf-03.svx, despite what you might see in historical data.
<p>However we always use lower case for entrance identifiers 'a', 'b', 'c' etc.
<p>We used to use CAPITAL LETTERS for cave names, e.g. 2014-MF-03, but <b>lower case</b> for the names of files, e.g. 2014-mf-03.svx . However so many people have done the revere that we have stopped caring.
<p>However we do still always use lower case for entrance identifiers 'a', 'b', 'c' etc.
<p>So a new cave would be 2023-ZZ-01 and its entrances would be 2023-ZZ-01a, 2023-Z-01b and 2023-ZZ-01c.
<p>This convention is to prevent confusion between Windows and Linux machines, and unintentional deletion of data.
<p>Our generic guidance for typing logbooks, handbook pages etc. applies particularly to cave descriptions and entrance descritpions where we have to be particularly picky about the formats and character encodings, so now read:
<a href="/handbook/computing/hbmanual1.html#conventions">expo typing conventions</a>.
<h2>List of New Cave/Cave_data fields</h2>
<p>The filename <em>must</em> be the name of the cave, with ".html" as a suffix, e.g. 1623-309.html or 1623-2024-XX-01.html . The filename is used by troggle to create the unique identifier for the cave, so don't screw this up.
<dl>
<dt>non_public</dt>
<dd>'False' or 'True'. True if the cave should only be visible to logged-in users. Caves
@ -42,18 +34,18 @@
</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).</dd>
<dd>(<i>Obsolete as of 2024 expo</i>). Internal I.D. used to be used to refer to this cave in entrance data files. Now we use the filename.</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
<dd>(<i>Required</i>).The Kataster area (always 1623 or 1626). This will <em>always</em> be the first 4 characters of the filename. 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>
<dd>(<i>Obsolete</i> - the subarea one)Yes - there really are two different fields, both called 'area'. Bonkers. This second
one is the CUCC-defined subareas shown in <a href="/areas.htm">this plan</a>.</dd>
</dl>
<dl>
<dt>kataster_code</dt>
@ -73,11 +65,11 @@
</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>
<dd>Internal ID to refer to each entrance instance in the entrance files (must be the same as that filename (e.g. 1623-161a in entrance_data/1623-161a.html). </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>
<dd>Leave blank for single-entrance cave. If there is more than one entrace then the letter needs to be given. This must be the same as the last character of the filename e.g. a for entrance_data/1623-161a.html or nothing at all for entrance_data/1623-114.html which has no letter.</dd>
</dl>
<dl>
<dt>explorers</dt>
@ -113,11 +105,11 @@
</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>
<dd>Cave length. Can be left blank and system should fill it in automatically from survey data (it doesn't yet) We should probably scrap this field.</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>
<dd>Cave depth. Can be left blank and system should fill it in automatically from survey data (it doesn't yet) We should probably scrap this field.</dd>
</dl>
<dl>
<dt>extent</dt>
@ -133,14 +125,14 @@
</dl>
<dl>
<dt>url</dt>
<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>.
<dd>(<i>Obsolete</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>
There are template files for you to fill-in when creating new caves and entrance in the online system. Download them:
<ul>
<li><a download href="../../templates/cave_data.xml">cave_data template</a>
<li><a download href="../../templates/entrance_data.xml">entrance_data template</a>
<li><a download href="../../templates/cave_data.html">cave_data template</a>
<li><a download href="../../templates/entrance_data.html">entrance_data template</a>
</ul>
These are XML files, not HTML files, using special tags which are used by the online system to create the webpages in combination with numerical survey data. Instructions are within each file. These are copies (and may be out of date), the master copies are in troggle/templates/dataformat/ .
</p>