expoweb/handbook/computing/todo.html

322 lines
15 KiB
HTML
Raw Normal View History

2020-04-10 13:09:12 +01:00
<!DOCTYPE html>
<html>
<head>
<title>Expo Systems - To-Do List</title>
<meta charset="utf-8">
<meta name="keywords" content="NOEDIT">
</head>
2020-04-13 12:46:57 +01:00
<body>
<h1>Expo To-Do List</h1>
<link rel="stylesheet" type="text/css" href="todo-styles.css" />
2020-04-10 13:09:12 +01:00
<button onclick="window.location.href = 'todo.html_edit';">Edit this to-do list</button>
2020-04-13 12:46:57 +01:00
<!--
2020-04-10 13:09:12 +01:00
<button onclick="window.location.href = 'x-todo.html_edit';">Update this to-do list</button>
-->
2020-04-13 12:46:57 +01:00
<!--
<label for="toggle-1">Toggle visibility of all sub-items</label>
<input type="checkbox" id="toggle-1">
-->
<!-- ------------------- Don't touch anything above this line --------------------------->
2020-04-10 13:09:12 +01:00
<h2>How this works</h2>
2020-04-13 12:46:57 +01:00
<p><b>Click on a sub-heading to reveal</b> the individual to-do items. Click again to hide.<br />
2020-04-10 13:09:12 +01:00
If a heading is in italics, then there are hidden items.
2020-04-13 12:46:57 +01:00
<p><b>Click on the main "How this works" heading</b> to toggle reveal/hide <b>everything.</b>
2020-04-10 13:09:12 +01:00
<p>Printing this page uses a much smaller font. Complain to <a href="mailto:expo-tech@lists.wookware.org">the nerd list</a> if you don't like this behaviour.
<p>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.
<p>We are working on a more capable and easier-to-use system (see <a href="x-todo.html">x-todo.html</a>) which will mimic how <a href="https://github.com/CaveSurveying/CUCCexposurveyissues/issues">GitHub Issues</a> do this sort of thing.
<h3>Process Documentation</h3>
<dl>
<dt><!--2020-03-26 psargent-->Wallets and new-cave</dt>
2020-04-13 12:46:57 +01:00
<dd><!--2020-03-26 psargent-->Explain (in the wallets process) how to view the surveys
2020-04-10 13:09:12 +01:00
online so that <br>&nbsp;&nbsp;(1) you can see an example of how to do your new one,
and <br>&nbsp;&nbsp;(2) so that you can check that you have done it properly when you
have finished.</dd>
2020-04-13 12:46:57 +01:00
<dd><!--2020-03-26 psargent-->Explain how to link a new cave into the other caves in
2020-04-10 13:09:12 +01:00
troggle filesystem</dd>
2020-04-13 12:46:57 +01:00
<dd><!--2020-03-26 psargent-->Explain how to add photos with the correct URL format to sub-HTML files attached to New Caves</dd>
<dt><!--2020-04-13 psargent-->svx check</dt>
2020-04-10 13:09:12 +01:00
<dd>explain command line to run on newly typed survex file to check for format errors '$cavern xxxx.svx'
2020-04-13 12:46:57 +01:00
<dd>explain when to use svxtrace.py <a href="troggle/scriptscurrent.html">current scripts</a>
<dt><!--2020-04-13 psargent-->QMs check</dt>
<dd>explain when to use svx2qm.py -> qms.csv-> tablize-qms.pl <a href="troggle/scriptscurrent.html">current scripts</a>
<dd>explain when to use find-dead-qms.py and qmreader.pl <a href="troggle/scriptscurrent.html">current scripts</a>
2020-04-10 13:09:12 +01:00
</dl>
2020-04-13 12:46:57 +01:00
2020-04-10 13:09:12 +01:00
<h3>Surveys data entry</h3>
<dl>
2020-04-13 12:46:57 +01:00
<dt><!--2020-04-13 psargent-->QMs check</dt>
<dd>Collect together the old "to do" and "readme" notes and put them in a standard place: expoweb/[year]/TODO.html(with self-edit instructionslike this page)
2020-04-10 13:09:12 +01:00
<dt>Write code to automatically extract ref info about wallets from tunnel xml files
<dd><!--2020-04-03 psargent-->This will replace :drawings:chk-xml.txt as used by :drawings:check-xml.sh
<dd><!--2020-04-03 psargent-->Do similar for Therion files when people start using #REF comments
<dt><!--2020-03-26 psargent-->2019 surveyscans
<dd><!--2020-03-26 psargent-->edit all the content.json</dd>
<dd><!--2020-03-26 psargent-->try to autocomplete the content.json by parsing .svx files</dd>
<dd><!--2020-03-26 psargent-->Put personal names into canonical form</dd>
<dt>2014 contents.json
<dd><!--2020-04-03 psargent-->parse all the svx files to extract people, dates & svx references
</dl>
<h3>Logbook fettling</h3>
<dl>
<dt>2019 Logbook</dt>
<dd>
transcribe the rest of those UKcaving blog entries into expoweb/years/2019/logbook.html</dd>
<dd><!--2020-04-03 psargent-->
copy the photos from the UKCaving blog into expofiles/photos/2019/<MyName>/ -- in fact many of those photos are already there</dd>
<dd><!--2020-04-03 psargent-->edit in the links to those photos in the right place in 2019/logbook.html</dd>
<dt>Garlic cave
<dd> edit logbook entries 2018, 2019 to link to extensive photos of Garlic cave area {Withnall 2018} , {Becka 2019}
<dt>Past logbooks - missing images?
<dd><!--2020-04-03 psargent-->Which previous years HTML logbooks are missing images extracted from scanned PDF copies of the logbooks?
<dt>imagemagick convert
<dd><!--2020-04-03 psargent-->Not working for PDFs on current version of xubuntu ! Fix & document. Also not working on WSL ubuntu. Needed to work with logbook images easily.
<dt>2018 Logbook</dt>
<dd>Check Natalie Uomini's typed entries and extensive photos are minimized and linked in properly to the HTML logbook
<dt>Add missing images to logbooks</dt>
<dd>
2000, 2008, 2009, 2011</dd>
<dd>
fix corrupted image in 2001 log</dd>
<dt>2011 logbook:</dt>
<dd>type up via-ferrate & bolt-testing writeups (In paper book, not in scan or HTML)</dd>
<dt>200? logbook:</dt>
<dd>
Type up "list of GPS locations still to type"</dd>
</dl>
<h3>Handbook</h3>
<dl>
<dt><!--2020-04-11 psargent-->Desperately needs Navigation - Location Context, Situational Awareness
<dd><!--2020-04-11 psargent-->No overall view of what there is: need a user-friendly diagrammatic overview <a href="https://en.wikipedia.org/wiki/Site_map">sitemap</a>. There are 4,869 files in :expoweb:</dd>
<dd><!--2020-04-11 psargent-->Not fixed by menus - breadcrumbs needed?</dd>
<dd><!--2020-04-11 psargent-->Diagrams of major sections: survey handbook, rigging handbook, computing handbook, Areas, cave data..</dd>
<dd><!--2020-04-11 psargent-->Chase Airoa to help fix <a href="../troggle/menudesign.html">the menus for phones</a></dd>
<dd><!--2020-04-11 psargent-->Look at <a href="https://www.gov.uk/guidance/government-design-principles">gov.uk guidelines</a> for inspiration</dd>
<dt><!--2020-04-11 psargent-->When git migration done
<dd>Edit out all mercurial
<dd>Split the TortoiseHg/PuTTy documentationa nd retain only PuTTy
<dt><!--2020-04-11 psargent-->Wookey Overview presentation
<dd>extract content from <a href="http://wookware.org/talks/expocomputer/#/10">Troggle</a> which does not render properly and extract the HTML not in slide format - correcting things now outdated.
2020-04-13 12:46:57 +01:00
</dl>
<h3>Photos</h3>
<dl>
<dt><!--2020-04-03 psargent-->Fix the BINS package
2020-04-10 13:09:12 +01:00
<dd><!--2020-04-03 psargent-->set up git on the BINS software? Fix base url sautret.org</dd>
<dd><!--2020-04-03 psargent-->set up a cron / Makefile job to run BINS</dd>
<dd><!--2020-04-03 psargent-->why is 'updatephotos' script in expofiles? </dd>
<dd>Document the ~expo/webphotos/ directory and how it works
<dd>Why does expofiles/photos/xml/ get created containing all the generated xml files? Fix this.
2020-04-13 12:46:57 +01:00
</dl>
2020-04-10 13:09:12 +01:00
<h3>System Documentation</h3>
<dl><!-- 2020-04-11 psargent -->
2020-04-10 13:09:12 +01:00
<dt><!--2020-04-11 psargent-->Document how we generate the SMK overall lengths and stats</dt>
<dd><!--2020-04-11 psargent-->scripts and manual actions in cavern
<dt><!--2020-03-26 psargent-->Troggle architecture</dt>
<dd><!--2020-03-26 psargent-->Handbook: add more to the new troggle architecture documentation. For future system maintainers</dd>
<dd><!--2020-04-10 psargent-->Regenerate the diagram of the tables in the database & document</dd>
<dd><!--2020-04-10 psargent-->Describe the parsing/import procedures so non-nerds can do it</dd>
<dd><!--2020-03-26 psargent-->Copy [some of] the .wiki material into the documentation somewhere</dd>
<dt><!--2020-03-26 psargent-->Surveyscans</dt>
<dd><!--2020-03-26 psargent-->explain where the image files are referenced from: svx, tunnel/therion, and </dd>
<dd>why there are so many broken links</dd>
<dt>Apache & MySQL configuration
<dd><!--2020-04-03 psargent-->DOCUMENT How to set up a server
<dd><!--2020-04-10 psargent-->Explain why Docker containers can be a maintenance nightmare
<dt>non-troggle scripts
<dd><!--2020-04-03 psargent-->DOCUMENT them all - have we got <a href="../troggle/otherscripts.html">a full list</a>?
</dl>
2020-04-13 12:46:57 +01:00
2020-04-10 13:09:12 +01:00
<h3>Troggle</h3>
<dl>
<dt>Better import error messages
<dd><!--2020-04-03 psargent-->REPORT if import surveyscan file failure
<dd><!--2020-04-03 psargent-->Why are so many surveyscan foolder missing after import?
<dd><!--2020-04-03 psargent-->WHY are total lengths of surveyed cave different between expo server and WSL server for 2019 and a few other years only ?
<dt><!-- 2020-04-11 psargent -->NOEDIT flag
<dd><!-- 2020-04-11 psargent -->Describe how this is implemented using &lt;meta name="keywords" content="NOEDIT"&gt;
2020-04-10 13:20:39 +01:00
2020-04-10 13:09:12 +01:00
<dt>Logbook data model: unfilled fields?
<dd><!--2020-04-03 psargent-->'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?
</dl>
2020-04-13 12:46:57 +01:00
<h3>Expo Server</h3>
<dl>
<dt><!--2020-03-26 psargent--> document directory structure
<dd><!--2020-04-03 psargent-->as per Julian's GitHub list - then close that issue</dd>
2020-04-10 13:09:12 +01:00
<dt>permissions
<dd><!--2020-04-03 psargent-->do we need a cron job or has the group membership fix fixed it ? either way, document it.
</dd>
</dl>
<h3><font color="fuchsia">Tackle Store Records</font></h3>
<dl>
<dt>No authoritative list of where the expo paper records are!
<dd><!--2020-04-03 psargent-->NO expo paperwork at all prior to 2008 in Tackle Store - where is it ?
<dd><!--2020-04-03 psargent-->FIND where all the wallet binders are, and the logbooks.
< <dd><!--2020-04-03 psargent--> BUY A4 plastic boxes for filing cabinet for logbooks getting damp there.
<dd>2017, 2018, 2019 wallet binders are in Philip S.'s house.
</dl>
2020-04-13 12:46:57 +01:00
<h3>
<font color="fuchsia">This to-do-list gadget itself</font>
</h3>
2020-04-10 13:09:12 +01:00
<dl>
<dt>Status
<dd>Try the <a href="x-todo.html"><em>Experimental</em> to-do list</a> - no extra display capabilities yet.
<dd>Fix the "click twice" on startup. Make it only click once to change display state of the DT tag
2020-04-13 12:46:57 +01:00
<dt><!--2020-03-26 psargent-->Eventual aim
<dd><!--2020-03-26 psargent-->to replace GitHub <a href="https://github.com/CaveSurveying/CUCCexposurveyissues/issues">
CUCCexposurveyissues</a> for non-tunnel, non-GIS issues.</dd>
<dd><!--2020-03-26 psargent-->We need two of these: <br>1.for expo systems work (troggle & scripts) - the current priority as we have nowhere currently that Wookey is willing to use
<br>2.for survey data progress/issues (though troggle itself can be used for some of this if cleaned up a bit)
</dd>
<dt><!--2020-03-26 psargent-->Try to automate simple functions in javascript
<dd><!--2020-03-26 psargent-->to control this document
in-place (tick, delete) instead of using the <a
href="https://www.tiny.cloud/docs/general-configuration-guide/use-tinymce-inline/">
tinymce</a> HTML editor in Django</dd>
2020-04-10 13:09:12 +01:00
<dd><!--2020-03-26 psargent-->Maybe restructure whole page as JSON and use
javascript editor to create (edit), re-order and demote items. </dd>
<dd><!--2020-03-26 psargent-->if using tinymcs, use the INLINE mode. </dd>
2020-04-13 12:46:57 +01:00
<dd><!--2020-03-26 psargent-->Implement comments on an issue, mimicking GitHub issues wiki</dd>
<dd><!--2020-03-26 psargent-->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.</dd>
2020-04-10 13:09:12 +01:00
<dd><!--2020-03-26 psargent-->checkboxes so that items can be ticked (which also does strike-through)</dd>
<dd><!--2020-04-03 psargent-->promotion/demotion options?</dd>
2020-04-13 12:46:57 +01:00
<dd><!--2020-03-26 psargent-->bin icon to delete an item? Better to have an archive process.</dd>
2020-04-10 13:09:12 +01:00
<dt>Local WSL server
<dd><!--2020-04-03 psargent-->Why is it using recuced-capability tinymce, a paths problem ?
<dt>Italics management
<dd><!--2020-04-03 psargent-->Hide ALL DD if any Heading clicked.
<dd><!--2020-04-03 psargent-->Put DL into italics when *any* DD is hidden
2020-04-13 12:46:57 +01:00
2020-04-10 13:09:12 +01:00
</dl>
2020-04-13 12:46:57 +01:00
<hr>
<!-- ------------------- Do not touch anything below here either ------------------------>
2020-04-10 13:09:12 +01:00
<!--2020-03-26--> Testing area..
<div id="demo">Demonstation text as initially read from disc</div>
2020-04-13 12:46:57 +01:00
<script>
document.getElementById("demo").innerHTML = "Demonstation innerHTML change CONFIRMED";
2020-04-10 13:09:12 +01:00
</script>
2020-04-13 12:46:57 +01:00
<!--Bother. The DOM is not carried across to the _edit page. It looks like the _edit page just re-reads
the original file from disc. So storing changes done by js will mean working directly with the POST action and a form. -->
2020-04-10 13:09:12 +01:00
<script>
// TO DO - make the <dt> italic when any of the <dd> following it are hidden.
2020-04-13 12:46:57 +01:00
// Set up the click handlers:
var itemlist = document.getElementsByTagName('h2');
for (i = 0; i < itemlist.length; i++) {
itemlist[i].onclick = h2toggle;
}
var itemlist = document.getElementsByTagName('dd');
for (i = 0; i < itemlist.length; i++) {
itemlist[i].onclick = hideable;
}
var itemlist = document.getElementsByTagName('dt');
for (i = 0; i < itemlist.length; i++) {
2020-04-10 13:09:12 +01:00
itemlist[i].onclick = showable;
2020-04-13 12:46:57 +01:00
}
function showable () {
// When clicking on a <dt> item, show or not all the following <dd> elements
if (this.style.fontStyle != "italic") {
this.style.fontStyle = "italic";
} else {
this.style.fontStyle = "normal";
}
var ddO = this.nextElementSibling;
while((ddO !== null) && (ddO.nodeName.toLowerCase() == 'dd')){
if (this.style.fontStyle != "normal") {
ddO.style.display = 'none';
} else {
ddO.style.display = 'block';
}
ddO = ddO.nextElementSibling;
}
}
function hideable () {
2020-04-10 13:09:12 +01:00
// When clicking on a <dd> item, show or not itself
2020-04-13 12:46:57 +01:00
var x = this;
if (x.style.display != "block") {
x.style.display = "block";
} else {
x.style.display = "none";
}
}
function h2toggle () {
// When clicking on a <h2> item, toggle the display of absolutely everything
var itemlist = document.getElementsByTagName('dd');
for (i = 0; i < itemlist.length; i++) {
x = itemlist[i]
if (x.style.display != "block") {
x.style.display = "block";
} else {
x.style.display = "none";
}
}
var dtlist = document.getElementsByTagName('dt');
for (i = 0; i < dtlist.length; i++) {
x = dtlist[i]
if (x.style.fontStyle != "normal") {
x.style.fontStyle = "normal";
} else {
x.style.fontStyle = "italic";
}
}
}
</script>
2020-04-10 13:09:12 +01:00
<hr /></body>
</html>