Next / Previous / Contents / TCC Help System / NM Tech homepage

10.31. hist.cgi: foTableStart(): Build the table preamble

In addition to opening the table element, this function adds the table-column elements and the table-header. See Section 10.32, “hist.cgi: foTableColumns() and Section 10.33, “hist.cgi: foTableHeader(): Generate the table's running heads”. For styling, see Section 13.11.7, “FO_TABLE_ATTRS.

hist.cgi
# - - -   f o T a b l e S t a r t

def foTableStart(s, cbcHist):
    '''Start the table and add table-column and table-header children.

      [ (s is a sox.Sox instance) and
        (cbcHist is a lib.CbcHist instance) ->
          s  +:=  an open table element with its table-column and
                  table-header children added from cbcHist's
                  effort information
          return that element ]
    '''
    #-- 1
    # [ s  +:=  an open table element styled with FO_TABLE_ATTRS
    #   table  :=  that element ]
    table = s.start('table', lib.FO_TABLE_ATTRS)

    #-- 2
    # [ s  +:=  table-column children representing cbcHist ]
    foTableColumns(s, cbcHist)

    #-- 3
    # [ s  +:=  a table-header child representing the running heads
    #           from cbcHist ]
    foTableHeader(s, cbcHist)

    #-- 4
    return table