-
Notifications
You must be signed in to change notification settings - Fork 177
How to Add an Acknowledgment
Tiago Araújo [SSW] edited this page Feb 8, 2024
·
6 revisions
You can add Acknowledgements to rules pages by modifying the frontmatter in the markdown file.
The following structure is used:
authors:
- title: <Authours Name> (Required)
url: <Hyperlink when clicked> (Optional)
img: <Profile Image to show> (Optional)
❗️ Warning: Please do not use nicknames in links to SSW.People profiles - they may cause 404s.
This allows the following formats:
- Linking to your SSW.People Profile (This will also grab your profile image)
Good: https://ssw.com.au/people/adam-cogan
Note: If you are linking to a people profile, make sure yourtitle
is spelt the same as your folder in SSW.People.Profiles
E.g. My SSW People profile URL is github.com/SSWConsulting/SSW.People.Profiles/tree/main/Brady-Stroud
So my title needs to be- title: Brady Stroud
- title: Adam Cogan
url: https://ssw.com.au/people/adam-cogan
- Linking to a URL and using a custom profile image
- title: Adam Cogan
url: https://ssw.com.au/people/adam-cogan
img: https://github.com/SSWConsulting/SSW.People.Profiles/raw/main/Adam-Cogan/Images/Adam-Cogan-Sketch.jpg
- Linking to your GitHub Profile (This will also grab your profile image)
- title: Adam Cogan
url: https://github.com/adamcogan
- No link and just the name of the Author (This will display a generic placeholder image)
- title: Adam Cogan
And here's an example of all 4 being used in the frontmatter of a rule.
---
type: rule
archivedreason:
title: Accommodation - Do you know the best online accommodation websites?
guid: 8d59feea-03b4-4cfc-b26e-77b2655293d9
uri: do-you-know-the-best-online-accommodation-websites
created: 2015-04-28T05:06:33.0000000Z
authors:
- title: Adam Cogan
url: https://ssw.com.au/people/adam-cogan
- title: Adam Cogan
url: https://ssw.com.au/people/adam-cogan
img: https://github.com/SSWConsulting/SSW.People.Profiles/raw/main/Adam-Cogan/Images/Adam-Cogan-Sketch.jpg
- title: Adam Cogan
url: https://github.com/adamcogan
- title: Adam Cogan
related: []
---
Figure: Example of 4 different Acknowledgement formats