You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pivot.apache.org by tv...@apache.org on 2009/11/24 06:35:54 UTC

svn commit: r883590 - in /incubator/pivot: site/trunk/README site/trunk/tutorials site/trunk/xsl/project.xml site/trunk/xsl/project.xsl site/trunk/xsl/template.xsl trunk/demos/www/index.xml trunk/demos/xsl/index.xsl

Author: tvolkert
Date: Tue Nov 24 05:35:53 2009
New Revision: 883590

URL: http://svn.apache.org/viewvc?rev=883590&view=rev
Log:
Unified tag names across site and demos XML

Added:
    incubator/pivot/site/trunk/tutorials   (with props)
Modified:
    incubator/pivot/site/trunk/README
    incubator/pivot/site/trunk/xsl/project.xml
    incubator/pivot/site/trunk/xsl/project.xsl
    incubator/pivot/site/trunk/xsl/template.xsl
    incubator/pivot/trunk/demos/www/index.xml
    incubator/pivot/trunk/demos/xsl/index.xsl

Modified: incubator/pivot/site/trunk/README
URL: http://svn.apache.org/viewvc/incubator/pivot/site/trunk/README?rev=883590&r1=883589&r2=883590&view=diff
==============================================================================
--- incubator/pivot/site/trunk/README (original)
+++ incubator/pivot/site/trunk/README Tue Nov 24 05:35:53 2009
@@ -1,38 +1,29 @@
 The Apache Pivot Website Instructions
 ---------------------------------------
 
-***NOTE***
-DO NOT EDIT THE .html files in the site-publish directory.
-Please follow the directions below for updating the website.
-***NOTE***
-
 The Pivot web site is based on .xml files which are transformed
 into .html files using XSLT and Ant.
 
-In order to make modifications to the Pivot web site, you need to first check out
-the Pivot site from SVN. To check out the Pivot site into a sub-directory
-called pivot-site in the current directory:
-
-svn checkout https://svn.apache.org/repos/asf/incubator/pivot/site/trunk pivot-site
+NOTE: In order to build, the site requires symbolic links to be set up that point to the demos and
+tutorials 'www' folders. If you are on a platform that supports symbollic links, these links will be
+created for you when you check out the Pivot site from SVN; by default, they will be:
 
-Once you have the site checked out locally, cd into your
-pivot-site directory and execute:
+  demos -> ../../trunk/demos/www
+  tutorials -> ../../trunk/tutorials/www
 
-> ant
+If these default links do not match your local folder structure, then you should update the links
+to point to the correct folders:
 
-This will build the documentation into the site-publish/ directory. The output
-will show you which files got re-generated.
+  // Current folder is [site-trunk]
+  $ ln -s [pivot-trunk]/demos/www demos
+  $ ln -s [pivot-trunk]/tutorials/www tutorials
 
-If you would like to make modifications to the web site documents,
-you simply need to edit the files in the site-author/ directory.
+Once you have the site checked out locally and the symbolic links set up, cd into your site trunk
+directory and execute:
 
-The files in site-author/stylesheets are the global files for the site. If you make a
-modification to project.xml, it will affect the left side navigation for the
-web site, and all of your .html files will be re-generated.
+> ant clean build
 
-Once you have built your documentation and confirmed that your changes are
-ok, you can check your .xml and your .html files back into SVN.
+This will build the site into the ant-bin/ directory.
 
-Then, copy the contents of the site-publish directory to
-people.apache.org:/www/incubator.apache.org/pivot/ to have the changes reflected
-on the Pivot web site.
+Note that the generated pages do not get checked into SVN. To deploy updated pages to the Pivot web
+site, you should scp the pages to people.apache.org:/www/pivot.apache.org/.

Added: incubator/pivot/site/trunk/tutorials
URL: http://svn.apache.org/viewvc/incubator/pivot/site/trunk/tutorials?rev=883590&view=auto
==============================================================================
--- incubator/pivot/site/trunk/tutorials (added)
+++ incubator/pivot/site/trunk/tutorials Tue Nov 24 05:35:53 2009
@@ -0,0 +1 @@
+link ../../trunk/tutorials/www
\ No newline at end of file

Propchange: incubator/pivot/site/trunk/tutorials
------------------------------------------------------------------------------
    svn:special = *

Modified: incubator/pivot/site/trunk/xsl/project.xml
URL: http://svn.apache.org/viewvc/incubator/pivot/site/trunk/xsl/project.xml?rev=883590&r1=883589&r2=883590&view=diff
==============================================================================
--- incubator/pivot/site/trunk/xsl/project.xml (original)
+++ incubator/pivot/site/trunk/xsl/project.xml Tue Nov 24 05:35:53 2009
@@ -19,47 +19,53 @@
 <project href="http://pivot.apache.org/">
     <title>Apache Pivot</title>
 
