Thiemo Mättig (WMDE) has uploaded a new change for review. ( https://gerrit.wikimedia.org/r/347833 )
Change subject: Small updates to README.md file ...................................................................... Small updates to README.md file I found some additional bits of information might help doing a full security review of the extension. I'm intentionally uploading this as a separate patch instead of having lots of comments on the original patch I977164e. But feel free to discuss this patch. Now that we have a baseline merged I believe it is fine to discuss details. Bug: T159710 Change-Id: I6215609af73dfceca4ea817a168baac794a77be3 --- M README.md 1 file changed, 6 insertions(+), 6 deletions(-) git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/WikibaseMediaInfo refs/changes/33/347833/1 diff --git a/README.md b/README.md index e8d75fe..ef201e6 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,26 @@ WikibaseMediaInfo is an extension to [Wikibase](http://www.wikiba.se/) adding the new MediaInfo entity type for handling structured data for multimedia files. -The extension hooks into file description pages and adds a link to MediaInfo page related to the file. +The extension hooks into a file description page and adds a link to a MediaInfo page storing supplemental meta data about the file. This may, for example, include the author, detailed license information, and concepts a picture actually depicts. ## Installation Enable the extension by adding `wfLoadExtension( 'WikibaseMediaInfo' );` to `LocalSettings.php`. -You might need to run `composer install` in the extension directory, or in the root directory of your MediaWiki installation if in your setup extension dependencies are merged into MediaWiki's vendor directory. +You might need to run `composer install` in the extension directory, or in the root directory of your MediaWiki installation if you are using a setup that merges all extension's dependencies into MediaWiki's vendor directory. ## Settings -By default MediaInfo pages will be created in the namespace `145`. In order to use custom namespace number, set `$wgMediaInfoNamespace` to the desired namespace ID in `LocalSettings.php`. +By default MediaInfo pages will be created in the namespace `145`. In order to use a custom namespace number, set `$wgMediaInfoNamespace` in `LocalSettings.php` to the desired namespace ID. ## Virtual MediaInfo entities -Note that, unlike Items and Properties in Wikibase, MediaInfo entities are not stored in the database until some data of the entity is set (e.g. its label or description). Nevertheless links to the MediaInfo page are displayed on file pages, and MediaInfo page is displayed correctly (showing no data but the related file name). Such MediaInfo entities which are not yet stored in the database are called "virtual" MediaInfo entities. +Note that, unlike Items and Properties in Wikibase, MediaInfo entities are not stored in the database until some data of the entity is set (e.g. its label or description). Nevertheless a link to the MediaInfo page is always displayed on file page, and the MediaInfo page is displayed correctly, showing no data but the related file name. Such MediaInfo entities which are not yet stored in the database are called "virtual" MediaInfo entities. ## Tests -PHPUnit tests are located in `tests/phpunit`. You can run tests (`tests/phpunit/composer`) not requiring MediaWiki framework by running `composer test`. This command also runs code style checks (using PHPCS). +PHPUnit tests are located in `tests/phpunit`. You can run tests not requiring the MediaWiki framework (located in `tests/phpunit/composer`) by running `composer test`. This command also runs code style checks using PHPCS. -Tests relying on MediaWiki framework must by run using MediaWiki core's `phpunit.php` endpoint. +Tests relying on the MediaWiki framework (located in `tests/phpunit/mediawiki`) must by run using MediaWiki core's `phpunit.php` endpoint. ## See also -- To view, visit https://gerrit.wikimedia.org/r/347833 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: newchange Gerrit-Change-Id: I6215609af73dfceca4ea817a168baac794a77be3 Gerrit-PatchSet: 1 Gerrit-Project: mediawiki/extensions/WikibaseMediaInfo Gerrit-Branch: master Gerrit-Owner: Thiemo Mättig (WMDE) <[email protected]> _______________________________________________ MediaWiki-commits mailing list [email protected] https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
