From MediaWiki.org
Jump to navigation Jump to search
This page is a translated version of the page Extension:CommonsMetadata and the translation is 33% complete.

Other languages:
Deutsch • ‎English • ‎català • ‎dansk • ‎español • ‎italiano • ‎polski • ‎português • ‎português do Brasil • ‎sicilianu • ‎suomi • ‎中文 • ‎日本語
OOjs UI icon advanced.svg
发布状态: 稳定版
实现 API
描述 尝试从共享资源页面中提取元数据
作者 Brian Wolff (bawolfftalk)
兼容性方针 发行分支
MediaWiki 1.25+
PHP 5.4+
许可协议 GNU General Public License 2.0 or later

  • $wgCommonsMetadataForceRecalculate
  • $wgCommonsMetadataSetTrackingCategories
问题 开放的工作 · 报告错误

共享资源元数据扩展是一个从维基共享资源中提取元数据的尝试,但也可以用于其它维基媒体项目。它基于图片描述中的模版和分类来添加一些额外信息到imageinfo API中。它被许多扩展和工具(例如媒体查看器可视化编辑器移动前端移动内容服务(MCS))用来提供更好的边框或图像选择对话框。





  • At some point in the future, wikidata will take over handling metadata at commons. In order to avoid disruptive changes, which will soon need to be changed again, the extension should work with commons metadata as it currently is (so not introducing new parser functions). Hence screen scraping.
  • The content of many of the fields on a commons description page include rich formatting (In particular: Links, italics, bold. In some cases more complex things like embedded images)
    • As a result, extension outputs parsed html (wikitext sucks, plain text doesn't capture the data)
    • Futhermore, the data tends to be formatted for human display, rather than (for example) machine formatted dates. When the date field says something like "circa 1600s", its hard to convert that to a precise date (otoh, many examples can be).
    • To carry that forward, also apply formatting to exif metadata, which is controlled on wiki (For example, commons links the camera name to a wikipedia article)
  • If we can't extract info from the description page, but the file has the author tagged in exif/XMP/iptc metadata, we should use that as a fallback.
  • Ideally such a system would be as commons-inspecific as possible, with the commons and non-commons part separated.
  • Commons description pages have multilingual descriptions. Lots of users probably just want one language.
    • In this implementation, it applies per language conventions to dates and things. Additionally for explicitly multi-lingual fields (description), there is an option to return all, or just a single language. Even in single language mode, some things are still language specific (like the thousands seperator on numbers)


  • 下载文件,并将其放置在您extensions/文件夹中的CommonsMetadata目录内。
  • 将下列代码放置在您的LocalSettings.php的底部:
    wfLoadExtension( 'CommonsMetadata' );
  • Yes 完成 – 在您的wiki上导航至Special:Version,以验证扩展已成功安装。

致使用MediaWiki 1.24或更早版本的用户:

上面的说明介绍的是安装此扩展的新方法,它使用wfLoadExtension() 如果您需要在早期版本(MediaWiki 1.24和更早版本)中安装此扩展,而不是wfLoadExtension( 'CommonsMetadata' );,您需要使用:

require_once "$IP/extensions/CommonsMetadata/CommonsMetadata.php";


警告 警告: If you're developing or testing this extension, we do NOT suggest you copy the Commons templates for image metadata, as they take extremely long to compile and have complicated dependencies like Scribunto. Instead, get an expanded version that has only wikitext/HTML and put in the various parameter references (or don't) manually. You can find an example (to be used with Special:Import) here. 或用Vagrant,里面默认含有一些模版。

When testing with remote images (e.g. Commons images if you have enabled $wgUseInstantCommons ), you can set $wgCommonsMetadataForceRecalculate = true; to force CommonsMetadata to parse the description page of the image and extract the metadata (normally, if the remote repository had CommonsMetadata installed as well, it would just copy the API output from there).


Use the imageinfo API, and include extmetadata as an image info property specified via iiprop.



View this example in the API sandbox:



The extension currently provides the following items in the extmetadata field of the response (the field names were chosen, where possible, to follow the IPTC-IIM format used in EXIF headers):

Data based on machine-readable data in the Information template:

  • ImageDescription - image description
  • Artist - author name (might contain complex HTML, multiple authors etc)
  • Credit - source
  • DateTimeOriginal - time of creation (space-separated ISO 8601 timestamp whenever possible, but can be any other textual description of a date, possibly with HTML mixed in)
  • ObjectName - title (for a book/painting; otherwise just the file name)
  • Permission - contents of the Permission field of the template. Can be a lot of things (license template, OTRS id, details on how to attribute...)
  • AuthorCount - the number of templates with authors (e.g. Book, Photograph...). The number of actual authors might be higher if a template describes multiple authors in a single string.

Data based on machine-readable data in the Location template:

  • GPSLatitude - latitude
  • GPSLongitude - longitude
  • GPSMapDatum - coordinate type (only WGS-84 supported for now)

Data based on machine-readable data in the license template:

  • LicenseShortName - short human-readable license name
  • LicenseUrl
  • UsageTerms
  • Copyrighted - True or False (for public domain images)

For multi-licensed images these values are currently unreliable.

  • Attribution - custom attribution that should replace Artist + Credit (can also originate from the Information template)
  • AttributionRequired - booleanish (phab:T86726), tells whether there is a legal requirement to attribute
  • NonFree - booleanish, true means the image is not under a free license. (Used for non-Commons images only.)

Other data:

  • CommonsMedadataExtension - contains the metadata parser version number; mostly for internal use
  • License - a best guess at the license of the image (mostly for internal use by MediaViewer, might change; LicenseShortName is probably more reliable)
  • Categories - a |-separated list of the categories of the image.
  • Assessments - a |-separated list of the assessments of the image (currently five values are supported: poty, potd, featured, quality, valued). Based on parsing category names, probably won't work for images not hosted on Commons.
  • Restrictions - reuse restrictions such as trademarks or personality rights; an array of keywords (the class names from this table, without the restriction- prefix). See also the restrict-* icons in MediaViewer.
  • DeletionReason - if set, the template is being considered for deletion. (Based on the nuke template, probably not reliable outside Commons.) It contains a deletion reason, but it is phrased to be applicable for a log entry, so it might be misleading (e.g. past tense when actually it is not yet decided whether the image will be deleted).