mirror of
https://github.com/DanielSiepmann/legacy-collections.git
synced 2024-11-21 14:16:12 +01:00
[TASK] Align with new TYPO3 documentation standards
- align README.md - add .editorconfig, Settings.cfg, Index.rst, Includes.rst.txt See https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/GeneralConventions/FileStructure.html for further details.
This commit is contained in:
Alexander Nitsche
parent
3b6a356789
commit
868f056a91
5 changed files with 231 additions and 29 deletions
20
.editorconfig
Normal file
20
.editorconfig
Normal file
|
|
@ -0,0 +1,20 @@
|
|||
root = true
|
||||
|
||||
[{*.rst,*.rst.txt}]
|
||||
charset = utf-8
|
||||
end_of_line = lf
|
||||
insert_final_newline = true
|
||||
trim_trailing_whitespace = true
|
||||
indent_style = space
|
||||
indent_size = 3
|
||||
max_line_length = 80
|
||||
|
||||
# MD-Files
|
||||
[*.md]
|
||||
charset = utf-8
|
||||
end_of_line = lf
|
||||
insert_final_newline = true
|
||||
trim_trailing_whitespace = true
|
||||
indent_style = space
|
||||
indent_size = 4
|
||||
max_line_length = 80
|
||||
34
Documentation/Includes.rst.txt
Normal file
34
Documentation/Includes.rst.txt
Normal file
|
|
@ -0,0 +1,34 @@
|
|||
.. More information about this file:
|
||||
https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/GeneralConventions/FileStructure.html#includes-rst-txt
|
||||
|
||||
.. ----------
|
||||
.. text roles
|
||||
.. ----------
|
||||
|
||||
.. role:: aspect(emphasis)
|
||||
.. role:: bash(code)
|
||||
.. role:: html(code)
|
||||
.. role:: js(code)
|
||||
.. role:: php(code)
|
||||
.. role:: rst(code)
|
||||
.. role:: sep(strong)
|
||||
.. role:: sql(code)
|
||||
|
||||
.. role:: tsconfig(code)
|
||||
:class: typoscript
|
||||
|
||||
.. role:: typoscript(code)
|
||||
.. role:: xml(code)
|
||||
:class: html
|
||||
|
||||
.. role:: yaml(code)
|
||||
|
||||
.. default-role:: code
|
||||
|
||||
.. ---------
|
||||
.. highlight
|
||||
.. ---------
|
||||
|
||||
.. By default, code blocks use PHP syntax highlighting
|
||||
|
||||
.. highlight:: php
|
||||
98
Documentation/Index.rst
Normal file
98
Documentation/Index.rst
Normal file
|
|
@ -0,0 +1,98 @@
|
|||
.. include:: /Includes.rst.txt
|
||||
|
||||
==================
|
||||
Legacy Collections
|
||||
==================
|
||||
|
||||
:Extension key:
|
||||
legacy_collections
|
||||
|
||||
:Package name:
|
||||
friendsoftypo3/legacy-collections
|
||||
|
||||
:Version:
|
||||
|release|
|
||||
|
||||
:Language:
|
||||
en
|
||||
|
||||
:Author:
|
||||
TYPO3 Core Team & Contributors
|
||||
|
||||
:License:
|
||||
This document is published under the
|
||||
`Creative Commons BY 4.0 <https://creativecommons.org/licenses/by/4.0/>`__
|
||||
license.
|
||||
|
||||
:Rendered:
|
||||
|today|
|
||||
|
||||
----
|
||||
|
||||
This extension provides TCA information and database tables for the generic
|
||||
"sys_collections" concept, which allows for statically select items into a
|
||||
collection.
|
||||
|
||||
In addition, two API classes for fetching items from a collection are available
|
||||
as well:
|
||||
|
||||
* `FriendsOfTYPO3\LegacyCollections\Collection\RecordCollectionRepository`
|
||||
* `FriendsOfTYPO3\LegacyCollections\Collection\StaticRecordCollection`
|
||||
|
||||
Both classes previously resided in the PHP namespace `TYPO3\CMS\Core\Collection`.
|
||||
|
||||
The functionality was part of the TYPO3 Core until TYPO3 v11.0, and moved into
|
||||
its own extension, receiving its own public repository.
|
||||
|
||||
----
|
||||
|
||||
**Table of Contents:**
|
||||
|
||||
.. contents::
|
||||
:backlinks: top
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
Installation
|
||||
============
|
||||
|
||||
The latest version can be installed via `TER`_ or via composer by running
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
composer require friendsoftypo3/legacy-collections
|
||||
|
||||
in a TYPO3 v10.0+ installation.
|
||||
|
||||
.. _TER: https://extensions.typo3.org/extension/legacy_collections
|
||||
|
||||
Current state
|
||||
=============
|
||||
|
||||
The extension has been part of TYPO3 Core for a very long time but its API
|
||||
wasn't flexible enough to build a generic collection model. It may become more
|
||||
healthy if maintained as third party extension and has been extracted for this
|
||||
reason.
|
||||
|
||||
Contribution
|
||||
============
|
||||
|
||||
Feel free to submit any pull request, or add documentation, tests, as you
|
||||
please. We will publish a new version every once in a while, depending on the
|
||||
amount of changes and pull requests submitted.
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
The extension is published under GPL v2+, all included third-party libraries are
|
||||
published under their respective licenses.
|
||||
|
||||
Authors
|
||||
-------
|
||||
|
||||
Many contributors have been working on this area while this functionality was
|
||||
part of the TYPO3 Core. This package is now maintained by a loose group of TYPO3
|
||||
enthusiasts inside the TYPO3 Community. Feel free to contact `Benni Mack`_ for
|
||||
any questions regarding "legacy_collections".
|
||||
|
||||
.. _Benni Mack: benni.mack@typo3.org
|
||||
62
Documentation/Settings.cfg
Normal file
62
Documentation/Settings.cfg
Normal file
|
|
@ -0,0 +1,62 @@
|
|||
# More information about this file:
|
||||
# https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/GeneralConventions/FileStructure.html#settings-cfg
|
||||
|
||||
[general]
|
||||
|
||||
project = Legacy Collections
|
||||
version = main (development)
|
||||
release = main (development)
|
||||
copyright = since 2020 by the TYPO3 contributors
|
||||
|
||||
[html_theme_options]
|
||||
|
||||
# "Edit on GitHub" button
|
||||
github_repository = FriendsOfTYPO3/legacy-collections
|
||||
github_branch = main
|
||||
|
||||
# Footer links
|
||||
project_home = https://extensions.typo3.org/extension/legacy_collections
|
||||
project_contact = https://typo3.slack.com/archives/C025BQLFA
|
||||
project_repository = https://github.com/FriendsOfTYPO3/legacy-collections
|
||||
project_issues = https://github.com/FriendsOfTYPO3/legacy-collections/issues
|
||||
project_discussions =
|
||||
|
||||
use_opensearch =
|
||||
|
||||
[intersphinx_mapping]
|
||||
|
||||
# Official TYPO3 manuals
|
||||
# h2document = https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/
|
||||
# t3cheatsheets = https://docs.typo3.org/m/typo3/docs-cheatsheets/main/en-us/
|
||||
# t3contribute = https://docs.typo3.org/m/typo3/guide-contributionworkflow/main/en-us/
|
||||
# t3coreapi = https://docs.typo3.org/m/typo3/reference-coreapi/main/en-us/
|
||||
# t3docteam = https://docs.typo3.org/m/typo3/team-t3docteam/main/en-us/
|
||||
# t3editors = https://docs.typo3.org/m/typo3/tutorial-editors/main/en-us/
|
||||
# t3extbasebook = https://docs.typo3.org/m/typo3/book-extbasefluid/main/en-us/
|
||||
# t3extexample = https://docs.typo3.org/m/typo3/guide-example-extension-manual/main/en-us/
|
||||
# t3home = https://docs.typo3.org/
|
||||
# t3install = https://docs.typo3.org/m/typo3/guide-installation/main/en-us/
|
||||
# t3l10n = https://docs.typo3.org/m/typo3/guide-frontendlocalization/main/en-us/
|
||||
# t3sitepackage = https://docs.typo3.org/m/typo3/tutorial-sitepackage/main/en-us/
|
||||
# t3start = https://docs.typo3.org/m/typo3/tutorial-getting-started/main/en-us/
|
||||
# t3tca = https://docs.typo3.org/m/typo3/reference-tca/main/en-us/
|
||||
# t3templating = https://docs.typo3.org/m/typo3/tutorial-templating/main/en-us/
|
||||
# t3translate = https://docs.typo3.org/m/typo3/guide-frontendlocalization/main/en-us/
|
||||
# t3tsconfig = https://docs.typo3.org/m/typo3/reference-tsconfig/main/en-us/
|
||||
# t3tsref = https://docs.typo3.org/m/typo3/reference-typoscript/main/en-us/
|
||||
# t3ts45 = https://docs.typo3.org/m/typo3/tutorial-typoscript-in-45-minutes/main/en-us/
|
||||
# t3viewhelper = https://docs.typo3.org/other/typo3/view-helper-reference/main/en-us/
|
||||
# t3upgrade = https://docs.typo3.org/m/typo3/guide-installation/main/en-us/
|
||||
|
||||
# TYPO3 system extensions
|
||||
# ext_adminpanel = https://docs.typo3.org/c/typo3/cms-adminpanel/main/en-us/
|
||||
# ext_core = https://docs.typo3.org/c/typo3/cms-core/main/en-us/
|
||||
# ext_dashboard = https://docs.typo3.org/c/typo3/cms-dashboard/main/en-us/
|
||||
# ext_felogin = https://docs.typo3.org/c/typo3/cms-felogin/main/en-us/
|
||||
# ext_form = https://docs.typo3.org/c/typo3/cms-form/main/en-us/
|
||||
# ext_fsc = https://docs.typo3.org/c/typo3/cms-fluid-styled-content/main/en-us/
|
||||
# ext_indexed_search = https://docs.typo3.org/c/typo3/cms-indexed-search/main/en-us/
|
||||
# ext_rte_ckeditor = https://docs.typo3.org/c/typo3/cms-rte-ckeditor/main/en-us/
|
||||
# ext_scheduler = https://docs.typo3.org/c/typo3/cms-scheduler/main/en-us/
|
||||
# ext_seo = https://docs.typo3.org/c/typo3/cms-seo/main/en-us/
|
||||
# ext_workspaces = https://docs.typo3.org/c/typo3/cms-workspaces/main/en-us/
|
||||
46
README.md
46
README.md
|
|
@ -1,38 +1,26 @@
|
|||
# TYPO3 Extension "legacy_collections"
|
||||
[](https://extensions.typo3.org/extension/legacy_collections/)
|
||||
[](https://get.typo3.org/version/11)
|
||||
[](https://get.typo3.org/version/10)
|
||||
|
||||
This extension provides TCA information and database tables for the generic "sys_collections"
|
||||
concept, which allows for statically select items into a collection.
|
||||
# TYPO3 extension `legacy_collections`
|
||||
|
||||
In addition, two API classes for fetching items from a collection are available as well:
|
||||
This extension provides TCA information and database tables for the generic
|
||||
"sys_collections" concept, which allows for statically select items into a
|
||||
collection.
|
||||
|
||||
In addition, two API classes for fetching items from a collection are available
|
||||
as well:
|
||||
|
||||
* `FriendsOfTYPO3\LegacyCollections\Collection\RecordCollectionRepository`
|
||||
* `FriendsOfTYPO3\LegacyCollections\Collection\StaticRecordCollection`
|
||||
|
||||
Both classes previously resided in the PHP namespace `TYPO3\CMS\Core\Collection`.
|
||||
|
||||
The functionality was part of the TYPO3 Core until TYPO3 v11.0, and moved into its
|
||||
own extension, receiving its own public repository.
|
||||
The functionality was part of the TYPO3 Core until TYPO3 v11.0, and moved into
|
||||
its own extension, receiving its own public repository.
|
||||
|
||||
## Installation
|
||||
The latest version can be installed via TER (https://extensions.typo3.org) or via composer
|
||||
by adding `composer require friendsoftypo3/legacy-collections` in a TYPO3 v10.0+ installation.
|
||||
|
||||
## Current state
|
||||
The extension has been part of TYPO3 Core for a very long time but its API wasn't flexible
|
||||
enough to build a generic collection model. It may become more healthy if maintained as third party
|
||||
extension and has been extracted for this reason.
|
||||
|
||||
## Contribution
|
||||
Feel free to submit any pull request, or add documentation, tests, as you please.
|
||||
We will publish a new version every once in a while, depending on the amount of changes
|
||||
and pull requests submitted.
|
||||
|
||||
### License
|
||||
The extension is published under GPL v2+, all included third-party libraries are
|
||||
published under their respective licenses.
|
||||
|
||||
### Authors
|
||||
Many contributors have been working on this area while this functionality was part of
|
||||
the TYPO3 Core. This package is now maintained by a loose group of TYPO3 enthusiasts inside
|
||||
the TYPO3 Community. Feel free to contact Benni Mack (benni.mack@typo3.org) for any questions
|
||||
regarding "legacy_collections".
|
||||
| | URL |
|
||||
|------------------|------------------------------------------------------------------------|
|
||||
| **Repository:** | https://github.com/FriendsOfTYPO3/legacy-collections |
|
||||
| **Read online:** | https://docs.typo3.org/p/friendsoftypo3/legacy-collections/main/en-us/ |
|
||||
| **TER:** | https://extensions.typo3.org/extension/legacy_collections |
|
||||
|
|
|
|||
Loading…
Reference in a new issue