Initial commit - Typo3 11.5.41
This commit is contained in:
Matteo Gallo
66
typo3conf/ext/news/Documentation/UsersManual/Index.rst
Normal file
66
typo3conf/ext/news/Documentation/UsersManual/Index.rst
Normal file
@@ -0,0 +1,66 @@
|
||||
.. include:: /Includes.rst.txt
|
||||
|
||||
.. _userManual:
|
||||
|
||||
Editors manual
|
||||
==============
|
||||
|
||||
.. container:: row m-0 p-0
|
||||
|
||||
.. container:: col-12 col-md-6 pl-0 pr-3 py-3 m-0
|
||||
|
||||
.. container:: card px-0 h-100
|
||||
|
||||
.. rst-class:: card-header h3
|
||||
|
||||
.. rubric:: :ref:`News administration module <newsAdminModule>`
|
||||
|
||||
.. container:: card-body
|
||||
|
||||
Use this module to create or edit news records, tags and categories.
|
||||
|
||||
.. container:: col-12 col-md-6 pl-0 pr-3 py-3 m-0
|
||||
|
||||
.. container:: card px-0 h-100
|
||||
|
||||
.. rst-class:: card-header h3
|
||||
|
||||
.. rubric:: :ref:`List module <listModule>`
|
||||
|
||||
.. container:: card-body
|
||||
|
||||
Advanced news editing, download, mass editing etc.
|
||||
|
||||
.. container:: col-12 col-md-6 pl-0 pr-3 py-3 m-0
|
||||
|
||||
.. container:: card px-0 h-100
|
||||
|
||||
.. rst-class:: card-header h3
|
||||
|
||||
.. rubric:: :ref:`Plugin <tutorialsBestPractice>`
|
||||
|
||||
.. container:: card-body
|
||||
|
||||
Describes the plugins and how to configure them
|
||||
|
||||
.. container:: col-12 col-md-6 pl-0 pr-3 py-3 m-0
|
||||
|
||||
.. container:: card px-0 h-100
|
||||
|
||||
.. rst-class:: card-header h3
|
||||
|
||||
.. rubric:: :ref:`Records <templatingExamples>`
|
||||
|
||||
.. container:: card-body
|
||||
|
||||
Lists all the fields of the various records
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 5
|
||||
:titlesonly:
|
||||
:hidden:
|
||||
|
||||
NewsModule/Index
|
||||
ListModule/Index
|
||||
Plugins/Index
|
||||
Records/Index
|
||||
@@ -0,0 +1,88 @@
|
||||
.. include:: /Includes.rst.txt
|
||||
|
||||
.. _listModule:
|
||||
|
||||
===========
|
||||
List module
|
||||
===========
|
||||
|
||||
You can also use the :guilabel:`List` module to create and edit news records.
|
||||
The choice depends on what modules you have permissions to use, your personal
|
||||
experience or choice.
|
||||
|
||||
The :guilabel:`List` module is more powerful then then the
|
||||
:ref:`News Administration <newsAdminModule>` module in some aspects,
|
||||
however it might be less tailored to the specific use case. This depends on
|
||||
how the project was set up.
|
||||
|
||||
.. todo: insert screenshot here.
|
||||
|
||||
Create a news storage folder
|
||||
============================
|
||||
|
||||
News records are usually stored in pages of the type :guilabel:`folder`. A
|
||||
folder itself cannot be displayed in the frontend. Its content can however
|
||||
be displayed on other pages through a plugin or TypoScript configuration.
|
||||
|
||||
Create a page of type folder by dragging a the folder symbol on top of the page
|
||||
tree into the desired position. Then give it a name and enable the folder in
|
||||
the context menu.
|
||||
|
||||
The folder can be displayed with a certain symbol such that folders containing
|
||||
news can be easily recognized.
|
||||
|
||||
Open the page properties by choosing :guilabel:`Edit` from the context menu.
|
||||
|
||||
Then go to the field :guilabel:`Behaviour > Contains Plugin` and chose
|
||||
:guilabel:`News`. After saving the folder record the symbol of the folder
|
||||
changes. If this field is not visible to you, you might lack permissions. In
|
||||
this case an administrator needs to set the field.
|
||||
|
||||
.. _listAddFirstRecord:
|
||||
|
||||
Add the first news record to a new folder
|
||||
=========================================
|
||||
|
||||
When there is no news record found in the folder yet, the table
|
||||
:guilabel:`News` is not visible yet. In that case click the plus button
|
||||
:guilabel:`Create a new record` on the top left of the list module area.
|
||||
|
||||
Chose :guilabel:`News system > News` from the list. Edit and save the news
|
||||
record as usual. The same strategy can be used to add
|
||||
:guilabel:`News system > Tags` and :guilabel:`News system > Tags`.
|
||||
|
||||
|
||||
Add subsequent news records to a folder
|
||||
=======================================
|
||||
|
||||
When a folder contains at least one news record it displays a table
|
||||
called :guilabel:`News` in the list module.
|
||||
|
||||
At the top of this table you can find the :guilabel:`New record` button.
|
||||
Click this button to create a news record directly.
|
||||
|
||||
Edit a news record
|
||||
==================
|
||||
|
||||
At the right of each listed news record you can edit, hide / unhide or
|
||||
delete a record by clicking the corresponding button. By clicking on the
|
||||
icon of the news you can also find a context menu with more options.
|
||||
|
||||
Download news as CSV or JSON
|
||||
============================
|
||||
|
||||
Starting with TYPO3 version 11 you can conveniently download all or a
|
||||
selection of news records to a comma-separated (CSV) file format that
|
||||
can be easily imported into excel. Click the :guilabel:`Download` button
|
||||
on the top right of the news table in the list module, make your choice
|
||||
click :guilabel:`Download`.
|
||||
|
||||
Mass editing
|
||||
============
|
||||
|
||||
Mass editing can come handy when you want to change many news records at
|
||||
once. The process differs between TYPO3 11.5 and older versions however.
|
||||
|
||||
Read the chapter on :ref:`mass editing <t3editors:mass-editing>` in the T
|
||||
YPO3 editors manual and chose the version of TYPO3 you are using from
|
||||
the top left version chooser.
|
||||
@@ -0,0 +1,91 @@
|
||||
.. include:: /Includes.rst.txt
|
||||
|
||||
.. _newsAdminModule:
|
||||
|
||||
==========================
|
||||
News administration module
|
||||
==========================
|
||||
|
||||
The :guilabel:`News Administration` module is a simple backend module that
|
||||
enables you to create, edit and search for news records. It can also be used
|
||||
to create categories or tags.
|
||||
|
||||
Go module :guilabel:`Web > News Administration`. If it is not chosen yet,
|
||||
choose the folder that your news records are stored in.
|
||||
|
||||
.. include:: /Images/AutomaticScreenshots/AdminModule.rst.txt
|
||||
|
||||
.. _newsModuleCreateNews:
|
||||
|
||||
Add a news record
|
||||
=================
|
||||
|
||||
Click the button :guilabel:`Create new news record` on the top of the
|
||||
:guilabel:`News Administration` module.
|
||||
|
||||
.. include:: /Images/AutomaticScreenshots/AddNewsInAdminModule.rst.txt
|
||||
|
||||
Fill in all necessary fields. In a standard setup only the title is a
|
||||
required field. Depending on your project there might be other required fields
|
||||
defined (for example at least on category chosen, author filled out etc..).
|
||||
|
||||
All required fields are marked in red and with an exclamation mark as is
|
||||
standard in TYPO3 backend forms.
|
||||
|
||||
When you are done, click the :guilabel:`Save` button.
|
||||
|
||||
If enabled by your integrator you are able to use the :guilabel:`View` button
|
||||
to preview your results. The integrator can follow this tutorial to
|
||||
:ref:`enable the view button <viewButton>`.
|
||||
|
||||
Depending on the settings of your project you might have to empty the cache
|
||||
before the news will be displayed in the list views. Your integrator can
|
||||
follow this tutorial, to :ref:`automate the cache clearing <cacheClearing>`.
|
||||
|
||||
|
||||
Search for news record
|
||||
=======================
|
||||
|
||||
Use the filter symbol on the top of the module to open the search. You can use
|
||||
multiple fields to filter the news.
|
||||
|
||||
|
||||
.. _newsModuleCreateCategory:
|
||||
|
||||
Create a category
|
||||
=================
|
||||
|
||||
The category records are provided by the TYPO3 Core. They are however closely
|
||||
integrated into EXT:news. You can create a category by clicking the button
|
||||
:guilabel:`Create a new category` on the top of the
|
||||
:guilabel:`News Administration` module.
|
||||
|
||||
.. include:: /Images/AutomaticScreenshots/AddCategoryInAdminModule.rst.txt
|
||||
|
||||
Fill in a title and possible a parent category and some other fields and
|
||||
click the :guilabel:`Save` button. Once you have created categories you can
|
||||
select them when editing news records.
|
||||
|
||||
You can also chose categories in the plugin to filter by categories. Or you can
|
||||
display a category menu.
|
||||
|
||||
.. _newsModuleCreateTag:
|
||||
|
||||
Create a tag
|
||||
============
|
||||
|
||||
.. include:: /Images/AutomaticScreenshots/AddTagInAdminModule.rst.txt
|
||||
|
||||
You can create a tag by clicking the button
|
||||
:guilabel:`Create a new tag` on the top of the
|
||||
:guilabel:`News Administration` module. Fill in a title and
|
||||
click the :guilabel:`Save` button.
|
||||
|
||||
Once you created some tags you can add to your news records on editing them.
|
||||
|
||||
Support \& Donate
|
||||
=================
|
||||
|
||||
You can find some information about how to support the main author of this
|
||||
extension on this page. Click the :guilabel:`Support & Donate` button
|
||||
on the top right of the module.
|
||||
105
typo3conf/ext/news/Documentation/UsersManual/Plugins/Index.rst
Normal file
105
typo3conf/ext/news/Documentation/UsersManual/Plugins/Index.rst
Normal file
@@ -0,0 +1,105 @@
|
||||
.. include:: /Includes.rst.txt
|
||||
|
||||
.. _plugin:
|
||||
|
||||
======
|
||||
Plugin
|
||||
======
|
||||
|
||||
The news plugin is used to output a defined list of records.
|
||||
|
||||
It can be added to create a content element with the type
|
||||
:guilabel:`Plugin` and by selecting the plugin type :guilabel:`News system`.
|
||||
|
||||
.. TODO: screenshot
|
||||
|
||||
.. only:: html
|
||||
|
||||
The available actions are:
|
||||
|
||||
.. contents::
|
||||
:local:
|
||||
:depth: 1
|
||||
|
||||
.. _plugin-list:
|
||||
|
||||
List
|
||||
^^^^
|
||||
The list action displays a list of defined records. The filters can be defined either in the plugin or by using TypoScript and are described :ref:`here <ts>`.
|
||||
|
||||
2 different list modes are available.
|
||||
|
||||
List view
|
||||
"""""""""
|
||||
|
||||
If a plugin is configured to show this implementation of the list action, it will change its behaviour if the URL contains a link to a detail action!
|
||||
If this is fulfilled, the detail action will be shown instead of the list action.
|
||||
|
||||
List view (without overloading detail view)
|
||||
"""""""""""""""""""""""""""""""""""""""""""
|
||||
The described behaviour of the first implementation might not be desired all the time.
|
||||
A typical example is to show a list view in the sidebar of a detail view page. If the above action would be used, the detail view would be shown in the sidebar too.
|
||||
|
||||
List of articles
|
||||
""""""""""""""""
|
||||
Show a specific list of articles
|
||||
|
||||
.. _plugin-detail:
|
||||
|
||||
Detail
|
||||
^^^^^^
|
||||
There are 2 typical use cases for this action:
|
||||
|
||||
- Use this action to show a full news record which is linked by a list view.
|
||||
- Provide a specific news record to output that one. This is very useful to embed a news record e.g. in a newsletter.
|
||||
|
||||
.. _plugin-dateMenu:
|
||||
|
||||
Date menu
|
||||
^^^^^^^^^
|
||||
Use this action to show a list of news items grouped by the date. A typical output can look like: ::
|
||||
|
||||
2015
|
||||
January: 13 entries
|
||||
February: 9 entries
|
||||
March: 6 entries
|
||||
June: 4 entries
|
||||
...
|
||||
2014
|
||||
March: 81 entries
|
||||
April: 32 entries
|
||||
May: 1 entry
|
||||
|
||||
|
||||
If you define a specific page id in field :guilabel:`PageId for list display` (inside the tab :guilabel:`Additional`) and
|
||||
placing a news plugin with the type :guilabel:`List` there, it is possible to create a date filter.
|
||||
|
||||
.. _plugin-searchForm:
|
||||
|
||||
Search form
|
||||
^^^^^^^^^^^
|
||||
Use this action to show a basic search inside news records.
|
||||
|
||||
.. _plugin-searchResult:
|
||||
|
||||
Search result
|
||||
^^^^^^^^^^^^^
|
||||
The search result action is based on the list action including an additional filter provided by the search form.
|
||||
|
||||
.. _plugin-categoryList:
|
||||
|
||||
Category menu
|
||||
^^^^^^^^^^^^^
|
||||
Use this action to show a list of categories. The categories are listed as tree.
|
||||
|
||||
If you define a specific page id in field :guilabel:`PageId for list display` (inside the tab "*Additional*") and
|
||||
placing a news plugin with the type :guilabel:`List` there, it is possible to create a category filter.
|
||||
|
||||
.. _plugin-tagList:
|
||||
|
||||
Tag list
|
||||
^^^^^^^^
|
||||
Use this action to show a list of tags.
|
||||
|
||||
If you define a specific page id in field :guilabel:`PageId for list display` (inside the tab "*Additional*") and
|
||||
placing a news plugin with the type :guilabel:`List` there, it is possible to create a tag filter.
|
||||
@@ -0,0 +1,120 @@
|
||||
.. include:: /Includes.rst.txt
|
||||
|
||||
.. _recordCategory:
|
||||
|
||||
========
|
||||
Category
|
||||
========
|
||||
|
||||
Categories are not mandatory but make it easier to structure news records.
|
||||
The category records themselves are supplied by the TYPO3 Core and might be
|
||||
shared with other extensions.
|
||||
|
||||
|
||||
Add a category
|
||||
==============
|
||||
|
||||
.. include:: /Images/AutomaticScreenshots/AddCategoryInAdminModule.rst.txt
|
||||
|
||||
Categories can be added in the :ref:`News administration <newsModuleCreateCategory>`
|
||||
or :ref:`List <listAddFirstRecord>` module.
|
||||
|
||||
Properties
|
||||
==========
|
||||
|
||||
.. include:: /Images/AutomaticScreenshots/CreateCategory.rst.txt
|
||||
|
||||
.. t3-field-list-table::
|
||||
:header-rows: 1
|
||||
|
||||
- :Field: Field
|
||||
:Description: Description
|
||||
|
||||
- :Field:
|
||||
Title
|
||||
:Description:
|
||||
Title of the category. This field is required!
|
||||
|
||||
- :Field:
|
||||
Parent category
|
||||
:Description:
|
||||
The parent category is used to build a category tree. Therefore
|
||||
select the parent of the current category. If nothing selected, the
|
||||
category is used as a root category.
|
||||
|
||||
- :Field:
|
||||
Image
|
||||
:Description:
|
||||
Image of the category which can be shown next to a category title.
|
||||
|
||||
- :Field:
|
||||
Description
|
||||
:Description:
|
||||
Description of the category
|
||||
|
||||
- :Field:
|
||||
Single-view page for news from this category
|
||||
:Description:
|
||||
If a page is defined, it is used as page for displaying the news
|
||||
record. If a news record belongs to more than one category, only the 1
|
||||
:sup:`st` category is checked for this field.
|
||||
|
||||
- :Field:
|
||||
News category shortcut
|
||||
:Description:
|
||||
Optional link of a news category to the given page
|
||||
|
||||
- :Field:
|
||||
SEO: <title>-Tag
|
||||
:Description:
|
||||
Can be used to set a special <title>-Tag for category pages.
|
||||
This must be enabled in the template:
|
||||
|
||||
.. code-block:: html
|
||||
|
||||
<f:if condition="{categories.0.title}">
|
||||
<n:titleTag>
|
||||
<f:format.htmlentitiesDecode>{categories.0.title}</f:format.htmlentitiesDecode>
|
||||
</n:titleTag>
|
||||
</f:if>
|
||||
|
||||
- :Field:
|
||||
SEO: Meta-Description
|
||||
:Description:
|
||||
Can be used to set a special meta description for category pages.
|
||||
This must be enabled in the template:
|
||||
|
||||
.. code-block:: html
|
||||
|
||||
<f:if condition="{categories.0.description}">
|
||||
<n:metaTag name="description" content="{categories.0.description -> f:format.stripTags()}" />
|
||||
</f:if>
|
||||
|
||||
- :Field:
|
||||
SEO: Headline
|
||||
:Description:
|
||||
Can be used to set a special headline for category pages, e.g. for H1 tag
|
||||
This must be enabled in the template:
|
||||
|
||||
.. code-block:: html
|
||||
|
||||
<f:if condition="{categories.0.headline}">
|
||||
<f:then>
|
||||
<h1>{categories.0.headline}</h1>
|
||||
</f:then>
|
||||
<f:else>
|
||||
<h1>News Category</h1>
|
||||
</f:else>
|
||||
</f:if>
|
||||
|
||||
- :Field:
|
||||
SEO: Text
|
||||
:Description:
|
||||
Can be used to add additional content text for category pages
|
||||
This must be enabled in the template:
|
||||
|
||||
.. code-block:: html
|
||||
|
||||
<f:if condition="{categories.0.text}">
|
||||
<f:format.html>{categories.0.text}</f:format.html>
|
||||
</f:if>
|
||||
@@ -0,0 +1,60 @@
|
||||
.. include:: /Includes.rst.txt
|
||||
|
||||
.. _records:
|
||||
|
||||
=======
|
||||
Records
|
||||
=======
|
||||
|
||||
EXT:news uses multiples records which are described here in detail.
|
||||
|
||||
|
||||
.. container:: row m-0 p-0
|
||||
|
||||
.. container:: col-12 col-md-6 pl-0 pr-3 py-3 m-0
|
||||
|
||||
.. container:: card px-0 h-100
|
||||
|
||||
.. rst-class:: card-header h3
|
||||
|
||||
.. rubric:: :ref:`News <recordNews>`
|
||||
|
||||
.. container:: card-body
|
||||
|
||||
News records to be displayed by the plugin. They can contain text,
|
||||
media (images, video, audio) or links to external sources.
|
||||
|
||||
.. container:: col-12 col-md-6 pl-0 pr-3 py-3 m-0
|
||||
|
||||
.. container:: card px-0 h-100
|
||||
|
||||
.. rst-class:: card-header h3
|
||||
|
||||
.. rubric:: :ref:`Categories <recordCategory>`
|
||||
|
||||
.. container:: card-body
|
||||
|
||||
Categories can be used to filter and sort news or to provide
|
||||
additional information.
|
||||
|
||||
.. container:: col-12 col-md-6 pl-0 pr-3 py-3 m-0
|
||||
|
||||
.. container:: card px-0 h-100
|
||||
|
||||
.. rst-class:: card-header h3
|
||||
|
||||
.. rubric:: :ref:`Tags <recordTag>`
|
||||
|
||||
.. container:: card-body
|
||||
|
||||
Tags can be used to group news or provide additional information
|
||||
depending on the project setup.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 5
|
||||
:titlesonly:
|
||||
|
||||
News/Index
|
||||
Category/Index
|
||||
Tag/Index
|
||||
|
||||
@@ -0,0 +1,275 @@
|
||||
.. include:: /Includes.rst.txt
|
||||
|
||||
.. _recordNews:
|
||||
|
||||
====
|
||||
News
|
||||
====
|
||||
|
||||
The news record is obviously the most important record in this extension.
|
||||
|
||||
|
||||
Add news record
|
||||
===============
|
||||
|
||||
News can be added in the :ref:`News administration <newsModuleCreateNews>`
|
||||
or :ref:`List <listAddFirstRecord>` module.
|
||||
|
||||
By default there are three types of news records:
|
||||
|
||||
* Standard news: These contain the content directly as text or content
|
||||
elements
|
||||
* Internal links: The content is stored on a standard typo3 page
|
||||
* External page: The content is found outside of the news installation
|
||||
|
||||
Standard news
|
||||
=============
|
||||
|
||||
In most projects when you create a new news record it will be automatically
|
||||
a standard news record. To confirm this check that the field :guilabel:`Type`
|
||||
is set to :guilabel:`News`. Standard news should usually have a text
|
||||
in the field :guilabel:`Text` field, some content elements in the
|
||||
:guilabel:`Content elements` tab and or some media in the :guilabel:`Media`
|
||||
tab.
|
||||
|
||||
News as internal link
|
||||
=====================
|
||||
|
||||
In some projects the text of the news itself is stored on a standard page. The
|
||||
news can still be listed in the list view of the news plugin.
|
||||
|
||||
Click the button :guilabel:`Create new news record` on the top of the
|
||||
:ref:`News Administration <newsModuleCreateNews>` module. Then switch the select filed
|
||||
:guilabel:`Type` to :guilabel:`Internal link`. Fill in the title field and
|
||||
other required or desired fields.
|
||||
|
||||
Then click the button to edit the :guilabel:`Internal link`.
|
||||
|
||||
When you are done, click the :guilabel:`Save` button. Depending on the settings
|
||||
of your project you might have to empty the cache
|
||||
before the news will be displayed in the list views.
|
||||
|
||||
|
||||
News as external page
|
||||
=====================
|
||||
|
||||
In some projects the text of the news itself is stored on an external page. The
|
||||
news can still be listed in the list view of the news plugin.
|
||||
|
||||
Creating an external page works just like an internal link. However you chose
|
||||
the type :guilabel:`External page` and enter the external link in the field
|
||||
:guilabel:`Link to External URL`.
|
||||
|
||||
|
||||
.. only:: html
|
||||
|
||||
.. contents::
|
||||
:local:
|
||||
:depth: 2
|
||||
|
||||
News record
|
||||
===========
|
||||
|
||||
The visible fields depend on
|
||||
|
||||
* The news type (see above)
|
||||
* Your user permissions
|
||||
* The configuration of your project
|
||||
* Third party extensions if applicable
|
||||
|
||||
.. t3-field-list-table::
|
||||
:header-rows: 1
|
||||
|
||||
- :Field:
|
||||
Field:
|
||||
:Description:
|
||||
Description:
|
||||
- :Field:
|
||||
Header
|
||||
:Description:
|
||||
Required! Title of a news record
|
||||
- :Field:
|
||||
Top news
|
||||
:Description:
|
||||
News records can be marked as top news if it is an important one. This field can be used for filtering and ordering.
|
||||
- :Field:
|
||||
Type
|
||||
:Description:
|
||||
A news record can belong to one of the following types:
|
||||
|
||||
- "News": Default news record
|
||||
- "Internal Page": The news record is linked to a regular page.
|
||||
- "External Page": The news record is linked to an external URL.
|
||||
|
||||
Some fields are only available for a special type.
|
||||
- :Field:
|
||||
Teaser
|
||||
:Description:
|
||||
A teaser text which is shown in the list view and explains the content
|
||||
of the news record in some sentences. Depending on the configuration
|
||||
it is possible that not complete text is shown in the frontend but
|
||||
just a part of it.
|
||||
- :Field:
|
||||
Author name
|
||||
:Description:
|
||||
Name of the author
|
||||
- :Field:
|
||||
Author email
|
||||
:Description:
|
||||
Email address of the author
|
||||
- :Field:
|
||||
Date & Time
|
||||
:Description:
|
||||
Date of the news record
|
||||
- :Field:
|
||||
Archive
|
||||
:Description:
|
||||
Depending on the configuration this date is used to define if the
|
||||
record is still shown. It is e.g. possible to show only records with
|
||||
an archive date in the past or in the future.
|
||||
- :Field:
|
||||
Text
|
||||
:Description:
|
||||
Main content of the news record.
|
||||
- :Field:
|
||||
Rich text editor disable
|
||||
:Description:
|
||||
If set, the RTE is disabled and the field "Text" is shown as plain textarea.
|
||||
- :Field:
|
||||
Content elements
|
||||
:Description:
|
||||
Add content elements to a news records. This field can be
|
||||
hidden by disabling the setting in :ref:`extensionConfiguration`.
|
||||
- :Field:
|
||||
Link to this Page
|
||||
:Description:
|
||||
Link to a regular page. This field is only shown with the type
|
||||
"Internal Page".
|
||||
- :Field:
|
||||
Link to External URL
|
||||
:Description:
|
||||
Link to an external url. This field is only shown with the type
|
||||
"External Page".
|
||||
- :Field:
|
||||
Categories
|
||||
:Description:
|
||||
Selection of categories the news record belongs to.
|
||||
- :Field:
|
||||
Tags
|
||||
:Description:
|
||||
Add tags to the news record. Use the suggest wizard to search for existing tags and to insert new tags.
|
||||
The pid can be set in the Extension Configuration :ref:`extensionConfigurationTagPid` or in :ref:`TsConfig <tsconfigTagPid>`.
|
||||
- :Field:
|
||||
Related News
|
||||
:Description:
|
||||
Define news records which are related to the current one.
|
||||
- :Field:
|
||||
Keywords
|
||||
:Description:
|
||||
Set keywords of this news record, separated with a comma (',')
|
||||
- :Field:
|
||||
Description
|
||||
:Description:
|
||||
Define an additional description
|
||||
- :Field:
|
||||
Alternative title
|
||||
:Description:
|
||||
If used, this field is used instead of the default tile.
|
||||
- :Field:
|
||||
Speaking URL path segment
|
||||
:Description:
|
||||
This field can be used for various scenarios, e.g. in your realurl configuration to set up the URL to the news record.
|
||||
|
||||
|
||||
Relations
|
||||
^^^^^^^^^
|
||||
|
||||
.. only:: html
|
||||
|
||||
.. contents::
|
||||
:local:
|
||||
:depth: 2
|
||||
|
||||
|
||||
Media file
|
||||
""""""""""
|
||||
This relation handles all media files you want to attach to a news record.
|
||||
|
||||
.. t3-field-list-table::
|
||||
:header-rows: 1
|
||||
|
||||
- :Field:
|
||||
Field:
|
||||
:Description:
|
||||
Description:
|
||||
- :Field:
|
||||
Show in list views
|
||||
:Description:
|
||||
If set, this media element will be rendered in the list view (or where it is desired by changing the templates).
|
||||
- :Field:
|
||||
Title
|
||||
:Description:
|
||||
Additional title
|
||||
- :Field:
|
||||
Alternative Title
|
||||
:Description:
|
||||
The alternative title is e.g. used for the alt attribute of images
|
||||
- :Field:
|
||||
Link
|
||||
:Description:
|
||||
Additional link
|
||||
- :Field:
|
||||
Caption
|
||||
:Description:
|
||||
Caption
|
||||
|
||||
|
||||
Video & audio file
|
||||
""""""""""""""""""
|
||||
TODO
|
||||
|
||||
Related files
|
||||
"""""""""""""
|
||||
This relation handles related files which are handled by FAL (File Abstraction Layer).
|
||||
|
||||
.. t3-field-list-table::
|
||||
:header-rows: 1
|
||||
|
||||
- :Field:
|
||||
Field:
|
||||
:Description:
|
||||
Description:
|
||||
- :Field:
|
||||
Title
|
||||
:Description:
|
||||
Additional title
|
||||
- :Field:
|
||||
Description
|
||||
:Description:
|
||||
Additional description
|
||||
|
||||
|
||||
|
||||
Related links
|
||||
"""""""""""""
|
||||
This relation handles links to any kind of URLs.
|
||||
|
||||
.. t3-field-list-table::
|
||||
:header-rows: 1
|
||||
|
||||
- :Field:
|
||||
Field:
|
||||
:Description:
|
||||
Description:
|
||||
- :Field:
|
||||
URL
|
||||
:Description:
|
||||
Required! URL can be a page id, email address, external URL, ...
|
||||
- :Field:
|
||||
Title
|
||||
:Description:
|
||||
Additional title
|
||||
- :Field:
|
||||
Description
|
||||
:Description:
|
||||
Additional description
|
||||
@@ -0,0 +1,93 @@
|
||||
.. include:: /Includes.rst.txt
|
||||
|
||||
.. _recordTag:
|
||||
|
||||
===
|
||||
Tag
|
||||
===
|
||||
|
||||
Tags are not mandatory but make it easier to structure news records.
|
||||
|
||||
.. include:: /Images/AutomaticScreenshots/AddTagInAdminModule.rst.txt
|
||||
|
||||
Add a tag
|
||||
=========
|
||||
|
||||
Tags can be added in the :ref:`News administration <newsModuleCreateTag>`
|
||||
or :ref:`List <listAddFirstRecord>` module.
|
||||
|
||||
Properties
|
||||
==========
|
||||
|
||||
.. t3-field-list-table::
|
||||
:header-rows: 1
|
||||
|
||||
- :Field:
|
||||
Field:
|
||||
:Description:
|
||||
Description:
|
||||
|
||||
- :Field:
|
||||
Title
|
||||
:Description:
|
||||
Title of the tag. This field is required!
|
||||
|
||||
- :Field:
|
||||
Hidden
|
||||
:Description:
|
||||
Hide a tag.
|
||||
|
||||
- :Field:
|
||||
SEO: <title>-Tag
|
||||
:Description:
|
||||
Can be used to set a special <title>-Tag for category pages.
|
||||
This must be enabled in the template:
|
||||
|
||||
.. code-block:: html
|
||||
|
||||
<f:if condition="{tags.0.title}">
|
||||
<n:titleTag>
|
||||
<f:format.htmlentitiesDecode>{tags.0.title}</f:format.htmlentitiesDecode>
|
||||
</n:titleTag>
|
||||
</f:if>
|
||||
|
||||
- :Field:
|
||||
SEO: Meta-Description
|
||||
:Description:
|
||||
Can be used to set a special meta description for category pages.
|
||||
This must be enabled in the template:
|
||||
|
||||
.. code-block:: html
|
||||
|
||||
<f:if condition="{tags.0.description}">
|
||||
<n:metaTag name="description" content="{tags.0.description -> f:format.stripTags()}" />
|
||||
</f:if>
|
||||
|
||||
- :Field:
|
||||
SEO: Headline
|
||||
:Description:
|
||||
Can be used to set a special headline for category pages, e.g. for H1 tag
|
||||
This must be enabled in the template:
|
||||
|
||||
.. code-block:: html
|
||||
|
||||
<f:if condition="{tags.0.headline}">
|
||||
<f:then>
|
||||
<h1>{tags.0.headline}</h1>
|
||||
</f:then>
|
||||
<f:else>
|
||||
<h1>News Category</h1>
|
||||
</f:else>
|
||||
</f:if>
|
||||
|
||||
- :Field:
|
||||
SEO: Text
|
||||
:Description:
|
||||
Can be used to add additional content text for category pages
|
||||
This must be enabled in the template:
|
||||
|
||||
.. code-block:: html
|
||||
|
||||
<f:if condition="{tags.0.text}">
|
||||
<f:format.html>{tags.0.text}</f:format.html>
|
||||
</f:if>
|
||||
Reference in New Issue
Block a user