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

10.26. hist.cgi: simpleMaster()

Builds one simple-page-master.

hist.cgi
# - - -   s i m p l e M a s t e r

def simpleMaster(s, masterName, dims, beforeName):
    '''Build a simple-page-master.

      [ (s is a sox.Sox instance) and
        (masterName is a master name) and
        (dims is a fo.PageDims instance) ->
          s  +:=  a simple-page-master named (masterName), using
              the layout from (dims) and the before-region name
              (beforeName) ]
    '''
    #-- 1
    # [ s  +:=  an open simple-master element named (masterName)
    #   master  :=  that element ]
    master = fo.simpleMaster(s, masterName, dims)

    #-- 2
    # [ s  +:=  a region-body element using the layout from (dims) ]
    fo.regionBody(s, dims)

    #-- 3
    # [ s  +:=  a region-before element named (beforeName) and
    #       using the layout from (dims) ]
    fo.regionBefore(s, beforeName, dims)

    #-- 4
    # [ s  +:=  closing tag for (master) ]
    master.end()