Opened 12 years ago

Closed 12 years ago

#147 closed enhancement (fixed)

Convert Hemlock documentation

Reported by: gz Owned by: rme
Priority: major Milestone:
Component: IDE Version:
Keywords: Cc:

Description

There is a lot of Hemlock documentation that comes with Hemlock - both for users and extension writers - but it needs to be converted from Scribe to a more useful form, perhaps some formalized wiki format.

Change History (4)

comment:1 Changed 12 years ago by gb

Gilbert Baumann (who did the original de-CMUCL-ization of Hemlock) apparently had or has a homebrewed Scribe->HTML converter; it was used to create an annotatable version of the CLIM spec, http://www.stud.uni-karlsruhe.de/~unk6/clim-spec/

comment:2 Changed 12 years ago by rme

  • Owner changed from gb to rme
  • Status changed from new to assigned

comment:3 Changed 12 years ago by alms

How about if we just announce the existence of the documentation to OpenMCL-devel and hint that it would be great if someone wanted to move it into the Trac wiki. We could even point them to page where Matthew did the first chapter, and ask for volunteers to work on the rest.

Following Gail's comment, maybe start with the Command Implementor's Manual, though.

Caveat is that we shouldn't do this if it's all going to change radically because of the work that Gail is currently doing.

comment:4 Changed 12 years ago by rme

  • Resolution set to fixed
  • Status changed from assigned to closed

Converted the Hemlock manuals into the Trac wiki. The formatting is not perfect, but at least the text is there now, and can be updated without too much hassle. (Although a browser text area isn't the most wonderful text editor in the world...)

See HemlockUser and HemlockProgrammer.

Some parts that are obviously irrelevant (the mail and news interfaces, for example) were left out.

Note: See TracTickets for help on using tickets.