Skip to content
This repository was archived by the owner on Oct 20, 2023. It is now read-only.

How To Use

Janik Baumann edited this page Apr 18, 2016 · 1 revision

A fully qualified string looks like this:

{newslist <json string>} // This is used for triggering the plugin.

As json string something like this can be given.

{
    "template": "default", // This defines which template should be used.
    "categories": [ // An array with all categories where the plugin should select from.
        "category/sub-category",
        "next-category"
    ],
    "limit": "4", // An limit for an maximum amount of articles.
    "offset": "0", // An offset to Skip some articles (counter starts by the newest articles).
    "words": { // Words which will be replaced in the template (probably for supporting multiple languages).
        "more": "mehr"
    }
}

If the template isn't given or if it is invalid the default template will be taken. A template has always to be set, otherwise the plugin will stop.

The categories element has to be given and it has to be an array. It doesn't matter if there is only one category.

The default options are:

'template' => 'default',
'categories' => '',
'offset' => 0,
'limit' => 0

Clone this wiki locally