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
  • How to insert an automatically created annotation
  • How to write an annotation from scratch
  • Tips
  • Placement of annotations when a new Chapter/Part/Schedule is inserted/substituted
  1. Managing Works
  2. Amending works

Annotating the amendments

PreviousApplying the amendmentsNextExample

Last updated 1 year ago

Annotations are how we show readers what happened to a piece of legislation over time. We make an annotation under each change, specifying what the change is and how it came about.

How to insert an automatically created annotation

  1. In Edit mode, place your cursor in the line below the one where the change was made.

  2. Click 'Insert | Insert annotation …' and select the appropriate verb (refer to the amending work).

  3. Amend the annotation:

    • First, double-check that the amending work is correct — especially when there are multiple amendments at the same date.

    • Replace the section reference (section 10 in the screenshot below) with the provision that was affected – in this case, subsection (2).

    • Replace XXX with the section of the amending work that made this particular change. (If the amending work doesn't have sections, delete all of section XXX of.)

  4. In our example, the final annotation will read {{*[subsection (2) substituted by section 8(1)(b) of the {{>/za-playground/act/by-law/2020/practice-3 Amendment By-law, 2020}}]}} – note it does not start with a capital letter, and there are no spaces between the brackets in the reference to section 8(1)(b).

How to write an annotation from scratch

Amendments have four elements:

  1. The provision of the amended work

  2. The verb associated with the amendment

  3. The provision of the amending work

  4. The actual change.

Annotations reflect the first three elements in the following way:

<provision of amended work> <verb>ed by <provision> of <amending work>

For example:

{{*[subsection (1) deleted by section 12 of Act 3 of 2019]}}

or:

{{*[definition of "consumer" substituted by section 1(a) of the Electricity Supply Amendment By-law, 2017]}}

Tips

  • Wrap annotations in {{*[annotation markup]}}, because they are editorial remarks.

  • Make the annotation as close to the change as possible.

  • To determine the verb, follow what is given in the amending work. (For example, 'altered' seems to be preferred over 'amended' in Nigeria.)

  • When the amending work doesn't have an Act number, use its short title.

Placement of annotations when a new Chapter/Part/Schedule is inserted/substituted

  • When an entire Chapter/Part/Schedule is inserted or substituted, place the annotation at the top, directly underneath the heading.

  • Also place an annotation underneath each section within the Chapter/Part.

  • When a new Schedule is inserted, just the one annotation at the top is necessary.

Inserting the annotation
The automatically inserted annotation still needs to be edited