CUCC Expedition Handbook
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.
There is a bug in that the 'new entrance' page which fails unless the entrance has been previously created on another cave. This is being fixed (April 2019).
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' unless you know otherwise.
- caveslug
- (Required). Internal I.D. used to refer to this cave in entrance data files. Typically the same as the filebase (e.g. 1623-195). Matches the
- area
- (Required).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
- (Either this or unofficial_number is required). Offical number in Austrian kataster if one has been allocated.
- unofficial_number
- (Either this or kataster_number is required). Initial temporary cave ID used until kataster number is allocated. (e.g. 2012-DD-01) If you do not give this (or the kataster_number if issued) then your cave will not appear in the caves list (Main Index/caves).
- entrance
- Enclosing tag for each entrance, containing an entranceslug ID and a letter (if more than one entrance)
- entranceslug
- 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.
- letter
- 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.
- explorers
- Club (CUCC) and year(s) of exploration. To distinguish from caves explored by foreign groups. Names can be given too if it was a small cave.
- underground_description
- Underground description. (description of approach and entrance goes in entrance file). For a small cave this will be the entire description. For larger caves it will be the front page of the description, or a short intro, containing links to other pages with the cave description in, or even nothing but a link.
- equipment
- For a small cave, summary of gear needed to descend. For longer caves it could be blank, a table, or just refer to the description/topos. Leave blank if this info is in the description.
- references
- References to documentation. Could be Journal articles or Logbook entries. Can be links if the docs are online.
- survey
- Drawn-up surveys. Scans of paper surveys or images/PDFs of electronic surveys. Should include HTML to display current plan and elevation, with links to larger versions (See section on URLs and files). Could list links to multiple years of survey, or even a separate survey page if it's complicated enough.
- kataster_status
- Normally empty but can be used for notes on process of getting cave into Austrian kataster. (e.g. 'Too small to be in Kataster', 'Number applied for on 'date', awaiting allocated number).
- underground_centre_line
- 'In dataset' if it is in the survex dataset. Blank if not, or notes about status such as 'surveyed, but no entrance fix so not yet in dataset'.
- notes
- Normally empty, but place for anything else that should be noted, such as info on cave maybe being a duplicate, or lost.
- length
- Cave length. Can be left blank and system should fill it in automatically from survey data (it doesn't yet)
- depth
- Cave depth. Can be left blank and system should fill it in automatically from survey data (it doesn't yet)
- extent
- Cave extent(as defined by survex. Not very useful. Best left blank and system could fill it in automatically from survey data (it doesn't yet). We should probably scrap this field.
- survex_file
- Name of top-level survey file for this cave. Relative to the 'loser' survex repository. So for most caves that's "caves/cavenum/cavnum.svx". (e.g. caves/204/204.svx
- description_file
- Name of top-level description file for this cave, when a separate file is used. Otherwise blank.
- url
- (Required). URL of this cave. i.e the URL this cave appears at on the website. Normally area/cavenum.html, e.g ('1623/165.html')