def writeExternExample(self, example):
fname = example.fname
htmlName = fname + '.html'
perl2html.convertFile(fname, htmlName)
self.htmlstream.write(
"%s (%s)\n" %
(html.href(htmlName, fname), html.href(fname, 'Raw Source')))
def makeLocalLink(self, name, display=None, comment=None):
if not display:
display = name
result = html.href('#' + name, display)
shortComment = shortDesc(comment)
if shortComment:
result = result + " - " + shortComment
return result
def formatEntry(self, entry, targetDir, htmlstream):
lowerName, name, context, description, docfile, anchor = entry
linkFile = File(docfile, targetDir.filesystem)
relative = linkFile.relativeTo(targetDir)
link = relative + '#' + anchor
htmlstream.tag('dt')
htmlstream.write(html.href(link, name))
htmlstream.write(' (' + context + ')\n')
if description:
htmlstream.tag('dd')
htmlstream.write(description)
def writeTable(self, htmlstream, docDir, title, memberList):
htmlstream.write(self.tableTitle % title)
htmlstream.pseudoBreak()
for info in memberList:
# write link
htmlstream.pushTag('TR', BGCOLOR="white")
htmlstream.pushTag('TD', WIDTH="15%")
if type(info.file) == type(''):
# a normal href, left unchanged
relative = info.file
else:
# an absolute doc address, made relative to caller
relative = info.file.relativeTo(docDir)
anchor = html.href(relative, str(info.title))
htmlstream.write(html.tagged('B', anchor))
htmlstream.popTag()
# write description
htmlstream.pushTag('TD')
htmlstream.write(info.formatDescription(' '))
htmlstream.popTag() # TD
htmlstream.popTag() # TR
htmlstream.pseudoBreak()
htmlstream.write('</TABLE>')
def genOverview (self, sourceFS, targetFS, memberdocs):
# get package description
contentsFile = sourceFS.search ('Contents.txt')
if contentsFile:
description = self.parseContentsFile (sourceFS.absolute (contentsFile))
else:
description = ''
# todo: get old descriptions
# merge and save
# set new and updated
# open html stream
htmlfile = self.name + '.html'
title = 'Package ' + self.name
htmlstream = html.HTMLFile (targetFS.absolute (htmlfile), title)
# write header
htmlstream.titleHeader (title)
htmlstream.pushTag ('Blockquote')
# write description
if description:
htmlstream.write (description)
# write links to members
htmlstream.pushTag ('DL')
htmlstream.pseudoBreak ()
for name, file, memberDesc in memberdocs:
# write link
htmlstream.tag ('DT')
htmlstream.write (html.href (file, name) + '\n')
# write description
if memberDesc:
htmlstream.tag ('DD')
htmlstream.write (memberDesc)
htmlstream.popTag ()
# close file
htmlstream.line ()
genDate (htmlstream)
htmlstream.close ()
return (self.name, htmlfile, description)