You are viewing a plain text version of this content. The canonical link for it is here.
Posted to general@gump.apache.org by aj...@apache.org on 2003/09/24 22:28:21 UTC

cvs commit: jakarta-gump/template/forrest/src/documentation skinconf.xml

ajack       2003/09/24 13:28:21

  Modified:    template/forrest status.xml
               python/gump document.py
  Added:       template/forrest/src/documentation/resources/images icon.png
                        group.svg project-logo.gif group-logo.gif
                        project.svg
               template/forrest/src/documentation/content/xdocs site.xml
                        tabs.xml
               template/forrest/src/documentation skinconf.xml
  Removed:     template forrest.properties forrest-targets.ent status.xml
               template/forrest skinconf.xml README.txt
               template/forrest/resources/images project.svg group.svg
                        group-logo.gif icon.png project-logo.gif
               template/forrest/content/xdocs tabs.xml site.xml
  Log:
  Trying the default forrest layout, to see if it helps...
  
  Revision  Changes    Path
  1.1                  jakarta-gump/template/forrest/src/documentation/resources/images/icon.png
  
  	<<Binary file>>
  
  
  1.1                  jakarta-gump/template/forrest/src/documentation/resources/images/group.svg
  
  Index: group.svg
  ===================================================================
  <?xml version="1.0" standalone="no"?>
  
  <!--
         SVG Anteater logo
          jefft@apache.org
  
  To get started with SVG, I'd recommend getting the Adobe SVG plugin, and the
  xml-batik CVS module. Then have a look at the xml-batik/samples files. Use the
  SVG spec (http://www.w3.org/TR/SVG/) as a reference.
  -->
  
  <!--
  <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.0//EN"
  "http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd">
  -->
  <svg xmlns="http://www.w3.org/2000/svg"
    xmlns:xlink="http://www.w3.org/1999/xlink" width="340" height="60" viewBox="0 0 340 60">
    <title>Anteater logo</title>
  
    <defs>
  
      <!--
      <radialGradient id="radialGradient">
        <stop style="stop-color:gold" offset="0"/>
        <stop style="stop-color:orange" offset=".5"/>
        <stop style="stop-color:crimson" offset="1"/>
      </radialGradient>
      <linearGradient id="linearGradient">
        <stop style="stop-color:gold" offset="0"/>
        <stop style="stop-color:orange" offset=".5"/>
        <stop style="stop-color:crimson" offset="1"/>
      </linearGradient>
      -->
  
      <linearGradient id="gradient" x1="0" y1="0" x2="0" y2="1">
        <stop style="stop-color:white" offset="0"/>
        <stop style="stop-color:lightgreen" offset="1"/>
      </linearGradient>
  
      <filter id="shadowFilter"  filterUnits="objectBoundingBox">
        <!-- Takes the alpha channel (black outline of the text), blurs it and saves as 'blur' -->
        <feGaussianBlur in="SourceAlpha" stdDeviation="2 2" result="blur"/>
        <!-- Takes saved 'blur' and offsets it by 4 pixels, saves as 'offsetBlur' -->
        <feOffset in="blur" dx="4" dy="4" result="offsetBlur"/>
        <!-- Merges SourceGraphic (original image) and 'offsetBlur', putting the
        former 'over' the latter, and using the merged result as the finished
        image -->
        <feComposite in="SourceGraphic" in2="offsetBlur" operator="over"/>
      </filter>
  
    </defs>
  
    <g filter="url(#shadowFilter)" fill="url(#gradient)">
      <text x="21%" y="60%" style="font-size:30pt; font-family:Verdana ; text-anchor: middle">
        Group
      </text>
      <text x="55%" y="80%" style="font-size:30pt; font-family:Verdana ; text-anchor: middle">
        Logo
      </text>
      <text x="81%" y="80%" style="font-size:6pt; font-family:Arial ; text-anchor: middle">
        Change this in
      </text>
      <text x="81%" y="95%" style="font-size:6pt; font-family:Arial ; text-anchor: middle">
        group-logo.svg
      </text>
    </g>
  </svg>
  
  
  
  
  
  1.1                  jakarta-gump/template/forrest/src/documentation/resources/images/project-logo.gif
  
  	<<Binary file>>
  
  
  1.1                  jakarta-gump/template/forrest/src/documentation/resources/images/group-logo.gif
  
  	<<Binary file>>
  
  
  1.1                  jakarta-gump/template/forrest/src/documentation/resources/images/project.svg
  
  Index: project.svg
  ===================================================================
  <?xml version="1.0" standalone="no"?>
  
  <!--
         SVG Anteater logo
          jefft@apache.org
  
  To get started with SVG, I'd recommend getting the Adobe SVG plugin, and the
  xml-batik CVS module. Then have a look at the xml-batik/samples files. Use the
  SVG spec (http://www.w3.org/TR/SVG/) as a reference.
  -->
  
  <!--
  <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.0//EN"
  "http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd">
  -->
  <svg xmlns="http://www.w3.org/2000/svg"
    xmlns:xlink="http://www.w3.org/1999/xlink" width="340" height="60" viewBox="0 0 340 60">
    <title>Anteater logo</title>
  
    <defs>
  
      <!--
      <radialGradient id="radialGradient">
        <stop style="stop-color:gold" offset="0"/>
        <stop style="stop-color:orange" offset=".5"/>
        <stop style="stop-color:crimson" offset="1"/>
      </radialGradient>
      <linearGradient id="linearGradient">
        <stop style="stop-color:gold" offset="0"/>
        <stop style="stop-color:orange" offset=".5"/>
        <stop style="stop-color:crimson" offset="1"/>
      </linearGradient>
      -->
  
      <linearGradient id="gradient" x1="0" y1="0" x2="0" y2="1">
        <stop style="stop-color:white" offset="0"/>
        <stop style="stop-color:lightgreen" offset="1"/>
      </linearGradient>
  
      <filter id="shadowFilter"  filterUnits="objectBoundingBox">
        <!-- Takes the alpha channel (black outline of the text), blurs it and saves as 'blur' -->
        <feGaussianBlur in="SourceAlpha" stdDeviation="2 2" result="blur"/>
        <!-- Takes saved 'blur' and offsets it by 4 pixels, saves as 'offsetBlur' -->
        <feOffset in="blur" dx="4" dy="4" result="offsetBlur"/>
        <!-- Merges SourceGraphic (original image) and 'offsetBlur', putting the
        former 'over' the latter, and using the merged result as the finished
        image -->
        <feComposite in="SourceGraphic" in2="offsetBlur" operator="over"/>
      </filter>
  
    </defs>
  
    <g filter="url(#shadowFilter)" fill="url(#gradient)">
      <text x="51%" y="75%" style="font-size:42pt; font-family:Verdana ; text-anchor: middle">
        MyProj
      </text>
      <text x="91%" y="80%" style="font-size:6pt; font-family:Arial ; text-anchor: middle">
        Change this in
      </text>
      <text x="91%" y="95%" style="font-size:6pt; font-family:Arial ; text-anchor: middle">
        project-logo.svg
      </text>
    </g>
  </svg>
  
  
  
  
  
  1.1                  jakarta-gump/template/forrest/src/documentation/content/xdocs/site.xml
  
  Index: site.xml
  ===================================================================
  <?xml version="1.0"?>
  
  <!--
  Forrest site.xml
  -->
  
  <site label="Gump" href="" xmlns="http://apache.org/forrest/linkmap/1.0">
  
    <about label="Work">
      <index label="Index" href="index.html"/>
    </about>
  
    <external-refs>
      <xml.apache.org href="http://xml.apache.org/">
        <forrest href="forrest/">
          <validation href="validation.html"/>
          <webapp href="your-project.html#webapp"/>
          <document-v11 href="document-v11.html"/>
        </forrest>
        <cocoon href="cocoon/"/>
      </xml.apache.org>
    </external-refs>
  
  </site>
  
  
  
  1.1                  jakarta-gump/template/forrest/src/documentation/content/xdocs/tabs.xml
  
  Index: tabs.xml
  ===================================================================
  <?xml version="1.0" encoding="UTF-8"?>
  <!DOCTYPE tabs PUBLIC "-//APACHE//DTD Cocoon Documentation Tab V1.0//EN" "tab-cocoon-v10.dtd">
  
  <tabs software="Gump"
    title="Gump"
    copyright="Apache Software Foundation"
    xmlns:xlink="http://www.w3.org/1999/xlink">
  
    <!-- The rules are:
      @dir will always have '/@indexfile' added.
      @indexfile gets appended to @dir if the tab is selected. Defaults to 'index.html'
      @href is not modified unless it is root-relative and obviously specifies a
      directory (ends in '/'), in which case /index.html will be added
    -->
  
    <tab label="Home" dir="" indexfile="index.html"/>
    <tab label="Stats" dir="" indexfile="gump_stats/index.html"/>
    <tab label="XRef" dir="" indexfile="gump_xref/index.html"/>
  
  </tabs>
  
  
  
  1.2       +11 -40    jakarta-gump/template/forrest/status.xml
  
  Index: status.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-gump/template/forrest/status.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- status.xml	24 Sep 2003 20:13:48 -0000	1.1
  +++ status.xml	24 Sep 2003 20:28:21 -0000	1.2
  @@ -1,58 +1,29 @@
   <?xml version="1.0"?>
   <status>
  -
     <developers>
  -    <person name="Joe Bloggs"      email="joe@joescompany.org"      id="JB" />
  +    <person name="Gump"      email="gump@jakarta.apache.org"      id="Gump" />
       <!-- Add more people here -->
     </developers>
   
     <todo>
       <actions priority="high">
         <action context="docs" dev="JB">
  -        Customize this template project with your project's details.  This
  -        TODO list is generated from 'status.xml'.
  -      </action>
  -      <action context="docs" dev="JB">
  -        Add lots of content.  XML content goes in
  -        <code>src/documentation/content/xdocs</code>, or wherever the
  -        <code>${project.xdocs-dir}</code> property (set in
  -        <code>forrest.properties</code>) points.
  +        Make prettier w/ nice skin.
         </action>
  -      <action context="feedback" dev="JB">
  +      <action context="feedback" dev="Gump">
           Mail <link
  -          href="mailto:forrest-dev@xml.apache.org">forrest-dev@xml.apache.org</link>
  +          href="mailto:gump@jakarta.apache.org">gump@jakarta.apache.org</link>
           with feedback.
         </action>
       </actions>
  -    <!-- Add todo items. @context is an arbitrary string. Eg:
  -    <actions priority="high">
  -      <action context="code" dev="SN">
  -      </action>
  -    </actions>
  -    <actions priority="medium">
  -      <action context="docs" dev="open">
  -      </action>
  -    </actions>
  -    -->
     </todo>
   
     <changes>
       <!-- Add new releases here -->
  -    <release version="0.1" date="2002">
  -      <!-- Some action types have associated images. By default, images are
  -      defined for 'add', 'fix', 'remove' and 'update'. If you add
  -      src/documentation/resources/images/<foo>.jpg images, these will
  -        automatically be used for entries of type <foo>. -->
  -
  -          <action dev="JB" type="add" context="admin">
  -            Initial Import
  -          </action>
  -          <!-- Sample action:
  -          <action dev="JB" type="fix" due-to="Joe Contributor"
  -            due-to-email="joec@apache.org" fixes-bug="123">
  -            Fixed a bug in the Foo class.
  -          </action>
  -          -->
  -        </release>
  -      </changes>
  -    </status>
  +    <release version="0.1" date="2003">     
  +      <action dev="Gump" type="add" context="admin">
  +        Created
  +      </action>
  +    </release>
  +  </changes>
  +</status>
  
  
  
  1.26      +12 -8     jakarta-gump/python/gump/document.py
  
  Index: document.py
  ===================================================================
  RCS file: /home/cvs/jakarta-gump/python/gump/document.py,v
  retrieving revision 1.25
  retrieving revision 1.26
  diff -u -r1.25 -r1.26
  --- document.py	24 Sep 2003 19:19:13 -0000	1.25
  +++ document.py	24 Sep 2003 20:28:21 -0000	1.26
  @@ -196,16 +196,16 @@
       forrest=Cmd('forrest','forrest',forrest)
       
       # Temporary
  -    forrest.addParameter('-debug')
  +    # Too verbose ... forrest.addParameter('-debug')
       
       forrest.addPrefixedParameter('-D','java.awt.headless','true','=')
  -    forrest.addPrefixedParameter('-D','project.content-dir',  \
  -        content, '=')    
  -    forrest.addPrefixedParameter('-D','project.xdocs-dir',  \
  -        xdocs, '=')
  +    #forrest.addPrefixedParameter('-D','project.content-dir',  \
  +    #    content, '=')    
  +    #forrest.addPrefixedParameter('-D','project.xdocs-dir',  \
  +    #    xdocs, '=')
           
  -    forrest.addPrefixedParameter('-D','project.site-dir',  \
  -        workspace.logdir, '=')
  +    #forrest.addPrefixedParameter('-D','project.site-dir',  \
  +    #    workspace.logdir, '=')
        
       #   
       # Do we just tweak forrest.properties?
  @@ -806,7 +806,11 @@
       
   def getContentDir(workspace,forrestdir=None):
       fdir=forrestdir or getForrestDir(workspace)
  -    cdir=os.path.abspath(os.path.join(fdir,'content'))
  +    sdir=os.path.abspath(os.path.join(fdir,'src'))
  +    if not os.path.exists(sdir): os.mkdir(sdir)
  +    ddir=os.path.abspath(os.path.join(sdir,'documentation'))
  +    if not os.path.exists(ddir): os.mkdir(ddir)
  +    cdir=os.path.abspath(os.path.join(ddir,'content'))
       if not os.path.exists(cdir): os.mkdir(cdir)
       return cdir  
       
  
  
  
  1.1                  jakarta-gump/template/forrest/src/documentation/skinconf.xml
  
  Index: skinconf.xml
  ===================================================================
  <?xml version="1.0"?>
  
  <!--
  Skin configuration file. This file contains details of your project, which will
  be used to configure the chosen Forrest skin.
  -->
  
  <!DOCTYPE skinconfig [
  
    <!ENTITY % links.att 'name CDATA #REQUIRED'>
    <!ENTITY % link.att 'name CDATA #REQUIRED href CDATA #REQUIRED'>
    <!ELEMENT skinconfig (disable-search?, disable-print-link?, disable-pdf-link?,
    disable-xml-link?, disable-compliance-links?, searchsite-domain?, searchsite-name?,
    project-name, project-url, project-logo, group-name?, group-url?, group-logo?,
    host-url?, host-logo?, year?, vendor?, trail?, credits?)*>
    <!ELEMENT credits (credit*)>
    <!ELEMENT credit (name, url, image?, width?, height?)>
    <!-- id uniquely identifies the tool, and role indicates its function -->
    <!ATTLIST credit id   CDATA #IMPLIED
                     role CDATA #IMPLIED>
    <!ELEMENT disable-search (#PCDATA)>
    <!ELEMENT disable-print-link (#PCDATA)>
    <!ELEMENT disable-pdf-link (#PCDATA)>
    <!ELEMENT disable-xml-link (#PCDATA)>    
    <!ELEMENT disable-compliance-links (#PCDATA)>   
    <!ELEMENT searchsite-domain (#PCDATA)>
    <!ELEMENT searchsite-name (#PCDATA)>  
    <!ELEMENT project-name (#PCDATA)>
    <!ELEMENT project-url (#PCDATA)>
    <!ELEMENT project-logo (#PCDATA)>
    <!ELEMENT group-name (#PCDATA)>
    <!ELEMENT group-url (#PCDATA)>
    <!ELEMENT group-logo (#PCDATA)>
    <!ELEMENT host-url (#PCDATA)>
    <!ELEMENT host-logo (#PCDATA)>
    <!ELEMENT year (#PCDATA)>
    <!ELEMENT vendor (#PCDATA)>
    <!ELEMENT trail (link1, link2, link3)>
    <!ELEMENT link1 EMPTY>
    <!-- Seems we can't use param entity refs until this is DTDified -->
    <!ATTLIST link1 name CDATA #REQUIRED href CDATA #IMPLIED>
    <!ELEMENT link2 EMPTY>
    <!ATTLIST link2 name CDATA #REQUIRED href CDATA #IMPLIED>
    <!ELEMENT link3 EMPTY>
    <!ATTLIST link3 name CDATA #REQUIRED href CDATA #IMPLIED>
    <!ELEMENT name (#PCDATA)>
    <!ELEMENT url (#PCDATA)>
    <!ELEMENT image (#PCDATA)>
    <!ELEMENT width (#PCDATA)>
    <!ELEMENT height (#PCDATA)>
    ]>
  
  <skinconfig>
    <!-- Do we want to disable the Google search box? -->
    <disable-search>true</disable-search>
    <!-- Do we want to disable the print link? -->
    <disable-print-link>true</disable-print-link>  
    <!-- Do we want to disable the PDF link? -->
    <disable-pdf-link>true</disable-pdf-link>
    <!-- Do we want to disable the xml source link? -->
    <disable-xml-link>true</disable-xml-link>
    <!-- Do we want to disable w3c compliance links? -->
    <disable-compliance-links>false</disable-compliance-links>
  
    <searchsite-domain>jakarta.apache.org</searchsite-domain>  
    <searchsite-name>Jakarta Gump</searchsite-name>  
  
    <!-- mandatory project logo
         skin: forrest-site renders it at the top -->
    <project-name>Jakarta Gump</project-name>
    <project-url>http://jakarta.apache.org/gump</project-url>
    <project-logo>images/project.png</project-logo>
    <!-- Alternative static image:
    <project-logo>images/project-logo.gif</project-logo> -->
  
    <!-- optional group logo
         skin: forrest-site renders it at the top-left corner -->
    <group-name>Jakarta</group-name>
    <group-url>http://jakarta.apache.org</group-url>
    <group-logo>images/group.png</group-logo>
    <!-- Alternative static image:
    <group-logo>images/group-logo.gif</group-logo> -->
  
    <!-- optional host logo (e.g. sourceforge logo)
         skin: forrest-site renders it at the bottom-left corner -->
    <host-url></host-url>
    <host-logo></host-logo>
  
    <!-- The following are used to construct a copyright statement -->
    <year>2003</year>
    <vendor>The Apache Software Foundation.</vendor>
  
    <!-- Some skins use this to form a 'breadcrumb trail' of links. If you don't
    want these, set the attributes to blank. The DTD purposefully requires them.
    -->
    <trail>
      <link1 name="Jakarta" href="http://jakarta.apache.org/"/>
      <link2 name="Jakarta Gump" href="http://jakarta.apache.org/gump/"/>
      <link3 name="" href=""/>
    </trail>
  
    <!-- Credits are typically rendered as a set of small clickable images in the
    page footer -->
    <credits>
      <credit>
        <name>Built with Apache Forrest</name>
        <url>http://xml.apache.org/forrest/</url>
        <image>images/built-with-forrest-button.png</image>
        <width>88</width>
        <height>31</height>
      </credit>
      <!-- A credit with @role='pdf' will have its name and url displayed in the
      PDF page's footer. -->
    </credits>
  
  </skinconfig>