Difference between revisions of "Technical Details"

From Australian Traditional Music Tunes
Jump to: navigation, search
(Tweak wording & link abcExport)
(Update ABCjs version to 4.0.0)
 
(2 intermediate revisions by the same user not shown)
Line 5: Line 5:
 
* [{{SERVER}}{{SCRIPTPATH}}/extensions/abcExport/ abcExport] - custom extension providing support for exporting abc tune content from one or more pages as either an abc notation file, or pdf rendered score  (see below)
 
* [{{SERVER}}{{SCRIPTPATH}}/extensions/abcExport/ abcExport] - custom extension providing support for exporting abc tune content from one or more pages as either an abc notation file, or pdf rendered score  (see below)
 
* [https://www.mediawiki.org/wiki/Extension:Html5mediator Html5mediator] - support embedded HTML5 audio (and video) players, modified locally to use a local javascript file and to work with latest mediawiki
 
* [https://www.mediawiki.org/wiki/Extension:Html5mediator Html5mediator] - support embedded HTML5 audio (and video) players, modified locally to use a local javascript file and to work with latest mediawiki
 +
* [https://www.mediawiki.org/wiki/Extension:MultiBoilerplate MultiBoilerplate] - to support inclusion of template content into the editor when creating new pages
 
* [https://www.mediawiki.org/wiki/Extension:Multi-Category_Search MultiCategorySearch] - to support searching for tunes over multiple categories, modified locally specifically to support tune searching
 
* [https://www.mediawiki.org/wiki/Extension:Multi-Category_Search MultiCategorySearch] - to support searching for tunes over multiple categories, modified locally specifically to support tune searching
* [https://www.mediawiki.org/wiki/Extension:NewArticleTemplate NewArticleTemplate] - to support inclusion of template content into the editor when creating new pages
 
 
* [https://www.mediawiki.org/wiki/Extension:Newest_Pages Newest_Pages] - to display the latest pages (mostly tunes) added to the site
 
* [https://www.mediawiki.org/wiki/Extension:Newest_Pages Newest_Pages] - to display the latest pages (mostly tunes) added to the site
 
* [https://www.mediawiki.org/wiki/Extension:Replace_Text Replace_Text] - to let admins do bulk page edits when we change our mind on format :-)
 
* [https://www.mediawiki.org/wiki/Extension:Replace_Text Replace_Text] - to let admins do bulk page edits when we change our mind on format :-)
Line 16: Line 16:
  
 
Integration of this [http://abcjs.net abcjs] package required a custom extension [{{SERVER}}{{SCRIPTPATH}}/extensions/ABCjs/ ABCjs] that was written specifically to support this site.
 
Integration of this [http://abcjs.net abcjs] package required a custom extension [{{SERVER}}{{SCRIPTPATH}}/extensions/ABCjs/ ABCjs] that was written specifically to support this site.
This extension adds a [https://www.mediawiki.org/wiki/Manual:Hooks/BeforePageDisplay BeforePageDisplay()] hook to include and configure the ''abcjs_plugin'' javascript package (currently using v2.3),
+
This extension adds a hook to include and configure the ''abcjs_plugin'' javascript package (currently using v4.0.0),
that renders abc music notation as a score, on all pages that match the required content criteria (see extension comments for details).
+
that renders abc music notation as a score, on all pages that match the required content criteria (see extension documentation for details).
Management of the Tune classification tags is assisted by adding [https://www.mediawiki.org/wiki/Manual:Hooks/EditPage::attemptSave EditPage::attemptSave] hook that scans the abc notation of a tune page being saved, and automatically adds/updates the required Key, Meter and Rhythm Category tags at the end of the page.
+
Management of the Tune classification tags is assisted by adding a hook to the page editor that scans the abc notation of a tune page being saved, and automatically adds/updates the required Key, Meter and Rhythm Category tags at the end of the page.
  
A second extension [{{SERVER}}{{SCRIPTPATH}}/extensions/abcExport/ abcExport] was also written to provide support for for exporting abc tune content from one or more pages, as either an abc notation file, or pdf rendered score. It adds a special page [[Special:AbcExport]] that allows for multiple page titles to be entered, or accessed if previously tagged, along with several new toolbox links to export from current page, tag page, or access this special page.
+
A second extension [{{SERVER}}{{SCRIPTPATH}}/extensions/abcExport/ abcExport] was also written to provide support for for exporting abc tune content from one or more pages, as either an abc notation file, or pdf rendered score. It adds a special page [[Special:AbcExport]] that allows for multiple page titles to be entered, or accessed if previously tagged, along with hooks to include several new toolbox navigation links to export from current page, tag page, or access this special page.
  
 
[[Category:Support]]
 
[[Category:Support]]

Latest revision as of 05:39, 23 March 2018

This site is constructed using:

  • Mediawiki - for the core wiki infrastructure that allows collaborative editing and viewing of the content (currently version 1.30.0)

with the following extensions added:

  • ABCjs - custom extension providing support for setting categories and rendering abc music notation on wiki pages (see below)
  • abcExport - custom extension providing support for exporting abc tune content from one or more pages as either an abc notation file, or pdf rendered score (see below)
  • Html5mediator - support embedded HTML5 audio (and video) players, modified locally to use a local javascript file and to work with latest mediawiki
  • MultiBoilerplate - to support inclusion of template content into the editor when creating new pages
  • MultiCategorySearch - to support searching for tunes over multiple categories, modified locally specifically to support tune searching
  • Newest_Pages - to display the latest pages (mostly tunes) added to the site
  • Replace_Text - to let admins do bulk page edits when we change our mind on format :-)

Copyright on these various packages is as shown on their respective sites.

ABCjs & abcExport Extensions

This site very much relies on the ABC Javascript (abcjs) open source javascript engine for rendering abc formatted tunes as sheet music entirely in the browser.

Integration of this abcjs package required a custom extension ABCjs that was written specifically to support this site. This extension adds a hook to include and configure the abcjs_plugin javascript package (currently using v4.0.0), that renders abc music notation as a score, on all pages that match the required content criteria (see extension documentation for details). Management of the Tune classification tags is assisted by adding a hook to the page editor that scans the abc notation of a tune page being saved, and automatically adds/updates the required Key, Meter and Rhythm Category tags at the end of the page.

A second extension abcExport was also written to provide support for for exporting abc tune content from one or more pages, as either an abc notation file, or pdf rendered score. It adds a special page Special:AbcExport that allows for multiple page titles to be entered, or accessed if previously tagged, along with hooks to include several new toolbox navigation links to export from current page, tag page, or access this special page.