')
ht = string.join(ht, '\n')
self.writeDocFile('Webware Component Index', 'Docs/ComponentIndex.html', ht, extraHead='')
def createIndex(self):
print 'Creating index.html...'
ht = self.htFragment('index')
ht = ht % self._props
self.writeDocFile('Webware Documentation', 'Docs/index.html', ht, extraHead='')
# @@ 2000-12-23 Uh, we sneak in Copyright.html here until
# we have a more general mechanism for adding the header
# and footer to various documents
ht = self.htFragment('Copyright')
self.writeDocFile('Webware Copyright et al', 'Docs/Copyright.html', ht)
def createComponentIndexes(self):
print "Creating components' index.html..."
indexFrag = self.htFragment('indexOfComponent')
link = '%s \n'
for comp in self._comps:
comp['webwareVersion'] = self._props['version']
comp['webwareVersionString'] = self._props['versionString']
# Create 'htDocs' as a readable HTML version comp['docs']
ht = []
for doc in comp['docs']:
ht.append(link % (doc['file'], doc['name']))
ht = string.join(ht, '')
comp['htDocs'] = ht
# Set up release notes
ht = []
releaseNotes = glob(os.path.join(comp['filename'], 'Docs', 'RelNotes-*.html'))
if releaseNotes:
# releaseNotes = [{'filename': os.path.basename(filename)} for filename in releaseNotes]
results = []
for filename in releaseNotes:
results.append({'filename': os.path.basename(filename)})
releaseNotes = results
for item in releaseNotes:
filename = item['filename']
item['name'] = filename[string.rfind(filename,'-')+1:string.rfind(filename,'.')]
releaseNotes.sort(self.sortReleaseNotes)
for item in releaseNotes:
ht.append(link % (item['filename'], item['name']))
else:
ht.append('None\n')
ht = string.join(ht, '')
comp['htReleaseNotes'] = ht
# Write file
title = comp['name'] + ' Documentation'
filename = os.path.join(comp['filename'], 'Docs', 'index.html')
contents = indexFrag % comp
cssLink = ''
self.writeDocFile(title, filename, contents, extraHead=cssLink)
def finished(self):
''' This method is invoked just before printGoodbye(). It is a hook for subclasses. This implementation does nothing. '''
pass
def printGoodbye(self):
print '''
Installation looks successful.
Welcome to Webware!
You can find more information at:
* Docs/index.html (e.g., local docs)
* http://webware.sourceforge.net
Installation is finished.'''
## Self utility ##
def printKeyValue(self, key, value):
# Handle values with line breaks by indenting extra lines
value = str(value)
value = string.replace(value, '\n', '\n'+' '*14)
print '%12s: %s' % (key, value)
def makeDir(self, dirName):
if not os.path.exists(dirName):
if self._verbose: print ' Making %s...' % dirName
os.mkdir(dirName)
def requirePath(self, path):
if path not in sys.path:
sys.path.insert(1, path)
def sortReleaseNotes(self, a, b):
''' Used by createComponentIndexes(). You pass this to list.sort(). '''
# We append '.0' below so that values like 'x.y' and 'x.y.z'
# compare the way we want them too (x.y.z is newer than x.y)
a = a['name']
if string.count(a, '.')==1:
a = a + '.0'
b = b['name']
if string.count(b, '.')==1:
b = b + '.0'
return -cmp(a, b)
def htFragment(self, name):
''' Returns an HTML fragment with the given name. '''
return open(os.path.join('Docs', name+'.htmlf')).read()
def writeDocFile(self, title, filename, contents, extraHead=''):
values = locals()
file = open(filename, 'w')
file.write(self._htHeader % values)
file.write(contents)
file.write(self._htFooter % values)
file.close()
if __name__=='__main__':
Installer().run(verbose=0)