Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cdaecke/md_unreadnews
TYPO3 extension to add a unread flag for feUsers to a news record.
https://github.com/cdaecke/md_unreadnews
news php typo3 typo3-cms-extension typo3-extension unread
Last synced: about 2 months ago
JSON representation
TYPO3 extension to add a unread flag for feUsers to a news record.
- Host: GitHub
- URL: https://github.com/cdaecke/md_unreadnews
- Owner: cdaecke
- License: other
- Created: 2019-03-27T16:08:48.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-07-15T09:31:21.000Z (6 months ago)
- Last Synced: 2024-09-16T23:13:27.758Z (4 months ago)
- Topics: news, php, typo3, typo3-cms-extension, typo3-extension, unread
- Language: PHP
- Size: 296 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: Readme.md
- Changelog: Changelog.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# TYPO3 Extension ``md_unreadnews``
This extension adds unread information to the records of ``ext:news`` for frontend users. In a list of news records, a frontend user can see, whether or not an article was read by himself. Additional it is possible to show how many unread articles are in a category.
The extension is shipped with typoscript libraries, which can be included at desired places.
## Requirements
- TYPO3 >= 11.5
- ext:news >= 9.0
## Screenshots
## Installation
- Install the extension by using the extension manager or use composer
- Include the static TypoScript of the extension
- Configure the extension by setting your own constants
Available constants:
- ``storagePid``: This is the uid of the page, where you want to store the unread records
- ``categories``: Comma separated string of category uids. All news records which are connected to a configured category will be marked as unread. If you don't provide a category, all news records will be considered.
- ``feGroup``: The uid of a feUserGroup. If provided, the unread info will only be set for users, who belong to this group. If not set, all users are considered.
## Usage
As soon as you have installed and activated the extension, it will hook into the saving process of new news records. Everytime a backend user adds a new record, the unread info for this record and the configured feUsers will be added.
### List plugin
The extension ships a plugin, which shows a list of all unread news for a user. In the ``Plugin Options`` you can set the link to the detail page. If you do not provide the detail page, the news record will be linked to the page of the first attached category.
### Show general unread counter
This counter will show the number of unread items for a user. To show this information use the following code in your fluid template:
### Show unread info in list view
Use the following code in the fluid template of the news extension to show, whether the current logged in feUser has read a news or not.
Example:
Copy ``ext:news/Ressources/Private/Partials/List/Item.html`` into your extension and modify the following:
{newsItem.title}
### Show unread info for categories
With the following code snippet you can show the number of unread news according to categories:
Example:
Copy ``ext:news/Ressources/Private/Templates/Category/List.html`` into your extension and modify the following:
{category.item.title}
### Remove unread info
Remove the unread info as soon, as the user has read the news article. Therefore add the following code on the news detail page:
Example:
Copy ``ext:news/Ressources/Private/Templates/News/Detail.html`` into your extension and add the following code at the end of the template:
### Cleanup task
This extension ships a scheduler task, which allows you to remove unread information,
which is older than a certain period of days. Activate this job, by following these steps:
- Switch to module `Scheduler`
- Add a new task and choose in the select field `Class` the option `Execute console commands`
- Fill all fields like you need them and use `mdUnreadnews:cleanup: Remove old unread information` in the field `Schedulable Command.`
- After saving the task, you will be able to fill the field
`Argument: days. Amount of days in the past till then all unread information shall be deleted. (integer)`.
Enter the days how long you want to keep the unread information. Default is 30 days.
## Bugs and Known Issues
If you find a bug, it would be nice if you add an issue on [Github](https://github.com/cdaecke/md_unreadnews/issues).
# THANKS
Thanks a lot to all who make this outstanding TYPO3 project possible!
## Credits
Extension icon was copied from [ext:news](https://github.com/georgringer/news) and then modified.