diff --git a/folk/README b/folk/README index 47d9078d8..3d9352cfd 100644 --- a/folk/README +++ b/folk/README @@ -2,25 +2,29 @@ Convert the folk.csv to fold/index.htm like this: $ cd :expoweb:/folk $ python ../scripts/make-folklist.py index.htm +This does some basiuc validation: it check sthat the mugshot +images and blurb HTML files exist. + Troggle *also* reads the mugshot and blurb about each person. It reads it direct from folk.csv +It does this when troggle is run with +python databaseReset.py people -Troggle generates its own blurb about each person. -A link to this troggle page has been added to folk/index.htm by -editing the script. +Troggle generates its own blurb about each person, including poast expedtitions and trips +taken from the logbooks (and from parsing svx files ?) +A link to this troggle page has been added to folk/index.htm +by making it happen in make-folklist.py Troggle scans the blurb and looks for everything between and

Menus: Why we need a change now

-

Phones

The current system makes it very difficult to design menus that work on phone screens. @@ -48,6 +47,7 @@ match the mental model they have of how the system is put to because maintenance difficulties have created an inconsistent system.

The menu system we created a decade ago was leading-edge in its time but user expectations have moved in a different direction. +
[This document originally written 19 February 2020, updated 2 April 2020]

Menus: Maintenance constraints

@@ -244,9 +244,9 @@ as the static menu.

Note that there is no <div id="menu"> enclosing -DIV +div tag. The -DIV +div tag is only there to tell troggle that there is a static menu and so it shouldn't provide one.

For the past 3 years the static menus have been mostly removed from edited pages as the dynamic menu did the job, and @@ -270,9 +270,11 @@ to do it anyway. If they can do this, they are not likely to be relying on the m downloadable documents (e.g. PDF) of prospecting guides and safety procedures - including topcamp and basecamp phone numbers - which we encourage all expoers to download to their phone before they leave base-camp. We already have a number of these but some are in .odt format which is not phone-friendly. But that is another job to fix. - -

+Return to
+Troggle intro
+ +
diff --git a/handbook/troggle/otherscripts.html b/handbook/troggle/otherscripts.html new file mode 100644 index 000000000..a80d33cb4 --- /dev/null +++ b/handbook/troggle/otherscripts.html @@ -0,0 +1,19 @@ + + + + +Handbook Troggle XXX + + + +

CUCC Expedition Handbook

+

Handbook Troggle XXX

+

This is not the page you are looking for. +

This will be replaced with the information you want as soon as someone gets around to writing it. Why not find out how to do this yourself ? + +

+Go on to: Troggle architecture
+Return to: Troggle intro
+
+ + diff --git a/handbook/troggle/placeholder.html b/handbook/troggle/placeholder.html new file mode 100644 index 000000000..a80d33cb4 --- /dev/null +++ b/handbook/troggle/placeholder.html @@ -0,0 +1,19 @@ + + + + +Handbook Troggle XXX + + + +

CUCC Expedition Handbook

+

Handbook Troggle XXX

+

This is not the page you are looking for. +

This will be replaced with the information you want as soon as someone gets around to writing it. Why not find out how to do this yourself ? + +

+Go on to: Troggle architecture
+Return to: Troggle intro
+
+ + diff --git a/handbook/troggle/trogarch.html b/handbook/troggle/trogarch.html new file mode 100644 index 000000000..a80d33cb4 --- /dev/null +++ b/handbook/troggle/trogarch.html @@ -0,0 +1,19 @@ + + + + +Handbook Troggle XXX + + + +

CUCC Expedition Handbook

+

Handbook Troggle XXX

+

This is not the page you are looking for. +

This will be replaced with the information you want as soon as someone gets around to writing it. Why not find out how to do this yourself ? + +

+Go on to: Troggle architecture
+Return to: Troggle intro
+
+ + diff --git a/handbook/troggle/trogdesign.html b/handbook/troggle/trogdesign.html new file mode 100644 index 000000000..30767f8c3 --- /dev/null +++ b/handbook/troggle/trogdesign.html @@ -0,0 +1,21 @@ + + + + +Handbook Troggle Design + + + +

CUCC Expedition Handbook

+

Troggle Design Decisions

+ +

Open issues being worked on: +

