docum update

This commit is contained in:
Philip Sargent 2023-01-29 15:26:34 +00:00
parent 04b7b1d549
commit e65b6aae9a
3 changed files with 47 additions and 133 deletions

View File

@ -43,9 +43,8 @@ li.todo:before {
<h3>Module to-do texts</h3>
<p>These are extracted directly from the <var>todo = &apos;&apos;&apos;Thing to do &apos;&apos;&apos;</var> string at the top of each file of troggle code:</p>
<hr>
<a href="/todo/anything"><div>
<embed type='text/html' height='100px' width='800px' src="/todo/anything"><br>
Click here if no todo list appears here (because 'frames' have been disabled).</div></a> This list is generated directly from the troggle python code files.
<div>
<a href="/todo/anything">Click here to see the programmers' to do within the code.</div></a> This list is generated directly from the troggle python code files.
<hr>
<h3>Other coding To Do things</h3>
@ -56,66 +55,35 @@ Click here if no todo list appears here (because 'frames' have been disabled).</
<li class="todo"><a href="/handbook/troggle/trog2030.html">Troggle in 2025-2030</a>
</ol>
<h3>Process Documentation</h3>
<details><summary><!--2020-03-26 psargent-->Wallets and new-cave</summary>
<details><summary><!--2020-03-26 psargent-->New-cave</summary>
<li class="todo"><!--2020-03-26 psargent-->Explain how to link a new cave into the other caves in
troggle filesystem
<li class="todo"><!--2020-03-26 psargent-->Explain how to add photos with the correct URL format to sub-HTML files attached to New Caves
<li class="todo">explain how to put stuff in the wallet folder and how to look at expofiles/photos/xml/
</details>
<details><summary><!--2021-10-31 psargent-->Scans and Drawings Uploads</summary>
<li class="todo">Add to user data manual how to upload to expofiles - in the "survey manual"
<li class="todo">Add in description of *where* to put the drawings files
</details>
<details><summary><!--2020-04-13 psargent-->svx check</summary>
<li class="todo">explain command line to run on newly typed survex file to check for format errors '$cavern xxxx.svx'
<li class="todo">explain when to use svxtrace.py <a href="troggle/scriptscurrent.html">current scripts</a>
<li class="todo">Making an svx - explain how to make link to *ref to wallet folder
<details><summary><!--2020-04-13 psargent-->svx check on import/upload/edit</summary>
<li class="todo">explain command line to run on newly typed survex file to check for format errors '$cavern xxxx.svx' AS WELL AS doing it online
</details>
<h3>Wallets re-programming</h3>
<details><summary><!--2021-05-21 psargent-->Things wallets.py might do in future </summary>
<li class="todo">- integrate into troggle, remove as a distinct script
<li class="todo">- relates to conversion of the XRF shell script into python/troggle too
<li class="todo">- checking the cave number specified matches the folder for the .svx file,
<li class="todo">- checking that the *ref: filed in the survex file is the same as the wallet nameS
<li class="todo">- detecting whether there is a description or a list of QMs in the survex file,
<li class="todo">- checking the name of the cave against the cave number,
<li class="todo">- checking whether the website page even exists for this cave,
<h3>Wallets extras</h3>
<details><summary><!--2023-01-29 psargent-->Things wallets.py might do in future </summary>
<li class="todo">- being more intelligent about .topo files and thus the lack of scan files,
<li class="todo">- checking the date is in the recent past etc.
</details>
<h3>Surveys data entry documentation</h3>
<details><summary>Write code to automatically extract ref info about wallets from tunnel xml files</summary>
<li class="todo"><!--2020-04-03 psargent-->This will replace :drawings:chk-xml.txt as used by :drawings:check-xml.sh
<li class="todo"><!--2020-04-03 psargent-->Do similar for Therion files when people start using #REF comments
</details>
<details><summary><!--2020-03-26 psargent-->2019 surveyscans</summary>
<li class="todo"><!--2020-03-26 psargent-->edit all the content.json files
<li class="todo"><!--2020-03-26 psargent-->try to autocomplete the content.json by parsing .svx files
<li class="todo"><!--2020-03-26 psargent-->Put personal names into canonical form
</details>
<details><summary>2014 contents.json</summary>
<li class="todo"><!--2020-04-03 psargent-->parse all the svx files to extract people, dates & svx references
</details>
<h3>Handbook</h3>
<details><summary><!--2020-04-11 psargent-->Navigation - Context, Situational Awareness</summary>
<details><summary><!--2020-04-11 psargent-->Layout and format</summary>
<li class="todo"><!--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:
<li class="todo"><!--2020-04-11 psargent-->Not fixed by menus - breadcrumbs needed?
<li class="todo"><!--2020-04-11 psargent-->Diagrams of major sections: survey handbook, rigging handbook, computing handbook, Areas, cave data..
<li class="todo"><!--2020-04-11 psargent-->Chase Airoa to help fix <a href="../troggle/menudesign.html">the menus for phones</a>
<li class="todo"><!--2020-04-11 psargent-->Look at <a href="https://www.gov.uk/guidance/government-design-principles">gov.uk guidelines</a> for inspiration</details>
<h3>Areas and prospecting guides</h3>
<h3>Areas </h3>
<details><summary>Areas (these are the sub-areas)</summary>
<li class="todo"><!--2020-05-01 psargent-->Downgrade the "areas" aspect of the documentation as we don't use these now
<li class="todo"><!--2023-01-29 psargent-->Remove or rename areas in the troggle code
</details>
@ -133,52 +101,10 @@ Click here if no todo list appears here (because 'frames' have been disabled).</
</details>
<h3>Laptop config.</h3>
<details><summary><!-- 2020-04-11 psargent --> imagemagick convert</summary>
<li class="todo"><!--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 & to extract PDFs, JPEGs. Need to edit /etc/ImageMagick-6/policy.xml
<a href="https://cromwell-intl.com/open-source/pdf-not-authorized.html">cromwell-intl.com/open-source/pdf-not-authorized.html</a>
</details>
<h3>System Documentation</h3>
<details><summary><!--2020-04-11 psargent-->Document how we generate the SMK overall lengths and stats</summary>
<li class="todo"><!--2020-04-20 psargent-->scripts and manual actions in cavern
<li class="todo">smklengths.sh script
<li class="todo">smklengsths.odt
</details>
<details><summary><!--2020-04-20 psargent-->:loser:/docs/ files</summary>
<li class="todo">Questions.txt
<li class="todo">SMKlog.txt
</details>
<details><summary><!--2020-03-26 psargent-->Troggle architecture</summary>
<li class="todo"><!--2020-04-10 psargent-->Regenerate the diagram of the tables in the database & document
<li class="todo"><!--2020-04-10 psargent-->Describe the parsing/import procedures so non-nerds can do it
</details>
<details><summary><!--2020-03-26 psargent-->Surveyscans</summary>
<li class="todo"><!--2020-03-26 psargent-->explain where the image files are referenced from: svx, tunnel/therion, and
<li class="todo">Be exhaustive in checking all the broken links between svx & wallets
</details>
<details><summary>Makefile</summary>
<li class="todo">Get it working ! How many of <a href="../troggle/scriptsother.html">other scripts</a> should be in it ? Should we do data imports to schedule too ?
</details>
<h3>Troggle</h3>
<details><summary><!--2022-02-15 psargent--> Expo log parsing</summary>
<li class="todo">Parsing broken on several old expo logs, excluded in the source code
</details>
<details><summary><!--2021-11-06 psargent--> CaveView fixing</summary>
@ -186,23 +112,6 @@ Click here if no todo list appears here (because 'frames' have been disabled).</
</details>
<details><summary><!--2021-11-04 psargent--> non-server, non-Apache links to Cave HTML i/t/l pages ALL BROKEN</summary>
<li class="todo">http://expo.survex.com/1623/others/l/113day.htm works but, and
<li class="todo">http://localhost:8000/1623/others/l/113day.htm works but
<li class="todo">http://localhost:8000/cave/others/l/purple.htm is a 404 as troggle urls.py doesn't do it at all
<li class="todo">Ah it is because of the 'cave' page being at /cave/ instead of sent to /1623/ which is the problem..
</details>
<details><summary><!-- 2020-04-11 psargent -->Troggle parser/viewer </summary>
<li class="todo">Explain how expopages (formerly flatpages) work. refer to computing/hbmanual1.html
</details>
<details><summary><!--2020-07-24 psargent--> Completely new design of QM management needed</summary>
<li class="todo"><!--2020-07-24 psargent-->see <a href="../troggle/scriptsqms.html">QM status and redesign needed document</a>
</details>
<h3>Troggle Refactoring</h3>
<details><summary><!--2022-02-15 psargent-->MIME types and filename extensions</summary>
@ -213,48 +122,42 @@ We should use <a href="https://github.com/ahupp/python-magic">python-magic</a> o
But note that there are TWO packages called python-magic, see https://stackoverflow.com/questions/436220/how-to-determine-the-encoding-of-text/16203777#16203777
</details>
<details><summary><!--2020-07-24 psargent-->Make parsers use generators to yield one line at a time</summary>
<li class="todo"><!--2020-07-24 psargent-->Both recursive load and linear load parsers/survex could do this.
<li class="todo"><!--2020-07-24 psargent-->In the logbooks parsing and cache loading.
</details>
<details><summary><!--2020-07-24 psargent-->Enhance some exceptions with dataIssue [NOTIFICATION pattern], not just in parsers</summary>
<li class="todo"><!--2020-07-24 psargent-->https://martinfowler.com/articles/replaceThrowWithNotification.html
</details>
<details><summary><!--2020-07-24 psargent-->Python documentation: Django's use of modern unobvious idioms</summary>
<li class="todo"><!--2020-07-24 psargent-->[DECORATOR] pattern used for login-required pages
<li class="todo"><!--2020-07-24 psargent-->Get all trogglistas to read https://ebookscart.com/effective-python-by-brett-slatkin-pdf-download/ - downloded to /expofiles/
<li class="todo"><!--2020-07-24 psargent-->Get all trogglistas to read https://martinfowler.com/tags/refactoring.html
</details>
<details><summary><!--2020-07-24 psargent-->expopages is used to deliver CSS and JS for django admin pages,</summary>
</details>
<details><summary><!--2022-02-19 psargent-->gardening our main model files for unused things</summary>
<li class="todo">get rid of 'expeditionday' as a concept everywhere ?
</details>
<details><summary><!--2022-02-19 psargent-->Make QM a first-class 'thing' and manage them explicitly in troggle</summary>
<li class="todo">after fixing the display of QMs from the existing hodge-podge
</details>
<h3>Expo Server</h3>
<details><summary><!--2020-07-24 psargent--> document cgit installation and config</summary>
<li class="todo"><!--2020-07-24 psargent-->as per Wookey on Debian 10
<li class="todo"><!--2020-07-24 psargent-->as per Wookey on Debian 10. Finish merging Wookey's instructions into handbook
</details>
<details><summary>MySQL configuration </summary>
<li class="todo"><!--2022-02-18 psargent-->robots.txt completely missing from /home/expo/static or troggle:/media
<li class="todo"><!--2020-05-14 psargent-->Document "anacron" / cron system on server
</details>
<details><summary>anacron and cron </summary>
<li class="todo"><!--2020-05-14 psargent-->Document "anacron" / cron system on server
</details>
<h3>The To Do pages</h3>
<p>We were working on a more capable and easier-to-use to-do system which would mimic
how <a href="https://github.com/CaveSurveying/CUCCexposurveyissues/issues">GitHub Issues</a> do this sort of thing,
but now we are just going to use standard HTML5 tags.
but now we are just using standard HTML5 tags. OK, using RST could be explored: <a href="todo.rst">todo.rst</a> but we don't have a renderer/editor for it yet.
But <a href="/handbook/computing/todo.html_edit">you can edit this page</a> very easily.
<hr>
See also <a href="todo-data.html">Data maintenance to-do list</a><br />

View File

@ -30,14 +30,7 @@ the caving</a>!
<hr />
<div class="tripdate" id="1997_s46">1997-07-08</div>
<div class="trippeople"><u>Duncan Collis</u>, William Stead, Jon Barber, Phil Underwood, </div>
<div class="triptitle"> 161 - Derigging SEP </div>
Dunks_, William -- TU 11 hour Jon, Phil U --&gt; TU 6&frac12; hour <br /><br />Derigged. <br /><br />Previous trips: <a href="#id1997-161-20">Fuzzy Logic</a> / <a href="#id1997-161-22">SEP</a> / <a href="../1998/log.htm#id1998-161-5">Next Siberia trip</a> (rig-in 1998)
<div class="timeug">T/U: 0.0 hours</div>
<hr />
<div class="tripdate" id="1997_s01">1997-07-18</div>
<div class="trippeople"><u>Mike Richardson</u>, Sam Lieberman, Dave Horsley, </div>
@ -435,6 +428,23 @@ TU 17hr <br /><br />Pushed below _S.E.P._<br> Whacked in loads of _Bolts_<br> Ab
<hr />
<div class="tripdate" id="1997_s46">1997-08-08</div>
<div class="trippeople"><u>Duncan Collis</u>, William Stead, Jon Barber, Phil Underwood, </div>
<div class="triptitle"> 161 - Derigging SEP </div>
Dunks_, William -- TU 11 hour Jon, Phil U --&gt; TU 6&frac12; hour
<br /><br />Derigged.
<br /><br />[mis-dated as July not August, and nobody noticed for 26 years - Philip S.]
<!--
Previous trips: <a href="#id1997-161-20">Fuzzy Logic</a> / <a href="#id1997-161-22">SEP</a> / <a href="../1998/log.htm#id1998-161-5">Next Siberia trip</a> (rig-in 1998)-->
<div class="timeug">T/U: 11.0 hours</div>
<hr />
<div class="tripdate" id="1997_s43">1997-08-08</div>
<div class="trippeople"><u>Dave Horsley</u>, Brian Outram, Mike Baslington, </div>
<div class="triptitle"> 161 - Derig of Wheelchair Access </div>

View File

@ -290,7 +290,7 @@ Large hole, craps out.
<hr />
<div class="tripdate" id="t2022-08-01b">2022-08-01</div>
<div class="tripdate" id="t2022-08-01c">2022-08-01</div>
<div class="trippeople">Luke Stangroom, Mike Butcher, <u>Jonty Pine</u>, </div>
<div class="triptitle">Fishface</div>
@ -1485,6 +1485,7 @@ With camp packed up, we started the long, muddy slog up Mongol Rally, weighed do
<div class="triptitle">Balcony - Derig</div>
<br /><br />Setting off from top camp 2 hours after Becka's group we descended and met the last camp team at the bottom of Honeycomb. Nat continued down to assist the first derig team at Mongol Rally. Tobias and I assisted Charlotte, Jono and Hannah with their bags back to the water that comes in near Natural Highs.
<br /><br />
Tobias, Hannah, Charlotte and Jono left for the surface and I went 2 minutes back to take a bag off of Becka. Back at the water spot I set up a stove for noodles and smash while the others hung the rope in the water in anticipation for the next couple of days of deluge. All set up and fed we left the cave and went back to top camp in sweaty conditions.
<div class="timeug">T/U: 0.0 hours</div>