Merge pull request #9 from alexander-nitsche/task-update-docs

[TASK] Align with new TYPO3 documentation standards
This commit is contained in:
Oliver Hader 2022-04-21 12:53:37 +02:00 committed by GitHub
commit e4c52ff059
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 238 additions and 30 deletions

20
.editorconfig Normal file
View 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

1
.gitignore vendored Normal file
View file

@ -0,0 +1 @@
/Documentation-GENERATED-temp/

View 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

96
Documentation/Index.rst Normal file
View file

@ -0,0 +1,96 @@
.. 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 them by clicking
the "Contact" link in the footer.

View 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/

View file

@ -1,38 +1,28 @@
# TYPO3 Extension "legacy_collections"
[![Latest Stable Version](https://poser.pugx.org/friendsoftypo3/legacy-collections/v/stable.svg)](https://extensions.typo3.org/extension/legacy_collections/)
[![TYPO3 11](https://img.shields.io/badge/TYPO3-11-orange.svg?style=flat-square)](https://get.typo3.org/version/11)
[![TYPO3 10](https://img.shields.io/badge/TYPO3-10-orange.svg?style=flat-square)](https://get.typo3.org/version/10)
[![Total Downloads](https://poser.pugx.org/friendsoftypo3/legacy-collections/d/total.svg)](https://packagist.org/packages/friendsoftypo3/legacy-collections)
[![Monthly Downloads](https://poser.pugx.org/friendsoftypo3/legacy-collections/d/monthly)](https://packagist.org/packages/friendsoftypo3/legacy-collections)
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 |

View file

@ -2,7 +2,12 @@
"name": "friendsoftypo3/legacy-collections",
"type": "typo3-cms-extension",
"description": "Legacy Collection PHP APIs for sys_collection database tables.",
"homepage": "https://typo3.org",
"homepage": "https://extensions.typo3.org/extension/legacy_collections",
"support": {
"issues": "https://github.com/FriendsOfTYPO3/legacy-collections/issues",
"source": "https://github.com/FriendsOfTYPO3/legacy-collections",
"docs": "https://docs.typo3.org/p/friendsoftypo3/legacy-collections/main/en-us/"
},
"license": ["GPL-2.0+"],
"require": {
"php": "^7.2 || ^8.0",