ArsDigita Community System Documentation

For everyone:

• ACS FAQ
• Release Notes
• Version History

And if you're a programmer, the ACS 3.2 developers' guide to ACS 3.3 and beyond

For people using the ACS to build and operate a website:

• ACS Installation Guide

  The following documents are being integrated into the Installation Guide; in case of information conflicts, the Installation Guide should usually be given precedence.

  • ArsDigita Server Architecture for ensuring web service reliability
  • Installing under Unix
  • Installing under Windows 2000 (and Windows 98)
  • Upgrading the ACS
  • Installing Webmail

• Getting Started with the ACS (coming soon)

• ACS Administrators's Guide
  • Magic Files
  • Filters and Other Tricks
  • Database Pools
  • Directories
  • Obtaining and Installing APM Packages (coming soon)
  • Monitoring
  • Server Clustering: a facility for keeping state synchronized between a group of load-balanced servers
  • Redirects: ensuring that legacy URLs pointed to by bookmarks and search engines still work
  • Robot detection: making sure that your entire site gets indexed
  • Customer relationship management: tracking a customer relationship through its various states.
  • Member value: a way of accumulating charges for users and then billing them out at the end of each month (commercial sites) or excluding them from the community if the charges get too high (non-commercial)

• Installed Package Documentation

  All package documentation is availabe here.

  Each module is owned by at least one programmer. The current list is in module-owners; each programmer is responsible for maintaining the module and the relevant portion of acceptance-test

  • /doc/ad-functional
  • /doc/ad-trees
  • /doc/address-book
  • /doc/adserver
  • /doc/bannerideas
  • /doc/bboard -- the discussion forum system
  • /doc/bookmarks
  • /doc/calendar
  • /doc/chat
  • /doc/classifieds
  • /doc/clickthrough
  • /doc/contact-manager -- good for sites with an extranet-y flavor
  • /doc/content-sections -- lets administrators add/manage different content sections of the site
  • /doc/contest -- run give-away contests
  • /doc/custom-sections -- allows group administrators add/manage custom sections of the site
  • /doc/curriculum
  • /doc/directory -- letting users find each other
  • /doc/display -- lets administrators set display settings and upload logo of the site
  • /doc/download -- offering versions of software or other stuff to people
  • /doc/dw -- a toolkit for data warehouse-style queries
  • /doc/ecommerce
  • /doc/events -- facilitates online registration for events
  • /doc/faq
  • /doc/file-manager -- simple content management tool
  • /doc/file-storage -- users who don't know HTML can collaboratively maintain a set of files on the server
  • /doc/general-alerts -- module programmers who need a generalized way of sending users email alerts.
  • /doc/glossary -- the ArsDigita Glossary, for creating an on-site dictionary of specialized terminology.
  • /doc/homepage -- give your users personal homepages on your system
  • /doc/intranet -- run your organization from this toolkit
  • /doc/neighbor -- Neighbor to Neighbor (hard to explain; see example at http://photo.net/neighbor/)
  • /doc/news
  • /doc/partner -- site-wide cobranding
  • /doc/poll -- opinion polls
  • /doc/portals -- using only a Web browser, build some portals for different groups within your organization (or the public)
  • /doc/press -- show press coverage about your site or company
  • /doc/pull-down-menus -- create Macintosh-style menu bars
  • /doc/spam -- send email to a group of users
  • /doc/static -- support for collecting comments, links, and download statistics for static files
  • /doc/survey-simple -- ask the users a series of questions
  • /doc/ticket -- a project and bug tracking system
  • /doc/wp -- WimpyPoint, a replacement for desktop bloatware like PowerPoint, allowing you to create and view presentations in your Web browsers

For engineers working on the development of ACS packages, both inside and outside ArsDigita:

• ACS Core Architecture Guide
  1. ACS Package Manager (APM)
  2. Request Processor
  3. Bootstrapping ACS
  4. General Permissions and the Permissions Package
  5. user registration
  6. user administration: how the publisher can select a class of users and what can then be done with that class
  7. user profiling and content categorization: matching users to content
  8. user groups: a general mechanism for lumping users together in groups, e.g., all students in a particular course
  9. user session tracking
  10. Security and Sessions
      • Preventing SQL-Smuggling Attacks
  11. Building Documents
  12. Dynamic Publishing System
  13. API Publication
      • Tcl Procedures: ad_proc and ad_library
      • URLs: ad_page_contract
      • Database Views and Stored Procedures/Functions
  14. Database Access API
  15. Content Repository (coming soon)
  16. Writing an ACS Module
  17. Content Sections
  18. Site-wide Search: a system for indexing all of a site's content in one big table

• ACS Developer's Guide
  • /acs-examples/ -- source code that shows how to use the rest of the software

• ACS Engineering Manual
  • Standards
  • Programming with AOLserver
  • Release Version Numbering

  • Working with XML
  • Supporting WAP (Wireless Application Protocol)

  • Philip's Developer Guide
  • Templates and Multi-lingual Support
  • Building "Help" Documentation for the End-User

  • Tcl API (procedure-by-procedure)

    See also:

    • AOLserver documentation, a notably useful part of which is the Tcl Developer's Guide

  • Module Tools (Library Packages)
    • Audit -- adding a change history to a table
    • Calendar widget -- displaying calendars
    • Content tagging -- useful for finding/screening naughty words but with wider potential as well
    • Email handler -- queues incoming email into an Oracle table; let's you do things like unified customer support or email replies to tickets
    • Graphing -- generating bar charts
    • New stuff -- showing folks what is new site-wide
    • General comments -- allows you to collect user comments on any item
    • General links -- allows you to collect user links on any item
    • Prototype builder -- quickly build standard ACS pages via a user interface
    • Tools -- collections of scripts providing services to perform common tasks such as spell checking.
    • Version Control -- an interface to CVS for modules that need access to a version control system

For systems integrators:

• Systems Integrator's Guide to the ACS
  • Enterprise Java Beans (EJB) and CORBA Interfaces
  • Mainframe Integration
  • LDAP Authentication
  • ERP Integration (e.g., SAP, Oracle Applications) (coming soon)

Installation-Specific

• /doc/patches -- documentation of patches/fixes to the ArsDigita Community System (ACS) on this site; useful when you are upgrading and when we are building a new version of the system
• /doc/custom -- documentation of custom features that you've added to this site that will/can never be rolled into the ACS.

The Glorious Future

• /bboard revision
• general cleanup

Copyright and Legal Status of this Software

This software is mostly Copyright 1995-2000 ArsDigita Corporation and licensed under the GNU General Public License, version 2 (June 1991).