Help:Automating the work list on composer pages

From ChoralWiki
Revision as of 13:45, 26 March 2015 by Choralia (talk | contribs)
Jump to navigation Jump to search

Adding new works or editions to ChoralWiki has so far implied that two pages are created or edited: the work page; and the relevant composer page.

To simplify the add work process, especially for the benefit of new contributors, it is envisaged that composer pages are gradually modified in such a way that the work list on them is automatically updated whenever a new work or a new edition is added.

At the same time, direct links to files (pdf, midi, etc.) on the composer page are supposed to be gradually removed. This is to prevent misalignments of links between the work page and the composer page, and, especially, to ensure that copyright information and editor credits are shown before a user can download any files.

At the present time a simple function exists, which can be used to automate the work list on composer pages. The function is named SortWorks, and it should be invoked as follows:

{{#SortWorks:}} or {{#SortWorks:<subcategory>}}

When included in a composer page it automatically creates an alphabetical listing of the works by the composer in subject. The optional <subcategory> parameter restricts the listing only to the pages that belong to the selected subcategory. For example:

{{#SortWorks:Sacred music}}

will only list the sacred works by the composer, alphabetically sorted.

The SortWorks function is currently suitable for composer pages that are simple enough. It will be progressively improved and/or complemented with other functions, so that it will be possible to extend the work list automation to more complex composer pages, and eventually obtain that the work list is automated on all ChoralWiki's composer pages.

Whenever a new work or a new edition is added, contributors are kindly invited to consider the automation of the work listing on the composer page using the SortWorks function.

This page is part of the CPDL Help system.
View main help index