Introduction
The Connexions
Project's authoring system is designed to facilitate
collaborative editing of educational materials. This document
explains some of the details of that system. The major
functionality is divided into two main areas:
- Managing Workgroups
- Managing Modules
Managing workgroups
Workgroups are a private "scratch area" for
groups of authors to work on a common set of modules. This
allows people working together to see their progress without
having to make it available to the whole world (although
workgroups were designed to facilitate multiple authors, an
individual may want to create a workgroup of only one person,
and create and edit his or her own modules in that workgroup).
Warning:
Remember that workgroups are not a replacement for
communication between authors. In particular,
workgroups have no control hierarchy, and the creator of the
group has no special privileges. Any member may add or
remove members or modules.
To join a group, a current member of the group must add you to
the group. There is currently no mechanism for requesting
addition to a group; it is assumed that, for the time being,
all collaborators have other means of communication with each
other and can form groups by common consent. "Leaving" a
group means you will no longer be a member. For you to become
a member again, a current member must add you again. Once
every member of a group has left the group, the group will be
deleted. The last member to leave will be asked to confirm
this step.
Each workgroup can have a number of modules that are
associated with it. In order to actually edit the module, a
member of the workgroup needs to
checkout the
module to the workgroup. Once it is checked out, any member
of workgroup who has editing permission may make changes to
module that module.
Note:
Workgroups are independent of editing privileges; a
workgroup is simply a place to list and track modules. To
edit a module you must be a maintainer for that module
warning:
A module can be associated with any number of workgroups.
This may cause some confusion for the authors if they are
not careful.
Managing modules
Modules are stored in a robust versioning system called CVS.
Version tracking is very important to an open-content project,
because when a change is made to a module, some instructors
may wish to use the old module and some may wish to use the
new module. When collaborating with other others, you may
also want to compare previous versions. CVS handles the work
of keeping all past and current versions simultaneously
accessible without having to store them separately.
Authors interact with CVS only through the
authoring interface to
the Connexions
module repository. The repository
holds and provides access to all of the Connexions project's
modules. Common activities to perform on modules include: