Initial commit - Typo3 11.5.41
This commit is contained in:
Matteo Gallo
@@ -0,0 +1,34 @@
|
||||
.. include:: /Includes.rst.txt
|
||||
|
||||
.. _configuration:
|
||||
|
||||
Configuration
|
||||
=============
|
||||
|
||||
The extension ships some TypoScript code which needs to be included.
|
||||
|
||||
#. Switch to the root page of your site.
|
||||
|
||||
#. Switch to :guilabel:`Template > Info/Modify`.
|
||||
|
||||
#. Press the link :guilabel:`Edit the whole template record` and switch to the
|
||||
tab :guilabel:`Includes`.
|
||||
|
||||
#. Select :guilabel:`News (news)` at the field :guilabel:`Include static (from extensions):`
|
||||
|
||||
.. include:: /Images/AutomaticScreenshots/NewsIncludeTypoScript.rst.txt
|
||||
|
||||
#. Include the static template of `EXT:fluid_styled_content` or provide the
|
||||
following TypoScript yourself:
|
||||
|
||||
.. code-block:: typoscript
|
||||
|
||||
plugin.tx_news.settings.detail.media.image.lightbox {
|
||||
enabled = 0
|
||||
class = lightbox
|
||||
width = 800m
|
||||
height = 600m
|
||||
}
|
||||
|
||||
#. **Optional:** If your templates are based on Twitter Bootstrap, add the TWB
|
||||
styles as well to get optimized templates.
|
||||
18
typo3conf/ext/news/Documentation/Administration/Index.rst
Normal file
18
typo3conf/ext/news/Documentation/Administration/Index.rst
Normal file
@@ -0,0 +1,18 @@
|
||||
.. include:: /Includes.rst.txt
|
||||
|
||||
|
||||
.. _admin-manual:
|
||||
|
||||
Administration
|
||||
==============
|
||||
|
||||
This chapter describes how to manage the extension from a superuser point of view.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:titlesonly:
|
||||
|
||||
Installation/Index
|
||||
Configuration/Index
|
||||
Update/Index
|
||||
Migration/Index
|
||||
@@ -0,0 +1,62 @@
|
||||
.. include:: /Includes.rst.txt
|
||||
|
||||
.. _installation:
|
||||
|
||||
Installation
|
||||
============
|
||||
|
||||
The extension needs to be installed as any other extension of TYPO3 CMS. Get the
|
||||
extension by one of the following methods:
|
||||
|
||||
#. **Use composer**: Run
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
composer require georgringer/news
|
||||
|
||||
in your TYPO3 installation.
|
||||
|
||||
#. **Get it from the Extension Manager:** Switch to the module :guilabel:`Admin Tools > Extensions`.
|
||||
Switch to :guilabel:`Get Extensions` and search for the extension key
|
||||
*news* and import the extension from the repository.
|
||||
|
||||
#. **Get it from typo3.org:** You can always get current version from `TER`_
|
||||
by downloading the zip version. Upload the file afterwards in the Extension
|
||||
Manager.
|
||||
|
||||
and :ref:`configure <extensionConfiguration>` it.
|
||||
|
||||
.. _TER: https://extensions.typo3.org/extension/news/
|
||||
|
||||
Compatibility
|
||||
-------------
|
||||
|
||||
Ensure the compatibility of the extension with your TYPO3 installation by
|
||||
considering this compatibility matrix:
|
||||
|
||||
=========== =========== =========== ======================================
|
||||
News TYPO3 PHP Support / Development
|
||||
=========== =========== =========== ======================================
|
||||
dev-main 10 - 11 7.4 - 8.1 unstable development branch
|
||||
9 10 - 11 7.4 - 8.1 features, bugfixes, security updates
|
||||
8 9.5 - 10 7.2 - 7.4 none
|
||||
7.x 8.7 - 9.x 7.0 - 7.2 none
|
||||
6.x 7.6 - 8.7 5.6 - 7.2 none
|
||||
5.x 7.6 - 8.7 5.6 - 7.2 none
|
||||
4.x 7.6 5.5 - 5.6 none
|
||||
3.x 6.2 5.5 - 5.6 security updates
|
||||
=========== =========== =========== ======================================
|
||||
|
||||
Versioning
|
||||
----------
|
||||
|
||||
This project uses `semantic versioning <https://semver.org/>`_, which means that
|
||||
|
||||
* **bugfix updates** (e.g. 1.0.0 => 1.0.1) just include small bugfixes or
|
||||
security relevant stuff without breaking changes,
|
||||
* **minor updates** (e.g. 1.0.0 => 1.1.0) include new features and smaller
|
||||
tasks without breaking changes and
|
||||
* **major updates** (e.g. 1.0.0 => 2.0.0) contain breaking changes which can be
|
||||
refactorings, features or bugfixes.
|
||||
|
||||
as can be seen by reading the project's :ref:`change log <changelog>`.
|
||||
@@ -0,0 +1,14 @@
|
||||
.. include:: /Includes.rst.txt
|
||||
|
||||
|
||||
Migration
|
||||
---------
|
||||
|
||||
EXT:news provides a powerful import module which can be used to add news and category records from various sources.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 5
|
||||
:titlesonly:
|
||||
|
||||
MigrationFromTtNews/Index
|
||||
MigrationFromRealurl/Index
|
||||
@@ -0,0 +1,39 @@
|
||||
.. include:: /Includes.rst.txt
|
||||
|
||||
.. _migration_realurl_routing:
|
||||
|
||||
===========================================
|
||||
Migration from realurl to news with routing
|
||||
===========================================
|
||||
|
||||
This tutorial will describe to migrate realurl aliases to news path_segment.
|
||||
|
||||
Requirements
|
||||
============
|
||||
|
||||
- Installed extension news
|
||||
- DB table tx_realurl_uniqalias (EXT:realurl not required to be installed)
|
||||
|
||||
Migration
|
||||
=========
|
||||
|
||||
Migration of aliases
|
||||
--------------------
|
||||
|
||||
If a lot of similar titles are used it might be a good a idea to migrate the unique aliases from realurl to news path_segment to ensure that the same alias are used.
|
||||
|
||||
Use Installtool Upgrade Wizard, where a wizard only appears, if missing slugs found between realurl and news.
|
||||
Requires database table "tx_realurl_uniqalias" from EXT:realurl, but EXT:realurl requires not to be installed.
|
||||
|
||||
This wizard migrates only matching realurl alias for news entries, where path_segment is empty, respecting language and expire date from realurl.
|
||||
|
||||
Cause only empty news slugs will be generated within this migration, you may decide to empty all news slugs before.
|
||||
|
||||
The result of this migration can still left empty slugs fields for news entries.
|
||||
Therefore you should generate these slugs afterwards using the news slug updater wizard.
|
||||
|
||||
Configure routing
|
||||
-----------------
|
||||
|
||||
Read the following chapter on :ref:`How to rewrite URLs with news parameters
|
||||
<how_to_rewrite_urls>`.
|
||||
@@ -0,0 +1,65 @@
|
||||
.. include:: /Includes.rst.txt
|
||||
|
||||
|
||||
Migration from tt_news to news
|
||||
------------------------------
|
||||
This tutorial will help you to migrate data from tt_news to news.
|
||||
|
||||
Requirements
|
||||
^^^^^^^^^^^^
|
||||
- Installed extension news
|
||||
- Installed extension news_ttnewsimport
|
||||
|
||||
.. hint:: If you experience any troubles during imports, test the latest versions of the 2 extensions which can be found at https://git.typo3.org/TYPO3CMS/Extensions/news.git and https://github.com/fsaris/news_ttnewsimport.
|
||||
|
||||
Migration
|
||||
^^^^^^^^^
|
||||
|
||||
Migration of records
|
||||
""""""""""""""""""""
|
||||
To be able to migrate records, you need to activate the import module.
|
||||
This needs to be done in the configuration of EXT:news inside the Extension Manager.
|
||||
|
||||
#. Activate the checkbox "Show importer", save and reload the backend. Now you should see the backend module "News Import".
|
||||
#. Switch to the backend module.
|
||||
#. Select "Import tt_news category records" from the select box and start the import of categories.
|
||||
#. Select "Import tt_news news records" from the select box and start the import of news records.
|
||||
|
||||
|
||||
Migration of plugins
|
||||
""""""""""""""""""""
|
||||
The plugins of tt_news can be migrated to plugins of EXT:news as well. This is done by using the CLI:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
./typo3/cli_dispatch.phpsh extbase ttnewspluginmigrate:run
|
||||
./typo3/cli_dispatch.phpsh extbase ttnewspluginmigrate:removeOldPlugins
|
||||
|
||||
Read more about the migration and its limitation in the documentation of news_ttnewsimport at https://github.com/fsaris/news_ttnewsimport.
|
||||
|
||||
Migration of unique aliases
|
||||
"""""""""""""""""""""""""""
|
||||
If a lot of similar titles are used it might be a good a idea to migrate the unique aliases to be sure that the same alias is used.
|
||||
|
||||
.. code-block:: sql
|
||||
|
||||
# temporary table
|
||||
CREATE TABLE tx_realurl_uniqalias_migration LIKE tx_realurl_uniqalias;
|
||||
# copy
|
||||
INSERT INTO tx_realurl_uniqalias_migration SELECT * FROM tx_realurl_uniqalias WHERE tablename='tt_news';
|
||||
# fix it
|
||||
UPDATE tx_realurl_uniqalias_migration SET value_id = (SELECT tx_news_domain_model_news.uid FROM `tx_news_domain_model_news` WHERE tx_news_domain_model_news.import_id=tx_realurl_uniqalias_migration.value_id),tablename='tx_news_domain_model_news' WHERE tablename='tt_news';
|
||||
# remove wrong alias (news which have not been imported)
|
||||
DELETE FROM tx_realurl_uniqalias_migration WHERE tablename='tx_news_domain_model_news' AND value_id=0;
|
||||
# insert alias back into realurl table
|
||||
INSERT INTO tx_realurl_uniqalias (tstamp,tablename,field_id,value_alias,value_id,lang,expire) SELECT tstamp,tablename,field_id,value_alias,value_id,lang,expire FROM tx_realurl_uniqalias_migration
|
||||
|
||||
|
||||
Not migrated
|
||||
""""""""""""
|
||||
Be aware that some things are **not** migrated:
|
||||
|
||||
- Templates
|
||||
- TypoScript configuration
|
||||
- Backenduser & -group configuration
|
||||
- Additional fields added to tt_news by 3rd party extensions
|
||||
@@ -0,0 +1,24 @@
|
||||
.. include:: /Includes.rst.txt
|
||||
|
||||
|
||||
Updating
|
||||
--------
|
||||
If you update EXT:news to a newer version, please read this section carefully!
|
||||
|
||||
Versioning
|
||||
^^^^^^^^^^
|
||||
EXT:news follows the `semantic versioning <https://semver.org/>`__ approach.
|
||||
|
||||
It uses a 3-number versioning scheme: *<major>.<minor>.<patch>*
|
||||
|
||||
- Major: Breaking changes
|
||||
- Minor: New functionality, backwards compatible (without breaking changes)
|
||||
- Patch: Bug fixes (without breaking changes)
|
||||
|
||||
Before an update
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
Before you start the update procedure, please read the changelog of all versions which have been
|
||||
released in the meantime! You can find those in the manual :ref:`here <changelog>`.
|
||||
|
||||
Furthermore it is **always** a good idea to do updates on a dedicated test installation or at least create a database backup.
|
||||
Reference in New Issue
Block a user