+
+Go on to: Troggle architecture
+Return to: Troggle intro
+
+ + diff --git a/handbook/troggle/trogdocm.html b/handbook/troggle/trogdocm.html new file mode 100644 index 000000000..a80d33cb4 --- /dev/null +++ b/handbook/troggle/trogdocm.html @@ -0,0 +1,19 @@ + + + + +Handbook Troggle XXX + + + +

CUCC Expedition Handbook

+

Handbook Troggle XXX

+

This is not the page you are looking for. +

This will be replaced with the information you want as soon as someone gets around to writing it. Why not find out how to do this yourself ? + +

+Go on to: Troggle architecture
+Return to: Troggle intro
+
+ + diff --git a/handbook/troggle/trogintro.html b/handbook/troggle/trogintro.html index 9c550b340..21f2e6cb3 100644 --- a/handbook/troggle/trogintro.html +++ b/handbook/troggle/trogintro.html @@ -7,17 +7,17 @@

CUCC Expedition Handbook

-

Troggle - what you may need to know

+

Troggle - what it is

Troggle is the software which runs the the expo cave survey data management and website.

-

Troggle - what it is

+

Troggle - what it does

Troggle manages all cave and expo data in a logical and maintainable way @@ -36,8 +36,10 @@ The troggle software is written and maintained by expo members.

  • expo.survex.com/survey_scans/2018%252343/ - list of links to scanned notes for wallet #43 during the 2018 expo.
    -Return to
    -expo online systems overbiew
    - +Go on to: +troggle status
    +Return to: +expo online systems overview
    +
    diff --git a/handbook/troggle/trogmanual.html b/handbook/troggle/trogmanual.html index c74c3b47a..9e16b6716 100644 --- a/handbook/troggle/trogmanual.html +++ b/handbook/troggle/trogmanual.html @@ -7,356 +7,40 @@

    CUCC Expedition Handbook

    -

    Troggle - Maintainers Manuals

    -

    Troggle runs much of the the cave survey data management, presents the data on the website and manages the Expo Handbook. -

    You may have arrived here by accident when where you really need to be is website history. +

    Troggle - Maintenance Manuals

    +

    Troggle is the software which runs the the expo cave survey data management and website. -

    This part of the handbook is intended for people maintaining the troggle software. Day to day cave recording and surveying tasks are documented in the expo "survey handbook" -

    This troggle manual describes these: +

    This part of the handbook is intended for people maintaining the troggle software: +

    - -
    - - -

    This page is mostly an index to other records of what troggle is and what plans have been made - but never implemented - to improve it. - -

    Troggle - what it is

    - -

    -Troggle is the software collection (not really a "package") based on Django -originally intended to manage all expo data in a logical and accessible way -and publish it on the web. It was first used on the 2009 expo - see 2009 logbook. -

    Only a small part of troggle's original plan was fully implemented and deployed. -Many of the things it was intended to replace are still operating as a motley collection written by many different people in -several languages (but mostly perl and python; we won't talk about the person who likes to use OCamL). -

    Examples of troggle-generated pages from data: -

    - -Today troggle is used for only three things: +

    Troggle - what it does

      -
    1. Reformatting all the visible webpages such that they have a coherent style and have a contents list at the top-left -hand corner. This is particularly true of the handbook you are reading now and the historic records of past expeditions. -
    2. Publishing the "guidebook descriptions" of caves. The user who is creating a new guidebook description -can do this by filling-in some online forms. (And managing all the cave suvey data to produce this.) +
    3. Coherently publishes expo data by cave, by expedition, by person, by trip or by survey - without requiring duplicate data entry. -
    4. Providing a secondary way of editing individual pages of the handbook and historic records pages +
    5. Manages and safely archives the typed and scanned survey data, entrance data, trip records (logbooks) and expo records. +
    6. Publishes the "guidebook descriptions" of caves by a combination of online forms and uploading files. +
    7. Supports the process of turning scribbled notes into finished cave surveys +
    8. Reformats all the visible webpages such that they have a coherent style and have a small menu at the top-left +hand corner. These are the handbook you are reading now and the historic records of past expeditions. + +
    9. Providing a way of editing individual pages of the handbook for very quick and urgent changes. -This is the "Edit this page" capability; see for -how to use it and how to tidy up afterwards. +[This is the "Edit this page" capability; see for +how to use it and how to tidy up afterwards].
    -

    The first thing to do

    -

    The first thing to do is to read: "Troggle: a novel system for cave exploration information management", by Aaron Curtis, CUCC. -

    Two things to remember are -

    - -

    Troggle Login

    -

    Yes you can log in to the troggle control panel: expo.survex.com/troggle. -

    -

    It has this menu of commands: -

    -All Survex | Scans | Tunneldata | 107 | 161 | 204 | 258 | 264 | Expo2016 | Expo2017 | Expo2018 | Django admin 
