Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/the-turk/flarum-diff
View post edit histories in your Flarum forum.
https://github.com/the-turk/flarum-diff
flarum flarum-extension
Last synced: about 2 months ago
JSON representation
View post edit histories in your Flarum forum.
- Host: GitHub
- URL: https://github.com/the-turk/flarum-diff
- Owner: the-turk
- License: mit
- Created: 2020-02-10T20:42:03.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-02-12T21:37:24.000Z (over 1 year ago)
- Last Synced: 2024-07-26T14:42:33.688Z (2 months ago)
- Topics: flarum, flarum-extension
- Language: PHP
- Homepage: https://discuss.flarum.org/d/22779-diff-for-flarum
- Size: 727 KB
- Stars: 8
- Watchers: 3
- Forks: 6
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-flarum - 2020 - View post edit histories. (Extensions / Discussion ([:top:](#table-of-contents)))
README
# Diff for Flarum
[](https://github.com/the-turk/flarum-diff/blob/master/LICENSE) [](https://packagist.org/packages/the-turk/flarum-diff) [](https://packagist.org/packages/the-turk/flarum-diff)
This extension adds a "post revision history" feature to your [Flarum](https://github.com/flarum) forum.
Screenshots:
- [Post-Stream Item](https://i.ibb.co/4m21pnM/post-Stream-Item.png)
- [Dropdown List](https://i.ibb.co/PTTcWCw/dropdown-List.png)
## Features
- Based on [jfcherng/php-diff](https://github.com/jfcherng/php-diff) repository (this one is forked from [chrisboulton/php-diff](https://github.com/chrisboulton/php-diff) since it's no longer maintained).
- Option for **line** (default), **word** and **char** level diffs.
- Three render modes including "Inline", "Side By Side" & "Combined".
- Archive old revisions using cron jobs or manually.
- Delete revisions or rollback to certain revision.
- Supports `fof/nightmode`, `the-turk/flarum-quiet-edits`.
- Supports all browsers which are supporting [css-grid](https://caniuse.com/#feat=css-grid).
Also, it won't load (and cache) anything until you click the "Edited" button so no need to worry about loading times.
## Requirements
 
You can check your php version by running `php -v` and check if `iconv` is installed by running `php --ri iconv` (which should display `iconv support => enabled`).
## Installation
```bash
composer require the-turk/flarum-diff
```
## Updating
```bash
composer update the-turk/flarum-diff
php flarum migrate
php flarum cache:clear
```
## Usage
Enable the extension and set the permissions. You're ready to go!
### Archive Old Revisions
If **x ≥ A** (where the **x** is post's revision count), first **y=mx+b** revisions for the post can be stored as merged & compressed `BLOB` in a new table (which is called `post_edit_histories_archive`). Specify the **A**, **m** and **b** from the settings modal. Float values of **y** will be rounded to the next lowest integer value. It's recommended to archive old revisions if you want to save storage volume but **_not recommended if you don't want to_**.
If you want to archive old revisions, please consider enabling _cron job option_ from the settings modal. I set a weekly cron job which is working on sundays at 02:00 AM (nothing special) using `diff:archive` command**. Otherwise, it'll try to find & archive old revisions for the post as soon as `Post\Revised` event fires or wait for your `php flarum diff:archive` command. See [this discussion](https://discuss.flarum.org/d/24118-setup-the-flarum-scheduler-using-cron) for setting up the scheduler.
## Links
- [Flarum Discuss post](https://discuss.flarum.org/d/22779-diff-for-flarum)
- [Source code on GitHub](https://github.com/the-turk/flarum-diff)
- [Changelog](https://github.com/the-turk/blob/master/CHANGELOG.md)
- [Report an issue](https://github.com/the-turk/flarum-diff/issues)
- [Download via Packagist](https://packagist.org/packages/the-turk/flarum-diff)