expoweb/handbook/survey/caveentryfields.html

<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>CUCC Expedition Handbook: Cave entry field</title>
<link rel="stylesheet" type="text/css" href="../../css/main2.css" />
</head>
<body>
<h2 id="tophead">CUCC Expedition Handbook</h2>

  <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. The same fields appear in each cave_data/ xml file.</p>
  <p>
    Instructions on how to enter the data for new
    caves and entrances, and especially how to add images/surveys so that they appear properly,
    is to be found on the sequence of pages <a href="caveentry.html">starting here</a>.
  </p>
  <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.html">cave_data template</a>
    <li><a download href="../../templates/entrance_data.html">entrance_data template</a>
    </ul>
    These are actually 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.
  </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:

  <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.
<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' unless you know otherwise.</dd>
  </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>
  </dl>
  <dl>
    <dt>area</dt>
    <dd>(<i>Required</i>).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/type/exploration code used in the Austrian kataster. <a href="/katast.htm">Look-up table here</a>.</dd>
  </dl>
  <dl>
    <dt>kataster_number</dt>
    <dd>(<i>Either this or unofficial_number is required</i>). Offical number in Austrian kataster if one has been allocated.</dd>
  </dl>
  <dl>
    <dt>unofficial_number</dt>
    <dd>(<i>Either this or kataster_number is required</i>). 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 <em>will not appear</em> in the caves list (<a href="http://expo.survex.com/caves">Main Index/caves</a>).</dd>
  </dl>
  <dl>
    <dt>entrance</dt>
    <dd>Enclosing tag for each entrance, containing an entranceslug ID and a letter (if more than one entrance)</dd>
  </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>
  </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>
  </dl>
  <dl>
    <dt>explorers</dt>
    <dd>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. HTML freeform field.</dd>
  </dl>
  <dl>
    <dt>underground_description</dt>
    <dd>Underground description (the description of the 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. You can leave this field empty and put a filename in description_file instead, in which case that will be used. HTML freeform field.</dd>
  </dl>
  <dl>
    <dt>equipment</dt>
    <dd>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. HTML freeform field.</dd>
  </dl>
  <dl>
    <dt>references</dt>
    <dd>References to documentation. Could be Journal articles or Logbook entries. Can be links if the docs are online. HTML freeform field.</dd>
  </dl>
  <dl>
    <dt>survey</dt>
    <dd>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. HTML freeform field.</dd>
  </dl>
  <dl>
    <dt>kataster_status</dt>
    <dd>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). HTML freeform field.</dd>
  </dl>
  <dl>
    <dt>underground_centre_line</dt>
    <dd>A text field: set to 'In dataset' if there is a survex file in the right plac ein the Loser repository. Blank if not, or notes about status such as 'surveyed, but no entrance fix so not yet in dataset'. HTML freeform field.</dd>
  </dl>
  <dl>
    <dt>notes</dt>
    <dd>Normally empty, but place for anything else that should be noted, such as info on cave maybe being a duplicate, or lost. HTML freeform field.</dd>
  </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>
  </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>
  </dl>
  <dl>
    <dt>extent</dt>
    <dd>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.</dd>
  </dl>
  <dl>
    <dt>survex_file</dt>
    <dd>Name of top-level survex file for this cave. Relative to the 'loser' <a href="../computing/repos.html">survex repository</a>. So for most caves that's <tt>caves-{area}/cavenum/cavenum.svx</tt> e.g. 'caves-1623/204/204.svx'</dd>
  </dl>
  <dl>
    <dt>description_file</dt>
    <dd>Filename: the name of top-level description file for this cave, when a separate file is used. Used instead of above entrance_description field for large caves with complex descriptions. Blank if the description is in the 'underground_description' field. </dd>
  </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>.
  </dl>

<hr />
<p>Back to <a href="caveentry.html">Cave data entry</a>
<hr />

</body>
<html>
Cave entry - outline documentation plan 2020-03-01 22:22:21 +00:00			`<!DOCTYPE html>`
			`<html>`
			`<head>`
			`<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />`
			`<title>CUCC Expedition Handbook: Cave entry field</title>`
			`<link rel="stylesheet" type="text/css" href="../../css/main2.css" />`
			`</head>`
			`<body>`
			`<h2 id="tophead">CUCC Expedition Handbook</h2>`

			`<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`
Add link to Kataster code info and which fields are free HTML 2020-05-25 01:00:02 +01:00			`some of them are a quite mysterious. This page explains what they mean. The same fields appear in each cave_data/ xml file.</p>`
Cave entry - outline documentation plan 2020-03-01 22:22:21 +00:00			`<p>`
			`Instructions on how to enter the data for new`
			`caves and entrances, and especially how to add images/surveys so that they appear properly,`
			`is to be found on the sequence of pages <a href="caveentry.html">starting here</a>.`
			`</p>`
cave and entrance template files links in handbook 2020-05-26 00:26:14 +01:00			`<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.html">cave_data template</a>`
			`<li><a download href="../../templates/entrance_data.html">entrance_data template</a>`
			`</ul>`
			`These are actually 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.`
			`</p>`
Cave entry - outline documentation plan 2020-03-01 22:22:21 +00:00
control panel working ane logbook export 2021-04-28 02:41:50 +01:00			`<h3>Only two fields are essential</h3>`
			`<p>There are only two essential fields 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.`
Cave entry - outline documentation plan 2020-03-01 22:22:21 +00:00			`<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' unless you know otherwise.</dd>`
			`</dl>`
			`<dl>`
			`<dt>caveslug</dt>`