-
    - -

    Future Developments: Preamble

    -

    Assumptions (points to necessarily agree upon) -

      -
    1. Let's NOT try to design a generic catalogue for storing all kind of data about caves of the whole world, intended for every kind of user (sports, exploration, science). Let's just settle for a generic framework. Let geeks in individual countries or individual communities write their tools operating within this framework. -
    2. Let's try make it available for the layman, but still well-playable for the geeks. -
    3. Let's rely on already existing, popular technologies. Let's keep it open source and multiplatform. Let's try not to reinvent the wheel. -
    4. Let's not assume everyone has an Internet connection while working with their data. -
    5. Let's version-control as much as possible. -
    6. Let's support i18n - let's use UTF-8 everywhere and cater for data in many languages(entrance names, cave descriptions, location descriptions etc.) -
    - -Everything here should be updated or replaced - this page just records a lot of unfinished ideas. -Most people will not want to read this at all. This is for speleosoftwarearcheologists only. - - -

    Two page preliminary design document for 'caca' (Cave Catalogue) rev.2 2013-07-26 by Wookey (copied from http://wookware.org/software/cavearchive/caca_arch2.pdf) - -

    stroggle

    -

    At one time Martin Green attempted to reimplement troggle as "stroggle" using flask instead of Django at -git@gitorious.org:stroggle/stroggle.git (but gitorious has been deleted).

    -

    A copy of this project is archived by Wookey on wookware.org/software/cavearchive/stroggle/. -

    There is also a copy of stroggle on the backed-up, read-only copy of gitorious on "gitorious valhalla"
    -stroggle code
    -stroggle-gitorious-wiki
    -but note that this domain has an expired ertificate so https:// complains. - - -

    CUCC wiki on troggle

    - -

    CUCC still has an archive list of things that at one time were live tasks: -from camcaving.uk/Documents/Expo/Legacy/Misc/... and that page is reproduced in the table below (so don't worry if the URL link goes dark when CUCC reorganise their legacy pages). -

    Troggle is a system under development for keeping track of all expo data in a logical and accessible way, and displaying it on the web. At the moment, it is [no longer] under development at http://troggle.cavingexpedition.com/ - -But note that this is Aaron's version of troggle, forked from the version of troggle we use. Aaron uses this for the Erebus expedition. -

    -

    Note that the information there is incomplete and editing is not yet enabled. -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

    Feature

    Old expo website

    Troggle: planned

    Troggle: progress so far

    Logbook

    Yes; manually formatted each year

    Yes; wiki-style

    Start at the front page, troggle.cavingexpedition.com/ [1] and click to logbook for year. The logbooks have been parsed back to 1997.

    Cave index and stats generated from survex file

    Yes

    Yes

    Done; see troggle.cavingexpedition.com/survey/caves/264 [2]

    Survey workflow helper

    Yes; minimal. surveys.csv produced an html table of whose surveys were not marked “finished”

    Yes. Makes table of surveys per expo which shows exactly what needs doing. Displays scans. Integrated with survex, scanner software, and tunnel.

    See it at troggle.cavingexpedition.com/survey . Be sure to try a recent year when we should have data. Survex, scanner, and tunnel integration still needs doing.

    QM lists generated automatically

    Depends on the cave. Each cave had a different system.

    Yes; unified system.

    Done, but only 204 and 234 Qms have been imported from old system so far. No view yet.

    Automatic calendar for each year of who will be on expo when

    No, manually produced some years

    Yes

    Done; see troggle.cavingexpedition.com/calendar/2007 (replace 2007 with year in question)

    Web browser used to enter data

    No

    Yes

    Everything can be edited through admin, at troggle.cavingexpedition.com/admin . Ask aaron, martin, or julian for the password if you want to have a look / play around with the admin site. Any changes you make will be overwritten. Eventually, data entry will probably be done using custom forms. -

    Cave and passage descriptions

    Yes, manually html coded.

    Yes, wiki-style.

    Not done yet.
    -

    Expo handbook

    Yes, manually html coded.
    -

    Maybe. Needs to be discussed further.


    -

    Not done yet.

    Table of who was on which expo

    Yes

    Yes

    Data has been parsed, this view hasn't been written yet.

    Signup form, System for keeping contact, medical and next of kin info

    No

    Yes

    Signup form should be ready by 20 Jan.

    Automated photo upload and gallery

    No; some manual photo galleries put together with lots of effort

    Yes

    Photo upload done, gallery needs writing.

    Search

    No

    Yes

    - -

    List of cave database software

    -from wookware.org/software/cavearchive/databasesoftwarelist - -
    -ckan is something like this - could we use it?
-esri online
-
-CUCC (troggle) http://cucc.survex.com/ - this site.
-virgina caves database (access+arcgis) (futrell)
-each country database
-Austria (spelix) ( www.spelix.at/
-UK cave registry 
-mendip cave registry: (access) www.mcra.org.uk/wiki/doku.php
-White mountains database (gpx + google earth)
-Matienzo (?)
-Fisher ridge (stephen cladiux)
-hong meigui (erin)  (ask erin later)
-Wikicaves www.grottocenter.org/
- multilingual, slippymap, wiki data entry. includes coordinate-free caves.
- focus on sport-caving type info (access, basic gear list, overall description, bibliography)
- e.g. australians only publish coordinates to nearest 10km
-turkey www.tayproject.org.
-
-www.uisic.uis-speleo.org/contacts.html change link. no-one looks for list of databases under 'contacts'
-
-graziano ferrari northern italy list (access + google earth)
-
    - -

    Wookey's notes on things to do

    -from wookware.org/software/cavearchive/goliczmail -
    -Generally I'd like to find some people (geeks) that share these technical
-ideas: (1) store things in a file system, (2) use XML, (3) do not aim too high
-(do not try designing a general system for handling all caving-related data
-for the whole world).
-
-If I could find some people that agree with this, then we could try to reach a
-compromise on:
-(1) how do we store our data in a file system,
-(2) how do we use this XML (let's do a common spec, but keep it simple)
-(3) how do we aim not to high and not end up dead like CaveXML :)
-
-After we do that, everyone goes away to do their own projects and write their
-own code. Or maybe we have some degree of co-operation in actually writing the
-code. Normal life. But the idea is that all geeks working on "cave inventory"
-and systems making extensive use of cave inventories try to adhere to this
-framework as much as possible. So that we can then exchange our tools.
-
-I think things like "which revision system do we use" or "do we use web or    
-Python" are really secondary. Everyone has their own views, habits,
-backgrounds.
-
-My idea is to work on this in a small group (no more than a few persons) - to
-get things going fast, even if they are not perfect from the beginning. If it
-works, we try to convince others to use it and maybe push it through UIS. 
-
    - -

    Wookey's other notes on things to do

    -from wookware.org/software/cavearchive/troggle2design -
    -forms
------
-1) members read/write folk.csv and year/members
-2) cave read/write cave_data, entrance_data, surveys/pics 
-3) trips -> logbook , QMs, or surveys (more than one survey or location possible)
-4) logbook reads/write year/logbook
-5) survey 
-6) prospecting app
-
-forms show who is logged in.
-
-databases
----------
-trips, read from 
- logbook entry
- folder year#index
- .svx files
- description
- QMs
-
-members (cache from form)
-
-caves
- caves_data
- entrance_data
-
-storage:
- expoweb
- data/
- cave_entrances
- caves
- descriptions
-
- loser
- foo.svx
-
    - - -

    Yet more of Wookey's notes

    -from wookware.org/software/cavearchive/expoweb-design -
    -frontpage
