{"id":21346547,"url":"https://github.com/typo3-cms/documentation","last_synced_at":"2025-07-12T17:30:55.905Z","repository":{"id":57074270,"uuid":"54374743","full_name":"TYPO3-CMS/documentation","owner":"TYPO3-CMS","description":"[READ-ONLY] Subtree split of the TYPO3 Core Extension \"documentation\"","archived":false,"fork":false,"pushed_at":"2020-03-31T08:57:51.000Z","size":345,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":9,"default_branch":"9.3","last_synced_at":"2024-08-09T22:36:53.337Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://typo3.org/","language":"PHP","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TYPO3-CMS.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-03-21T09:13:54.000Z","updated_at":"2020-02-11T15:52:16.000Z","dependencies_parsed_at":"2022-08-24T14:55:07.848Z","dependency_job_id":null,"html_url":"https://github.com/TYPO3-CMS/documentation","commit_stats":null,"previous_names":[],"tags_count":34,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TYPO3-CMS%2Fdocumentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TYPO3-CMS%2Fdocumentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TYPO3-CMS%2Fdocumentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TYPO3-CMS%2Fdocumentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TYPO3-CMS","download_url":"https://codeload.github.com/TYPO3-CMS/documentation/tar.gz/refs/heads/9.3","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225829074,"owners_count":17530666,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-22T02:09:24.017Z","updated_at":"2024-11-22T02:09:24.562Z","avatar_url":"https://github.com/TYPO3-CMS.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":".. ==================================================\n.. FOR YOUR INFORMATION\n.. --------------------------------------------------\n.. -*- coding: utf-8 -*- with BOM.\n\n\n.. _start:\n\n=============\nDocumentation\n=============\n\nThis extension provides a Backend module for TYPO3 to show both the documentation of local extensions and custom\ndocuments.\n\nThe Backend module features two actions:\n\n#. Show Documentation\n#. Download Documentation\n\n\nShow Documentation\n==================\n\nThis view shows a list of available documents:\n\n- Extensions with a manual rendered as ``html`` or ``pdf``;\n- Extensions with an OpenOffice manual (``sxw``);\n- Official TYPO3 documentation (tutorials, references, ...) available locally;\n- Custom documents, rendered either as ``html`` or ``pdf``.\n\nTo be listed, documents should be stored within ``typo3conf/Documentation/\u003cdocumentation-key\u003e/\u003clanguage\u003e/\u003cformat\u003e/``:\n\n``documentation-key``\n\tExtensions use the documentation key ``typo3cms.extensions.\u003cextension-key\u003e``.\n\n``language``\n\tEither \"default\" (for English) or a proper locale identifying your translated documentation. E.g.,\n\t``fr_FR``, ``fr_CA``, ``de_DE`` ...\n\n``format``\n\tEither ``html`` or ``pdf``. Additional formats may be supported by 3rd party extensions\n\t(such as `EXT:sphinx \u003chttps://typo3.org/extensions/repository/view/sphinx\u003e`_).\n\n\nRegistering Custom Documents\n----------------------------\n\n#. Choose a documentation key such as ``\u003ccompany\u003e.\u003cdocument-name\u003e``\n\n#. Put your documentation as HTML (main file *must be* ``Index.html``) within\n   ``typo3conf/Documentation/\u003cdocumentation-key\u003e/default/html/`` or as PDF (any name will fit) within\n   ``typo3conf/Documentation/\u003cdocumentation-key\u003e/default/pdf/``\n\n#. Create a text description file ``composer.json`` containing the title and description of your documentation and place\n   it within ``typo3conf/Documentation/\u003cdocumentation-key\u003e/default/``:\n\n   .. code-block:: json\n\n       {\n           \"name\": \"Put some title here\",\n           \"type\": \"documentation\",\n           \"description\": \"Put some description here.\"\n       }\n\n#. [optionally] Put a custom icon (either ``icon.png`` or ``icon.gif``) within directory\n   ``typo3conf/Documentation/\u003cdocumentation-key\u003e/``\n\n\nDownload Documentation\n======================\n\nThis view is only accessible to TYPO3 administrators. It shows a form to retrieve rendered documentation for loaded\nextensions and to fetch a copy of official TYPO3 manuals, guides and references from https://docs.typo3.org.\n\n\nConfiguration\n=============\n\nThere are two User TSconfig options available:\n\nmod.help_DocumentationDocumentation.documents.hide\n  Comma-separated list of keys of documentation that should be hidden from the user.\n\nmod.help_DocumentationDocumentation.documents.show\n  Comma-separated list of keys of documentation that should be shown to the user (others are implicitly hidden).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftypo3-cms%2Fdocumentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftypo3-cms%2Fdocumentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftypo3-cms%2Fdocumentation/lists"}