Laws.Africa Editor Guide
English
English
  • Welcome
  • Getting started
    • Lesson plan
    • Signing up
    • Digitising legislation
    • What is Akoma Ntoso
    • Terminology guide
  • Managing Works
    • Creating and editing works
      • Working with commencements
    • Deleting a document
    • Amending works
      • Creating the amending work
      • Linking the amendment
      • Creating a new document at the new point in time
      • Applying the amendments
      • Annotating the amendments
      • Example
      • Exercise
      • Consolidating the annotations
        • Simple example
        • Complicated example
    • Bulk imports (spreadsheet)
  • How-tos
    • Tasks
    • Importing a document
      • The importer
    • Cleaning up an import
    • Going back to a previous version of a document
    • Fixing all-caps headings
    • Working with tables
      • Table errors
    • Working with links
    • Working with italicised terms
    • Inserting an image
    • Inserting special characters
    • Resolving editor warnings
    • Making comments
    • Inserting editorial notes
    • Changing a document's date
    • Changing a document's short title or language
    • Search and rescue
    • How to handle different language documents
    • How to mark up defined terms which do not occur in a Definitions section
    • Very complicated amendments
      • Research
      • Undo some amendments?
      • Update the timeline
      • Create the tasks
      • Apply the amendments
  • Markup guide
    • Introduction
    • Marking up the structure
    • Preface, Long title, and Preamble
    • Headings
    • Marking up Schedules / Annexes
    • Marking up annotations
    • Marking up tables
    • Marking up links
    • Marking up images
    • Marking up footnotes
    • Marking up formatting
    • Marking up insertions and deletions
    • Keyword reference
  • Reviewing a document
    • Reviewing a document
    • Reviewer checklist
    • Signing off a work
  • Style Guides
    • Laws.Africa
    • Côte d'Ivoire
    • Ghana
    • Namibia
      • Regulations
    • Lesotho
    • Malawi
    • Nigeria
    • Zambia
    • South African Acts
    • South African By-laws
    • Tanzania
    • Uganda
    • UNEP
    • Zimbabwe
    • Seychelles
    • Mauritius
    • Pan-African Parliament/ AGP
    • Turks and Caicos
    • Papua New Guinea
    • eSwatini
    • Rwanda
    • Documents in languages other than English
  • Administration
    • Site settings
    • Managing administrators
    • Countries and localities
    • Document subtypes
    • Task labels
    • Taxonomies
    • Notion templates
Powered by GitBook
On this page
  • Guiding principles
  • What to include and exclude
  • Exclude
  • Include
  • Headings
  • Marking up headings with or without keywords
  • Formatting
  • Forms
  • Subsidiary legislation
  • Regulations
  • Example
  • Other notices
  • Example
  • Treaties and other documents with a Preamble
  1. Style Guides

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

  • Acronyms (or initialisms 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

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.

Marking up headings with or without keywords

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.

And sometimes other formatting should be applied, such as superscript or subscript: see Marking up formatting.

Forms

  • Only use italics for instructions, like (insert name here).

  • Use SUBPARTs 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/:

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/:

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.

PreviousSigning off a workNextCôte d'Ivoire

Last updated 1 year ago

Fixing all-caps headings