Open main menu

Extension:MarkImages

MediaWiki extensions manual
OOjs UI icon advanced.svg
MarkImages
Release status: beta
Implementation Hook
Description Marks images on special and category pages based on their categories
Author(s) Ostrzycieltalk
Latest version continuous updates
Compatibility policy master
MediaWiki 1.29+
PHP 5.6+
Database changes No
License MIT License
Download
Example Image category on Nonsensopedia with images marked according to their license
Hooks used
LinksUpdateComplete
InfoAction
BeforePageDisplay
Translate the MarkImages extension if it is available at translatewiki.net
Check usage and version matrix.

The MarkImages extension marks images in galleries on special and category pages based on image's categories.

The user can specify rules for which categories should correspond to what CSS classes. The extension then adds these CSS classes to divs of corresponding images in galleries. It is intended for marking images based on their licenses, but can be used for other purposes, too.

InstallationEdit

  • Download and place the file(s) in a directory called MarkImages in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
    wfLoadExtension( 'MarkImages' );
    
  •   Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

ConfigurationEdit

All configuration is done through a single MediaWiki message: MediaWiki:MarkImages-categories. It should contain a list of category-CSS class pairs in following format:

* Category:Example category 1|example-class-1
* Category:Example category 2|example-class-2|recursive

The category name should always include the "Category:" prefix in your wiki's local language (canonical). The recursive option tells the extension to apply this rule recursively to all child categories. You can specify as many rules as you like, you can also use the same CSS class multiple times and apply multiple classes to a single image.

You have to define these CSS classes yourself. You can place them for example in MediaWiki:Common.css to make it apply to all desktop skins, or in a gadget to allow your users to enable or disable this feature. The extension appends these classes to the div element with thumb CSS class. A simple example from Nonsensopedia of a CSS class you can use for modifying image's background:

.file-free {
	background-color: #B0FAB0 !important;
}

After setting up the extension you should run the initImageClasses.php script provided in the maintenance folder to initialize CSS class cache and see the results. The extension will automatically update the cache whenever an image's description page is changed or null-edited. It will not update the cache when you modify the configuration or change the category tree in some way. In such a case you will have to have to rerun this maintenance script or null-edit all affected pages. This should be fixed in the future elegantly, but for now one solution is to set up a cron job that runs the maintenance script at night.

How it worksEdit

After a user saves a description page, the extension grabs the image's categories and checks them against all rules specified in MediaWiki:MarkImages-categories. It builds an array of CSS classes that should be applied to this image and saves these classes in the page_props table. When a gallery is rendered on a category or special page, the extension inserts these extra CSS classes cached in the database. The extension relies entirely on the cache, so it should be reasonably fast.