#!/usr/bin/python """ Reference documentation generator for Templayer http://excess.org/templayer/ library to build dynamic html that provides clean separation of form (html+css+javascript etc..) and function (python code) as well as making cross-site scripting attacks and improperly generated html very difficult. Copyright (c) 2003-2006 Ian Ward This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. """ import pydoc import types import templayer html_template = """ Templayer ((version)) Reference

Templayer ((version)) Reference

Templayer Home Page / Tutorial / Reference

%toc%
%contents% """ class TemplayerHTMLDoc( pydoc.HTMLDoc ): def heading(self, title, fgcol, bgcol, extras=''): return extras def section(self, title, fgcol, bgcol, contents, width=6, prelude='', marginalia=None, gap=' '): if " = " in title: visible, tail = title.split(" = ",1) aname = tail.split('">',1)[0] aname = aname.split('"',1)[1] aname = aname.replace(" ","_") title = ''+visible return '

%s [back to top]

%s' % (title,contents) def namelink(self, name, *ignore): return name def classlink(self, obj, modname): return obj.__name__ def modulelink(self, obj): return obj.__name__ def modpkglink(self, (name, path, ispackage, shadowed) ): return name def markup(self, text, escape=None, funcs={}, classes={}, methods={}): return pydoc.HTMLDoc.markup( self, text, escape ) def main(): html = TemplayerHTMLDoc() contents = [] doc = [] contents.append('
') for obj, name in [ (None,"Template classes"), (templayer.Template,"Template"), (templayer.HTMLTemplate,"HTMLTemplate"), (None,"Layer classes"), (templayer.FileLayer,"FileLayer"), (templayer.Layer,"Layer"), (None,"HTML Markup"), (templayer.expand_html_markup,"expand_html_markup"), (templayer.RawHTML,"RawHTML"), (None,None), (None,"Utility functions"), (templayer.html_url_encode,"html_url_encode"), (templayer.html_href,"html_href"), (templayer.html_target,"html_target"), (templayer.html_escape,"html_escape"), (templayer.django_form,"django_form"), ]: if name is None: contents.append('') elif obj is None: contents.append('
%s
' % name) doc.append('

%s

' % name ) else: lname = name if type(obj) != types.ClassType: #dirty hack doc.append('

function %s [back to top]

' % (name,name) ) lname = lname.replace(" ","_") contents.append('
' + '%s
' % (lname,name) ) doc.append( html.document( obj, name ) ) contents.append("
") h = html_template h = h.replace("%toc%", "".join(contents)) h = h.replace("%contents%", "".join(doc)) print h if __name__ == "__main__": main()