dirkbaechle avatar dirkbaechle committed 38bc0d2 Draft

- improved PDF output for generated variablelists

Comments (0)

Files changed (3)

bin/scons-proc.py

             
             ve = stf.newNode("varlistentry")
             stf.setAttribute(ve, 'id', '%s%s' % (v.prefix, v.idfunc()))
-            stf.appendNode(ve, v.xml_term())
+            for t in v.xml_terms():
+                stf.appendNode(ve, t)
             vl = stf.newNode("listitem")
             added = False
             if v.summary is not None:
     def idfunc(self):
         return self.name
     
-    def xml_term(self):
+    def xml_terms(self):
         e = stf.newNode("term")
         stf.setText(e, self.name)
-        return e
+        return [e]
 
 class Builder(SConsThing):
     description = 'builder'
     prefix = 'b-'
     tag = 'function'
     
-    def xml_term(self):
-        t = stf.newNode("term")
-        s = stf.newNode("synopsis")
+    def xml_terms(self):
+        ta = stf.newNode("term")
         b = stf.newNode(self.tag)
         stf.setText(b, self.name+'()')
-        stf.appendNode(s, b)
-        stf.appendNode(t, s)
-        s = stf.newNode("synopsis")
+        stf.appendNode(ta, b)
+        tb = stf.newNode("term")
         b = stf.newNode(self.tag)
         stf.setText(b, 'env.'+self.name+'()')
-        stf.appendNode(s, b)
-        stf.appendNode(t, s)
-        return t
+        stf.appendNode(tb, b)
+        return [ta, tb]
             
     def entityfunc(self):
         return self.name

doc/generated/builders.gen

 <variablelist xmlns="http://www.scons.org/dbxsd/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0/scons.xsd scons.xsd">
   <varlistentry id="b-CFile">
     <term>
-      <synopsis>
-        <function>CFile()</function>
-      </synopsis>
-      <synopsis>
-        <function>env.CFile()</function>
-      </synopsis>
+      <function>CFile()</function>
+    </term>
+    <term>
+      <function>env.CFile()</function>
     </term>
     <listitem>
 <para xmlns="http://www.scons.org/dbxsd/v1.0">
   </varlistentry>
   <varlistentry id="b-Command">
     <term>
-      <synopsis>
-        <function>Command()</function>
-      </synopsis>
-      <synopsis>
-        <function>env.Command()</function>
-      </synopsis>
+      <function>Command()</function>
+    </term>
+    <term>
+      <function>env.Command()</function>
     </term>
     <listitem>
 <para xmlns="http://www.scons.org/dbxsd/v1.0">
   </varlistentry>
   <varlistentry id="b-CXXFile">
     <term>
-      <synopsis>
-        <function>CXXFile()</function>
-      </synopsis>
-      <synopsis>
-        <function>env.CXXFile()</function>
-      </synopsis>
+      <function>CXXFile()</function>
+    </term>
+    <term>
+      <function>env.CXXFile()</function>
     </term>
     <listitem>
 <para xmlns="http://www.scons.org/dbxsd/v1.0">
   </varlistentry>
   <varlistentry id="b-DVI">
     <term>
-      <synopsis>
-        <function>DVI()</function>
-      </synopsis>
-      <synopsis>
-        <function>env.DVI()</function>
-      </synopsis>
+      <function>DVI()</function>
+    </term>
+    <term>
+      <function>env.DVI()</function>
     </term>
     <listitem>
 <para xmlns="http://www.scons.org/dbxsd/v1.0">
   </varlistentry>
   <varlistentry id="b-Install">
     <term>
-      <synopsis>
-        <function>Install()</function>
-      </synopsis>
-      <synopsis>
-        <function>env.Install()</function>
-      </synopsis>
+      <function>Install()</function>
+    </term>
+    <term>
+      <function>env.Install()</function>
     </term>
     <listitem>
 <para xmlns="http://www.scons.org/dbxsd/v1.0">
   </varlistentry>
   <varlistentry id="b-InstallAs">
     <term>
-      <synopsis>
-        <function>InstallAs()</function>
-      </synopsis>
-      <synopsis>
-        <function>env.InstallAs()</function>
-      </synopsis>
+      <function>InstallAs()</function>
+    </term>
+    <term>
+      <function>env.InstallAs()</function>
     </term>
     <listitem>
 <para xmlns="http://www.scons.org/dbxsd/v1.0">
   </varlistentry>
   <varlistentry id="b-InstallVersionedLib">
     <term>
