Help:Structure of this wiki

From TalyDocs

Contents 1 About the wiki 2 Organisation 3 Page Titles 3.1 Special titles 3.2 Capitalisation 4 How to subsection

[edit] About the wiki

This wiki can potentially contain manuals for many Taly Products, both software and hardware. It will be updated by Taly staff, and is READ-ONLY for clients.

[edit] Organisation

Each product is contained in a single category (e.g. TBM) Each category must contain a Table of Contents page, that is linked from the sidebar (naviagation section). In additional this table of contents is to be linked from the main page.

[edit] Page Titles

Each page title must start with the category code of the product (e.g. TBM) then a colon and then a space. For example for the Introduction for TBM, the page title would be

TBM: Introduction

[edit] Special titles

Under each manual these are special titles that will often be present and should written as follows for clarity.

• Table of Contents
• Introduction

[edit] Capitalisation

• The first letter of each word except these words is capitalised
  • and
  • or
  • the
  • of
  • this
• The first letter of a phrase (Start of title or after :) is capitalised

[edit] How to subsection

In any manual we will break up the material into subsections (e.g. Stock, Debtors). To make this clear, the page titles must contain the section heading (and subsection headings) This must correspond to headings in the Table of Contents for that manual. Example for barcode labels might be something like this

TBM: Stock: Barcode Labels

Then the Table of Contents might have a part looking something like this

2. Stock
...
2.3 Barcode Labels