AwardAnnals:Annalentry
From AwardAnnals
The term “annalentry” is used like a template, but it is actually a magic word. It is used to display a standard listing of creative works. If used in the “Annal” namespace, it adds the annal’s award to the work’s list of honors.
Display a list of works
Here is a simple example of using an annalentry to display a list. If you add the following lines to any page on the site, it will produce the listing shown in the box below it.
{{annalentry:Ilium
| winner=Starship Troopers (book)
| Starship Troopers (film)
}}
Ilium: Book 1 of the Ilium series
From the towering heights of Olympos Mons on Mars, the mighty Zeus and his immortal family of gods, goddesses, and demigods look down upon a momentous battle, observing—and often influencing—the legendary exploits of Paris, Achilles, Hector, Odysseus, and the clashing armies of Greece and Troy.
Thomas Hockenberry, former twenty-first-century professor and Iliad scholar, watches as well. It is Hockenberry’s duty to observe and report on the Trojan War’s progress to the so-called deities who saw fit to return him from the dead. But the muse he serves has…
Starship Troopers is a classic novel by one of science fiction’s greatest writers of all time and is now a Tri-Star movie. In one of Heinlein’s most controversial bestsellers, a recruit of the future goes through the toughest boot camp in the universe—and into battle with the Terran Mobile Infantry against mankind’s most frightening enemy.
In the first and finest RoboCop movie, director Paul Verhoeven combined near-future science fiction with a keen sense of social satire—not to mention enough high-velocity violence to satisfy even the most voracious bloodlust. In Starship Troopers, Verhoeven and RoboCop cowriter Ed Neumeier take inspired cues from Robert Heinlein’s classic sci-fi novel to create a special-effects extravaganza that functions on multiple levels of entertainment. The film might be called “Melrose Place in Space,” with its youthful cast of handsome guys and…
Note that the code contains a list of page titles, but the displayed list contains the proper names of the creative work rather than the page title. The content of each listing is set with an “infobox” template. (See creative work page for details.) An annalentry may be added to any page where a listing is desired. Prefix the work with “winner=” to place a blue ribbon on the image.
Use in an 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
| 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 in a listing. About half way down, the argument “set recipients” changes the mode back to the default mode, which expects a list of pages containing a creative work infobox. The only difference from the display mode is that the 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.
For example, the following code will produce results identical to those above. Harry Potter is set to place “1”, and subsequent books to “3”. Then entire list is given a “2001 Hugo-Novel” honor because the last argument set the year for the entire annalentry.
{{annalentry:set terms
| year=1900
| award=Hugo-Novel
| 1=winner
| 2=
| 3=nominee
| 4=
| default=1
| set recipients
| Harry Potter and the Goblet of Fire: Book 4 of Harry Potter
| set terms
| default=3
| set recipients
| Midnight Robber
| The Sky Road
| Calculating God
| A Storm of Swords
| set terms
| year=2001
}}
The number of arguments is unlimited. The arguments should appear in this order:
- set terms should be the first argument. This tells the parser that the following arguments will describe the award and the terms applied.
- year is either the year of eligibility or the year of award, whichever the award organization uses.
- 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) - 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.
- 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”
- set recipients tells the parser that the following arguments will identify CWs.
- 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 for one award, 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.
