expo/expoweb
1
0
Fork 0
mirror of https://expo.survex.com/repositories/expoweb/.git/ synced 2025-01-18 00:42:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

typing conventions requirements

Browse Source
This commit is contained in:
Philip Sargent 2023-07-29 18:52:27 +03:00
parent 849e12f3d3
commit 8bb01361b4
2 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
handbook/computing/hbmanual1.html
View File

@ -52,8 +52,8 @@ so you cannot use "Edit this page". These pages will not show "Edit this page" i
<h3>Linking in New Pages</h3>
<p>You link your new page into the handbook by editing another page in which you want to create a link. For example if you have created a new page describing your wonderful new sleeping bag/hammock technique, then you might want to add a link in to <a href="../kitlist.html">Expo Personal Gear List</a>. Unfortunately the "create link" icon (a picture of 3 links of a chain) is disabled in the on-line editor so you would have to click on the HTML icon and insert the link by editing the HTML directly using an <em>&lt;a href="filename"&gt;</em> tag. See <a href="#images">Images: Relative and Absolute URLs</a> below for how to structure the URLs in the <var>href</var> attribute.
<h3>Conventions</h3>
[This should all be moved to a different page as it covers all files and names, just just the handbook pages.]
<h3 id="conventions">Conventions</h3>
This covers all files and names, not just just the handbook pages. Other parts of the handbook guidance for logbooks, cave description writeups, entrance decription text and everything else redirect here.
<h4>Encoding</h4>
<ul>
@ -62,8 +62,8 @@ so you cannot use "Edit this page". These pages will not show "Edit this page" i
<a href="https://developer.mozilla.org/en-US/docs/Web/CSS">CSS3</a> but a great many pages still use obsolescent tags such as &lt;font&gt;. These are being removed whenever a page is edited.
<li>All the pages use a single CSS stylesheet <a href="/css/main2.css">/css/main2.css</a>.
<li>We do not use any javascript framework: just HTML and CSS. You may come across historic references to jquery but this is not used.
<li>When editing webpages, use <a href="https://www.freeformatter.com/html-entities.html">HTML entities</a> for characters with umlauts, e.g. <em>&amp;ouml;</em> for &ouml;.
<li>Only use a UTF-8 encoding if there is no HTML entity, e.g. biohazard: <span style='font-size:30px;'>&#9763;</span>
<li>When editing webpages, use <a href="https://www.freeformatter.com/html-entities.html">HTML entities</a> for characters with umlauts, e.g. <var>&amp;ouml;</var> for &ouml;.
<li><em>Only</em> use a <a href="https://en.wikipedia.org/wiki/UTF-8#Encoding_process">UTF-8 encoding</a> if there is no HTML entity available, e.g. biohazard: <span style='font-size:30px;'>&#9763;</span> which is written as <var> &amp;#9763;</var>
</ul>
<h4>Automated formatting</h4>
<ul>

10
handbook/survey/caveentryfields.html
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>