Translations : Français | Italiano

Oscailt Documentation

This is the home page of the Oscailt Documentation site. We hope to include all sorts of documents here covering the oscailt codebase and to install and maintain it. Some article stubs have been provided to get the ball rolling, feel free to edit, combine or breakdown further the topics of these stubs.

General Introduction and Background to Oscailt

• History of Oscailt
• Basic Design of Oscailt
• Why Use Oscailt?
• Licence
• Contributors to Oscailt
• Helping Out with Oscailt
• Download (sourceforge site)
• http://lists.indymedia.org/mailman/listinfo/oscailt
• Example Site
• What's Missing?
• Oscailt's Roadmap

Installation Guide

• Requirements
• How to Install Oscailt
• How to Upgrade from previous version of Oscailt

User Guides

• How to publish
• Frequently Asked Questions^?

Editor Guides

• How to moderate the newswire
• How to create features
• How to use macros in story content
• How to use the clipboard^?
• Other Editorial Functions^?
• Edit Locks

Administration Guides

• How to Configure a New Site
• Server Administration Index Page
• Oscailt Main Configuration Page
• How to Add new Topics, Regions, Types and Languages^?
• How to Manage Users, Roles and Permissions^?
• How to Maintain an oscailt installation^?
• How to Fight Spam and other abuse with Oscailt
• Frequently Asked Questions

Layout Management Guides

• How to Modify Oscailt Modules^?
• How to Create New Oscailt Modules^?
• How to Change Page Layouts^?
• How to Manage page styles and graphics^?
• How to Build Multi-Lingual Sites^?

Oscailt Modules

• Introduction to Modules

Basic Elements

• Introduction to Basic Elements^?
• Static Document Module
• Simple Link Module
• Picture Box Module
• Code Box Module
• Category Listing Module
• Filter Box Module
• Headline Box Module
• User Preferences Module

Core Site Modules

• Introduction to Site Modules^?
• Newswire Module
• Feature-wire Module
• Archive Module
• Gallery Module
• Latest Comments Module
• Publisher Module
• Article Viewing Module
• Archive Search Module
• Events Calendar Module
• Imported Feed Module
• Exported Feed Module

Layout Elements

• Introduction to Layout Elements
• Vertical Menus
• Horizontal Bars
• Inset Boxes
• Listing Boxes
• Page Layouts

Site Sub-sections

• Introduction to Site sub-sections^?
• Site Sub-Section Module^?

Developer Guides

• How to develop a new plugin
• Frequently Asked Questions^?

Design And Architecture

• General Design Notes
• Database and Database Access Objects
• Module Architecture^?
• Feeds^?

Bugs Problems and Feedback

• Bugs in the Oscailt 3 code

-- ChekovFeeney - 04 Jul 2005
-- VinnieC - 05 Jul 2005 added stubs for some desired documentation
to top