Skip to main content

2.1 Formatting Structure

This page illustrates the format of which is recommended for the structuring of association documentation and other materials. This paragraph for example is a page description which could be used to provide a summaries context of the contents of this page. The summary must be formatted in italics to highlight that it is not a clause and merely a description.

2.1.1 The formatting structure must use a numbered system with indentation to provide an easy to reference application of the documentation. This must be kept in sequence and not miss numbers or iterations as that can lead to readers believing that content is missing (unless that content is truly missing). The numbering will be structured as follows:

<chapter>.<page>.<clause>.<sub_clause>

2.1.1.1 All clauses and sub clauses must start with the structured numbers in bold to add visual separation.

2.1.1.2 All sub clauses must be indented to provide a clear and visual divide of parent and child relationship between clauses and sub clauses.

2.1.1.3 Only lists within clauses can break the standard demonstrated in rule 1.1.1 above. These lists can be used to do the following:

      • Unordered lists must be indented further to reflect being the child of a clause or sub clause.
      1. If appropriate, ordered lists can also be used to provide further referencing beside the clause or sub clause.
      1. If appropriate, ordered lists with letters can be used to provide further referencing beside the rule or sub clause. This is not recommended when introducing an international audience where English is not their fluent language. 

        (NOTE: Unfortunately Bookstack does not provide the ability to create lettered lists without html scripting)

        <ol id="<random_id_number>" style="list-style: lower-alpha;">

2.1.2 Clause Headings - Clauses may have short headings which are denoted at the beginning of the clause followed by a '-' dash and the corresponding clause.

2.1.3 All clauses and sub clauses must be concisely written to prevent any misinterpretation of the subject matter or clause.

2.1.3.1 The use of tools such as ChatGPT and Gammarly are recommended to ensure concise use of literature in documentation.

2.1.4 The use of appendices as individual pages are recommended when referencing or illustrating material that can cloud the documentation written.

2.1.4.1 All appendices should be located at the end of a book under an "Appendices" chapter, with a hyperlink from the referencing page (The chapter should not be numbered as "Chapter X: Appendices").

2.1.4.2 Each appendix must be a single page with the naming convention as follows: "Appendix X1: Example Image". Each appendix must be an ordered list of letters and may include a number to allow for sub-appendices to be grouped.