todo updates

This commit is contained in:
Philip Sargent 2021-05-03 00:53:48 +01:00
parent e20dca50c7
commit 5708b906c5

View File

@ -43,7 +43,7 @@ If a heading is in italics, then there are hidden items.
<h3>Process Documentation</h3>
<details><summary><!--2020-03-26 psargent-->Wallets and new-cave</summary>
<li><!--2020-03-26 psargent-->Explain how to link a new cave into the other caves in
troggle filesystem</dd>
troggle filesystem
<li><!--2020-03-26 psargent-->Explain how to add photos with the correct URL format to sub-HTML files attached to New Caves
@ -79,9 +79,9 @@ If a heading is in italics, then there are hidden items.
</details>
<details><summary><!--2020-03-26 psargent-->2019 surveyscans</summary>
<li><!--2020-03-26 psargent-->edit all the content.json files</dd>
<li><!--2020-03-26 psargent-->try to autocomplete the content.json by parsing .svx files</dd>
<li><!--2020-03-26 psargent-->Put personal names into canonical form</dd>
<li><!--2020-03-26 psargent-->edit all the content.json files
<li><!--2020-03-26 psargent-->try to autocomplete the content.json by parsing .svx files
<li><!--2020-03-26 psargent-->Put personal names into canonical form
</details>
@ -92,164 +92,158 @@ If a heading is in italics, then there are hidden items.
<h3>Handbook</h3>
<details><summary><!--2020-04-11 psargent-->Navigation - Context, Situational Awareness</summary>
<li><!--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>
<li><!--2020-04-11 psargent-->Not fixed by menus - breadcrumbs needed?</dd>
<li><!--2020-04-11 psargent-->Diagrams of major sections: survey handbook, rigging handbook, computing handbook, Areas, cave data..</dd>
<li><!--2020-04-11 psargent-->Chase Airoa to help fix <a href="../troggle/menudesign.html">the menus for phones</a></dd>
<li><!--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><!--2020-04-11 psargent-->Not fixed by menus - breadcrumbs needed?
<li><!--2020-04-11 psargent-->Diagrams of major sections: survey handbook, rigging handbook, computing handbook, Areas, cave data..
<li><!--2020-04-11 psargent-->Chase Airoa to help fix <a href="../troggle/menudesign.html">the menus for phones</a>
<li><!--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>
<details><summary>Areas (these are the sub-areas)</summary>
<li><!--2020-05-01 psargent-->Downgrade the "areas" aspect of the documentation as we don't use these now
</details>
<details><summary>Prospecting Guides & slippy map & GPS tracks</summary>
<li><!--2020-07-24 psargent-->Redesign to be used as overlay on phone/tablet using essentials.gpx data
</details>
<h3>Photos</h3>
<dl>
<dt><!--2020-04-03 psargent-->Fix the BINS package (Wookey is looking for replacement)
<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.
<dt>galley thumbs etc.
<dd>:expoweb:/galley/0.htm thumbnails not loading
<details><summary><!--2020-04-03 psargent-->Fix the BINS package (Wookey is looking for replacement)</summary>
<li><!--2020-04-03 psargent-->set up git on the BINS software? Fix base url sautret.org
<li><!--2020-04-03 psargent-->set up a cron / Makefile job to run BINS
<li><!--2020-04-03 psargent-->why is 'updatephotos' script in expofiles?
<li>Document the ~expo/webphotos/ directory and how it works
<li>Why does expofiles/photos/xml/ get created containing all the generated xml files? Fix this.
</details>
<details><summary>galley thumbs etc.</summary>
<li>:expoweb:/galley/0.htm thumbnails not loading
</dl>
</details>
<h3>Laptop config.</h3>
<dl>
<dt><!-- 2020-04-11 psargent --> 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 & to extract PDFs, JPEGs. Need to edit /etc/ImageMagick-6/policy.xml
<details><summary><!-- 2020-04-11 psargent --> imagemagick convert</summary>
<li><!--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>
</dl>
</details>
<h3>System Documentation</h3>
<dl><!-- 2020-04-11 psargent -->
<dt><!--2020-04-11 psargent-->Document how we generate the SMK overall lengths and stats</dt>
<dd><!--2020-04-20 psargent-->scripts and manual actions in cavern
<dd>smklengths.sh script
<dd>smklengsths.odt
<dt><!--2020-04-20 psargent-->:loser:/docs/ files
<dd>Questions.txt
<dd>SMKlog.txt
<details><summary><!--2020-04-11 psargent-->Document how we generate the SMK overall lengths and stats</summary>
<li><!--2020-04-20 psargent-->scripts and manual actions in cavern
<li>smklengths.sh script
<li>smklengsths.odt
</details>
<details><summary><!--2020-04-20 psargent-->:loser:/docs/ files</summary>
<li>Questions.txt
<li>SMKlog.txt
<dt><!--2020-03-26 psargent-->Troggle architecture</dt>
</details>
<details><summary><!--2020-03-26 psargent-->Troggle architecture</summary>
<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>
<li><!--2020-04-10 psargent-->Regenerate the diagram of the tables in the database & document
<li><!--2020-04-10 psargent-->Describe the parsing/import procedures so non-nerds can do it
<dt><!--2020-03-26 psargent-->Surveyscans</dt>
</details>
<details><summary><!--2020-03-26 psargent-->Surveyscans</summary>
<dd><!--2020-03-26 psargent-->explain where the image files are referenced from: svx, tunnel/therion, and </dd>
<dd>Be exhaustive in checking all the broken links between svx & wallets</dd>
<li><!--2020-03-26 psargent-->explain where the image files are referenced from: svx, tunnel/therion, and
<li>Be exhaustive in checking all the broken links between svx & wallets
<dt>non-troggle scripts
<dd><!--2020-04-03 psargent-->DOCUMENT them all - have we got ? //expofiles/unidentified_scripts/ !
<dt>Makefile
<dd>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>
<details><summary>non-troggle scripts </summary>
<li><!--2020-04-03 psargent-->DOCUMENT them all - have we got ? //expofiles/unidentified_scripts/ !
</details>
<details><summary>Makefile</summary>
<li>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 ?
</dl>
</details>
<h3>Troggle</h3>
<dl>
<dt><!--2020-07-27 psargent--> QM links in cave descriptions ALL BROKEN
<dd><!--2020-07-24 psargent-->There are HREF links to individual QMs in the cave description in e.g. 204
<details><summary><!--2020-07-27 psargent--> QM links in cave descriptions ALL BROKEN</summary>
<li><!--2020-07-24 psargent-->There are HREF links to individual QMs in the cave description in e.g. 204
<a href="1623/204/swings.html">Swings and Roundabouts</a> such as "At the bottom there is a climb down over boulders <a href="1623/204/qm.html#C2001-204-45">[C2001-204-45 C]</a>." where the troggle URL fails completely.
<dt>Better import error messages
<dd><!--2020-04-20 psargent-->REPORT 'folder not recognised' errors into error log inside database -> "DataIssue" register
<dt><!-- 2020-04-11 psargent -->Troggle parser/viewer
<dd>Explain how expopages (formerly flatpages) work. refer to computing/hbmanual1.html
<dt><!--2020-07-24 psargent--> Completely new design of QM management needed
<dd><!--2020-07-24 psargent-->see <a href="../troggle/scriptsqms.html">QM status and redesign needed document</a>
<dt><!--2020-07-24 psargent--> jQuery version and remove all unused CSS and JS files
<dd><!--2020-07-24 psargent-->jQuery used for Edit This Page very very VERY out of date. Reinstate TinyMCE too ?
<dt><!--2020-07-24 psargent--> 19 names don't work in folk/troggle
<dd><!--2020-07-24 psargent-->there are 3 separate name parsers: in the folk script, and two in different bits of troggle.
</details>
<details><summary>Better import error messages </summary>
<li><!--2020-04-20 psargent-->REPORT 'folder not recognised' errors into error log inside database -> "DataIssue" register
</details>
<details><summary><!-- 2020-04-11 psargent -->Troggle parser/viewer </summary>
<li>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><!--2020-07-24 psargent-->see <a href="../troggle/scriptsqms.html">QM status and redesign needed document</a>
</details>
<dt><!--2020-07-24 psargent--> Django migrations documentation needed
<dd><!--2020-07-24 psargent-->How to upgrade python version, django version, django-plugins versions, pip install and useful/essential tools such as python -Wall manage.py check -v 3.
<dd><!--2020-07-24 psargent-->django-estensions usefulness. Explain/document why troggle still needs database migraitons even though we rebuild it afresh each time
</dl>
<h3>Troggle Refactoring</h3>
<dl> <dt><!--2020-07-24 psargent-->Make parsers use generators to yield one line at a time
<dd><!--2020-07-24 psargent-->Both recursive load and linear load parsers/survex could do this.
<dd><!--2020-07-24 psargent-->In the logbooks parsing and cache loading.
<dt><!--2020-07-24 psargent-->Replace assert() with dataIssue [NOTIFICATION pattern] or Exceptions
<dd><!--2020-07-24 psargent-->https://martinfowler.com/articles/replaceThrowWithNotification.html
<dt><!--2020-07-24 psargent-->Python documentation: Django's use of modern unobvious idioms
<dd><!--2020-07-24 psargent-->[DECORATOR] pattern used for login-required pages
<dd><!--2020-07-24 psargent-->Get all trogglistas to read https://ebookscart.com/effective-python-by-brett-slatkin-pdf-download/ - downloded to /expofiles/
<dd><!--2020-07-24 psargent-->Get all trogglistas to read https://martinfowler.com/tags/refactoring.html
<dt><!--2020-07-24 psargent-->Flatfiles is used to deliver CSS and JS for django admin pages,
<dd><!--2020-07-24 psargent-->staticfiles django plugin broken, not needed so use flatfiles but fix awkradnesses such as /expofiles/ directory listing not working
<details><summary><!--2020-07-24 psargent-->Make parsers use generators to yield one line at a time</summary>
<li><!--2020-07-24 psargent-->Both recursive load and linear load parsers/survex could do this.
<li><!--2020-07-24 psargent-->In the logbooks parsing and cache loading.
</details>
<details><summary><!--2020-07-24 psargent-->Replace assert() with dataIssue [NOTIFICATION pattern] or Exceptions</summary>
<li><!--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><!--2020-07-24 psargent-->[DECORATOR] pattern used for login-required pages
<li><!--2020-07-24 psargent-->Get all trogglistas to read https://ebookscart.com/effective-python-by-brett-slatkin-pdf-download/ - downloded to /expofiles/
<li><!--2020-07-24 psargent-->Get all trogglistas to read https://martinfowler.com/tags/refactoring.html
</details>
<details><summary><!--2020-07-24 psargent-->Flatfiles is used to deliver CSS and JS for django admin pages,</summary>
<li><!--2020-07-24 psargent-->staticfiles django plugin broken, not needed so use flatfiles but fix awkradnesses such as /expofiles/ directory listing not working
</dl>
</details>
<h3>Expo Server</h3>
<dl>
<dt><!--2020-07-24 psargent--> document cgit installation and config
<dd><!--2020-07-24 psargent-->as per Wookey on new server Debian 10
<dt><!--2020-03-26 psargent--> document directory structure
<dd><!--2020-04-03 psargent-->as per Julian's GitHub list - then close that issue.
Use 'tee' to create ascii art for this.</dd>
<details><summary><!--2020-07-24 psargent--> document cgit installation and config</summary>
<li><!--2020-07-24 psargent-->as per Wookey on new server Debian 10
</details>
<details><summary><!--2020-03-26 psargent--> document directory structure</summary>
<li><!--2020-04-03 psargent-->as per Julian's GitHub list - then close that issue.
Use 'tee' to create ascii art for this.
<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><!--2020-04-03 psargent-->Makefile - and permissions.
</details>
<details><summary>permissions</summary>
<li><!--2020-04-03 psargent-->do we need a cron job or has the group membership fix fixed it ? either way, document it.
<li><!--2020-04-03 psargent-->Makefile - and permissions.
<dt>Apache & MySQL configuration
<dd><!--2020-04-03 psargent-->DOCUMENT How to set up a server
<dd><!--2020-04-10 psargent-->Fix and document permissions for cron jobs
<dd><!--2020-05-14 psargent-->Document "anacron" / cron system on server
<dd><!--2020-04-10 psargent-->Explain why Docker containers can be a maintenance nightmare unless built from a script
<dd><!--2020-04-25 psargent--> /expofiles/ needs config , refer to apache/django docm.
<dd><!--2020-04-25 psargent--> admin/doc/ BROKEN PAGE needs config - refer to django docm.
</dl>
</details>
<details><summary>Apache & MySQL configuration </summary>
<li><!--2020-04-03 psargent-->DOCUMENT How to set up a server
<li><!--2020-04-10 psargent-->Fix and document permissions for cron jobs
<li><!--2020-05-14 psargent-->Document "anacron" / cron system on server
<li><!--2020-04-10 psargent-->Explain why Docker containers can be a maintenance nightmare unless built from a script
<li><!--2020-04-25 psargent--> /expofiles/ needs config , refer to apache/django docm.
<li><!--2020-04-25 psargent--> admin/doc/ BROKEN PAGE needs config - refer to django docm.
</details>
<h3>
<font color="fuchsia">This to-do-list gadget itself</font>
</h3>
<dl>
<dt>Status
<dd>Make it only click once to change display state of the DT tag
<details><summary>Status</summary>
<li>This one is being replaced by HTML5 with no JS. But the other todo page still uses JS
<li>Make it only click once to change display state of the DT tag
<dt><!--2020-03-26 psargent-->Eventual aim
</details>
<details><summary><!--2020-03-26 psargent-->Eventual aim</summary>
<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>
<li><!--2020-03-26 psargent-->to replace GitHub <a href="https://github.com/CaveSurveying/CUCCexposurveyissues/issues">
CUCCexposurveyissues</a> for non-tunnel, non-GIS issues.
<dt><!--2020-03-26 psargent-->Try to automate simple functions in javascript
<li><!--2020-03-26 psargent-->if using tinymcs, use the INLINE mode.
<li><!--2020-03-26 psargent-->Implement comments on an issue, mimicking GitHub issues wiki
<li><!--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.
<li><!--2020-03-26 psargent-->checkboxes so that items can be ticked (which also does strike-through)
<li><!--2020-04-03 psargent-->promotion/demotion options?
<li><!--2020-03-26 psargent-->bin icon to delete an item? Better to have an archive process.
</details>
<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>
<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>
<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>
<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>
<dd><!--2020-03-26 psargent-->bin icon to delete an item? Better to have an archive process.</dd>
<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-->Put DL into italics when *any* DD is hidden
</dl>
<!-- ------------------- Do not touch anything below here either ------------------------>
<!--2020-03-26--> Testing area..