From abade360f4deef9bce6b534a71238473a199f77f Mon Sep 17 00:00:00 2001 From: "Philip Sargent (muscogee)" Date: Fri, 10 Apr 2020 13:09:12 +0100 Subject: [PATCH] handbook editing manual --- handbook/computing/hbmanual1.html | 99 ++++++ handbook/computing/hbmanual2.html | 97 ++++++ handbook/computing/manual.html | 150 +-------- handbook/computing/onlinesystems.html | 2 +- .../{x-todo-styles.css => todo-styles.css} | 5 +- handbook/computing/todo.html | 286 ++++++++++++++++++ handbook/computing/x-todo.html | 3 +- handbook/i/createpage.jpg | Bin 0 -> 13041 bytes handbook/i/editthispage.jpg | Bin 0 -> 66640 bytes handbook/survey/newcave.html | 1 + handbook/upload-expert.html | 6 +- scripts/make-folklist.py | 1 + 12 files changed, 502 insertions(+), 148 deletions(-) create mode 100644 handbook/computing/hbmanual1.html create mode 100644 handbook/computing/hbmanual2.html rename handbook/computing/{x-todo-styles.css => todo-styles.css} (92%) create mode 100644 handbook/computing/todo.html create mode 100644 handbook/i/createpage.jpg create mode 100644 handbook/i/editthispage.jpg diff --git a/handbook/computing/hbmanual1.html b/handbook/computing/hbmanual1.html new file mode 100644 index 000000000..1907b396c --- /dev/null +++ b/handbook/computing/hbmanual1.html @@ -0,0 +1,99 @@ + + + + +CUCC Expedition Handbook: editing the handbook + + + +

CUCC Expedition Manuals - Editing the Handbook

+

Editing the Handbook (1)

+ +

Handbook editing manual

+ +

These pages are for cavers wanting to: +

    +
  1. quickly edit a correction using "Edit this Page", or +
  2. edit several pages while sitting at the expo laptop +
  3. edit several pages using their own laptop +
+ +

"Edit this page"

+ +

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. +

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 log in to troggle using the well-known "cavey:beery" password. You generally only need to do this once. + +

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. +gosser bier + +

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 bold or italic and to select syles such as headings or plain text. + +

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). +

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. + +

Footnote: 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 the bottom of this page if you want to know more.] + +

Autogenerated pages

+

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 correct the underlying cave survey data

+ +

Creating New Pages

+

If you type in the name of a new webapge into the address bar of your browser, e.g. http://expo.survex.com/handbook/festering/spa.html (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":
+ +

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. + +

Conventions

+

Encoding

+ +

Filenames

+ + + +
+

Tidying up and commiting the edits

+

'Edit This Page' edits the file served on the web but it does not update the file in the version control +repository. To properly finish the job you need to get a nerd to +

+

We intend to make this issue go away when we migrate the expoweb repo from mercurial to git during 2020. +

+

Go on to Editing several pages
+Return to Online systems overview + + +

+ + + diff --git a/handbook/computing/hbmanual2.html b/handbook/computing/hbmanual2.html new file mode 100644 index 000000000..b997cb25b --- /dev/null +++ b/handbook/computing/hbmanual2.html @@ -0,0 +1,97 @@ + + + + +CUCC Expedition Handbook: editing the handbook + + + +

CUCC Expedition Manuals - Editing the Handbook

+

Editing the Handbook (2)

+ +

Handbook and Repository editing

+ +

These pages are for cavers wanting to: +

    +
  1. quickly edit a correction using "Edit this page", or +
  2. edit several pages in repositories using the expo laptop +
  3. edit several pages using your own laptop +
+ + + +

2. Editing this handbook and files in repositories

+

The primary and recommended way of editing this handbook, historic expo files and survey data is to use +a laptop which has the version control software installed and configured. The +person editing needs to know how to use this software, and also needs to know how to edit raw HTML files +using a text editor. + +

+ +

The Expo laptop has the necessary software installed, so it is best to learn how to do this +when sitting at that laptop. + +

