Next / Previous / Contents / Shipman's homepage

15. indexBoilerplate: Fixed content for the index page

noteweb
# - - -   i n d e x B o i l e r P l a t e

def indexBoilerplate ( parent ):
    '''Add the fixed content to the index page.

      [ parent is an et.Element ->
          parent  +:=  fixed content for the index page ]
    '''
    #-- 1 --
    # [ parent  +:=  paragraph about seasons ]
    p1  =  et.SubElement ( parent, 'p' )
    p1.text  =  ( 'Notes are grouped according to the reporting '
                  'seasons for ' )
    cite  =  et.SubElement (p1, 'cite' )
    cite.text  =  'Audubon Field Notes'
    cite.tail  =  '.'

    #-- 2 --
    # [ parent  +:=  paragraph linking to conventions page ]
    p2  =  et.SubElement ( parent, 'p' )
    p2.text  =  'See '
    conLink  =  et.SubElement ( p2, 'a', href=CONVENTIONS_URL )
    conLink.text  =  "How to read Shipman's field notes"
    conLink.tail  =  ( ' for notational conventions and the '
                       "author's contact information." )