typing conventions requirements

This commit is contained in:
2023-07-29 18:52:27 +03:00
parent 849e12f3d3
commit 8bb01361b4
2 changed files with 11 additions and 7 deletions

View File

@@ -28,9 +28,13 @@
<p>See below for explanations.
<h3>Names of identifiers and files</h3>
<p>Always use <b>lower case</b> in names of caves, despite what you might see in historical data.
<p>So a new cave would be 2023-zz-01 and its entrances would be 2023-zz-01a, 2023-zz-01b and 2023-zz-01c.
<p>This is to prevent confusion between Windows and Linux machines, and unintentional deletion of data.
<p>Today we use CAPITAL LETTERS for cave names, e.g. 2014-MF-03, but <b>lower case</b> for the names of files, e.g. 2014-mf-03.svx, despite what you might see in historical data.
<p>However we always use lower case for entrance identifiers 'a', 'b', 'c' etc.
<p>So a new cave would be 2023-ZZ-01 and its entrances would be 2023-ZZ-01a, 2023-Z-01b and 2023-ZZ-01c.
<p>This convention is to prevent confusion between Windows and Linux machines, and unintentional deletion of data.
<p>Our generic guidance for typing logbooks, handbook pages etc. applies particularly to cave descriptions and entrance descritpions where we have to be particularly picky about the formats and character encodings, so now read:
<a href="/handbook/computing/hbmanual1.html#conventions">expo typing conventions</a>.
<h2>List of New Cave/Cave_data fields</h2>
<dl>
<dt>non_public</dt>