AwardAnnals:Annal page
From AwardAnnals
Overview
An annal documents the result of an award event, which is the means for providing the honors list that appears in every annalentry (AE) listing and on the creative work (CW) page. An annal is the heart of the Award Annals, consequently it has its own namespace. Editing an annal is restricted to Award Annals administrators because the AE on a page in the Annal namespace is inserted into the AE database, causing a ripple of page updates.
- The honors list and score for all the CWs named in the AE are update.
- The cache for pages with an AE linking to the named CWs is invalidated.
- The cache for all honor rolls is invalidated.
Invalidating the cache for all honor rolls, as opposed to just those that list an affected CW, may seem extreme. The reason is that the affected CWs may need to be added to honor rolls that they were not previously on.
If adding a new AE, do not forget to edit the annal navigator for the previous year so that the navigator provides continuous linking.
Naming Convention
Use the award organization page name with these modifications:
- Prepend the year of award.
- Append the award category.
The proper name for an award is comprised of the award organization plus award category and should be capitalized.
If you are an Award Annals administrator, the page may be prepended with “Annal:” so that the database insertions take place. If you do not have these privileges, create the page anyway. Especially in the case of adding a new award to the site, administrators may not want to induct the pages until the CWs, AEs, and award organization pages have been reviewed. Once deemed acceptable, it is merely a matter of moving the page to the “Annal” namespace. It should be noted that being an official Annal is not necessary. It is acceptable to create all of the pages for ”Goober’s Homemade Award”, which will look just like an official Annal. The only difference will be that winning a Goober will not garner any honor points, and it will not be listed in the honors list. If a number of unofficial awards is added to the site, I will provide some facility for seeing a complete list of honors for each CW so that the unofficial awards will be linked to from CW listings.
Format
Annal pages are linked together with an Annal Navigator, so that clicking to the next or previous year is easily available. For this reason, the format of each annal should be very similar so that flipping through the years is not jarring to the patron. The format shown below is strongly recommended, but each award must be given individual consideration. A different format is not unacceptable so long as it is applied to each of the award’s annals.
This example is taken from Annal:2001 Hugo Award for Novel.
Results of the [[Hugo Award]] in the year [[:Category:2001]]. For a [[AwardAnnals:Ranking|ranked]] list of books, try an honor roll:
*[[Honor roll:Hugo Award for Novel|Hugo Award for Novel]]
*[[Honor roll:Speculative Fiction books|Speculative Fiction books]]
*[[Honor roll:Speculative Fiction authors|Speculative Fiction authors]].
{{AnnalNav
| info = [[Hugo Award]]
| previous = [[Annal:2000 Hugo Award for Novel|2000]]
| next = [[Annal:2002 Hugo Award for Novel|2002]] }}
{{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
}}
{{AnnalNav
| info = [[Hugo Award]]
| previous = [[Annal:2000 Hugo Award for Novel|2000]]
| next = [[Annal:2002 Hugo Award for Novel|2002]] }}
[[Category:Hugo Award for Novel|2001 Hugo Award for Novel]]
[[Category:2001|Hugo Award for Novel]]
Introductory information
The page should start with a simple identification of the annal containing:
- Name and link to the award organization
- Year linked to the year’s category
- Links to relevant or related honor rolls
Additional information about the award ceremony and anomalies is welcome, so long as it is brief. For instance, it should be noted if there are was a tie, or if no winner was named, or if no award was given for this year. If the ceremony differs from year to year, a short paragraph about this particular year is in order; otherwise, put such information on the award organization page.
Annal navigator
Add this template immediately before the AE. If there are more than a entries (enough so that scrolling is necessary to see the last entry) then add another one immediately following the AE. The arguments:
- info= a link to the award organization page. Use the shortest version of the award name after the pipe.
- previous=a link to the previous year's annal with the year after the pipe. Leave blank if this is the first annal.
- next= a link to the next year. Leave blank if this is the end of the line.
For the best aesthetic results, do not leave any clear returns between the navigator and the AE.
Annal entry construct
For detailed information on this construct, see AwardAnnals:annalentry. It's purpose here is to identify the finalists and winner of this award. The number of arguments is unlimited, and the state of the entry changes with each argument. 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 to the CWs. These terms determine the words in the honors list, and should be manipulated to produce the desired result.†
- year is obvious.
- 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. List the title of the CW's page rather than the proper title of the CW: notice that the winner’s page (Harry Potter and the Goblet of Fire: Book 4 of Harry Potter) includes the subtitle to differentiate it from the film. The name of the work shown in the AE listing will be the proper title identified in the infobox. See AwardAnnals:Creative work page for details on CW title and CW page title.
The annalentry will display a listing for every work named and, if in the “Annal:” namespace, modify the honors list and score to include this event. The winner’s listing will display a blue ribbon on this page.
†An honors list is generated like this: “{$year} {$award} {$place}”. Manipulation of this process was necessary for the Dagger Award because the place should 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
…
Categories
There are two categories for this type of page. The first is named simply for the year: [[Category:2001|Hugo Award for Novel]]. Since all pages in this category probably begin with the year, follow the pipe with the name of this award/category without the year so that they can be sorted by the award name.
The second category is named for the award/category: [[Category:Hugo Award for Novel|2001 Hugo Award for Novel]]. This provides a listing of all the annals available for an award/category, which may be quicker than the annal navigator if you are looking for a particular year. Follow the pipe with the name of the page without the namespace (not strictly necessary, but what the heck).
