mirror of
https://github.com/werkraum-media/events.git
synced 2024-11-22 10:36:11 +01:00
Cleanup Documentation
Remove all boilerplate which was not touched anyway. Migrate from Settings.yml to Settings.cfg.
This commit is contained in:
parent
34dff294ea
commit
2f2957ef6c
21 changed files with 13 additions and 739 deletions
|
|
@ -1,82 +0,0 @@
|
||||||
.. ==================================================
|
|
||||||
.. FOR YOUR INFORMATION
|
|
||||||
.. --------------------------------------------------
|
|
||||||
.. -*- coding: utf-8 -*- with BOM.
|
|
||||||
|
|
||||||
.. include:: ../Includes.txt
|
|
||||||
|
|
||||||
|
|
||||||
.. _admin-manual:
|
|
||||||
|
|
||||||
Administrator Manual
|
|
||||||
====================
|
|
||||||
|
|
||||||
Target group: **Administrators**
|
|
||||||
|
|
||||||
Describes how to manage the extension from an administrator point of view.
|
|
||||||
That relates to Page/User TSconfig, permissions, configuration etc.,
|
|
||||||
which administrator level users have access to.
|
|
||||||
|
|
||||||
Language should be non / semi-technical, explaining, using small examples.
|
|
||||||
|
|
||||||
|
|
||||||
.. _admin-installation:
|
|
||||||
|
|
||||||
Installation
|
|
||||||
------------
|
|
||||||
|
|
||||||
- How should the extension be installed?
|
|
||||||
- Are they dependencies to resolve?
|
|
||||||
- Is it a static template file to be included?
|
|
||||||
|
|
||||||
To install the extension, perform the following steps:
|
|
||||||
|
|
||||||
#. Go to the Extension Manager
|
|
||||||
#. Install the extension
|
|
||||||
#. Load the static template
|
|
||||||
#. ...
|
|
||||||
|
|
||||||
For a list of configuration options, using a definition list is recommended:
|
|
||||||
|
|
||||||
Some Configuration
|
|
||||||
This option enables...
|
|
||||||
|
|
||||||
Other configuration
|
|
||||||
This other option is for all the rest...
|
|
||||||
|
|
||||||
|
|
||||||
.. figure:: ../Images/AdministratorManual/ExtensionManager.png
|
|
||||||
:alt: Extension Manager
|
|
||||||
|
|
||||||
Extension Manager (caption of the image)
|
|
||||||
|
|
||||||
List of extensions within the Extension Manager also shorten with "EM" (legend of the image)
|
|
||||||
|
|
||||||
|
|
||||||
.. _admin-configuration:
|
|
||||||
|
|
||||||
Configuration
|
|
||||||
-------------
|
|
||||||
|
|
||||||
* Where and how the extension should be configured? TypoScript? PHP?
|
|
||||||
|
|
||||||
* Are there other prerequisite to full fill beforehand?
|
|
||||||
For example, configure a setting in a special way somewhere.
|
|
||||||
|
|
||||||
|
|
||||||
.. _admin-faq:
|
|
||||||
|
|
||||||
FAQ
|
|
||||||
---
|
|
||||||
|
|
||||||
Possible subsection: FAQ
|
|
||||||
|
|
||||||
Subsection
|
|
||||||
^^^^^^^^^^
|
|
||||||
|
|
||||||
Some subsection
|
|
||||||
|
|
||||||
Sub-subsection
|
|
||||||
""""""""""""""
|
|
||||||
|
|
||||||
Deeper into the structure...
|
|
||||||
|
|
@ -1,106 +0,0 @@
|
||||||
.. ==================================================
|
|
||||||
.. FOR YOUR INFORMATION
|
|
||||||
.. --------------------------------------------------
|
|
||||||
.. -*- coding: utf-8 -*- with BOM.
|
|
||||||
|
|
||||||
.. include:: ../Includes.txt
|
|
||||||
|
|
||||||
|
|
||||||
.. _configuration:
|
|
||||||
|
|
||||||
Configuration Reference
|
|
||||||
=======================
|
|
||||||
|
|
||||||
Technical information: Installation, Reference of TypoScript options,
|
|
||||||
configuration options on system level, how to extend it, the technical
|
|
||||||
details, how to debug it and so on.
|
|
||||||
|
|
||||||
Language should be technical, assuming developer knowledge of TYPO3.
|
|
||||||
Small examples/visuals are always encouraged.
|
|
||||||
|
|
||||||
Target group: **Developers**
|
|
||||||
|
|
||||||
|
|
||||||
.. _configuration-typoscript:
|
|
||||||
|
|
||||||
TypoScript Reference
|
|
||||||
--------------------
|
|
||||||
|
|
||||||
Possible subsections: Reference of TypoScript options.
|
|
||||||
The construct below show the recommended structure for
|
|
||||||
TypoScript properties listing and description.
|
|
||||||
|
|
||||||
Properties should be listed in the order in which they
|
|
||||||
are executed by your extension, but the first should be
|
|
||||||
alphabetical for easier access.
|
|
||||||
|
|
||||||
When detailing data types or standard TypoScript
|
|
||||||
features, don't hesitate to cross-link to the TypoScript
|
|
||||||
Reference as shown below. See the :file:`Settings.yml`
|
|
||||||
file for the declaration of cross-linking keys.
|
|
||||||
|
|
||||||
|
|
||||||
Properties
|
|
||||||
^^^^^^^^^^
|
|
||||||
|
|
||||||
.. container:: ts-properties
|
|
||||||
|
|
||||||
=========================== ===================================== ======================= ====================
|
|
||||||
Property Data type :ref:`t3tsref:stdwrap` Default
|
|
||||||
=========================== ===================================== ======================= ====================
|
|
||||||
allWrap_ :ref:`t3tsref:data-type-wrap` yes :code:`<div>|</div>`
|
|
||||||
`subst\_elementUid`_ :ref:`t3tsref:data-type-boolean` no 0
|
|
||||||
wrapItemAndSub_ :ref:`t3tsref:data-type-wrap`
|
|
||||||
=========================== ===================================== ======================= ====================
|
|
||||||
|
|
||||||
|
|
||||||
Property details
|
|
||||||
^^^^^^^^^^^^^^^^
|
|
||||||
|
|
||||||
.. only:: html
|
|
||||||
|
|
||||||
.. contents::
|
|
||||||
:local:
|
|
||||||
:depth: 1
|
|
||||||
|
|
||||||
|
|
||||||
.. _ts-plugin-tx-extensionkey-stdwrap:
|
|
||||||
|
|
||||||
allWrap
|
|
||||||
"""""""
|
|
||||||
|
|
||||||
:typoscript:`plugin.tx_extensionkey.allWrap =` :ref:`t3tsref:data-type-wrap`
|
|
||||||
|
|
||||||
Wraps the whole item.
|
|
||||||
|
|
||||||
|
|
||||||
.. _ts-plugin-tx-extensionkey-wrapitemandsub:
|
|
||||||
|
|
||||||
wrapItemAndSub
|
|
||||||
""""""""""""""
|
|
||||||
|
|
||||||
:typoscript:`plugin.tx_extensionkey.wrapItemAndSub =` :ref:`t3tsref:data-type-wrap`
|
|
||||||
|
|
||||||
Wraps the whole item and any submenu concatenated to it.
|
|
||||||
|
|
||||||
|
|
||||||
.. _ts-plugin-tx-extensionkey-substelementUid:
|
|
||||||
|
|
||||||
subst_elementUid
|
|
||||||
""""""""""""""""
|
|
||||||
|
|
||||||
:typoscript:`plugin.tx_extensionkey.subst_elementUid =` :ref:`t3tsref:data-type-boolean`
|
|
||||||
|
|
||||||
If set, all appearances of the string ``{elementUid}`` in the total
|
|
||||||
element html-code (after wrapped in allWrap_) are substituted with the
|
|
||||||
uid number of the menu item. This is useful if you want to insert an
|
|
||||||
identification code in the HTML in order to manipulate properties with
|
|
||||||
JavaScript.
|
|
||||||
|
|
||||||
|
|
||||||
.. _configuration-faq:
|
|
||||||
|
|
||||||
FAQ
|
|
||||||
---
|
|
||||||
|
|
||||||
Possible subsection: FAQ
|
|
||||||
|
|
@ -1,60 +0,0 @@
|
||||||
.. ==================================================
|
|
||||||
.. FOR YOUR INFORMATION
|
|
||||||
.. --------------------------------------------------
|
|
||||||
.. -*- coding: utf-8 -*- with BOM.
|
|
||||||
|
|
||||||
.. include:: ../Includes.txt
|
|
||||||
|
|
||||||
|
|
||||||
.. _developer:
|
|
||||||
|
|
||||||
Developer Corner
|
|
||||||
================
|
|
||||||
|
|
||||||
Target group: **Developers**
|
|
||||||
|
|
||||||
Use this section for *providing code examples* or any **useful** information code wise.
|
|
||||||
|
|
||||||
|
|
||||||
.. _developer-hooks:
|
|
||||||
|
|
||||||
Hooks
|
|
||||||
-----
|
|
||||||
|
|
||||||
Possible hook examples. Input parameters are:
|
|
||||||
|
|
||||||
+----------------+---------------+---------------------------------+
|
|
||||||
| Parameter | Data type | Description |
|
|
||||||
+================+===============+=================================+
|
|
||||||
| $table | string | Name of the table |
|
|
||||||
+----------------+---------------+---------------------------------+
|
|
||||||
| $field | string | Name of the field |
|
|
||||||
+----------------+---------------+---------------------------------+
|
|
||||||
|
|
||||||
Use parameter :code:`$table` to retrieve the table name...
|
|
||||||
|
|
||||||
.. _developer-api:
|
|
||||||
|
|
||||||
API
|
|
||||||
---
|
|
||||||
|
|
||||||
How to use the API...
|
|
||||||
|
|
||||||
.. code-block:: php
|
|
||||||
|
|
||||||
$stuff = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance(
|
|
||||||
'\\Foo\\Bar\\Utility\\Stuff'
|
|
||||||
);
|
|
||||||
$stuff->do();
|
|
||||||
|
|
||||||
or some other language:
|
|
||||||
|
|
||||||
.. code-block:: javascript
|
|
||||||
:linenos:
|
|
||||||
:emphasize-lines: 2-4
|
|
||||||
|
|
||||||
$(document).ready(
|
|
||||||
function () {
|
|
||||||
doStuff();
|
|
||||||
}
|
|
||||||
);
|
|
||||||
Binary file not shown.
|
Before Width: | Height: | Size: 153 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 120 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 226 KiB |
|
|
@ -1,21 +0,0 @@
|
||||||
.. ==================================================
|
|
||||||
.. FOR YOUR INFORMATION
|
|
||||||
.. --------------------------------------------------
|
|
||||||
.. -*- coding: utf-8 -*- with BOM.
|
|
||||||
|
|
||||||
.. This is 'Includes.txt'. It is included at the very top of each and
|
|
||||||
every ReST source file in this documentation project (= manual).
|
|
||||||
|
|
||||||
|
|
||||||
.. ==================================================
|
|
||||||
.. DEFINE SOME TEXT ROLES
|
|
||||||
.. --------------------------------------------------
|
|
||||||
|
|
||||||
.. role:: typoscript(code)
|
|
||||||
|
|
||||||
.. role:: ts(typoscript)
|
|
||||||
:class: typoscript
|
|
||||||
|
|
||||||
.. role:: php(code)
|
|
||||||
|
|
||||||
.. highlight:: php
|
|
||||||
|
|
@ -1,36 +1,17 @@
|
||||||
.. ==================================================
|
.. _start:
|
||||||
.. FOR YOUR INFORMATION
|
|
||||||
.. --------------------------------------------------
|
|
||||||
.. -*- coding: utf-8 -*- with BOM.
|
|
||||||
|
|
||||||
.. include:: Includes.txt
|
======
|
||||||
|
Events
|
||||||
.. _start:
|
======
|
||||||
|
|
||||||
=============================================================
|
|
||||||
DD Events
|
|
||||||
=============================================================
|
|
||||||
|
|
||||||
.. only:: html
|
.. only:: html
|
||||||
|
|
||||||
:Classification:
|
:Classification:
|
||||||
dd_events
|
events
|
||||||
|
|
||||||
:Version:
|
|
||||||
|release|
|
|
||||||
|
|
||||||
:Language:
|
|
||||||
en
|
|
||||||
|
|
||||||
:Description:
|
:Description:
|
||||||
Extension to manage Destination Data managed events
|
Extension to manage Destination Data managed events
|
||||||
|
|
||||||
:Keywords:
|
|
||||||
comma,separated,list,of,keywords
|
|
||||||
|
|
||||||
:Copyright:
|
|
||||||
2019
|
|
||||||
|
|
||||||
:Author:
|
:Author:
|
||||||
Dirk Koritnik
|
Dirk Koritnik
|
||||||
|
|
||||||
|
|
@ -53,12 +34,4 @@ DD Events
|
||||||
:maxdepth: 3
|
:maxdepth: 3
|
||||||
:titlesonly:
|
:titlesonly:
|
||||||
|
|
||||||
Introduction/Index
|
|
||||||
User/Index
|
|
||||||
Administrator/Index
|
|
||||||
Configuration/Index
|
|
||||||
Developer/Index
|
|
||||||
KnownProblems/Index
|
|
||||||
ToDoList/Index
|
|
||||||
Changelog
|
Changelog
|
||||||
Links
|
|
||||||
|
|
|
||||||
|
|
@ -1,46 +0,0 @@
|
||||||
.. ==================================================
|
|
||||||
.. FOR YOUR INFORMATION
|
|
||||||
.. --------------------------------------------------
|
|
||||||
.. -*- coding: utf-8 -*- with BOM.
|
|
||||||
|
|
||||||
.. include:: ../Includes.txt
|
|
||||||
|
|
||||||
|
|
||||||
.. _introduction:
|
|
||||||
|
|
||||||
Introduction
|
|
||||||
============
|
|
||||||
|
|
||||||
|
|
||||||
.. _what-it-does:
|
|
||||||
|
|
||||||
What does it do?
|
|
||||||
----------------
|
|
||||||
|
|
||||||
This chapter should give a brief overview of the extension. What does it do? What problems does it solve?
|
|
||||||
Who is interested in this? Basically, this section includes everything people need to know to decide whether they
|
|
||||||
should go on with this extension or not.
|
|
||||||
|
|
||||||
.. important::
|
|
||||||
|
|
||||||
Please don't forget to repeat your extension's version number in the
|
|
||||||
:file:`Settings.yml` file, in the :code:`release` property. It will be
|
|
||||||
automatically picked up on the cover page by the :code:`|release|`
|
|
||||||
substitution.
|
|
||||||
|
|
||||||
|
|
||||||
.. _screenshots:
|
|
||||||
|
|
||||||
Screenshots
|
|
||||||
-----------
|
|
||||||
|
|
||||||
This chapter should help people figure how the extension works. Remove it
|
|
||||||
if not relevant.
|
|
||||||
|
|
||||||
.. figure:: ../Images/IntroductionPackage.png
|
|
||||||
:width: 500px
|
|
||||||
:alt: Introduction Package
|
|
||||||
|
|
||||||
Introduction Package just after installation (caption of the image)
|
|
||||||
|
|
||||||
How the Frontend of the Introduction Package looks like just after installation (legend of the image)
|
|
||||||
|
|
@ -1,17 +0,0 @@
|
||||||
.. ==================================================
|
|
||||||
.. FOR YOUR INFORMATION
|
|
||||||
.. --------------------------------------------------
|
|
||||||
.. -*- coding: utf-8 -*- with BOM.
|
|
||||||
|
|
||||||
.. include:: ../Includes.txt
|
|
||||||
|
|
||||||
|
|
||||||
.. _known-problems:
|
|
||||||
|
|
||||||
Known Problems
|
|
||||||
==============
|
|
||||||
|
|
||||||
Say where bugs can be reported / followed up. Is it a
|
|
||||||
`bug tracker <http://forge.typo3.org/projects/typo3cms-doc-official-extension-template/issues>`_?
|
|
||||||
Use this section for informing about any type of of problem
|
|
||||||
that are not necessarily named in the bug tracker such as performance issues, ...
|
|
||||||
|
|
@ -1,24 +0,0 @@
|
||||||
.. ==================================================
|
|
||||||
.. FOR YOUR INFORMATION
|
|
||||||
.. --------------------------------------------------
|
|
||||||
.. -*- coding: utf-8 -*- with BOM.
|
|
||||||
|
|
||||||
.. include:: Includes.txt
|
|
||||||
|
|
||||||
|
|
||||||
.. _links:
|
|
||||||
|
|
||||||
Links
|
|
||||||
-----
|
|
||||||
|
|
||||||
:TER:
|
|
||||||
https://typo3.org/extensions/repository/view/<extension key>
|
|
||||||
|
|
||||||
:Bug Tracker:
|
|
||||||
https://forge.typo3.org/projects/extension-<extension key>/issues
|
|
||||||
|
|
||||||
:Git Repository:
|
|
||||||
https://github.com/<username>/<extension key>
|
|
||||||
|
|
||||||
:Contact:
|
|
||||||
`@<username> <https://twitter.com/your-username>`__
|
|
||||||
|
|
@ -1,65 +0,0 @@
|
||||||
.. ==================================================
|
|
||||||
.. FOR YOUR INFORMATION
|
|
||||||
.. --------------------------------------------------
|
|
||||||
.. -*- coding: utf-8 -*- with BOM.
|
|
||||||
|
|
||||||
.. include:: ../Includes.txt
|
|
||||||
|
|
||||||
|
|
||||||
.. _start:
|
|
||||||
|
|
||||||
=============================================================
|
|
||||||
###PROJECT_NAME### (Deutsch)
|
|
||||||
=============================================================
|
|
||||||
|
|
||||||
.. only:: html
|
|
||||||
|
|
||||||
:Klassifikation:
|
|
||||||
extension_key
|
|
||||||
|
|
||||||
:Version:
|
|
||||||
|release|
|
|
||||||
|
|
||||||
:Sprache:
|
|
||||||
de
|
|
||||||
|
|
||||||
:Beschreibung:
|
|
||||||
Geben Sie eine Beschreibung ein.
|
|
||||||
|
|
||||||
:Schlüsselwörter:
|
|
||||||
komma-getrennte,Liste,von,Schlüsselwörtern
|
|
||||||
|
|
||||||
:Copyright:
|
|
||||||
###YEAR###
|
|
||||||
|
|
||||||
:Autor:
|
|
||||||
###AUTHOR###
|
|
||||||
|
|
||||||
:E-Mail:
|
|
||||||
author@example.com
|
|
||||||
|
|
||||||
:Lizenz:
|
|
||||||
Dieses Dokument wird unter der Open Publication License, siehe
|
|
||||||
http://www.opencontent.org/openpub/ veröffentlicht.
|
|
||||||
|
|
||||||
:Gerendert:
|
|
||||||
|today|
|
|
||||||
|
|
||||||
Der Inhalt dieses Dokuments bezieht sich auf TYPO3,
|
|
||||||
ein GNU/GPL CMS-Framework auf `www.typo3.org <https://typo3.org/>`__.
|
|
||||||
|
|
||||||
|
|
||||||
**Inhaltsverzeichnis**
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 3
|
|
||||||
:titlesonly:
|
|
||||||
|
|
||||||
.. Introduction/Index
|
|
||||||
.. UserManual/Index
|
|
||||||
.. AdministratorManual/Index
|
|
||||||
.. Configuration/Index
|
|
||||||
.. DeveloperCorner/Index
|
|
||||||
.. KnownProblems/Index
|
|
||||||
.. ToDoList/Index
|
|
||||||
.. ChangeLog/Index
|
|
||||||
|
|
@ -1,24 +0,0 @@
|
||||||
How to translate
|
|
||||||
================
|
|
||||||
|
|
||||||
This directory contains the German translation of your documentation.
|
|
||||||
This is a complete Sphinx project but you may reuse assets from the
|
|
||||||
main documentation under Documentation/.
|
|
||||||
|
|
||||||
If you plan to translate your documentation to German, you should
|
|
||||||
rename this directory and remove the suffix ".tmpl":
|
|
||||||
|
|
||||||
Localization.de_DE.tmpl -> Localization.de_DE
|
|
||||||
|
|
||||||
As this file is not needed either, feel free to delete it as well.
|
|
||||||
|
|
||||||
|
|
||||||
Supported languages
|
|
||||||
===================
|
|
||||||
|
|
||||||
Please visit http://sphinx-doc.org/latest/config.html#intl-options for a
|
|
||||||
list of languages supported by Sphinx.
|
|
||||||
|
|
||||||
Please note however that TYPO3 is using locales so you may need to
|
|
||||||
extend the language code from Sphinx into a proper locale to be used
|
|
||||||
by TYPO3.
|
|
||||||
|
|
@ -1,29 +0,0 @@
|
||||||
# This is the project specific Settings.yml file.
|
|
||||||
# Place Sphinx specific build information here.
|
|
||||||
# Settings given here will replace the settings of 'conf.py'.
|
|
||||||
|
|
||||||
# Below is an example of intersphinx mapping declaration
|
|
||||||
# Add more mappings depending on what manual you want to link to
|
|
||||||
# Remove entirely if you don't need cross-linking
|
|
||||||
|
|
||||||
---
|
|
||||||
conf.py:
|
|
||||||
copyright: 2012-2015
|
|
||||||
project: Extension Name (Deutsch)
|
|
||||||
version: x.y
|
|
||||||
release: x.y.z
|
|
||||||
intersphinx_mapping:
|
|
||||||
t3tsref:
|
|
||||||
- https://docs.typo3.org/typo3cms/TyposcriptReference/
|
|
||||||
- null
|
|
||||||
latex_documents:
|
|
||||||
- - Index
|
|
||||||
- <extension_key>.tex
|
|
||||||
- Extension Name (Français)
|
|
||||||
- Your Name
|
|
||||||
- manual
|
|
||||||
latex_elements:
|
|
||||||
papersize: a4paper
|
|
||||||
pointsize: 10pt
|
|
||||||
preamble: \usepackage{typo3}
|
|
||||||
...
|
|
||||||
|
|
@ -1,65 +0,0 @@
|
||||||
.. ==================================================
|
|
||||||
.. FOR YOUR INFORMATION
|
|
||||||
.. --------------------------------------------------
|
|
||||||
.. -*- coding: utf-8 -*- with BOM.
|
|
||||||
|
|
||||||
.. include:: ../Includes.txt
|
|
||||||
|
|
||||||
|
|
||||||
.. _start:
|
|
||||||
|
|
||||||
=============================================================
|
|
||||||
###PROJECT_NAME### (Français)
|
|
||||||
=============================================================
|
|
||||||
|
|
||||||
.. only:: html
|
|
||||||
|
|
||||||
:Classification:
|
|
||||||
extension_key
|
|
||||||
|
|
||||||
:Version:
|
|
||||||
|release|
|
|
||||||
|
|
||||||
:Langue:
|
|
||||||
fr
|
|
||||||
|
|
||||||
:Description:
|
|
||||||
entrez une description.
|
|
||||||
|
|
||||||
:Mots-clés:
|
|
||||||
list,mots-clés,séparés,par,virgules
|
|
||||||
|
|
||||||
:Copyright:
|
|
||||||
###YEAR###
|
|
||||||
|
|
||||||
:Auteur:
|
|
||||||
###AUTHOR###
|
|
||||||
|
|
||||||
:E-mail:
|
|
||||||
author@example.com
|
|
||||||
|
|
||||||
:Licence:
|
|
||||||
Ce document est publié sous la licence de publication libre
|
|
||||||
disponible sur http://www.opencontent.org/openpub/
|
|
||||||
|
|
||||||
:Généré:
|
|
||||||
|today|
|
|
||||||
|
|
||||||
Le contenu de ce document est en relation avec TYPO3,
|
|
||||||
un CMS/Framework GNU/GPL disponible sur `www.typo3.org <https://typo3.org/>`__.
|
|
||||||
|
|
||||||
|
|
||||||
**Sommaire**
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 3
|
|
||||||
:titlesonly:
|
|
||||||
|
|
||||||
.. Introduction/Index
|
|
||||||
.. UserManual/Index
|
|
||||||
.. AdministratorManual/Index
|
|
||||||
.. Configuration/Index
|
|
||||||
.. DeveloperCorner/Index
|
|
||||||
.. KnownProblems/Index
|
|
||||||
.. ToDoList/Index
|
|
||||||
.. ChangeLog/Index
|
|
||||||
|
|
@ -1,24 +0,0 @@
|
||||||
How to translate
|
|
||||||
================
|
|
||||||
|
|
||||||
This directory contains the French translation of your documentation.
|
|
||||||
This is a complete Sphinx project but you may reuse assets from the
|
|
||||||
main documentation under Documentation/.
|
|
||||||
|
|
||||||
If you plan to translate your documentation to French, you should
|
|
||||||
rename this directory and remove the suffix ".tmpl":
|
|
||||||
|
|
||||||
Localization.fr_FR.tmpl -> Localization.fr_FR
|
|
||||||
|
|
||||||
As this file is not needed either, feel free to delete it as well.
|
|
||||||
|
|
||||||
|
|
||||||
Supported languages
|
|
||||||
===================
|
|
||||||
|
|
||||||
Please visit http://sphinx-doc.org/latest/config.html#intl-options for a
|
|
||||||
list of languages supported by Sphinx.
|
|
||||||
|
|
||||||
Please note however that TYPO3 is using locales so you may need to
|
|
||||||
extend the language code from Sphinx into a proper locale to be used
|
|
||||||
by TYPO3.
|
|
||||||
|
|
@ -1,29 +0,0 @@
|
||||||
# This is the project specific Settings.yml file.
|
|
||||||
# Place Sphinx specific build information here.
|
|
||||||
# Settings given here will replace the settings of 'conf.py'.
|
|
||||||
|
|
||||||
# Below is an example of intersphinx mapping declaration
|
|
||||||
# Add more mappings depending on what manual you want to link to
|
|
||||||
# Remove entirely if you don't need cross-linking
|
|
||||||
|
|
||||||
---
|
|
||||||
conf.py:
|
|
||||||
copyright: 2012-2015
|
|
||||||
project: Extension Name (Français)
|
|
||||||
version: x.y
|
|
||||||
release: x.y.z
|
|
||||||
intersphinx_mapping:
|
|
||||||
t3tsref:
|
|
||||||
- https://docs.typo3.org/typo3cms/TyposcriptReference/
|
|
||||||
- null
|
|
||||||
latex_documents:
|
|
||||||
- - Index
|
|
||||||
- <extension_key>.tex
|
|
||||||
- Extension Name (Français)
|
|
||||||
- Your Name
|
|
||||||
- manual
|
|
||||||
latex_elements:
|
|
||||||
papersize: a4paper
|
|
||||||
pointsize: 10pt
|
|
||||||
preamble: \usepackage{typo3}
|
|
||||||
...
|
|
||||||
8
Documentation/Settings.cfg
Normal file
8
Documentation/Settings.cfg
Normal file
|
|
@ -0,0 +1,8 @@
|
||||||
|
[general]
|
||||||
|
project = Events Extension
|
||||||
|
copyright = since 2019 by Dirk Koritnik
|
||||||
|
|
||||||
|
[html_theme_options]
|
||||||
|
project_home = https://gitlab.werkraum-media.de/typo3/events/
|
||||||
|
project_issues = https://redmine.werkraum-media.de/projects/events
|
||||||
|
project_repository = https://gitlab.werkraum-media.de/typo3/events/
|
||||||
|
|
@ -1,32 +0,0 @@
|
||||||
# This is the project specific Settings.yml file.
|
|
||||||
# Place Sphinx specific build information here.
|
|
||||||
# Settings given here will replace the settings of 'conf.py'.
|
|
||||||
|
|
||||||
# Below is an example of intersphinx mapping declaration
|
|
||||||
# Add more mappings depending on what manual you want to link to
|
|
||||||
# Remove entirely if you don't need cross-linking
|
|
||||||
|
|
||||||
---
|
|
||||||
conf.py:
|
|
||||||
copyright: 2019
|
|
||||||
project: DD Events
|
|
||||||
version: 1.0.0
|
|
||||||
release: 1.0.0
|
|
||||||
intersphinx_mapping:
|
|
||||||
t3tsref:
|
|
||||||
- http://docs.typo3.org/typo3cms/TyposcriptReference/
|
|
||||||
- null
|
|
||||||
latex_documents:
|
|
||||||
- - Index
|
|
||||||
- dd_events.tex
|
|
||||||
- DD Events
|
|
||||||
- Dirk Koritnik
|
|
||||||
- manual
|
|
||||||
latex_elements:
|
|
||||||
papersize: a4paper
|
|
||||||
pointsize: 10pt
|
|
||||||
preamble: \usepackage
|
|
||||||
html_theme_options:
|
|
||||||
github_repository: TYPO3-Documentation/TYPO3CMS-Example-ExtensionManual
|
|
||||||
github_branch: latest
|
|
||||||
...
|
|
||||||
|
|
@ -1,16 +0,0 @@
|
||||||
.. ==================================================
|
|
||||||
.. FOR YOUR INFORMATION
|
|
||||||
.. --------------------------------------------------
|
|
||||||
.. -*- coding: utf-8 -*- with BOM.
|
|
||||||
|
|
||||||
.. include:: ../Includes.txt
|
|
||||||
|
|
||||||
|
|
||||||
.. _todo:
|
|
||||||
|
|
||||||
To-Do list
|
|
||||||
==========
|
|
||||||
|
|
||||||
Give a link pointing to a `roadmap <http://forge.typo3.org/projects/typo3cms-doc-official-extension-template/roadmap>`_.
|
|
||||||
Alternatively, you can dress up a list of things you want to add or fix in this chapter
|
|
||||||
or give a vision about where the extension is heading.
|
|
||||||
|
|
@ -1,67 +0,0 @@
|
||||||
.. ==================================================
|
|
||||||
.. FOR YOUR INFORMATION
|
|
||||||
.. --------------------------------------------------
|
|
||||||
.. -*- coding: utf-8 -*- with BOM.
|
|
||||||
|
|
||||||
.. include:: ../Includes.txt
|
|
||||||
|
|
||||||
|
|
||||||
.. _user-manual:
|
|
||||||
|
|
||||||
Users Manual
|
|
||||||
============
|
|
||||||
|
|
||||||
Target group: **Editors**
|
|
||||||
|
|
||||||
Here should be described how to use the extension from the editor perspective.
|
|
||||||
|
|
||||||
- How does it work?
|
|
||||||
|
|
||||||
- works well when doing this.
|
|
||||||
|
|
||||||
- does not work so well when doing that
|
|
||||||
but we can live with it.
|
|
||||||
|
|
||||||
- **mind indentation when nesting lists**.
|
|
||||||
|
|
||||||
- How to install the plugin on a web page?
|
|
||||||
|
|
||||||
- What options are available?
|
|
||||||
|
|
||||||
Language should be non-technical, explaining, using small examples.
|
|
||||||
Don't use to many acronyms unless they have been explained.
|
|
||||||
Don't be confusing by putting information targeting administrators.
|
|
||||||
|
|
||||||
.. tip::
|
|
||||||
|
|
||||||
Take a break from time to time.
|
|
||||||
|
|
||||||
Admonitions should be used to warn the users about potential
|
|
||||||
pitfalls, attract their attention to important elements
|
|
||||||
or just add some notes for for information (further reading,
|
|
||||||
for example).
|
|
||||||
|
|
||||||
.. important::
|
|
||||||
|
|
||||||
Remember to always say "please" when asking your software to
|
|
||||||
do something.
|
|
||||||
|
|
||||||
Provide screenshots as needed for making things clear. When creating
|
|
||||||
screenshots, try using the `Introduction Package <http://demo.typo3.org/>`_
|
|
||||||
as a neutral TYPO3 CMS instance.
|
|
||||||
|
|
||||||
.. 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)
|
|
||||||
|
|
||||||
|
|
||||||
.. _user-faq:
|
|
||||||
|
|
||||||
FAQ
|
|
||||||
---
|
|
||||||
|
|
||||||
Possible subsection: FAQ
|
|
||||||
Loading…
Reference in a new issue