CaseNotes

Engineer's Casenotes

These case notes are intended as a brief list of observations and points for current and upcoming items within the Wiki Design and Implemetation repository. In short: notes to myself, a sort of aide-memoire of things I need to do (or at least think about).

It is written in the form of an engineering log book in reverse chronological order (most recent at the top). I know that GitHub provides similar facilities: issues, milestones, actions &c. all of which have their uses. I just wanted something that was a bit more free-flowing and less official. I also wanted something that I could modify regularly and keep up to date without having multiple commits in the main repository for what were essentially just notes and lists of things to do.

This Case Notes file was created on October 21^st, 2024.

Michael Gledhill Chester — October 2024

⬆️ Top

General points and observations

Open list — Points for consideration:

Note

The date above reflects the latest point at which the list was modified.

✅ General points
	✅ Comments within Markdown ✅ Gitkeep ✅ eadme.md does not suppoort <u> only <ins>(but <s> works) ✅ GitHub docs Markdown files https://github.com/github/docs/tree/main/content ✅ Relative paths to files ✅ When to use - or %20 in filenames with spaces ✅ downloading a `.md` file
✅ Wiki structures
	✅ Creating a Wiki for a repository ✅ Cloning a Wiki to a local machine ✅ Setting up VS Code to push changes ✅ Understanding how Wiki pages are stored and structured ✅ Basic concepts of a Wiki page ✅ Sidebars and footers ✅ Imposing a folder structure on a Wiki ✅ Creating different sidebars and footers for individual pages
✅ MainPoint
	✅ Body text ✅ Tab character converts body text to code fragment ✅ Paragraphs ✅ Line breaks ✅ Horizontal lines ✅ Emphasis bold ✅ Emphasis italic ✅ Emphasis underlining ✅ Emphasis strikethrough ✅ Subscript and superscript ✅ Lists unnumbered ✅ Lists numbered (ordered) ✅ Lists nested ✅ Lists nested combinations ✅ Block quotes ✅ Headings ✅ Images ✅ Links ✅ Escape characters ✅ Special space characters ✅ HTML restrictions for space character names ✅ Image spacer in Headings ✅ Differences between Wiki Markdown and GitHub md files
✅ Extended markdown
	✅ Link to headings ✅ Link by reference ✅ Tables (Markdown) ✅ Task lists ✅ Emojis ✅ Alerts ✅ Footnotes ✅ Making footnotes work on Wiki pages ✅ Code fragments ✅ Code fragments with syntax highlights ✅ Framed code highlights ✅ LaTex and Tex coloured fonts ✅ MathJax and formulae ✅ Built in diagrams (Mermaid) ✅ Built in diagrams (GeoJSON/TopoJSON) ✅ Built in 3D models (ASCII STL) ✅ Image refresh (?bxno=xxxx)
✅ Markdown & HTML
	✅ HTML sanitisation ✅ Permited and prescribed tags/attributes ✅ Names and anchor points ✅ Tables (HTML) ✅ Tables vertical alignment ✅ Table widths and borders ✅ Collapsable content ✅ Advanced table of contents ✅ Links with HTML ✅ Images with HTML ✅ Buttons ✅ Navigation bars ✅ Tootltips for links >
✅ Wiki constraints
	✅ Max page length 484,044 characters ✅ 5000 files max ✅ File sizes
✅ Conventions, tips and tricks
	✅ Practical Series conventions ✅ Numbers and point characters ❶ ❷ ❸ ❹ ❺ ❻ ❼ ❽ ❾ ❿ — ● ⚫︎ ⬤ ✅ Sidebars and footers contents and structure ✅ Managing sidebars and footers ✅ Conventions for folders, image storage and data storage ✅ IO Badges and placeholders ✅ Links to top, bottom and other points on a page
✅ Managing a Wiki
	✅ Revision control ✅ History ✅ Managing commits ✅ Rebase a Wiki
⭕ Appendix content
	⭕ Cheat sheet ⭕ keyboard shortcuts
⭕ Word document
	⭕ Add HTML to emphasis sections (bold, italic &c.) ⭕ Use of PSOP.UK shortlinks
	^{List 1 — Points and points for consideration}