README.md

Shaarli Descriptor Plugin

Shaarli plugin to customize the default height/number of rows of the Description field when editing a link.

Tested on Shaarli 0.11.1 with the Shaarli-Material theme in desktop and Android Chrome browsers, but it should work with all built-in themes as well. Should be compatible with Shaarli 0.12.0-beta as well which introduced a major internal rewrite (#1511).

Features

• Set up the number of rows that define the hight of the Description textarea
• Plugin Administration page integration for easy configuration

Screenshots

Plugin Administration page

After plugin enabled with default DESCRIPTION_ROWS settings:

Edit Link page

After plugin enabled and DESCRIPTION_ROWS set to 10:

Installation

The plugin's folder (shaarli_descriptor) should be placed in the <shaarli>/plugins/ directory.

The directory structure should look like:

└── plugins
    └── shaarli_descriptor
        ├── shaarli_descriptor.html
        ├── shaarli_descriptor.meta
        └── shaarli_descriptor.php

To enable the plugin, just check it in the Plugin Administration page (?do=pluginadmin).

You can also add shaarli_descriptor to your list of enabled plugins in data/config.json.php.
The general.enabled_plugins list should look like then:

"general": {
  "enabled_plugins": [
    "shaarli_descriptor",
    [...]
  ],
}

Configuration

Go to the Plugin Administration page, and edit the following settings (with the plugin enabled).

• DESCRIPTION_ROWS:
  Hight of the Description textarea. Default: 4
  Example value: 8
  Supported values: integer numbers greater than or equal to 1. If not specified or malformed, defaults to 4.

Note: this setting can also be set in data/config.json.php, in the plugins section:

"general": {
    "plugins": {
        "DESCRIPTION_ROWS": "10",
        [...]
    },
}

Known issues

None

Recommendation

Shaarli Descriptor works best with my Shaarli Markdown Toolbar plugin, check it out, too! 😉

Contact

Immánuel Fodor
fodor.it | Linkedin