Skip to content

Commit

Permalink
Merge branch 'maths:master' into master
Browse files Browse the repository at this point in the history
  • Loading branch information
guidopinkernell authored Jul 20, 2024
2 parents 78cb0fa + 33f0a2c commit 92a0556
Show file tree
Hide file tree
Showing 84 changed files with 1,156 additions and 130 deletions.
28 changes: 20 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ MkDocs cannot display MathJax out-of-the-box, so we use the markdown extension [

MkDocs can accept a third-party theme, and the main STACK website uses the [Bootstrap Theme](https://github.com/mkdocs/mkdocs-bootstrap), which uses all the website building tools of [Bootstrap](https://getbootstrap.com/docs/4.0/getting-started/introduction/). This includes Bootstraps [responsive grid system](https://getbootstrap.com/docs/4.0/layout/grid/) and its [card styling](https://getbootstrap.com/docs/4.0/components/card/). Parts of the theme can be overridden in the `overrides` folder. The `main.html` file is set up to extend the base Bootstrap theme, to for example, add a custom footer. A custom stylesheet is also added, under `website_files/custom.css`.

The site is hosted by [GitHub Pages](https://pages.github.com/) from the `gh-pages` branch. An workflow under `.github` ensures that MkDocs runs its command `mkdocs gh-deploy` every time the repository is pushed to, which rebuilds the website and pushes the built HTML piles to the `gh-pages` branch. This overrides all the files currently in the `gh-pages` branch, so **you must never edit files directly in the `gh-pages` branch**.
The site is hosted by [GitHub Pages](https://pages.github.com/) from the `gh-pages` branch. A workflow under `.github` ensures that MkDocs runs its command `mkdocs gh-deploy` every time the repository is pushed to, which rebuilds the website and pushes the built HTML piles to the `gh-pages` branch. This overrides all the files currently in the `gh-pages` branch, so **you must never edit files directly in the `gh-pages` branch**.

## Updating the website

Expand All @@ -42,14 +42,26 @@ Links between pages are relative. If a link starts with `/` it will be taken rel

### Accessibility

When adding new content, please try to adhere to the [WCAG 2.1 Accessibility Guidelines](https://www.w3.org/TR/WCAG21/) as much as possible. Please:
When adding to the STACK website, please consider all users. Some may be accessing the information you are wishing to comunicate, in a way you may not have considered. This can be physically different formats such as mobile phones and tablets, use of accessibility tools such as screen readers and keyboard controls or simply a different perspective such as colourblindness or dyslexia.

Please consider/check the following key points when making changes:

- Different screen sizes and zoom levels: elements should be responsive to changes in size.
- Use divs instead of tables as much as possible.
- Make use of Bootstrap's responsive grid system detailed in the [bootstrap documentation](https://getbootstrap.com/docs/4.0/layout/grid/).

- Images: Add **meaningful** alternative text to all non-text objects in particular images. This can be done using the `alt=""` tag. It is important that this text convays the information that the
picture would have if viewed. If there is text in the image then this
must be given. Do not paraphrase this text. If the text is the only information you wish to comunicate, consider if you could type it out using html environments, e.g. code snippets and mathematical equations. Some useful
guidance on alternative text is given by [Harvard Univeristy](https://accessibility.huit.harvard.edu/describe-content-images).

- Links: Please add text to links rather than a full `hhtps://` link, as it slows down screen reader users and makes navigation using verbal comands very difficult. However, avoid link text such as 'here' or 'read more', make each link disernable from other links on the page, and make it as clear as you can where the link leads just from the text. Some useful guidance on hyperlinks is given by [Yale University](https://usability.yale.edu/web-accessibility/articles/links).

- Colour: do not use colour alone to convay meaning e.g. in a plot. Ensure your text has contrast levels of at least 4:5:1, this can be easily checked with the [WebAIM contrast checker](https://webaim.org/resources/contrastchecker/).

Detailed guidance on digital accessiblity are given by the [WCAG 2.1 Accessibility Guidelines](https://www.w3.org/TR/WCAG21/).


* Add alternative text to all non-text objects, in particular images. This can be done using the `alt=""` tag.
* Making sure elements are responsive to different page sizes.
* Use divs instead of tables as much as possible.
* Make use of [Bootstrap's responsive grid system](https://getbootstrap.com/docs/4.0/layout/grid/).
* Never use colour as the sole way of conveying a message.
* Use colours with contrast levels of at least 4:5:1.

Some work has already been done to make the website automatically be accessible. In particular, tables will collapse when the screen is small.

Expand Down
8 changes: 6 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,19 @@ nav:
- About: 'About.md'
- Get Started: 'GetStarted.md'
- Community:
- 'Developmet team and Advisory Board': 'Community.md'
- 'Development team and Advisory Board': 'Community.md'
- 'African STACK Community Leadership Team': 'Communities/African_leadership.md'
- 'STACK Professionals Network': 'Communities/Professional_network.md'
- Training and Events:
- 'Meetings': 'Training_and_events.md'
- 'Annual conferences': 'Conference.md'
- 'Training events in 2020': '2020meetings.md'
- 'Meeting reports': 'MeetingReports/index.md'
- Projects: Projects/
- Projects:
- 'Overview': 'Projects/index.md'
- 'AuthOMath': 'Projects/AuthOMath/index.md'
- 'IDIAM': 'Projects/IDIAM/index.md'
- 'KTP' : 'Projects/KTP/index.md'
- Case Studies: CaseStudies/
- Demo: 'https://stack-demo.maths.ed.ac.uk/demo/'
- Documentation: 'https://docs.stack-assessment.org/en/'
Expand Down
3 changes: 1 addition & 2 deletions theme/includes/footer.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ <h5>Contact Us</h5>
</p>
<p> <br><a href="https://github.com/maths/moodle-qtype_stack">STACK git repository</a>
<br><a href="https://moodle.org/mod/forum/view.php?id=752">Moodle's "Mathematics tools" forum</a>
<br><a href ="https://stack.edina.ac.uk/">STACK@EDINA hosted service</a>
</p>
</div>
<div class="col-md" style="text-align:left">
Expand All @@ -29,4 +28,4 @@ <h5>Contact Us</h5>
<br><a rel="license" href="https://creativecommons.org/licenses/by-sa/4.0/"><img alt="Creative Commons Licence" style="border-width:0" src="https://i.creativecommons.org/l/by-sa/4.0/80x15.png" /></a> This work is licensed under a <a rel="license" href="https://creativecommons.org/licenses/by-sa/4.0/">Creative Commons Attribution-ShareAlike 4.0 International License</a> | <a href="{{nav.homepage.url | url}}/Legal/Licenses">Licenses</a>
</div>
</div>
</div>
</div>
6 changes: 0 additions & 6 deletions website_files/About.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,6 @@ As an open-source project, users help improve STACK by adding features, translat
<br>
<a class="btn btn-primary" href="https://docs.stack-assessment.org/en/About/Credits" role="button">Credits and contributions</a><a class="btn btn-primary" href="https://abacus.aalto.fi" role="button">ABACUS material bank</a>

#### Commercial hosting
We appreciate some people prefer hosted services as an alternative to running their own server. We are pleased to work with EDINA at the University of Edinburgh as a recommended hosting partner.<br> <a class="btn btn-primary" href="https://stack.edina.ac.uk/" role="button">Hosted STACK</a>

<div class="d-inline"><a href="https://edina.ac.uk/"><img style="display: inline-block;" src="../img/edina-logo-cmyk.jpg" class="img-fluid img-logo" title="EDINA logo" alt="EDINA logo"/></a></div>


#### Trusted user base
STACK is trusted by many respected institutions.

Expand Down
Loading

0 comments on commit 92a0556

Please sign in to comment.