2020-03-02 17:23:44 +00:00
<!DOCTYPE html>
2020-03-01 22:22:21 +00:00
< html >
< head >
2020-03-02 17:23:44 +00:00
< meta http-equiv = "Content-Type" content = "text/html; charset=utf-8" / >
2022-06-22 22:59:33 +01:00
< meta http-equiv = "Content-Type" content = "text/html; charset=utf8" / >
2020-03-01 22:22:21 +00:00
< title > Handbook placeholder page< / title >
< link rel = "stylesheet" type = "text/css" href = "../../css/main2.css" / >
< / head >
< body >
< h2 id = "tophead" > CUCC Expedition Handbook< / h2 >
< h1 > Cave data file< / h1 >
2020-04-11 17:46:18 +01:00
< p > These files live in < span style = "font-family: monospace" > :expoweb:/cave_data/< / span >
2020-03-01 22:22:21 +00:00
< p > The example full format below is of a very simple cave with hardly any fields filled in. The most vital field is
2021-04-14 01:47:41 +01:00
< code > < url> 1623/4< /url> < / code >
at the bottom as this shows that the cave descripition data is in < code > :expoweb:/cave_data/1623-2.html< / code >
There will only be an additional description file for large and complex caves.
2020-03-01 22:22:21 +00:00
<!-- it would be nice to find something that colourises this in HTML -->
< pre > < code > < !-- Only put one cave in this file -->
< !-- If you edit this file, make sure you update the websites database -->
< html lang="en">
< head>
< meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
< /head>
< body>
< cave>
2020-03-02 17:23:44 +00:00
< non_public> True< /non_public>
< caveslug> 1623-4< /caveslug>
< official_name> Ritscherbachhö hle< /official_name>
< area> 1623< /area>
< area> 11< /area>
< kataster_code> 1/T(W) +< /kataster_code>
< kataster_number> 4< /kataster_number>
< unofficial_number> < /unofficial_number>
2020-03-01 22:22:21 +00:00
2020-03-02 17:23:44 +00:00
< entrance>
< entranceslug> 1623-4< /entranceslug>
< letter> < /letter>
< /entrance>
2020-03-01 22:22:21 +00:00
2020-03-02 17:23:44 +00:00
< explorers> Hö hlenforschervereinigung Altaussee, 1937< /explorers>
< underground_description> < /underground_description>
< equipment> < /equipment>
< references> < /references>
< survey> Plan at 1:100 by Alfred Auer, 1968 < /survey>
< kataster_status> < /kataster_status>
< underground_centre_line> < /underground_centre_line>
< notes> < /notes>
< length> 12.3m< /length>
< depth> 1.07m< /depth>
< extent> < /extent>
< survex_file> < /survex_file>
2021-04-14 01:47:41 +01:00
< description_file> < /description_file>
< url> 1623/4< /url>
2020-03-01 22:22:21 +00:00
< /cave>
< /body>
< /html>
< / code > < / pre >
<!-- Yes we should not be using the <tt> "teletype" tag as it is deprecated. -->
< p > As you can see, this is an XML tag format similar to HTML but with tags defined to hold cave survey data. These files are processed by troggle in real-time to produce an HTML file on the fly which is sent to your browser so that it
2023-07-09 10:28:40 +01:00
looks < a href = "http://expo.survex.com/1623/4" > like this< / a >
2020-03-01 22:22:21 +00:00
2020-03-02 17:23:44 +00:00
< p > An explanation of what the field names mean and how they are used is on
the < a href = "caveentryfields.html" > cave entry fields< / a > page. There is not an exact correspondance between
the form and the file format however.
2020-03-01 22:22:21 +00:00
< p > When you fill in the online form you creating a file just like the one above: troggle takes the input data from the form and creates the file. Troggle also stores the cave information in it's live memory when you use the form method.
< p > If instead of using the form you create the file by hand and upload it to the server you will also need find a nerd to run the cave import procedure before troggle "knows" that the cave exists.
< h3 > Cave entrances< / h3 >
2020-04-11 17:46:18 +01:00
< p > There is < a href = "newentrancefile.html" > an exactly analogous file< / a > for cave entrances except that those files live in < span style = "font-family: monospace" > :expoweb:/entrance_data/< / span >
2020-05-26 00:26:14 +01:00
< h3 > Template Files - please use these< / h3 >
< p >
There are template files for you to fill-in when creating new caves and entrance in the online system. Download them:
< ul >
< li > < a download href = "../../templates/cave_data.html" > cave_data template< / a >
< li > < a download href = "../../templates/entrance_data.html" > entrance_data template< / a >
< / ul >
These are XML files, exactly as shown above, but with extensive instructions within each file.
< / p >
2020-03-01 22:22:21 +00:00
< h2 > File layout< / h2 >
2020-04-11 17:46:18 +01:00
< p > The caves in our site are stored as XML files in the directory < tt > :expoweb:/cave_data< / tt > and in
2021-04-14 01:47:41 +01:00
files named < tt > :expoweb:/cave_data/{area}-{cavenumber}.html< / tt > . Entrances are correspondingly
2020-04-11 17:46:18 +01:00
in < tt > :expoweb:/entrance_data< / tt > files, with the same naming convention, except that if
there is more than one entrance they have a,b,c suffixes, e.g. < tt > :expoweb:/< b > entrance< / b > _data/{area}-{cavenumber}b< / tt >
2020-03-01 22:22:21 +00:00
< p > < / p > Any < em > associated files< / em > , usually photos and surveys, are
2021-04-14 01:47:41 +01:00
stored under the area names < tt > :expoweb:/1623/{cavenumber}/ent_photo1.jpg< / tt > or < tt > :expoweb:/1626/{cavenumber}/< / tt >
2020-03-01 22:22:21 +00:00
Note that this is a different naming convention: caves and entrances have the {area} as < em >
part of the file name
< / em >
whereas associated files have the {area} < em > as a directory< / em > in which the files are stored.
< p > An
understanding of this file layout is very important when filling in the forms or writing the tags so that images
appear on the final published website. The URLs in the XML file < em > should be relative URLs< / em > to the cave page, which < em > appears< / em >
2021-04-14 01:47:41 +01:00
as < tt > cave/{area}/{cavenumber}< / tt > on the website even though < em > internally< / em > the data
is coming from < tt > cave_data/{area}-{cavenumber}.html and entrance_data/{area}-{cavenumber}.html< / tt > < / p >
2021-05-04 15:41:17 +01:00
< h3 > Handy tips for images< / h3 >
< p > Cave description files get moved about quite a bit while a cave is being actively explored. And even if the files are not moved, the user-visible URL can move (remember the 171 and 172 caves had different levels of nesting in the url). Doing either of those breaks all the image links
< em > unless< / em > you do it like this:
< ul >
< li > Do not use relative links like this < var > href = "../imgs/2020_w_01/deepandsqualid/camp5.jpg"< / var >
< li > Put all the images for a cave into the same folder, and use absolute links: < var > href = "/1623/2020_w_01/i/camp5.jpg"< / var > with a leading slash "/".
< li > A common idiom is to have subfolders "/i/", "/t/" and "/l/" containing respectively the full image (~600 pixels across), a thumbnail image, and an HTML file fragment of the big image with descriptive text.
< / ul >
2020-03-01 22:22:21 +00:00
< hr / >
< p > Back to the form-filling method
< a href = "caveentry.html" > the form-filling method< / a > guide
2022-06-24 15:26:20 +01:00
< hr / > < / body >
2020-03-01 22:22:21 +00:00
< / html >
