Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/semanticmediawiki/semanticimagecaption
Allows to generate image caption information from annotations
https://github.com/semanticmediawiki/semanticimagecaption
image-caption mediawiki mw semantic semantic-mediawiki semantic-mediawiki-extension sic smw
Last synced: 2 months ago
JSON representation
Allows to generate image caption information from annotations
- Host: GitHub
- URL: https://github.com/semanticmediawiki/semanticimagecaption
- Owner: SemanticMediaWiki
- License: other
- Created: 2020-05-02T14:14:52.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-12-21T12:12:54.000Z (about 1 year ago)
- Last Synced: 2024-06-11T20:23:35.320Z (6 months ago)
- Topics: image-caption, mediawiki, mw, semantic, semantic-mediawiki, semantic-mediawiki-extension, sic, smw
- Language: PHP
- Homepage: https://www.semantic-mediawiki.org/wiki/Extension:Semantic_Image_Caption
- Size: 56.6 KB
- Stars: 8
- Watchers: 10
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- License: COPYING
Awesome Lists containing this project
README
# Semantic Image Caption
[](https://travis-ci.org/SemanticMediaWiki/SemanticImageCaption)
[](https://scrutinizer-ci.com/g/SemanticMediaWiki/SemanticImageCaption/)
[](https://scrutinizer-ci.com/g/SemanticMediaWiki/SemanticImageCaption/)
[](https://packagist.org/packages/mediawiki/semantic-image-caption)
[](https://packagist.org/packages/mediawiki/semantic-image-caption)
Semantic Image Caption (a.k.a. SIC) is a [Semantic MediaWiki][smw] 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](https://getcomposer.org) with [MediaWiki's built-in support for Composer](https://www.mediawiki.org/wiki/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:
```json
{
"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
Create a [schema][schema] with the [`IMAGECAPTION_RULE_SCHEMA`](/docs/imagecaption.rule.md) 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 [email protected]. You can subscribe to this list [here](http://sourceforge.net/mailarchive/forum.php?forum_name=semediawiki-user).
If you want to contribute work to the project please subscribe to the developers mailing list and have a look at the [contribution guildline](/docs/CONTRIBUTING.md). A list of people who have made contributions in the past can be found [here][contributors].
* [File an issue](https://github.com/SemanticMediaWiki/SemanticImageCaption/issues)
* [Submit a pull request](https://github.com/SemanticMediaWiki/SemanticImageCaption/pulls)
* Ask a question on [the mailing list](https://semantic-mediawiki.org/wiki/Mailing_list)
## Tests
This extension provides unit and integration tests that are run by a [continues integration platform][travis] but can also be executed using `composer test` from the extension base directory.
## License
[GNU General Public License 2.0 or later][licence]
[composer]: https://getcomposer.org/
[licence]: https://www.gnu.org/copyleft/gpl.html
[mwcomposer]: https://www.mediawiki.org/wiki/Composer
[smw]: https://www.semantic-mediawiki.org/wiki/Semantic_MediaWiki
[travis]: https://travis-ci.org/SemanticMediaWiki/SemanticImageCaption
[mw-testing]: https://www.mediawiki.org/wiki/Manual:PHP_unit_testing
[mw-update]: https://www.mediawiki.org/wiki/Manual:Update.php
[mw-localsettings]: https://www.mediawiki.org/wiki/Localsettings
[contributors]: https://github.com/SemanticMediaWiki/SemanticImageCaption/graphs/contributors
[semver]: http://semver.org/
[schema]: https://www.semantic-mediawiki.org/wiki/Help:Schema