README

THIS IS A FORK FROM ARLIMA (https://github.com/victorjonsson/Arlima)

WORK IN PROGRESS

The plugin license is converted to MIT.

The plugin in is intended to be backwards compatible with Arlima but with the following requirements:

PHP version 7 and above.
WordPress version 4.9 and above.

This is an open source project meaning that the time spent on this project will vary and contributions are welcome.

Some rewrites will be done as first version 3.2 planned as first stable release.

PHPUnit

Attention! composer update before any unit testing!

We run docker containers to unit tests in real WordPress (no mock). https://github.com/frozzare/docker-wptest https://github.com/wpup/test-suite Special thanks to Frozzare!

To initialize tests with docker, run: docker run --name mysql -e MYSQL_ALLOW_EMPTY_PASSWORD=true -d mysql:latest

To run tests, in the plugin folder, eg: docker run -e WP_VERSION=4.9 --rm -v $(pwd):/opt --link mysql frozzare/wptest:7.0 vendor/bin/phpunit

PHPUnit testing with docker: https://youtu.be/9CEoapNrrSc

Arlima inherited readme text:

This Wordpress plugin was created by Swedish newspaper Västerbottens-Kuriren to give its editorial staff an easy to use tool for customizing the front pages of their online magazines. It's used on a daily basis at http://www.folkbladet.nu and http://www.vk.se, websites that together has over 200 000 unique visitors per week.

Getting started

Download the latest release from github and unzip the folder in your plugin directory
Go to "Article lists" -> "Edit lists" in wp-admin and create your first article list.
Open up a page (or create it) in wp-admin. Down to the right you will see a meta box labeled "Arlima" where you choose the list that you created on step 2.
Go to "Article lists" -> "Manage lists" and start stuffing your article list with interesting content.

Tip! Install the plugin "Scissors Continued" to get even more functionality out of Arlima

Authors

@chredd @znoid @victor_jonsson @lefalque

Wiki

User manual

Publishing article lists
Interface walkthrough (updated for version 3.0)
Keyboard shortcuts in the list manager (updated for version 3.0)
Importing article lists from remote websites
Importing RSS-feeds

Developer manual

Custom CSS
Creating a custom page template
Filters and actions (updated for version 3.0)
Programmatically insert article lists in your template
Creating custom article templates (updated for version 3.0)
Customized streamers
Article formats
Cache management
How to modify the post search
Include PHP files in articles
Article list sections
Using Arlima in the ordinary category loop
Modifing the list manager with javascript (updated for version 3.0)

elseifab / wp-newslist

Maintainers

Details