Editing rules

Steps to edit a rule

1. Click on the edit link on the rule page
2. Once on GitHub, click on the pencil
3. Make the changes you want
4. Save your change. See Saving rules

For the SSW.Rules markdown syntax, check out this sample markdown rule. Click here to see how it looks.

How to add an image

To add an image, add it as a separate file in the same folder as the rule. You can then reference that file directly in the markdown (e.g. )

How to add Acknowledgements

You can add Acknowledgements to rules pages by modifying the frontmatter in the markdown file.

The following stucture is used:

authors:
- title: <Authours Name> (Required)
  url: <Hyperlink when clicked> (Optional)
  img: <Profile Image to show> (Optional)

This allows the following formats:

1. Linking to your SSW.People Profile (This will also grab your profile image)

- title: Adam Cogan
  url: https://ssw.com.au/people/adam-cogan

2. 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

3. Linking to your GitHub Profile (This will also grab your profile image)

- title: Adam Cogan
  url: https://github.com/adamcogan

4. 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