expoweb/handbook/survey/caveentry.html

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<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, and how to enter new
    caves and entrances, and especially how to add images/surveys so that they appear.</p>

<p>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).

  <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' 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). Matches the </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/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>(<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.</dd>
  </dl>
  <dl>
    <dt>underground_description</dt>
    <dd>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.</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.</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.</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.</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).</dd>
  </dl>
  <dl>
    <dt>underground_centre_line</dt>
    <dd>'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'.</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.</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 survey file for this cave. Relative to the 'loser' survex repository. So for most caves that's &quot;caves/cavenum/cavnum.svx&quot;. (e.g. caves/204/204.svx</dd>
  </dl>
  <dl>
    <dt>description_file</dt>
    <dd>Name of top-level description file for this cave, when a separate file is used. Otherwise blank.</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. Normally <tt>area/cavenum.html</tt>, e.g ('1623/165.html')</dd>
  </dl>


</body>
<html>
STylistic rearrangements 2018-08-02 16:06:49 +01:00			`<html>`
Create new page dpocumenting new cave entry process/fields 2017-12-07 03:25:11 +00:00			`<head>`
STylistic rearrangements 2018-08-02 16:06:49 +01:00			`<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />`
			`<title>CUCC Expedition Handbook: Cave entry field</title>`
moving a couple of files into /computing/ folder and updating links 2020-03-01 19:23:17 +00:00			`<link rel="stylesheet" type="text/css" href="../../css/main2.css" />`
Create new page dpocumenting new cave entry process/fields 2017-12-07 03:25:11 +00:00			`</head>`
			`<body>`
STylistic rearrangements 2018-08-02 16:06:49 +01:00			`<h2 id="tophead">CUCC Expedition Handbook</h2>`

Create new page dpocumenting new cave entry process/fields 2017-12-07 03:25:11 +00:00			`<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>`

More wallet documentation and links to troggle reporting 2019-04-02 00:54:05 +01:00			`<p>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).`

Create new page dpocumenting new cave entry process/fields 2017-12-07 03:25:11 +00:00			`<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>`
Add info on all new-cave fields to handbook 'caveentry' page 2017-12-26 01:43:50 +00:00
Create new page dpocumenting new cave entry process/fields 2017-12-07 03:25:11 +00:00			`<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>`
Add info on all new-cave fields to handbook 'caveentry' page 2017-12-26 01:43:50 +00:00
Create new page dpocumenting new cave entry process/fields 2017-12-07 03:25:11 +00:00			`<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`
Add info on all new-cave fields to handbook 'caveentry' page 2017-12-26 01:43:50 +00:00			`are normally public, so enter 'False' unless you know otherwise.</dd>`
Create new page dpocumenting new cave entry process/fields 2017-12-07 03:25:11 +00:00			`</dl>`
			`<dl>`
			`<dt>caveslug</dt>`
Add info on all new-cave fields to handbook 'caveentry' page 2017-12-26 01:43:50 +00: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). Matches the </dd>`
Create new page dpocumenting new cave entry process/fields 2017-12-07 03:25:11 +00:00			`</dl>`
			`<dl>`
			`<dt>area</dt>`
Add info on all new-cave fields to handbook 'caveentry' page 2017-12-26 01:43:50 +00:00			`<dd>(<i>Required</i>).The Kataster area (always 1623 or 1626). It's important to get this right, especially`
Create new page dpocumenting new cave entry process/fields 2017-12-07 03:25:11 +00:00			`if near the border between the two areas. 1623 is our main area, but the border is not too far beyond the Stone`
Add info on all new-cave fields to handbook 'caveentry' page 2017-12-26 01:43:50 +00:00			`Bridge so since 2014 some of our caves are in 1626.</dd>`
Create new page dpocumenting new cave entry process/fields 2017-12-07 03:25:11 +00:00			`</dl>`
			`<dl>`
			`<dt>area</dt>`
			`<dd>Yes - there really are two different fields, both called 'area'. Bonkers. This second`
Add info on all new-cave fields to handbook 'caveentry' page 2017-12-26 01:43:50 +00:00			`one is the CUCC-defined areas shown in <a href="/areas.htm">this plan</a>.</dd>`
Create new page dpocumenting new cave entry process/fields 2017-12-07 03:25:11 +00:00			`</dl>`
			`<dl>`
			`<dt>kataster_code</dt>`
			`<dd>The length/depth code used in the Austrian kataster. This may be autogenerated if you`
Add info on all new-cave fields to handbook 'caveentry' page 2017-12-26 01:43:50 +00:00			`don't enter one.</dd>`
Create new page dpocumenting new cave entry process/fields 2017-12-07 03:25:11 +00:00			`</dl>`
			`<dl>`
			`<dt>kataster_number</dt>`
Add info on all new-cave fields to handbook 'caveentry' page 2017-12-26 01:43:50 +00:00			`<dd>(<i>Either this or unofficial_number is required</i>). Offical number in Austrian kataster if one has been allocated.</dd>`
Create new page dpocumenting new cave entry process/fields 2017-12-07 03:25:11 +00:00			`</dl>`
			`<dl>`
			`<dt>unofficial_number</dt>`
More wallet documentation and links to troggle reporting 2019-04-02 00:54:05 +01:00			`<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>`
Create new page dpocumenting new cave entry process/fields 2017-12-07 03:25:11 +00:00			`</dl>`
			`<dl>`
			`<dt>entrance</dt>`
Add info on all new-cave fields to handbook 'caveentry' page 2017-12-26 01:43:50 +00:00			`<dd>Enclosing tag for each entrance, containing an entranceslug ID and a letter (if more than one entrance)</dd>`
Create new page dpocumenting new cave entry process/fields 2017-12-07 03:25:11 +00:00			`</dl>`
			`<dl>`
			`<dt>entranceslug</dt>`
