module Synopsis.Formatters.HTML.DirectoryLayout
class DirectoryLayout
DirectoryLayout-inheritance Scopes/Synopsis/Formatters/HTML/DirectoryLayout/NestedDirectoryLayout.html Scopes/Synopsis/Parsers/IDL/IDL/Parser.html
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)
references
source code
Methods Summary:
  init(self, processor)
references
source code
  copy_file(self, src, dest)
references
source code
Copy src to dest, if dest doesn't exist yet or is outdated.
  scope(self, scope = None)
references
source code
Return the filename of a scoped name (class or module).
  file_index(self, filename)
references
source code
Return the filename for the index of an input file.
  file_source(self, filename)
references
source code
Return the filename for the source of an input file.
  file_details(self, filename)
references
source code
Return the filename for the details of an input file.
  index(self)
references
source code
Return the name of the main index file.
  special(self, name)
references
source code
Return the name of a special file (tree, etc).
  scoped_special(self, name, scope, ext = '.html')
references
source code
Return the name of a special type of scope file.
  xref(self, page)
references
source code
  module_tree(self)
references
source code
Return the name of the module tree index.
  module_index(self, scope)
references
source code
Return the name of the index of the given module.
  link(self, decl)
references
source code
Create a link to the named declaration.
Methods Details:
  copy_file(self, src, dest)
references
source code
Copy src to dest, if dest doesn't exist yet or is outdated.
  scope(self, scope = None)
references
source code
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)
references
source code
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)
references
source code
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)
references
source code
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)
references
source code
Return the name of the main index file. Default is index.html
  special(self, name)
references
source code
Return the name of a special file (tree, etc). Default is _name.html
  scoped_special(self, name, scope, ext = '.html')
references
source code
Return the name of a special type of scope file. Default is to join the scope with '.' and prepend '.'+name
  xref(self, page)
references
source code
Return the name of the xref file for the given page
  module_tree(self)
references
source code
Return the name of the module tree index. Default is _modules.html
  module_index(self, scope)
references
source code
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)
references
source code
Create a link to the named declaration. This method may have to deal with the directory layout.