| title |
|---|
A guide to the module materials |
A Guide to Module Materials
While we will be using Aula to drive the module materials, all of the content written is also available on GitHub Pages.
Here is a quick overview of the conventions I will use here, where I get a few more formatting options.
!!! important "Accessibility"
One reason I have used the GitHub / Markdown approach in the past, is to help students with
accessibility issues. For example, I find it really hard to work outside of "Dark Mode".
If you want to talk to me about this, please do, there is a heck of a lot we can do with
formatting that can help address any requirements you have.
Dark and Light Mode:
Personally, I hate light mode, the contrast seems to make things much harder to read, but I also appreciate it not for everyone. Therefore, I have written a plugin for mkdocs that means you also have the option to read text in a format that works for you.
!!! info
I am using localstorage on your browser to remember your preferences,
this means that no details get sent to the server.
Feel free to use the View Page Source (++ctrl+u++) or Inspect Element (++rbutton+q++) to check my working
Footnotes
Will be used either to:
- refer to other material (like a citation)
- As a note on something
Breakout Boxes
Throughout the text I will be using breakout boxes. I will use this as a way to highlight important points or make tasks clear.
I also use notes to replace the side-tracks that I tend to go down when giving lectures...
!!! discuss
A question to think about and discuss on the Aula
It will usually come with a ```#tag```
!!! task
A practical task to complete.
I love learning through doing. So we will have lots
of practical activities to complete.
There are also different levels of task
!!! easytask "Easy Task"
You **should** be able to do this to pass the module
!!! task "Task"
Being able to complete this should give you a decent grade.
!!! hardtask "Hard Task"
**Optional** harder task for those who want to test their skills
!!! note
Something interesting that I would add as a side note in
lectures. (It replaces me side-tracking myself).
!!! example
An example of whatever we have been talking about.
!!! warning
Lets you know something is important.
Its probably a good idea to pay attention.
!!! info
Another way of talking about something interesting. Usually technical.
!!! tip
A Tip, or other thing that might be worth knowing
Spotted a Bug or Typo
Well done. Writing this module was hard because of how much content went into it, and the nature of the topic. Just like writing code, it's not possible to be 100% bug-free and although I try to catch any problems, inevitably some will slip through the gaps2
The "minimising" step here is to try to get multiple people reading the material in advance of the module start, using a spell-checker, and developing in an environment that allows for version control, separation of content and presentation, reducing duplication and the chance for drift, etc. 3
As for catching bugs that make it through that process: you're the beta tester. If you find a bug, typo, factual error or even just have a good idea for improvement, let me know. Drop me a message at (aa9863@coventry.ac.uk). Unless you prefer to remain anonymous, you will be credited as a contributor to the page.