Added: incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/README URL: http://svn.apache.org/viewvc/incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/README?rev=627288&view=auto ============================================================================== --- incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/README (added) +++ incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/README Tue Feb 12 22:42:38 2008 @@ -0,0 +1,264 @@ + + + JSPWiki documentation + ===================== + + $Revision: 1.31 $ + $Date: 2007-05-05 10:35:45 $ + $Author: jalkanen $ + +What is it? +----------- + +JSPWiki is a simple (well, not any more) WikiWiki clone, written in Java +and JSP. A WikiWiki is a web site which allows anyone to participate +in its development. JSPWiki supports all the traditional wiki features, +as well as very detailed access control and security integration using JAAS. + + + Copyright (C) 2001-2007 JSPWiki development team + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public License + as published by the Free Software Foundation; either version 2.1 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this program; if not, write to the Free + Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA + 02111-1307 USA + + +The license file can be found in doc/LICENSE. + +(No, the LGPL does not mean that all the content in your new wiki will +be under the LGPL, anymore than any text you write using Emacs becomes +GPL.) + +One small request I have. If you really, really like this software, +donate a small amount of money to the World Wildlife Foundation +(WWF), Free Software Foundation (FSF), or Electronic Freedom +Foundation (EFF), or whichever charity is close to your heart. + +The world doesn't need to become a bad place. + +Oh yeah, and if you run a Wiki based on this software, let me know. +I'm always interested in hearing from my users =). + + +Pre-requirements +---------------- + +Okay, so you wanna Wiki? You'll need the following things: + +REQUIRED: + +* A JSP engine that supports Servlet API 2.3. I recommend Tomcat from + http://jakarta.apache.org/tomcat for a really easy installation. + Tomcat 4.x or later is supported, however, we strongly recommend + Tomcat 5.x or later. + +* Some previous administration experience... If you've ever installed + Apache or any other web server, you should be pretty well off. + +* And of course, a server to run the JSP engine on. + +* JDK 1.4+. JDK 1.5 is recommended. + + +OPTIONAL: + +* JavaMail package from java.sun.com, if you want to use log4j mailing + capabilities. You'll also need the Java Activation Framework. + +* RCS versioning system installed and available in your PATH if you + want to use RCS versioning. It is also possible (and on Windows, it + is even recommended) to use the VersioningFileProvider, which does + not require RCS. + + +Really simple installation +-------------------------- + +This section is meant for you, if you just want to have a really quick +install without much worries. If you want to have a more complicated +installation (with more power as to how to do things), +check out the "Install" section below. + +Since JSPWiki 2.1.153, JSPWiki comes with a really simple installation +engine. Just do the following: + +1) Install Tomcat from http://jakarta.apache.org/ (or any other servlet + container) + +2) Drop the JSPWiki.war file in your <tomcat home>/webapps/ directory. + Optional: Rename the JSPWiki.war if you want your URL to end with + something else than /JSPWiki/. For example, to get it called "wiki" + just rename the "JSPWiki.war" file to "wiki.war". + +3) Point your browser at http://<myhost>/JSPWiki/Install.jsp + (Or, if you renamed it in the previous phase, use something like + http://<myhost>/wiki/Install.jsp) + +4) Answer a couple of simple questions + +5) Restart your container + +6) Point your browser to http://<myhost>/JSPWiki/ (or whatever name you + chose in point 2) + +That's it! + + +Advanced Installation +--------------------- + +First, install a JSP engine and a web server. You can download Tomcat +from http://jakarta.apache.org/tomcat/. This software was built +originally on top of Tomcat 5.5, but probably most other versions +work, too, and most other JSP containers. + +After you've installed the engine and checked that it works, you just +make a subdirectory under $TOMCAT_HOME/webapps/. For example, if you +want your application to be called 'MyWiki', just create a directory +called 'MyWiki', then extract all files from the war files into that +directory, preserving the directory structure. + +Edit the WEB-INF/jspwiki.properties file to your liking. The only +thing you need to set is the directory where you want your wiki pages +to be stored. I recommend a directory that is regularly backed up. + +Unzip the contents of jspwiki-corepages.zip into your newly created +directory. You can find the rest of the documentation in the +JSPWiki-doc.zip file. + +(Re)start tomcat. + +Point your browser at http://<where your Tomcat is installed>/MyWiki/. +You should see the Main Wiki page. See the next section if you want +to edit the pages =). + + +Installation with Windows +------------------------- + +If you are using a version of Microsoft Windows, you'll find that +getting RCS up and running may be a bit problematic, and thus we +recommend the VersioningFileProvider. + +All JSPWiki documentation is in the web; please see +http://doc.jspwiki.org/2.4/wiki/WindowsInstall + +Upgrading from previous versions +-------------------------------- + +Please read ReleaseNotes. + +All JSPWiki documentation is in the web; please see +http://doc.jspwiki.org/2.4/ + + +Configuring JSPWiki +------------------- + +All configuration information is kept in WEB_INF/jspwiki.properties. +The file is pretty well documented, so I recommend you read it through +first. + +There are also some auxiliary configuration files, such as filters.xml. + +Also, there is a far more detailed documentation in the web: + +http://doc.jspwiki.org/2.4/ + + +Where to go next aka. where is the rest of the documentation? +------------------------------------------------------------- + +The rest of the documentation is at + +http://doc.jspwiki.org/2.4/ + + +Acknowledgements +---------------- + +This product includes software developed by the Apache Software Foundation +(http://www.apache.org/). See doc/LICENCE.Apache for more information. + +This product includes software developed by the OpenSymphony Group +(http://www.opensymphony.org/). See doc/LICENSE.OpenSymphony for more +information. + +There have been many contributors so far. Especially thanks go to +Andrew Jaquith, Dirk Fredericx, Murray Altheim, Olaf Kock, Mark +Rawling, Dan Frankowski, Terry Steichen, Chuck Smith, Christoph Sauer, +Erik Bunn, Niilo Neuvo, Alain Ravet, Kalle Kivimaa, Jeff Phillips, +Mahlen Morris, Paul Downes, Michael Gentry, John Volkar, Torsten +Hildebrandt, and Foster Schucker who have given me quite a lot of +support and/or code. There are also a number of other people who have +generously given their time, and you can find hopefully all of their +names in the ChangeLog. + + +Contact +------- + +JSPWiki authors can be contacted on the jspwiki-users mailing list. +You can see the instructions on http://www.jspwiki.org/wiki/JSPWikiMailingList. + +The mailing list should also be your primary place to ask support questions. +There are many wise and knowledgeable people on that list. + +If all else fails, feel free to send me (Janne Jalkanen, the lead developer) +direct email, at [EMAIL PROTECTED] + + +LICENSES +======== + +JSPWiki is licenced under the Lesser General Public License, version +2.1. See LICENSE. + +The various Jakarta libraries are licensed under the Apache Public +License. See http://www.apache.org/LICENSE.txt + +The search_highlight.js script is licensed under the X11 (MIT) +License: + +COPYRIGHT AND PERMISSION NOTICE + +Copyright (c) 2002 Stuart Langridge + +All rights reserved. + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, and/or sell copies of the Software, and to permit persons +to whom the Software is furnished to do so, provided that the above +copyright notice(s) and this permission notice appear in all copies of +the Software and that both the above copyright notice(s) and this +permission notice appear in supporting documentation. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT +OF THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR +HOLDERS INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY +SPECIAL INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER +RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF +CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN +CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. + +Except as contained in this notice, the name of a copyright holder +shall not be used in advertising or otherwise to promote the sale, use +or other dealings in this Software without prior written authorization +of the copyright holder. +
Added: incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/ReleaseNotes URL: http://svn.apache.org/viewvc/incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/ReleaseNotes?rev=627288&view=auto ============================================================================== --- incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/ReleaseNotes (added) +++ incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/ReleaseNotes Tue Feb 12 22:42:38 2008 @@ -0,0 +1,111 @@ + +This is a stable release of JSPWiki 2.6. Welcome to the new, all-seeing, +all-dancing, all-spanking JSPWiki! + +This is the final release of JSPWiki as LGPL software. The development of +JSPWiki moves to the Apache Incubation process, and in the future, you can +find JSPWiki from the Apache website. For more information, please see +http://www.jspwiki.org/wiki/ApacheRelicensing. + +Please report any issues you can find at http://issues.apache.org/JIRA/ + +NEW FEATURES +============ + +* JSPWiki source code requires JDK 1.5 to compile, though it should + still run under JDK 1.4. + +* Workflow packages (e.g. for moderating page edits or registrations) + +* Internationalization. Included are English, Finnish, German and Spanish + translations. + +* Spaces in wikinames are now allowed for a more natural-looking page content. + However, this does not break existing links - but names with spaces are + preferred. + +* Support for new link target types, e.g. [cool link|http://google.com|target='_blank'] + to open the link in a new window. + +* SisterSites support + +* Local security policies - no more need to use a global security policy + to configure JSPWiki security! + +* Improved SpamFilter, including Captcha support (currently only supports ASIRRA) + +* Far improved FCK WYSIWYG editor support + +* All new default template with all sorts of awesome goodies, such as upload + progress indicator, etc! It is based on the ever-popular BrushedTemplate! + +* No more JAR signing! Unfortunately, though, if you're running JSPWiki with + a global security policy, you will still need to sign the JAR yourself using + the "ant signjar" command. + +This is just a quick overview. The full list of what is new in 2.6 can be seen at + +http://www.jspwiki.org/wiki/NewIn2.6 + +UPGRADE NOTES +============= + +Upgrading from 2.4: + +* Reinstall in a new directory + +* You can copy old templates directly to the new templates + directory. Templates should be for the most part be compatible + between 2.6 and 2.4 - though obviously most 2.4 templates do + not have localization. + +* Copy old jspwiki.properties over the default jspwiki.properties + and everything should just work. + +* Copy old filters.xml to new WEB-INF/classes directory + +* Optional: check your jspwiki.policy file against the new one: + some definitions have changed. + + +Upgrading from earlier installations: + +* Please make a complete reinstall. Your wiki pages will still be + compatible, and the configuration for the most part. + +Please visit http://doc.jspwiki.org/2.4/ for further instructions. + + + +EXPERIMENTAL FEATURES +===================== + +There are some features in this release which could mostly be considered +experimental at best. The following ones are known to work only +partially: + +* WebDAV support. This is known to be broken on pretty many levels... + + +KNOWN PROBLEMS +============== + +* WebDav does not yet support the new + authentication/permissions scheme. Therefore, if you have very + sensitive data in your wiki, you might not want to enable it. + +* Not all old plugins work. Specifically, plugins from 2.2, which + 1) use com.ecyrd.jspwiki package, will fail because they are not + signed with the same key as jspwiki.jar, and + 2) any plugin, which constructs new WikiPages will fail because + of the constructor has been changed. + +* The default template does not work at all if you turn off + Javascript. We are aware of this and working on a fix. + +* Our documentation simply sucks at this point. Please forgive us, + and point where those fixes are needed. We will improve upon + this during our progress towards a stable. + +* The ShortURLConstructor does not work reliably. Please use + ShortViewURLConstructor, or Apache mod_rewrite. Added: incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/build.bat URL: http://svn.apache.org/viewvc/incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/build.bat?rev=627288&view=auto ============================================================================== --- incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/build.bat (added) +++ incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/build.bat Tue Feb 12 22:42:38 2008 @@ -0,0 +1,5 @@ [EMAIL PROTECTED] off + +REM A simple build script + +ant -Dbuild.properties=build.properties.mine -find Added: incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/build.properties URL: http://svn.apache.org/viewvc/incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/build.properties?rev=627288&view=auto ============================================================================== --- incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/build.properties (added) +++ incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/build.properties Tue Feb 12 22:42:38 2008 @@ -0,0 +1,59 @@ +# +# This file contains defaults for development. If you are cross- +# developing in multiple environments, just change the defaults +# in this file. +# +# Any changes in this file will be reflected in the default +# jspwiki.properties-file when it is run. +# [EMAIL PROTECTED]@=JSPWiki [EMAIL PROTECTED]@=/tmp/jspwiki/repository [EMAIL PROTECTED]@=/tmp/jspwiki/jspwiki-stripes.log [EMAIL PROTECTED]@=/tmp/jspwiki/security-stripes.log [EMAIL PROTECTED]@=/tmp/jspwiki/spamlog-stripes.log + [EMAIL PROTECTED]@=/tmp/testrepository [EMAIL PROTECTED]@=/tmp/testworkdir [EMAIL PROTECTED]@=/tmp/jspwikitests.log + [EMAIL PROTECTED]/tmp/testrepository/auth.txt [EMAIL PROTECTED]@=tests/etc/filters.xml + +# JavaMail configuration [EMAIL PROTECTED]@=127.0.0.1 [EMAIL PROTECTED]@=25 [EMAIL PROTECTED]@=JSPWiki <[EMAIL PROTECTED]> [EMAIL PROTECTED]@=foo [EMAIL PROTECTED]@=foopassword + +# Enable these if you wish to create a static content tarball +# for use with Apache or another front-end web server. +# You should specify user and group names that make sense for +# your environment. + +static.user = apache +static.group = daemon +jks.password = jspwiki + +# +# If you are running web tests, these need to be set to your +# Tomcat admin name and password. +# +tomcat.admin=tomcat +tomcat.password=tomcat +tomcat.host = localhost +tomcat.port = 8080 +tomcat.protocol = http + +# +# JDBC testing properties +# +jdbc.driver.id=hsql +jdbc.driver.jar=tests/lib/hsqldb.jar +jdbc.driver.class=org.hsqldb.jdbcDriver +jdbc.driver.url=jdbc:hsqldb:hsql://localhost/jspwiki +jdbc.admin.id=SA +jdbc.admin.password= +jdbc.user.id=jspwiki +jdbc.user.password=password +install.fulldir=/usr/share/java/tomcat/webapps Propchange: incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/build.properties ------------------------------------------------------------------------------ svn:executable = * Added: incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/build.properties.win URL: http://svn.apache.org/viewvc/incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/build.properties.win?rev=627288&view=auto ============================================================================== --- incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/build.properties.win (added) +++ incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/build.properties.win Tue Feb 12 22:42:38 2008 @@ -0,0 +1,22 @@ +# +# This file contains defaults for development. If you are cross- +# developing in multiple environments, just change the defaults +# in this file. +# +# Any changes in this file will be reflected in the default +# jspwiki.properties-file when it is run. +# +# Java and Windows do not mix too well, so you will have to put +# four \'s for every \ in the path... +# [EMAIL PROTECTED]@=JSPWiki [EMAIL PROTECTED]@=C:\\\\temp\\\\wikipages [EMAIL PROTECTED]@=C:\\\\temp\\\\jspwiki.log + [EMAIL PROTECTED]@=C:\\\\temp\\\\testrepository [EMAIL PROTECTED]@=C:\\\\temp\\\\testworkdir [EMAIL PROTECTED]@=C:\\\\temp\\\\jspwikitests.log + +# JavaMail configuration [EMAIL PROTECTED]@[EMAIL PROTECTED] [EMAIL PROTECTED]@=localhost Added: incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/build.sh URL: http://svn.apache.org/viewvc/incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/build.sh?rev=627288&view=auto ============================================================================== --- incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/build.sh (added) +++ incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/build.sh Tue Feb 12 22:42:38 2008 @@ -0,0 +1,3 @@ +#!/bin/sh + +ant -Dbuild.properties=build.properties -find Added: incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/install.sh URL: http://svn.apache.org/viewvc/incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/install.sh?rev=627288&view=auto ============================================================================== --- incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/install.sh (added) +++ incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/install.sh Tue Feb 12 22:42:38 2008 @@ -0,0 +1,42 @@ +#!/bin/sh +# +# A very simple installer script which restarts tomcat as well. +# +# This is just a sample. +# + +if [ "$1" = "public" ] +then + echo "Installing in public" + TOMCAT_HOME=/p/web/tomcat/current/ + private=0 +else + echo "Installing in private" + TOMCAT_HOME=$HOME/jakarta-tomcat-3.2.2 + private=1 +fi + +$TOMCAT_HOME/bin/shutdown.sh + +ant clean +ant war + +rm -rf $TOMCAT_HOME/webapps/JSPWiki +USER=`whoami` +cp /tmp/$USER/JSPWiki/install/*.war $TOMCAT_HOME/webapps + +cd $TOMCAT_HOME/webapps +rm -rf JSPWiki +mkdir JSPWiki +cd JSPWiki +jar xf ../JSPWiki.war + +# +# Copy private things. +# +if [ $private -eq 1 ] +then + cp -v $HOME/Projects/JSPWiki/jspwiki.properties $TOMCAT_HOME/webapps/JSPWiki/WEB-INF/ +fi + +$TOMCAT_HOME/bin/startup.sh Added: incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/run_webtests.sh URL: http://svn.apache.org/viewvc/incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/run_webtests.sh?rev=627288&view=auto ============================================================================== --- incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/run_webtests.sh (added) +++ incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/run_webtests.sh Tue Feb 12 22:42:38 2008 @@ -0,0 +1,50 @@ +#!/bin/sh +# +# This script runs the WebUnit tests for JSPWiki. You should tweak +# it according to your own setup. You can also look on all the things +# that the webtests expect to be running. +# +# Couple of notes: +# +# This script is destructive in the sense that it will restart your +# tomcat, and also remove configuration files. +# +# Make sure that your junit.jar can be found in the classpath. +# The last resort is to drop it in your $JAVA_HOME/lib/ext, or on OSX +# /Library/Java/External/ +# +# This is tuned for Tomcat 5.5. Any previous/later version may have +# unintended consequences. +# + +export CATALINA_HOME=${HOME}/Java/tomcat-webtest + +BUILD_PROPERTIES=build.properties + +if [ "${JSPWIKI_BUILD}" ]; +then + BUILD_PROPERTIES=${JSPWIKI_BUILD} +fi + +echo "Using property file ${BUILD_PROPERTIES}" + +if [ ! -f "${BUILD_PROPERTIES}" ]; +then + echo "Cannot find ${BUILD_PROPERTIES}" + exit 1 +fi + +# Shutdown tomcat + +echo "Restarting tomcat..." + +${CATALINA_HOME}/bin/shutdown.sh > /dev/null + +sleep 5 + +rm -rf ${CATALINA_HOME}/webapps/test* +rm -rf ${CATALINA_HOME}/conf/Catalina/localhost/test* + +${CATALINA_HOME}/bin/startup.sh > /dev/null + +ant -Dbuild.properties=${BUILD_PROPERTIES} -find build.xml webtests Propchange: incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/run_webtests.sh ------------------------------------------------------------------------------ svn:executable = *
