events/Documentation/Administrator/Index.rst

1.7 KiB

Administrator Manual

Target group: Administrators

Describes how to manage the extension from an administrator point of view. That relates to Page/User TSconfig, permissions, configuration etc., which administrator level users have access to.

Language should be non / semi-technical, explaining, using small examples.

Installation

  • How should the extension be installed?
  • Are they dependencies to resolve?
  • Is it a static template file to be included?

To install the extension, perform the following steps:

  1. Go to the Extension Manager
  2. Install the extension
  3. Load the static template
  4. ...

For a list of configuration options, using a definition list is recommended:

Some Configuration

This option enables...

Other configuration

This other option is for all the rest...

Extension Manager (caption of the image)

List of extensions within the Extension Manager also shorten with "EM" (legend of the image)

Configuration

  • Where and how the extension should be configured? TypoScript? PHP?
  • Are there other prerequisite to full fill beforehand? For example, configure a setting in a special way somewhere.

FAQ

Possible subsection: FAQ

Subsection

Some subsection

Sub-subsection

Deeper into the structure...