[gatein-commits] gatein SVN: r6588 - epp/docs/branches/5.1/Site_Publisher.

[do-not-reply at jboss.org]

Author: smumford
Date: 2011-06-02 23:55:06 -0400 (Thu, 02 Jun 2011)
New Revision: 6588

Added:
   epp/docs/branches/5.1/Site_Publisher/README
Removed:
   epp/docs/branches/5.1/Site_Publisher/create_site_publisher_docs.sh
Log:
Committed script in error. Replacing with README file.

Added: epp/docs/branches/5.1/Site_Publisher/README
===================================================================
--- epp/docs/branches/5.1/Site_Publisher/README	                        (rev 0)
+++ epp/docs/branches/5.1/Site_Publisher/README	2011-06-03 03:55:06 UTC (rev 6588)
@@ -0,0 +1,23 @@
+Red Hat Site Publisher User Guide Build Instructions:
+
+A script is available to automate this task. Check it out from: https://svn.devel.redhat.com/repos/ecs/JBoss_Enterprise_Portal_Platform/create_site_publisher_docs.sh
+
+Either run this script or perform the following steps manually (this guide assumes you have the necessary permissions).
+
+1: Check out the eXo WCM User Guide source from: http://svn.exoplatform.org/projects/ecms/branches/2.1.x/docs/userguide
+
+2: Check out the Red hat build files from: https://svn.devel.redhat.com/repos/ecs/JBoss_Enterprise_Portal_Platform/SPUG_Build_Files
+
+3: Copy the 'userguide' directory to 'User_Guide'.
+
+4: Copy the XML files in the 'SPUG_Build_Files/files' directory into User_Guide/en-US. This will overwrite some eXo-specific files with Red Hat equivalents. Consider removing the original 'User_Guide.xml' and 'User_Guide.ent' files.
+
+5: Copy the PNG files from the 'SPUG_Build_Files/images' folder into User_Guide/images. This will overwrite some eXo-specific screenshots with Red Hat equivalents.
+
+6: Navigate into the 'User_Guide/en-US/images' directory and run the command:
+
+   $ xargs rm < ../../../SPUG_Build_Files/rm_icons.txt. 
+
+This will remove inline icons that, if present, will override textual fallbacks and break visual impairment accessibility guidelines mentioned in the Publican User Guide.
+
+7: The Site Publisher User Guide should build using Red Hat images text and product names/numbers.
\ No newline at end of file

Deleted: epp/docs/branches/5.1/Site_Publisher/create_site_publisher_docs.sh
===================================================================
--- epp/docs/branches/5.1/Site_Publisher/create_site_publisher_docs.sh	2011-06-03 03:53:16 UTC (rev 6587)
+++ epp/docs/branches/5.1/Site_Publisher/create_site_publisher_docs.sh	2011-06-03 03:55:06 UTC (rev 6588)
@@ -1,42 +0,0 @@
-#! /bin/bash
-
-echo "Checking for required resources..."
-   sleep 2s; echo "Checking for original eXo userguide..."
-   if [ ! -d userguide ]; then
-      sleep 2s; echo "Nope. Fetching eXo Source..."
-      svn co http://svn.exoplatform.org/projects/ecms/branches/2.1.x/docs/userguide
-   else
-      sleep 2s; echo "Yup. Check for updates..."
-      svn up userguide/
-   fi
-   sleep 2s; echo "Checking for local RH User_Guide..."
-   if [ ! -d User_Guide ]; then
-      sleep 2s; echo "Nope. Creating Local User_Guide.."
-      cp -r userguide/ User_Guide
-   else echo "Yup. Updating modules from userguide..."
-      sleep 2s; rsync -rvu userguide/en-US/modules/ User_Guide/en-US/modules
-   fi
-   sleep 2s; echo "Checking for RH SP build files..."
-   if [ ! -d SPUG_Build_Files ]; then
-      sleep 2s; echo "Nope. Fetching RH SP build files..."
-      svn co https://svn.devel.redhat.com/repos/ecs/JBoss_Enterprise_Portal_Platform/SPUG_Build_Files
-   else
-      sleep 2s; echo "Yup. Checking for updates..."
-      svn up SPUG_Build_Files/
-   fi
-
-sleep 2s; echo "Creating Red Hat Site Publisher User Guide..."
-
-      sleep 2s; echo "Copying Red Hat build files"
-         sleep 2s; cp -v SPUG_Build_Files/files/* User_Guide/en-US/; rm -v User_Guide/en-US/User_Guide.xml User_Guide/en-US/User_Guide.ent
-      
-      sleep 2s; echo "Copying Red Hat images..."
-            sleep 2s; cp -v SPUG_Build_Files/images/* User_Guide/en-US/images/
-      
-      sleep 2s; echo "Removing inline icon files..."
-            sleep 2s; cd User_Guide/en-US/images; xargs rm -v < ../../../SPUG_Build_Files/rm_icons.txt
-               cd ..
-      sleep 2s; echo "Replacing PRODUCT entities with text..."
-            grep -lr "\&PRODUCT\;" User_Guide/en-US/ | xargs sed -i 's/\&PRODUCT\;/Site Publisher/g'
-
-exit
\ No newline at end of file