expoweb/handbook/computing/todo.html

172 lines
7.6 KiB
HTML
Raw Normal View History

<!DOCTYPE html>
<html>
<head>
<title>Expo Systems - To-Do List</title>
<meta charset="utf-8">
</head>
<body>
<style>
body {
background: #fff url(/images/style/bg-system.png) repeat-x 0 0
}
/* Use grey for system/programming/nerd pages as a visual reminder */
</style>
<style>
2022-06-25 21:00:48 +01:00
li.todo {
font: 18px Calibri, sanserif;
font-weight: normal;
color: 6083BF;
list-style-type: None;
line-height: 1.0;
margin-left: 1.0em;
}
2022-06-25 21:00:48 +01:00
li.todo:before {
content: "» ";
font-weight: normal;
color: 6083BF;
}
</style>
<h1>Expo Systems To-Do List</h1>
2021-05-03 00:59:38 +01:00
<h2>How this works</h2>
2021-05-03 01:00:54 +01:00
<p><b>Click on the solid triangle in a sub-heading to reveal</b> the individual to-do items. Click again to hide.<br />
<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.
2022-06-25 21:00:48 +01:00
<p>Edit this page by using the same "Edit this page" function that you may have used before.
<p>To see the "data maintenance" and "survey data-entry" to-do lists, go to <a href="todo-data.html">the other TO-DO list</a>
2021-04-21 20:41:01 +01:00
<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>
2023-02-02 21:50:24 +00:00
2023-01-29 15:26:34 +00:00
<div>
2023-02-02 21:50:24 +00:00
<figure>
<a href="/todo/anything">
<img border="1" src="todo-snapshot.jpg" width=45%>
<figcaption>Click here for live list.
</figure></div></a>
This to-do list is generated directly from the troggle python code files and is the most up to date
to-do list for programming you are likely to find anywhere. Every serious maintainer also maintains their own personal handwritten notes and/or Google Keep lists too.
2021-04-21 20:41:01 +01:00
<hr>
2021-04-10 19:21:45 +01:00
<h3>Other coding To Do things</h3>
<p>See also these long-running issues which have their own 'to do' implications:
<ol>
2022-06-25 21:00:48 +01:00
<li class="todo"><a href="/handbook/troggle/trogdesign.html">What Troggle Does Badly - Design Decisions</a>
<li class="todo"><a href="/handbook/troggle/menudesign.html">New Menu System</a>
<li class="todo"><a href="/handbook/troggle/trog2030.html">Troggle in 2025-2030</a>
</ol>
<h3>Process Documentation</h3>
2023-01-29 15:26:34 +00:00
<details><summary><!--2020-03-26 psargent-->New-cave</summary>
2022-06-25 21:00:48 +01:00
<li class="todo"><!--2020-03-26 psargent-->Explain how to link a new cave into the other caves in
2021-05-03 00:53:48 +01:00
troggle filesystem
2022-06-25 21:00:48 +01:00
<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
2023-01-29 15:26:34 +00:00
2021-04-10 19:21:45 +01:00
</details>
2023-01-29 15:26:34 +00:00
<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
2021-04-10 19:21:45 +01:00
</details>
2023-01-29 15:26:34 +00:00
<h3>Wallets extras</h3>
2023-02-02 22:01:54 +00:00
<details><summary><!--2023-01-29 psargent-->Things wallets stuff might do in future </summary>
2022-06-25 21:00:48 +01:00
<li class="todo">- being more intelligent about .topo files and thus the lack of scan files,
2023-01-29 15:26:34 +00:00
2021-05-02 00:49:36 +01:00
</details>
<h3>Handbook</h3>
2023-01-29 15:26:34 +00:00
<details><summary><!--2020-04-11 psargent-->Layout and format</summary>
2023-01-29 15:26:34 +00:00
2022-06-25 21:00:48 +01:00
<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>
2023-01-29 15:26:34 +00:00
<h3>Areas </h3>
<details><summary>SubAreas </summary>
<li class="todo"><!--2020-05-01 psargent-->Downgrade the "sub areas" aspect of the documentation as we don't use these now
<li class="todo"><!--2023-07-14 psargent-->Remove or rename sub areas (called "areas") in the troggle code
2021-05-03 00:53:48 +01:00
</details>
2021-10-31 20:48:05 +00:00
2020-05-01 16:42:13 +01:00
<h3>Photos</h3>
<details><!--2023-07-14 psargent--><summary>Shared Google Photos</summary>
<li class="todo">Devise procedures and code assist to import the shared Expo google photo library into our photo storage area
</details>
2021-05-03 00:53:48 +01:00
<details><summary><!--2020-04-03 psargent-->Fix the BINS package (Wookey is looking for replacement)</summary>
2022-06-25 21:00:48 +01:00
<li class="todo"><!--2020-04-03 psargent-->set up git on the BINS software? Fix base url sautret.org
<li class="todo"><!--2020-04-03 psargent-->set up a cron / Makefile job to run BINS
<li class="todo"><!--2020-04-03 psargent-->why is 'updatephotos' script in expofiles?
<li class="todo">Document the ~expo/webphotos/ directory and how it works
<li class="todo">Why does expofiles/photos/xml/ get created containing all the generated xml files? Fix this.
2021-05-03 00:53:48 +01:00
</details>
<details><summary>galley thumbs etc.</summary>
2022-06-25 21:00:48 +01:00
<li class="todo">:expoweb:/galley/0.htm thumbnails not loading
2021-05-03 00:53:48 +01:00
</details>
2023-01-29 15:26:34 +00:00
<h3>Troggle</h3>
<details><summary><!--2023-07-13 psargent--> Logbook entry formg</summary>
<li class="todo">Make a form to enable logbook entries to be typed directly into troggle live, while also saving to logbook.html so that re-parsing does not lose anything.
</details>
2021-11-06 22:37:23 +00:00
<details><summary><!--2021-11-06 psargent--> CaveView fixing</summary>
<li class="todo">Re document the now-re-enabled CaveView (July 2023)
2021-11-04 17:44:45 +00:00
</details>
2023-01-29 15:26:34 +00:00
<h3>Troggle Refactoring</h3>
2022-02-15 19:19:35 +00:00
<details><summary><!--2022-02-15 psargent-->MIME types and filename extensions</summary>
2022-06-25 21:00:48 +01:00
<li class="todo">We should use standard <a href="https://docs.python.org/3/library/mimetypes.html">https://docs.python.org/3/library/mimetypes.html</a>
2022-02-15 19:19:35 +00:00
to convert between mimetypes and filenames, not our own hacks
2023-02-02 22:01:54 +00:00
<li class="todo">We should not be relying on filenames to accurately describe the format of the files. This is not robust and may also be a bit insecure.
2022-02-15 19:19:35 +00:00
We should use <a href="https://github.com/ahupp/python-magic">python-magic</a> or some other wrapper around Linux libmagic1 C library.
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>
2023-01-29 15:26:34 +00:00
2021-05-03 00:53:48 +01:00
<details><summary><!--2020-07-24 psargent-->Python documentation: Django's use of modern unobvious idioms</summary>
2022-06-25 21:00:48 +01:00
<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
2021-05-03 00:53:48 +01:00
</details>
2023-01-29 15:26:34 +00:00
<h3>Expo Server</h3>
2021-05-03 00:53:48 +01:00
<details><summary><!--2020-07-24 psargent--> document cgit installation and config</summary>
2023-01-29 15:26:34 +00:00
<li class="todo"><!--2020-07-24 psargent-->as per Wookey on Debian 10. Finish merging Wookey's instructions into handbook
2021-05-03 00:53:48 +01:00
</details>
<details><summary>MySQL configuration </summary>
2022-06-25 21:00:48 +01:00
<li class="todo"><!--2022-02-18 psargent-->robots.txt completely missing from /home/expo/static or troggle:/media
2023-01-29 15:26:34 +00:00
2021-05-03 00:53:48 +01:00
</details>
2023-01-29 15:26:34 +00:00
<details><summary>anacron and cron </summary>
<li class="todo"><!--2020-05-14 psargent-->Document "anacron" / cron system on server
</details>
2022-06-25 21:00:48 +01:00
<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,
2023-01-29 15:26:34 +00:00
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 />
Back to <a href="onlinesystems.html">Online Systems manual</a>
<hr /></body>
</html>