-      <synopsis>
-        <function>InstallVersionedLib()</function>
-      </synopsis>
-      <synopsis>
-        <function>env.InstallVersionedLib()</function>
-      </synopsis>
+      <function>InstallVersionedLib()</function>
+    </term>
+    <term>
+      <function>env.InstallVersionedLib()</function>
     </term>
     <listitem>
 <para xmlns="http://www.scons.org/dbxsd/v1.0">
   </varlistentry>
   <varlistentry id="b-Jar">
     <term>
-      <synopsis>
-        <function>Jar()</function>
-      </synopsis>
-      <synopsis>
-        <function>env.Jar()</function>
-      </synopsis>
+      <function>Jar()</function>
+    </term>
+    <term>
+      <function>env.Jar()</function>
     </term>
     <listitem>
 <para xmlns="http://www.scons.org/dbxsd/v1.0">
   </varlistentry>
   <varlistentry id="b-Java">
     <term>
-      <synopsis>
-        <function>Java()</function>
-      </synopsis>
-      <synopsis>
-        <function>env.Java()</function>
-      </synopsis>
+      <function>Java()</function>
+    </term>
+    <term>
+      <function>env.Java()</function>
     </term>
     <listitem>
 <para xmlns="http://www.scons.org/dbxsd/v1.0">
   </varlistentry>
   <varlistentry id="b-JavaH">
     <term>
-      <synopsis>
-        <function>JavaH()</function>
-      </synopsis>
-      <synopsis>
-        <function>env.JavaH()</function>
-      </synopsis>
+      <function>JavaH()</function>
+    </term>
+    <term>
+      <function>env.JavaH()</function>
     </term>
     <listitem>
 <para xmlns="http://www.scons.org/dbxsd/v1.0">
   </varlistentry>
   <varlistentry id="b-Library">
     <term>
-      <synopsis>
-        <function>Library()</function>
-      </synopsis>
-      <synopsis>
-        <function>env.Library()</function>
-      </synopsis>
+      <function>Library()</function>
+    </term>
+    <term>
+      <function>env.Library()</function>
     </term>
     <listitem>
 <para xmlns="http://www.scons.org/dbxsd/v1.0">
   </varlistentry>
   <varlistentry id="b-LoadableModule">
     <term>
-      <synopsis>
-        <function>LoadableModule()</function>
-      </synopsis>
-      <synopsis>
-        <function>env.LoadableModule()</function>
-      </synopsis>
+      <function>LoadableModule()</function>
+    </term>
+    <term>
+      <function>env.LoadableModule()</function>
     </term>
     <listitem>
 <para xmlns="http://www.scons.org/dbxsd/v1.0">
   </varlistentry>
   <varlistentry id="b-M4">
     <term>
-      <synopsis>
-        <function>M4()</function>
-      </synopsis>
-      <synopsis>
-        <function>env.M4()</function>
-      </synopsis>
+      <function>M4()</function>
+    </term>
+    <term>
+      <function>env.M4()</function>
     </term>
     <listitem>
 <para xmlns="http://www.scons.org/dbxsd/v1.0">
   </varlistentry>
   <varlistentry id="b-Moc">
     <term>
-      <synopsis>
-        <function>Moc()</function>
-      </synopsis>
-      <synopsis>
-        <function>env.Moc()</function>
-      </synopsis>
+      <function>Moc()</function>
+    </term>
+    <term>
+      <function>env.Moc()</function>
     </term>
     <listitem>
 <para xmlns="http://www.scons.org/dbxsd/v1.0">
   </varlistentry>
   <varlistentry id="b-MOFiles">
     <term>
-      <synopsis>
-        <function>MOFiles()</function>
-      </synopsis>
-      <synopsis>
-        <function>env.MOFiles()</function>
-      </synopsis>
+      <function>MOFiles()</function>
+    </term>
+    <term>
+      <function>env.MOFiles()</function>
     </term>
     <listitem>
 <para xmlns="http://www.scons.org/dbxsd/v1.0">
   </varlistentry>
   <varlistentry id="b-MSVSProject">
     <term>
-      <synopsis>
-        <function>MSVSProject()</function>
-      </synopsis>
-      <synopsis>
-        <function>env.MSVSProject()</function>
-      </synopsis>
+      <function>MSVSProject()</function>
+    </term>
+    <term>
+      <function>env.MSVSProject()</function>
     </term>
     <listitem>
 <para xmlns="http://www.scons.org/dbxsd/v1.0">
   </varlistentry>
   <varlistentry id="b-MSVSSolution">
     <term>
