Author: crossley Date: Sun Dec 5 19:11:03 2004 New Revision: 109939 URL: http://svn.apache.org/viewcvs?view=rev&rev=109939 Log: Add some tools to assist with review-sitemap-docs.
Added: cocoon/branches/BRANCH_2_1_X/tools/review-sitemap-docs/ cocoon/branches/BRANCH_2_1_X/tools/review-sitemap-docs/README.txt (contents, props changed) cocoon/branches/BRANCH_2_1_X/tools/review-sitemap-docs/add-column.sed (contents, props changed) cocoon/branches/BRANCH_2_1_X/tools/review-sitemap-docs/find-component-java-files-exclude.txt (contents, props changed) cocoon/branches/BRANCH_2_1_X/tools/review-sitemap-docs/find-component-java-files.sh (contents, props changed) Added: cocoon/branches/BRANCH_2_1_X/tools/review-sitemap-docs/README.txt Url: http://svn.apache.org/viewcvs/cocoon/branches/BRANCH_2_1_X/tools/review-sitemap-docs/README.txt?view=auto&rev=109939 ============================================================================== --- (empty file) +++ cocoon/branches/BRANCH_2_1_X/tools/review-sitemap-docs/README.txt Sun Dec 5 19:11:03 2004 @@ -0,0 +1,25 @@ +These are some basic tools to assist with the + Review of sitemap component documentation + http://cocoon.apache.org/2.1/plan/review-sitemap-docs.html + +------------------------------------------------------------------------ +Keep the table synchronised with the java source +------------------------------------------------ +Occasionally do the following ... + cd cocoon-2_1_X + tools/review-sitemap-docs/find-component-java-files.sh +Compare with last time you ran it ... + diff component-java-files-20041206.txt component-java-files-20041201.txt +Also compare with a listing of the files from Cocoon trunk. +Add new rows to the table with copy-and-paste. + +------------------------------------------------------------------------ +Add a new empty column to the table +----------------------------------- +Edit the sed script to define the next column, then run it. + cd cocoon-2_1_X + sed -f tools/review-sitemap-docs/add-column.sed \ + src/documentation/xdocs/plan/review-sitemap-docs.xml > tmp + mv tmp src/documentation/xdocs/plan/review-sitemap-docs.xml + +------------------------------------------------------------------------ Added: cocoon/branches/BRANCH_2_1_X/tools/review-sitemap-docs/add-column.sed Url: http://svn.apache.org/viewcvs/cocoon/branches/BRANCH_2_1_X/tools/review-sitemap-docs/add-column.sed?view=auto&rev=109939 ============================================================================== --- (empty file) +++ cocoon/branches/BRANCH_2_1_X/tools/review-sitemap-docs/add-column.sed Sun Dec 5 19:11:03 2004 @@ -0,0 +1,4 @@ +/th>D<\/th/a \ + <th>E</th> +/D --><td/a \ + <!-- E --><td></td> Added: cocoon/branches/BRANCH_2_1_X/tools/review-sitemap-docs/find-component-java-files-exclude.txt Url: http://svn.apache.org/viewcvs/cocoon/branches/BRANCH_2_1_X/tools/review-sitemap-docs/find-component-java-files-exclude.txt?view=auto&rev=109939 ============================================================================== --- (empty file) +++ cocoon/branches/BRANCH_2_1_X/tools/review-sitemap-docs/find-component-java-files-exclude.txt Sun Dec 5 19:11:03 2004 @@ -0,0 +1,2 @@ +src/blocks/woody +src/documentation/xdocs/tutorial Added: cocoon/branches/BRANCH_2_1_X/tools/review-sitemap-docs/find-component-java-files.sh Url: http://svn.apache.org/viewcvs/cocoon/branches/BRANCH_2_1_X/tools/review-sitemap-docs/find-component-java-files.sh?view=auto&rev=109939 ============================================================================== --- (empty file) +++ cocoon/branches/BRANCH_2_1_X/tools/review-sitemap-docs/find-component-java-files.sh Sun Dec 5 19:11:03 2004 @@ -0,0 +1,10 @@ +#!/bin/bash + +# Scan the Cocoon repository and find sitemap components + +find src -name *Action.java -o -name *Generator.java \ + -o -name *Matcher.java -o -name *Reader.java \ + -o -name *Selector.java -o -name *Serializer.java \ + -o -name *Transformer.java \ +| grep -v -f tools/review-sitemap-docs/find-component-java-files-exclude.txt \ +| sort > component-java-files.txt
