sdoc is the current umbrella name for both the markup language and the parser we use to generate documentation for the SEUL Project. The format is based on HTML, and consists of extra tags to provide a faster way to build pages, concentrating on content rather than presentation. The parser is a basic SGML core, with hooks to allow the contents of any tag to be passed into a handler script for processing.
sdoc is primarily intended as a way to build an entire web site in a single style, while offloading the work of building that style to one entity in charge of the site. Maintaining a single look throughout the website with dozens of authors in many countries/timezones would be impossible if all the pages were editted in raw HTML. As such, all tags that exist to date are designed for the SEUL website.
Much of the functionality comes from slightly modifying or augmenting existing HTML tags:
There are a few new tags that are specific to the webpage doctype for now, but may appear (likely with different output) in other doctypes in the future:
A basic document is quite simple to create. By far the simplest method would be to copy the following example and fill in the appropriate information. The HTML output is also available.<HTML>
<META name="doctype" content="webpage">
<META name="author" content="Erik Walthinsen (omega)">
<META name="description" content="Basic placeholder file, an example">
<META name="keywords" content="placeholder, sdoc, example">
<p>Pathetic placeholder file</p>
$Id: writing.html,v 22.214.171.124 2001/02/08 20:09:05 arma Exp $