cave entry documentation

This commit is contained in:
Philip Sargent
2021-04-12 23:07:23 +01:00
parent 228b44fe0e
commit 8505627b4d
2 changed files with 17 additions and 21 deletions

View File

@@ -96,7 +96,7 @@
</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'. HTML freeform field..</dd>
<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>
@@ -116,15 +116,15 @@
</dl>
<dl>
<dt>survex_file</dt>
<dd>Name of top-level survey file for this cave. Relative to the 'loser' <a href="../computing/repos.html">survex repository</a>. So for most caves that's &quot;caves/cavenum/cavenum.svx&quot;. (e.g. caves/204/204.svx</dd>
<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>Name of top-level description file for this cave, when a separate file is used. Used instead of above entrance_description field. Blank if description is in that field.</dd>
<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. Normally <tt>area/cavenum.html</tt>, e.g ('1623/165.html')</dd>
<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 />