home FrontPage

Devdocs main · MNTB wikis main · Up one level (only works on a non-FrontPage)

Welcome!

This ZWiki is for explaining/discussing the Connexions projects author submission policy

Procedure for submitting modules/courses into the Connexions system

One of the primary goals of the Connexions project is to provide an environment where many authors can contribute content in their area of expertise/interest. We envision content creation as a collaborative endeavor between faculty, their students, and end users.

At present, WYSIWYG editors that would make CNXML and MathML? mark-up painless are not yet available. While we are working extremely hard to provide easy to use environments in the future, it is clear that we cannot wait for these tools before we build up significant content. Connexions authors need to remember that they are pioneers and truly doing something that has never been done before.

To make the content generation process as painless as possible for pioneering authors, for the time being, we are asking that authors create and submit modules in plain text format without equations. More specifically, to:

  1. Create a workgroup for yourself or your team using the author website at cnx.rice.edu, and decide who will be resposible for specific material. Add all of the authors you will be collaborating with to the workgroup.
  2. Create a new module in the Connexions author system using the author website at cnx.rice.edu. Indicate the author(s) and maintainers. (We will let you know the name of the Rice Connexions student who will help you maintain your modules. You might also want to get your students involved as maintainers and maybe even as co-authors.)
  3. Input the text of your module in plain text format - no CNXML or MathML? tags are required, but leave blank spaces where the equations should go and indicate the positions of the figures. Also indicate any hyperlinks to other Connexions modules or WWW pages.
  4. Print out the raw text.
  5. Legibly hand-write the equations on the printed document. Optionally, feel free to write latex formulai in the module (but no macros) or write out unusual characters in, say, square brackets as in [OMEGA] and [2 pi f]?.
  6. Create your figures with whatever drawing package you are comfortable with, but convert them into postscript format for submission. Upload the figure files with the module.
  7. Mail or fax your printed pages to Connexions at 713-348-5686, and we will add the cnxML tags, convert the equations to mathML, and add the figures. We will then notify you so that you can proofread the module and suggest corrections.
  8. For any questions or comments feel free to contact Brent Hendricks (Brentmh@rice.edu) or the connexions content coordinator Adan Galvan (jago@rice.edu).

    Be aware that Connexions modules should not simply be a text book chopped up into smaller pieces. As you write modules, think of them as self-contained nuggets that can stand on their own and be re-used in many different contexts.

    We highly recommend getting students involved in authoring. We have seen several cases here at Rice where the collaborative effort between outstanding students and faculty have resulted in really excellent content. The model which seems to work best is that the student works from class notes, handouts, and overheads to write a first draft of module. The faculty member then makes suggestions for improvements, clarifications etc., which are then incorporated into the draft. Finally when enough modules are written to make a "chapter", they are "Connexized" and the whole body of work is reviewed one more time for completeness and consistency. This is also a good time to review other modules in the Connexions database to add references and links.

    Please be aware that with our current system and tool set, it can take several months from the time all of your modules have been submitted to having a final version available on the web and in printable (PDF) form. An entire course worth of modules starting from raw text will take up to nine months to mark-up, proof, and finalize.

    A typical time line would look something like this:

    • Nine months prior to the start of the course: Begin writing modules
    • Three months prior: All content in the Connexions system
    • Six weeks prior: Proof to author(s)
    • Four weeks prior: Proof back from author(s) with corrections
    • Two weeks prior: Final sign-off by author(s)
    • One week prior: All modules available on Connexions and PDF file run.

    We welcome any comments or suggestions on this system since it is designed to make the author's job as simple as possible.

For more information, see: HelpPage, RecentChanges, ZWiki

128.42.12.234, 2002/01/23 14:36:35.6142 US/Central (via web):
for the written version of equation, add a written symbolic version of the equation, as well as a written-out version of the canonical spoken form of the equation