> For the complete documentation index, see [llms.txt](https://docs.laws.africa/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.laws.africa/style-guides/laws.africa.md).

# Laws.Africa

Style points that apply to all our projects

## Guiding principles

* User-friendliness.
* Being faithful to the original.
* Accurately capturing the content and structure, and not sweating the presentation.

## What to include and exclude

### Exclude

* Metadata – should be captured separately and reflected automatically on the coverpage:
  * Date of assent
  * Date of commencement
  * List of amendments
* Signatures (do not include as an image)
* Arrangement of Sections

### Include

* Language of text signed, e.g. `(English text signed by the Premier)`
* Preface, Long title, Preamble, including the word `ACT` before the Long title
* Main content
* Schedules

## Headings

Our preferred style is Sentence case for all headings, which is more readable than all caps.

Sentence case capitalises the first word, any proper nouns and acronyms, and defined terms.

* To **capitalise** means to uppercase the first letter:
  * `namibia` → `Namibia`
* **Proper nouns** include country names and the names of certain bodies:
  * `attorney general` → `Attorney General`&#x20;
* **Acronyms** (or [initialisms](http://www.todayifoundout.com/index.php/2012/05/the-difference-between-an-acronym-and-an-initialism/) if you want to be that person) will often also be defined in the legislation:
  * '"**ITU**" means International Telecommunications Union;'
  * `Members of the itu` → `Members of the ITU`
* But sometimes they'll just be assumed:
  * `The sabc` → `The SABC`
* **Defined terms** are defined in the definitions section of the current work:
  * '"**Board**" means the Board of Commissioners established under section 5 of this Act;'
  * `Members of the board` → `Members of the Board`

{% hint style="info" %}
If a term is consistently used in the upper case in a work, it should be used in the upper case in headings, even if it isn't explicitly defined.
{% endhint %}

{% content-ref url="/pages/-MA70o-0e5qn-985lTOt" %}
[Fixing all-caps headings](/how-tos/mark-up/fix-all-caps-headings.md)
{% endcontent-ref %}

### Marking up headings with or without keywords&#x20;

If a document is divided by headings for which a keyword exists, such as `CHAPTER/PART`, please use `SUBPART`  for any further headings which do not have a keyword.

If a document is divided by headings for which a keyword does  not exist, please use `DIVISION`  and `SUBDIVISION`  for those headings.

## Formatting

In general, we don't mark up bold, italics, or underlined text purely for emphasis.

Words or phrases that should be bold because they are headings or defined terms should rather be marked up as headings or defined terms.

But some terms are italicised, depending on the jurisdiction: see [Working with italicised terms](/how-tos/mark-up/italicised-terms.md).

And sometimes other formatting should be applied, such as superscript or subscript: see [Marking up formatting](/markup-guide/marking-up-formatting.md).

## Forms

* Only use italics for instructions, like (*insert name here*).
* Use `SUBPART`s for forms rather than crossheadings.
* Use the special character for a checkbox (☐) where appropriate.
* Use underscores (\_\_\_) for fill-ins.
* Keep the use of images to a bare minimum: only for logos, maps, etc.
* Don't use an image for 'Official stamp' – rather use italics text.
* Don't aim to replicate the formatting exactly as it is in the original; just make sure the text is all there and the meaning is clear.

## Subsidiary legislation

### Regulations

*Do* keep the introductory text from the notice, but *don't* treat the Regulations as being in a Schedule.

So, even though the notice text says 'in the Schedule', we put the Regulations in the BODY of the document, and keep the introductory text as the PREFACE of the document. (Any schedules to the Regulations will be treated as Schedules.)

### Example

From <https://edit.laws.africa/works/akn/za-wc/act/pn/2010/232/>:

![](https://672843079-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LoitfV0OP-HrMLMazq_%2F-MEvR7we0foTlAr2jcFn%2F-MEvx9ncAeHx8dOg4B5g%2Fimage.png?alt=media\&token=04aa6a8a-862f-40db-9e68-b793a3c9549d)

![](https://672843079-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LoitfV0OP-HrMLMazq_%2Fuploads%2F4zBJAmzufDp2FZtCCRms%2Fimage.png?alt=media\&token=8a4521d2-06c8-4190-9d96-277174c9df2c)

### Other notices

Keep the body of the notice as the BODY, and the Schedule as a SCHEDULE.

### Example

From <https://edit.laws.africa/works/akn/za/act/gn/2020/752/>:

![](https://672843079-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LoitfV0OP-HrMLMazq_%2F-MF0-PVsevxmblStx4qn%2F-MF00Bq8bPgDRIuaR5jO%2Fimage.png?alt=media\&token=766efc6a-fdc7-44ca-a47a-eb462c2f78bb)

![](https://672843079-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LoitfV0OP-HrMLMazq_%2Fuploads%2FcikmcmiUNgy7xbWFRkXv%2Fimage.png?alt=media\&token=d8de8bbd-984c-49df-ab6b-637c8400c57c)

### Treaties and other documents with a Preamble

In the Preamble of a document, style the first word of each sentence (words highlighted in the image below) as it is in the source document. If such word it **underlined**, please remove the underlining and **add italics** to it.&#x20;

![](https://672843079-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LoitfV0OP-HrMLMazq_%2Fuploads%2FvsWtszLVk7Kpt5uTfwdH%2F1.png?alt=media\&token=5b24796a-f7cd-4f4d-836e-e5301395bbca)
