From ecd7241cd33f4926cbafd39efddfd5c166f5c128 Mon Sep 17 00:00:00 2001 From: Wookey Date: Thu, 7 Dec 2017 03:25:11 +0000 Subject: [PATCH] Create new page dpocumenting new cave entry process/fields --- handbook/caveentry.html | 139 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 139 insertions(+) create mode 100644 handbook/caveentry.html diff --git a/handbook/caveentry.html b/handbook/caveentry.html new file mode 100644 index 000000000..614317520 --- /dev/null +++ b/handbook/caveentry.html @@ -0,0 +1,139 @@ + + + + + Cave entry fields + + +

Cave entry page fields

+

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.

+ +

Effectively each field is concatenated to make an HTML + page for the cave (or entrance), so each field may contain arbitrary HTML.

+ +

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.

+ +

File layout

+

The caves in our site are stored as XML files under noscript/cave_data and in + files named area-cavenumber. Entrances are correspondingly + in noscript/entrance_data 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 1623 or 1626, 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 area/cavenumber.

+ +

An example will make clear how this works

+

TODO - example of the filelayout

+ + +

List of New Cave/Cave_data fields

+
+
non_public
+
'False' or 'True'. True if the cave should only be visible to logged-in users. Caves + are normally public, so enter 'False'.
+
+
+
caveslug
+
I.D. used to refer to this cave in entrance data files.
+
+
+
area
+
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.
+
+
+
area
+
Yes - there really are two different fields, both called 'area'. Bonkers. This second + one is the CUCC-defined areas shown in this plan.
+
+
+
kataster_code
+
The length/depth code used in the Austrian kataster. This may be autogenerated if you + don't enter one.
+
+
+
kataster_number
+
+
+
+
unofficial_number
+
+
+
+
entrance
+
+
+
+
entranceslug
+
+
+
+
letter
+
+
+
+
explorers
+
+
+
+
underground_description
+
+
+
+
equipment
+
+
+
+
references
+
+
+
+
survey
+
+
+
+
kataster_status
+
+
+
+
underground_centre_line
+
+
+
+
notes
+
+
+
+
length
+
+
+
+
depth
+
+
+
+
extent
+
+
+
+
survex_file
+
+
+
+
description_file
+
+
+
+
url
+
+
+ + + + +