expoweb/handbook/survey/caveentry.html

168 lines
10 KiB
HTML
Raw Normal View History

<!DOCTYPE html>
2018-08-02 16:06:49 +01:00
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>CUCC Expedition Handbook: Cave data entry</title>
2024-02-09 00:01:17 +00:00
<link rel="stylesheet" type="text/css" href="/css/main2.css" />
</head>
<body>
<body>
<h2 id="tophead">CUCC Expedition Handbook - New Cave data</h2>
<h1>Creating a new cave in the online system</h1>
2018-08-02 16:06:49 +01:00
<h2>Great, I have discovered a new cave...</h2>
<p>If you have not come to this page from the sequence starting at <a href="newcave.html">Starting a New Cave"</a> then go and read that first.
<div style="width:100%;height:50px;background:#C8E1E2" align="center">
This page outlines step 6 of the survey production process. Each step is documented separately.<br />
<!-- Yes we need some proper context-marking here, breadcrumb trails or something.
Maybe a colour scheme for just this sequence of pages
-->
<a href="newcave.html">1</a>
- <a href="newwallet.html">2</a>
- <a href="newsurvex.html">3</a>
- <a href="drawup.htm">4</a>
- <a href="newrig.html">5</a>
- <a href="caveentry.html">6</a>
2021-05-07 20:12:47 +01:00
- <a href="ententry.html">7</a>
- <a href="cavedescription.html">8</a></div>
<h2>Process</h2>
<p>
This page and those following describe the process for creating new
caves and entrances, and especially how to add images/surveys so that they appear correctly online.</p>
</p>
<h3>Two ways of creating a new cave in the online system</h3>
<ul>
<li>Filling in the online form</li>
<li>Editing a file and uploading it</li>
</ul>
<p>For experienced people creating a batch of small caves the file upload & import process is quicker. Most people won't use this method
for their first cave so it is documented separately in <a href="newcavefile.html">new cave file method</a>.
<p>In other words you can either add caves (or entrances) using the web-interface
2020-04-26 21:41:21 +01:00
or you can check out the 'expoweb' <a href="../computing/repos.html">repository</a> using the version control system and just edit the files.</p>
<p>Nevertheless you will find it useful when filling out the form for the first time
to have some idea what is going on behind the scenes. So you are recommended to have a quick look
at the <a href="newcavefile.html">new cave file method</a> even if you have no intention of using it.
</p>
<h3>Guidebook description</h3>
<p>
2022-03-19 22:10:27 +00:00
<p>For a simple cave all the description will go into the "New Cave" form as described here. A more complex cave will
have separate HTML files for the different sections and subdirectories to put them all in. Here we only describe the
process for a simple cave.
<p>
Complementing the passage description in vertical bits is a <a href="newrig.html">Rigging
Guide</a>. Keep notes on this as it is the next step after drawing up the survey.
The rigging guide sections will have been written into the logbook, and the passage descriptions will
have been written into the survex files, with more lyrical descriptions written into the logbook for each trip.
<p>Write a <b>passage descriptions</b> by copying and extending the descriptions
2022-03-19 22:10:27 +00:00
given in all the component .svx files. You will have seen how these were created in
the <a
href="cavedescription.html">Cave Description"</a> handbook page.
<p>This should be detailed enough to be
followed by someone in the cave who hasn't been there before, and should
include all passage names, lengths of pitches and climbs, compass directions
when this makes left/right/ahead clearer. If your passage is a connection
it is worth while writing descriptions from both directions. You will copy the collected descriptions
into the online system using the "New Cave" form but for now just ensure that you
have it all collected together.
<p>In
written descriptions, underline passage names the first time they are
mentioned, or when they are "defined".</p>
<p>
If it is a complex cave, you will type this description, and pass it on to someone more nerdy who
will file it in the right place. For a simple cave you can do it all yourself with the
the <a href="/newcave/">New Cave form</a> - but not yet.
<h3>Guidebook description formatting</h3>
<p>You are typing an HTML fragment which will be assembled into a complete page. So follow our usual rules about
<a href="../computing/hbmanual1.html#images">putting images in Handbook pages</a> and <a href="../logbooks.html#format">writing HTML in logbooks</a>
<h2>Recommended procedure</h2>
<p>
You will find the process a lot easier to follow if you Edit an existing cave first, because then you can see all the necesary
fields filled in. You can then fill out the form for your new cave using that as an example to follow. But of course be
very careful not to actually chenge anything on the form you have open for editing.
</p>
2021-04-25 00:44:40 +01:00
<h3>New Cave Number</h3>
2021-04-25 00:44:40 +01:00
<p>For a totally new cave you will be using a temporary number such as 2017-CUCC-24 or 2018-dm-07, not an Austrian official-issued Kataster number. But you may have been surveying a new passage in an established cave in which case you will need to find out if it has recently been issued with a Kataster number.
<p>The list in the "<a href="/caves">Caves</a>" page (the menu item "Caves" in the vertical menu in the top-left of the page you are reading now)
shows all the caves which have been already "created" within the online system. You can see a slightly-more updated list in the
<a href="../../noinfo/cave-number-index">Cave Number Index</a> which includes caves which are in the process of being registered but may not have been "created" using either of the two methods described here.
2021-04-25 00:44:40 +01:00
<h3>New Cave form</h3>
2021-04-25 00:44:40 +01:00
<p>The links to follow to open up the "New Cave" form or the "Edit Cave" forms are
2021-04-25 00:44:40 +01:00
somewhat obscure.
Go to the main cave index page which lists all the caves: <a href="/caves">Cave Index</a>
2021-04-25 00:44:40 +01:00
and on the right of the page, between the 1626 caves and the 1623 caves, it says<br />
<a href="/newcave/">New Cave</a><br /> just above where it also says "Cave Number Index - kept updated".<br /> But don't click on it yet, first we will edit an old cave.
</p>
2022-03-20 00:31:49 +00:00
<h3 id="editcave">Edit Cave form</h3>
<p>
First make sure that you are logged-in to the troggle website. You almost certainly are already,
but if you are trying this on a new machine this can catch you out. Go to
2021-04-25 00:44:40 +01:00
<a href="/accounts/login/">/accounts/login/</a>.
The username is "expo" and the password is the usual "{cavey}:{beery}" one.
</p>
<ul>
<li>
2023-11-02 22:08:52 +00:00
Now open the cave page for an existing cave, e.g. <a href="/1623/172/172.html">Plateauh&ouml;hle 172</a>.
</li>
2023-11-02 22:08:52 +00:00
<li>Now you are looking at the description of the cave. Take a moment to look at the URL in the title bar of your browser: the URL is <var>/1623/172/172.html</var>. Remember this, we will come back to it.
2021-04-25 00:44:40 +01:00
<li>
Now you can see a new option saying
<a href="1623-4/edit/" >"Edit this cave"</a> at the bottom of the top left-hand menu.
It has a little icon of a pen next to it. But don't click on it yet.</li>
<li>First, scroll down the page until you see the heading "Entrances". This cave has only one entrance but other caves may have more. You can see that the information about the entrance, including the all-important photograph, is indented slightly to indicate that this is Entrance information, not Cave information.
<li>Just under the heading "Entrances" there is a link "Edit". This will take you to the form for editing entrances, not the form for editing caves.
<li>Now go the left-hand menu and look for the option "Edit this cave"
2020-03-01 23:17:02 +00:00
<li>Click on it. A form appears.</li> <!-- a pirate steals your survey. -->
<li>
2021-04-25 00:44:40 +01:00
Scroll down the page - it is a long form - and look at the "URL" field.
This is the critical field to get right when you create your own cave using the New Cave form. The URL is where your cave will be published by the system, so if you put something strange here, no one will be able to find it. This field is where you tell the system where you want the cave description to be published.
<br>Some of the fields are expandable (you can drag the bottom-right corner to make the box bigger).
</li>
</ul>
2021-04-25 00:44:40 +01:00
<p>Now let's look at another cave:
<ul>
<li>The cave nearby: <a href="/1623/171/171.html">Plateauh&ouml;hle 171</a>.
<li>Here you can see that it has two entrances.
2023-11-02 22:08:52 +00:00
<li>Take a note of the URL: <var>/1623/171/171.html</var>.
2021-04-25 00:44:40 +01:00
<li>Now go the left-hand menu and click on "Edit this cave"
2023-11-02 22:08:52 +00:00
<li>You can see that both entrances are listed at the bottom of the form, and that the URL field matches the one you saw for the cave description: <var>/1623/171/171.html</var>.
<li>Cave 171 has a lot of photographs associated with it (unlike 172), and these photos have been put in a separate folder /171/ . This is why we have what appeared to be a redundant part of the URL in the other cave: if there are photos, we need somewhere to put them.
2021-04-25 00:44:40 +01:00
<li>This cave also has a correct link to a survex file under the heading "Survex File"
Click on <a href="/survexfile/caves-1623/171/171.svx">This survex file</a> and you can see the names and details of the survey done in 2016 by Jenny and Olly.
Click on '3d download' in the cave description page and you will open the centreline in 3d on your computer - if you have survex installed (which you should do: Olly wrote it and he will be upset if you don't).
2021-04-25 00:44:40 +01:00
</ul>
<p>Behind the scenes, you are editing different .xml files for the cave and for each entrance.
Troggle collects these together to make an XML page for the cave (or entrance).
So each field you fill in on the form may contain arbitrary HTML. Be careful!</p>
<h2>List of New Cave/Cave_data fields</h2>
<p>The full list of fields is documented: <a href="caveentryfields.html">the full list of data-entry fields</a> when creating a cave.
<hr />
<p>Back to the previous page in this sequence <a href="newrig.html">New rigging guide</a>.
<br />A side trip to see an explantion of all <a href="caveentryfields.html">the fields on the form</a>
<br />A side trip to see how to do this as a file upload process using git, the <a href="newcavefile.html">cave description data file</a>
2021-05-07 20:12:47 +01:00
<br />Now go the the next page in this sequence <a href="ententry.html">Create a new Entrance record</a>.
2023-11-02 22:08:52 +00:00
<hr /></body>
<html>