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

Create new page dpocumenting new cave entry process/fields

Browse Source
This commit is contained in:
Wookey
2017-12-07 03:25:11 +00:00
parent 50dc703038
commit ecd7241cd3
1 changed files with 139 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

139
handbook/caveentry.html Normal file
View File

@@ -0,0 +1,139 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN">
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<title>Cave entry fields</title>
</head>
<body>
<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, and how to enter new
caves and entrances, and especially how to add images/surveys so that they appear.</p>
<p>Effectively each field is concatenated to make an HTML
page for the cave (or entrance), so each field may contain arbitrary HTML.</p>
<p>You can either add caves (or entrances) using the web-interface, clicking on 'New Cave') or
'New Entrance'), or you can check out the 'expoweb' repository and just edit the files.</p>
<h2>File layout</h2>
<p>The caves in our site are stored as XML files under <tt>noscript/cave_data</tt> and in
files named <tt>area-cavenumber</tt>. Entrances are correspondingly
in <tt>noscript/entrance_data</tt> files, with the same naming convention, except that if
there is more than one entrance they have a,b,c suffixes. Any associated files, usually photos and surveys, are
stored under the area names <tt>1623</tt> or <tt>1626</tt>, then the cavenumber. An
understanding of this file layout is very important when writing the html so that images
appear as the URLs in the XML file should be relative URLs to the cave page, which appears
as <i>area/cavenumber</i>.</p>
<p>An example will make clear how this works</p>
<p>TODO - example of the filelayout</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'.</dd>
</dl>
<dl>
<dt>caveslug</dt>
<dd>I.D. used to refer to this cave in entrance data files.</dd>
</dl>
<dl>
<dt>area</dt>
<dd>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></dd>
</dl>
<dl>
<dt>unofficial_number</dt>
<dd></dd>
</dl>
<dl>
<dt>entrance</dt>
<dd></dd>
</dl>
<dl>
<dt>entranceslug</dt>
<dd></dd>
</dl>
<dl>
<dt>letter</dt>
<dd></dd>
</dl>
<dl>
<dt>explorers</dt>
<dd></dd>
</dl>
<dl>
<dt>underground_description</dt>
<dd></dd>
</dl>
<dl>
<dt>equipment</dt>
<dd></dd>
</dl>
<dl>
<dt>references</dt>
<dd></dd>
</dl>
<dl>
<dt>survey</dt>
<dd></dd>
</dl>
<dl>
<dt>kataster_status</dt>
<dd></dd>
</dl>
<dl>
<dt>underground_centre_line</dt>
<dd></dd>
</dl>
<dl>
<dt>notes</dt>
<dd></dd>
</dl>
<dl>
<dt>length</dt>
<dd></dd>
</dl>
<dl>
<dt>depth</dt>
<dd></dd>
</dl>
<dl>
<dt>extent</dt>
<dd></dd>
</dl>
<dl>
<dt>survex_file</dt>
<dd></dd>
</dl>
<dl>
<dt>description_file</dt>
<dd></dd>
</dl>
<dl>
<dt>url</dt>
<dd></dd>
</dl>
</body>
<html>