Extensions: Difference between revisions

From QualityBox Wiki
No edit summary
m (not plural)
 
(3 intermediate revisions by the same user not shown)
Line 38: Line 38:
This may be optional if you don't use Semantic MediaWiki. The only place where the imagesLoaded code seems to be used is by MasonryMainPage; and SemanticMediaWiki (in their jQuery.qtip.js (which implements [http://qtip2.com/ qTip2] - Pretty powerful tooltips - v2.2.1)).
This may be optional if you don't use Semantic MediaWiki. The only place where the imagesLoaded code seems to be used is by MasonryMainPage; and SemanticMediaWiki (in their jQuery.qtip.js (which implements [http://qtip2.com/ qTip2] - Pretty powerful tooltips - v2.2.1)).
; Use case
; Use case
: In it's simplest use case, this library will allow the developer to provide status indications of uploading images, and other things (e.g. do something once the page background is loaded.) Since this library can help provide really nice 'tooltip' features, and is used for that purpose in [[Semantic MediaWiki]] and [[SemanticResultsFormats]], it's a required <abbr title="User eXperience">UX</abbr> feature. See https://www.semantic-mediawiki.org/wiki/Help:Tooltip and http://qtip2.com/ for more on tooltips (which is just one example of what imagesLoaded can be useful for.)
: In it's simplest [https://imagesloaded.desandro.com/ use case], this library will allow the developer to provide status indications of uploading images, and other things (e.g. do something once the page background is loaded.) Since this library is used by [[Semantic MediaWiki]] and [[SemanticResultsFormats]], it's a required <abbr title="User eXperience">UX</abbr> feature (although I don't think it's a hard requirement for SMW tooltips). See https://www.semantic-mediawiki.org/wiki/Help:Tooltip and http://qtip2.com/ for more on tooltips (which is just one example of what imagesLoaded can be useful for.)
; Known issues
; Known issues
: [https://github.com/enterprisemediawiki/ImagesLoaded/issues/3 I had a problem] where I needed to upgrade the underlying version... maybe due to Chameleon skin since that's not core Meza?
: [https://github.com/enterprisemediawiki/ImagesLoaded/issues/3 I had a problem] where I needed to upgrade the underlying version... maybe due to Chameleon skin since that's not core Meza?
== CategoryTree ==
; Known Issues
: uses Constants. Constants are not supported by extension registration. https://phabricator.wikimedia.org/T141223
<categorytree mode="pages">Presentation</categorytree>


[[Category:Extensions]]
[[Category:Extensions]]

Latest revision as of 08:41, 31 October 2018

Extension management is a hot topic at WMF. Kunal is working on it, and there is an RFC at https://www.mediawiki.org/wiki/Requests_for_comment/Extension_management_feedback


Of the bundled extensions in the MediaWiki download, there are several new ones appearing in the REL1_31 version:

  • CodeEditor
  • MultimediaViewer
  • OATHAuth
  • ReplaceText

See too: https://www.mediawiki.org/wiki/Suggestions_for_extensions_to_be_integrated


With so many extensions in QualityBox, we really need to work on a systematic way of describing for each extension:

  1. What does it do?
  2. What extension does this compare with, or replace?
  3. How does it do it?
  4. What other extensions, or platform components are involved?
  5. User visible features
  6. Admin visible features
  7. Optional?
  8. Use case
  9. Known issues

Images Loaded

What does it do?
The Images Loaded extension, written by James Montalvo, is a very minimal extension that does just one thing: it loads and makes available the 'Images Loaded' javascript library by the same name.
What extension does this compare with, or replace?
If you wanted to use the javascript library without this extension, you'd have to copy/paste the code (as Administrator) into MediaWiki:Common.js
How does it do it?
By creating a single static function in the extension class, it adds a <script> tag in the source for every page.
What other extensions, or platform components are involved?
It uses the BeforePageDisplay hook, which is designed to allow last minute changes to the output page, e.g. adding of CSS or JavaScript by extensions.
User visible features
depends on code implementing library features
Admin visible features
depends on code implementing library features
Optional?

This may be optional if you don't use Semantic MediaWiki. The only place where the imagesLoaded code seems to be used is by MasonryMainPage; and SemanticMediaWiki (in their jQuery.qtip.js (which implements qTip2 - Pretty powerful tooltips - v2.2.1)).

Use case
In it's simplest use case, this library will allow the developer to provide status indications of uploading images, and other things (e.g. do something once the page background is loaded.) Since this library is used by Semantic MediaWiki and SemanticResultsFormats, it's a required UX feature (although I don't think it's a hard requirement for SMW tooltips). See https://www.semantic-mediawiki.org/wiki/Help:Tooltip and http://qtip2.com/ for more on tooltips (which is just one example of what imagesLoaded can be useful for.)
Known issues
I had a problem where I needed to upgrade the underlying version... maybe due to Chameleon skin since that's not core Meza?


CategoryTree

Known Issues
uses Constants. Constants are not supported by extension registration. https://phabricator.wikimedia.org/T141223