-      <synopsis>
-        <function>MSVSSolution()</function>
-      </synopsis>
-      <synopsis>
-        <function>env.MSVSSolution()</function>
-      </synopsis>
+      <function>MSVSSolution()</function>
+    </term>
+    <term>
+      <function>env.MSVSSolution()</function>
     </term>
     <listitem>
 <para xmlns="http://www.scons.org/dbxsd/v1.0">
   </varlistentry>
   <varlistentry id="b-Object">
     <term>
-      <synopsis>
-        <function>Object()</function>
-      </synopsis>
-      <synopsis>
-        <function>env.Object()</function>
-      </synopsis>
+      <function>Object()</function>
+    </term>
+    <term>
+      <function>env.Object()</function>
     </term>
     <listitem>
 <para xmlns="http://www.scons.org/dbxsd/v1.0">
   </varlistentry>
   <varlistentry id="b-Package">
     <term>
-      <synopsis>
-        <function>Package()</function>
-      </synopsis>
-      <synopsis>
-        <function>env.Package()</function>
-      </synopsis>
+      <function>Package()</function>
+    </term>
+    <term>
+      <function>env.Package()</function>
     </term>
     <listitem>
 <para xmlns="http://www.scons.org/dbxsd/v1.0">
   </varlistentry>
   <varlistentry id="b-PCH">
     <term>
-      <synopsis>
-        <function>PCH()</function>
-      </synopsis>
-      <synopsis>
-        <function>env.PCH()</function>
-      </synopsis>
+      <function>PCH()</function>
+    </term>
+    <term>
+      <function>env.PCH()</function>
     </term>
     <listitem>
 <para xmlns="http://www.scons.org/dbxsd/v1.0">
   </varlistentry>
   <varlistentry id="b-PDF">
     <term>
-      <synopsis>
-        <function>PDF()</function>
-      </synopsis>
-      <synopsis>
-        <function>env.PDF()</function>
-      </synopsis>
+      <function>PDF()</function>
+    </term>
+    <term>
+      <function>env.PDF()</function>
     </term>
     <listitem>
 <para xmlns="http://www.scons.org/dbxsd/v1.0">
   </varlistentry>
   <varlistentry id="b-POInit">
     <term>
-      <synopsis>
-        <function>POInit()</function>
-      </synopsis>
-      <synopsis>
-        <function>env.POInit()</function>
-      </synopsis>
+      <function>POInit()</function>
+    </term>
+    <term>
+      <function>env.POInit()</function>
     </term>
     <listitem>
 <para xmlns="http://www.scons.org/dbxsd/v1.0">
   </varlistentry>
   <varlistentry id="b-PostScript">
     <term>
-      <synopsis>
-        <function>PostScript()</function>
-      </synopsis>
-      <synopsis>
-        <function>env.PostScript()</function>
-      </synopsis>
+      <function>PostScript()</function>
+    </term>
+    <term>
+      <function>env.PostScript()</function>
     </term>
     <listitem>
 <para xmlns="http://www.scons.org/dbxsd/v1.0">
   </varlistentry>
   <varlistentry id="b-POTUpdate">
     <term>
-      <synopsis>
-        <function>POTUpdate()</function>
-      </synopsis>
-      <synopsis>
-        <function>env.POTUpdate()</function>
-      </synopsis>
+      <function>POTUpdate()</function>
+    </term>
+    <term>
+      <function>env.POTUpdate()</function>
     </term>
     <listitem>
 <para xmlns="http://www.scons.org/dbxsd/v1.0">
   </varlistentry>
   <varlistentry id="b-POUpdate">
     <term>
-      <synopsis>
-        <function>POUpdate()</function>
-      </synopsis>
-      <synopsis>
-        <function>env.POUpdate()</function>
-      </synopsis>
+      <function>POUpdate()</function>
+    </term>
+    <term>
+      <function>env.POUpdate()</function>
     </term>
     <listitem>
 <para xmlns="http://www.scons.org/dbxsd/v1.0">
   </varlistentry>
   <varlistentry id="b-Program">
     <term>
-      <synopsis>
-        <function>Program()</function>
-      </synopsis>
-      <synopsis>
-        <function>env.Program()</function>
-      </synopsis>
+      <function>Program()</function>
+    </term>
+    <term>
+      <function>env.Program()</function>
     </term>
     <listitem>
 <para xmlns="http://www.scons.org/dbxsd/v1.0">
   </varlistentry>
   <varlistentry id="b-RES">
     <term>