Add link to Kataster code info and which fields are free HTML 2020-05-25 01:00:02 +01:00			`<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>`
Cave entry - outline documentation plan 2020-03-01 22:22:21 +00:00			`</dl>`
			`<dl>`
			`<dt>area</dt>`
			`<dd>(<i>Required</i>).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>`
Add link to Kataster code info and which fields are free HTML 2020-05-25 01:00:02 +01:00			`<dd>The length/type/exploration code used in the Austrian kataster. <a href="/katast.htm">Look-up table here</a>.</dd>`
Cave entry - outline documentation plan 2020-03-01 22:22:21 +00:00			`</dl>`
			`<dl>`
			`<dt>kataster_number</dt>`
			`<dd>(<i>Either this or unofficial_number is required</i>). Offical number in Austrian kataster if one has been allocated.</dd>`
			`</dl>`
			`<dl>`
			`<dt>unofficial_number</dt>`
			`<dd>(<i>Either this or kataster_number is required</i>). 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 <em>will not appear</em> in the caves list (<a href="http://expo.survex.com/caves">Main Index/caves</a>).</dd>`
			`</dl>`
			`<dl>`
			`<dt>entrance</dt>`
			`<dd>Enclosing tag for each entrance, containing an entranceslug ID and a letter (if more than one entrance)</dd>`
			`</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>`
			`</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>`
			`</dl>`
			`<dl>`
			`<dt>explorers</dt>`
Add link to Kataster code info and which fields are free HTML 2020-05-25 01:00:02 +01:00			`<dd>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. HTML freeform field.</dd>`
Cave entry - outline documentation plan 2020-03-01 22:22:21 +00:00			`</dl>`
			`<dl>`
			`<dt>underground_description</dt>`
Add link to Kataster code info and which fields are free HTML 2020-05-25 01:00:02 +01:00			`<dd>Underground description (the description of the 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. You can leave this field empty and put a filename in description_file instead, in which case that will be used. HTML freeform field.</dd>`
Cave entry - outline documentation plan 2020-03-01 22:22:21 +00:00			`</dl>`
			`<dl>`
			`<dt>equipment</dt>`
Add link to Kataster code info and which fields are free HTML 2020-05-25 01:00:02 +01:00			`<dd>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. HTML freeform field.</dd>`
Cave entry - outline documentation plan 2020-03-01 22:22:21 +00:00			`</dl>`
			`<dl>`
			`<dt>references</dt>`
Add link to Kataster code info and which fields are free HTML 2020-05-25 01:00:02 +01:00			`<dd>References to documentation. Could be Journal articles or Logbook entries. Can be links if the docs are online. HTML freeform field.</dd>`
Cave entry - outline documentation plan 2020-03-01 22:22:21 +00:00			`</dl>`
			`<dl>`
			`<dt>survey</dt>`
Add link to Kataster code info and which fields are free HTML 2020-05-25 01:00:02 +01:00			`<dd>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. HTML freeform field.</dd>`
Cave entry - outline documentation plan 2020-03-01 22:22:21 +00:00			`</dl>`
			`<dl>`
			`<dt>kataster_status</dt>`
Add link to Kataster code info and which fields are free HTML 2020-05-25 01:00:02 +01:00			`<dd>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). HTML freeform field.</dd>`
Cave entry - outline documentation plan 2020-03-01 22:22:21 +00:00			`</dl>`
			`<dl>`
			`<dt>underground_centre_line</dt>`
cave entry documentation 2021-04-12 23:07:23 +01:00			`<dd>A text field: set to 'In dataset' if there is a survex file in the right plac ein the Loser repository. Blank if not, or notes about status such as 'surveyed, but no entrance fix so not yet in dataset'. HTML freeform field.</dd>`
Cave entry - outline documentation plan 2020-03-01 22:22:21 +00:00			`</dl>`
			`<dl>`
			`<dt>notes</dt>`
Add link to Kataster code info and which fields are free HTML 2020-05-25 01:00:02 +01:00			`<dd>Normally empty, but place for anything else that should be noted, such as info on cave maybe being a duplicate, or lost. HTML freeform field.</dd>`
Cave entry - outline documentation plan 2020-03-01 22:22:21 +00:00			`</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>`
			`</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>`
			`</dl>`
			`<dl>`
			`<dt>extent</dt>`
			`<dd>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.</dd>`
			`</dl>`
			`<dl>`
			`<dt>survex_file</dt>`
cave entry documentation 2021-04-12 23:07:23 +01:00			`<dd>Name of top-level survex file for this cave. Relative to the 'loser' <a href="../computing/repos.html">survex repository</a>. So for most caves that's <tt>caves-{area}/cavenum/cavenum.svx</tt> e.g. 'caves-1623/204/204.svx'</dd>`
Cave entry - outline documentation plan 2020-03-01 22:22:21 +00:00			`</dl>`
			`<dl>`
			`<dt>description_file</dt>`
cave entry documentation 2021-04-12 23:07:23 +01:00			`<dd>Filename: the name of top-level description file for this cave, when a separate file is used. Used instead of above entrance_description field for large caves with complex descriptions. Blank if the description is in the 'underground_description' field. </dd>`
Cave entry - outline documentation plan 2020-03-01 22:22:21 +00:00			`</dl>`
			`<dl>`
			`<dt>url</dt>`
cave entry documentation 2021-04-12 23:07:23 +01:00			`<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>.`
Cave entry - outline documentation plan 2020-03-01 22:22:21 +00:00			`</dl>`

			`<hr />`
			`<p>Back to <a href="caveentry.html">Cave data entry</a>`
			`<hr />`

			`</body>`
			`<html>`