very significantly rearranged instructions on creating survex files

This commit is contained in:
Philip Sargent 2023-07-22 23:56:35 +03:00
parent 391e035ffa
commit 30e1e7864e

View File

@ -28,136 +28,66 @@ This page outlines step 3 of the survey production process. Each step is documen
- <a href="cavedescription.html">8</a>
</div>
<h2>Process</h2>
<p>In principle you do not need any software other than a text editor to create a survex file.
<p>You do not need any software to create a survex file. You can do it using the online editor in your web browser.
So you do not need to have installed survex on your laptop at this point.
</p>
<p>Once you used the online system, which tries to give useful feedback, you can type up survex files using a text editor.
<p>If using a digital survey device, initially cut and paste the surve data from an exported file into the online survex editor form.
<h4 >Two ways to type in survex data</h3>
<ul>
<li>Either you can create a new file and use a text-editor on the <em>expo laptop</em>, as described immediately below,
<li>Or you can use the online system using a web browser from any computer anywhere. This is much, much easier. To do this you need to
be somewhat confident of the name (the 'surveytrip' id) you will be using. Instructions are
<a href="#onlinesvx">at the bottom of this page</a>. <br>[This capability has been broken for many years. It is now fully restored in 2020.]
</ul>
<div class="onleft">
<div class="centre">
<figure>
<a href="/survexfile/caves-1623/204/midlevel/110_bidet.svx">
<img src="notex.jpg" width="700px"></a>
<figcaption style="font-variant-caps: small-caps;">
<em>Typical raw survex data - 'bidet' in Steinbr&uuml;ckenh&ouml;hle, Martin Green 14/8/2000</em>
<em>Typical raw survex data - 'bidet' in Steinbr&uuml;ckenh&ouml;hle, Martin Green 2000-08-14</em> <br />Click to see in online editor.
</figcaption>
</figure>
</div>
<h3 id="survexformat">Typing in the survey data in survex format</h3>
<p>The survey data typed up must include all the notes, including station details and passage
names. Make a backup copy to another machine or USB stick as soon as you have typed it in.
New users will be using the expo laptop to create the .svx file using the online form, not by editing a text file with a text editor.
<h4 id="rightplace">The Right Place</h4>
The new survex data will live in the folder
<pre>
/home/expo/loser/caves-{area}/{cave}/{surveytripid}.svx
</pre>
example:
<pre>
/home/expo/loser/caves-1623/264/mongolrally.svx
</pre>
and tell someone nerdy when you have finished and they will
ensure that it is <em>saved, committed, </em>and<em> pushed</em> appropriately to the :loser: repo.
<p>If you have several parts of the cave surveyed on one trip, create several distinct .svx files.
<h4 >Two ways to type in survex data</h3>
<ul>
<li><a href="/expofiles/documents/surveying/survex-guide.pdf">How to create a survex file</a> - PDF - Brendan's guide.
<li><a href="getin.htm">From muddy book to survex plot</a> - the survex file format (to be revised)
<li><a href="qmentry.html">How to add QM data and cave descriptions</a> - and why this is vital
<li><font color=red>[survex software docm.]</font> <a href="https://survex.com/docs/manual/svxhowto.htm">Contents of .svx files</a> - How do I?
<li><font color=red>[survex software docm.]</font> <a href="https://survex.com/docs/manual/genhowto.htm">How do I Create a new survey</a> - example with several surveys joined
<li><font color=red>[survex software docm.]</font> <a href="https://survex.com/docs/manual/datafile.htm">Survex data files</a> - all the sections and keywords explained
<li><font color=red>[tunnel software docm.]</font> <a href="/expofiles/tunnelwiki/wiki/pages/File_Formats.html">Survex data files</a> - introduction and explanation
<li>Use the online system using a web browser from any computer anywhere. You will need to
be somewhat confident of the name (the 'surveytrip' id) you will be using, which will typically be the name of your new passage (e.g. "easybimble")
and the number used for the cave: either an existing one such as 1623-290 or a completely new one such as 2050-BH-03.
<li>Or you can create a new file with a text-editor on the <em>expo laptop</em>. Instructions are
<a href="#survexformat">at the bottom of this page</a>.
</ul>
<p>Once you have created the .svx file you will run survex to check that your format is correct without typos
and to generate a centre line. Then you will print the survey line,
manually transcribe your sketches from the wallet notes onto that paper,
scan it again and then use that scanned image to digitise passage layout into tunnel or therion.
<ul>
<li><a href="athome.htm">Back in the UK</a> - not really part of the process
<li><a href="/expofiles/presentations/cave_surveying_20130626.pdf">Cave Surveying - training course slidepack</a>
<li><a href="../survexhistory96.htm">History of Survex (1996)</a></li>
</ul>
<p>[Nerds: survex cave data belongs in the <a href="../computing/repos.html">repository</a> :loser: so e.g.
:loser:/caves-1623/264/mongolrally.svx". We are assuming that normal users have never
worked with an distributed version control system at this point which is why we are only
telling them to use the <em>expo laptop</em>.]
<h3><a id="tickqm">Entering the QM data</a></h3>
<p>
QMs are the unexplored leads, they are Question Marks because we don't
know where they go to. There is a specific format for recording them in survex files.
</p>
<p>
Read this <a href="qmentry.html">separate description</a> about
entering the QM data into a survex file.
</p>
<h3><a id="tickingoff">Entering the cave description in the survex file</a></h3>
<p>The last part of the survex file is a description of the passage surveyed. Remember
that this is intended to be read by people
<em>who have not been to that bit of the cave themselves</em>
<code>
;------------<br />
;Cave description ;(leave commented-out)<br />
; See 2017 description for details of GSH up to the 'p50'.
Briefly, on the way to couldashouldawoulda a 22 m entrance crawl from the
surface leads to a climb down and a junction. Left leads to easy c
rawling passage for a short distance, then another junction where
traversing over a shallow hole and down a stooping-height sandy
passage to a sharp left turn and a sandy, easy 'squeeze' leading to a
straighforward p10.
</code>
[from <a href="/survexfile/caves-1623/2017-cucc-24/couldashouldawoulda_to_bathdodgersbypass.svx"><em>couldashouldawoulda_to_bathdodgersbypass.svx</em></a>]
</p>
<p>
Note that the description is often written as one long line. Use the word-wrap capability in your editor
to make it easier for yourself.
See more detail in the <a href="cavedescription.html">Cave Description"</a> handbook page which also describes eventual HTML publication.
<div >
<figure>
<a href="../i/wolfhohle_1983-08-08.jpg">
<img src="../t/wolfhohle_1983-08-08.jpg" ></a>
<figcaption style="font-variant-caps: small-caps;">
Wolfh&ouml;hle raw survey data 1983 - Austrian mud (click to enlarge)
</figcaption>
</figure>
</div>
<h3><a id="onlinesvx">Using the direct online system</a></h3>
<p>This is where you type up the hand-scrawled notes directly into a a web browser, creating a new online survex file automatically in the right place on the online system.
<p>Having confirmed the right name to use for your cave, including whether it is in area 1623 or 1626, e.g.
<p>This is where you type up the hand-scrawled notes directly into a a web browser, creating a new online survex file automatically
in the right place on the online system.
<p>You will be over-writing a template file with lots of comments and optional examples in square brackets,
but first you need to find the right place for everything.
<h4 id="rightplace">The right place</h4>
<p>Having confirmed the right name to use for your passage and your cave, including whether it is in area 1623 or 1626,
the survex file will eventaully be in e.g.
<pre>
caves-1623/2050-cucc-01/easybimble.svx
caves-1623/2050-BH-03/easybimble.svx
</pre>
open a web browser on the equivalent page
The way to start is to open a web browser on the equivalent page
<pre>
http://expo.survex.com/survexfile/caves-{area}/{cave}/{surveytripid}.svx
</pre>
where {area} will be 1623 or 1626, and for a new discovery, {cave} will be something like 2050-BH-01 if it is the third cave disovered by
where {area} will be 1623 or 1626, and for a new discovery, {cave} will be something like 2050-BH-03 if it is the third cave disovered by
Dr. Bunsen Honeydew on the 2050 expo, e.g.
<pre>
<a href="/survexfile/caves-1623/2050-BH-03/easybimble.svx">/survexfile/caves-1623/2050-BH-03/easybimble.svx</a>
</pre>
and a survex-file editing page will open, pre-populated with an example template
for survex data, most of which you will delete and replace. Edit this template and type in your own data.
<p>You can save your work by pressing the "Save this edited svx file" button, but it
<em>Before</em> you click on that link, you need to make sure that you are logged in. In the top-right of troggle-generated pages there is a menu item "Log in", if
all your browser pages are handbook pages, click <a href="/accounts/login/">here</a> to get to the log in page. The username is "expo" and the password
is the usual cavey:beery one which is written up on the whiteboard in the potato hut.
<p>
Now click that link <a href="/survexfile/caves-1623/2050-BH-03/easybimble.svx">/survexfile/caves-1623/2050-BH-03/easybimble.svx</a> and a survex-file editing page will open, pre-populated with an example template
for survex data.
<p>Most of the template data you will delete and replace. Edit this template and type in your own data. OK, so if you have never typed
a survex file before, go to <a href="#newbie">this section</a> below on this page.
<p>If you have several parts of the cave surveyed on one trip, create several distinct .svx files.
<p>You can save your work by pressing the "Save this edited svx file" button <em>below</em> the edit box, but it
will refuse to save until you have hand-edited out all the template material in [square brackets].
<p>As you edit it, you can
press the "Differences between edited and saved versions of this file" and the differences which
@ -216,6 +146,103 @@ URL bar e.g.
and the intermediate directories will be created on the server if they don't already exist. This is in addition to
the directory name which is also the name of your new cave being created automatically.
<h3 id="survexformat">Typing in the survey data with a text editor</h3>
<p>The survey data typed up must include all the notes, including station details and passage
names. A simple copy of the export from a digital device will not do. We need names, dates and description. Make a backup copy to another machine or USB stick as soon as you have typed it in.
<p>
New users will be using the online form to create the .svx file , not by editing a text file with a text editor,
so don't confuse newcomers by showing them how you (an expert, of course) do it.
<p>
The new survex data will live in the folder on the <em>expo laptop</em>:
<pre>
/home/expo/loser/caves-{area}/{cave}/{surveytripid}.svx
</pre>
example:
<pre>
/home/expo/loser/caves-1623/264/mongolrally.svx
</pre>
and tell someone nerdy when you have finished and they will
ensure that it is <em>saved, committed, </em>and<em> pushed</em> appropriately to the :loser: repo. All of which is automatic if you
use the online form.
<h3 id="newbie">What goes in a survex file</h3>
<ul>
<li><a href="/expofiles/documents/surveying/survex-guide.pdf">How to create a survex file</a> - PDF - Brendan's guide.
<li><a href="getin.htm">From muddy book to survex plot</a> - the survex file format (to be revised)
<li><a href="qmentry.html">How to add QM data and cave descriptions</a> - and why this is vital
<li><font color=red>[survex software docm.]</font> <a href="https://survex.com/docs/manual/svxhowto.htm">Contents of .svx files</a> - How do I?
<li><font color=red>[survex software docm.]</font> <a href="https://survex.com/docs/manual/genhowto.htm">How do I Create a new survey</a> - example with several surveys joined
<li><font color=red>[survex software docm.]</font> <a href="https://survex.com/docs/manual/datafile.htm">Survex data files</a> - all the sections and keywords explained
<li><font color=red>[tunnel software docm.]</font> <a href="/expofiles/tunnelwiki/wiki/pages/File_Formats.html">Survex data files</a> - introduction and explanation
</ul>
<p>Once you have created the .svx file you will run survex to check that your format is correct without typos
and to generate a centre line. Then you will print the survey line,
manually transcribe your sketches from the wallet notes onto that paper,
scan it again and then use that scanned image to digitise passage layout into tunnel or therion.
<ul>
<li><a href="athome.htm">Back in the UK</a> - not really part of the process
<li><a href="/expofiles/presentations/cave_surveying_20130626.pdf">Cave Surveying - training course slidepack</a>
<li><a href="../survexhistory96.htm">History of Survex (1996)</a></li>
</ul>
<p>[Nerds: survex cave data belongs in the <a href="../computing/repos.html">repository</a> :loser: so e.g.
:loser:/caves-1623/264/mongolrally.svx". We are assuming that normal users have never
worked with an distributed version control system at this point which is why we are
telling them to use the online form.]
<h3><a id="tickqm">Entering the QM data</a></h3>
<p>
QMs are the unexplored leads, they are Question Marks because we don't
know where they go to. There is a specific format for recording them in survex files.
</p>
<p>
Read this <a href="qmentry.html">separate description</a> about
entering the QM data into a survex file.
</p>
<h3><a id="tickingoff">Entering the cave description in the survex file</a></h3>
<p>The last part of the survex file is a description of the passage surveyed. Remember
that this is intended to be read by people
<em>who have not been to that bit of the cave themselves</em>
<code>
;------------<br />
;Cave description ;(leave commented-out)<br />
; See 2017 description for details of GSH up to the 'p50'.
Briefly, on the way to couldashouldawoulda a 22 m entrance crawl from the
surface leads to a climb down and a junction. Left leads to easy c
rawling passage for a short distance, then another junction where
traversing over a shallow hole and down a stooping-height sandy
passage to a sharp left turn and a sandy, easy 'squeeze' leading to a
straighforward p10.
</code>
[from <a href="/survexfile/caves-1623/2017-cucc-24/couldashouldawoulda_to_bathdodgersbypass.svx"><em>couldashouldawoulda_to_bathdodgersbypass.svx</em></a>]
</p>
<p>
Note that the description is often written as one long line. Use the word-wrap capability in your editor
to make it easier for yourself.
See more detail in the <a href="cavedescription.html">Cave Description"</a> handbook page which also describes eventual HTML publication.
<div >
<figure>
<a href="../i/wolfhohle_1983-08-08.jpg">
<img src="../t/wolfhohle_1983-08-08.jpg" ></a>
<figcaption style="font-variant-caps: small-caps;">
Wolfh&ouml;hle raw survey data 1983 - Austrian mud (click to enlarge)
</figcaption>
</figure>
</div>
<hr />
<p>Back to the previous page in this sequence
<a href="newwallet.html">Creating a new survey wallet</a>.