def test_indexAnchorsAdded(self):
indexer.setIndexFilename('theIndexFile.html')
# generate the output file
templ = dom.parse(open(d['template']))
tmp = self.makeTemp('lore_index_test.xhtml')
tree.doFile(os.path.join(tmp, 'lore_index_test.xhtml'),
self.linkrel, '.html', d['baseurl'], templ, d)
self.assertXMLEqual(
"""\
<?xml version="1.0" ?><!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Transitional//EN' 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd'><html lang="en" xmlns="http://www.w3.org/1999/xhtml">
<head><title>Twisted Documentation: The way of the program</title></head>
<body bgcolor="white">
<h1 class="title">The way of the program</h1>
<div class="content">
<span/>
<p>The first paragraph.</p>
<h2>The Python programming language<a name="auto0"/></h2>
<a name="index01"/>
<a name="index02"/>
<p>The second paragraph.</p>
</div>
<a href="theIndexFile.html">Index</a>
</body>
</html>""",
FilePath(tmp).child("lore_index_test.html").getContent())
def test_indexAnchorsAdded(self):
indexer.setIndexFilename('theIndexFile.html')
# generate the output file
templ = dom.parse(open(d['template']))
tmp = self.makeTemp('lore_index_test.xhtml')
tree.doFile(os.path.join(tmp, 'lore_index_test.xhtml'), self.linkrel,
'.html', d['baseurl'], templ, d)
self.assertXMLEqual(
"""\
<?xml version="1.0" ?><!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Transitional//EN' 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd'><html lang="en" xmlns="http://www.w3.org/1999/xhtml">
<head><title>Twisted Documentation: The way of the program</title></head>
<body bgcolor="white">
<h1 class="title">The way of the program</h1>
<div class="content">
<span/>
<p>The first paragraph.</p>
<h2>The Python programming language<a name="auto0"/></h2>
<a name="index01"/>
<a name="index02"/>
<p>The second paragraph.</p>
</div>
<a href="theIndexFile.html">Index</a>
</body>
</html>""",
FilePath(tmp).child("lore_index_test.html").getContent())
def test_munge(self):
indexer.setIndexFilename("lore_index_file.html")
doc = microdom.parse(open(self.file))
templ = microdom.parse(open(d['template']))
node = templ.cloneNode(1)
tree.munge(doc, node, self.linkrel, os.path.dirname(self.file),
self.file, d['ext'], d['baseurl'], d)
self.assertEqualsFile('good_internal.xhtml', node.toprettyxml())
def test_indexEntriesAdded(self):
indexer.addEntry('lore_index_test.html', 'index02',
'language of programming', '1.3')
indexer.addEntry('lore_index_test.html', 'index01',
'programming language', '1.2')
indexer.setIndexFilename("lore_index_file.html")
indexer.generateIndex()
self.assertEqualFiles1("lore_index_file_out.html",
"lore_index_file.html")
def test_indexAnchorsAdded(self):
indexer.setIndexFilename('theIndexFile.html')
# generate the output file
templ = microdom.parse(open(d['template']))
tmp = self.makeTemp('lore_index_test.xhtml')
tree.doFile(os.path.join(tmp, 'lore_index_test.xhtml'), self.linkrel,
'.html', d['baseurl'], templ, d)
self.assertEqualFiles1("lore_index_test_out.html",
os.path.join(tmp, "lore_index_test.html"))
def test_indexAnchorsAdded(self):
indexer.setIndexFilename('theIndexFile.html')
# generate the output file
templ = microdom.parse(open(d['template']))
tmp = self.makeTemp('lore_index_test.xhtml')
tree.doFile(os.path.join(tmp, 'lore_index_test.xhtml'),
self.linkrel, '.html', d['baseurl'], templ, d)
self.assertEqualFiles1("lore_index_test_out.html",
os.path.join(tmp, "lore_index_test.html"))
def test_munge(self):
indexer.setIndexFilename("lore_index_file.html")
doc = microdom.parse(open(self.file))
templ = microdom.parse(open(d['template']))
node = templ.cloneNode(1)
tree.munge(doc, node, self.linkrel,
os.path.dirname(self.file),
self.file,
d['ext'], d['baseurl'], d)
self.assertEqualsFile('good_internal.xhtml', node.toprettyxml())
def runGivenOptions(opt):
"""Do everything but parse the options; useful for testing.
Returns a descriptive string if there's an error."""
book = None
if opt['book']:
book = htmlbook.Book(opt['book'])
df = getProcessor(opt['input'], opt['output'], opt.config)
if not df:
return 'getProcessor() failed'
walker = getWalker(df, opt)
if opt['files']:
for filename in opt['files']:
walker.walked.append(('', filename))
elif book:
for filename in book.getFiles():
walker.walked.append(('', filename))
else:
walker.walkdir(opt['docsdir'] or '.', opt['prefixurl'])
if opt['index']:
indexFilename = opt['index']
elif book:
indexFilename = book.getIndexFilename()
else:
indexFilename = None
if indexFilename:
indexer.setIndexFilename("%s.%s" % (indexFilename, opt['output']))
else:
indexer.setIndexFilename(None)
## TODO: get numberSections from book, if any
numberer.setNumberSections(opt['number'])
walker.generate()
if walker.failures:
for (file, errors) in walker.failures:
for error in errors:
print "%s:%s" % (file, error)
return 'Walker failures'
def runGivenOptions(opt):
"""Do everything but parse the options; useful for testing.
Returns a descriptive string if there's an error."""
book = None
if opt['book']:
book = htmlbook.Book(opt['book'])
df = getProcessor(opt['input'], opt['output'], opt.config)
if not df:
return 'getProcessor() failed'
walker = getWalker(df, opt)
if opt['files']:
for filename in opt['files']:
walker.walked.append(('', filename))
elif book:
for filename in book.getFiles():
walker.walked.append(('', filename))
else:
walker.walkdir(opt['docsdir'] or '.', opt['prefixurl'])
if opt['index']:
indexFilename = opt['index']
elif book:
indexFilename = book.getIndexFilename()
else:
indexFilename = None
if indexFilename:
indexer.setIndexFilename("%s.%s" % (indexFilename, opt['output']))
else:
indexer.setIndexFilename(None)
## TODO: get numberSections from book, if any
numberer.setNumberSections(opt['number'])
walker.generate()
if walker.failures:
for (file, errors) in walker.failures:
for error in errors:
print "%s:%s" % (file, error)
return 'Walker failures'
def test_munge(self):
indexer.setIndexFilename("lore_index_file.html")
doc = dom.parse(open(self.file))
node = dom.parse(open(d['template']))
tree.munge(doc, node, self.linkrel, os.path.dirname(self.file),
self.file, d['ext'], d['baseurl'], d)
self.assertXMLEqual(
"""\
<?xml version="1.0" ?><!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Transitional//EN' 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd'><html lang="en" xmlns="http://www.w3.org/1999/xhtml">
<head><title>Twisted Documentation: My Test Lore Input</title></head>
<body bgcolor="white">
<h1 class="title">My Test Lore Input</h1>
<div class="content">
<span/>
<p>A Body.</p>
</div>
<a href="lore_index_file.html">Index</a>
</body>
</html>""", node.toxml())
def test_munge(self):
indexer.setIndexFilename("lore_index_file.html")
doc = dom.parse(open(self.file))
node = dom.parse(open(d["template"]))
tree.munge(doc, node, self.linkrel, os.path.dirname(self.file), self.file, d["ext"], d["baseurl"], d)
self.assertXMLEqual(
"""\
<?xml version="1.0" ?><!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Transitional//EN' 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd'><html lang="en" xmlns="http://www.w3.org/1999/xhtml">
<head><title>Twisted Documentation: My Test Lore Input</title></head>
<body bgcolor="white">
<h1 class="title">My Test Lore Input</h1>
<div class="content">
<span/>
<p>A Body.</p>
</div>
<a href="lore_index_file.html">Index</a>
</body>
</html>""",
node.toxml(),
)
def test_indexEntriesAdded(self):
indexer.addEntry('lore_index_test.html', 'index02', 'language of programming', '1.3')
indexer.addEntry('lore_index_test.html', 'index01', 'programming language', '1.2')
indexer.setIndexFilename("lore_index_file.html")
indexer.generateIndex()
self.assertEqualFiles1("lore_index_file_out.html", "lore_index_file.html")
def test_indexEntriesAdded(self):
indexer.addEntry("lore_index_test.html", "index02", "language of programming", "1.3")
indexer.addEntry("lore_index_test.html", "index01", "programming language", "1.2")
indexer.setIndexFilename("lore_index_file.html")
indexer.generateIndex()
self.assertEqualFiles1("lore_index_file_out.html", "lore_index_file.html")
