AwardAnnals:Annalentry

From AwardAnnals

The magic word {{annalentry:}} (AE) is used to document an award event on a page in the Annal namespace. Its function and format is identical to the {{displayworks:}} function with some added commands for describing an award annal. If used in the “Annal” namespace, it adds the annal’s award to the work’s list of honors.

An AE uses the {{displayworks:}} function to display its results. Refer to that function’s page for details concerning the display of the honored works.

Usage in an Award Annal

When used in the “Annal” namespace, the arguments provided in annalentry are used to update the database table “aa_annalentry” and to update the list of honors that immediately follows the creator’s name in a listing. This example is taken from Annal:2001 Hugo Award for Novel.

{{annalentry:set terms
| year=2001
| prevannal = 2000
| nextannal = 2002
| annalcategory = Hugo Award for Novel
| awardpage =  [[Hugo Award]]
| award=Hugo-Novel
| 1=winner
| 2=
| 3=nominee
| 4=
| default=3
| set recipients
| winner = Harry Potter and the Goblet of Fire: Book 4 of Harry Potter
| Midnight Robber
| The Sky Road
| Calculating God
| A Storm of Swords
}}

The annalentry has two distinct modes. The first argument sets the mode to “set terms” and is followed by arguments that define the award event and how it should be represented on the site. About half way down, the argument “set recipients” changes the mode back to the default mode, which expects a list of creative work page titles. Each page title may be assigned a “place” such as winner or nominee. The place names vary between awards, and so must be defined so that the listing will reflect the terminology used by the award organization.

Important Note: the “set terms” arguments affect the entire list, so adding “| set terms | year=2000” at the end of the annalentry will change the year for all of the works. The only exception is the “default” argument. The number assigned to “default” is immediately assigned to a work without an explicit place, so changing “default” midway through the list will only affect the works that follow.

There is no set limit to the number of arguments, or to their order. For the sake of convention, arguments should appear in this order:

1. set terms should be the first argument. This tells the parser that the following arguments will describe the award and the terms applied.
2. year is either the year of eligibility or the year of award, whichever the award organization uses.
3. prevannal identifies the previous year’s annal to produce a link in the annal navigator. The digits previous year is enough to produce a link to the previous annal if the name is otherwise identical, but in some cases a full link is required (e.g., the award organization changes the name of the award).
4. nextannal identifies the next year’s annal. Leave blank if there is none.
5. annalcategory is the name of the wiki category for this specific award. It is usually the full name of the award (e.g. “Hugo Award for Novel”), but may be something different. Whitbread award changed their name to the Costa in 2006, so Annal:2005 Whitbread Book Award for Novel belongs to Category:Costa Book Award for Novel.
6. awardpage is the page title of the award organization’s page (e.g., Hugo Award). This creates a link in the annal navigator, and includes the annal in a category named for the award organization (e.g., Category:Hugo Award annals).
7. award is the term used to identify this award in the honors list you see on each CW listing. It should be a very short and descriptive. For instance:
   “Hugo–novel” (Hugo Award for Novel)
   “NBA–nonfiction” (National Book Award for Nonfiction)
   “NBA–nonfiction” (National Book Award for Nonfiction)
   “Oscar–Picture” (Academy Award® for Best Motion Picture)
8. 1 is the term used to describe the CW that wins. It is usually “winner”, but may be “1st” or “Palme d’Or”, or whatever the award organization calls the winner. Also list the other places. The finalists are always “3” so that scoring is equal with awards that sometimes issue special recognition for the runner-up.
9. default is the place of a CW that does not explicitly specify a place. In the example format above, notice that Harry Potter is specified as the winner, and the place of the others is not specified. They default to “3”, which is “nominee”
10. set recipients tells the parser that the following arguments will identify CWs.
11. creative works are listed here ordered by place (winner first) and then by title. Use the “place” term specified in the arguments above to identify the proper score for each work.

The honors generated from the terms provided in the annalentry are like this: “{$year} {$award} {$place}”. Manipulation of this process is sometimes necessary. The Dagger Award required the place come before the award: the winner is “2000 Gold Dagger”, and second place is “2000 Silver Dagger”. This was accomplished by leaving award blank:

{{annalentry:set terms
| year=2000
| award=
| 1=Gold Dagger
| 2=Silver Dagger
| 3=Dagger shortlist
…

It is sometimes necessary to assign zero honor points to a work due to the quirks of an award organization. For instance, in the early 1980s the National Book Award sometimes nominated a book for a hardcover award, and the next year nominated the same book for a paperback award. It would skew the ranking to allow the book two scores from one award organization, so one of the nominations can be assigned zero score. This is done by simply defining the place “0=nominee*” (note the asterisk) and using it instead of the normal “nominee”. Many zero-score places may be defined using numbers 11 through 20, though one should suffice.