-
Notifications
You must be signed in to change notification settings - Fork 0
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
Florian 'Panade' Tatzel
committed
Jul 30, 2014
0 parents
commit 6fbddc6
Showing
48 changed files
with
9,860 additions
and
0 deletions.
There are no files selected for viewing
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,5 @@ | ||
|
||
# Default PAGE object: | ||
page = PAGE | ||
page.10 = TEXT | ||
page.10.value = HELLO WORLD!!!!! |
Empty file.
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 @@ | ||
<INCLUDE_TYPOSCRIPT:source="FILE: EXT:pde_distribution/Configuration/TypoScript/Setup/page.ts"> |
Binary file not shown.
82 changes: 82 additions & 0 deletions
82
pde_distribution/Documentation.tmpl/Administrator/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,82 @@ | ||
.. ================================================== | ||
.. 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... |
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 @@ | ||
.. ================================================== | ||
.. FOR YOUR INFORMATION | ||
.. -------------------------------------------------- | ||
.. -*- coding: utf-8 -*- with BOM. | ||
.. include:: ../Includes.txt | ||
|
||
|
||
.. _changelog: | ||
|
||
ChangeLog | ||
========= | ||
|
||
Providing a change log chapter is optional. You can also refer | ||
users to the ChangeLog file inside the extension or to some repository's | ||
commit listing. |
104 changes: 104 additions & 0 deletions
104
pde_distribution/Documentation.tmpl/Configuration/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,104 @@ | ||
.. ================================================== | ||
.. 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_) | ||
is 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 |
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,58 @@ | ||
.. ================================================== | ||
.. 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 added
BIN
+153 KB
...distribution/Documentation.tmpl/Images/AdministratorManual/ExtensionManager.png
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.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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,21 @@ | ||
.. ================================================== | ||
.. 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 |
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,65 @@ | ||
.. ================================================== | ||
.. FOR YOUR INFORMATION | ||
.. -------------------------------------------------- | ||
.. -*- coding: utf-8 -*- with BOM. | ||
.. include:: Includes.txt | ||
|
||
.. _start: | ||
|
||
============================================================= | ||
PanadeEdu Tutorial Distribution | ||
============================================================= | ||
|
||
.. only:: html | ||
|
||
:Classification: | ||
pde_distribution | ||
|
||
:Version: | ||
|release| | ||
|
||
:Language: | ||
en | ||
|
||
:Description: | ||
Configures Template | ||
|
||
:Keywords: | ||
comma,separated,list,of,keywords | ||
|
||
:Copyright: | ||
2014 | ||
|
||
:Author: | ||
Florian Tatzel | ||
|
||
:Email: | ||
[email protected] | ||
|
||
:License: | ||
This document is published under the Open Content License | ||
available from http://www.opencontent.org/opl.shtml | ||
|
||
:Rendered: | ||
|today| | ||
|
||
The content of this document is related to TYPO3, | ||
a GNU/GPL CMS/Framework available from `www.typo3.org <http://www.typo3.org/>`_. | ||
|
||
**Table of Contents** | ||
|
||
.. toctree:: | ||
:maxdepth: 5 | ||
:titlesonly: | ||
:glob: | ||
|
||
Introduction/Index | ||
User/Index | ||
Administrator/Index | ||
Configuration/Index | ||
Developer/Index | ||
KnownProblems/Index | ||
ToDoList/Index | ||
ChangeLog/Index | ||
Targets |
Oops, something went wrong.