Macrobyte Resources Conversant Developer Central
Internet groupware development platform
First Look at the Documentation Outline




 
Subject First Look at the Documentation Outline
Posted 6/5/2002; 3:33 PM by Seth Dillingham
Last Modified 6/5/2002; 6:03 PM by Seth Dillingham
In Response To (#Top of Thread.)
Label High Read 5644
<Previous Next> Thread: Edit Reply
The basic outline of the documenation that we're writing for Conversant is ready, and we'd like to hear your comments on it. You probably won't learn much from reading the outline (it's really just a table of contents), but your feedback will help us finalize it.

The 1.0 release of Conversant is waiting for just two things: documentation and a licensing tool. The licensing tool is almost ready, but the docs are not. We're not planning to write all of these docs before the release, as that'll take too long, but we are going to finish the most important parts. That's another part you can help with: which parts are the most important to you?

As you peruse the outline, you'll see that there are question marks in some places. These are the things we're not sure about yet, and are definitely subject to change. (None of it is set in stone, but those areas with question marks are the least stable.)

Finally, you can read the outline either on the web site, or in the attached outline file (if you have Radio or Frontier installed).

Enough preamble! Your comments are welcome and most appreciated...


Outline of Documentation for Conversant
Preface
Introduction
Overview of Conversant
Philosophy
Features and Benefits
Developers: Frameworks vs. Applications
Conversant comes with both
Example Uses?
Concepts and Terminology
Zones
Conversations
Members
Groups
Messages
Enclosures
Preferences
Templates
Pages (Files and Folders)
Getting Started
Installing Covnersant
Creating a Conversant Site
From the wizard
From scratch
Administrators
Adding Members
Messages
Creating
Editing
Deleting
Bound Message Pages
Macros (Intro)
Conditional Macros (Intro)
Templates (Intro)
Admin Interface
Overview
Members
Overview
Creating, Editing, and Deleting Members
Setting Member Prefs
Groups
Overview
Creating, Editing, and Deleting Members
Setting Member Prefs
Conversations
(All items in this section should discuss only the functionality offered by the page in the admin interface, and then refer to other pages for more information on the related feature in Conversant.)
Overview
Messages
Preferences
Labels
Custom Fields
IP Security
Javascript
Logs
Navigation
Page Themes
Resources
Structure
Stylesheets
Templates
Zone
Overview
Preferences
IP Security
System
Overivew
Zones
Preferences
Administrators
Logs
Macros
Overview
Format
Parameters
Evaluation
Examples
Conditional Macros ?
(too advanced for this section?)
Templates
Overview
Read-Only
Types
Creating
Editing
Deleting
Pre-Compiled ?
InsertTemplateMacro ?
Javascript
Overview
Editing
Javascript macro
Linking vs. Embedding
Stylesheets (CSS)
Overview
Editing
Stylesheet macro
Linking vs. Embedding
Resources
Overview
Types
Custom Fields
Overview
Types
Conditional Macros
Overview
Format
Complex Conditionals (Parens and boolean operators)
Page Types
Overview
Advanced Query Page
Bound Message
DG Calendar Page
Directory Mirror
Enclosure Page
Full Thread
Query ?
Redirect Page
Topics Page
Weblog
Weblog View
WebOutline
Security
Overview
Web
Email
Guests, Members, and Administrators
Plugins
Overview of Conversant Plugins
Everything's a Plugin (Philosophy of the Plugin Interface)
Default (Shipping) Plugins
Example Uses for Custom Plugins ?
Create Your First Plugin
(this plugin will be used for all subsequent sections of the plugings docs, and if the read the docs from beginning to end they'll have a new, fully-functional plugin that makes use of all of the major features)
Instructions for starting a new plugin
Format of New Plugins (what goes where)
Only include what the plugin needs (optional parts)
Callbacks
Overview
How they're called
Review of what's available
Add some callbacks to your plugin
Read-Only Templates
Overview
Review: Template Types and Pre-Compiled Templates
Add some read-only templates to your plugin
Preferences
Overview
Add some preferences to your plugin
Macros
Overview
Parameters
No-further-processing
Post-processing options
(urlEncode, entify, etc.)
Add some templates to your plugin
Add the Conv_processMacros callback
Pages
Overview
#content receiver script
#objectNotFoundHandler receiver script
#processVirtualPage receiver script
Supporting callbacks in your pages
Page Properties
Direct callbacks from MRI's pages scripts
Create a new page type in your plugin
Custom Field Types
Overview
?
Conditional Macros
Overview
?
Interfaces
Overview
?
Styles ?
Overview
?
Tools
Overview: "Put anything in the tools table."
Membership Mgmt. and Databases
Overview
Groups
Conversant.members vs. Twine.users
Default user engines
Writing a custom user engine
Message Databases
Overview
Conversant.messages vs. Twine.messagestore
Default Messagestore engines
Writing a custom messagestore engine
Appendix - Conversant API Reference
Overview
Conversations
IO
Members
Messages
Plugins
Preferences
Scheduler
Styles
System
Templates
Zones
Appendix - Callback Refnerence
Overview
(Should this be part of the API reference, as it will have a similar structure? There are also callbacks in the IO plugins which might make that awkward, so I'm voting for a separate callback reference.)
Appendix - Conditional Macro Reference
Overview
Appendix - RSS and other XML Formts
Overview
<Previous Next> Thread: Edit Reply
ENCLOSURES

Docs Outline.ftop (8K)
REPLIES

RE: First Look at the Documentation Outline
6/6/2002 by Donald W. Larson
My only suggestion would be to add example code for each place that needs it

RE: First Look at the Documentation Outline
6/6/2002 by Samuel Reynolds
Just a few things: 1. Licensing tool: Will this be available to/licensable

RE: First Look at the Documentation Outline
6/14/2002 by Clark Venable
Seth and I have had occasion to discuss the performance of Conversant on a

RE: First Look at the Documentation Outline
6/14/2002 by Clark Venable
Some thoughts (from a non-developer): Please consider including a section on

RE: First Look at the Documentation Outline
7/8/2002 by Bradford Powell
I wondering how one can even begin considering using Conversant without knowing



 
© 2002 Macrobyte Resources. All rights reserved.