From SLIS Second Life Wiki

Contents 1 Sloodle Developer Documentation 1.1 Translation 1.2 Testing 1.3 Programming 1.3.1 Beginners' Guides 1.3.2 Advanced Guides 1.3.3 Testing 1.3.4 Programming References 1.3.5 Other References 1.3.6 SVN 1.3.7 LSL SLOODLE API

Sloodle Developer Documentation

The documentation here is designed for people who want to contribute to the Sloodle project, including programmers, scripters, testers, translators, and others. For quick browsing, you may wish to use the category page to view a complete list of all articles in this section. Otherwise, you may use the sections below.

Translation

If you want to help translate the Sloodle module, then your help is much appreciated! We are working on establishing sensible ways of having multiple languages on this wiki, which would allow you to translate the online documentation. There are also opportunities to translate the contents of the Sloodle module itself, and of the Second Life scripts/objects. Get in touch if you would like to help by posting on our forums at sloodle.org.

The following pages will provide you with more information about translating for each part of the Sloodle project:

• Translating on the Sloodle wiki
• Translating the Sloodle module
• Translating Sloodle objects in Second Life

Testing

Programmers are not perfect, so we are always interested to have people testing Sloodle, especially when we have a new release. The best way to get involved as a tester is simply to install Sloodle on your own Moodle site, get the in-world objects, and try it out!

If you are new to Sloodle, then the following links should help you get started:

• Installing the Sloodle Module
• How do I Get Started with Sloodle
• Getting help with Sloodle

If you discover problems with Sloodle, then please report them! It is also important to test the solutions for problems, as it might take several attempts to properly fix something.

• Reporting Sloodle problems

If you are a programmer, then you are welcome to help fix problems. You will need to get involved with the programming, so see the section below.

Programming

New page: Making new Sloodle objects

Beginners' Guides

Sloodle is a community project which thrives on willing volunteers contributing their time and effort. You are very welcome to contribute as a programmer, although you will usually need some experience of the computer languages involved first. Look at these pages to find out if you are ready:

• What do I need to be a Sloodle programmer?
• Getting started as a Sloodle programmer
• Sloodle programming survival kit

Advanced Guides

• How objects get setup with basic class configuration information
• Moodle-SL Interactions - which objects talk to which scripts?
• Sloodle programming guidelines - a set of principles and conventions to follow when programming

• Sloodle Source Code Repository - the layout of the Sloodle source code repository
• XMLRPC in Sloodle - how is XMLRPC used by Sloodle?
• Update Module Page - how to ensure settings are saved into the DB
• Add Module Page - how to add elements to your modules setup page
• addElement attributes - how to add defaults to your elements, and add help files to your modules setup page

Testing

As a programmer, you will need to test your own code, and will have the opportunity to find and fix bugs and faults. Use the following pages for more information:

• Reporting Sloodle problems
• Fixing Sloodle problems

• Unit tests - testing the Sloodle module

Programming References

There is a lot involved in Sloodle programming, so the reference documentation will get fairly large. It is useful if you know where to look though:

• Sloodle PHP API - PHP classes, functions, constants, and variables
• Sloodle LSL Library - standard LSL scripts and snippets for Sloodle programming

• Sloodle communications specification - the way in which objects and scripts must communicate
• Component Specifications - a description of specifications, and a complete list

Other References

These pages contain other information which may be of interest to Sloodle programmers:

• Roadmap - our development roadmap
• Action Points - weekly list of tasks

SVN

We are currently using SVN to track and manage updates to the SLOODLE codebase. Generally, everything gets checked into the trunk at: http://sloodle.googlecode.com and during releases - we tag the code, which creates a copy of the current trunk specific to that release. If we have to add changes to a tagged version once it's been tagged, the currently tagged version is checked out , the change is commited, and then merged back into the trunk.

For a detailed guide on tagging - see this URL: http://netpl.blogspot.com/2008/12/tortoise-svn-tag-merge-tutorial.html

LSL SLOODLE API

SLOODLE LSL API

This page is part of the Sloodle documentation
SloodleDocs Home | User Documentation | Administrator Documentation | Developer Documentation | Sloodle Wiki Home