diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/editor_configs/xmlmind/addon/config/scons/common.incl | 4 | ||||
| -rw-r--r-- | doc/generated/builders.gen | 430 | ||||
| -rw-r--r-- | doc/images/overview.graphml | 418 | ||||
| -rw-r--r-- | doc/overview.rst | 174 | ||||
| -rw-r--r-- | doc/user/pdf.xsl | 13 |
5 files changed, 778 insertions, 261 deletions
diff --git a/doc/editor_configs/xmlmind/addon/config/scons/common.incl b/doc/editor_configs/xmlmind/addon/config/scons/common.incl index eafa0a4..d03f74c 100644 --- a/doc/editor_configs/xmlmind/addon/config/scons/common.incl +++ b/doc/editor_configs/xmlmind/addon/config/scons/common.incl @@ -11,7 +11,9 @@ <cfg:preserveSpace xmlns="" elements="address funcsynopsisinfo classsynopsisinfo - literallayout programlisting screen synopsis" /> + literallayout programlisting screen synopsis + sconstruct scons_example_file example_commands + scons_output_command file directory" /> <cfg:documentResources xmlns=""> <cfg:resource path="//@fileref" /> diff --git a/doc/generated/builders.gen b/doc/generated/builders.gen index 2b033e4..0e3073e 100644 --- a/doc/generated/builders.gen +++ b/doc/generated/builders.gen @@ -15,12 +15,10 @@ <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"> @@ -43,12 +41,10 @@ env.CFile(target = 'bar', source = 'bar.y') </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"> @@ -63,12 +59,10 @@ for the calling syntax and details. </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"> @@ -92,12 +86,10 @@ env.CXXFile(target = 'bar', source = 'bar.yy') </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"> @@ -153,12 +145,10 @@ env.DVI(target = 'ccc.dvi', source = 'ccc.latex') </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"> @@ -178,12 +168,10 @@ env.Install('/usr/local/bin', source = ['foo', 'bar']) </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"> @@ -201,12 +189,10 @@ arguments list different numbers of files or directories. </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"> @@ -226,12 +212,10 @@ env.InstallAs(target = ['../lib/libfoo.a', '../lib/libbar.a'], </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"> @@ -277,12 +261,10 @@ env.Jar(target = 'bar.jar', </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"> @@ -357,12 +339,10 @@ env['ENV']['LANG'] = 'en_GB.UTF-8' </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"> @@ -415,12 +395,10 @@ env.JavaH(target = 'export', </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"> @@ -432,12 +410,10 @@ builder method. </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"> @@ -451,12 +427,10 @@ this creates a loadable module bundle. </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"> @@ -476,12 +450,10 @@ env.M4(target = 'foo.c', source = 'foo.c.m4') </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"> @@ -499,12 +471,10 @@ env.Moc('foo.cpp') # generates foo.moc </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"> @@ -556,12 +526,10 @@ Compile files for languages defined in <filename>LINGUAS</filename> file </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"> @@ -739,12 +707,10 @@ env.MSVSProject(target = 'Bar' + env['MSVSPROJECTSUFFIX'], </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"> @@ -813,12 +779,10 @@ env.MSVSSolution(target = 'Bar' + env['MSVSSOLUTIONSUFFIX'], </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"> @@ -830,12 +794,10 @@ builder method. </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"> @@ -905,12 +867,10 @@ env.Package( NAME = 'foo', </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"> @@ -932,12 +892,10 @@ env['PCH'] = env.PCH('StdAfx.cpp')[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"> @@ -963,12 +921,10 @@ env.PDF(target = 'bbb', source = 'bbb.dvi') </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"> @@ -1071,12 +1027,10 @@ which has same efect as: </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"> @@ -1102,12 +1056,10 @@ env.PostScript(target = 'bbb', source = 'bbb.dvi') </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"> @@ -1274,12 +1226,10 @@ then the <filename>messages.pot</filename> will contain </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"> @@ -1393,12 +1343,10 @@ pre-configured via environment. </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"> @@ -1429,12 +1377,10 @@ env.Program(target = 'foo', source = ['foo.o', 'bar.c', 'baz.f']) </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"> @@ -1457,12 +1403,10 @@ env.RES('resource.rc') </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"> @@ -1506,12 +1450,10 @@ env.RMIC(target = 'outdir3', </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"> @@ -1531,12 +1473,10 @@ env.RPCGenClient('src/rpcif.x') </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"> @@ -1556,12 +1496,10 @@ env.RPCGenHeader('src/rpcif.x') </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"> @@ -1581,12 +1519,10 @@ env.RPCGenClient('src/rpcif.x') </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"> @@ -1606,12 +1542,10 @@ env.RPCGenClient('src/rpcif.x') </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"> @@ -1716,12 +1650,10 @@ when it is done linking it. </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"> @@ -1770,12 +1702,10 @@ below, for more information. </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"> @@ -1816,12 +1746,10 @@ will raise an error if there is any mismatch. </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"> @@ -1890,12 +1818,10 @@ below, for more information. </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"> @@ -1985,12 +1911,10 @@ subst.Substfile('pgm2.c', [Value('#include "@foo@.h"'), </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"> @@ -2033,12 +1957,10 @@ env.Tar('foo') </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"> @@ -2106,12 +2028,10 @@ blob.txt </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"> @@ -2246,12 +2166,10 @@ running <command>scons '.'</command>.</para></note> </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"> @@ -2280,12 +2198,10 @@ files. </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"> @@ -2311,12 +2227,10 @@ env.Uic(target = Split('include/foo.h gen/uicfoo.cc gen/mocfoo.cc'), </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"> diff --git a/doc/images/overview.graphml b/doc/images/overview.graphml new file mode 100644 index 0000000..74f80d7 --- /dev/null +++ b/doc/images/overview.graphml @@ -0,0 +1,418 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<graphml xmlns="http://graphml.graphdrawing.org/xmlns" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:y="http://www.yworks.com/xml/graphml" xmlns:yed="http://www.yworks.com/xml/yed/3" xsi:schemaLocation="http://graphml.graphdrawing.org/xmlns http://www.yworks.com/xml/schema/graphml/1.1/ygraphml.xsd"> + <!--Created by yFiles for Java 2.9--> + <key for="graphml" id="d0" yfiles.type="resources"/> + <key for="port" id="d1" yfiles.type="portgraphics"/> + <key for="port" id="d2" yfiles.type="portgeometry"/> + <key for="port" id="d3" yfiles.type="portuserdata"/> + <key attr.name="url" attr.type="string" for="node" id="d4"/> + <key attr.name="description" attr.type="string" for="node" id="d5"/> + <key for="node" id="d6" yfiles.type="nodegraphics"/> + <key attr.name="Beschreibung" attr.type="string" for="graph" id="d7"/> + <key attr.name="url" attr.type="string" for="edge" id="d8"/> + <key attr.name="description" attr.type="string" for="edge" id="d9"/> + <key for="edge" id="d10" yfiles.type="edgegraphics"/> + <graph edgedefault="directed" id="G"> + <data key="d7"/> + <node id="n0" yfiles.foldertype="group"> + <data key="d4"/> + <data key="d6"> + <y:ProxyAutoBoundsNode> + <y:Realizers active="0"> + <y:GroupNode> + <y:Geometry height="269.01233212809916" width="204.95703125" x="100.521484375" y="53.0390625"/> + <y:Fill color="#F5F5F5" transparent="false"/> + <y:BorderStyle color="#000000" type="dashed" width="1.0"/> + <y:NodeLabel alignment="right" autoSizePolicy="node_width" backgroundColor="#EBEBEB" borderDistance="0.0" fontFamily="Dialog" fontSize="15" fontStyle="plain" hasLineColor="false" height="21.4609375" modelName="internal" modelPosition="t" textColor="#000000" visible="true" width="204.95703125" x="0.0" y="0.0">User's view</y:NodeLabel> + <y:Shape type="roundrectangle"/> + <y:State closed="false" closedHeight="50.0" closedWidth="50.0" innerGraphDisplayEnabled="false"/> + <y:Insets bottom="15" bottomF="15.0" left="15" leftF="15.0" right="15" rightF="15.0" top="15" topF="15.0"/> + <y:BorderInsets bottom="0" bottomF="0.0" left="0" leftF="0.0" right="0" rightF="0.0" top="3" topF="3.0"/> + </y:GroupNode> + <y:GroupNode> + <y:Geometry height="50.0" width="50.0" x="0.0" y="60.0"/> + <y:Fill color="#F5F5F5" transparent="false"/> + <y:BorderStyle color="#000000" type="dashed" width="1.0"/> + <y:NodeLabel alignment="right" autoSizePolicy="node_width" backgroundColor="#EBEBEB" borderDistance="0.0" fontFamily="Dialog" fontSize="15" fontStyle="plain" hasLineColor="false" height="21.4609375" modelName="internal" modelPosition="t" textColor="#000000" visible="true" width="65.201171875" x="-7.6005859375" y="0.0">Folder 1</y:NodeLabel> + <y:Shape type="roundrectangle"/> + <y:State closed="true" closedHeight="50.0" closedWidth="50.0" innerGraphDisplayEnabled="false"/> + <y:Insets bottom="5" bottomF="5.0" left="5" leftF="5.0" right="5" rightF="5.0" top="5" topF="5.0"/> + <y:BorderInsets bottom="0" bottomF="0.0" left="0" leftF="0.0" right="0" rightF="0.0" top="0" topF="0.0"/> + </y:GroupNode> + </y:Realizers> + </y:ProxyAutoBoundsNode> + </data> + <graph edgedefault="directed" id="n0:"> + <node id="n0::n0"> + <data key="d6"> + <y:ShapeNode> + <y:Geometry height="30.0" width="174.95703125" x="115.521484375" y="185.05694731404958"/> + <y:Fill color="#FFCC00" transparent="false"/> + <y:BorderStyle color="#000000" type="line" width="1.0"/> + <y:NodeLabel alignment="center" autoSizePolicy="content" fontFamily="Dialog" fontSize="12" fontStyle="plain" hasBackgroundColor="false" hasLineColor="false" height="17.96875" modelName="custom" textColor="#000000" visible="true" width="164.95703125" x="5.0" y="6.015625">XML files (src/user/man/...)<y:LabelModel> + <y:SmartNodeLabelModel distance="4.0"/> + </y:LabelModel> + <y:ModelParameter> + <y:SmartNodeLabelModelParameter labelRatioX="0.0" labelRatioY="0.0" nodeRatioX="0.0" nodeRatioY="0.0" offsetX="0.0" offsetY="0.0" upX="0.0" upY="-1.0"/> + </y:ModelParameter> + </y:NodeLabel> + <y:Shape type="rectangle"/> + </y:ShapeNode> + </data> + </node> + <node id="n0::n1"> + <data key="d6"> + <y:ShapeNode> + <y:Geometry height="41.9375" width="158.357421875" x="123.8212890625" y="265.11389462809916"/> + <y:Fill color="#FFCC00" transparent="false"/> + <y:BorderStyle color="#000000" type="line" width="1.0"/> + <y:NodeLabel alignment="center" autoSizePolicy="content" fontFamily="Dialog" fontSize="12" fontStyle="plain" hasBackgroundColor="false" hasLineColor="false" height="17.96875" modelName="custom" textColor="#000000" visible="true" width="92.154296875" x="33.1015625" y="11.984375">XML validation<y:LabelModel> + <y:SmartNodeLabelModel distance="4.0"/> + </y:LabelModel> + <y:ModelParameter> + <y:SmartNodeLabelModelParameter labelRatioX="0.0" labelRatioY="0.0" nodeRatioX="0.0" nodeRatioY="0.0" offsetX="0.0" offsetY="0.0" upX="0.0" upY="-1.0"/> + </y:ModelParameter> + </y:NodeLabel> + <y:Shape type="rectangle"/> + </y:ShapeNode> + </data> + </node> + <node id="n0::n2"> + <data key="d6"> + <y:SVGNode> + <y:Geometry height="52.0" width="51.154296875" x="177.4228515625" y="92.5"/> + <y:Fill color="#CCCCFF" transparent="false"/> + <y:BorderStyle color="#000000" type="line" width="1.0"/> + <y:NodeLabel alignment="center" autoSizePolicy="content" fontFamily="Dialog" fontSize="12" fontStyle="plain" hasBackgroundColor="false" hasLineColor="false" height="17.96875" modelName="custom" textColor="#000000" visible="true" width="41.154296875" x="42.63675428695848" y="20.570887005532427">Writer<y:LabelModel> + <y:SmartNodeLabelModel distance="4.0"/> + </y:LabelModel> + <y:ModelParameter> + <y:SmartNodeLabelModelParameter labelRatioX="-0.2930339421443093" labelRatioY="0.5" nodeRatioX="0.5" nodeRatioY="0.24114686549100794" offsetX="0.0" offsetY="0.0" upX="0.0" upY="-1.0"/> + </y:ModelParameter> + </y:NodeLabel> + <y:SVGNodeProperties usingVisualBounds="true"/> + <y:SVGModel svgBoundsPolicy="0"> + <y:SVGContent refid="1"/> + </y:SVGModel> + </y:SVGNode> + </data> + </node> + </graph> + </node> + <node id="n1"> + <data key="d6"> + <y:ShapeNode> + <y:Geometry height="41.9375" width="225.341796875" x="90.3291015625" y="339.03125"/> + <y:Fill color="#FFCC00" transparent="false"/> + <y:BorderStyle color="#000000" type="line" width="1.0"/> + <y:NodeLabel alignment="center" autoSizePolicy="content" fontFamily="Dialog" fontSize="12" fontStyle="plain" hasBackgroundColor="false" hasLineColor="false" height="17.96875" modelName="custom" textColor="#000000" visible="true" width="121.650390625" x="51.845703125" y="11.984375">Creating entity lists +<y:LabelModel> + <y:SmartNodeLabelModel distance="4.0"/> + </y:LabelModel> + <y:ModelParameter> + <y:SmartNodeLabelModelParameter labelRatioX="0.0" labelRatioY="0.0" nodeRatioX="0.0" nodeRatioY="0.0" offsetX="0.0" offsetY="0.0" upX="0.0" upY="-1.0"/> + </y:ModelParameter> + </y:NodeLabel> + <y:Shape type="rectangle"/> + </y:ShapeNode> + </data> + </node> + <node id="n2"> + <data key="d6"> + <y:ShapeNode> + <y:Geometry height="41.9375" width="134.7734375" x="382.61328125" y="339.03125"/> + <y:Fill color="#FFCC00" transparent="false"/> + <y:BorderStyle color="#000000" type="line" width="1.0"/> + <y:NodeLabel alignment="center" autoSizePolicy="content" fontFamily="Dialog" fontSize="12" fontStyle="plain" hasBackgroundColor="false" hasLineColor="false" height="31.9375" modelName="custom" textColor="#000000" visible="true" width="124.7734375" x="5.0" y="5.0">Check that example +names are unique<y:LabelModel> + <y:SmartNodeLabelModel distance="4.0"/> + </y:LabelModel> + <y:ModelParameter> + <y:SmartNodeLabelModelParameter labelRatioX="0.0" labelRatioY="0.0" nodeRatioX="0.0" nodeRatioY="0.0" offsetX="0.0" offsetY="0.0" upX="0.0" upY="-1.0"/> + </y:ModelParameter> + </y:NodeLabel> + <y:Shape type="rectangle"/> + </y:ShapeNode> + </data> + </node> + <node id="n3"> + <data key="d6"> + <y:ShapeNode> + <y:Geometry height="41.9375" width="163.35546875" x="368.322265625" y="410.96875"/> + <y:Fill color="#FFCC00" transparent="false"/> + <y:BorderStyle color="#000000" type="line" width="1.0"/> + <y:NodeLabel alignment="center" autoSizePolicy="content" fontFamily="Dialog" fontSize="12" fontStyle="plain" hasBackgroundColor="false" hasLineColor="false" height="17.96875" modelName="custom" textColor="#000000" visible="true" width="149.458984375" x="6.9482421875" y="11.984375">Create example outputs<y:LabelModel> + <y:SmartNodeLabelModel distance="4.0"/> + </y:LabelModel> + <y:ModelParameter> + <y:SmartNodeLabelModelParameter labelRatioX="0.0" labelRatioY="0.0" nodeRatioX="0.0" nodeRatioY="0.0" offsetX="0.0" offsetY="0.0" upX="0.0" upY="-1.0"/> + </y:ModelParameter> + </y:NodeLabel> + <y:Shape type="rectangle"/> + </y:ShapeNode> + </data> + </node> + <node id="n4"> + <data key="d6"> + <y:ShapeNode> + <y:Geometry height="41.9375" width="171.125" x="117.4375" y="410.96875"/> + <y:Fill color="#FFCC00" transparent="false"/> + <y:BorderStyle color="#000000" type="line" width="1.0"/> + <y:NodeLabel alignment="center" autoSizePolicy="content" fontFamily="Dialog" fontSize="12" fontStyle="plain" hasBackgroundColor="false" hasLineColor="false" height="31.9375" modelName="custom" textColor="#000000" visible="true" width="161.125" x="5.0" y="5.0">Resolve XIncludes for text +and examples<y:LabelModel> + <y:SmartNodeLabelModel distance="4.0"/> + </y:LabelModel> + <y:ModelParameter> + <y:SmartNodeLabelModelParameter labelRatioX="0.0" labelRatioY="0.0" nodeRatioX="0.0" nodeRatioY="0.0" offsetX="0.0" offsetY="0.0" upX="0.0" upY="-1.0"/> + </y:ModelParameter> + </y:NodeLabel> + <y:Shape type="rectangle"/> + </y:ShapeNode> + </data> + </node> + <node id="n5"> + <data key="d6"> + <y:ShapeNode> + <y:Geometry height="30.0" width="155.29296875" x="125.353515625" y="497.09375"/> + <y:Fill color="#FFCC00" transparent="false"/> + <y:BorderStyle color="#000000" type="line" width="1.0"/> + <y:NodeLabel alignment="center" autoSizePolicy="content" fontFamily="Dialog" fontSize="12" fontStyle="plain" hasBackgroundColor="false" hasLineColor="false" height="17.96875" modelName="custom" textColor="#000000" visible="true" width="145.29296875" x="5.0" y="6.015625">Create HTML, PDF, Man<y:LabelModel> + <y:SmartNodeLabelModel distance="4.0"/> + </y:LabelModel> + <y:ModelParameter> + <y:SmartNodeLabelModelParameter labelRatioX="0.0" labelRatioY="0.0" nodeRatioX="0.0" nodeRatioY="0.0" offsetX="0.0" offsetY="0.0" upX="0.0" upY="-1.0"/> + </y:ModelParameter> + </y:NodeLabel> + <y:Shape type="rectangle"/> + </y:ShapeNode> + </data> + </node> + <node id="n6"> + <data key="d6"> + <y:ShapeNode> + <y:Geometry height="41.9375" width="144.6171875" x="130.69140625" y="563.21875"/> + <y:Fill color="#FFCC00" transparent="false"/> + <y:BorderStyle color="#000000" type="line" width="1.0"/> + <y:NodeLabel alignment="center" autoSizePolicy="content" fontFamily="Dialog" fontSize="12" fontStyle="plain" hasBackgroundColor="false" hasLineColor="false" height="31.9375" modelName="custom" textColor="#000000" visible="true" width="134.6171875" x="5.0" y="5.0">Install in proper place +for packaging<y:LabelModel> + <y:SmartNodeLabelModel distance="4.0"/> + </y:LabelModel> + <y:ModelParameter> + <y:SmartNodeLabelModelParameter labelRatioX="0.0" labelRatioY="0.0" nodeRatioX="0.0" nodeRatioY="0.0" offsetX="0.0" offsetY="0.0" upX="0.0" upY="-1.0"/> + </y:ModelParameter> + </y:NodeLabel> + <y:Shape type="rectangle"/> + </y:ShapeNode> + </data> + </node> + <node id="n7"> + <data key="d6"> + <y:ShapeNode> + <y:Geometry height="41.9375" width="102.306640625" x="398.8466796875" y="491.125"/> + <y:Fill color="#FFCC00" transparent="false"/> + <y:BorderStyle color="#000000" type="line" width="1.0"/> + <y:NodeLabel alignment="center" autoSizePolicy="content" fontFamily="Dialog" fontSize="12" fontStyle="plain" hasBackgroundColor="false" hasLineColor="false" height="31.9375" modelName="custom" textColor="#000000" visible="true" width="92.306640625" x="5.0" y="5.0">Create API doc +(Epydoc)<y:LabelModel> + <y:SmartNodeLabelModel distance="4.0"/> + </y:LabelModel> + <y:ModelParameter> + <y:SmartNodeLabelModelParameter labelRatioX="0.0" labelRatioY="0.0" nodeRatioX="0.0" nodeRatioY="0.0" offsetX="0.0" offsetY="0.0" upX="0.0" upY="-1.0"/> + </y:ModelParameter> + </y:NodeLabel> + <y:Shape type="rectangle"/> + </y:ShapeNode> + </data> + </node> + <edge id="n0::e0" source="n0::n0" target="n0::n1"> + <data key="d10"> + <y:PolyLineEdge> + <y:Path sx="0.0" sy="0.0" tx="0.0" ty="0.0"/> + <y:LineStyle color="#000000" type="line" width="1.0"/> + <y:Arrows source="none" target="standard"/> + <y:EdgeLabel alignment="center" distance="2.0" fontFamily="Dialog" fontSize="12" fontStyle="plain" hasBackgroundColor="false" hasLineColor="false" height="17.96875" modelName="six_pos" modelPosition="tail" preferredPlacement="anywhere" ratio="0.5" textColor="#000000" visible="true" width="83.318359375" x="2.0" y="16.04410017029312">get validated</y:EdgeLabel> + <y:BendStyle smoothed="false"/> + </y:PolyLineEdge> + </data> + </edge> + <edge id="e0" source="n0::n1" target="n1"> + <data key="d10"> + <y:PolyLineEdge> + <y:Path sx="0.0" sy="0.0" tx="0.0" ty="0.0"/> + <y:LineStyle color="#000000" type="line" width="1.0"/> + <y:Arrows source="none" target="standard"/> + <y:BendStyle smoothed="false"/> + </y:PolyLineEdge> + </data> + </edge> + <edge id="e1" source="n1" target="n4"> + <data key="d10"> + <y:PolyLineEdge> + <y:Path sx="0.0" sy="0.0" tx="0.0" ty="0.0"/> + <y:LineStyle color="#000000" type="line" width="1.0"/> + <y:Arrows source="none" target="standard"/> + <y:BendStyle smoothed="false"/> + </y:PolyLineEdge> + </data> + </edge> + <edge id="e2" source="n1" target="n2"> + <data key="d10"> + <y:PolyLineEdge> + <y:Path sx="0.0" sy="0.0" tx="0.0" ty="0.0"/> + <y:LineStyle color="#000000" type="line" width="1.0"/> + <y:Arrows source="none" target="standard"/> + <y:BendStyle smoothed="false"/> + </y:PolyLineEdge> + </data> + </edge> + <edge id="e3" source="n2" target="n3"> + <data key="d10"> + <y:PolyLineEdge> + <y:Path sx="0.0" sy="0.0" tx="0.0" ty="0.0"/> + <y:LineStyle color="#000000" type="line" width="1.0"/> + <y:Arrows source="none" target="standard"/> + <y:BendStyle smoothed="false"/> + </y:PolyLineEdge> + </data> + </edge> + <edge id="e4" source="n3" target="n4"> + <data key="d10"> + <y:PolyLineEdge> + <y:Path sx="0.0" sy="0.0" tx="0.0" ty="0.0"/> + <y:LineStyle color="#000000" type="line" width="1.0"/> + <y:Arrows source="none" target="standard"/> + <y:BendStyle smoothed="false"/> + </y:PolyLineEdge> + </data> + </edge> + <edge id="e5" source="n5" target="n6"> + <data key="d10"> + <y:PolyLineEdge> + <y:Path sx="0.0" sy="0.0" tx="0.0" ty="0.0"/> + <y:LineStyle color="#000000" type="line" width="1.0"/> + <y:Arrows source="none" target="standard"/> + <y:BendStyle smoothed="false"/> + </y:PolyLineEdge> + </data> + </edge> + <edge id="e6" source="n4" target="n5"> + <data key="d10"> + <y:PolyLineEdge> + <y:Path sx="0.0" sy="0.0" tx="0.0" ty="0.0"/> + <y:LineStyle color="#000000" type="line" width="1.0"/> + <y:Arrows source="none" target="standard"/> + <y:EdgeLabel alignment="center" distance="2.0" fontFamily="Dialog" fontSize="12" fontStyle="plain" hasBackgroundColor="false" hasLineColor="false" height="17.96875" modelName="six_pos" modelPosition="tail" preferredPlacement="anywhere" ratio="0.5" textColor="#000000" visible="true" width="132.970703125" x="2.0" y="13.109375">switching to Docbook</y:EdgeLabel> + <y:BendStyle smoothed="false"/> + </y:PolyLineEdge> + </data> + </edge> + <edge id="e7" source="n5" target="n7"> + <data key="d10"> + <y:PolyLineEdge> + <y:Path sx="0.0" sy="0.0" tx="0.0" ty="0.0"/> + <y:LineStyle color="#000000" type="line" width="1.0"/> + <y:Arrows source="none" target="standard"/> + <y:BendStyle smoothed="false"/> + </y:PolyLineEdge> + </data> + </edge> + <edge id="e8" source="n7" target="n6"> + <data key="d10"> + <y:PolyLineEdge> + <y:Path sx="0.0" sy="0.0" tx="0.0" ty="0.0"> + <y:Point x="450.0" y="584.1875"/> + </y:Path> + <y:LineStyle color="#000000" type="line" width="1.0"/> + <y:Arrows source="none" target="standard"/> + <y:BendStyle smoothed="false"/> + </y:PolyLineEdge> + </data> + </edge> + <edge id="n0::e1" source="n0::n2" target="n0::n0"> + <data key="d10"> + <y:PolyLineEdge> + <y:Path sx="0.0" sy="0.0" tx="0.0" ty="0.0"/> + <y:LineStyle color="#000000" type="line" width="1.0"/> + <y:Arrows source="none" target="standard"/> + <y:EdgeLabel alignment="center" distance="2.0" fontFamily="Dialog" fontSize="12" fontStyle="plain" hasBackgroundColor="false" hasLineColor="false" height="17.96875" modelName="six_pos" modelPosition="tail" preferredPlacement="anywhere" ratio="0.5" textColor="#000000" visible="true" width="81.94140625" x="2.0" y="11.289856713665415">edits/creates</y:EdgeLabel> + <y:BendStyle smoothed="false"/> + </y:PolyLineEdge> + </data> + </edge> + </graph> + <data key="d0"> + <y:Resources> + <y:Resource id="1"><?xml version="1.0" encoding="utf-8"?> +<!-- Generator: Adobe Illustrator 15.0.2, SVG Export Plug-In . SVG Version: 6.00 Build 0) --> +<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd"> +<svg version="1.1" id="Ebene_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px" + width="57px" height="65px" viewBox="0 0 57 65" enable-background="new 0 0 57 65" xml:space="preserve"> +<g> + + <linearGradient id="SVGID_1_" gradientUnits="userSpaceOnUse" x1="26.5396" y1="-732.5005" x2="27.7805" y2="-762.2984" gradientTransform="matrix(1 0 0 -1 0.1201 -708.5371)"> + <stop offset="0.2711" style="stop-color:#FFAB4F"/> + <stop offset="1" style="stop-color:#FFD28F"/> + </linearGradient> + <path fill="url(#SVGID_1_)" stroke="#ED9135" stroke-miterlimit="10" d="M49.529,51.225c-4.396-4.396-10.951-5.884-12.063-6.109 + V37.8H19.278c0,0,0.038,6.903,0,6.868c0,0-6.874,0.997-12.308,6.432C1.378,56.691,0.5,62.77,0.5,62.77 + c0,1.938,1.575,3.492,3.523,3.492h48.51c1.947,0,3.521-1.558,3.521-3.492C56.055,62.768,54.211,55.906,49.529,51.225z"/> + + <radialGradient id="face_x5F_white_1_" cx="27.7827" cy="-734.2632" r="23.424" fx="23.2131" fy="-736.753" gradientTransform="matrix(1 0 0 -1 0.1201 -708.5371)" gradientUnits="userSpaceOnUse"> + <stop offset="0" style="stop-color:#FFD28F"/> + <stop offset="1" style="stop-color:#FFAB4F"/> + </radialGradient> + <path id="face_x5F_white_3_" fill="url(#face_x5F_white_1_)" stroke="#ED9135" stroke-miterlimit="10" d="M43.676,23.357 + c0.086,10.2-6.738,18.52-15.246,18.586c-8.503,0.068-15.467-8.146-15.553-18.344C12.794,13.4,19.618,5.079,28.123,5.012 + C36.627,4.945,43.59,13.158,43.676,23.357z"/> + + <linearGradient id="face_highlight_1_" gradientUnits="userSpaceOnUse" x1="2941.4297" y1="5677.457" x2="2965.0596" y2="5770.9087" gradientTransform="matrix(0.275 0 0 0.2733 -783.3976 -1543.4047)"> + <stop offset="0" style="stop-color:#FFFFFF;stop-opacity:0.42"/> + <stop offset="1" style="stop-color:#FFFFFF;stop-opacity:0.2067"/> + </linearGradient> + <path id="face_highlight_3_" fill="url(#face_highlight_1_)" d="M27.958,6.333c-6.035,0.047-10.747,4.493-12.787,10.386 + c-0.664,1.919-0.294,4.043,0.98,5.629c2.73,3.398,5.729,6.283,9.461,8.088c3.137,1.518,7.535,2.385,11.893,1.247 + c2.274-0.592,3.988-2.459,4.375-4.766c0.183-1.094,0.293-2.289,0.283-3.553C42.083,13.952,36.271,6.268,27.958,6.333z"/> + <path fill="#CC9869" stroke="#99724F" stroke-linecap="round" stroke-linejoin="round" d="M32.215,9.938 + c0,0,5.688,2.75,7.688,8.125c2.104,5.652,4.123,8.232,4.188,8c1.875-6.794,1.063-21.438-10.17-21.587 + c-20.455-7.663-25.58,11.962-23.893,19.65c1.078,4.911,2.234,6.686,3.938,8.08C13.966,32.205,15.028,17.563,32.215,9.938z"/> + + <radialGradient id="collar_x5F_body_2_" cx="15.1587" cy="-765.7056" r="32.4004" gradientTransform="matrix(1 0 0 -1 0.1201 -708.5371)" gradientUnits="userSpaceOnUse"> + <stop offset="0" style="stop-color:#B0E8FF"/> + <stop offset="1" style="stop-color:#74AEEE"/> + </radialGradient> + <path id="collar_x5F_body_1_" fill="url(#collar_x5F_body_2_)" stroke="#5491CF" d="M0.5,62.768c0,1.938,1.575,3.494,3.523,3.494 + h48.51c1.947,0,3.521-1.559,3.521-3.494c0,0-1.844-6.861-6.525-11.543c-4.815-4.813-11.244-6.146-11.244-6.146 + c-1.771,1.655-5.61,2.802-10.063,2.802c-4.453,0-8.292-1.146-10.063-2.802c0,0-5.755,0.586-11.189,6.021 + C1.378,56.689,0.5,62.768,0.5,62.768z"/> + + <radialGradient id="collar_x5F_r_2_" cx="31.5" cy="-755.832" r="9.2834" gradientTransform="matrix(1 0 0 -1 0.1201 -708.5371)" gradientUnits="userSpaceOnUse"> + <stop offset="0" style="stop-color:#80CCFF"/> + <stop offset="1" style="stop-color:#74AEEE"/> + </radialGradient> + <path id="collar_x5F_r_1_" fill="url(#collar_x5F_r_2_)" stroke="#5491CF" d="M38.159,41.381c0,0-0.574,2.369-3.013,4.441 + c-2.108,1.795-5.783,2.072-5.783,2.072l3.974,6.217c0,0,2.957-1.637,5.009-3.848c1.922-2.072,1.37-5.479,1.37-5.479L38.159,41.381z + "/> + + <radialGradient id="collar_x5F_l_2_" cx="19.1377" cy="-755.873" r="9.2837" gradientTransform="matrix(1 0 0 -1 0.1201 -708.5371)" gradientUnits="userSpaceOnUse"> + <stop offset="0" style="stop-color:#80CCFF"/> + <stop offset="1" style="stop-color:#74AEEE"/> + </radialGradient> + <path id="collar_x5F_l_1_" fill="url(#collar_x5F_l_2_)" stroke="#5491CF" d="M18.63,41.422c0,0,0.576,2.369,3.012,4.441 + c2.109,1.793,5.785,2.072,5.785,2.072l-3.974,6.217c0,0-2.957-1.637-5.007-3.85c-1.922-2.072-1.37-5.48-1.37-5.48L18.63,41.422z"/> + + <radialGradient id="Knob2_2_" cx="27.8872" cy="7.9414" r="0.9669" gradientTransform="matrix(1 0 0 -1 0.04 64.1543)" gradientUnits="userSpaceOnUse"> + <stop offset="0" style="stop-color:#80CCFF"/> + <stop offset="1" style="stop-color:#74AEEE"/> + </radialGradient> + <circle id="Knob2_1_" fill="url(#Knob2_2_)" stroke="#5491CF" cx="28.258" cy="56.254" r="0.584"/> + + <radialGradient id="Knob1_2_" cx="27.9253" cy="1.6973" r="0.9669" gradientTransform="matrix(1 0 0 -1 0.04 64.1543)" gradientUnits="userSpaceOnUse"> + <stop offset="0" style="stop-color:#80CCFF"/> + <stop offset="1" style="stop-color:#74AEEE"/> + </radialGradient> + <circle id="Knob1_1_" fill="url(#Knob1_2_)" stroke="#5491CF" cx="28.296" cy="62.499" r="0.584"/> +</g> +</svg> +</y:Resource> + </y:Resources> + </data> +</graphml> diff --git a/doc/overview.rst b/doc/overview.rst new file mode 100644 index 0000000..612fbba --- /dev/null +++ b/doc/overview.rst @@ -0,0 +1,174 @@ +============================= +SCons Documentation Toolchain +============================= + + +Introduction +============ + +This text tries to give an overview of the current SCons documentation toolchain. +The interested user should be able to better understand where and how the text he writes +is processed. +It is also a reference for core developers and the release team. + +.. image:: images/overview.png + +The diagram above roughly shows the steps that we currently need for creating all the MAN pages, User manuals and +reference documents. You may think: "Geeez, that looks so complicated. Why can't they +simply convert XML files to PDF with Docbook, or use reST?" Please be patient, and +continue reading. Things will get a little clearer soon. + +Our toolchain doesn't only produce HTML and PDF files that are nice to look at, it also performs a lot +of processing under the covers. We try to have our documentation as consistent as possible to the +current behaviour of the source code, but this requires some extra steps. + +So let's start right at the top... + +Writer's view +============= + +The toolchain is set up, such that the User has a very restricted view on this whole "document +processing thingy". All he should be concerned about is to edit existing text or write new sections +and paragraphs. +Sometimes even a completely new chapter has to be added, in general he can fire up his XML editor of choice +and type away. + +If he is a really nice user, he cares about validating his XML files against our special +"SCons Docbook DTD/XSD". Either during typing, supported by his XML editor, or by executing a special +script + +:: + + python bin/docs-validate.py + + +from the top source folder afterwards. Preferably both. + +Everything's looking okay, all validation passed? Good, then he simply commits his new work, and +creates a pull request on Bitbucket. That's it! + +Additionally, he can create the single documents on his side if he wants to get a feel for how the +final result looks (and who doesn't?). Each of the document folders (``design``, ``developer``, ``man``, +``python10``, ``reference``, and ``user``) contains an ``SConstruct`` file along with the actual +XML files. You can call + +:: + + python ../../src/script/scons.py + +from within the directory, and have the MAN pages or HTML created...even PDF, if you have a +renderer installed (``fop``, ``xep`` or ``jw``). + +Validation +========== + +Just a few more words about the validation step. +We are using our own DTD/XSD as a kind of hook, which only exists to link our own +SCons documentation tags into the normal Docbook XSD. For the output, we always +have an intermediary step (see diagram above), where we rewrite tags like ``cvar`` +into a block of Docbook formatting elements representing it. + +The toolchain, and all the Python scripts supporting it, are based on the prerequisite that +all documents are valid against the SCons Docbook XSD. This step guarantees that we can +accept the pull request of a user/writer with all his changes, and can create the documentation +for a new release of SCons without any problems at a later time. + + +Entities +======== + +We are using entities for special keywords like ``SCons`` that should appear with the same +formatting throughout the text. These are kept in a single file ``doc/scons.mod`` which gets +included by the documents. + +Additionally, for each Tool, Builder, Cvar and Function, a bunch of linkends in the form of +entities get defined. They can be used in the MAN page and the User manual. + +When you add an XML file in the ``src/engine/Tools`` folder, e.g. for a tool named ``foobar``, +you can use the two entities + +*t-foobar* + which prints the name of the Tool, and + +*t-link-foobar* + which is a link to the description of the Tool in the Appendix + +of the User guide's text. + +By calling the script + +:: + + python bin/docs-update-generated.py + +you can recreate the lists of entities (``*.mod``) in the ``generated`` folder, if required. +At the same time, this will generate the ``*.gen`` files, which list the full +description of all the Builders, Tools, Functions and CVars for the MAN page +and the guide's appendix. + +For more information about how to properly describe these elements, refer to +the start of the Python script ``bin/SConsDoc.py``. It explains the available +tags and the exact syntax in detail. + + +Examples +======== + +In the User Guide, we support automatically created examples. This means that the output of the specified +source files and SConstructs, is generated by running them with the current SCons version. +We do this to ensure that the output displayed in the manual, is identical to what you get when you run +the example on the command-line. + +A short description about how these examples have to be defined, can be found at the start of the file +``bin/SConsExamples.py``. Call + +:: + + python bin/docs-create-example-outputs.py + +from the top level source folder, to run all examples through SCons. + +Before this script starts to generate any output, it checks whether the names of all defined examples are +unique. Another important prerequisite is, that for every example all the single ``scons_output`` blocks need to have +a ``suffix`` attribute defined. These suffixes also have to be unique, within each example. + +All example output files (``*.xml``) get written to the folder ``doc/generated/examples``, together with all files defined +via the ``scons_example_file`` tag. They are put under version control, too. Like this, it is easier to compare +whether the output got broken for a new version of SCons. + +Note, that these output files are not actually needed for editing the documents. When loading the User manual into an XML +editor, you will always see the example's definition. Only when you create some output, the files from +``doc/generated/examples`` get XIncluded and all special ``scons*`` tags are transformed into Docbook elements. + + +Directories +=========== + +Documents are in the folders ``design``, ``developer``, ``man``, +``python10``, ``reference``, and ``user``. + +*editor_configs* + Prepared configuration sets for the validating WYSIWYG XML editors + XmlMind and Serna. You'll probably want to try the latter, because + the XXE config requires you to have a full version (costing a few + hundred bucks) and is therefore untested. For installing the Serna + config, simply copy the ``scons`` folder into the ``plugins`` + directory of your installation. Likewise, the XXE files from the + ``xmlmind`` folder have to be copied into ``~/.xxe4/`` under Linux. + +*generated* + Entity lists and outputs of the UserGuide examples. They get generated + by the update scripts ``bin/docs-update-generated.py`` + and ``bin/docs-create-example-outputs.py``. + +*images* + Images for the ``overview.rst`` document. + +*xsd* + The SCons Docbook schema (XSD), based on the Docbook v4.5 DTD/XSD. + +*xslt* + XSLT transformation scripts for converting the special SCons + tags like ``scons_output`` to valid Docbook during document + processing. + diff --git a/doc/user/pdf.xsl b/doc/user/pdf.xsl index cda0644..652975f 100644 --- a/doc/user/pdf.xsl +++ b/doc/user/pdf.xsl @@ -36,6 +36,8 @@ <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
@@ -54,8 +56,15 @@ reference toc,title 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>
|