doclib/SConscript

   1 # -*- python -*-
   2
   3 Import('env')
   4 import SENFSCons
   5
   6 ###########################################################################
   7
   8 import yaptu
   9
  10 def modules():
  11     global EXTRA_MODULES
  12     rv = []
  13     ix = len(env.Dir('#').abspath)+1
  14     ex = dict((env.Dir(p).abspath,True) for n,p in EXTRA_MODULES)
  15     for module in env.Alias('all_docs')[0].sources:
  16         if module.name != 'html.stamp' : continue
  17         if not ex.get(module.dir.abspath):
  18             rv.append(('lib%s' % module.dir.dir.dir.name, module.dir.abspath[ix:]))
  19     rv.sort()
  20     return [ (name, env.Dir(path).abspath[ix:]) for name,path in EXTRA_MODULES ] + rv
  21
  22 def indices():
  23     ix = len(env.Dir('#').abspath)+1
  24     return [ doc.dir.abspath[ix:]
  25              for doc in env.Alias('all_docs')[0].sources
  26              if doc.name == "search.idx" ]
  27
  28 def writeTemplate(target = None, source = None, env = None):
  29     file(target[0].abspath,"w").write(yaptu.process(str(env['TEMPLATE']), globals(), env.Dictionary()))
  30
  31 writeTemplate = env.Action(writeTemplate, varlist = [ 'TEMPLATE' ])
  32
  33 ###########################################################################
  34
  35 # Extra documentation modules which are handled (named) different from
  36 # library modules
  37 EXTRA_MODULES = [
  38     ('Overview', '#/doc/html'),
  39     ('Examples', '#/Examples/doc/html'),
  40     ('SENFScons', '#/senfscons/doc/html') ]
  41
  42 HEADER = """<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  43 <html>
  44 <head>
  45 <title>$title</title>
  46 <link href="@TOPDIR@/doc/html/doxygen.css" rel="stylesheet" type="text/css">
  47 <link href="@TOPDIR@/doclib/senf.css" rel="stylesheet" type="text/css">
  48 <style type="text/css">
  49 div.tabs ul li.$projectname a { background-color: #EDE497; }
  50 </style>
  51 </head>
  52 <body>
  53
  54 <div id="head">
  55   <div id="search">
  56     <form action="@TOPDIR@/doclib/search.php" method="get">
  57       Search: <input type="text" name="query" size="20" accesskey="s"/>
  58     </form>
  59   </div>
  60   <h1>SENF Extensible Network Framework</h1>
  61   <h2>${TITLE}</h2>
  62 </div>
  63
  64 <div id="content1">
  65   <div id="content2">
  66     <div class="tabs menu">
  67       <ul>
  68 {{      for name, path in modules():
  69           <li class="${name}"><a href="@TOPDIR@/${path}/index.html">${name}</a></li>
  70 }}
  71       </ul>
  72     </div>"""
  73
  74 OVERVIEW_EXTRA_HEADER="""
  75     <div class="tabs">
  76       <ul>
  77       <li><a href="@TOPDIR@/doc/html/xref.html">Open Issues</a></li>
  78         <li><a class="ext" href="http://svn.berlios.de/wsvn/senf/?op=log&rev=0&sc=0&isdir=1">SVN ChangeLog</a></li>
  79         <li><a class="ext" href="http://developer.berlios.de/projects/senf">SENF @ BerliOS</a></li>
  80         <li><a class="ext" href="http://openfacts.berlios.de/index-en.phtml?title=SENF+Network+Framework">Wiki</a></li>
  81       </ul>
  82     </div>"""
  83
  84 FOOTER = """<hr style="width:0px;border:none;clear:both;margin:0;padding:0" />
  85   </div>
  86 </div>
  87 <div id="footer">
  88   <span>
  89     <a href="mailto:senf-dev@lists.berlios.de">Contact: senf-dev@lists.berlios.de</a> |
  90     Copyright &copy; 2006 Fraunhofer Gesellschaft, SatCom, Stefan Bund
  91   </span>
  92 </div>
  93 </body></html>"""
  94
  95 SEARCH_PHP="""
  96 <?php include 'search_functions.php'; ?>
  97 <?php search(); ?>"""
  98
  99 SEARCH_PATHS_PHP="""<?php
 100 function paths() {
 101   return array(
 102 {{  for index in indices():
 103       "../${index}/",
 104 }}
 105   );
 106 }
 107 ?>"""
 108
 109 env.Command('doxy-header.html', None, writeTemplate,
 110             TEMPLATE = Literal(HEADER),
 111             TITLE = "Documentation and API reference")
 112 env.Command('doxy-header-overview.html', None, writeTemplate,
 113             TEMPLATE = Literal(HEADER+OVERVIEW_EXTRA_HEADER),
 114             TITLE = "Introduction and Overview")
 115 env.Command('doxy-footer.html', None, writeTemplate,
 116             TEMPLATE = Literal(FOOTER))
 117 env.Alias('all_docs',
 118           env.Command('search.php', 'html-munge.xsl',
 119                       [ writeTemplate,
 120                         'xsltproc --nonet --html --stringparam topdir .. -o - $SOURCE $TARGET 2>/dev/null'
 121                             + "| sed"
 122                             +   r" -e 's/\[\[/<?/g' -e 's/\]\]/?>/g'"
 123                             +   r" -e 's/\$$projectname/Overview/g'"
 124                             +   r" -e 's/\$$title/Search results/g'"
 125                             +       "> ${TARGET}.tmp",
 126                         'mv ${TARGET}.tmp ${TARGET}' ],
 127                       TEMPLATE = Literal(HEADER
 128                                          + OVERVIEW_EXTRA_HEADER
 129                                          + SEARCH_PHP.replace('<?','[[').replace('?>',']]')
 130                                          + FOOTER),
 131                       TITLE = "Search results"))
 132 env.Alias('all_docs',
 133           env.Command('search_paths.php', None, writeTemplate,
 134                       TEMPLATE = Literal(SEARCH_PATHS_PHP)))