-      <synopsis>
-        <function>RES()</function>
-      </synopsis>
-      <synopsis>
-        <function>env.RES()</function>
-      </synopsis>
+      <function>RES()</function>
+    </term>
+    <term>
+      <function>env.RES()</function>
     </term>
     <listitem>
 <para xmlns="http://www.scons.org/dbxsd/v1.0">
   </varlistentry>
   <varlistentry id="b-RMIC">
     <term>
-      <synopsis>
-        <function>RMIC()</function>
-      </synopsis>
-      <synopsis>
-        <function>env.RMIC()</function>
-      </synopsis>
+      <function>RMIC()</function>
+    </term>
+    <term>
+      <function>env.RMIC()</function>
     </term>
     <listitem>
 <para xmlns="http://www.scons.org/dbxsd/v1.0">
   </varlistentry>
   <varlistentry id="b-RPCGenClient">
     <term>
-      <synopsis>
-        <function>RPCGenClient()</function>
-      </synopsis>
-      <synopsis>
-        <function>env.RPCGenClient()</function>
-      </synopsis>
+      <function>RPCGenClient()</function>
+    </term>
+    <term>
+      <function>env.RPCGenClient()</function>
     </term>
     <listitem>
 <para xmlns="http://www.scons.org/dbxsd/v1.0">
   </varlistentry>
   <varlistentry id="b-RPCGenHeader">
     <term>
-      <synopsis>
-        <function>RPCGenHeader()</function>
-      </synopsis>
-      <synopsis>
-        <function>env.RPCGenHeader()</function>
-      </synopsis>
+      <function>RPCGenHeader()</function>
+    </term>
+    <term>
+      <function>env.RPCGenHeader()</function>
     </term>
     <listitem>
 <para xmlns="http://www.scons.org/dbxsd/v1.0">
   </varlistentry>
   <varlistentry id="b-RPCGenService">
     <term>
-      <synopsis>
-        <function>RPCGenService()</function>
-      </synopsis>
-      <synopsis>
-        <function>env.RPCGenService()</function>
-      </synopsis>
+      <function>RPCGenService()</function>
+    </term>
+    <term>
+      <function>env.RPCGenService()</function>
     </term>
     <listitem>
 <para xmlns="http://www.scons.org/dbxsd/v1.0">
   </varlistentry>
   <varlistentry id="b-RPCGenXDR">
     <term>
-      <synopsis>
-        <function>RPCGenXDR()</function>
-      </synopsis>
-      <synopsis>
-        <function>env.RPCGenXDR()</function>
-      </synopsis>
+      <function>RPCGenXDR()</function>
+    </term>
+    <term>
+      <function>env.RPCGenXDR()</function>
     </term>
     <listitem>
 <para xmlns="http://www.scons.org/dbxsd/v1.0">
   </varlistentry>
   <varlistentry id="b-SharedLibrary">
     <term>
-      <synopsis>
-        <function>SharedLibrary()</function>
-      </synopsis>
-      <synopsis>
-        <function>env.SharedLibrary()</function>
-      </synopsis>
+      <function>SharedLibrary()</function>
+    </term>
+    <term>
+      <function>env.SharedLibrary()</function>
     </term>
     <listitem>
 <para xmlns="http://www.scons.org/dbxsd/v1.0">
   </varlistentry>
   <varlistentry id="b-SharedObject">
     <term>
-      <synopsis>
-        <function>SharedObject()</function>
-      </synopsis>
-      <synopsis>
-        <function>env.SharedObject()</function>
-      </synopsis>
+      <function>SharedObject()</function>
+    </term>
+    <term>
+      <function>env.SharedObject()</function>
     </term>
     <listitem>
 <para xmlns="http://www.scons.org/dbxsd/v1.0">
   </varlistentry>
   <varlistentry id="b-StaticLibrary">
     <term>
-      <synopsis>
-        <function>StaticLibrary()</function>
-      </synopsis>
-      <synopsis>
-        <function>env.StaticLibrary()</function>
-      </synopsis>
+      <function>StaticLibrary()</function>
+    </term>
+    <term>
+      <function>env.StaticLibrary()</function>
     </term>
     <listitem>
 <para xmlns="http://www.scons.org/dbxsd/v1.0">
   </varlistentry>
   <varlistentry id="b-StaticObject">
     <term>
