Skip to content

Commit

Permalink
Documentation enhancement
Browse files Browse the repository at this point in the history
  • Loading branch information
thucke committed Nov 18, 2017
1 parent fdd24a9 commit 323223e
Showing 1 changed file with 78 additions and 1 deletion.
79 changes: 78 additions & 1 deletion Documentation/Administrator/Index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. ==================================================
.. ==================================================
.. FOR YOUR INFORMATION
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.
Expand All @@ -12,6 +12,7 @@
:class: typoscript
.. role:: php(code)
.. highlight:: php
.. _docs.typo3.org.logging: https://docs.typo3.org/typo3cms/CoreApiReference/ApiOverview/Logging/Index.html

.. _admin-manual:

Expand Down Expand Up @@ -73,6 +74,82 @@ extensions content element to change the timezone.

Constant uid setting pointing to the the page for changing the timezone.

.. _admin-logging:

Logging
-------

This extension features the standard logging mechanisms of TYPO3. You'll find find more information at `docs.typo3.org.logging`_.
Four log levels are actually used which might be activated via Typoscript in the following manner:

.. code-block:: typoscript
plugin.tx_timezones.settings.logging {
error {
file = typo3temp/logs/Timezones.log
table = sys_log
}
warning {
file = typo3temp/logs/Timezones.log
table = sys_log
}
info {
file = typo3temp/logs/Timezones.log
table = sys_log
}
debug {
file = typo3temp/logs/Timezones.log
table = sys_log
}
}
Changing style
--------------

.. index::
single: Changing style

Templates
^^^^^^^^^

The templates of this extension are stored in the directory ``typo3conf/ext/timezones/Resources/Private/Templates/Timezones`` of your TYPO3 installation.
For customization just copy them - all or only the one you want to change - into another directory e.g. ``fileadmin/templates/ext/timezones/``.
Then add the following configuration in your typoscript template:

.. code-block:: typoscript
plugin.tx_timezones.view {
templateRootPaths {
10 = fileadmin/templates/ext/timezones/
}
partialRootPaths {
10 = fileadmin/templates/ext/timezones/
}
layoutRootPaths {
10 = fileadmin/templates/ext/timezones/
}
}
.. caution::
When numbering the upper entries Do NOT use zero (0)!! This is used by the extension itself. Overiding the original folder might cause unwanted behaviour.

CSS
^^^

You may want to also override the default CSS style.
The extension template includes the file ``typo3conf/ext/timezones/Resources/Public/Css/timezones.css`` using the following typoscript:

.. code-block:: typoscript
page {
includeCSS {
timezones = EXT:timezones/Resources/Public/Css/timezones.css
}
}
Overriding CSS could be done completely placing this snippet in your configuration referencing another CSS file.
Specific directives could be also overridden or extended in your own CSS file(s).


.. _admin-faq:
Expand Down

0 comments on commit 323223e

Please sign in to comment.