Appendix E. The udx Utility

Not all processors will support uDoc tag minimization features. So along with the mxlparser, we provide a utility, udx, to transform uDoc files containing short tags and wiki symbol markup into files with full MicroXML tags. For ease of authoring and editing, the same utility can convert the other way, replacing full tag markup with minimizations wherever possible. Either way, the conversion is lossless.

The rules udx uses are simple, and are controlled by a number of settings in udx.ini. The defaults are built iinto the software, and can be overridden by command-line switches and by modifying the corresponding udx.ini settings. The element properties in [CodeElements] and [ElementTypes] are used for the wiki symbol processing and for adding <p> tags within block elements that wrap text. If you create new elements meant to contain code, or create new text or inline elements, add those new elements to udx.ini.

Sometimes you may want udx to skip some parts of a file, while processing others. The <udx> tag provides this functionality within a document.

Full-tag creation from short tags and from wiki symbols is the default operation, and can also be specified with the “-f” switch on the command line. It does four things:

Tag minimization is specified with the “-m” switch on the command line. There are four actions it performs:

The udx utility is released as FOSS under the Apache 2 license to permit commercial use. It uses and includes the MXL parser. Downloads are available on the uDoc2Go site for the Windows executable and the C++ source. The utility is also hosted on GitHub.

Previous Topic:  D.4 Licensing

Next Topic:  E.1 The udx Switches

Child Topics:

E.1 The udx Switches

E.2 The udx.ini File

E.3 The <udx> Tag

Sibling Topics:

The uDoc Document Format

Chapter 1. Why Use uDoc?

Chapter 2. uDoc Structures

Chapter 3. uDoc Processing

Chapter 4. uDoc Addressing

Chapter 5. uDoc File Generation

Chapter 6. uDoc Elements

Appendix A. Comparison of Markup Formats

Appendix B. uDoc Sample Files

Appendix C. Standard uDoc Libraries

Appendix D. MXL MicroXML Parser