noteweb: Rendering bird field notes for the Web |  |
noteweb: Rendering bird field notes for the Web | |
Abstract
Describes a system for translating XML-based bird field notes to HTML.
This publication is available in Web form and also as a PDF document.
Please forward any comments to john@nmt.edu.
Table of Contents
day-notesday-summary blockday-annotation elementsform elementfloc elementstable.seasonsth.winter, etc.th.row-label: The row labeldiv.loc-child: Indented child
blockdiv.day-summary: Daily summary
blockdiv.loc-def: Location definitiondiv.loc-narrative: Locality narrativediv.para: Ordinary paragraphsdiv.form: General form-related datadiv.floc: Multiple sightingsMONTH_NAME_MAP: Translate month
numbers to month namesMONTH_SEASON_MAP: Define the season
for each monthYEAR_PAT: Pattern for year numbersYYYY_MM_XML_PAT: Month file name patternHTML_EXT: File extension for XHTML pagesINDEX_PAGE_NAME: Name of the index pageINDEX_PAGE_TITLEHOME_PAGE_URL: Home page URLCONVENTIONS_URLSEASONS_CLASS: Class attribute for
the table of seasonsYEAR_GROUP_FREQUENCYYEAR_GROUP_CLASS: CSS class for years
ending a year groupYEAR_ROW_CLASSROW_LABEL_CLASSNBSP: Non-breaking space characterPHI: Greek letter ϕCSS_URL: Our stylesheetZDP_LOGOLOC_CHILD_CLASSNOTABLE_CLASSDAY_SUMMARY_CLASSLOC_DEF_CLASSLOC_NARRATIVE_CLASSLOC_LABEL_CLASSPARA_CLASSFORM_CLASSNOTABLE_FORM_CLASSBIRD_NAME_CLASSFLOC_CLASSGENUS_CLASSmain(): The main programfindYears: Locate year directoriesbuildIndex(): Build the index pagepageFrame: Set up navigation for the
index pageindexBoilerplate: Fixed content for the
index pageindexTable(): Build the table of
monthly linksindexTableFrame(): Set up the table
structurebuildRow(): Build one row of the index
tablebuildMonthCell(): Build one monthly
cell in the index tableclass YearCollection: The top-level
data structureYearCollection.__init__():
ConstructorYearCollection.addYear(): Add a yearYearCollection.__getitem__(): Return
self[yyyy]YearCollection.genYearsRev():
Generate years in reverse chronological orderYearCollection.neighbors(): Find
previous and next monthYearCollection.__findPrev(): Find
predecessor monthYearCollection.findNext(): Find
successor monthclass YearRow: Container for one
year's recordsYearRow.__init__(): ConstructorYearRow.__len__(): Number of
contained monthsYearRow.__getitem__(): Retrieve one
monthYearRow.firstMonth(): Return the
first monthYearRow.lastMonth(): Return the
last monthYearRow.predecessor(): Find the
previous monthYearRow.successor(): Find the
following monthYearRow.readAllMonths(): Process input
files for one yearYearRow.readOneMonth(): Read one
monthly fileYearRow.writeMonthPages(): Generate monthly
pagesclass MonthCell: One table cellMonthCell.__init__(): ConstructorMonthCell.fileName(): Path to the
month's pageMonthCell.writePage(): Render as
XHTMLMonthCell.__pageFrame(): Set up a basic
pageMonthCell.__renderPage(): Add the
notes contentMonthCell.__pageTOC(): Generate page
table of contentsMonthCell.__dayTOC(): Month table of
contents entry for one dayMonthCell.__notablesBlock(): Display
any notable recordsMonthCell.__span(): Add a span inlineMonthCell.__dayBlock(): Render one
daily note setMonthCell.__dayTitle(): Render the
title for one daily blockMonthCell.__daySummary(): Render the
daily summary blockMonthCell.__locDef(): Display a
locality definitionMonthCell.__dayAnnotation(): Render
day-annotation contentMonthCell.__annoBlock(): Annotation
block with a labelMonthCell.__narrative(): Render a
Narrative instanceMonthCell.__paragraph(): Render one
paragraphMonthCell.__paraContent(): Content of
one paragraphMonthCell.__birdForm(): Render one
BirdFormMonthCell.__singleSighting():
Single-sighting caseMonthCell.__multiSighting():
Multiple-sighting caseMonthCell.__locGroup(): Render a
locality groupMonthCell.__sightNotes(): Render a
sighting notes groupMonthCell.__photo(): Generate a photo
reference or linkMonthCell.__floc(): Generate one of
multiple sightingsMonthCell.__ageSexGroup(): Render
age-sex-group contentMonthCell.monthName(): Translate a
month key to a month name (static method)Once birdwatching field notes are encoded in the form described in A system for encoding bird field notes, the next link in the tool chain is described herein: rendering these notes into a Web structure.
The noteweb script expects to be run from a directory containing all the notes files in this form:
Each year's worth of notes resides in subdirectory
yyyy/yyyy
Each month's worth of notes resides in a single file at
path yyyy/yyyy-mm.xmlmm01-12.
Assuming all the input files are valid, the noteweb script builds these files, also in and under the current directory:
A set of HTML files, one for each input .xml file, but named yyyy/yyyy-mm.html
field.html, a thumb-index page
with links to the monthly pages. This organized as a
table, with the years in rows and the months in
columns.