It's important to understand that the pages you can edit by this method +are stored in a version control system (see below). This stops us losing data and +makes it very hard for you to screw anything up permanently, so don't +worry about making changes - they can always be reverted if there is a +problem. It also means that several people can work on the site on +different computers at once and normally merge their changes +easily. + +

The recommended editing workflow is to (a) use the version control software to synchronise your local laptop copy of the +website files with that on the server ("pull" from the server); (b) edit a set of .html files on your laptop so that all links between them are consistent, +(c) save the files locally, and (d) "commit" them locally; +(e) "push" the collection of changes to the expo server. +

See the Expo data management manual for a fuller description of the version control software +repositories and how to install and use the software. + +

What you can't do

+

All the scans, photos, presentations, fat documents and videos are +not stored in the version control repositories so you cannot edit or change them using the method described here.

+ +

3. Your own laptop

+

Setting up your own laptop so that it can do everything the expo laptop can do is quite a +complicated process. At a minimum you will be an experienced software nerd already and will have git, mercurial and a text editor installed and you will know how to use them. +You will have done the ssh +key-pair setup process - which you can only do entirely on your own if +you have access to the expo laptop. +

See setting up a minimal laptop for a short list of software. This assumes you know how to use it all. +
See setting up your own laptop for the full list of software we use and where to get it. +

Note that the instructions are primarily for people using Linux with some help for those using Windows. If you are a Mac user then you are on your own. + +

Cheat lists and quick reminders

+

If you know what you are doing here is the basic info on what's where:
+ +

+ +

Simple changes to static HTML files will take effect immediately (or as soon as the hg update hack is done, see below), +but changes to dynamically-generated files - cave descriptions, QM lists etc. - +will not take effect, until the troggle import/update scripts are run on the server. These should run automatically and frequently but currently they are run manually by nerds as the expo server is undergoing heavy software maintenance.

+ +
+

Mercurial Website Hack 2019

+ +

Currently [April 2020] after commiting and pushing your changes to the :expoweb: or :loser: respositories, you will need to +login to expo.survex.com using ssh, cd to ~/expoweb/ (or ~/loser/) and issue a "hg update" command to make your changes noticed by the webserver. This problem will go away during 2020 when Wookey finishes migrating these repos from mercurial to git. + + +

+

Back to to "Edit this page"
+Forwards to Data Management Manual + + +

+ + + diff --git a/handbook/computing/manual.html b/handbook/computing/manual.html index 474dbaa5a..d2c12cb3f 100644 --- a/handbook/computing/manual.html +++ b/handbook/computing/manual.html @@ -2,14 +2,17 @@ -CUCC Expedition Handbook: Programmers manual +CUCC Expedition: Data Maintenance Manual -

CUCC Expedition Handbook - Online systems

+

CUCC Expedition: Data Maintenance Manual

Expo Data Maintenance Manual

-

Expo data management programmers' manual

+

[This page currently being restructured and edited to make it more appropriate to the task. Many fragments have been moved here but not yet properly edited together. Also there are no links to other pages which will be needed.] + + +

Expo data maintenance manual

We have migrated two of these to git but the other two still use mercurial. -

Mercurial Website Hack 2019

-

Currently (December 2019) after commiting and pushing your changes to expoweb to the mercurial server, you will need to -login to expo.survex.com using ssh, cd to /expoweb/ and issue a "hg update" command to make your changes noticed by the webserver. This problem will go away before Expo 2020 - we hope - when we finish migrating from mercurial to git. - -

All the scans, photos, presentations, fat documents and videos are -stored just as files (not in version control) in 'expofiles'. See -below for details on that.

- -

How the data management system works

- -

Troggle runs the expo cave survey data management, presents the data on the website and manages the Expo Handbook. See the troggle intro. - -

Anything you check in which affects cave data or descriptions won't appear on the site until -the data management system update scripts are run. -This should happen automatically every 30 mins (not since 2017), but you can also kick off a manual update. -See 'The expoweb-update script' below for details.

- -

Also note that the ::expoweb:: web pages and cave data reports you see on the visible website -are not the same as the version-controlled "master" expoweb repo. -So in order that your committed and pushed changes become visible on the website, -they have to be 'pulled' from the repo (on teh server machine) onto the webserver (another place on the same server machine) before your changes are reflected.

