This documentation relates to the latest version of Confluence.
If you are using an earlier version, please go to the documentation home page and select the relevant version.

Userinfo Plugin Tutorial

Added by Charles Miller, last edited by Charles Miller on Jun 30, 2006  (view change)
All Versions
Click for all versions
Confluence 2.9 Documentation

Index

Introduction

This tutorial is being written during the course of the development of a Confluence plugin. It is a demonstration of a number of techniques and tips useful to plugin development, and also of how all the various types of Confluence plugin modules can be combined to add new features to the Confluence application.

The plugin being developed during the course of this tutorial is not just a toy or a random idea that was thought up to write a guide around, it's actually something that we intend to make use of on the Atlassian extranet, fulfilling a real requirement of our business.

I'm hoping to add new chapters to the tutorial each week until it development of the plugin is complete.

Requirements

In order to get the most out of this tutorial, you should have:

  1. Confluence 2.2 (the plugin makes use of features that were not available in Confluence 2.1 or earlier)
  2. A suitable plugin development environment.

The Plugin

On the Atlassian extranet, which is obviously powered by Confluence, we keep a staff directory. This directory is really just a single Confluence page with a section for each staff member. Here's mine:

When we started the page, there were only about twenty people in the company. Now we've grown over fifty, it has started to become unwieldy, and with each new hire it gets a little harder to maintain. Thus, the aims of the userinfo plugin are:

  • Allow users to maintain their own contact details
  • Provide a way to display contact information in wiki pages

Once that's done, we could add more features like:

  • A searchable / categorisable staff directory
  • vCard export of contact information
  • iCal export of staff birthdays

(How many of these we get done really depends on how much time I have to spare )

Contents

Coming Soon:

Labels:

confluence confluence Delete
confluence22 confluence22 Delete
plugins plugins Delete
tutorial tutorial Delete
developer developer Delete
Enter labels to add to this page:
Wait Image 
Looking for a label? Just start typing.

Comments (10)

 

  1. Jul 17, 2006

    Rajendra says:

    waiting for third part of this tutorial. So far it's been great learning. I'm su...

    waiting for third part of this tutorial.

    So far it's been great learning. I'm sure past job was as Teacher

     -

    Rajendra 

  2. Jul 17, 2006

    Rajendra says:

    i mean your job ...

    i mean your job ...

  3. Oct 13, 2006

    Jeff Smith says:

    Charles, I was wondering if Confluence had any kind of "contact management" and...

    Charles,

    I was wondering if Confluence had any kind of "contact management" and I came across this page. I would really like to see this kind of thing implemented. Do you see this evolving into more of a generic address book, or just contacts for registered confluence users?

    cheers,
    Jeff

  4. Nov 30, 2006

    Bjarki Jonsson says:

    This is something we have been looking and waiting for in Confluence, any news o...

    This is something we have been looking and waiting for in Confluence, any news on this?

    regards,

    -b

  5. Dec 03, 2006

    Michael McKeown says:

    I'd like to see this completed too!

    I'd like to see this completed too!

    1. Feb 07, 2007

      Christian Løverås says:

      AOL! :)

      AOL!

      1. Feb 07, 2007

        Christian Løverås says:

        Or at least: The opportunity do download and use this plugin. That would be grea...

        Or at least: The opportunity do download and use this plugin. That would be great!

  6. Mar 20, 2007

    Simon Mittag says:

    Charles, this plugin is a pretty cool idea! Our people directory is immensely po...

    Charles, this plugin is a pretty cool idea! Our people directory is immensely popular, yet suffers from lack of structured, searchable information, like phone numbers, AIM etc.

    Any chance of this getting properly released? Does the confluence 2.3/2.4 plugin API change any of this tutorial? Is it possible to package this as a downloadable repository plugin, while still overwriting the relevant built in decorators for the confluence UI?

  7. Oct 26, 2007

    Anonymous says:

    First a suggestion:adding a micro format for the contact info.\\ Question, How c...

    First a suggestion:adding a micro format for the contact info.

    Question, How can one overload the main.vmd that is applied to this area.  It seems that the <pattern>*</pattern> that is applied to /display/user.  I want to be able to apply our custom decorator buy since so much happens at /display i can't seem to add a decorator that listens at /display/* or something similar.

    Any advice would be great.

    Thanks 

    1. Oct 29, 2007

      Mei Yan Chan says:

      Hi, It would be appreciated if you can elaborate more on what you intended to a...

      Hi,

      It would be appreciated if you can elaborate more on what you intended to achieve? I presume that you would like to override the main.vmd in the custom decorator, however, this file is not within the plugin. Do correct me if I've misinterpreted your question? Furthermore, I would recommend you to create a support request at the link below for a better follow up. Thanks.

      Regards,
      Mei

Add Comment