README.rst 2.8 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
.. ==================================================
.. FOR YOUR INFORMATION
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.


.. _start:

=============
Documentation
=============

This extension provides a Backend module for TYPO3 to show both the documentation of local extensions and custom
documents.

The Backend module features two actions:

#. Show Documentation
19
#. Download Documentation
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37


Show Documentation
==================

This view shows a list of available documents:

- Extensions with a manual rendered as ``html`` or ``pdf``;
- Extensions with an OpenOffice manual (``sxw``);
- Official TYPO3 documentation (tutorials, references, ...) available locally;
- Custom documents, rendered either as ``html`` or ``pdf``.

To be listed, documents should be stored within ``typo3conf/Documentation/<documentation-key>/<language>/<format>/``:

``documentation-key``
	Extensions use the documentation key ``typo3cms.extensions.<extension-key>``.

``language``
38
39
	Either "default" (for English) or a proper locale identifying your translated documentation. E.g.,
	``fr_FR``, ``fr_CA``, ``de_DE`` ...
40
41

``format``
42
43
	Either ``html`` or ``pdf``. Additional formats may be supported by 3rd party extensions
	(such as `EXT:sphinx <http://typo3.org/extensions/repository/view/sphinx>`_).
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69


Registering Custom Documents
----------------------------

#. Choose a documentation key such as ``<company>.<document-name>``

#. Put your documentation as HTML (main file *must be* ``Index.html``) within
   ``typo3conf/Documentation/<documentation-key>/default/html/`` or as PDF (any name will fit) within
   ``typo3conf/Documentation/<documentation-key>/default/pdf/``

#. Create a text description file ``composer.json`` containing the title and description of your documentation and place
   it within ``typo3conf/Documentation/<documentation-key>/default/``:

   .. code-block:: json

       {
           "name": "Put some title here",
           "type": "documentation",
           "description": "Put some description here."
       }

#. [optionally] Put a custom icon (either ``icon.png`` or ``icon.gif``) within directory
   ``typo3conf/Documentation/<documentation-key>/``


70
71
Download Documentation
======================
72
73

This view is only accessible to TYPO3 administrators. It shows a form to retrieve rendered documentation for loaded
74
extensions and to fetch a copy of official TYPO3 manuals, guides and references from https://docs.typo3.org.
75
76
77
78
79
80
81
82
83
84
85
86


Configuration
=============

There are two User TSconfig options available:

mod.help_DocumentationDocumentation.documents.hide
  Comma-separated list of keys of documentation that should be hidden from the user.

mod.help_DocumentationDocumentation.documents.show
  Comma-separated list of keys of documentation that should be shown to the user (others are implicitly hidden).