-
Notifications
You must be signed in to change notification settings - Fork 26
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
46 changed files
with
1,314 additions
and
200 deletions.
There are no files selected for viewing
42 changes: 42 additions & 0 deletions
42
Documentation/Localization.de_DE/Configuration/General.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
.. include:: /Includes.rst.txt | ||
.. index:: Configuration | ||
.. _configuration-general: | ||
|
||
===================== | ||
General configuration | ||
===================== | ||
|
||
How is the extension configured? | ||
Aim to provide simple instructions detailing how the extension is configured. | ||
Always assume that the user has no prior experience of using the extension. | ||
|
||
Try and provide a typical use case for your extension | ||
and detail each of the steps required to get the extension running. | ||
|
||
|
||
.. index:: | ||
Configuration; Example | ||
Configuration; Typical | ||
.. _configuration_example: | ||
.. _configuration_typical: | ||
|
||
Typical example | ||
=============== | ||
|
||
* Does the integrator need to include a static template? | ||
* For example add a code snippet with comments | ||
|
||
Minimal example of TypoScript: | ||
|
||
* Code-blocks have support for syntax highlighting | ||
* Use any supported language | ||
|
||
.. code-block:: typoscript | ||
plugin.tx_myextension.settings { | ||
# configure basic email settings | ||
email { | ||
subject = Some subject | ||
from = [email protected] | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
.. include:: /Includes.rst.txt | ||
|
||
.. _configuration: | ||
|
||
============= | ||
Configuration | ||
============= | ||
|
||
.. toctree:: | ||
:maxdepth: 5 | ||
:titlesonly: | ||
|
||
General | ||
TypoScriptReference/Index | ||
TSconfig | ||
|
70 changes: 70 additions & 0 deletions
70
Documentation/Localization.de_DE/Configuration/TSconfig.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
.. include:: /Includes.rst.txt | ||
.. highlight:: typoscript | ||
.. index:: | ||
TSconfig | ||
.. _configuration-tsconfig: | ||
|
||
TSconfig reference | ||
================== | ||
|
||
If your extension uses TSconfig you can document it here. | ||
|
||
This section covers all configurations which can be set with TSconfig. | ||
Every configuration starts with :typoscript:`tx_myextension.`. | ||
|
||
.. note:: | ||
Just for clarification: TSconfig is in TYPO3 only used for configurations | ||
inside the backend! | ||
|
||
.. index:: | ||
TSconfig; Page | ||
.. _configuration-tsconfig_page: | ||
|
||
User TSconfig | ||
============= | ||
|
||
.. confval values will be added automatically to the index. | ||
.. confval:: enableSomething | ||
|
||
:type: bool | ||
:Default: 0 | ||
|
||
If :typoscript:`1` then something is enabled. | ||
|
||
Example:: | ||
|
||
tx_myextension.enableSomething = 1 | ||
|
||
|
||
.. index:: | ||
TSconfig; Page | ||
.. _configuration-tsconfig_user: | ||
|
||
Page TSconfig | ||
============= | ||
|
||
.. confval:: limitSomething | ||
|
||
:type: int | ||
:Default: 5 | ||
|
||
This value limits something. If it is set to :typoscript:`0` something will | ||
be unlimited. | ||
|
||
|
||
Example, limit something to 10:: | ||
|
||
tx_myextension.limitSomething = 10 | ||
|
||
.. confval:: someImportantPages | ||
|
||
:type: list | ||
:Default: '' | ||
|
||
Comma-list of fields from the pages-table. These fields are ... | ||
|
||
|
||
Example, limit something to 10:: | ||
|
||
tx_myextension.someImportantPages = 4, 7, 42 |
42 changes: 42 additions & 0 deletions
42
Documentation/Localization.de_DE/Configuration/TypoScriptReference/Constants.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
.. include:: /Includes.rst.txt | ||
.. highlight:: typoscript | ||
|
||
.. index:: | ||
TypoScript; Constants | ||
.. _configuration-typoscript-constants: | ||
|
||
Constants | ||
========= | ||
|
||
Enable / disable some options | ||
----------------------------- | ||
|
||
.. confval:: enableThis | ||
|
||
:type: bool | ||
:Default: 0 | ||
|
||
If :typoscript:`1` then something is enabled. | ||
|
||
Example:: | ||
|
||
plugin.tx_example.settings { | ||
enableThis = 1 | ||
} | ||
|
||
Configure page ids | ||
------------------ | ||
|
||
.. confval:: storageId | ||
|
||
:type: int | ||
:Default: 0 | ||
|
||
The id of the page storing the records | ||
|
||
|
||
Example:: | ||
|
||
plugin.tx_example.settings { | ||
storageId = 42 | ||
} |
22 changes: 22 additions & 0 deletions
22
Documentation/Localization.de_DE/Configuration/TypoScriptReference/Index.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
.. include:: /Includes.rst.txt | ||
.. _configuration-typoscript: | ||
|
||
TypoScript reference | ||
==================== | ||
|
||
Possible subsections: Reference of TypoScript options. | ||
The construct below show the recommended structure for TypoScript properties listing and description. | ||
|
||
When detailing data types or standard TypoScript features, | ||
don't hesitate to cross-link to the TypoScript Reference as shown below. | ||
|
||
See :ref:`h2document:how-to-document-hyperlinks` for information about how to use cross-references. | ||
|
||
See the :file:`guides.xml` file for the declaration of cross-linking keys. | ||
|
||
.. toctree:: | ||
:maxdepth: 5 | ||
:titlesonly: | ||
|
||
Constants | ||
Setup |
25 changes: 25 additions & 0 deletions
25
Documentation/Localization.de_DE/Configuration/TypoScriptReference/Setup.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
.. include:: /Includes.rst.txt | ||
.. highlight:: typoscript | ||
.. index:: | ||
TypoScript; Setup | ||
.. _configuration-typoscript-setup: | ||
|
||
Setup | ||
===== | ||
|
||
Enable / disable some options | ||
----------------------------- | ||
|
||
.. confval:: enableThat | ||
|
||
:type: bool, stdWrap | ||
:Default: 0 | ||
|
||
If :typoscript:`1` then something is enabled... | ||
|
||
|
||
Example:: | ||
|
||
plugin.tx_example.settings { | ||
enableThis.field = xyz | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,108 @@ | ||
.. include:: /Includes.rst.txt | ||
.. highlight:: php | ||
|
||
.. _developer: | ||
|
||
================ | ||
Developer corner | ||
================ | ||
|
||
Use this section to provide examples of code or detail any information that would be deemed relevant to a developer. | ||
|
||
For example explain how a certain feature was implemented. | ||
|
||
|
||
.. _developer-api: | ||
|
||
API | ||
=== | ||
|
||
How to use the API... | ||
|
||
Interfaces | ||
---------- | ||
|
||
The following list provides information for all necessary interfaces that are | ||
used inside of this documentation. For up to date information, please check | ||
the source code. | ||
|
||
|
||
.. php:namespace:: Vendor\MyExtension\Interfaces | ||
.. php:interface:: ExampleInterface | ||
Has to be implemented by all ... | ||
|
||
.. php:method:: methodOne() | ||
:returntype: string | ||
:returns: Something important | ||
|
||
.. php:interface:: AnotherImportantInterface | ||
Used for ... | ||
|
||
.. php:interface:: RequireJsModuleInterface | ||
Widgets implementing this interface will add the provided RequireJS modules. | ||
Those modules will be loaded in dashboard view if the widget is added at least once. | ||
|
||
.. php:method:: getRequireJsModules() | ||
Returns a list of RequireJS modules that should be loaded, e.g.:: | ||
|
||
return [ | ||
'TYPO3/CMS/MyExtension/ModuleName', | ||
'TYPO3/CMS/MyExtension/Module2Name', | ||
]; | ||
|
||
See also :ref:`t3coreapi:requirejs` for further information regarding RequireJS | ||
in TYPO3 Backend. | ||
|
||
:returntype: array | ||
:returns: List of modules to require. | ||
|
||
.. php:method:: setDate($year, $month, $day) | ||
Set the date. | ||
|
||
:param int $year: The year. | ||
:param int $month: The month. | ||
:param int $day: The day. | ||
:returns: Either false on failure, or the datetime object for method chaining. | ||
|
||
|
||
Examples | ||
-------- | ||
|
||
A php example:: | ||
|
||
// use \TYPO3\CMS\Core\Utility\GeneralUtility; | ||
$stuff = GeneralUtility::makeInstance( | ||
'\\Foo\\Bar\\Utility\\Stuff' | ||
); | ||
$stuff->do(); | ||
|
||
Example in another language: | ||
|
||
.. code-block:: javascript | ||
:linenos: | ||
:emphasize-lines: 2-4 | ||
$(document).ready( | ||
function () { | ||
doStuff(); | ||
} | ||
); | ||
A YAML example: | ||
|
||
.. code-block:: yaml | ||
services: | ||
Vendor\Extension\EventListener\YourListener: | ||
tags: | ||
- name: event.listener | ||
identifier: 'your-self-choosen-identifier' | ||
method: 'methodToConnectToEvent' | ||
event: Vendor\MyExtension\Event\MyActionEvent |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
.. include:: /Includes.rst.txt | ||
|
||
.. _for-editors: | ||
|
||
=========== | ||
For Editors | ||
=========== | ||
|
||
How to use the extension from the perspective of an editor. | ||
|
||
Think of common tasks that an editor is likely to perform: | ||
|
||
* How do they complete them? | ||
* What problems are they likely to encounter? | ||
* What access do they require? | ||
* What configuration options are available to them? | ||
|
||
One example could be adding a frontend plugin to a page and then configuring it. | ||
|
||
Language should be non-technical, aim to avoid using acronyms where possible. | ||
|
||
Be mindful that editors typically don't have administrative access to the installation. | ||
|
||
.. 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 add some notes for for information (further reading, for example). | ||
|
||
Do not overuse admonitions like notes, important, etc.! | ||
|
||
Provide screenshots as needed for making things clear. | ||
When creating screenshots, try using the Official Introduction Package. | ||
|
||
.. figure:: /Images/BackendView.png | ||
:class: with-shadow | ||
:alt: Backend view | ||
|
||
Default Backend view (caption of the image) | ||
|
||
Do not use huge full-screen images, unless it is necessary and serves a good purpose. | ||
|
||
.. _editor-faq: | ||
|
||
FAQ | ||
=== | ||
|
||
Possible subsection: FAQ |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.