[TASK] Minify SVG Icons
[Packages/TYPO3.CMS.git] / typo3 / sysext / documentation / README.rst
1 .. ==================================================
2 .. FOR YOUR INFORMATION
3 .. --------------------------------------------------
4 .. -*- coding: utf-8 -*- with BOM.
5
6
7 .. _start:
8
9 =============
10 Documentation
11 =============
12
13 This extension provides a Backend module for TYPO3 to show both the documentation of local extensions and custom
14 documents.
15
16 The Backend module features two actions:
17
18 #. Show Documentation
19 #. Download Documentation
20
21
22 Show Documentation
23 ==================
24
25 This view shows a list of available documents:
26
27 - Extensions with a manual rendered as ``html`` or ``pdf``;
28 - Extensions with an OpenOffice manual (``sxw``);
29 - Official TYPO3 documentation (tutorials, references, ...) available locally;
30 - Custom documents, rendered either as ``html`` or ``pdf``.
31
32 To be listed, documents should be stored within ``typo3conf/Documentation/<documentation-key>/<language>/<format>/``:
33
34 ``documentation-key``
35         Extensions use the documentation key ``typo3cms.extensions.<extension-key>``.
36
37 ``language``
38         Either "default" (for English) or a proper locale identifying your translated documentation. E.g.,
39         ``fr_FR``, ``fr_CA``, ``de_DE`` ...
40
41 ``format``
42         Either ``html`` or ``pdf``. Additional formats may be supported by 3rd party extensions
43         (such as `EXT:sphinx <http://typo3.org/extensions/repository/view/sphinx>`_).
44
45
46 Registering Custom Documents
47 ----------------------------
48
49 #. Choose a documentation key such as ``<company>.<document-name>``
50
51 #. Put your documentation as HTML (main file *must be* ``Index.html``) within
52    ``typo3conf/Documentation/<documentation-key>/default/html/`` or as PDF (any name will fit) within
53    ``typo3conf/Documentation/<documentation-key>/default/pdf/``
54
55 #. Create a text description file ``composer.json`` containing the title and description of your documentation and place
56    it within ``typo3conf/Documentation/<documentation-key>/default/``:
57
58    .. code-block:: json
59
60        {
61            "name": "Put some title here",
62            "type": "documentation",
63            "description": "Put some description here."
64        }
65
66 #. [optionally] Put a custom icon (either ``icon.png`` or ``icon.gif``) within directory
67    ``typo3conf/Documentation/<documentation-key>/``
68
69
70 Download Documentation
71 ======================
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 Configuration
78 =============
79
80 There are two User TSconfig options available:
81
82 mod.help_DocumentationDocumentation.documents.hide
83   Comma-separated list of keys of documentation that should be hidden from the user.
84
85 mod.help_DocumentationDocumentation.documents.show
86   Comma-separated list of keys of documentation that should be shown to the user (others are implicitly hidden).