----------
-quick to load:
-Links:
- Caves number, name, location
- Years 
- Handbook
- Data Entry
- Main Index
-
-Slippy map:
- Indexes to cave page
-
-Cave page:
- Access, description, photos, QMs, Survey
- 
-Years:
- Logbooks/surveynotes/survexdata/people matrix
- Documents
-
-Data Entry:
- Logbook entry
- Survey data
- Survey Notes
- Cave description
- QMs
- Photos
- New cave
-
-Backend datafiles:
- caves/
- cave_entrance
- cave_data
- directory of info
- 
- years/
- year/
-  logbook
-	 pubs/
-	  reports
-  admin/
-   lists
-		 who_and_when
-		 travel
-		 jobs
- 
- surveyscans/
-  year/
-	  index
-		 #num
- handbook/
-  (all static info)
- 
-Storage:
- non-html or > 200K go in 'files' (PDF, PNG, JPEG, DOC, ODF, SVG)
- convert small 800x600 version into website by default. (matching structure?
-
    -
    - - +Go on to: Troggle architecture
    +Return to: Troggle intro
    +
    diff --git a/handbook/troggle/trogstatus.html b/handbook/troggle/trogstatus.html index b57d41eae..47dd84bae 100644 --- a/handbook/troggle/trogstatus.html +++ b/handbook/troggle/trogstatus.html @@ -7,8 +7,8 @@

    CUCC Expedition Handbook

    -

    Troggle & Expo Systems - Update status

    -

    Troggle runs the expo cave survey data management, presents the data on the website and manages the Expo Handbook. +

    Troggle & Expo Systems - status update

    +

    Troggle is the software which runs the the expo cave survey data management and website.

    Early 2019

    In early 2019 the university computing service upgraded its firewall rules which took the @@ -22,26 +22,27 @@ This move to a different secure server means that all ssh to the server now need

    Wookey: July 2019

    -

    troggle has been migrated to git, and the old erebus and cvs branches (pre 2010) removed. Some decrufting was done to get rid of log files, old copies of embedded javascript (codemirror, jquery etc) and some fat images no longer used. +

    The troggle software has been migrated to git, and the old erebus and cvs branches (pre 2010) removed. Some decrufting was done to get rid of log files, old copies of embedded javascript (codemirror, jquery etc) and some fat images no longer used.

    -tunneldata has also been migrated to git, and renamed 'drawings' as it includes therion data too these days. +The tunneldata repo has also been migrated to git, and renamed 'drawings' as it includes therion data too these days.

    -The loser repo and expoweb repo need more care in migration. Loser should have the old 1999-2004 CVS history restored, and maybe toms annual snapshots from before that, so ancient history can usefully be researched (sometimes useful). It's also a good idea to add the 2015, 2016 and 2017 ARGE data we got (in 2017) added in the correct years so that it's possible to go back to an 'end of this year' checkout and get an accurate view of what was found (for making plots and length stats). All of that requires some history rewriting, which is best done at the time of conversion. +The loser repo and expoweb repo need more care in migration (expoweb is the website content - which is published by troggle). Loser should have the old 1999-2004 CVS history restored, and maybe Tom's annual snapshots from before that, so ancient history can usefully be researched (sometimes useful). It's also a good idea to add the 2015, 2016 and 2017 ARGE data we got (in 2017) added in the correct years so that it's possible to go back to an 'end of this year' checkout and get an accurate view of what was found (for making plots and length stats). All of that requires some history rewriting, which is best done at the time of conversion.

    Similarly expoweb is full of bloat from fat images and surveys and one 82MB thesis that got checked in and then removed. Clearing that out is a good idea. I have a set of 'unused fat blob' lists which can be stripped out with git-gilter. It's not hard to make a 'do the conversion' script, ready for sometime after expo 2019 has calmed down.

    April 2020

    -Wookey is now preparing to move 'expoweb' and 'loser' from mercurial to git "as-is" and then to use the git tools to patch up the history and to remove redundancies, rather than the original plan to tidy them up during the move. +Wookey is now preparing to move 'expoweb' and 'loser' from mercurial to git "as-is" and then to use the git tools to patch up the history and to remove redundancies, rather than the original plan to tidy them up "at the time of conversion".

    Sam continues to work on upgrading django from v1.7 . We are using python 2.7.17 and while we could upgrade to Python v3 using the same version (1.7) of django, we would rather upgrade django as much as possible first before we tackle that. Old versions of django have unpatched security issues.

    "Django 1.11 is the last version to support Python 2.7. Support for Python 2.7 and Django 1.11 ends in 2020." see: django versions.

    Enforced time at home is giving us a new impetus to writing and restructuring the documentation for everything.

    - -Return to
    -Website history
    +Go on to: Troggle maintenance manual
    +
    +Return to:
    Troggle intro
    +Website history