- -

Your own laptop

-

Setting your own laptop so that it can do everything the expo laptop can do is quite a -complicated process. At a minimum you will be an experienced software nerd already and will have git, mercurial and a text editor installed and you will know how to use them. -You will have done the -key-pair setup process - which you can only do entirely on your own if -you have access to the expo laptop. -

See setting up a minimal laptop for a short list of software. This assumes you know how to use it all. -
See setting up your own laptop for the full list of software we use and where to get it. -

Note that the instructions are primarily for people using Linux with some help for those using Windows. If you are a Mac user then you are on your own. - - -

Using 'Edit This Page'

-

This can be used to edit web pages without installing any software or doing any key-pair setup. It even works if your laptop is a Mac. -

This is the capability that you can see in the top-left-hand menu on any website page if you log in to troggle using the cavey:beery password. -

'Edit This Page' is a troggle capability edits the file served by the webserver but it does not update the copy of the file in the -repository (the invese of the problem described above as 'Mercurial Website Hack'). To properly finish the job you need to -

-

Again, we hope that this issue will go away when we migrate the expoweb repo from mercurial to git before the 2020 Expo. - - -

Editing the data management system

- -

To edit the data management system fully, you need to use the version control system - software which is currently git and mercurial. -Some (static text) pages can be edited directly on-line using the 'edit this page link' which you'll -see if you are logged into troggle. In general the dynamically-generated pages, such as those describing -caves which are generated from the cave survey data, can not be edited in this way, but forms are provided -for some types of these like 'caves'.

- -

Cheat lists and quick reminders

-

If you know what you are doing here is the basic info on what's where:
-(if you don't know what you're doing, skip to Editing the data management system below.) -

- -

Simple changes to static HTML files will take effect immediately (or as soon as the hg update hack is done, but this will disappear when we move entirely to git), -but changes to dynamically-generated files - cave descriptions, QM lists etc. - -will not take effect, until a nerd runs the expoweb-update script on the server.

- -

The expoweb & drawings import scripts

- -

The import scripts for the cave data are currently (Feb.2020) run manually by a nerd. So if you enter cave data,logbooks or survey scans you won't see the result -until a nerd has been placated.

-

Updating cave pages

- +

Cave description pages are automatically generated from a set of cave files in noinfo/cave_data/ and noinfo/entrance_data/. These files are named -.html (where area is 1623 or 1626). These @@ -290,7 +158,7 @@ Files are added and edited using the version control system for the expoweb repo

Cave pages and handbook menu design

See the menu design history and proposals page on where we are and what we might do to improveand fix menus. - +

