XWiki Installation Manual - GreenPepper Open Documentation Refactoring

Manual installation

The manual installation involves many actions and should be executed by someone familiar with XWiki. In case the installation does not work, consult our forum and don't hesitate to ask for help.

From an existing XWiki installation, stop the XWiki instance if it is running then execute the following actions.

Copy to WEB-INF/lib

Copy the greenpepper-xwiki-plugin-x.x-complete.jar to the WEB-INF/lib directory of your XWiki webapps.

Register the GreenPepper plugin

Add the GreenPepper plugin entry class com.greenpepper.xwiki.GreenPepperPlugin to the list of active plugins under the file WEB-INF/xwiki.cfg.

WEB-INF/xwiki.cfg

#-# List of active plugins.
xwiki.plugins=\
	com.xpn.xwiki.monitor.api.MonitorPlugin,\
	com.xpn.xwiki.plugin.skinx.JsSkinExtensionPlugin,\
	com.xpn.xwiki.wysiwyg.server.plugin.WysiwygPlugin, \
	...
	com.xpn.xwiki.plugin.tag.TagPlugin, \
	com.greenpepper.xwiki.GreenPepperPlugin

GreenPepper web.xml

Add the following XML snippet to the file WEB-INF/web.xml inside the <web-app></web-app> element.

WEB-INF/web.xml

<!-- GreenPepper -->
<listener>
	<listener-class>com.greenpepper.xwiki.web.GreenPepperContextListener</listener-class>
</listener>

<servlet>
	<servlet-name>GreenPepper</servlet-name>
	<servlet-class>com.greenpepper.xwiki.web.GreenPepperServlet</servlet-class>
</servlet>

<servlet>
	<servlet-name>GreenPepper XMLRPC Api</servlet-name>
	<servlet-class>com.greenpepper.xwiki.xmlrpc.GreenPepperXmlRpcServlet</servlet-class>
</servlet>

<servlet-mapping>
	<servlet-name>GreenPepper</servlet-name>
	<url-pattern>*.greenpepper</url-pattern>
</servlet-mapping>

<servlet-mapping>
	<servlet-name>GreenPepper XMLRPC Api</servlet-name>
	<url-pattern>/greenpepper/xmlrpc/*</url-pattern>
</servlet-mapping>

Templates javascript.vm

Add the following code snippet at the end of the file templates/javascript.vm.

templates/javascript.vm

## GreenPepper
#set($gpp = $xwiki.getPlugin("GreenPepper"))
#if($gpp)$gpp.javascript()#end

Templates stylesheets.vm

Add the following code snippet at the end of the file templates/stylesheets.vm.

templates/stylesheets.vm

## GreenPepper
#set($gpp = $xwiki.getPlugin("GreenPepper"))
#if($gpp)$gpp.style()#end

Templates contentview.vm

Using the Colibri Skin

Add the following code snippet before the <div id="xwikicontent">.

XWiki 2.3+

The contentview.vm is not longer under the Colibri Skin directory. Modify the contentview.vm under the templates directory.

contentview.vm

#set($gpp = $xwiki.getPlugin("GreenPepper"))
#if($gpp)<div id="gp_header">$gpp.header()</div><div id="gp_content"></div>#end

Restart XWiki

Restart the XWiki instance and you should be ready to use GreenPepper.