README

It is a highly customizable framework for chronological organized content - much more than just a news list! – (Quote by an user)

1 Features

• Based on extbase & fluid, implementing best practices from TYPO3 CMS
• Supports editors & authors by providing
  • well structured plugins with good preview functionality
  • backend module with filter & search
  • Frontend template variant based on Twitter Bootstrap (v3)
• Comprehensive documentation

2 Usage

2.1 Installation

Installation using Composer

The recommended way to install the extension is using Composer.

Run the following command within your Composer based TYPO3 project:

composer require georgringer/news

Installation as extension from TYPO3 Extension Repository (TER)

Download and install the extension with the extension manager module.

2.2 Minimal setup

1. Include the static TypoScript of the extension. Optional: If your templates are based on Twitter Bootstrap, add the TWB styles as well to get optimized templates.
2. Create some news records on a sysfolder.
3. Create a plugin on a page and select at least the sysfolder as startingpoint.

3 Help supporting further development

Why? The news extension is a powerful tool with a lot of features, always trying to thrive on the latest possibilities of the TYPO3 core. This implies a lot of work bringing this to the TYPO3 community.

How? There are multiple ways to support the further development

• Patreon: Support me on patreon.com and get access to additional extensions and snippets as reward.
• PayPal: Support me by a donation on paypal.com. It is just one click away.
• Amazon Wishlist: Satisfy a wish of my Amazon wishlist.

4 Administration corner

4.1 Versions and support

4.2 Changelog

Please look into the official extension documentation in changelog chapter.

4.3 Release Management

News uses semantic versioning, which means, that

• bugfix updates (e.g. 1.0.0 => 1.0.1) just includes small bugfixes or security relevant stuff without breaking changes,
• minor updates (e.g. 1.0.0 => 1.1.0) includes new features and smaller tasks without breaking changes,
• and major updates (e.g. 1.0.0 => 2.0.0) breaking changes wich can be refactorings, features or bugfixes.

4.4 Contribution

Pull Requests are gladly welcome! Nevertheless please don't forget to add an issue and connect it to your pull requests. This is very helpful to understand what kind of issue the PR is going to solve.

Bugfixes: Please describe what kind of bug your fix solve and give us feedback how to reproduce the issue. We're going to accept only bugfixes if we can reproduce the issue.

Features: Not every feature is relevant for the bulk of news users. In addition: We don't want to make news even more complicated in usability for an edge case feature. It helps to have a discussion about a new feature before you open a pull request.