Add info on all new-cave fields to handbook 'caveentry' page 2017-12-26 01:43:50 +00:00			`<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>`
Create new page dpocumenting new cave entry process/fields 2017-12-07 03:25:11 +00:00			`</dl>`
			`<dl>`
			`<dt>letter</dt>`
Add info on all new-cave fields to handbook 'caveentry' page 2017-12-26 01:43:50 +00:00			`<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>`
Create new page dpocumenting new cave entry process/fields 2017-12-07 03:25:11 +00:00			`</dl>`
			`<dl>`
			`<dt>explorers</dt>`
Add info on all new-cave fields to handbook 'caveentry' page 2017-12-26 01:43:50 +00: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.</dd>`
Create new page dpocumenting new cave entry process/fields 2017-12-07 03:25:11 +00:00			`</dl>`
			`<dl>`
			`<dt>underground_description</dt>`
Add info on all new-cave fields to handbook 'caveentry' page 2017-12-26 01:43:50 +00:00			`<dd>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.</dd>`
Create new page dpocumenting new cave entry process/fields 2017-12-07 03:25:11 +00:00			`</dl>`
			`<dl>`
			`<dt>equipment</dt>`
Add info on all new-cave fields to handbook 'caveentry' page 2017-12-26 01:43:50 +00: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.</dd>`
Create new page dpocumenting new cave entry process/fields 2017-12-07 03:25:11 +00:00			`</dl>`
			`<dl>`
			`<dt>references</dt>`
Add info on all new-cave fields to handbook 'caveentry' page 2017-12-26 01:43:50 +00:00			`<dd>References to documentation. Could be Journal articles or Logbook entries. Can be links if the docs are online.</dd>`
Create new page dpocumenting new cave entry process/fields 2017-12-07 03:25:11 +00:00			`</dl>`
			`<dl>`
			`<dt>survey</dt>`
Add info on all new-cave fields to handbook 'caveentry' page 2017-12-26 01:43:50 +00: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.</dd>`
Create new page dpocumenting new cave entry process/fields 2017-12-07 03:25:11 +00:00			`</dl>`
			`<dl>`
			`<dt>kataster_status</dt>`
Add info on all new-cave fields to handbook 'caveentry' page 2017-12-26 01:43:50 +00: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).</dd>`
Create new page dpocumenting new cave entry process/fields 2017-12-07 03:25:11 +00:00			`</dl>`
			`<dl>`
			`<dt>underground_centre_line</dt>`
Add info on all new-cave fields to handbook 'caveentry' page 2017-12-26 01:43:50 +00:00			`<dd>'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'.</dd>`
Create new page dpocumenting new cave entry process/fields 2017-12-07 03:25:11 +00:00			`</dl>`
			`<dl>`
			`<dt>notes</dt>`
Add info on all new-cave fields to handbook 'caveentry' page 2017-12-26 01:43:50 +00:00			`<dd>Normally empty, but place for anything else that should be noted, such as info on cave maybe being a duplicate, or lost.</dd>`
Create new page dpocumenting new cave entry process/fields 2017-12-07 03:25:11 +00:00			`</dl>`
			`<dl>`
			`<dt>length</dt>`
Add info on all new-cave fields to handbook 'caveentry' page 2017-12-26 01:43:50 +00:00			`<dd>Cave length. Can be left blank and system should fill it in automatically from survey data (it doesn't yet)</dd>`
Create new page dpocumenting new cave entry process/fields 2017-12-07 03:25:11 +00:00			`</dl>`
			`<dl>`
			`<dt>depth</dt>`
Add info on all new-cave fields to handbook 'caveentry' page 2017-12-26 01:43:50 +00:00			`<dd>Cave depth. Can be left blank and system should fill it in automatically from survey data (it doesn't yet)</dd>`
Create new page dpocumenting new cave entry process/fields 2017-12-07 03:25:11 +00:00			`</dl>`
			`<dl>`
			`<dt>extent</dt>`
Add info on all new-cave fields to handbook 'caveentry' page 2017-12-26 01:43:50 +00:00			`<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>`
Create new page dpocumenting new cave entry process/fields 2017-12-07 03:25:11 +00:00			`</dl>`
			`<dl>`
			`<dt>survex_file</dt>`
Add info on all new-cave fields to handbook 'caveentry' page 2017-12-26 01:43:50 +00:00			`<dd>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</dd>`
Create new page dpocumenting new cave entry process/fields 2017-12-07 03:25:11 +00:00			`</dl>`
			`<dl>`
			`<dt>description_file</dt>`
Add info on all new-cave fields to handbook 'caveentry' page 2017-12-26 01:43:50 +00:00			`<dd>Name of top-level description file for this cave, when a separate file is used. Otherwise blank.</dd>`
Create new page dpocumenting new cave entry process/fields 2017-12-07 03:25:11 +00:00			`</dl>`
			`<dl>`
			`<dt>url</dt>`
Add info on all new-cave fields to handbook 'caveentry' page 2017-12-26 01:43:50 +00:00			`<dd>(<i>Required</i>). URL of this cave. i.e the URL this cave appears at on the website. Normally <tt>area/cavenum.html</tt>, e.g ('1623/165.html')</dd>`
Create new page dpocumenting new cave entry process/fields 2017-12-07 03:25:11 +00:00			`</dl>`


Add info on all new-cave fields to handbook 'caveentry' page 2017-12-26 01:43:50 +00:00
Create new page dpocumenting new cave entry process/fields 2017-12-07 03:25:11 +00:00			`</body>`
			`<html>`