+
+These pages are for cavers wanting to: +
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.
+
+
+
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.] + +
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
+ +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. + +
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. + +
'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 +
hg commit -m "changed topcamp phone number - myName"
+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.
+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
+
+
+
These pages are for cavers wanting to: +
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. + +
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.
+ +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. + +
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.
+ +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
+
+
+
[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.] + + +
Troggle runs the expo cave survey data management, presents the data on the website and manages the Expo Handbook. See the troggle intro. - -
Some key sections of the online webpages are autogenerated by scripts or by -troggle, and are not static files, -so you have to edit the base data, not the generated file (e.g cave -pages, QM (question mark) lists, expo members list, prospecting pages). All -autogenerated files say 'This file is autogenerated - do not edit' at -the top - so check for that before wasting time on changes that will -just be overwritten
- -The primary and recommended way of editing this handbook (and the website generally) is to use -a laptop which has the version control software installed. 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 public expo server is on a machine far, far away that we only access remotely. - -
The Expo laptop has the 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; (b) edit a set of .html files on your laptop so that all links between them are consistent, -save the files locally, and "commit" them locally; -(c) "push" the collection of changes to the expo online server as a single action. -
See the Expo data management systems manual for a fuller description of the version control software -repositories and how to install and use the software. - -
You can update a single webpage -online via a browser. This is best used 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. -If you are a logged-on user you will see "Edit this page" on the menu on the 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 raw HTML of the page - so you need -to know how to do that. - - -
After doing the page editing and saving your work, you need to ask a nerd to finish the process fairly soon as the "Edit this page" -mechanism does not tidy-up after itself properly. -See these instructions for this tidy-up - -
We use a distributed revision control system (git, and formerly mercurial) for all the important data. (Note that we just use git: not GitHub, not GitLab, just git.) This means that many people can edit and merge their changes with the expo @@ -113,16 +67,12 @@ The same goes for holiday photographs and GPS logs.
In 2019 we had half our version-controlled repositories under mercurial and half under git. The intention is to move entirely to git before the 2020 expo. -
We have migrated two of these to git but the other two still use mercurial. -
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.
- -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.
- -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. - - -
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. - - -
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'.
- -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 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.
-Cave description pages are automatically generated from a set of
cave files in noinfo/cave_data/ and noinfo/entrance_data/. These files
are named - See the menu design history and proposals
page on where we are and what we might do to improveand fix menus.
-
+Cave pages and handbook menu design
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. + +