mediawiki/semantic-image-caption

This package is not installable via Composer 1.x, please make sure you upgrade to Composer 2+. Read more about our Composer 1.x deprecation policy.

Complementary extension to Semantic MediaWiki to support the generation of image captions from annotations.

dev-master / 1.0.x-dev 2021-08-12 11:07 UTC

This package is auto-updated.

Last update: 2021-09-12 11:24:33 UTC


README

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

Semantic Image Caption (a.k.a. SIC) is a Semantic MediaWiki extension to support the generation of image captions from annotations.

Requirements

  • PHP 7.1 or later
  • MediaWiki 1.32 to 1.34
  • Semantic MediaWiki 3.2 or later

Installation

The recommended way to install Semantic Image Caption is using Composer with MediaWiki's built-in support for Composer.

Note that Semantic MediaWiki must be installed first according to the installation instructions provided.

Step 1

Change to the base directory of your MediaWiki installation. If you do not have a "composer.local.json" file yet, create one and add the following content to it:

{
	"require": {
		"mediawiki/semantic-image-caption": "~1.0"
	}
}

If you already have a "composer.local.json" file add the following line to the end of the "require" section in your file:

"mediawiki/semantic-image-caption": "~1.0"

Remember to add a comma to the end of the preceding line in this section.

Step 2

Run the following command in your shell:

php composer.phar update --no-dev

Note if you have Git installed on your system add the --prefer-source flag to the above command.

Step 3

Add the following line to the end of your "LocalSettings.php" file:

wfLoadExtension( 'SemanticImageCaption' );

Usage

81570680-740ffd00-9390-11ea-9db5-06f7d23b0b69.png

Create a schema with the IMAGECAPTION_RULE_SCHEMA type to identify the default_rule and possible other rules to match a specific requirement for the generation of caption information.

Add caption annotations to images with a Text or Monolingual text type property (which is assigned to the caption_property in the schema).

Depending on the rules defined, properties used, and captions provided, embedded images will show captions generated from image page annotations.

Contribution and support

If you have remarks, questions, or suggestions, please send them to semediawiki-users@lists.sourceforge.net. You can subscribe to this list here.

If you want to contribute work to the project please subscribe to the developers mailing list and have a look at the contribution guildline. A list of people who have made contributions in the past can be found here.

Tests

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

License

GNU General Public License 2.0 or later