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 <link rel="shortcut icon" href="@TOPDIR@/doclib/favicon.ico">
  49 <style type="text/css">
  50 div.tabs ul li.$projectname a { background-color: #EDE497; }
  51 </style>
  52 </head>
  53 <body>
  54
  55 <div id="head">
  56   <div id="search">
  57     <form action="@TOPDIR@/doclib/search.php" method="get">
  58       Search: <input type="text" name="query" size="20" accesskey="s"/>
  59     </form>
  60   </div>
  61   <h1>SENF Extensible Network Framework</h1>
  62   <h2>${TITLE}</h2>
  63 </div>
  64
  65 <div id="content1">
  66   <div id="content2">
  67     <div class="tabs menu">
  68       <ul>
  69 {{      for name, path in modules():
  70           <li class="${name}"><a href="@TOPDIR@/${path}/index.html">${name}</a></li>
  71 }}
  72       </ul>
  73     </div>"""
  74
  75 OVERVIEW_EXTRA_HEADER="""
  76     <div class="tabs">
  77       <ul>
  78       <li><a href="@TOPDIR@/doc/html/xref.html">Open Issues</a></li>
  79         <li><a class="ext" href="http://svn.berlios.de/wsvn/senf/?op=log&rev=0&sc=0&isdir=1">SVN ChangeLog</a></li>
  80         <li><a class="ext" href="http://developer.berlios.de/projects/senf">SENF @ BerliOS</a></li>
  81         <li><a class="ext" href="http://openfacts.berlios.de/index-en.phtml?title=SENF+Network+Framework">Wiki</a></li>
  82       </ul>
  83     </div>"""
  84
  85 FOOTER = """<hr style="width:0px;border:none;clear:both;margin:0;padding:0" />
  86   </div>
  87 </div>
  88 <div id="footer">
  89   <span>
  90     <a href="mailto:senf-dev@lists.berlios.de">Contact: senf-dev@lists.berlios.de</a> |
  91     Copyright &copy; 2006 Fraunhofer Gesellschaft, SatCom, Stefan Bund
  92   </span>
  93 </div>
  94 </body></html>"""
  95
  96 SEARCH_PHP="""
  97 <?php include 'search_functions.php'; ?>
  98 <?php search(); ?>"""
  99
 100 SEARCH_PATHS_PHP="""<?php
 101 function paths() {
 102   return array(
 103 {{  for index in indices():
 104       "../${index}/",
 105 }}
 106   );
 107 }
 108 ?>"""
 109
 110 env.Command('doxy-header.html', None, writeTemplate,
 111             TEMPLATE = Literal(HEADER),
 112             TITLE = "Documentation and API reference")
 113 env.Command('doxy-header-overview.html', None, writeTemplate,
 114             TEMPLATE = Literal(HEADER+OVERVIEW_EXTRA_HEADER),
 115             TITLE = "Introduction and Overview")
 116 env.Command('doxy-footer.html', None, writeTemplate,
 117             TEMPLATE = Literal(FOOTER))
 118 env.Alias('all_docs',
 119           env.Command('search.php', 'html-munge.xsl',
 120                       [ writeTemplate,
 121                         'xsltproc --nonet --html --stringparam topdir .. -o - $SOURCE $TARGET 2>/dev/null'
 122                             + "| sed"
 123                             +   r" -e 's/\[\[/<?/g' -e 's/\]\]/?>/g'"
 124                             +   r" -e 's/\$$projectname/Overview/g'"
 125                             +   r" -e 's/\$$title/Search results/g'"
 126                             +       "> ${TARGET}.tmp",
 127                         'mv ${TARGET}.tmp ${TARGET}' ],
 128                       TEMPLATE = Literal(HEADER
 129                                          + OVERVIEW_EXTRA_HEADER
 130                                          + SEARCH_PHP.replace('<?','[[').replace('?>',']]')
 131                                          + FOOTER),
 132                       TITLE = "Search results"))
 133 env.Alias('all_docs',
 134           env.Command('search_paths.php', None, writeTemplate,
 135                       TEMPLATE = Literal(SEARCH_PATHS_PHP)))