<h2id="tophead">CUCC Expedition Manuals - Editing the Handbook</h2>
<h1>Editing the Handbook (1)</h1>
<h2>Handbook editing manual</h2>
<p>These pages are for cavers wanting to:
<ol>
<li>quickly edit a correction using "Edit this Page", or
<li>edit several pages while sitting at the <em>expo laptop</em>
<li>edit several pages using their own laptop
</ol>
<h3id="editthispage">"Edit this page"</h3>
<p>You can update a single webpage
online via a browser. This is best for urgent edits to a single page, e.g.
if the emergency phone at top-camp has to use a new SIM with a different phone number.
<p>You can edit web pages without installing any software or doing any configuration. It even works if your laptop is a Mac.
To use it you need to <ahref="/accounts/login/">log in to troggle</a> using the well-known "cavey:beery" password. You generally only need to do this once.
<p>When you are a logged-on user you will see "Edit this page" at the bottom of the menu on the top-left of this page. It appears on
nearly all pages in this website. If you click on it you will be able to edit the content of the page.
<p>The image shows what it looks like when editing the "bierbook" page. There is a menu bar along the top of the panel where you can select the usual word-processing commands to make text <b>bold</b> or <em>italic</em> and to select syles such as headings or plain text.
<p>After editing the page you save your work by clicking on the "Submit" button at the bottom (see it at the bottom-left of the image).
<p>There is nothing to stop you editing lots of pages by this method but you will find it extremely tedious. It is especially tedious creating the links between pages.
<p><b>Footnote:</b> Currently this process does not properly tidy up after itself. Everyone can see your new edited page on the website immediately but you will need to ask a nerd to finish the process to make sure that your changes become persistent and don't get overwritten. [See the explanation at <ahref="#tidy">the bottom of this page</a> if you want to know more.]
<p>Some key sections of the online webpages are autogenerated from cave survey data
so you cannot use "Edit this page". These pages will not show "Edit this page" in the top-left menu even when you are logged in. If you need to change any of these you will need to <ahref="manual.html">correct the underlying cave survey data</a></p>
<p>If you type in the name of a new webapge into the address bar of your browser, e.g. <ahref="http://expo.survex.com/handbook/festering/spa.html">http://expo.survex.com/handbook/festering/spa.html</a> (e.g. if you want to document how to find a hot-tub in Altaussee) then troggle will offer to create the page for you. Just click on the blue text that says "Create this page":<br/>
<imgsrc="../i/createpage.jpg"/>
<p>Then once created, you can edit it the same way that you edit a pre-existing page.
<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 <ahref="../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><a href="filename"></em> tag. See <ahref="#images">Images: Relative and Absolute URLs</a> below for how to structure the URLs in the <var>href</var> attribute.
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.
<ahref="https://developer.mozilla.org/en-US/docs/Web/CSS">CSS3</a> but a great many pages still use obsolescent tags such as <font>. These are being removed whenever a page is edited.
<li>When editing webpages, use <ahref="https://www.freeformatter.com/html-entities.html">HTML entities</a> for characters with umlauts, e.g. <var>&ouml;</var> for ö.
<li><em>Only</em> use a <ahref="https://en.wikipedia.org/wiki/UTF-8#Encoding_process">UTF-8 encoding</a> if there is no HTML entity available, e.g. biohazard: <spanstyle='font-size:30px;'>☣</span> which is written as <var>&#9763;</var>
<li>When any .html page is loaded by troggle it replaces all the <em><head>...</head></em> material with the expo standard header. So don't put anything in the header of any page you edit as it will be ignored. This is also where troggle inserts the <ahref="/css/main2.css">/css/main2.css</a> standard stylesheet.
<li>On loading a .html page troggle also inserts a standard menu - normally visible to the top left of the page. This is not inserted if the .html page has its own menu: <em><div id="menu"><ul id="links"> ... various <li>items .. </ul></div></em>
it will be stripped out by troggle when it replaces the header, but it will notice it and will not insert "Edit this page" at the end of the inserted menu.
<li>No spaces in filenames. Use underscores or hyphens.
<li>No filenames starting with "-" or "!" (Mac users beware)
<lI>All filenames to start with an alphabetic letter.
<li>All filenames to be in lower case, must not use umlauts, must not have extra full-stops in the name.
<li>Don't use capitals in any sort of identifier. If you have to, make _sure_ that they are used exactly the same everywhere.
Otherwise it's easy to make pages that work on Windows, but which don't on Linux.
<li>When you use "Edit this page" you are editing on the server which is a Linux machine.
<li> Never create two files spelt the same except for capitalisation. They will overwrite each other if edited on a Windows machine <em>without any warning</em>. This is particularly a problem for the filenames generated on phones for photographs.
<br><figcaption>AA1 netbook<br /> sits high up out of reach<br />
(ours is less shiny)</figcaption>
</figure>
</pre></code>
<ul>
<li>"Rooted" URLs will work werever your fragment of HTML ends up. This root is the always the root of the <var>:expoweb:</var> repo, i.e. <var>/home/expo/expoweb/</var>.
<li>"Relative" URLs will be relative to wherever the webpage <em>is being viewed from</em> as located in the published
strcuture. This is often not where you think it is (especially for individual logbook entries and cave descriptions) but for handbook pages it is straightforward: you can see the location in the browser URL bar and for this page it is in the folder <var>"/handbook/computing/"</var>.
Where the <var>class="onright"</var> attribute is set on the IMG tag and not on the FIGURE tag or an enclosing DIV tag. If you find one of those in a page you are editing, please update it to use the current <figure> and <figcaption> structure. [Note the mixed URLs in this example, one is absolute and one is relative: this is not a recommended style.]
<h3id="tidy">Tidying up and committing the edits</h3>
<p>'Edit This Page' edits the file served on the web, saves it, adds it to the list of proposed git updates, then finally does the git 'commit' on the server. Things can go wrong at each step of the process.
<p>Specific error message pages are produced if the file cannot be saved (usually a permissions error), if it cannot be added to git's list, or if the git commit fails (which would be due to a merge failure on a previous commit attempt).
<p>If the version control commit fails, your edits will be saved and you will see them on the
website but <em>they will be lost later</em> if you do not get a nerd to fix the version control
which submits the obligatory comment with the commit operation. You should write something informative and brief about your changes between the quotation marks and also give your full name.
