From 75e49624d4fd206a2ad51e4ea1c569993239ca3e Mon Sep 17 00:00:00 2001 From: Philip Sargent Date: Wed, 5 Apr 2023 14:32:36 +0100 Subject: [PATCH]
and
and relative and absolute URLs --- handbook/computing/hbmanual1.html | 36 +++++++++++++++++++++++++++---- handbook/logbooks.html | 11 +++++++++- handbook/survey/caveentry.html | 4 ++++ 3 files changed, 46 insertions(+), 5 deletions(-) diff --git a/handbook/computing/hbmanual1.html b/handbook/computing/hbmanual1.html index aa0a2c7a6..91f323ef2 100644 --- a/handbook/computing/hbmanual1.html +++ b/handbook/computing/hbmanual1.html @@ -50,7 +50,7 @@ so you cannot use "Edit this page". These pages will not show "Edit this page" i

Then once created, you can edit it the same way that you edit a pre-existing page.

Linking in New Pages

-

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 Expo Personal Gear List. 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 <a href="filename"> tag. +

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 Expo Personal Gear List. 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 <a href="filename"> tag. See Images: Relative and Absolute URLs below for how to structure the URLs in the href attribute.

Conventions

[This should all be moved to a different page as it covers all files and names, just just the handbook pages.] @@ -85,16 +85,44 @@ Otherwise it's easy to make pages that work on Windows, but which don't on Linux
  • Never create two files spelt the same except for capitalisation. They will overwrite each other if edited on a Windows machine without any warning. This is particularly a problem for the filenames generated on phones for photographs. -

    Images

    +

    Images: Relative and Absolute URLs

    • Older parts of the website have sub-folders "i/", "l/", and "t/" holding respectively
      i/ - the image file at full resolution (600px width usually)
      l/ - an html file which displays the full image with a caption and some description
      t/ - a thumbnail image which is usually used inside an <a> tag to link to the l/ html file. - -
    +

    When creating figures use one of these two constructions. The first with "rooted" URLs beginning with a "/":

    +
    +<figure class="onright">
+<a href="/piclinks/typing.htm"><img  src="/images/typing.jpg"></a>
+<br><figcaption>Tony Rooke at computer in 1991 - in the old potato hut</figcaption>
+</figure>
     +or, with "relative" URLs, where the URL does not start with a "/": +
    +<figure class="onleft">
+<a href="../l/hut-cables.html"><img width=200 src="../i/acer-blue-aspire-one-netbook.jpg"></a>
+<br><figcaption>AA1 netbook<br /> sits high up out of reach<br /> 
+(ours is less shiny)</figcaption>
+</figure>
+
     +
      +
    • "Rooted" URLs will work werever your fragment of HTML ends up. This root is the always the root of the :expoweb: repo, i.e. /home/expo/expoweb/. +
    • "Relative" URLs will be relative to wherever the webpage is being viewed from 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 "/handbook/computing/". +
    + + + +

    +P.S. In older pages that have not been updated recently, you may see this archaic form:

    +
    +<a href="/years/2018/logbook.html#t2018-08-03w"><img src="i/logbookpage.jpg" class="onright"></a>
+
     +Where the class="onright" 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.] + +

    Tidying up and committing the edits

    '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. diff --git a/handbook/logbooks.html b/handbook/logbooks.html index 0944ef1a9..c3b818d98 100644 --- a/handbook/logbooks.html +++ b/handbook/logbooks.html @@ -133,7 +133,16 @@ idea to type up just your trip(s) in a separate file, e.g. "logbook-mynew

    Format of the online logbooks

    -

    Do whatever you like to try and represent the logbook in html. The only rigid structure is the markup to allow troggle to parse the files into 'trips':

    +

    Do whatever you like to try and represent the logbook in html but do keep is simple. Don't try any clever HTML stuff. See the "Edit this Page" instructions for how to insert images and figures. + + +

    When writing logbook entries, just use relative URLs to the same folder as your text, e.g. href="mynicepic.jpg" and the image and the logbook HTML will, for a 2017 expo, be put into /years/2017/. + +

    One special suggestion: do not use <P> paragraph tags. Well, you can if you like, but they will be stripped out and replaced by double-newlines when the file is parsed. This is because <P> paragraph tags cannot be nested - that is not allowed in HTML - and the fragment you are writing will be merged with other fragments and may be put inside a higher-level paragraph. [This is also true for Cave Description text in "Edit this Cave".] + +

    Logbook-specific HTML

    +

    +The only rigid structure is the markup to allow troggle to parse the logbook files into 'trips':

     <hr />
 <div class="tripdate" id="t2007-07-12B">2007-07-12</div>
diff --git a/handbook/survey/caveentry.html b/handbook/survey/caveentry.html
index 9658b26f3..e8bb8a16f 100644
--- a/handbook/survey/caveentry.html
+++ b/handbook/survey/caveentry.html
@@ -45,6 +45,7 @@ This page outlines step 6 of the survey production process. Each step is documen
     to have some idea what is going on behind the scenes. So you are recommended to have a quick look
     at the new cave file method even if you have no intention of using it.
   
    
+  
 
    Guidebook description
    
 
 
    
@@ -79,6 +80,9 @@ If it is a complex cave, you will type this description, and pass it on to someo
 will file it in the right place. For a simple cave you can do it all yourself with the
 the New Cave form - but not yet.
 
+
    Guidebook description formatting
    
+
    You are typing an HTML fragment which will be assembled into a complete page. So follow our usual rules about
+putting images in Handbook pages and  writing HTML in logbooks
 
   
    Recommended procedure