1.2 (2019-02-09)

Mallard 1.2 DRAFT

This is a draft specification. It is likely that changes will still be made before the final specification.

Mallard is a markup language for dynamic, topic-oriented help. It is designed to be as simple as possible, while still providing the features needed for a modern help system. Mallard features a unique reciprocal linking system that helps writers create flexible help frameworks that are easy to extend with new content. Writers can create an outline-like structure, and as they add new help topics, the reciprocal linking mechanism will neatly integrate the new help topics with the existing help topics.

These pages serve as the official specification for the Mallard 1.2 markup language. Mallard is formally defined using a RELAX NG schema, maintained in compact syntax in code blocks throughout this specification. These are automatically extracted to create the official schema.

The specification is designed to be easy to read, with plenty of notes and examples. It can serve as a reference for those already familiar with the basic concepts of Mallard. For an introduction to Mallard, see Learn Mallard on projectmallard.org.

© 2007-2011 Shaun McCance
© 2011 Jim Campbell
cc-by-sa 3.0 (us)

This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.

As a special exception, the copyright holders give you permission to copy, modify, and distribute the example code contained in this document under the terms of your choosing, without restriction.

Powered by