1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
|
"""
Wikifier is a script to add spaces to the pydoc files and move them to the documentation folder.
"""
from __future__ import absolute_import
#Init has to be imported first because it has code to workaround the python bug where relative imports don't work if the module is imported as a main module.
import __init__
from skeinforge_tools.skeinforge_utilities import gcodec
from skeinforge_tools.skeinforge_utilities import settings
import cStringIO
import os
__author__ = "Enrique Perez (perez_enrique@yahoo.com)"
__date__ = "$Date: 2008/21/04 $"
__license__ = "GPL 3.0"
class Heading:
"A class to hold the heading and subheadings."
def __init__( self, depth = 0 ):
"Initialize."
self.depth = depth
def addToOutput( self, output ):
"Add to the output."
line = ' ' * self.depth + '<a href="#%s">%s</a><br />\n' % ( self.name, self.name )
output.write( line )
def getFromLine( self, headingLineTable, line ):
"Get the heading from a line."
headingTag = 'h' + str( self.depth + 2 )
nextLine = '\n<hr>\n'
if self.depth > 0:
nextLine = '\n'
self.name = line.replace( '=', '' ).replace( '<br>', '' )
headingLineTable[ line ] = '<a name="%s" id="%s"></a><%s>%s</%s>%s' % ( self.name, self.name, headingTag, self.name, headingTag, nextLine )
return self
def addToHeadings( headingLineTable, headings, line ):
"Add the line to the headings."
for depth in xrange( 4, - 1, - 1 ):
equalSymbolLength = depth + 2
if line[ : equalSymbolLength ] == '=' * equalSymbolLength:
headings.append( Heading( depth ).getFromLine( headingLineTable, line ) )
return
def getNavigationHypertext( fileText, transferredFileNameIndex, transferredFileNames ):
"Get the hypertext help with navigation lines."
helpTextEnd = fileText.find( '</p>' )
helpTextStart = fileText.find( '<p>' )
helpText = fileText[ helpTextStart : helpTextEnd ]
lines = gcodec.getTextLines( helpText )
headings = []
headingLineTable = {}
for line in lines:
addToHeadings( headingLineTable, headings, line )
headingsToBeenAdded = True
output = cStringIO.StringIO()
for line in lines:
if line[ : 2 ] == '==':
if headingsToBeenAdded:
output.write( '<br />\n' )
for heading in headings:
heading.addToOutput( output )
output.write( '<br />\n' )
headingsToBeenAdded = False
if line in headingLineTable:
line = headingLineTable[ line ]
output.write( line + '\n' )
helpText = output.getvalue()
previousFileName = 'contents.html'
previousIndex = transferredFileNameIndex - 1
if previousIndex >= 0:
previousFileName = transferredFileNames[ previousIndex ]
previousLinkText = '<a href="%s">Previous</a>' % previousFileName
navigationLine = getNavigationLine( '<a href="contents.html">Contents</a>', previousLinkText, getNextLinkText( transferredFileNames, transferredFileNameIndex + 1 ) )
helpText = navigationLine + helpText + '<br />\n<br />\n' + navigationLine + '<hr>\n'
return fileText[ : helpTextStart ] + helpText + fileText[ helpTextEnd : ]
def getNavigationLine( contentsLinkText, previousLinkText, nextLinkText ):
"Get the wrapped pydoc hypertext help."
return '<p>\n%s / %s / %s\n</p>\n' % ( previousLinkText, nextLinkText, contentsLinkText )
def getNextLinkText( hypertextFiles, nextIndex ):
"Get the next link text."
nextFileName = 'contents.html'
if nextIndex < len( hypertextFiles ):
nextFileName = hypertextFiles[ nextIndex ]
return '<a href="%s">Next</a>' % nextFileName
def getWrappedHypertext( fileText, hypertextFileIndex, hypertextFiles ):
"Get the wrapped pydoc hypertext help."
helpTextEnd = fileText.find( '</p>' )
if helpTextEnd < 0:
print( 'Failed to find the helpTextEnd in getWrappedHypertext in docwrap.' )
helpTextStart = fileText.find( '<p>' )
if helpTextStart < 0:
print( 'Failed to find the helpTextStart in getWrappedHypertext in docwrap.' )
helpText = fileText[ helpTextStart : helpTextEnd ]
helpText = helpText.replace( ' ', ' ' )
return fileText[ : helpTextStart ] + helpText + fileText[ helpTextEnd : ]
def readWriteDeleteHypertextHelp( documentDirectoryPath, hypertextFileIndex, hypertextFiles, transferredFileNames ):
"Read the pydoc hypertext help documents, write them in the documentation folder then delete the originals."
fileName = hypertextFiles[ hypertextFileIndex ]
print( fileName )
filePath = os.path.join( documentDirectoryPath, fileName )
fileText = gcodec.getFileText( fileName )
fileText = getWrappedHypertext( fileText, hypertextFileIndex, hypertextFiles )
if fileText.find( 'This page is in the table of contents.' ) > - 1:
fileText = fileText.replace( 'This page is in the table of contents.', '' )
transferredFileNames.append( fileName )
gcodec.writeFileText( filePath, fileText )
os.remove( fileName )
def readWriteNavigationHelp( documentDirectoryPath, transferredFileNameIndex, transferredFileNames ):
"Read the hypertext help documents, and add the navigation lines to them."
fileName = transferredFileNames[ transferredFileNameIndex ]
print( fileName )
filePath = os.path.join( documentDirectoryPath, fileName )
fileText = gcodec.getFileText( filePath )
fileText = getNavigationHypertext( fileText, transferredFileNameIndex, transferredFileNames )
gcodec.writeFileText( filePath, fileText )
def removeFilesInDirectory( directoryPath ):
"Remove all the files in a directory."
fileNames = os.listdir( directoryPath )
for fileName in fileNames:
filePath = os.path.join( directoryPath, fileName )
os.remove( filePath )
def writeContentsFile( documentDirectoryPath, hypertextFiles ):
"Write the contents file."
output = cStringIO.StringIO()
output.write( '<html>\n <head>\n <title>Contents</title>\n </head>\n <body>\n' )
navigationLine = getNavigationLine( 'Contents', 'Previous', getNextLinkText( hypertextFiles, 0 ) )
output.write( navigationLine )
for hypertextFile in hypertextFiles:
writeContentsLine( hypertextFile, output )
output.write( navigationLine )
output.write( ' </body>\n</html>\n' )
filePath = os.path.join( documentDirectoryPath, 'contents.html' )
gcodec.writeFileText( filePath, output.getvalue() )
def writeContentsLine( hypertextFile, output ):
"Write a line of the contents file."
summarizedFileName = hypertextFile[ : hypertextFile.rfind( '.' ) ]
numberOfDots = summarizedFileName.count( '.' )
prefixSpaces = ' ' * numberOfDots
if numberOfDots > 0:
summarizedFileName = summarizedFileName[ summarizedFileName.rfind( '.' ) + 1 : ]
capitalizedSummarizedFileName = settings.getEachWordCapitalized( summarizedFileName )
output.write( '%s<a href="%s">%s</a><br>\n' % ( prefixSpaces, hypertextFile, capitalizedSummarizedFileName ) )
def writeHypertext():
"Run pydoc, then read, write and delete each of the files."
shellCommand = 'pydoc -w ./'
commandResult = os.system( shellCommand )
if commandResult != 0:
print( 'Failed to execute the following command in writeHypertext in docwrap.' )
print( shellCommand )
hypertextFiles = gcodec.getFilesWithFileTypeWithoutWords( 'html' )
if len( hypertextFiles ) <= 0:
print( 'Failed to find any help files in writeHypertext in docwrap.' )
return
documentDirectoryPath = gcodec.getAbsoluteFolderPath( hypertextFiles[ 0 ], 'documentation' )
removeFilesInDirectory( documentDirectoryPath )
sortedReplaceFiles = []
for hypertextFile in hypertextFiles:
sortedReplaceFiles.append( hypertextFile.replace( '.html', '. html' ) )
sortedReplaceFiles.sort()
hypertextFiles = []
for sortedReplaceFile in sortedReplaceFiles:
hypertextFiles.append( sortedReplaceFile.replace( '. html', '.html' ) )
transferredFileNames = []
for hypertextFileIndex in xrange( len( hypertextFiles ) ):
readWriteDeleteHypertextHelp( documentDirectoryPath, hypertextFileIndex, hypertextFiles, transferredFileNames )
for transferredFileNameIndex in xrange( len( transferredFileNames ) ):
readWriteNavigationHelp( documentDirectoryPath, transferredFileNameIndex, transferredFileNames )
writeContentsFile( documentDirectoryPath, transferredFileNames )
print( '%s files were wrapped.' % len( transferredFileNames ) )
def main():
"Display the craft dialog."
writeHypertext()
if __name__ == "__main__":
main()
|
