Developers Welcome!

You've stumbled onto the Clearspace Developer Guide. Here you can read the latest developer documentation and FAQs, along with questions and answers.

Find What You Need

Search

Ask

Post a question.

Browse

Use links on this page or the lists of documents or discussions in this community.

Places to Start

Building Plugins

By building plugins, you can add new features to Clearspace. This includes new widgets and other UI features, as well as back-end components such as web services or custom authentication providers.

Building Actions

You can build plugins that enhance Clearspace with links to new functionality, additions to the admin console, and additions to the end user UI.

Building Widgets

This introduction gives you the basics on building widgets -- views for displaying content on customizable Clearspace pages.

Building Macros

This introduction gives you the basics on building macros -- tools to make it easier for people to add and format content through the content editor.

Clearspace Architecture

This high-level overview of Clearspace technologies provides links to more information about the pieces themselves.

Themes Overview

Whether basic, in-between or advanced, themes customize the application's look and feel.

 

Spotlight Areas

Each of the following sets of topics focuses on a particular area of Clearspace development. Click a link to view a list of topics as they're grouped by tags. Above the topic list, you'll be able to edit the focus by adding or removing tags to filter it.

Front-End

Back-End

Content Types

Technologies

References

Javadoc

Clearspace API reference.

Plugin XML Reference

This reference describes the elements and attributes that make up a plugin's configuration XML file.

UI Components XML Reference

This reference describes the elements and attributes through which you can can UI components to Clearspace. You use the elements described here in a plugin.xml file.

Database Schema Guide

This document describes tables in the Clearspace database.

REST Web Services Reference

This document list the web services that Clearspace exposes via REST, or Representational State Transfer.

SOAP Web Services Guide

If you're looking to use SOAP-style web services to access Clearspace, this basic information can get you started.

Actions

Notifications

Latest Poll

What version of the JDK do you use? - More polls 1.6 (85%) 1.5 (15%) 1.4 (0%) Votes 13 - Full Results

About This Guide

It's a work in progress.

On this page (the one you're looking at), we're trying a few things. Scroll down to see our efforts to make it easier to find content. You can search, post a question, or just poke around. In "Places to Start," you'll find some of our intro topics. In "Spotlight Areas," we've put up links that take you to lists of topics collected by the tags we've used to categorize them ("struts," "security," "themes," and so on). See what you think.

 

So what's different?

Well, for one thing, we don't have a "developer blog" or a "developer chat." You'll still find blogs on Jivespace, of course, including on developer ideas. But we're streamlining things.

 

And yes, you'll still find Clearspace documentation on the Jive Software web site. But consider that archived content (you wouldn't want version 2.0.9 developers to be left out, would you?). The latest developer stuff is here.

Where sample code lives.

It's not here. We've put up a public Subversion project. You can get sample code there (some of it pretty cool actually). Check it out.