diff --git a/handbook/computing/onlinesystems.html b/handbook/computing/onlinesystems.html index 9fb8ab6d4..bb602cd94 100644 --- a/handbook/computing/onlinesystems.html +++ b/handbook/computing/onlinesystems.html @@ -19,7 +19,7 @@ This page is the overview. The online systems manuals are split into these secti
  • the next expo - preparing for next year
  • Survey handbook - how to input cave survey data. -
  • Handbook maintenance - how to improve and update what you are reading now. +
  • Handbook maintenance - how to improve and update what you are reading now.
  • System maintenance - how to fix and enhance the software tools we have written:
    • Troggle - the system framework diff --git a/handbook/computing/x-todo-styles.css b/handbook/computing/todo-styles.css similarity index 92% rename from handbook/computing/x-todo-styles.css rename to handbook/computing/todo-styles.css index bc8cb7b34..5e5c21fb4 100644 --- a/handbook/computing/x-todo-styles.css +++ b/handbook/computing/todo-styles.css @@ -60,7 +60,7 @@ dd { font: 18px Calibri, sanserif; font-weight: normal; color: 6083BF; - display: block; + display: none; #list-style-type: disc; line-height: 1.3; margin-left: 1.0em; @@ -80,6 +80,7 @@ dt { margin-right: 5em; #list-style-type: none; line-height: 1.4; + font-style: italic; } @@ -87,7 +88,7 @@ dt { input[type=checkbox] ~ dl dd { display: block; } - input[type=checkbox]:checked ~ dl dd { +input[type=checkbox]:checked ~ dl dd { display: none; } diff --git a/handbook/computing/todo.html b/handbook/computing/todo.html new file mode 100644 index 000000000..960c813f4 --- /dev/null +++ b/handbook/computing/todo.html @@ -0,0 +1,286 @@ + + + +Expo Systems - To-Do List + + + + +

      Expo To-Do List

      + + + + + + + +

      How this works

      + +

      Click twice on a sub-heading to reveal the individual to-do items. Click again to hide.
      +If a heading is in italics, then there are hidden items. +

      Printing this page uses a much smaller font. Complain to the nerd list if you don't like this behaviour. + +

      Edit this page by clicking on the big blue button. It uses the same "Edit this page" function that you may have used before. Just be careful not to touch the code at the top and bottom of the page. + +

      We are working on a more capable and easier-to-use system (see x-todo.html) which will mimic how GitHub Issues do this sort of thing. + +

      Process Documentation

      +
      +
      Wallets and new-cave
      + +
      Explain (in the wallets process) how to view the surveys + online so that
        (1) you can see an example of how to do your new one, + and
        (2) so that you can check that you have done it properly when you + have finished.
      +
      Explain how to link a new cave into the other caves in + troggle filesystem
      +
      Explain how to add photos with the correct URL format to sub-HTML files attached to New Caves
      +
      svx check
      +
      explain command line to run on newly typed survex file to check for format errors '$cavern xxxx.svx' +
      + +

      Surveys data entry

      +
      +
      Write code to automatically extract ref info about wallets from tunnel xml files +
      This will replace :drawings:chk-xml.txt as used by :drawings:check-xml.sh +
      Do similar for Therion files when people start using #REF comments + +
      2019 surveyscans + +
      edit all the content.json
      +
      try to autocomplete the content.json by parsing .svx files
      +
      Put personal names into canonical form
      +
      2014 contents.json +
      parse all the svx files to extract people, dates & svx references +
      + + +

      Logbook fettling

      +
      +
      2019 Logbook
      +
      + transcribe the rest of those UKcaving blog entries into expoweb/years/2019/logbook.html
      +
      + copy the photos from the UKCaving blog into expofiles/photos/2019// -- in fact many of those photos are already there
      +
      edit in the links to those photos in the right place in 2019/logbook.html
      + +
      Garlic cave +
      edit logbook entries 2018, 2019 to link to extensive photos of Garlic cave area {Withnall 2018} , {Becka 2019} +
      Past logbooks - missing images? +
      Which previous years HTML logbooks are missing images extracted from scanned PDF copies of the logbooks? + +
      imagemagick convert +
      Not working for PDFs on current version of xubuntu ! Fix & document. Also not working on WSL ubuntu. Needed to work with logbook images easily. + +
      2018 Logbook
      +
      Check Natalie Uomini's typed entries and extensive photos are minimized and linked in properly to the HTML logbook + + +
      Add missing images to logbooks
      +
      + 2000, 2008, 2009, 2011
      +
      + fix corrupted image in 2001 log
      + +
      2011 logbook:
      +
      type up via-ferrate & bolt-testing writeups (In paper book, not in scan or HTML)
      + +
      200? logbook:
      +
      + Type up "list of GPS locations still to type"
      + +
      + +

      Handbook

      +
      + +
      Desperately needs Navigation - Location Context, Situational Awareness +
      No overall view of what there is: need a user-friendly diagrammatic overview sitemap. There are 4,869 files in :expoweb:
      +
      Not fixed by menus - breadcrumbs needed?
      +
      Diagrams of major sections: survey handbook, rigging handbook, computing handbook, Areas, cave data..
      +
      Chase Airoa to help fix the menus for phones
      +
      Look at gov.uk guidelines for inspiration
      +
      When git migration done +
      Edit out all mercurial +
      Split the TortoiseHg/PuTTy documentationa nd retain only PuTTy +
      Wookey Overview presentation +
      extract content from Troggle which does not render properly and extract the HTML not in slide format - correcting things now outdated. + +
      +

      Photos

      +
      + +
      Fix the BINS package +
      set up git on the BINS software? Fix base url sautret.org
      +
      set up a cron / Makefile job to run BINS
      +
      why is 'updatephotos' script in expofiles?
      +
      Document the ~expo/webphotos/ directory and how it works +
      Why does expofiles/photos/xml/ get created containing all the generated xml files? Fix this. + + +
      + +

      System Documentation

      +
      +
      Document how we generate the SMK overall lengths and stats
      +
      scripts and manual actions in cavern + + + +
      Troggle architecture
      + +
      Handbook: add more to the new troggle architecture documentation. For future system maintainers
      +
      Regenerate the diagram of the tables in the database & document
      +
      Describe the parsing/import procedures so non-nerds can do it
      +
      Copy [some of] the .wiki material into the documentation somewhere
      + + +
      Surveyscans
      + +
      explain where the image files are referenced from: svx, tunnel/therion, and
      +
      why there are so many broken links
      +
      Apache & MySQL configuration +
      DOCUMENT How to set up a server +
      Explain why Docker containers can be a maintenance nightmare +
      non-troggle scripts +
      DOCUMENT them all - have we got a full list? + + +
      + +

      Troggle

      +
      +
      Better import error messages +
      REPORT if import surveyscan file failure +
      Why are so many surveyscan foolder missing after import? +
      WHY are total lengths of surveyed cave different between expo server and WSL server for 2019 and a few other years only ? + +
      Logbook data model: unfilled fields? +
      'cave' of location field missing on nearly all logbook entroies. Missing from logbook templates. Where is this used and how can we fill it it in? Is it useful? +
      + + +

      Expo Server

      +
      +
      document directory structure + +
      as per Julian's GitHub list - then close that issue
      +
      permissions + +
      do we need a cron job or has the group membership fix fixed it ? either way, document it. +
      +
      + +

      Tackle Store Records

      +
      +
      No authoritative list of where the expo paper records are! +
      NO expo paperwork at all prior to 2008 in Tackle Store - where is it ? +
      FIND where all the wallet binders are, and the logbooks. +<
      BUY A4 plastic boxes for filing cabinet for logbooks getting damp there. +
      2017, 2018, 2019 wallet binders are in Philip S.'s house. +
      + +

      + This to-do-list gadget itself +

      +
      +
      Status +
      Try the Experimental to-do list - no extra display capabilities yet. +
      Fix the "click twice" on startup. Make it only click once to change display state of the DT tag + +
      Eventual aim + +
      to replace GitHub + CUCCexposurveyissues for non-tunnel, non-GIS issues.
      +
      We need two of these:
      1.for expo systems work (troggle & scripts) - the current priority as we have nowhere currently that Wookey is willing to use +
      2.for survey data progress/issues (though troggle itself can be used for some of this if cleaned up a bit) + +
      + +
      Try to automate simple functions in javascript + +
      to control this document + in-place (tick, delete) instead of using the + tinymce HTML editor in Django
      +
      Maybe restructure whole page as JSON and use + javascript editor to create (edit), re-order and demote items.
      +
      if using tinymcs, use the INLINE mode.
      +
      Implement comments on an issue, mimicking GitHub issues wiki
      +
      Use javascript to skip over the _edit page and submit changes + direct to server when updating. Needs direct POST and include the javascript in the posted content.
      +
      checkboxes so that items can be ticked (which also does strike-through)
      +
      promotion/demotion options?
      +
      bin icon to delete an item? Better to have an archive process.
      +
      Local WSL server +
      Why is it using recuced-capability tinymce, a paths problem ? +
      Italics management +
      Hide ALL DD if any Heading clicked. +
      Put DL into italics when *any* DD is hidden + + +
      + + +
      + + + + Testing area.. +
      Demonstation text as initially read from disc
      + + + + +
      + diff --git a/handbook/computing/x-todo.html b/handbook/computing/x-todo.html index 8bdb628aa..53fe10eb8 100644 --- a/handbook/computing/x-todo.html +++ b/handbook/computing/x-todo.html @@ -3,10 +3,11 @@ Expo Systems - Experimental To-Do List +

      Experimental expo To-Do List

      - + +