1.9 uDoc Files

The three types of uDoc files are identified by their block root element, doc, map, or lib. A uDoc project is defined by its root map, which contains refs to docs and to other component maps. The map and docs can also contain refs to items stored in the libs. The files can be located anywhere; their relative paths have no effect on the locations of the output files, which are entirely determined by the nesting and content of the refs in the maps.

Note:  It's perfectly OK to have text content in a library, not just the definitions it is meant for. That way your library can be self-documenting.

Previous Topic:  1.8 uDoc Element Types

Next Topic:  1.9.1 uDoc Maps

Parent Topic:  Chapter 1. Why Use uDoc?

Child Topics:

1.9.1 uDoc Maps

1.9.2 uDoc Docs

1.9.3 uDoc Libs

Sibling Topics:

1.1 uDoc Alternatives

1.2 uDoc Error Recovery

1.3 uDoc Interoperability

1.4 uDoc Hierarchies

1.5 uDoc Development

1.6 uDoc Tag Minimization

1.7 uDoc Metadata

1.8 uDoc Element Types




  1. Or use the less specialized .xml extension.