Initial commit - Typo3 11.5.41
This commit is contained in:
Matteo Gallo
@@ -0,0 +1,37 @@
|
||||
.. include:: /Includes.rst.txt
|
||||
|
||||
.. _quickConfiguration:
|
||||
|
||||
===================
|
||||
Quick configuration
|
||||
===================
|
||||
|
||||
Include TypoScript template
|
||||
===========================
|
||||
|
||||
It is necessary to include at least the basic TypoScript provided by this
|
||||
extension.
|
||||
|
||||
Go module :guilabel:`Web > Template` and chose your root page. It should
|
||||
already contain a TypoScript template record. Switch to view
|
||||
:guilabel:`Info/Modify` and click on :guilabel:`Edit the whole template record`.
|
||||
|
||||
.. include:: /Images/AutomaticScreenshots/NewsIncludeTypoScript.rst.txt
|
||||
|
||||
Switch to tab :guilabel:`Includes` and add the following templates from the list
|
||||
to the right: :guilabel:`News (news)`. It is possible to include additional
|
||||
templates provided by the news extension depending on your use case. For example
|
||||
you can additionally chose :guilabel:`News Styles Twitter Bootstrap V5 (news)`
|
||||
to use templates for the css framework Bootstrap in version 5.
|
||||
|
||||
Read more about possible configurations via TypoScript in the
|
||||
:ref:`Reference <typoscript>` section.
|
||||
|
||||
Further reading
|
||||
===============
|
||||
|
||||
* :ref:`Global extension configuration <extensionConfiguration>`
|
||||
* :ref:`TypoScript <typoscript>`, mainly configuration for the frontend
|
||||
* :ref:`TsConfig <tsconfig>`, configuration for the backend
|
||||
* :ref:`Routing <routing>` for human readable URLs
|
||||
* :ref:`Templating <quickTemplating>` customize the templates
|
||||
126
typo3conf/ext/news/Documentation/QuickStart/CreateRecords.rst
Normal file
126
typo3conf/ext/news/Documentation/QuickStart/CreateRecords.rst
Normal file
@@ -0,0 +1,126 @@
|
||||
.. include:: /Includes.rst.txt
|
||||
|
||||
.. _quickContent:
|
||||
.. _howToStart:
|
||||
|
||||
===========================
|
||||
Create some initial content
|
||||
===========================
|
||||
|
||||
.. _quickPageStructure:
|
||||
|
||||
Recommended page structure
|
||||
==========================
|
||||
|
||||
Create at least the following pages:
|
||||
|
||||
* "Home": Root page of the site, containing the root TypoScript template record and
|
||||
the start page content: Normal page.
|
||||
* "News Storage": A folder to store the news in: Folder
|
||||
|
||||
Usually you will also need
|
||||
|
||||
* "News list": A list page to display all news on: Normal page
|
||||
* "News display": A single page to display the news detail view on:
|
||||
Normal page, hidden in menu
|
||||
|
||||
Your page tree could, for example look like that:
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
Home
|
||||
├── Some page
|
||||
├── ...
|
||||
├── News list
|
||||
│ └── News display
|
||||
├── ...
|
||||
└── Storage
|
||||
├── Other storage
|
||||
├── ...
|
||||
└── News Storage
|
||||
|
||||
|
||||
.. _quickNewsRecords:
|
||||
.. _howToStartCreateRecords:
|
||||
|
||||
Create news records
|
||||
===================
|
||||
|
||||
Before any news record can be shown in the frontend those need to be
|
||||
created.
|
||||
|
||||
.. include:: /Images/AutomaticScreenshots/AddNewsInAdminModule.rst.txt
|
||||
|
||||
#. Go to the module :guilabel:`Web > News administration`
|
||||
|
||||
#. Go to the "News Storage" Folder that you created in the first step.
|
||||
|
||||
#. Use the icon in the topbar :guilabel:`Create new news record`.
|
||||
|
||||
#. Fill out all desired fields and click :guilabel:`Save`.
|
||||
|
||||
More information about the records can be found here:
|
||||
:ref:`news record <recordNews>`, :ref:`category record <recordCategory>`,
|
||||
:ref:`tag record <recordTag>`.
|
||||
|
||||
|
||||
.. _howToStartAddPlugin:
|
||||
|
||||
Add plugins: display the news in the frontend
|
||||
=============================================
|
||||
|
||||
A plugin is used to render a defined selection of records in the frontend.
|
||||
Follow these steps to add a plugin respectively for detail and list view to
|
||||
a page:
|
||||
|
||||
Detail page
|
||||
-----------
|
||||
|
||||
#. Go to module :guilabel:`Web > Page` and to the previously created page
|
||||
"News display".
|
||||
|
||||
#. Add a new content element and select the entry
|
||||
:guilabel:`Plugins > News system`.
|
||||
|
||||
#. Switch to the tab :guilabel:`Plugin` where you can define the plugins settings.
|
||||
The most important settings are :guilabel:`What to display` and :guilabel:`Startingpoint`.
|
||||
|
||||
#. Change the 1 :sup:`st` select box :guilabel:`What to display` to :guilabel:`Detail view`.
|
||||
|
||||
#. Save the plugin.
|
||||
|
||||
List page
|
||||
---------
|
||||
|
||||
.. include:: /Images/AutomaticScreenshots/Plugin.rst.txt
|
||||
|
||||
#. Go to module :guilabel:`Web > Page` and to the previously created page
|
||||
"News list".
|
||||
|
||||
#. Add a new content element and select the entry
|
||||
:guilabel:`Plugins > News system`.
|
||||
|
||||
#. Switch to the tab :guilabel:`Plugin` where you can define the plugins settings.
|
||||
The most important settings are :guilabel:`What to display` and :guilabel:`Startingpoint`.
|
||||
|
||||
#. The selected view is already :guilabel:`List view`. This is fine.
|
||||
|
||||
#. Fill the field :guilabel:`Startingpoint` by selecting the :guilabel:`sysfolder` you created
|
||||
in the beginning of the tutorial.
|
||||
|
||||
#. Switch to tab :guilabel:`Additional` and fill the field :guilabel:`PageId
|
||||
for single news display` with the page you just created before.
|
||||
|
||||
.. include:: /Images/AutomaticScreenshots/PluginAdditional.rst.txt
|
||||
|
||||
#. Save the plugin.
|
||||
|
||||
Read more about the plugin configuration in chapter :ref:`Plugin <plugin>`.
|
||||
|
||||
Have a look at the frontend
|
||||
===========================
|
||||
|
||||
Load the "News list" page in the frontend and you should now see the news records
|
||||
as output. A click on the title should show the news record on the
|
||||
detail page. You want to change the way the records are displayed? Have a look
|
||||
at the chapter :ref:`Templating <quickTemplating>`
|
||||
50
typo3conf/ext/news/Documentation/QuickStart/Index.rst
Normal file
50
typo3conf/ext/news/Documentation/QuickStart/Index.rst
Normal file
@@ -0,0 +1,50 @@
|
||||
.. include:: /Includes.rst.txt
|
||||
|
||||
.. _quickStart:
|
||||
|
||||
===========
|
||||
Quick start
|
||||
===========
|
||||
|
||||
.. rst-class:: bignums-tip
|
||||
|
||||
#. Install this extension:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
composer require georgringer/news
|
||||
|
||||
.. rst-class:: horizbuttons-attention-m
|
||||
|
||||
- :ref:`Quick installation <quickInstallation>`
|
||||
|
||||
#. Configuration:
|
||||
|
||||
- Include the basic TypoScript
|
||||
- Further configuration
|
||||
|
||||
.. rst-class:: horizbuttons-attention-m
|
||||
|
||||
- :ref:`Quick configuration <quickConfiguration>`
|
||||
|
||||
#. Create initial content:
|
||||
|
||||
- Recommended page structure
|
||||
- Create news records
|
||||
|
||||
.. rst-class:: horizbuttons-attention-m
|
||||
|
||||
- :ref:`Recommended page structure <quickPageStructure>`
|
||||
- :ref:`Create news records <quickNewsRecords>`
|
||||
|
||||
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 5
|
||||
:titlesonly:
|
||||
:hidden:
|
||||
|
||||
Installation
|
||||
Configuration
|
||||
CreateRecords
|
||||
Templating
|
||||
41
typo3conf/ext/news/Documentation/QuickStart/Installation.rst
Normal file
41
typo3conf/ext/news/Documentation/QuickStart/Installation.rst
Normal file
@@ -0,0 +1,41 @@
|
||||
.. include:: /Includes.rst.txt
|
||||
|
||||
.. _quickInstallation:
|
||||
|
||||
==================
|
||||
Quick installation
|
||||
==================
|
||||
|
||||
In a :ref:`composer-based TYPO3 installation <t3start:install>` you can install
|
||||
the extension EXT:news via composer:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
composer require georgringer/news
|
||||
|
||||
In TYPO3 installations above version 11.5 the extension will be automatically
|
||||
installed. You do not have to activate it manually.
|
||||
|
||||
If you are using an older version of TYPO3 or have a legacy installation
|
||||
without composer, have a look at the
|
||||
:ref:`Extended installation <installation>` chapter.
|
||||
|
||||
|
||||
Update the database scheme
|
||||
--------------------------
|
||||
|
||||
Open your TYPO3 backend with :ref:`system maintainer <t3start:system-maintainer>`
|
||||
permissions.
|
||||
|
||||
In the module menu to the left navigate to :guilabel:`Admin Tools > Maintanance`,
|
||||
then click on :guilabel:`Analyze database` and create all.
|
||||
|
||||
.. include:: /Images/AutomaticScreenshots/AnalyzeDatabase.rst.txt
|
||||
|
||||
Clear all caches
|
||||
----------------
|
||||
|
||||
In the same module :guilabel:`Admin Tools > Maintanance` you can also
|
||||
conveniently clear all caches by clicking the button :guilabel:`Flush cache`.
|
||||
|
||||
.. include:: /Images/AutomaticScreenshots/FlushCache.rst.txt
|
||||
44
typo3conf/ext/news/Documentation/QuickStart/Templating.rst
Normal file
44
typo3conf/ext/news/Documentation/QuickStart/Templating.rst
Normal file
@@ -0,0 +1,44 @@
|
||||
.. include:: /Includes.rst.txt
|
||||
|
||||
.. _quickTemplating:
|
||||
|
||||
=========================
|
||||
Quick templating in Fluid
|
||||
=========================
|
||||
|
||||
EXT:news is using Fluid as templating engine. If you are not experienced
|
||||
with Fluid yet you can read more about it in the chapter
|
||||
:ref:`Changing & editing templates <templatingStart>`.
|
||||
|
||||
Copy the Fluid templates that you want to adjust to your
|
||||
:ref:`sitepackage extension <templatingSitepackage>`.
|
||||
|
||||
You find the original templates in :file:`EXT:news/Resources/Private/Templates/`
|
||||
and the partials in :file:`EXT:news/Resources/Private/Partials/`. Never change
|
||||
these templates directly!
|
||||
|
||||
To override the standard news templates
|
||||
with your own you can use the TypoScript **constants** to set the
|
||||
paths:
|
||||
|
||||
.. code-block:: typoscript
|
||||
:caption: TypoScript constants
|
||||
|
||||
plugin.tx_news {
|
||||
view {
|
||||
templateRootPath = EXT:mysitepackage/Resources/Private/Extensions/News/Templates/
|
||||
partialRootPath = EXT:mysitepackage/Resources/Private/Extensions/News/Partials/
|
||||
layoutRootPath = EXT:mysitepackage/Resources/Private/Extensions/News/Layouts/
|
||||
}
|
||||
}
|
||||
|
||||
Add these lines to the file
|
||||
:file:`EXT:mysitepackage/Configuration/TypoScript/constants.typoscript` in your
|
||||
sitepackage.
|
||||
|
||||
EXT:news provides a couple of specific Fluid :ref:`ViewHelpers <viewHelpersReference>`.
|
||||
Of course all :doc:`ViewHelpers provided by TYPO3 <t3viewhelper:Index>` can
|
||||
be used as well.
|
||||
|
||||
In the tutorial section there are many
|
||||
:ref:`templating examples <templatingExamples>`.
|
||||
Reference in New Issue
Block a user