AwardAnnals:Honor roll
From AwardAnnals
An “honor roll” is an ranked list of either works or the creators of those works. The ranking of a creative work (CW) is determined by a score which represents the number and quality of the honors it has received in the annals. The ranking of creators is determined by the sum of the scores his or her works in a given category has received. For instance, a creator may have different rankings in the categories of Fiction and Fantasy because all his or her works are Fiction, but only some of them are Fantasy.
Generating Honor Rolls
Honor rolls are automatically generated using the {{honorroll:}} magic word. For clarity, let's refer to the magic word as the function, output of this function as the honor roll.
The function selects works from the Creative Work Database, which contains cover art, titles, creators, a list of honors, and a synopsis. This information is culled from the {{definework:}} on a CW page, and changes whenever such a page is saved. The list of honors changes whenever the CW is included on an annal page. The function orders the list of CWs by the score derived from the honors list.
The following is the wiki text from a typical honor roll page—Honor roll:Fiction books. The last line contains the function.
Each of these Fiction books has received at least one award nomination. They are [[AwardAnnals:Ranking|ranked]] by honors received.
See also:
*[[Honor roll:Recent Fiction books]] honored within the last 3 years.
*[[Honor roll:Fiction authors]].
*[[:Category:Fiction book awards]].
{{honorroll:cwcategory|Fiction books}}
The first argument determines the source of the list: cwcategory or annals or works by. A “works by” honor roll is the same as a “cwcategory” where the category is computed from the page name. For instance, on the page “Robert A. Heinlein”, a “works by” honor roll will display works from the wiki category “Category:Works by Robert A. Heinlein”.
The second argument (separated by a pipe) specifies a wiki category (a page title in the “Category” namespace). The prefix “Category:” is assumed, and should not be included in the category name (e.g., “Fiction books”, not “Category:Fiction books”). The previous example prepares a list of all the pages that belong to.
Categorical honor roll
A cwcategory is the most common type of honor roll. The second parameter must specify a wiki category containing CW pages. The function ignores non-CW pages in the specified category, so specifying a category with no CW pages produces “no matches”.
Categorical honor rolls are automatically included in one of these wiki categories:
- Creators' honor rolls: specify a category beginning with the words “Works_by_”. They generate honor rolls specific to a certain creator.
- Categorical honor rolls:creators: in the “Honor_roll:” namespace and specify the “creator” parameter to produce a list of creators.
- Categorical honor rolls: in the “Honor_roll:” namespace. Assumed to be a “genre” category.
- Honor rolls: any that do not fall into a category above.
Award honor roll
An annals honor roll produces a list of CWs that have received a particular honor. The second parameter must specify a wiki category that contains annal pages (e.g., Hugo Award for Novel). The function ignores non-annals in the specified category.
Award honor rolls are automatically included in one of these wiki categories:
- Award honor rolls:creators: in the “Honor_roll:” namespace and specify the “creator” parameter to produce a list of creators.
- Award honor rolls: in the “Honor_roll:” namespace.
- Honor rolls: any that do not fall into a category above.
Function parameters
- Query Type: “cwcategory” or “annals”.
- Wiki Category: Specify a page in the “Category” namespace. The prefix “Category:” is assumed, and should not be included in the category name (e.g., “Fiction books”, not “Category:Fiction books”).
- Creator List: “creators” or omitted. Inclusion will cause the function to output a ranked list of people that have created CWs in the specified category. The rank for each person is calculated only from works in the specified category.
- Year Range: “year ####” or omitted. Includes only CWs honored in the specified year(s). Note that the year is specified by the award organization and may be either the year published or year awarded. Rank is calculated from all honors, even those outside the specified range. Examples:
- “year 2000” — received an honor in 2000
- “year 2001-2004” (inclusive)
- “year now” or “year current” (current year)
- “year last #” or “year past #” (most recent # years including current year)
- “year recent” (most recent 3 years including the current year)
