mediawiki/summary-cards

Display content summaries on hovered links with the help of templates and #ask queries.

dev-master / 1.x-dev 2017-10-16 08:46 UTC

README

Build Status Code Coverage Scrutinizer Code Quality Latest Stable Version Packagist download count Dependency Status

Summary Cards (a.k.a SUC) is a simple extension for displaying distinct content summaries on hovered links.

The content of a Summary Card is created by a template is assigned to the namespace of the hovered link and requested via Ajax.

The extension does not require Semantic MediaWiki but it is highly recommended to use them together in order for summaries to generate individual content (e.g. property that contains short description, image property, known keywords, modification date etc.) while building a summary.

Requirements

  • PHP 5.5 or later
  • MediaWiki 1.25 or later

Installation

The recommended way to install SummaryCards is by using Composer with an entry in MediaWiki's composer.json.

{
	"require": {
		"mediawiki/summary-cards": "~1.0"
	}
}
  1. From your MediaWiki installation directory, execute composer require mediawiki/summary-cards:~1.0
  2. Navigate to Special:Version on your wiki and verify that the package have been successfully installed.

Usage

image

Documentation

The following document contains a detailed description on available settings and how to create adaptable content summaries.

Contribution and support

If you want to contribute work to the project please subscribe to the developers mailing list and have a look at the contribution guideline.

Tests

This extension provides unit and integration tests that are run by a continues integration platform but can also be executed using composer phpunit from the extension base directory.

License

GNU General Public License, version 2 or later.