src/documentation/skinconf.xml

Mailing-List: contact svn-help@forrest.apache.org; run by ezmlm
Precedence: bulk
Reply-To: "Forrest Developers List" <dev@forrest.apache.org>
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Subject: svn commit: r1056814 -
 /forrest/trunk/site-author/content/xdocs/docs_0_90/howto/howto-buildPlugin.xml
Date: Sat, 08 Jan 2011 21:59:03 -0000
To: svn@forrest.apache.org
From: crossley@apache.org
Message-Id: <20110108215903.2CD682388994@eris.apache.org>

Author: crossley
Date: Sat Jan  8 21:59:02 2011
New Revision: 1056814

URL: http://svn.apache.org/viewvc?rev=1056814&view=rev
Log:
Fix some out-of-date instructions.

Modified:
    forrest/trunk/site-author/content/xdocs/docs_0_90/howto/howto-buildPlugin.xml

Modified: forrest/trunk/site-author/content/xdocs/docs_0_90/howto/howto-buildPlugin.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/docs_0_90/howto/howto-buildPlugin.xml?rev=1056814&r1=1056813&r2=1056814&view=diff
==============================================================================
--- forrest/trunk/site-author/content/xdocs/docs_0_90/howto/howto-buildPlugin.xml (original)
+++ forrest/trunk/site-author/content/xdocs/docs_0_90/howto/howto-buildPlugin.xml Sat Jan  8 21:59:02 2011
@@ -193,10 +193,13 @@
         <section id="skinconf">
           <title>src/documentation/skinconf.xml</title>
           <p>
-            This configures the skin for your plugins documentation. There are
-            some items that need to be configured in here, for example, the
-            copyright information. The file is heavily commented so probably
-            best to read through it, changing what you need to.
+            This configures the skin for your plugins documentation.
+            Note that it is a minimal file, as most content is centrally configured for all ASF plugins.
+            Over-ride some elements if needed, e.g. see the PDF output plugin.
+          </p>
+          <p>
+            If this is not and ASF-hosted plugin, then copy the skinconf.xml from a fresh
+            'forrest seed-sample' site instead.
           </p>
         </section>
         <section id="doc">
@@ -210,10 +213,11 @@
         <section id="hosted">
           <title>Style notes for plugins hosted at forrest.apache.org</title>
           <p>
-            After seeding a new plugin, copy the configuration from an existing
+            After seeding a new plugin, copy some configuration from an existing
             plugin (e.g. org.apache.forrest.plugin.input.projectInfo). Copy
-            src/documentation/skinconf.xml (and edit to suit) and
             src/documentation/content/xdocs/images/project-logo.gif
+            and
+            src/documentation/content/xdocs/favicon.ico
           </p>
         </section>
       </section>
@@ -426,7 +430,6 @@
         </p>
         <ul>
           <li>Review the docs and ensure any version numbers in text are "0.7"</li>
-          <li>Edit the skinconf.xml to ensure that all version numbers are "0.7", e.g. the MOTD.</li>
           <li>Edit the plugin's descriptors to ensure that the "forrestVersion" is 0.7 and that the "version" is appropriate. </li>
           <li>Ensure that the "website" parameter includes "pluginDocs/plugins_0_70"</li>
           <li>Edit status.xml to set the release date. Ensure that the changes notes are complete.</li>
@@ -438,8 +441,6 @@
         <ul>
           <li>Review the docs and ensure any version numbers in text are
              "0.8"</li>
-          <li>Edit the skinconf.xml to ensure that all version numbers are
-             "0.8-dev", e.g. the MOTD.</li>
           <li>Edit the plugin's descriptors to ensure that the "forrestVersion" is
              0.8 and that the "version" is incremented. </li>
           <li>Ensure that the "website" parameter includes "pluginDocs/plugins_0_80"</li>