Synopsis - Synopsis.Formatters.HTML.DirectoryLayout.DirectoryLayout

module Synopsis.Formatters.HTML.DirectoryLayout
class DirectoryLayout
File: ../Synopsis/Formatters/HTML/DirectoryLayout.py
DirectoryLayout defines how the generated html files are organized. The default implementation uses a flat layout with all files being part of a single directory.
Protected Methods Summary:
_strip(self, filename)
Methods Summary:
init(self, processor)
copy_file(self, src, dest)
Copy src to dest, if dest doesn't exist yet or is outdated.
scope(self, scope = None)
Return the filename of a scoped name (class or module).
file_index(self, filename)
Return the filename for the index of an input file.
file_source(self, filename)
Return the filename for the source of an input file.
file_details(self, filename)
Return the filename for the details of an input file.
index(self)
Return the name of the main index file.
special(self, name)
Return the name of a special file (tree, etc).
scoped_special(self, name, scope, ext = '.html')
Return the name of a special type of scope file.
xref(self, page)
module_tree(self)
Return the name of the module tree index.
module_index(self, scope)
Return the name of the index of the given module.
link(self, decl)
Create a link to the named declaration.
Methods Details:
copy_file(self, src, dest)
Copy src to dest, if dest doesn't exist yet or is outdated.
scope(self, scope = None)
Return the filename of a scoped name (class or module). The default implementation is to join the names with '-' and append ".html". Additionally, special characters are quoted.
file_index(self, filename)
Return the filename for the index of an input file. Default implementation is to join the path with '.', prepend '_file.' and append '.html'
file_source(self, filename)
Return the filename for the source of an input file. Default implementation is to join the path with '.', prepend '_source.' and append '.html'
file_details(self, filename)
Return the filename for the details of an input file. Default implementation is to join the path with '.', prepend '_file_detail.' and append '.html'
index(self)
Return the name of the main index file. Default is index.html
special(self, name)
Return the name of a special file (tree, etc). Default is _name.html
scoped_special(self, name, scope, ext = '.html')
Return the name of a special type of scope file. Default is to join the scope with '.' and prepend '.'+name
xref(self, page)
Return the name of the xref file for the given page
module_tree(self)
Return the name of the module tree index. Default is _modules.html
module_index(self, scope)
Return the name of the index of the given module. Default is to join the name with '.', prepend '_module' and append '.html'
link(self, decl)
Create a link to the named declaration. This method may have to deal with the directory layout.
Generated on Thu Apr 16 16:27:01 2009 by
synopsis (version devel)