-    <global>
+    <!-- The global items appear in the main navigation. -->
+    <global-items>
         <item name="Demos" href="~release/demos/"/>
         <item name="Download" href="~download"/>
         <item name="Documentation" href="documentation.html"/>
         <item name="Get Involved" href="get-involved.html"/>
         <item name="About" href="about.html"/>
-    </global>
+    </global-items>
 
-    <groups>
-        <group id="demos" name="Demos">
+    <!--
+    The item groups show up in the footer navigation. The items belonging to the same group as the
+    current page will also show up in the left navigation (with the exception of demos, which
+    reference demos/index.xml.
+    -->
+    <item-groups>
+        <item-group id="demos" name="Demos">
             <item name="Kitchen Sink" href="~release/demos/kitchen-sink.html"/>
             <item name="Charting" href="http://ixnay.biz/charts.html"/>
             <item name="Component Explorer" href="~release/tutorials/component-explorer.html"/>
             <item name="More Demos" href="~release/demos/"/>
-        </group>
+        </item-group>
 
-        <group id="documentation" name="Documentation">
+        <item-group id="documentation" name="Documentation">
             <item name="Getting Started" href="getting-started.html"/>
             <item name="Tutorial" href="~release/tutorials/"/>
             <item name="FAQ" href="~wiki/frequently-asked-questions-faq.html"/>
             <item name="Javadoc (1.4)" href="~release/docs/api/"/>
-        </group>
+        </item-group>
 
-        <group id="get-involved" name="Get Involved">
+        <item-group id="get-involved" name="Get Involved">
             <item name="SVN Repositories" href="svn.html"/>
             <item name="Mailing Lists" href="lists.html"/>
             <item name="Bug Database" href="~jira/"/>
             <item name="Wiki" href="~wiki/"/>
-        </group>
+        </item-group>
 
-        <group id="related" name="Related">
+        <item-group id="related" name="Related">
             <item name="JFreeChart Provider" href="http://code.google.com/p/pivot-jfree/"/>
-        </group>
+        </item-group>
 
-        <group id="about" name="About">
+        <item-group id="about" name="About">
             <item name="Who We Are" href="who-we-are.html"/>
             <item name="Contact" href="contact.html"/>
             <item name="News" href="news.html"/>
             <item name="Legal/License" href="legal.html"/>
-            <item name="Sponshorship" href="~asf/foundation/sponsorship.html" footer="no"/>
-            <item name="Thanks" href="~asf/foundation/thanks.html" footer="no"/>
-        </group>
-    </groups>
+            <item name="Sponshorship" href="~asf/foundation/sponsorship.html" footer="false"/>
+            <item name="Thanks" href="~asf/foundation/thanks.html" footer="false"/>
+        </item-group>
+    </item-groups>
 </project>

Modified: incubator/pivot/site/trunk/xsl/project.xsl
URL: http://svn.apache.org/viewvc/incubator/pivot/site/trunk/xsl/project.xsl?rev=883590&r1=883589&r2=883590&view=diff
==============================================================================
--- incubator/pivot/site/trunk/xsl/project.xsl (original)
+++ incubator/pivot/site/trunk/xsl/project.xsl Tue Nov 24 05:35:53 2009
@@ -31,8 +31,8 @@
 
   <!-- Defined variables (not overrideable) -->
   <xsl:variable name="project" select="document('project.xml')/project"/>
-  <xsl:variable name="group">
-    <xsl:value-of select="//document/@group"/>
+  <xsl:variable name="item-group">
+    <xsl:value-of select="//document/@item-group"/>
   </xsl:variable>
 
   <!-- Process an entire document into an HTML page -->
@@ -92,7 +92,7 @@
 
               <xsl:comment>MAIN NAVIGATION</xsl:comment>
               <ul class="navi">
-                <xsl:apply-templates select="$project/global/item"/>
+                <xsl:apply-templates select="$project/global-items/item"/>
               </ul>
             </div>
 
@@ -106,7 +106,7 @@
 
             <div class="footerLinks">
               <ul class="footerMenuGr">
-                <xsl:apply-templates select="$project/groups/group"/>
+                <xsl:apply-templates select="$project/item-groups/item-group"/>
               </ul>
             </div>
           </div>
@@ -120,11 +120,11 @@
   </xsl:template>
 
   <!-- Process an item group -->
-  <xsl:template match="group">
+  <xsl:template match="item-group">
     <li>
       <strong><xsl:value-of select="@name"/></strong>
       <ul>
-        <xsl:apply-templates select="item[not(@footer='no')]"/>
+        <xsl:apply-templates select="item[not(@footer='false')]"/>
       </ul>
     </li>
   </xsl:template>

Modified: incubator/pivot/site/trunk/xsl/template.xsl
URL: http://svn.apache.org/viewvc/incubator/pivot/site/trunk/xsl/template.xsl?rev=883590&r1=883589&r2=883590&view=diff
==============================================================================
--- incubator/pivot/site/trunk/xsl/template.xsl (original)
+++ incubator/pivot/site/trunk/xsl/template.xsl Tue Nov 24 05:35:53 2009
@@ -25,7 +25,7 @@
 
       <xsl:comment>GROUP NAVIGATION</xsl:comment>
       <ul class="naviLeft">
-        <xsl:apply-templates select="$project/groups/group[@id=$group]/item"/>
+        <xsl:apply-templates select="$project/item-groups/item-group[@id=$item-group]/item"/>
       </ul>
 
       <xsl:comment>CONTENT</xsl:comment>

Modified: incubator/pivot/trunk/demos/www/index.xml
URL: http://svn.apache.org/viewvc/incubator/pivot/trunk/demos/www/index.xml?rev=883590&r1=883589&r2=883590&view=diff
==============================================================================
--- incubator/pivot/trunk/demos/www/index.xml (original)
+++ incubator/pivot/trunk/demos/www/index.xml Tue Nov 24 05:35:53 2009
@@ -25,34 +25,42 @@
         <p>
             This page contains a collection of Pivot demos. All demos require Java 6 or greater.
         </p>
-        <demo id="kitchen-sink" featured="true">
-            <screenshot kind="large">kitchen-sink.png</screenshot>
-        </demo>
-        <demo id="stock-tracker">
-            <screenshot kind="large">stock-tracker.png</screenshot>
-        </demo>
-        <demo id="itunes-search">
-            <screenshot kind="large">itunes-search.png</screenshot>
-        </demo>
-        <demo id="json-viewer">
-            <screenshot kind="large">json-viewer.png</screenshot>
-        </demo>
-        <demo id="xml-viewer">
-            <screenshot kind="large">xml-viewer.png</screenshot>
-        </demo>
-        <demo id="scripting"/>
-        <demo id="file-drag-drop"/>
-        <demo id="table-row-editor"/>
-        <demo id="animated-clock">
-            <screenshot kind="large">animated-clock.png</screenshot>
-        </demo>
-        <demo id="large-data"/>
-        <demo id="rss-feed"/>
-        <demo id="dom-interaction"/>
-        <demo id="decorators">
-            <screenshot kind="large">decorators.png</screenshot>
-        </demo>
-        <demo id="fixed-column-table"/>
-        <demo id="multiselect"/>
+        <demo-item id="kitchen-sink">
+            <screenshot>kitchen-sink.png</screenshot>
+        </demo-item>
+        <demo-item id="stock-tracker">
+            <screenshot>stock-tracker.png</screenshot>
+        </demo-item>
+        <demo-item id="itunes-search">
+            <screenshot>itunes-search.png</screenshot>
+        </demo-item>
+        <demo-item id="charts" href="http://ixnay.biz/charts.html">
+            <title>Charting</title>
+            <description>
+                Demonstrates charting in Pivot using the JFreeChart chart provider (hosted at
+                http://ixnay.biz).
+            </description>
+            <screenshot>charts.png</screenshot>
+        </demo-item>
+        <demo-item id="json-viewer">
+            <screenshot>json-viewer.png</screenshot>
+        </demo-item>
+        <demo-item id="xml-viewer">
+            <screenshot>xml-viewer.png</screenshot>
+        </demo-item>
+        <demo-item id="scripting"/>
+        <demo-item id="file-drag-drop"/>
+        <demo-item id="table-row-editor"/>
+        <demo-item id="animated-clock">
+            <screenshot>animated-clock.png</screenshot>
+        </demo-item>
+        <demo-item id="large-data"/>
+        <demo-item id="rss-feed"/>
+        <demo-item id="dom-interaction"/>
+        <demo-item id="decorators">
+            <screenshot>decorators.png</screenshot>
+        </demo-item>
+        <demo-item id="fixed-column-table"/>
+        <demo-item id="multiselect"/>
     </body>
 </document>

Modified: incubator/pivot/trunk/demos/xsl/index.xsl
URL: http://svn.apache.org/viewvc/incubator/pivot/trunk/demos/xsl/index.xsl?rev=883590&r1=883589&r2=883590&view=diff
==============================================================================
--- incubator/pivot/trunk/demos/xsl/index.xsl (original)
+++ incubator/pivot/trunk/demos/xsl/index.xsl Tue Nov 24 05:35:53 2009
@@ -89,7 +89,7 @@
         <xsl:apply-templates/>
     </xsl:template>
 
-    <xsl:template match="demo">
+    <xsl:template match="demo-item">
         <xsl:if test="position()&gt;1">
             <hr/>
         </xsl:if>
@@ -100,8 +100,8 @@
         <h3><a href="{$id}.html"><xsl:value-of select="$demo/properties/title"/></a></h3>
         <p><a href="{$id}.jnlp">Web start</a></p>
         <p><xsl:value-of select="$demo/properties/description"/></p>
-        <xsl:if test="screenshot[@kind='large']">
-            <xsl:variable name="src" select="screenshot[@kind='large']"/>
+        <xsl:if test="screenshot">
+            <xsl:variable name="src" select="screenshot"/>
             <p><img src="{$src}"/></p>
         </xsl:if>
     </xsl:template>