Cave description editing

This commit is contained in:
Philip Sargent 2022-03-20 00:31:49 +00:00
parent c83a84ad2d
commit 045b5f8eb1
8 changed files with 89 additions and 4 deletions

View File

@ -23,6 +23,10 @@ unavoidable complexities in getting the GPX file out of your device.
<p><em>(If you are looking for how to upload some photos instead, those instructions are
<a href="uploading.html">here</a>)</em>.
<h3>TEMPORARY FIX 2022</h3>
<p>The form to make this easy is not yet written [March 2022]. So use the <a href="/photoupload/">Photo Upload Form</a> which
temporarily will also work for GPX files.
<h3>Instructions: contents</h3>
<ol>
<li><a href="#getgpx">Get the GPX file</a> that holds your locations and wanderings from your phone.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 523 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 170 KiB

View File

@ -26,7 +26,6 @@
<a href="qmentry.html">the QMs</a> and before the <var>*end</var> .
<p>The description is written as a single long line of text. In the online editor it is wrapped to fit the window.
<code>
;------------<br />
;Cave description ;(leave commented-out)<br />
@ -43,10 +42,81 @@ straighforward p10.
<p>You can have several lines of description, as you can see if you follow the link above, but each one must be
prefixed with a semi-colon otherwise the survex software will complain.
<p style="margin:4%">
<em>Technical Note:</em> The syntax for a Cave Description, both the title and the text includes a leading semi-colon.
So it is syntactically a "comment" so far as the survex software is concerned.
So it is syntactically a "comment" so far as <a href="https://survex.com/docs/manual/datafile.htm">the survex software</a>
is concerned.
<h2>In the Cave Definition file</h2>
<p>When you look at a cave listed in the list on the "<a href="/caves/">Caves"</a>" page, such as <a
href="/1623/290/290.html">/1623/290/290.html</a>, and you click on "Edit this cave" in the left-hand menu when you are
logged-on, you will see the Cave Registration <a href="/1623-290_cave_edit/">editing and update form</a>.
All the cave description you read on the Cave
page is set in the text box "Underground description" on the form in
<a href="https://www.w3schools.com/html/html_paragraphs.asp">HTML</a>.
<p>So for an existing cave, where someone has already done the
<a href="caveentry.html">initial cave registration process</a>, you can easily add in your description of your new
passage by cutting and pasting from your survex file, e.g.
<a href="/survexfile/caves-1623/2017-cucc-28/toto_to_crystalcrumble.svx">toto_to_crystalcrumble.svx</a> into the
end of the text in the "Underground description" text box.
<p>You can drag the corners of the "Underground description" text box on the cave registration form to make it easier to edit the HTML.
Just separate the paragraphs with &lt;P&gt; codes and it will work. (You don't need the semi-colons any more.)
<p style="margin:4%">
<em>Technical Note:</em> The information in the cave registration form is saved to the server as a file, which is
committed to the version control system automatically, as
well as being registered in the online database used by the website publication software. If you are a nerd with a
<a href="../computing/basiclaptop.html#basic"><var>basic expo laptop</var></a>, you can edit the file directly.
For Fischgesicht (originally 2017-CUCC-28 and now 1623/290), this is in the
<var>:expoweb:</var> repo, in <var>/cave_data/1623-290.html</var>, but you will have to manage the git commit process yourself.
<p>Fischgesicht currently (pre-2022 expo) has 25 survex files (listed <a href="/survexfile/2017-cucc-28">here</a>
now, or <a href="/survexfile/caves-1623/290/290.svx">here</a> in future). You could do a useful job by
checking all those survex files to see if the cave description in them has already been copied into the cave registration form
"Underground description" text box.
<h3>More complex caves</h3>
<p>Fischgesicht currently has only one cave description file. Older, more complex caves such as Balkonh&ouml;hle
have the cave description separated out into several HTML files. The field of the cave registration form "Description file",
which was blank for Fischgesicht, has a filename in it on the Balkonh&ouml;hle form: "<var>1623/264/ent.html</var>"
which is in the <var>:expoweb:</var> repo folder.
<p>Unfortunately, you cannot (yet) use the "Edit This Page" capability to edit those
webpages from any web browser and you will need to use the <var>expo laptop</var> in the potato hut to play
with the files directly. (Or elevate yourself to nerd status and configure your own laptop as a
<a href="../computing/basiclaptop.html#basic"><var>basic expo laptop</var></a> yourself.)
<h3>Adding photographs to cave descriptions</h3>
<p>Cave Schwa H&ouml;hle 1623/81 is a simple cave and if you look at its
<a href="/1623-81_cave_edit/">cave registration form online</a>
and look in the "Survey" field, you will see that the "Survey" text box contains the HTML code for several images of cave surveys
with relative filepaths like this:
<br><pre><code>&lt;img src="../others/82_area_plan.png" alt="Survey" /&gt;
</code></pre>
These are relative to where the cave description will be published, which is specified in the
"URL" field.
<p>The reason why they are relative to the <em>published</em> webpage is that it is your own web browser which is interpreting
the &lt;IMG&gt; link, and it will use that to ask the server for the image.
<p>Now it is a good idea to go and read the "Edit Cave Form" part of the handbook page
<a href="caveentry.html#editcave">Creating a new cave in the online system</a> which compares the two caves 171 and 172 and how their photograph
data is stored slightly differently.
<p>The "URL" field has a helpful hint next to it in square brackets: [1623/000/000] to remind you of the right format
when you are creating a new cave. For this cave
the URL is set to <var>1623/264/264.html</var>. [Note that depsite having ".html" at the end of it, this is not a real file: it is generated by the website publication software to contain
all these bits of information.]
<p> The <em>real</em> file holding the cave description is in the "Description file" field which says
<var>1623/264/ent.html</var> and is in the <var>:expoweb:</var> repo.
<h4>Summary</h4>
<p>So using just a web browser you can edit the HTML for the top-level cave description, and you can add in links to
photos so long as they are already
uploaded to the system in the right place for that cave.
<p>It is instructive to look at the cave registration form for Balkonh&ouml;hle at the same time as
reading the published cave description in another browser window.
You will see how the different parts are assembled into one overall description. You will need to know this before
you can edit the HTML of complex caves directly.
<hr />
Return to "<a href="newsurvex.html">Survey handbook - survex format</a>"<br>

View File

@ -104,7 +104,7 @@ the <a href="/newcave/">New Cave form</a> - but not yet.
<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>
<h3>Edit Cave form</h3>
<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

View File

@ -95,6 +95,7 @@ New cave process
&boxvr;&HorizontalLine;&HorizontalLine; 3 Creating a new survex file
&boxv; &boxvr;&HorizontalLine;&HorizontalLine; How to create a survex file - PDF - Brendan's guide
&boxv; &boxvr;&HorizontalLine;&HorizontalLine; From muddy book to survex plot
&boxv; &boxvr;&HorizontalLine;&HorizontalLine; Cave description
&boxv; &boxur;&HorizontalLine;&HorizontalLine; Adding QMs (Question Marks)
&boxvr;&HorizontalLine;&HorizontalLine; 4 Drawing up your survey
&boxv; &boxvr;&HorizontalLine;&HorizontalLine; How to use Tunnel - PDF - Brendan's guide

View File

@ -127,6 +127,16 @@ straighforward p10.
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.

View File

Before

Width:  |  Height:  |  Size: 61 KiB

After

Width:  |  Height:  |  Size: 61 KiB