-      <synopsis>
-        <function>StaticObject()</function>
-      </synopsis>
-      <synopsis>
-        <function>env.StaticObject()</function>
-      </synopsis>
+      <function>StaticObject()</function>
+    </term>
+    <term>
+      <function>env.StaticObject()</function>
     </term>
     <listitem>
 <para xmlns="http://www.scons.org/dbxsd/v1.0">
   </varlistentry>
   <varlistentry id="b-Substfile">
     <term>
-      <synopsis>
-        <function>Substfile()</function>
-      </synopsis>
-      <synopsis>
-        <function>env.Substfile()</function>
-      </synopsis>
+      <function>Substfile()</function>
+    </term>
+    <term>
+      <function>env.Substfile()</function>
     </term>
     <listitem>
 <para xmlns="http://www.scons.org/dbxsd/v1.0">
   </varlistentry>
   <varlistentry id="b-Tar">
     <term>
-      <synopsis>
-        <function>Tar()</function>
-      </synopsis>
-      <synopsis>
-        <function>env.Tar()</function>
-      </synopsis>
+      <function>Tar()</function>
+    </term>
+    <term>
+      <function>env.Tar()</function>
     </term>
     <listitem>
 <para xmlns="http://www.scons.org/dbxsd/v1.0">
   </varlistentry>
   <varlistentry id="b-Textfile">
     <term>
-      <synopsis>
-        <function>Textfile()</function>
-      </synopsis>
-      <synopsis>
-        <function>env.Textfile()</function>
-      </synopsis>
+      <function>Textfile()</function>
+    </term>
+    <term>
+      <function>env.Textfile()</function>
     </term>
     <listitem>
 <para xmlns="http://www.scons.org/dbxsd/v1.0">
   </varlistentry>
   <varlistentry id="b-Translate">
     <term>
-      <synopsis>
-        <function>Translate()</function>
-      </synopsis>
-      <synopsis>
-        <function>env.Translate()</function>
-      </synopsis>
+      <function>Translate()</function>
+    </term>
+    <term>
+      <function>env.Translate()</function>
     </term>
     <listitem>
 <para xmlns="http://www.scons.org/dbxsd/v1.0">
   </varlistentry>
   <varlistentry id="b-TypeLibrary">
     <term>
-      <synopsis>
-        <function>TypeLibrary()</function>
-      </synopsis>
-      <synopsis>
-        <function>env.TypeLibrary()</function>
-      </synopsis>
+      <function>TypeLibrary()</function>
+    </term>
+    <term>
+      <function>env.TypeLibrary()</function>
     </term>
     <listitem>
 <para xmlns="http://www.scons.org/dbxsd/v1.0">
   </varlistentry>
   <varlistentry id="b-Uic">
     <term>
-      <synopsis>
-        <function>Uic()</function>
-      </synopsis>
-      <synopsis>
-        <function>env.Uic()</function>
-      </synopsis>
+      <function>Uic()</function>
+    </term>
+    <term>
+      <function>env.Uic()</function>
     </term>
     <listitem>
 <para xmlns="http://www.scons.org/dbxsd/v1.0">
   </varlistentry>
   <varlistentry id="b-Zip">
     <term>
-      <synopsis>
-        <function>Zip()</function>
-      </synopsis>
-      <synopsis>
-        <function>env.Zip()</function>
-      </synopsis>
+      <function>Zip()</function>
+    </term>
+    <term>
+      <function>env.Zip()</function>
     </term>
     <listitem>
 <para xmlns="http://www.scons.org/dbxsd/v1.0">
 <xsl:param name="paper.type" select="'letter'"></xsl:param>
 <xsl:param name="body.start.indent">0pt</xsl:param>
 <xsl:param name="shade.verbatim" select="1"></xsl:param>
+<xsl:param name="variablelist.term.break.after" select="1"></xsl:param>
+
 <xsl:param name="generate.toc">
 /appendix toc,title
 article/appendix  nop
 set       toc,title
 </xsl:param>
 
-<xsl:template match="varlistentry/term">
-	<xsl:call-template name="inline.boldseq"/>
+<xsl:attribute-set name="variablelist.term.properties">
+  <xsl:attribute name="font-weight">bold</xsl:attribute>
+</xsl:attribute-set>
+
+<xsl:template match="variablelist">
+  <xsl:variable name="presentation">
+    <xsl:call-template name="pi.dbfo_list-presentation"/>
+  </xsl:variable>
+  <xsl:apply-templates select="." mode="vl.as.blocks"/>
 </xsl:template>
 
 </xsl:stylesheet> 
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.