Index.rst 1.62 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
.. ==================================================
.. FOR YOUR INFORMATION
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.

.. include:: ../Includes.txt


.. _users-manual:

Users manual
============

Documentation of how to use the extension, how it works, how to apply it, if it's a website plugin.

Language should be non-technical, explaining, using small examples. Don't use to many acronyms unless they have been explained.

Examples: For the "News" plugin this would be a manual showing how to create the news items, explaining the options etc.

Provide screenshots of a neutral Backend such as the Backend of the Introduction Package for instance. Have in mind that the User manual could possibly be re-used in a larger documentation compilation, for example when a company generates a documentation for its client.

Target group: **Users**

.. figure:: ../Images/UserManual/BackendView.png
	:width: 500px
	:alt: Backend view

    	Default Backend view (caption of the image)

    	The Backend view of TYPO3 after the user has clicked on module "Page". (legend of the image)


Link to official documentation
------------------------------

Sphinx makes it easy to link to official TYPO3 documentation:

- :ref:`TYPO3 Tutorial for Editors <t3editors:start>`
- :ref:`Getting Started Tutorial <t3start:start>`

and you may even link to a very specific chapter explaining how to :ref:`create a browser condition <t3tsref:condition-browser>` within the TypoScript Reference.

For a complete reference of available cross-link prefixes, please consult file ``_make/conf.py``.


FAQ
^^^

Possible subsection: FAQ