Download the PHP package typo3/cms-documentation without Composer
On this page you can find all versions of the php package typo3/cms-documentation. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package cms-documentation
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
- Download Documentation
Show Documentation
This view shows a list of available documents:
- Extensions with a manual rendered as
htmlorpdf; - Extensions with an OpenOffice manual (
sxw); - Official TYPO3 documentation (tutorials, references, ...) available locally;
- Custom documents, rendered either as
htmlorpdf.
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
Either "default" (for English) or a proper locale identifying your translated documentation. E.g.,
fr_FR, fr_CA, de_DE ...
format
Either html or pdf. Additional formats may be supported by 3rd party extensions
(such as EXT:sphinx).
Registering Custom Documents
- Choose a documentation key such as
<company>.<document-name> - Put your documentation as HTML (main file must be
Index.html) withintypo3conf/Documentation/<documentation-key>/default/html/or as PDF (any name will fit) withintypo3conf/Documentation/<documentation-key>/default/pdf/ - Create a text description file
composer.jsoncontaining the title and description of your documentation and place it withintypo3conf/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.pngoricon.gif) within directorytypo3conf/Documentation/<documentation-key>/
Download Documentation
This view is only accessible to TYPO3 administrators. It shows a form to retrieve rendered documentation for loaded extensions and to fetch a copy of official TYPO3 manuals, guides and references from https://docs.typo3.org.
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).
