Miramo · Contents mmComposer Reference Guide (v 1.5) iii Font selection

Miramo®

mmComposer

mmComposer Reference Guide

VERSION 1.5

Copyright © 2014–2018 Datazone Ltd. All rights reserved. Miramo®, mmChart™, mmComposer™ and fmComposer™ aretrademarks of Datazone Ltd. All other trademarks are the property of their respective owners. Readers of this documentationshould note that its contents are intended for guidance only, and do not constitute formal offers or undertakings.

‘License Agreement’

This software, called Miramo, is licensed for use by the user subject to the terms of a License Agreement between the user andDatazone Ltd. Use of this software outside the terms of this license agreement is strictly prohibited. Unless agreed otherwise,this License Agreement grants a non-exclusive, non-transferable license to use the software programs and related document-ation in this package (collectively referred to as Miramo) on licensed computers only. Any attempted sublicense, assignment,rental, sale or other transfer of the software or the rights or obligations of the License Agreement without prior written con-sent of Datazone shall be void. In the case of a Miramo Development License, it shall be used to develop applications only andno attempt shall be made to remove the associated watermark included in output documents by any method.

The documentation accompanying this software must not be copied or re-distributed to any third-party in either printed,photocopied, scanned or electronic form. The software and documentation are copyrighted. Unless otherwise agreed in writ-ing, copies of the software may be made only for backup and archival purposes. Unauthorized copying, reverse engineering,decompiling, disassembling, and creating derivative works based on the software are prohibited. This notice is provided forinformation only, and does not constitute a License Agreement. Datazone does not warrant that the software will be free fromerror or will meet your specific requirements.

You assume complete responsibility for decisions made or actions taken based on information obtained using the software.Any statements made concerning the utility of the software are not to be construed as unexpressed or implied warranties.

‘Trademarks’

FrameMaker, Acrobat, Adobe, PostScript, Adobe Illustrator and TIFF are trademarks of Adobe Systems Inc. Windows NT isa trademark of Microsoft Corporation. PANTONE is a registered trademark of Pantone Incorporated. Miramo is a RegisteredTrademark of Datazone Ltd (see above).

‘Acknowledgements’

Miramo includes software developed and licensed by the Apache Software Foundation (http://www.apache.org/) and ICU—International Components for Unicode (http://site.icu-project.org/).

Datazone LimitedPalm Gate,Kenmare,Co. KerryV93KN84Republic of IrelandTel: +353 64 66 289 64Fax: +353 64 66 289 65Email: [email protected]

1.5.0p13-191118

mmComposer Reference Guide (v 1.5) i

Contents

Running mmComposer 1Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Command line options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Root element: <MiramoXML> 3Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

<MiramoXML ... >. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

Inline markup elements 5Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

<AFrame ... >. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

<ATextFrame ... >. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

<Cell ... >. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

<ChangeBarBegin ... />. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

<ChangeBarEnd ... />. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

<Chapter ... >. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

<Contents ... >. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

<ContentsInclude ... >. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

<currentPageNumber ... />. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

<Date ... >. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

<FNote ... >. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

<Frame ... >. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

<HyperCmd ... >. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

<Image ... >. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

<ImageDef ... />. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

<Index ... >. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

<IX ... >. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

<lastPageNumber ... />. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

<Line ... />. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

<ListLabel ... >. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

<MathML ... >. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

<MkDest ... />. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

<ObjectTitle ... >. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

<ParaGroup ... >. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

Contents

mmComposer Reference Guide (v 1.5) ii

<Row ... >. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103

<RunningText ... >. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

<RunningTextMarker>. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

<Section ... />. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

<Tbl ... >. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115

<TblColumn ... />. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

<TblContinuation ... />. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123

<TblTitle ... >. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124

<TextFrame ... >. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125

<Var ... />. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128

<XRef ... />. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

Format definitions 131Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

<ChangeBarDef ... />. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132

<ColorDef ... />. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134

<ContentsDef ... >. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136

<DateDef ... >. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140

<DocDef ... />. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143

<FNoteDef ... />. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147

<FontDef ... />. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

<IndexDef ... >. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157

<MathMLDef ... />. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

<MetaData ... >. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168

<PageDef ... >. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171

<ParaDef ... >. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175

<ParaGroupDef ... />. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187

<RuleDef ... />. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188

<RunningTextDef ... >. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189

<SectionDef ... />. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193

<TblDef ... >. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198

<TblColumnDef ... >. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202

<TblContinuationDef>. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205

<TextFrameDef ... >. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207

<VarDef ... >. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212

<XRefDef ... >. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214

Appendix 1Fonts 217Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217

Supported font types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217

Font installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217

Contents

mmComposer Reference Guide (v 1.5) iii

Font selection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217

Fonts for complex scripts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217

OpenType font features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218

Appendix 2Setting text language 222language usage. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222

Languages values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222

Appendix 3Autonumbering 224Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224

Autonumbering layout. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224

Simple autonumbered lists. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225

Complex autonumbering schemes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226

Unlimited-level hierarchical autonumbering. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229

Alignment of autonumbering. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231

Indented autonumbering. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232

Arabic lists. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234

numberStyle values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235

Appendix 4Summary of element properties & values 236Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236

MiramoXML element. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237

Inline markup elements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238

Format definition elements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251

(BLANK PAGE) mmComposer Reference Guide (v 1.5) iv

Contents

mmComposer Reference Guide (v 1.5) v

List of Examples

Example 1 Multiple objects in an <AFrame ... >.. .... .... .... .... .... .... .... .... .... .... .. 10

Example 2 Including a graphic image (1).. .... .... .... .... .... .... .... .... .... .... .... .... .... ..10

Example 3 Including a graphic image (2).. .... .... .... .... .... .... .... .... .... .... .... .... .... ..11

Example 4 Run-in <ATextFrame ... > (1).. .... .... .... .... .... .... .... .... .... .... .... .... .... .. 16

Example 5 Cell rotation.. .... .... .... .... .... .... .... .... .... .... .... .... .... .... .... .... .... .... .. 19

Example 6 Cell rotation.. .... .... .... .... .... .... .... .... .... .... .... .... .... .... .... .... .... .... .. 20

Example 7 Change bar definition (1).. .... .... .... .... .... .... .... .... .... .... .... .... .... .... .. 22

Example 8 Defining a single-level table of contents.. .... .... .... .... .... .... .... .... .... .. 27

Example 9 Adding another level to a table of contents.. .... .... .... .... .... .... .... .... .. 28

Example 10 Contents list: using <paragraphLabel/> and sub-elements.. .... .... .. 29

Example 11 Contents list: <paragraphLabel/> type property default setting.. .... .... .. 30

Example 12 Contents list: <paragraphLabel/> labelWidth property.. .... .... .... .... .... .. 30

Example 13 Contents list: <paragraphLabel/> labelWidth and labelIndentproperties (1).. .... .... .... .... .... .... .... .... .... .... .... .... .... .... .. 31

Example 14 Contents list: <paragraphLabel/> labelWidth and labelIndentproperties (2).. .... .... .... .... .... .... .... .... .... .... .... .... .... .... .. 31

Example 15 Using <currentPageNumber ... /> within the document main flow.. .... .. 35

Example 16 Using <currentPageNumber ... /> within a background text frame.. .... .. 36

Example 17 Using <PageDef ... >, <Image ... > and <imageReplace ... />.. .... .... .... .. 59

Example 18 Using <ImageDef ... /> (1).. .... .... .... .... .... .... .... .... .... .... .... .... .... .. 60



Example 21 Using the <IX ... > and <IXsub ... /> elements.. .... .... .... .... .... .... .... .. 65

Example 22 Generating a default index.. .... .... .... .... .... .... .... .... .... .... .... .... .... .. 66

Example 23 Generating an index with group titles.. .... .... .... .... .... .... .... .... .... .... ..66

Example 24 <IX ... > entries for different indexes.. .... .... .... .... .... .... .... .... .... .... .. 66

Example 25 Generating an ‘Authors’ index.. .... .... .... .... .... .... .... .... .... .... .... .... .. 67

Example 26 Generating a ‘Book titles’ index.. .... .... .... .... .... .... .... .... .... .... .... .. 67

Example 27 Using <lastPageNumber ... /> within the document main flow.. .... .... .. 68

Example 28 Bulleted list using inline markup (1).. .... .... .... .... .... .... .... .... .... .... .. 75

Example 29 Bulleted list using inline markup (2).. .... .... .... .... .... .... .... .... .... .... .. 76

Example 30 Autonumbered list (1).. .... .... .... .... .... .... .... .... .... .... .... .... .... .... .. 77

Example 31 Autonumbered list (1).. .... .... .... .... .... .... .... .... .... .... .... .... .... .... .. 77

Example 32 Run into paragraph text auto-labeling (1)... .... .... .... .... .... .... .... .... .. 78

Example 33 Run into paragraph text auto-labeling (2)... .... .... .... .... .... .... .... .... .. 78

Example 34 Using a list label leader string (1).. .... .... .... .... .... .... .... .... .... .... .... .. 79

Example 35 Using a list label leader string (2).. .... .... .... .... .... .... .... .... .... .... .... .. 79

Example 36 Including an image in a list label (1).. .... .... .... .... .... .... .... .... .... .... .. 80

Example 37 A simple equation in <MathML ... >.. .... .... .... .... .... .... .... .... .... .... .. 86

Example 38 Using <ObjectTitle ... >.. .... .... .... .... .... .... .... .... .... .... .... .... .... .... .. 90

Example 39 Using the <endTab ... > sub-element.. .... .... .... .... .... .... .... .... .... .. 100

Example 40 Not using <ParaGroup ... >.. .... .... .... .... .... .... .... .... .... .... .... .... .. 101

Contents

mmComposer Reference Guide (v 1.5) vi

Example 41 Using <ParaGroup ... >.. .... .... .... .... .... .... .... .... .... .... .... .... .... .... .. 102

Example 42 Pararagraph-based running text.. .... .... .... .... .... .... .... .... .... .... .... .. 109

Example 43 Including paragraph text in running header.. .... .... .... .... .... .... .... .. 109


Example 45 Simple table.. .... .... .... .... .... .... .... .... .... .... .... .... .... .... .... .... .... .. 119

Example 46 Using <TblContinuationDef>.. .... .... .... .... .... .... .... .... .... .... .... .... .. 123

Example 47 Using default cross-reference definitions.. .... .... .... .... .... .... .... .... .. 130

Example 48 Format definition identifier property names.. .... .... .... .... .... .... .... .... ..131

Example 49 Change bar definition (1).. .... .... .... .... .... .... .... .... .... .... .... .... .... .. 133

Example 50 Change bar usage (1).. .... .... .... .... .... .... .... .... .... .... .... .... .... .... .. 133

Example 51 <ContentsDef ... > format definition for list of tables.. .... .... .... .... .... .. 138

Example 52 <ContentsDef ... > format definition for list of tables.. .... .... .... .... .... .. 138

Example 53 Including a list of tables (1).. .... .... .... .... .... .... .... .... .... .... .... .... .. 138

Example 54 Including a list of tables (2).. .... .... .... .... .... .... .... .... .... .... .... .... .. 139

Example 55 Defining <DateDef ... > variables.. .... .... .... .... .... .... .... .... .... .... .... .. 142

Example 56 Defining <DateDef ... > variables.. .... .... .... .... .... .... .... .... .... .... .... .. 142

Example 57 Using rdim.. .... .... .... .... .... .... .... .... .... .... .... .... .... .... .... .... .... .. 156

Example 58 Simple <IndexDef ... > format definition.. .... .... .... .... .... .... .... .... .. 160

Example 59 A <MathMLDef ... /> format definition.. .... .... .... .... .... .... .... .... .... .. 166

Example 60 A simple equation in <MathML ... >.. .... .... .... .... .... .... .... .... .... .... .. 166

Example 61 Math ML in file referenced in Example 60.. .... .... .... .... .... .... .... .... .. 167

Example 62 Typical <MetaData ... > usage.. .... .... .... .... .... .... .... .... .... .... .... .. 170

Example 63 Including a background image or tint with bleed.. .... .... .... .... .... .... .. 172

Example 64 Using the <PageDef ... > element (1).. .... .... .... .... .... .... .... .... .... .. 172

Example 65 Using the <PageDef ... > element (2a).. .... .... .... .... .... .... .... .... .... .. 173

Example 66 Using the <PageDef ... > element (2b).. .... .... .... .... .... .... .... .... .... .. 173

Example 67 Using the <PageDef ... > element (2c).. .... .... .... .... .... .... .... .... .... .. 173

Example 68 Paragraph input for Figure 54.. .... .... .... .... .... .... .... .... .... .... .... .... ..184

Example 69 <RuleDef ... />s used in Figures 55 and 56.. .... .... .... .... .... .... .... .... .. 185


Example 71 Including paragraph text in running header.. .... .... .... .... .... .... .... .. 192


Example 73 MasterRageRule usage.. .... .... .... .... .... .... .... .... .... .... .... .... .... .... .. 197

Example 74 Using <TblColumnDef ... > in a <TblDef ... >.. .... .... .... .... .... .... .... .. 203

Example 75 The effect of <TblColumnDef ... > in a <Tbl ... > instance.. .... .... .... .. 204

Example 76 Using <TblColumnDef ... > in a <TblDef ... >.. .... .... .... .... .... .... .... .. 204

Example 77 Multi-style and multi-lingual <TblContinuationDef> format definitions 206

Example 78 Defining a page header.. .... .... .... .... .... .... .... .... .... .... .... .... .... .. 209

Example 79 Defining a frame above/below.. .... .... .... .... .... .... .... .... .... .... .... .. 210

Example 80 Using the <TextFrameDef ... > elements defined in Example 79.. .... .... ..211

Example 81 Defining and using named variables with <VarDef ... > and <Var ... /> 213

Example 82 <XRefDef ... > format definition examples.. .... .... .... .... .... .... .... .... .. 215

Example 83 Referencing an <XRefDef ... > format definition.. .... .... .... .... .... .... .. 216

Example A1.1 Characters not included in a font's character set.. .... .... .... .... .... .. 218

Example A3.1 Paragraph format definitions for simple autonumbering (1).. .... .... .. 225

Contents

mmComposer Reference Guide (v 1.5) vii

Example A3.2 Autonumbered input (1).. .... .... .... .... .... .... .... .... .... .... .... .... .... ..225

Example A3.3 Resetting numbering (modification to Example A3.2 ).. .... .... .... .... .. 225



Example A3.6 Autonumbered input (2).. .... .... .... .... .... .... .... .... .... .... .... .... .... ..227

Example A3.7 Paragraph formats for complex autonumbering (E1).. .... .... .... .... .. 227




Example A3.11 Input for three-level autonumbering (E5).. .... .... .... .... .... .... .... .. 230

Example A3.12 Paragraph formats for multi-level autonumbering (E5).. .... .... .... .. 230

Example A3.13 Paragraph format definitions for start-aligned numbering.. .... .... .. 231

Example A3.14 Paragraph format definitions for end-aligned numbering (1).. .... .. 232

Example A3.15 Paragraph format definitions for end-aligned numbering (2).. .... .. 232

Example A3.16 Paragraph format definitions for run into text numbering (1).. .... .. 233

Example A3.17 Paragraph format definitions for run into text numbering (2).. .... .. 233

Example A3.18 Paragraph format definitions for Arabic autonumbering.. .... .... .... .. 234

Example A3.19 Arabic input.. .... .... .... .... .... .... .... .... .... .... .... .... .... .... .... .... .. 234

(BLANK PAGE) mmComposer Reference Guide (v 1.5) viii

mmComposer Reference Guide (v 1.5) 1 of 260

Chapter 1Running mmComposer

Introduction

The simplest mmComposer run command is as follows:

miramo -composer mmc -Opdf output.pdf input.mmxml

The above command processes an mmComposer input file, ‘input.mmxml’, and produces theoutput file, ‘output.pdf’. Input and output files may be referenced either relative to the currentworking folder or via full path names.

Input files must be located in folders that are readable by the mmServer RunAs user account.The mmServer RunAs user account is created during the installation of Miramo. Output filesmust be located in folders that are readable and writeable by the mmServer RunAs user account.

The mmaccess command line utility provides an easy way to grant the appropriate permissionsfor the mmServer RunAs user account. The command:

mmaccess -help

displays a list of the mmaccess options.

Job processing may also be initiated via .NET, C++ and Java APIs. The .NET, C++ and Java APIsare documented in ‘docs\api’ sub-folders in the Miramo installation folder.

Command line options

Table 1 lists the Miramo command line options. Several command line options may be invokeddirectly within the <MiramoXML ... > element (see page 4).

Table 1 List of command line options

Option name and value Description

-composer mmc Required. Every job must be run using the ‘-composer mmc’command line option.

-Opdf filename Required. The output PDF file name. Every job must be run us-ing the ‘-Opdf filename’ command line option.

-mfd filename filename is name of a format definitions file.

-PDFbookmarks All | None | n Show PDF bookmarks, or PDF bookmark levels when output isdisplayed in a PDF viewer. n indicates tbe number of PDF book-mark levels to display.

A value of ‘0’ specifies that only top-level bookmarks are dis-played on first opening in a PDF file viewer. A value of ‘1’ spe-cifies that top-level bookmarks and the next level are displayedon first opening in a PDF file viewer, and so on.

Chapter 1 – Running mmComposer


Table 1 List of command line options (Continued )

Option name and value Description

-cropMarks N | Y Print cropmarks. The media box must be larger than the pagesize.

-mediaSize a3 | a4 | a5 | b5| tabloid | legal | letter |ndimndim

Media size dimensions. Either a keyword value, or a ndimndimvalue. If a ndimndim value, the first n value is the mediawidth, the second n value is the media height, for example:"10cm12in".

The -mediaSize option sets the size of the PDF media box.

By default the size of the PDF media, bleed, trim and crop boxesare the same as the page size specified by the <DocDef .../> or <PageDef ... > elements (see pages 143–146 and171–174).

-showProperties N | Y Show font, paragraph and table properties in annotations inoutput PDF. For use in application development and debuggingonly.


Chapter 2Root element: <MiramoXML>

Introduction

<MiramoXML ... > is the root element. All input must be enclosed within the <MiramoXML ...> element.

<MiramoXML ... >

Chapter 2 – Root element: <MiramoXML>


<MiramoXML ... >

SummaryThe <MiramoXML ... > element is a wrapper, or root element, for the entire input stream.

Properties

Property Value<MiramoXML

Opdf filename

PDF output file name.

mfd filename

Miramo format definitions file name.

PDFbookmarks all | none | n

Show PDF bookmarks, or PDF bookmark levels when output is displayed ina PDF viewer. n indicates tbe number of PDF bookmark levels to display.

cropMarks N | Y

Print cropmarks. The media box must be larger than the page size.

mediaSize a3 | a4 | a5 | b5 | tabloid | legal | letter | ndimndim

Media size dimensions. Either a keyword value, or a ndimndim value. If andimndim value, the first n value is the media width, the second n value isthe media height, for example: "10cm12in".

The mediaSize property sets the size of the PDF media box.

By default the size of the PDF media, bleed, trim and crop boxes are thesame as the page size specified by the <DocDef ... /> or <PageDef ... > ele-ments (see pages 143–146 and 171–174).

language key

Set the document language to key. The key values for the language prop-erty are listed in Table A 2.1 on pages 223–223.

The role of the language property is described in Appendix 2– Settingtext language on pages 222–223.

showProperties N | Y

Show font, paragraph and table properties in annotations in output PDF.For use in application development and debugging only.

</MiramoXML>


Chapter 3Inline markup elements

Introduction

Inline markup elements are primarily containers for document content, with optional format-ting overrides. Inline markup elements are the major in-flow elements within a document, forexample paragraphs, tables and anchored graphics frames.

All inline markup elements, along with their properties/attributes and content must conformwith XML syntax.1

1 See http://www.w3schools.com/xml/xml_syntax.asp for a summary of XML syntax rules.

http://www.w3schools.com/xml/xml_syntax.asp

<AFrame ... >

Chapter 3 – Inline markup elements


<AFrame ... >

SummaryThe <AFrame ... > element may be included at the top level or used within paragraphs(and within paragraphs within table cells) to include anchored graphics frames.

An <AFrame ... > element, or a <Frame ... > element (see pages 49–50), may beused as a container for one or more of, or a combination of, <Frame ... > and <Image ...> elements.

An anchored frame is anchored to a point in the text immediately preceding the<AFrame ... > element.

The positioning of anchored frames relative to their anchor point may be any of the fol-lowing: above paragraph, below paragraph, runin to paragraph and outside text column.

The positioning of items in an anchored frame is relative to the left and top edges of theanchored frame.

Properties

Property Value<AFrame

Frame dimensions

width dim

Width of frame.

The value of width is ignored if wrapContent is set to 'Y' (see wrapCon-tent property below).

Default: '25.4mm'

height dim

Height of frame.

The value of height is ignored if wrapContent is set to 'Y' (see wrapCon-tent property below).

Default: '25.4mm'

Content auto wrappingThese properties are independent of language settings.

wrapContent N | Y

If wrapContent is set to 'Y' then shrink-wrap the right and bottom edgesof the anchored frame to coincide with the rightmost and lowest verticesof the bounding boxes of the included images or frames.

The width and height properties are ignored if wrapContent is set to 'Y'.

Default: '25.4mm'

<AFrame ... >



Property Value

Anchored frame location

position inline | below | inline | runin | outsideTextFrame

Position of anchored frame relative to anchor or insertion point. Theposition property is applicable only when the anchored frame is within a element.

Value Description

inline Within paragraph text. When the position property isset to 'inline' the <AFrame ... > element must contain an<Image ... > element. If position is set to ‘inline’ the align

property is ignored.

below Inside text frame, below current paragraph.

runin Run into paragraph. A maximum of one element with-in a element may have a position property setto 'runin'. The anchored frame should not be located im-mediately before a page or column boundary.

outsideTextFrameOutside of text frame.

If the <AFrame> element is at the top level, outside a element, the‘below’, ‘inline’ and ‘runin’ values are not applicable.

If position is not set to ‘inline’ the lateral alignment of the anchored frameis specified using the align property (see below).

When position is set to ‘outsideTextFrame’ the lateral position of theanchored frame may be further adjusted using the sideOffset property (seebelow).

When position is set to ‘runin’ the top of the anchored frame is alignedwith the top of the text (at caps height) in the first line of the paragraph.When position is set to ‘outsideTextFrame’ the top of the anchoredframe is aligned with the top of the text (at caps height) in the first lineof the paragraph by default. This position may be adjusted using theverticalOffset property (see below).

Default: xxxx

align start | center | end

Lateral alignment of the anchored frame. The align property is ignored ifposition is set to ‘inline’.

Use the align property to control lateral positioning, either within or out-side a text column.

Value Description

start Align left or, if paragraph paragraph text is right-to-left,align right.

center Center the anchored frame between the left and righttext frame borders.

end Align right or, if paragraph paragraph text is right-to-left,align left.

Default: end

<AFrame ... >



Property Value

sideOffset dim

Offset of frame from the alignment position specified by the align prop-erty.

Effective only if the position property is set to 'outsideTextFrame'.

Default: 0

verticalOffset dim

Vertical offset of frame.

Effective only if the position property is set to 'outsideTextFrame'. Valuemay be positive or negative. By default the top of the anchored frame isaligned with the top of the text (at caps height) in the first line of the con-tainer paragraph.

Default: 0

Text runaround gapThe following runaround properties are effective only if the position property is set to 'runin'.

runAroundGap dim

Specify the gap between the anchored frame and text flowing around it.The value of dim may be negative.

Default: 6pt

sideGap dim

Specify the side gap between the anchored frame and text flowing aroundit. The value of dim may be negative.

Default: value of runAroundGap

belowGap dim

Specify the gap below the anchored frame and text flowing around it. Thevalue of dim may be negative.


Indentation properties

startIndent dim

Position of anchored frame relative to the start side of the container.Ignored unless the align property is set to ‘start’.

endIndent dim

Position of anchored frame relative to the end side of the container.Ignored unless the align property is set to ‘end’.

Border pen properties

penWidth dim

Width of border pen. The outside edge of the pen stroke is aligned withthe frame border.

<AFrame ... >



Property Value

penStyle solid | dotted | dashed

Border pen style.

Default: solid

penColor name

Pen color. name is a color defined using <ColorDef ... />.

penTint percent

Pen tint as a percent value in the range 0–100. A tint value of 0 (zero) isthe color white irrespective of the setting of the penColor property.

penOpacity 0 | 100

A value of 100 sets the pen color to 100% opaque. A value of '0' sets thepen color to 100% transparent. (A value of '0' is the same as setting pen-Width to '0'.)

Background fill properties

fillColor name

Background fill color. name is a color defined using <ColorDef ... />.

fillTint percent

Background fill tint as a percent value in the range 0–100. A tint value of 0(zero) is the color white irrespective of the setting of the fillColor property.

fillOpacity 0 | 100

A value of 100 sets the fill color to 100% opaque. A value of 0 sets the fillcolor to 100% transparent.

Include title

objectTitle N | Y

Include title/caption for anchored frame. See the <ObjectTitle ... > elementon pages 88–90.

>

<AFrame> sub-elements

The following elements may be included between <AFrame> and </AFrame>.

<ObjectTitle properties>content</ObjectTitle>

Include a caption for the anchored frame. See the <ObjectTitle ... > ele-ment on pages 88–90 for properties. Not applicable when positionis set to ‘inline’ (see page 7).

<description language ="name">content</description>

Include a description of the anchored frame. This is for a read out loudapplication. The description text is not included in the displayed output.

</AFrame>

<AFrame ... >



Notes1 Multiple <Image ... > and <Frame ... > elements may be included within an

<AFrame ... >, as illustrated in Example 1.

1 <AFrame width="6cm" height="7cm" penWidth="1pt" >2 <Image file="${IMG}/stripe" left="3cm" width="1in" height="1in" />3 <Image file="${IMG}/star" left="4cm" width="1in" height="1in" />4 <Frame left="1in" top="4in" penWidth="0.2pt" > </Frame>5 </AFrame>

Example 1 Multiple objects in an <AFrame ... >

If the placement of graphic objects overlap, later objects are superimposed on earli-er objects.

Examples

Using variations on default properties

Example 2 illustrates how to use the <AFrame ... > and <Image ... > elements to includean image.

1 2 Mt. Fuji in a blue sky.3 <AFrame wrapContent="Y" >4 <Image file="${images}/trainAndFuji.jpg" dpi="2700" />5 </AFrame>6 

Example 2 Including a graphic image (1)

Mt. Fuji in a blue sky.

Figure 2 Output from Example 2.

The three elements, , <AFrame ... > and<Image ... >, included in Example 2 have thenear-minimum number of property settings. The<AFrame ... > wrapContent specifies that the di-mensions of the anchored frame are automatic-ally determined by the size of the image, which iscentered within the text frame by default. The output from Example 2 is shown in Figure2. The dotted red lines delimit the text frame border.

By default neither borders nor fills are applied to the <AFrame ... > or <Image ... > ele-ments.

Example 3 illustrates an anchored frame with an image bleeding outside the page.

1 2 Cloudy sky3 <AFrame wrapContent="Y" endIndent="-31mm" align="end" >

4 <Image file="${images}/wideSky.jpg" dpi="540" />5 </AFrame>

<AFrame ... >



6 

Example 3 Including a graphic image (2)

Cloudy sky

page width = 210 mm

text frame width = 160 mm

Figure 3 Output from Example 3(scaled to 20%).

In Example 3 the <AFrame ... > bleeds 6 mm outsidethe right side of the page edge. This is achieved bysetting the <AFrame ... > align property to ‘end’ andthe endIndent property to a negative value equivalentto the sum of the size of the right margin, 25 mm,plus the desired amount of bleed (line 3).

The output from Example 3 is shown in Figure 3.

To make the bleed occur at the opposite page border, the <AFrame ... > align property isset to ‘start’ and the startIndent is set to a negative value equivalent to the sum of the sizeof the left margin plus the desired amount of bleed.

<ATextFrame ... >



<ATextFrame ... >

SummaryUse <ATextFrame ... > within paragraphs or table cells to include a ‘shrink-wrapped’anchored text frame.

Text, tables and anchored frames may be placed between the <ATextFrame ... > and </ATextFrame> elements.

Properties

Property Value<ATextFrame

Overall dimensions

width dim

Overall width of anchored text frame, including margins.

Default: 200pt

minimumHeight dim

Minimum height of frame.

Default: 15pt

maximumHeight dim

Default: 300pt

Anchored text frame location

position inline | below | runin | outsideTextFrame

Position of anchored text frame relative to anchor or insertion point. Theposition property is applicable only when the anchored text frame is withina element.

Value Description

inline Inline at the insertion point within paragraph text.


runin Run into paragraph. A maximum of one element withina element may have a position property set to'runin'. The anchored text frame should not be locatedimmediately before a page or column boundary.


If the <ATextFrame> element is at the top level, outside a element,the ‘below’, ‘inline’ and ‘runin’ values are not applicable.

If position is not set to ‘inline’ the lateral alignment of the anchored textframe is specified using the align property (see below).

When position is set to ‘outsideTextFrame’ the lateral position of theanchored text frame may be further adjusted using the sideOffset property(see below).

<ATextFrame ... >



Property ValueWhen position is set to ‘runin’ the top of the anchored text frame isaligned with the top of the text (at caps height) in the first line of the para-graph. When position is set to ‘outsideTextFrame’ the top of the anchoredtext frame is aligned with the top of the text (at caps height) in the firstline of the paragraph by default. This position may be adjusted using theverticalOffset property (see below).


Lateral alignment of the anchored text frame. The align property is ignoredif position is set to ‘inline’.


Value Description


center Center the anchored text frame between the left andright text frame borders.


Default: end

sideOffset dim

Offset of frame from the alignment position specified by the align prop-erty.


Default: 0

verticalOffset dim

Vertical offset of frame.

Effective only if the position property is set to 'outsideTextFrame'. Valuemay be positive or negative. By default the top of the anchored text frameis aligned with the top of the text (at caps height) in the first line of thecontainer paragraph.

Default: 0

Text runaround gapThe following runaround properties are effective only if the position property is set to 'runin'.

runAroundGap dim

Specify the gap between the anchored text frame and text flowing aroundit. The value of dim may be negative.

Default: 6pt

sideGap dim

Specify the side gap between the anchored text frame and text flowingaround it. The value of dim may be negative.


<ATextFrame ... >



Property Value

belowGap dim

Specify the gap below the anchored text frame and text flowing around it.The value of dim may be negative.



penWidth dim



Border pen style.

Default: solid

penColor name


penTint percent


penOpacity 0 | 100



fillColor name


fillTint percent


fillOpacity 0 | 100


Text frame inside margins (for text frame within <ATextFrame>)

allMargins dim

All text frame margins. Placing a leftMargin, topMargin, rightMargin,or bottomMargin property after the allMargins property overrides thecorresponding allMargins setting.

Default: 4pt

leftMargin dim

Text frame left margin.

Default: 4pt

<ATextFrame ... >



Property Value

topMargin dim

Text frame top margin.

Default: 4pt

rightMargin dim

Text frame right margin.

Default: 4pt

bottomMargin dim

Text frame bottom margin.

Default: 4pt

Include title

objectTitle N | Y

Include title/caption for anchored frame. See the <ObjectTitle ... > elementon pages 88–90.

>

<ATextFrame> sub-elements

The following elements may be included between <ATextFrame> and</ATextFrame>.


Include a caption for the anchored text frame. See the <ObjectTitle ...> element on pages 88–90 for properties. Not applicable whenposition is set to ‘inline’ (see page 12).


Include a description of the anchored text frame. This is for a read outloud application. The description text is not included in the displayed out-put.

</ATextFrame>

ExamplesExample 4 shows an <ATextFrame ... > with position set to 'runin'.

<ATextFrame width="28mm" fillColor="Blue" fillTint="10" position="runin" align="start"

runAroundGap="2pt"crop="N"topMargin="1.5pt" leftMargin="4pt" bottomMargin="0pt" >

<ATextFrame> ATextFrame text </ATextFrame></ATextFrame>Now, you take the Finns; there's any number of them around in the

<ATextFrame ... >



woods, where you least expect to see them, logging and such.

Example 4 Run-in <ATextFrame ... > (1)

<ATextFrame>ATextFrame text</ATextFrame>

Now, you take the Finns;there's any number ofthem around in the woods,

where you least expect to see them, logging and such.

Figure 1 Output from Example 4

The output from Example 4 is shown inFigure 1.

<Cell ... >



<Cell ... >

SummaryUse the <Cell ... > element within a <Row ... > element to begin a new cell within therow. The <Cell ... > element has properties for specifying straddles, border rulings andfill colors.

All text content within the <Cell ... > element must be contained within one or more elements.

Properties

Property Value<Cell

Cell background

fillColor color

Fill color. fillOpacity must be set to a value other than '0' (transparent) forthe specified color to display.

fillOpacity 0 | 100

Fill opacity.

Default: 0

fillTint percent

Fill tint.

Default: 100%

Cell border rulings

startRule name

Start ruling.

name is the name of a ruling format in a referenced template, or definedusing the <RuleDef ... /> format definition element (see page 188).

Default: none

topRule name

Top ruling. See startRule above.

endRule name

End ruling. See startRule above.

bottomRule name

Bottom ruling. See startRule above.

<Cell ... >



Property Value

Vertical alignment of cell text

verticalTextAlign top | middle | bottom

Vertical alignment of the cell text block within the startMargin andendMargin cell margins.

If the cellOrientation property is set to ‘90’ or ‘-90’, the vertical text blockis aligned horzontally.

Rotation of cell text

cellOrientation 0 | +90 | -90

Rotation of text block and cell margins. When the value of cellOrientationis ‘0’ the cell text is horizontal.

See Notes 1 and 2, starting on page 19.

Default: 0

Column and row span properties

columnSpan int | remainder

Horizontal (column) straddle. int is the number of columns to straddle inthis row, from this cell in the table direction. Setting columnSpan to '1'has no effect. Setting columnSpan to '2' creates a horizontal span in thetable direction from the cell to the next cell, and so on.

If columnSpan is set to 'remainder', all remaining columns in the row arestraddled.

Default: 1 (no straddle)

rowSpan int

Vertical (row) span. Number of rows to straddle in this column, from thiscell down. Setting rowSpan to '1' has no effect. Setting rowSpan to '2'creates a vertical span downwards in the current column to the next row,and so on. The corresponding <Cell ... > element must be omitted in eachsucceeding row for every vertically straddled (spanned) cell in a column.

Default: 1 (no straddle)

Cell margins

allMargins dim

All cell margins, i.e. start, top, end and bottom.

Overrides the default margin. specified in the table format, if any.

Default units are points.

startMargin dim

Cell start / left margin override.

topMargin dim

Cell top margin override.

<Cell ... >



Property Value

endMargin dim

Cell end / right margin override.

bottomMargin dim

Cell bottom margin override.

</Cell>

Notes1 If not constrained by <Row ... > element height, minimumHeight or maximumHeight

values, the minimum height of a cell containing rotated text is the (unrotated) widthof the text plus the sum of the cell's startMargin and endMargin.

2 The cellOrientation rotation value applies to both the text contained within the celland the orientation of the cell margins, as illustrated in Example 5 and Figure 4.

1 <Tbl tblDef="T_thinRulings"2 startMargin="4mm" endMargin="3mm" topMargin="3mm" bottomMargin="5mm" >3 <TblColumn width="16mm" /> <TblColumn width="16mm" />4 5 <Row height="16mm" >6 <Cell columnSpan="remainder" > cellOrientation="0" </Cell>7 </Row>8 9 <Row height="32mm" >

10 <Cell cellOrientation="-90" > cellOrientation="-90" </Cell>11 <Cell cellOrientation="+90" verticalTextAlign="bottom"12 > cellOrientation="+90" </Cell>13 </Row>14 </Tbl>

Example 5 Cell rotation

topMargin="3mm"

bottomMargin="5mm"star

tMar

gin=

"4m

m"

endM

argi

n="3

mm

"

topM

argi

n="3

mm

"

botto

mM

argi

n="5

mm

"

startMargin="4mm"

endMargin="3mm"

bottomM

argin="5m

m"

topMargin=

"3mm

"

startMargin="4mm"

endMargin="3mm"

cellOrientation="0"

cellO

rient

atio

n="-

90" cellO

rientation="+

90"


The output from Example 5 is shown in Fig-ure 4, along with annotations that illustratethe rotation of the cell margins when thecellOrientation property is set to ‘90’ or ‘-90’

and the text direction is left to right.

Examples

Interaction between <Row ... > and <Cell ...> properties

Example 6 illustrates the interaction between the<Row ... > element cellOrientation property and the<Cell ... > element cellOrientation property.

<Cell ... >



1 <Tbl tblDef="T_thinRulings"2 startMargin="1mm" endMargin="1mm" topMargin="1mm" bottomMargin="1mm" >3 <TblColumn width="10mm" /> <TblColumn width="10mm" />4 <TblColumn width="10mm" /> <TblColumn width="10mm" />5 6 <Row cellOrientation="90" verticalTextAlign="middle" >7 <Cell> Banyan </Cell>8 <Cell cellOrientation="-90" > Baobab </Cell>9 <Cell cellOrientation="-90" > Beech </Cell>

10 <Cell cellOrientation="-90" > Ying Ke Pine </Cell>11 </Row>12 </Tbl> 

Example 6 Cell rotation

Banyan

Bao

bab

Bee

ch

Ying

Ke

Pin

e



<ChangeBarBegin ... />




SummaryThe <ChangeBarBegin ... /> element specifies the beginning of a change region. The endof the change region is specified by a <ChangeBarEnd ... /> element that has a matchingid value.

In the ouput the change region is indicated by a change bar down either the start or endedge of the column, as specified by the position property and subject to adjustment bythe offset property.

The position, thickness, style, and color of the generated change bar is determined bythe respective properties (see each property definition).

Properties

Property Value<ChangeBarBegin

General properties

changeBarDef name

<ChangeBarDef ... /> format name.

All <ChangeBarDef ... /> element properties may be used with <Change-BarBegin ... /> (see the description of <ChangeBarDef ... /> element onpages 132–133).

id string

string is change bar identifier, required in the case of nested or overlappingchange regions..

Size and position properties

position start | end

Position of the change bar.

Default: start

style solid | groove | double | ridge

Change bar style.

Default: solid

width dim

Overall width of the change bar.In the case style is set to ‘double’ the change bar comprises two verticalrules each of which has a width equal to one third the value of width. Thegap between the rules is one third the value of width.

Default: 3pt




Property Value

colorDef dim

Color of the change bar.

Default: Red

opacity percent

Opacity of the change bar.

Default: Red

offset dim

Offset to the center of the change bar width from the start or end edge ofthe container text column. The text column edge anchor point depends onthe setting of the position property. Positive values move the changebaroutside away from the container edge. Negative values move the change-bar inside away from the container edge.

Default: 6pt

/>

Examples

Using change bars

Example 7 illustrates using the <ChangeBarDef ... /> element.

1 The Orangan forest has: bears<ChangeBarBegin2 offset="26pt" width="22pt" colorDef="Red" style="solid" position="start"3 /> and wolves<ChangeBarEnd/>.

Example 7 Change bar definition (1)

The Orangan forest has:bears and wolves.

text frame width

offset

width


The output from Example 7 is shown in Figure 6.The dotted red lines delimit the container frameborder. In Figure 6 the ‘offset’ and ‘width’ annota-tions indicate the values of the offset and width

properties.

<ChangeBarEnd ... />



<ChangeBarEnd ... />

SummaryThe <ChangeBarEnd ... /> element specifies the end of a change region. The beginningof the change region is specified by a <ChangeBarBegin ... /> (see pages 21–22)element that has a matching id value.

Properties

Property Value<ChangeBarEnd

General properties

id string

string is the change bar identifier corresponding to a preceding <Change-BarBegin ... /> element with the same id value. See the <ChangeBarBe-gin ... /> id property on 21.

/>

<Chapter ... >



<Chapter ... >

SummaryUse the <Chapter ... > element to create a ‘chapter’ within a ‘book’. Each chapter may ref-erence its own mfd file and numbering styles.

To add generated files such as TOCs (table of contents) and indexes to a book, see the<Contents ... > and <Index ... > elements on pages 26–31 and 62–63.

Properties

Property Value<Chapter

Format definitions

mfd filename

filename is the name of a file containing Miramo format definitions in mfdformat.

Chapter numbering

The following properties set up the <chapterNumber ... /> sub-element.

chapterNumberStyle key

Sets chapter number style.

The key value for the chapterNumberStyle property, e.g. 'westernArab-ic', 'uppercaseAlpha', 'lowercaseAlpha', 'uppercaseRoman', 'lowercaseRo-man', 'indicArabic', indicates the numbering scheme and style. The full listof key values for the chapterNumberStyle property is shown in Table A 3.1 on pages 235–235.

Default: westernArabic

chapterNumberStart increment | int

Set chapter number.

Page numbering

For setting up the document starting page number.

pageNumberStyle key

Sets the chapter page number style.

The key value for the pageNumberStyle property, e.g. 'westernArabic','uppercaseAlpha', 'lowercaseAlpha', 'uppercaseRoman', 'lowercaseRo-man', 'indicArabic', indicates the numbering scheme and style. The full listof key values for the pageNumberStyle property is shown in Table A 3.1 on pages 235–235.


<Chapter ... >



Property Value

pageNumberStart increment | int

Specifies a fixed numeric value, int, for the <pageNumber ... /> sub-ele-ment, or whether to increment, the starting page number for this bookcomponent.

Default: 1

Paragraph numbering

paragraphNumberStart increment | int

Set start number for autonumbered paragraphs.

Page starting side

startSide Left | Right | continue

Starting page side.

Value Description

Left Left page.

Right Right page.

continue Next available side.

The startSide property is ignored (the starting page side is always ‘Right’)unless the document is set to be double-sided.

Default: File

</Chapter>

<Contents ... >



<Contents ... >

SummaryUse the <Contents ... > element to create an auto-generated contents list, i.e. a standardtable of contents, or in-document order lists of tables, figures, and so on. Multiple con-tents lists may be included within a single document.

Different auto-generated lists are distinguished from each other by the paragraph formatsthat are selected for inclusion via <ContentsInclude ... > (see pages 32–34) ele-ments.

Every <Contents ... > element must include a minimum of one <ContentsInclude ... >element.

The simplest way to produce a table of contents is using the following markup:

<Contents><ContentsInclude names="Heading1" />

</Contents>

The above assumes the presence of ‘Heading1’ paragraphs.

Properties

Property Value<Contents

contentsDef name

name is the name of a <ContentsDef ... > contents format definition. Seepages 136–139.

position normal | topOfColumn | topOfPage | topOfLeftPage |topOfRightPage

Contents placement.

Value Description

normal Start contents at the current position.

topOfColumn Start contents at top of next column

topOfPage Start contents at top of next page

topOfLeftPage Start contents at top of next left page

topOfRightPage Start contents at top of next right page

For single-sided documents (see the <DocDef ... /> doubleSided prop-erty on page 143), setting the position property to any of ‘topOfPage’,‘topOfLeftPage’, or ‘topOfRightPage’, has the same effect, which is toforce the paragraph to start at the top of a page.

chapterOnly N | Y

If chapterOnly is set to ‘Y’ and the <Contents ... > element occurs within a<Chapter ... > element (see pages 24–25), the generated TOC willonly include paragraphs present within the <Chapter ... > element.

Default: N

<Contents ... >



Property Value</Contents>

Notes1 The <Contents ... > element may be included anywhere at the top level, i.e. outside

a element.

2 The <Contents ... > element may be preceded by a <Section ... /> element, e.g.

<Section page="First" allPages="contentsContinued" pageNumber="1"pageNumberStyle="lowercaseRoman" />

3 The <Contents ... > element may be followed by a <Section ... /> element, e.g.

<Section page="First" allPages="Right" pageNumber="1"pageNumberStyle="westernArabic" />

Examples

Single-level table of contents

Example 8 shows how to create a single-level table of contents.

1 List of chapters 2 <Contents>

3 <ContentsInclude names="P_chapterTitle.ExA,P_chapterTitleTOC"

4 paraDef="P_TOCexampleL1"

5 firstLineIndent="11mm" startIndent="11mm" endIndent="10mm"endMargin="08mm"

6 >7 <paragraphText textColor="Maroon" />

8 <leader>.. ..</leader> <pageNumber/>

9 </ContentsInclude>

10 </Contents>

Example 8 Defining a single-level table of contents

In Example 8 the <ContentsInclude ... > names property specifies the tag names,‘P_chapterTitle.ExA’ and ‘P_chapterTitleTOC’, of the paragraphs to be included at the toplevel in the contents (line 3). The formatting of the top level text within the contents isspecified using the <ContentsInclude ... > paraDef property to refer to a <ParaDef ... >‘P_TOCexampleL1’ format definition (line 4). A set of element properties may beused as formatting overrides, e.g. firstLineIndent, and so on, as illustrated on line 5.

<Contents ... >



List of chapters

Contents.. .... .... .... .... .... .... .... .... .. i

Inline markup elements.. .... .... .... .. 5

Format definitions.. .... .... .... .... .. 131

pgf.sI.L1 textWidth.L1 pgf.eI.L1 eM.L1


By default the overall width of a<ContentsInclude ... > level, includ-ing the paragraph startIndent value isthe width of its container. Indentationfrom the end side is achieved by set-ting a value for endMargin (see line 5in Example 8).

The components of the referenced paragraph to include in the contents listing arespecified by including one of more of the <paragraphLabel/>, <paragraphNumber/>,<paragraphText/> and <pageNumber ... /> sub-elements within the <ContentsInclude ...>, with an optional <leader ... > sub-element to specify the page number leader (e.g. seelines 7 and 8 in Example 8).

The property setting, textColor, on the <paragraphText/> sub-element on line7 specifies a color override for the referenced paragraph text only.

The output from Example 8 is shown in Figure 7. The dimensions ‘pgf.sI.L1’, ‘pgf.eI.L1’

and ‘eM.L1’ shown in Figure 7 represent the values of the contents listing paragraphstartIndent and endIndent and the <ContentsInclude ... >endMargin values in Example8 (see line 5).

E.1 textWidth = containerWidth - (startIndent + endIndent + endMargin)

Multi-level table of contents

A multi-level contents list is created by including multiple <ContentsInclude ... > ele-ments within a <Contents ... > element. For example, if the markup shown in Example9 is included after line 9 in Example 8 the result is a bi-level contents list.

1 <ContentsInclude names="P_elementName.ExA"


3 startIndent="14mm" firstLineIndent="14mm" endIndent="11mm" endMargin="22mm"

4 >5 <paragraphText/> <leader>.. ..</leader> <pageNumber/>


Example 9 Adding another level to a table of contents

List of chapters and sections

Contents.. .... .... .... .... .... .... .... .... .... .... .. i

Inline markup elements.. .... .... .... .... .... .. 5<AFrame ... >.. .... .... .... .... .... .. 6<TblContinuation ... />.. .... .. 123

Format definitions.. .... .... .... .... .... .... .. 131



The output from Examples 8 and9 is shown in Figure 8.

The dimensions ‘pgf.sI.L2’, ‘pgf.eI.L2’

and ‘eM.L2’ shown in Figure31 represent the values ofthe contents listing paragraphstartIndent and endIndent andthe <ContentsInclude ... >end-

<Contents ... >



Margin values in Example 9 (seeline 3).

Using the <ContentsInclude ... > <paragraphLabel/> sub-element

Example 10 illustrates using sub-elements within the <ContentsInclude ... > element,specifically the <paragraphLabel/> and sub-elements.

1 List of chapters2 <Contents>

3 <ContentsInclude names="P_chapterTitle.ExA,P_chapterTitleTOC"


5 firstLineIndent="6mm" startIndent="11mm" endIndent="10mm" endMargin="08mm"

6 >7 <paragraphLabel textSize="6.5pt" /> 

8 <paragraphText textColor="Maroon" />


10 </ContentsInclude>11 </Contents>

Example 10 Contents list: using <paragraphLabel/> and sub-elements

List of chaptersContents.. .... .... .... .... .... .. i

Chapter 3

Inline markup elements.. .... .. 5Chapter 4

Format definitions.. .... .. 131



The output from Example 10is shown in Figure 9. The<paragraphLabel/> text, ‘Chaptern’, is outdented in Figure 9 becausethe value of the firstLineIndent

<ContentsInclude ... > propertyis less than the value of thestartIndent (see line 5 in Example10).

Using the <paragraphLabel/> type, labelWidth and labelIndent properties

Example 11 shows setting the <paragraphLabel/> type property to ‘runin’ (the default).

1 List of examples2 <Contents>

3 <ContentsInclude names="P_exampleCaption.ExA|P_exampleCaption.ExB"

4 paraDef="P_TOClistOfExamplesA"


6 >7 <paragraphLabel textSize="6pt" type="runin"

8 textColor="DarkBlue" /> <paragraphText

9 textColor="Maroon" />



<Contents ... >



12 </Contents>

Example 11 Contents list: <paragraphLabel/> type property default setting

pgf.fLI

List of examples

Example 1 Multiple objects in an<AFrame ... >.. .... .... .... .... .. 10

Example 2 Including a graphic image (1).. .... .. 10Example 3 Including a graphic image (2).. .... .. 11Example 4 Run-in <ATextFrame ... > (1).. .... .. 16Example A3.18 Paragraph format

definitions for Arabicautonumbering.. .... .... .... .. 234


Figure 10 LOF2: Output from Example 11

The output from Example 11 is shownin Figure 10. Example 11 is similarto Examples 8 through 10 in that inall cases the <paragraphLabel/> type

property is set to ‘runin’, either bydefault or explicitly (line 7 in Example11.)

Example 11 is intended as a basisfor comparison with the following Ex-amples 12 through 14, in all of whichthe <paragraphLabel/> type property is set to ‘fixed’.

Example 12 sets the <paragraphLabel/> type property to ‘fixed’ and also sets the<paragraphLabel/> labelWidth property.

1 List of examples2 <Contents>

3 <ContentsInclude names="P_exampleCaption.ExA|P_exampleCaption.ExB"



6 >7 <paragraphLabel textSize="6pt" type="fixed"

8 labelWidth="15mm" textAlign="start" /> <paragraphText



11 </ContentsInclude>12 </Contents>

Example 12 Contents list: <paragraphLabel/> labelWidth property

lW

pgf.fLI

List of examples

Example 1 Multiple objects in an<AFrame ... >.. .... .... .... .... .... .. 10

Example 2 Including a graphic image (1).. .. 10Example 3 Including a graphic image (2).. .. 11Example 4 Run-in <ATextFrame ... > (1).. .... ..16Example A3.18 Paragraph format definitions

for Arabic autonumbering.. .... .. 234


Figure 11 LOF3a: Output from Example 12

The output from Example 12 isshown in Figure 11. In Example12 the <paragraphLabel/> type prop-erty is set to 'fixed' (line 7) and the<paragraphLabel/> labelWidth propertyis specified as '15 mm' (line 8). Notethat when the <paragraphLabel/> type

property is set to 'fixed' and thelabelIndent property is not set ('auto' bydefault), the end of the label width islocated at the start of the paragraph startIndent not the firstLineIndent.

<Contents ... >



Example 13 introduces the <paragraphLabel/> labelIndent property, which anchors theposition of the start of the label width area to the start side of the container, independ-ently of the position of the paragraph startIndent (line 6).

The label text in Example 13 is right-aligned by setting the <paragraphLabel/> textAlign

property to ‘end’ (line 7).

1 <ContentsDef contentsDef="listOfExamplesEx" >Contents.CD1.contentsStart/xnM/2 <ContentsInclude names="P_exampleCaption.ExA|P_exampleCaption.ExB"



5 >6 <paragraphLabel textSize="6pt" type="fixed" labelIndent="5mm"

7 labelWidth="14mm" textAlign="end" /> <paragraphText



10 </ContentsInclude>11 </ContentsDef>

Example 13 Contents list: <paragraphLabel/> labelWidth and labelIndent properties (1)

1 List of examples2 <Contents contentsDef="listOfExamplesEx" />

Example 14 Contents list: <paragraphLabel/> labelWidth and labelIndent properties (2)

lWlI

pgf.fLI

List of examples

Example 1 Multiple objects in an<AFrame ... >.. .... .... .... .... .. 10

Example 2 Including a graphic image (1).. .. 10Example 3 Including a graphic image (2).. .. 11Example 4 Run-in <ATextFrame ... > (1).. .... ..16

Example A3.18 Paragraph format definitionsfor Arabic autonumbering.. .. 234


Figure 12 CD1: Output from Example 14

The output from Examples 13 and14 is shown in Figure 12.

More <ContentsDef ... > examplesare shown on pages 138–139.

<ContentsInclude ... >




SummaryUse one or more <ContentsInclude ... > elements within the <Contents ... > element (seepages 26–31) to specify the paragraphs to be included within a generated con-tents list, and their formatting within the list.

Each instance of a <ContentsInclude ... > element creates a new level within the contentslist.

Properties

Property Value<ContentsInclude

Specify paragraph types to include

names namelist

Name(s) of paragraph formats to include in contents list.

namelist is one or more comma or bar-separated paragraph format namesdefined using the <ParaDef ... > element. See line 4 in Example 8 on page27.

Contents list formatting properties

endMargin dim

Indent the effective page end margin.

By default the end margin is aligned at the end edge of the container. Set-ting endMargin enables page number references to be adjusted inwards.The endIndent property of the contents list paragraph format is adjustedrelative to the value of the endMargin property. See dimensions ‘eM.L1’and ‘pgf.eI.L1’ in Figure 7 on page 28.

Default: 0

paragraphProperties element properties

See the element on pages 91–100).Apply paragraph properties to the contents list paragraph format.

>

<ContentsInclude> sub-elements

The following elements may be included between <ContentsInclude> and</ContentsInclude>. fontProperties refers to element properties. Seethe element on pages 40–48).

<paragraphText [keepFormatting = "N | Y"] fontProperties />

Include the paragraph text. Any auto-numbering or other paragraph fea-tures defined by an associated <ListLabel ... > element are excluded from<paragraphText/>.




<ContentsInclude> sub-elements (Continued )

The default value of the <paragraphText/> keepFormatting property is ‘N’.In this case the settings specified by elements within the refer-enced paragraph text are ignored.

If the keepFormatting property is set to ‘Y’, settings specified by elements in the referenced paragraph text are all applied, with the fol-lowing exceptions: (1) the verticalShift property, and (2) the textSizeproperty when its value is a dim or rdim (e.g. "12pt", "8mm", "+2pt","-1pt", etc). If the textSize property is specified using a percent value (e.g."80%", "-20%", etc) then the value is applied.

<paragraphLabel [type ="runin | fixed"] [numberOnly = "N | Y"][labelIndent = "auto | dim"] [labelWidth = "dim"][textAlign = "start | end | justify"] fontProperties />

If the referenced paragraph(s) specified by the names property have anassociated <ListLabel ... > element, include the entire contents of the as-sociated <ListLabel ... > element.

By default the list label runs into the paragraph text and the<paragraphLabel/> labelIndent, labelWidth and textAlign proper-ties are ignored. If the <paragraphLabel/> type property is set to ‘fixed’the start position of the label and the label width are specified inde-pendently of the parent element's firstLineIndent, using the<paragraphLabel/> labelWidth property and, optionally, the labelIndentproperty.

If the <paragraphLabel/> type property is set to 'fixed', the<paragraphLabel/> labelIndent property specifies indent of the label areafrom the start side of its containing text frame or table cell.

If the <paragraphLabel/> labelIndent property is set to 'auto', the in-dent of the list label defaults to the value of the parent element'startIndent' value minus the value of the labelWidth property.

If the <paragraphLabel/> type property is set to 'fixed', the<paragraphLabel/> labelWidth property specifies width of the list labelarea.

If the <paragraphLabel/> numberOnly property is set to 'Y' and the ref-erenced paragraphs have an associated <ListLabel ... > element containing<counter ... /> elements, include only the autonumber counter values andall text between the first and last <counter ... /> elements.

If the <paragraphLabel/> type property is set to 'fixed', text within the listlabel area is aligned at the start position by default. This can be changedusing the textAlign property.

<paragraphNumber [type ="runin | fixed"][labelIndent = "auto | dim"] [labelWidth = "dim"][textAlign = "start | end | justify"] fontProperties />

If the referenced paragraph(s) specified by the names property have anassociated <ListLabel ... > element containing <counter ... /> elements, in-clude only the autonumber counter values and all text between the firstand last <counter ... /> elements.

See the description of the <paragraphLabel/> properties.

<leader fontProperties>content</leader>

Specify leader string.




<ContentsInclude> sub-elements (Continued )

<pageNumber fontProperties />

Include the page number.

 

The element may be used before (but not after) the<paragraphText/> sub-element to include a line break. The elementmay not be used within a element within the <ContentsIn-clude ... > element.



The element (see pages 40–48) may be used withinthe <ContentsInclude ... > element provided there is no within the element.

</ContentsInclude>

Notes1 The <paragraphText/>, <paragraphLabel/>, <paragraphNumber/>, <leader ... > and

<pageNumber ... /> sub-elements support element properties. See the element on pages 40–48.

The text properties apply only with the scope of the content of the sub-element towhich they are applied.

2 In the general case each successive <ContentsInclude ... > element denotes anothercontents list level. But successive <ContentsInclude ... > elements may be used toformat contents list items within the same level, e.g. for multi-language documentswhen different fonts are needed for different languages. In this case the propertiesof successive <ContentsInclude ... > are identical, with the exception of the namesand fmt properties. As an alternative, instead of referencing a different paragraphformat for the format of the contents list item a language-specific fontFamily prop-erty may be added to the <paragraphText/> sub-element.

3 Sub-elements included in a <ContentsInclude ... > element must appear in the fol-lowing order:

<paragraphLabel/> <paragraphNumber/> <paragraphText/> <leader/> <pageNumber/>

ExamplesSee the examples for the <Contents ... > element, starting on page 27.

<currentPageNumber ... />




SummaryThe <currentPageNumber ... /> element may be included within a element to dis-play the current page number. Normally the <currentPageNumber ... /> element is usedwithin a background <TextFrame ... > within a <PageDef ... > to include the current pagenumber in header or footer running text.

See also: <lastPageNumber ... /> on page 68.

Properties

Property Value<currentPageNumber

Font properties

fontProperties element properties

See the and <FontDef ... /> elements on pages 40–48and 151–156). fontProperties override the default page number textproperties, as inherited from the enclosing paragraph format.

/>

ExamplesExample 15 illustrates using the <currentPageNumber ... /> element.

1 The current page number is: <currentPageNumber/> 2 The current page number is: <currentPageNumber fontDef="F_Red" /> 3 This page number is: <currentPageNumber fontDef="F_Red" fontAngle="Italic" /> 

Example 15 Using <currentPageNumber ... /> within the document main flow

The current page number is: 35The current page number is: 35This page number is: 35

Figure 13 Output from Example 15 .

Input lines 1 and 2 in Example 15 assumethat the input also contains the following<FontDef ... /> format definition:

<FontDef fontDef="F_Red" textColor="Red" />

Example 16 illustrates using the <currentPageNumber ... /> and <lastPageNumber ... />elements in a background text frame on a master page.

1 <PageDef pageDef="Right" >2 3 4 5 <TextFrame type="background" L="25.0mm" T="219mm" W="125.0mm" H="4.0mm" >6 mmComposer Reference Guide <currentPageNumber




8 textColor="Blue" /> of <lastPageNumber/> 9 </TextFrame>

10 main flow and other background text flow formats omitted11 </PageDef>

Example 16 Using <currentPageNumber ... /> within a background text frame

The markup shown in Example 16 produces output similar to that shown in the runningfooter of this page.

<Date ... >



<Date ... >

SummaryUse the <Date ... > element to include the document generation date and time.

The date value(s) and text inserted by the <Date ... > element is defined either in a tem-plate file or by using the <DateDef ... > element (see pages 140–142).

Properties

Property Value<Date

Date format

dateDef name

Optional name of <DateDef ... > format definition.

Default: ldate

>

<Date> sub-elements

The following elements may be included between <Date> and </Date>.

<second/>, , <second00/>, <minute/>, <minute00/>, <hour/>,<hour01/>, <hour24/>, <ampm/>, <AMPM/>, <dayNumber/>, <dayNumber01/>,<dayName/>, <shortDayName/>, <monthNumber/>, <monthNumber01/>,<monthName/>, <shortMonthName/>, <year/> and <shortYear/>.

See the <DateDef ... > element on pages 140–141 for a description of theabove elements..

</Date>

<FNote ... >



<FNote ... >

SummaryUse the <FNote ... > element within a element to include a footnote within asingle-column text flow (see Note 1). The <FNote ... > element may contain ele-ments.

The numbering and layout of document footnotes is specified using the <FNoteDef ... />element (see pages 147–150).

If the <FNote ... > element is used within a table, the table footnotes are output at theend of the table by default. This may be changed using the <Tbl ... > or <TblDef ... >footnotePosition properties (see pages 118 and 201). Table footnotes numbering re-starts from 1 for each table instance.

Properties

Property Value<FNote

Reference pre-defined paragraph format

paraDef name

name is optional paragraph format name (overrides the default footnoteparagraph format).

All element properties may be used with <FNote ... > (see the de-scription of element properties on pages 91–100). Note how-ever that the element pagination properties have no effect whenused with <FNote ... >.

Default: Footnote

</FNote>

Notes1 Footnotes cannot be included within multi-column layouts.

2 A single-paragraph footnote may contain text in either of the following, directlyequivalent, ways:

<FNote>This is a footnote</FNote><FNote> This is a footnote </FNote>

If the footnote contains more than one paragraph, then each paragraph must bewrapped within elements, e.g.

<FNote>This is footnote paragraph 1This is footnote paragraph 2 </FNote>

<FNote ... >



3 The default format for all paragraphs in a footnote is as specified by the<FNoteDef ... /> element's paraDef property (see page 148).

4 A footnote cannot contain a footnote.







SummaryThe element may be used to control the appearance of text within paragraphs.Settable text attributes include style, size, position, emphasis type, inter-character spa-cing and color.

 elements, unlike other inline elements, may be nested to any depth whenused in normal paragraph text (i.e. elements operate analogously with a LIFOstack).

Properties

Property Value element (see pages 151–156).

The following:This is warning text ...

produces:This is warning text ...

The above example assumes a pre-existing ‘F_Bold’ font format definition.

To revert to the default paragraph font format set the fontDef property tothe empty string, i.e. (no spaces between the ""). Forexample

10 point Red textthen back into the default paragraph font.

produces:10 point Red text then back into the default paragraph font.

Primary font properties

See Appendix 1– Fonts on pages 217–221 for details about supported font types and fontselection.

fontFamily name

Font family. E.g. 'Arial', 'Times New Roman'.

textSize dim | rdim

Text size.

Default units are points (1/72 inch).





Property Valuerdim values are applicable only when the textSize property is includeddirectly within a element, i.e. not within or other ele-ments that support properties. An rdim value may have any ofthe following forms: +20%, 120%, 85%, -4%, +dim and -dim (e.g. +2pt,-1mm).

E.g. the followingThe next text is in 10 points.This text is back to the default paragraph text size.

produces:The next text is in 10 points. This text is back to the default paragraphtext size.

fontAngle name

Font angle. E.g. 'Italic', 'Oblique'.

E.g. the followingSome italic text ...

produces: Some italic text ...

fontWeight name

Font weight. E.g. 'Bold', 'Medium'.Some bold text ...

produces: Some bold text ...

textColor name

Text color.

E.g. the followingToday is a Red letterday ...

produces: Today is a Red letter day ...

textOpacity 100 | 0

Text opacity.

If textOpacity is set to '0' the text is included invisibly in the PDF output,and may be copied and searched.

E.g. the followingThis is transparent text

produces: This is transparent text

Default: 100

language key

Set the font language to key. The key values for the language propertyare listed in Table A 2.1 on pages 223–223.


Text capitalization

capitalization normal | smallCaps | uppercase | lowercase

Apply special text casing.





Property ValueValue Description

normal Process text unchanged

smallCaps Translate lowercase text into smallcaps. The relativesize of the smallcaps text depends on the setting ofthe smallCapsStyle and the smallCapsSize proper-ties.

uppercase Convert lowercase text to uppercase.

lowercase Convert uppercase text to lowercase.

Default: normal

smallCapsStyle simulated | fromFont

If smallCapsStyle is set to ‘simulated’ the size of the smallcaps text is set tothe percentage value specified by the smallCapsSize property regardless ofwhether the font supports the smcp feature.

If smallCapsStyle is set to ‘fromFont’ and the font supports the smcpfeature, the internal font smallcaps size is used and the value of thesmallCapsSize property is ignored.

Default: fromFont

smallCapsSize percent

Relative size of small caps when capitalization is set to ‘smallCaps’.Ignored if the font contains the smcp feature and the smallCapsStyleproperty is set to ‘fromFont’.

Default: 80%

Font features

fontFeatures N | Y

Enable text and font features.

fontFeaturesList keylist

Enable selected OpenType advanced features.

keylist may comprise one of more key values separated by vertical bars.Each key value must be four alphanumeric characters long and correspondto the values listed in the OpenType specification. Invalid features and re-quests for features not present in the font are ignored.

E.g. this inputNormal Lorem amat ipsum| Convoluted Lorem amat ipsum 

produces: Normal Lorem amat ipsum| vt t iThe fontFeaturesList property is ignored unless the fontFeatures property isis set to ‘Y’.

Underline, overline and strikethrough

textUnderline none | single | numeric | double

Underline style.






none No underline.

single Normal (single) underline. By default the 'single' under-line baseline offset and underline thickness are as spe-cified by the corresponding values in the post table ofthe current font. If these values are not present in thecurrent font (.ttf or .otf), the baseline offset and under-line thickness are set to 10% and 6% of the current fontsize.

numeric Numeric underline. By default the thickness of a 'numer-ic' underline is 0.5pt and the baseline offset to the mid-point of the underline is 2pt, irrespective of the currentfont size. A 'numeric' underline is low at small font sizesand high at large font sizes.

double Double underline. By default the thickness of each linein a 'double' underline is 0.5pt and the baseline offset tothe mid-point of the first underline is 2pt, irrespective ofthe current font size. The pitch between the two under-lines is 2pt.

By default the underline color is as specified by the textColor property,i.e. the color of the text above the underline. Underline color may bechanged by setting the underlineColor property. Underline thicknessesand baseline offsets may be changed by setting the underlineThicknessand underlineOffset properties.

E.g. the followingnormal underlinedouble underline numeric underlinenormal underlineswitch off underline

produces:normal underline double underlinenumeric underline normal underline switch off underline

underlineOffset dim | percent

Underline offset from text baseline to the center of the underline (or thefirst underline in the case of a double underline) as an absolute value or apercentage of the text size.

E.g. the followingLow underline(30% of text size) small text 

produces: Low underline (30% of text size) small text

underlineThickness dim | percent

Underline thickness as an absolute value or a percentage of the text size.

E.g. the followingThick underline (14%) no underline Thick underline (1.2pt) no underline





Property Valueproduces:Thick underline (14%) no underlineThick underline (1.2pt) no underline

underlineGap dim | percent

Gap between lines of a double underline.

Underline gap between the centers of the underlines as an absolute valueor a percentage of the text size. Applicable only when underline is set to'double'.

E.g. the followingDouble underline with custom gap between lines 

produces: Double underline with custom gap between lines

underlineColor name

Underline color.

E.g. the followingunderlinered underlinered underlinered 

produces:underlineredunderlineredunderlinered

textOverline N | Y

Overline.

overline

produces: overline

Default: 'N'

strikeThrough N | Y

Strike through.

E.g.strike through

produces: strike through

fillColor name

E.g. the followingText with a cool background.

produces: Text with a cool background.

Default: no background text color





Property Value

fillTint percent

Tint for text background color. Applicable only if fillColor is set.

E.g. the followingText with a blue-tint background.

produces: Text with a blue-tint background.

Default: 100%

fillOpacity 100 | 0

Opacity of text background color. Applicable only if fillColor is set.

E.g. the followingText with a 10% opacitybackground.

produces: Text with a 10% opacity background.

Default: 100%

Line breaking

lineBreak Y | N

Suppress line breaks within a word or phrase.

If the lineBreak property is set to ‘N’, all other hyphenation and linebreaking properties are ineffective.

hyphenate Y | N

Turn on hyphenation.

maximumHyphens int

Maximum number of adjacent hyphenated lines.

minimumBeforeHyphen int

Minimum number of characters before hyphen.

minimumAfterHyphen int

Minimum number of characters after hyphen.

minimumWordSize int

Minimum word size to hyphenate.

allowHyphenationBefore chars

Add additional characters that allow a hyphenation before. The additionalcharacters may be included as a space-separated list of UTF-8 chracters, oras numeric character entities (e.g. &#xhhhh;).

allowHyphenationAfter chars

Add additional characters that allow a hyphenation after.

allowLineBreakBefore chars

Add additional characters that allow a line break before. The additionalcharacters may be included as a space-separated list of UTF-8 chracters, oras numeric character entities (e.g. &#xhhhh;).

By default line breaking is based on UAX #14: Unicode Line Breaking Al-gorithm.

http://unicode.org/reports/tr14/






Property Value

allowLineBreakAfter chars

Add additional characters that allow a line break after. Otherwise same asallowLineBreakBefore.

Horizontal text spacing

textKern Y | N

Enable pair kerning.

This inputAWAY andAWAY

produces: AWAY and AWAY

ligatures N | Y

Enable ligatures.

This inputNo ligature ffi:Office<Fontligatures="Y" > Ligature ffi: Office 

produces: No ligature ffi: Office Ligature ffi: Office

textSpread percent

Inter-character spread, or tracking.

percent is relative i n c r e a s e / decrease in character spread. Negativevalues reduce character spread. Spread is expressed as a percentage of thefont size.

The character spread property in <FontDef ... /> or the tex-tKern property (above) must be switched on for character spread values toaffect output.

Default: '0'

letterSpacing N | Y

Allow additional letter spacing.

Inter-word spacing in justified text may sometimes have to exceed themaximum specified by the maximumWordSpace property (see below). Insuch cases, setting the letterSpacing property to 'Y' will allow additionalspace to be added between letters within words to reduce excessive spa-cing between words.

maximumWordSpace percent

Maximum inter-word spacing. A value of 100 is equivalent to one quarterof an em space.

optimumWordSpace percent

Optimum inter-word spacing. A value of 100 is equivalent to one quarterof an em space.

E.g. the following





Property ValueLike as the wavesmake towards the pebbl'd shore, So do ourminutes hasten 

produces:Like as the waves make towards the pebbl'd shore, Sodo our minutes hasten

minmumWordSpace percent

Minimum inter-word spacing. A value of 100 is equivalent to one quarterof an em space.

Vertical text adjustment

superscript N | Y

Superscript.

E.g.Normal textsuperscript normal text

produces:Normal textsuperscript normal text

Default: 'N'

subscript N | Y

Subscript.

Normal textsubscript normal text

produces: Normal textsubscript normal text

Default: 'N'

verticalShift percent

Vertical displacement of text.

percent is the required text downshift expressed as a percentage of an emin the current font size. If percent is preceded by a minus sign the text isupshifted.

The upshift or downshift is relative to the default paragraph baseline.

If the paragraph line spacing is set to fixed using the paragraph propertiesin a template document or by setting the <ParaDef ... > or elementlineSpacingMode property to 'fixed' (see pages 177 and 93), theshifted text may interfere with text above or below and may also extendabove or below the border of a text frame or a table cell.

This inputSome text down1down2up1 more text...

produces:Some text

down1

down2up1

more text...

Default: '0'





Property Value

Specify prefix and suffix text

prefix string

Font format name.



<Frame ... >



<Frame ... >

SummaryUse one or more <Frame ... > elements within an <AFrame ... >element to create one ormore fixed frames within an anchored frame. Alternatively, one or more <Frame ... > ele-ments may also be used within a <PageDef ... > element, or another <Frame ... > element.

A <Frame ... > element (fixed frame) may be used as a container for a graphic image, us-ing the <Image ... > element, for other fixed frames using the <Frame ... > element, orfor including the <mmDraw> element.

Properties

Property Value<Frame

Dimensions

width | W dim

Width of frame.

height | H dim

Height of frame.

Position

left | L dim

Distance from left edge of parent object. Negative values may be used.

Default: 0

top | T dim

Distance from top edge of parent object. Negative values may be used.

Default: 0


penWidth dim

Width of border pen. The center of the pen width is aligned with theframe border.


Border pen style.

Default: solid

penColor name


penTint percent


<Frame ... >



Property Value

penOpacity 0 | 100



fillColor name


fillTint percent


fillOpacity 0 | 100


</Frame>

<HyperCmd ... >



<HyperCmd ... >

SummaryThe <HyperCmd ... > element enables jumps to hypertext destinations in PDF or Frame-Maker output documents and viewing files (via URL addressing) in an internet browser.

The active, clickable, area is delimited by the content within the <HyperCmd ... > and </HyperCmd> start and end elements. If the active area includes text it may be made visu-ally distinct from the surrounding text by applying one or more of the <HyperCmd ... >font properties.

Properties

Property Value<HyperCmd

General hypertext properties

file filename

filename is the name of the file containing the hypertext destination. Iffilename contains spaces, it must be enclosed within a pair of quotationmark, ", or or apostrophe characters, ', U+0027 APOSTROPHE or U+0022QUOTATION MARK.

The file option may be used with either the jumptopage option or thejumptodest option when the destination is not in the current file. The fileoption is ignored if neither the jumptopage nor the jumptodest option isused.

openURL url

url is the URL of a file to open in a browser, for example:See the<HyperCmd fontDef="F_Bold" openURL="http://www.wikipedia.org/" >Wikipedia</HyperCmd> web site for more information.

which appears as follows in the resulting output document:

See the Wikipedia web site for more information.

In the above the active area is the text within <HyperCmd> and </Hyper-Cmd>.

jumptopage firstpage | lastpage | nextpage | prevpage | int

Jump to first, last, previous, next or specified page number in the currentfile or another file.

Value Description

firstpage First page (in current file, or document named by fileproperty above).

lastpage Last page (in current file, or document named by fileproperty above).

nextpage Next page (current file only).

prevpage Previous page (current file only).

http://www.wikipedia.org/

<HyperCmd ... >



Property Valueint Page number int

Use the file property to specify a destination in another file.

Enables a hyperlink in PDF viewer applications, for example:See the<HyperCmd fontDef="F_Bold" jumptopage="prevpage" file="inline.mm.pdf" >previous page</HyperCmd> for more information.


See the previous page for more information.

Page number is the document page number, as shown in running head-ers/footers. If the specified page number does not exist in the target docu-ment, the first page is displayed.

jumptodest string

string is the destination identification, set using <MkDest id="string"/>, inthe current file or another file, e.g.

<MkDest id="MkDest_Example_in_HyperCmd" />

Use the file property to specify a destination in another file.This is an example of <HyperCmd textColor="Red"jumptodest="horses42" >hypertext jump</HyperCmd>,in red again.


This is an example of hypertext jump, in red again.

Hyper command font properties


See the and <FontDef ... /> elements on pages 40–48and 151–156). fontProperties override the default hyper commandtext properties, as inherited from the current paragraph format.

</HyperCmd>

<Image ... >



<Image ... >

SummaryUse the <Image ... > element within an <AFrame ... >, <Frame ... >, <PageDef ... > or a<TextFrame ... > element to import an external image file.

One or more <Image ... > elements may be included within an <AFrame ... >, or a<Frame ... > element. One or more <Image ... > elements may be included within a<PageDef ... >, or a <TextFrame ... > element when the type property is set to 'background'

(see page 125).

Properties

Property Value<Image

Import properties (1)

file filename

RequiredRelative or absolute file name of image file.

Files may be referenced using environment variables, as in ${filename}. Inthis case environment variable names must be surrounded by curly braces.

If none of the width, height or dpi properties is set, and if the image con-tains no basis for determining its absolute dimensions, the image is scaledto fit in a 1 inch × 1 inch (25.4 mm × 25.4 mm) rectangle.

Image location

left dim

Distance of left edge of the image bounding box from left side of enclos-ing <PageDef ... >, <TextFrame ... >, <Frame ... > or <AFrame ... > ele-ment. Negative left values are permitted. See Note 2 on page 56.

Default: 0

top dim

Distance of top edge of the image bounding box from top side of enclos-ing <PageDef ... >, <TextFrame ... >, <Frame ... > or <AFrame ... > ele-ment. Negative top values are permitted. See Note 2 on page 56.

Default: 0

Image dimensions

width dim

Image width. If the width property is set the dpi property (see below) is ig-nored.

<Image ... >



Property ValueIf no height property is included the image height is calculated automatic-ally using the image aspect ratio.

Default: 25.4mm

height dim

Image height. If the height property is set the dpi property (see below) isignored.

If no width property is included the image width is calculated automatic-ally using the image aspect ratio.

Default: 25.4mm


fillColor name


fillTint percent


fillOpacity 0 | 100


Image rotation

rotate degrees

Image rotation angle in degrees. See Note 2 on page 56.

keepAspectRatio N | Y

If both the width property and the height property are set, then settingkeepAspectRatio to 'Y' results in the values of width and height (above)being treated as maximum, not absolute, values. I.e. the image is scaled tothe maximum possible size within the constraints of the width and heightvalues while maintaining its original aspect ratio.

dpi int

Image size in dpi (dots per inch). Setting the dpi property results in equalx and y inverse image scaling, i.e. the larger the dpi value the smaller theprinted image.

The dpi property is ignored if used in combination with either or both thewidth and height properties.

pdfPageNumber int

Page number in PDF document to import as an image. The first page in thePDF document is always page 1.

Default: 1

>

<Image ... >



<Image> sub-element

The following element may be included between <Image> and </Image>.

<imageReplacelocationName = "name"[active = "Y | N"][align = "topLeft | topRight | bottomLeft | bottomRight"][fit = "width | height | withinBox | adjust | fromImage"][dpi = "int"][crop = "Y | N"]/>

If an image is placed on a master page using an <Image ... > element thatincludes an <imageReplace ... /> sub-element with its active property setto ‘Y’, then the image's location and dimensions are used as a locator fora replacement image.

The left, top, width, and height specified by the parent <Image ... > ele-ment are used as a location box for the positioning and alignment of thereplacement image. The filename of the replacement image is specifiedusing the <ImageDef ... /> element (see pages 58–61).

locationNameRequired Assigns a locationName to an image on a master pagebackground. The locationName value may be referenced by an<ImageDef ... /> element..

Multiple instances of <Image ... > elements on master pages maycontain <imageReplace ... /> sub-elements having the same or dif-ferent locationName values.

active Set the active property to ‘Y’ to activate image replacementmode.

align Set the align property to ‘topLeft’, ‘topRight’, ‘bottomLeft’ or‘bottomRight’ to align the replacement image corner with the cor-responding corner in the image replacement box.

fit Set the fit property to one of ‘width’, ‘height’, ‘withinBox’, ‘adjust’or ‘fromImage’ to specify the replacement image format.

Value Description

width Fit to width of image box, preserving aspect ratio.The replacement image may expand above or belowthe replacement image box, depending on the valueof the align property.

height Fit to height of image box, preserving aspect ratio.The replacement image may expand to the right orleft of the replacement image box, depending on thevalue of the align property.

withinBox Fit into the image replacement location box, pre-serving aspect ratio. The value of the crop property isirrelevant.

adjust Fit to height of and width of image box. The replace-ment image aspect ratio is not preserved.

fromImage Use the image dimensions specified by the metadatain the replacement image. If the dpi property is notset and the image metadata does not include a DPIvalue, a value of 96 dpi is assumed.

<Image ... >



<Image> sub-element (Continued )

dpi Set the DPI (dots/pixels per inch) value for the replacement image.Applies only in the case the fit property is set to ‘fromImage’.

crop Crop the replacement image so it cannot extend outside the im-age replacement box. Applies only in the case the fit property isset to ‘width’, ‘height’ or ‘fromImage’.

</Image>

Notes1 Supported image file formats include the following:

RGB versions of: GIF, JPEG, PDF, PNG and TIFF.

container ↵

1-1 1-2 1-3 1-4 1-5 1-6 1-7

2-1 2-4 2-5 2-6 2-7

3-1 3-2 3-3 3-7

4-2 4-3 4-5 4-6 4-74-1

top

left bbH

bbW

Figure 14 Un-rotated im-age

2 Images are rotated about the centers of their post-rota-tion bounding box. Images are postioned within theircontainer (<AFrame ... >, <Frame ... >, <PageDef ... >or <TextFrame ... >) by the values of the <Image ...> element's left and top properties, which specify theleft and top offsets of the image post-rotation boundingbox.

container ↵

1-11-21-31-41-51-61-7

2-12-42-52-62-7

3-13-23-33-7

4-24-34-54-64-7 4-1

top

left bbH

bbW

Figure 15 Image rotated180°

In Figures 14 through 17 the ‘left’ and ‘top’ top dimen-sions correspond to the values of <Image ... > element'sleft and top properties. The ‘bbW’ and ‘bbH’ dimen-sions are the image bounding box width and height.Figure 15 shows the same image as shown in Figure 14rotated through 180°.

container ↵

1-1

1-2

1-3

1-4

1-5

1-6

1-7

2-1

2-4

2-5

2-6

2-7

3-1

3-2

3-3

3-7

4-2

4-3

4-5

4-6

4-7

4-1

top

left

bbH

bbW


In the case of unrotated images and images rotated 180degrees, ‘bbW’ and ‘bbH’ correspond to the values of<Image ... > element's width and height properties. Inthe case of images rotated plus or minus 90 degrees,‘bbW’ and ‘bbH’ correspond to the values of <Image ...> element's height and width properties.

Figure 16 shows the same image as shown in Figure14 rotated through 30°.

<Image ... >



container ↵

1-1

1-2

1-3

1-4

1-5

1-6

1-7

2-1

2-4

2-5

2-6

2-7

3-1

3-2

3-3

3-7

4-2

4-3

4-5

4-6

4-7

4-1

top

left

bbH

bbW


Figure 17 shows the same image as shown in Figure 14rotated through 140°.

<ImageDef ... />



<ImageDef ... />

SummaryUse <ImageDef ... /> to replace an image on a master page with a different image.

The image on the master page must be included via an <Image ... > element that has a<imageReplace ... /> sub-element (see pages 55–56).

Properties

Property Value<ImageDef

Replacement file

file none | filename

RequiredRelative or absolute file name of replacement image file.


In the special case the file property is set to ‘none’, the image is replacedwith no image.

locationName name

RequiredlocationName is the value of the master page image <Image ... > <im-ageReplace ... /> sub-element locationName property (see page 55).

/>

Examples

Using <ImageDef ... />

Image A Image B

Figure 18 Sample images to illustrate<ImageDef ... /> usage.

The usage of the <ImageDef ... />element is illustrated with referenceto the Image A and Image B im-ages shown in Figure 18. Image A is1000 pixels wide × 667 pixels deep.Image B is 1224 pixels wide × 784pixels deep. Each image is scaled toa width of 28 mm at a constant as-pect ratio.

<ImageDef ... />



Example 17 shows a format definition for a ‘Cover’ <PageDef ... >, 74 mm wide ×105 mm high (standard ISO 216 A7 size), along with some inline markup (starting online 25) required to produce output.

1 <PageDef pageDef="Cover" width="74mm" height="105mm" >2 3 <Image left="0" top="0" width="74mm" height="105mm" file="bgKhaki.png" >

4 <imageReplace locationName="coverBackground"

5 fit="height" align="topLeft" /> </Image>

6 7 <Image left="5mm" top="4mm" width="59mm" height="18mm" file="bgBlue.png" >

8 <imageReplace locationName="authorImage"

9 fit="height" align="bottomLeft" /> </Image>

10 11 <Image left="5mm" top="95mm" width="59mm" height="8mm" file="bgRed.png" >

12 <imageReplace active="Y" crop="Y" locationName="logo"

13 fit="height" align="topLeft" /> </Image>

14 15 <TextFrame left="14mm" top="26mm" width="50mm" height="50mm"

16 type="background" > <Var varDef="bookTitle" /> 17 </TextFrame>

18 19 <TextFrame left="14mm" top="78mm" width="50mm" height="12mm"

20 type="background" > <Var varDef="bookAuthor" /> 21 </TextFrame>

22 </PageDef>2324 25 <Section Page="Cover" emptyPage="Blank" pageCount="even" />

26 <VarDef27 varDef="bookTitle">Recent Trends in Modern Agriculture</VarDef>28 <VarDef varDef="bookAuthor">by Jimmy Vegan Jr</VarDef>

Example 17 Using <PageDef ... >, <Image ... > and <imageReplace ... />

The ‘Cover’ <PageDef ... > in Example 17 contains three master page locator images,‘bgKhaki.png’, ‘bgKBlue.png’ and ‘bgRed.png’, with <imageReplace ... /> names, ‘cover-Background’, ‘authorImage’ and ‘logo’ (lines 3-5, 7-9 and 11-13), and two backgroundtext frames.

<ImageDef ... />



RecentTrends

inModern

Agricultureby

Jimmy Vegan Jr

Figure 19 Output fromExample 17

The first background text frame contains a variable that refer-ences the document title variable definition (lines 15-17). Thesecond background text frame contains a variable that refer-ences the author name variable definition (lines 19-21).

The output from Example 17 is shown Figure 19. The markupfor the dashed borders shown around the graphic and textframe objects in Figures 19 to 21 is not shown in the input.

In all the <imageReplace ... /> elements in Example 17 the fit

property is set to ‘height’ (lines 5, 9 and 13). In this case settingthe align property to ‘topLeft’ or ‘bottomLeft’ results in the samereplacement image sizing and alignment. Similarly, setting thealign property to ‘topRight’ or ‘bottomRight’ results in the same replacement image sizingand alignment. Conversely, if the fit property is set to ‘width’ setting the align anchor pointto either the left or the right of the image replacement location box makes no difference.

RecentTrends

inModern

Agricultureby

Mark Twain

Figure 20 Output fromExamples 17 and 18

Examples 18, 19 and 20 illustrate inline markup, e.g. includedat the end of Example 17 (after line 28), required to effect im-age replacement on master pages.<ImageDef locationName="coverBackground" file="ImageA.jpg" /><ImageDef locationName="authorImage" file="markTwain.png" /><ImageDef locationName="logo" file="flagCU.png" />

Example 18 Using <ImageDef ... /> (1)

The values of the <ImageDef ... /> locationName propertiesin Example 18 correspond with the <imageReplace ... />locationName values in the ‘Cover’ master page that are to bereplaced.

The replacement images are all aligned at the LHS of the <Image ... > location boxes onthe master page, as specified by the <imageReplace ... /> align values in Example 17 (lines5, 9 and 13).

RecentTrends

inModern

Agricultureby

Charles Dickens

Figure 21 Output fromExample 17 (modified)

and Example 19

In Example 18 the replacement images are specified using the<ImageDef ... /> file property. Example 19 uses a different setof images as values for the file property, and their output pos-itioning is right aligned within the locator boxes, as shown inFigure 21.<ImageDef locationName="coverBackground" file="ImageB.jpg" /><ImageDef locationName="logo" file="flagSE.png" /><ImageDef locationName="authorImage" file="charlesDickens.png" />


The re-alignment of the images in Figure 21 is effected bychanging the <imageReplace ... /> align properties to haveright values in Example 17 (lines 5, 9 and 13).

<ImageDef ... />



RecentTrends

inModern

Agricultureby

Jimmy Vegan Jr


In the special case the <ImageDef ... /> file property is set to‘none’ the replaceable image is replaced with no image, as il-lustrated in Example 20 and the output in Figure 22.<ImageDef locationName="coverBackground" file="none" /><ImageDef locationName="logo" file="none" /><ImageDef locationName="authorImage" file="none" />


<Index ... >



<Index ... >

SummaryThe <Index ... > element generates an index from preceding <IX ... > index contents ele-ments.

The <IX ... > element is used to specify text references for inclusion in the generated in-dex. The set of <IX ... > element contents included in an index is determined by the<Index ... > element names property, or by the <IndexDef ... > element names property.Different index entry levels are delimited using one or more <IXsub ... /> elements with-in the <IX ... > element content.

The simplest way to produce an index is using the following markup:

<Index/>or

<Index indexDef="IndexDef format name" names="namelist" />

Properties

Property Value<Index

Index format name and selector properties

indexDef string

Name of index format defined using the <IndexDef ... > element (seepages 157–160). If no indexDef property is used, the default indexformat is used.

Default: index

names namelist

Bar or comma separated list of <IX ... > element name property values (seepage 64) to include in the index.

Default: index

>

<Index> sub-elements

The following elements may be included between <Index> and </Index>. font-Properties refers to element properties. See the element onpages 40–48).The following <Index ... > sub-elements override the built-in default values andthe values specified by a referenced <IndexDef ... > index format definition.

<levelFormat paraDef="name" />

See the description of the <IndexDef ... > <levelFormat ... > sub-elementon page 159.

<Index ... >



<Index> sub-elements (Continued )

<entrySuffix>content</entrySuffix>

See the description of the <IndexDef ... > <entrySuffix ... > sub-elementon page 159.

<pageReferenceSeparator fontProperties>content</pageReferenceSeparator>

See the description of the <IndexDef ... > <pageReferenceSeparator ... >sub-element on page 159.

<pageRangeSeparator fontProperties>content</pageRangeSeparator>

See the description of the <IndexDef ... > <pageRangeSeparator ... > sub-element on page 159.

<pageNumber entryType="normal | primary" fontProperties />

See the description of the <IndexDef ... > <pageNumber ... /> sub-ele-ment on page 160.

</Index>

<IX ... >



<IX ... >

SummaryUse the <IX ... > element to create an index entry.

Index entry levels are separated using the <IXsub ... /> element (see page 65).

Properties

Property Value<IX

Define index entry

name string

Name of index entry. Index entries are included in index instances basedupon the name value being included in the <Index ... > or <IndexDef ... >names namelist set (see pages 62 and 157).

Default: index

pageType single | start | end | nopage

Type of page reference in index.

Value Description

single Single page reference.

start First page in page range.

end Last page in page range.

nopage Exclude page number.

Default: single

sortKey string

string is index entry sort string.

Only required if entry is to be sorted differently from the index text.

entryType normal | primary

Normal or primary index entry. entryTypes with different values may havedifferent font properties applied, using the <IndexDef ... > and <Index ...> sub-elements <pageRangeSeparator ... > (see page 159) and <pa-geNumber ... /> (see page 160) entryType font properties.

Default: normal

Index entry font properties


See the and <FontDef ... /> elements on pages 40–48and 151–156). fontProperties override the default index entry textproperties, as specified by the paragraph formats referenced by the<IndexDef ... > <levelFormat ... > sub-elements (see page 159). ThefontFormat property name must be used when referencing a font formatdefinition created using the <FontDef ... /> element.

<IX ... >



Property Value>

<IX> sub-elements

The following elements may be included between <IX> and </IX>. fontProper-ties refers to element properties. See the element on pages40–48).

<IXsub [sortKey="string"] fontProperties />

Start index sub-entry, sort sub-entry by the value of sortKey if specified.

fontProperties are element properties. See pages40–48.

</IX>

Notes1 To include spaces before the beginning of, or after the end of, index entry text (i.e.

between <IX ... > and </IX> elements), use any of the space or non-breaking spacecharacter entity references, e.g. or .

Examples

Standard indexes

Example 21 contains several <IX ... > elements. These <IX ... > elements may occur indifferent locations throughout the input.

Animals<IX name="ixExample1">Animals</IX> 

Animals range in size from very small, e.g. mice<IX name="ixExample1">mice</IX>,to very large, e.g. elephants<IX name="ixExample1" entryType="primary" >elephants</IX>.Mice are found all over, but elephants have restricted habitats, e.g.in Africa<IX name="ixExample1" entryType="primary" >elephants<IXsub/>in Africa</IX>, inIndia<IX name="ixExample1">elephants<IXsub/>in India</IX>, in circuses<IX name="ixExample1">elephants<IXsub sortKey="circus"/>in the circus</IX>and in zoological gardens. Aardvarks<IX name="ixExample1">aardvark</IX> too.<IX name="ixExample1" >elephants<IXsub sortKey="zoo"/>in the zoo</IX>

Example 21 Using the <IX ... > and <IXsub ... /> elements

AnimalsAnimals range in size from very small, e.g. mice,to very large, e.g. elephants. Mice are found allover, but elephants have restricted habitats, e.g.in Africa, in India, in circuses and in zoologicalgardens. Aardvarks too.


The output from Example 21 isshown in Figure 23.

An index based on the <IX ... >elements included in Example21 may be generated using themarkup shown in Example 22.

<IX ... >



<Index names="ixExample1"groupTitles="N" />

Example 22 Generating a default index

aardvark 65Animals 65elephants 65

in the circus 65in Africa 65in India 65in the zoo 65

mice 65

Figure 24 Output from Ex-amples 21 and 22

The index generated from Examples 21 and 22 is shownin Figure 24.

Group titles may be included in a generated index by set-ting the <Index ... > groupTitles property to 'Y', as shownin Example 23.

1 <Index names="ixExample1" groupTitles="Y" >2 <pageNumber entryType="normal" textColor="Blue" />

3 <pageNumber entryType="primary" textColor="Red" />

4 </Index>

Example 23 Generating an index with group titles

Aaardvark 65Animals 65

Eelephants 65

in the circus 65in Africa 65in India 65in the zoo 65

Mmice 65

Figure 25 Group titles:output from Examples

21 and 23

The index generated from Examples 21 and 23 is shown inFigure 25. Example 23 also includes formatting overridesfor the normal and primary page number references usingthe <Index ... > <pageNumber ... /> sub-element to specifydifferent colors for illustration—see lines 2 and 3. (In mostcases normal and primary page number references are dis-tinguished using Regular and Bold font weights.)

The formatting of the generated indexes shown in Figures 24and 25 are based on built-in default settings.

Specialized indexes

Examples 24 through 26 show how to created specialized in-dexes, specifically indexes of authors and book titles.

<fI>Diets of elephants</fI>, Johnson, Dirk, 1992.<IX name="BookTitles" > <fI>Diets of elephants</fI> </IX><IX name="Authors" >Johnson, Dirk</IX> <fI>Elephants in herds</fI>, Johns, Albert, 2014.<IX name="Authors" >Johns, Albert</IX><IX name="BookTitles" > <fI>Elephants in herds</fI> </IX> <fI>ABCDE Elephant</fI>, Johns, Xavier, 2022.<IX name="Authors" >Johns, Xavier</IX><IX name="BookTitles" > <fI>ABCDE Elephant</fI> </IX>

Example 24 <IX ... > entries for different indexes

<IX ... >



Diets of elephants, Johnson, Dirk, 1992. Elephants in herds, Johns, Albert, 2014. ABCDE Elephant, Johns, Xavier, 2022.

Figure 26 Body text output from Example 24


An ‘Authors’ index based on the<IX ... > elements included in Ex-ample 24 may be generated usingthe markup shown in Example 25.

Index of authors<Index names="Authors" groupTitles="N" />

Example 25 Generating an ‘Authors’ index

Index of authors

Johns, Albert 67Johns, Xavier 67Johnson, Dirk 67


The authors index generated from Examples 24 and 25 isshown in Figure 27.

An ‘Book titles’ index based on the <IX ... > elements in-cluded in Example 24 may be generated using the markupshown in Example 26.

Index of book titles

<Index names="BookTitles" groupTitles="N" />

Example 26 Generating a ‘Book titles’ index

Index of book titles

ABCDE Elephant 67Diets of elephants 67Elephants in herds 67

Figure 28 Output from Examples24 and 26

The book titles index generated from Examples 24and 26 is shown in Figure 28.

<lastPageNumber ... />



<lastPageNumber ... />

SummaryThe <lastPageNumber ... /> element may be included within a element to dis-play the last page number. Normally the <lastPageNumber ... /> element is used withina background <TextFrame ... > within a <PageDef ... > to include the last page numberin a document in header or footer running text.

See also: <currentPageNumber ... /> on page 35.

Properties

Property Value<lastPageNumber

Font properties


See the and <FontDef ... /> elements on pages 40–48and 151–156). fontProperties override the default page number textproperties, as inherited from the enclosing paragraph format.

/>

ExamplesExample 27 illustrates using the <lastPageNumber ... /> element.

1 The last page number is: <lastPageNumber/> 2 The last page number is: <lastPageNumber fontDef="F_Red" /> 3 The last page number is: <lastPageNumber fontDef="F_Red" fontAngle="Italic" /> 

Example 27 Using <lastPageNumber ... /> within the document main flow

The last page number is: 260The last page number is: 260The last page number is: 260

Figure 29 Output from Example 27 .

Input lines 1 and 2 in Example 27 assumethat the input also contains the following<FontDef ... /> format definition:

<FontDef fontDef="F_Red" textColor="Red" />

See Example 16 on page 36 for an illustration of the <lastPageNumber ... /> elementin a background text frame on a master page.

<Line ... />



<Line ... />

SummaryThe <Line ... /> element may be used within <PageDef ... >, <TextFrame ... >,<TextFrameDef ... > (if the type property is set to 'background') and <Frame ... > elementsto include a graphic line rule.

Properties

Property Value<Line

Line position, length and angle

left dim

Distance from left side of container to start of line.

Default: 0

top dim

Distance from top side of container to start of line.

Default: 0

length dim

Line length.

Default: Container width minus the value of width

angle number

Angle of clockwise rotation from vertical.

Default: 90 (horizontal)

Line pen properties

penWidth dim

Width of line pen.

Default: '0.5pt'


Line pen style.

Default: solid

penColor name


penTint percent


<Line ... />



Property Value

penOpacity 0 | 100


/>

<ListLabel ... >



<ListLabel ... >

SummaryUse the <ListLabel ... > element within a or a <ParaDef ... > element to formatstatic or autonumbered labels and lists.

Properties

Property Value<ListLabel

Label format

type runin | fixed

Label type.

Value Description

runin The label runs into the paragraph text. The la-bel starts at the parent element first-LineIndent. The width of the label is the length ofthe text in the label, including any counter values.

fixed The start position of the label and the label widthare specified independently of the parent element's firstLineIndent, using the <ListLabel ...> labelWidth property and, optionally, the la-belIndent property.

If type is set to 'runin', all the following <ListLabel ... > properties areignored: labelIndent, labelWidth, textAlign, lineSpacing, first-LineIndent, and startIndent. The <leader ... > sub-element (see page74) is also ignored if type is set to 'runin'.

Default: runin

Label position properties

When the type property is set to 'fixed' the labelIndent and labelWidth properties positionthe list label area outdented or indented relative to the start side of the associated paragraphtext. See Note 1 on page 75.

labelIndent auto | dim

If type is set to 'fixed', indent of the label area from the start side of itscontaining text frame or table cell.

If labelIndent is set to 'auto', the indent of the list label defaults to thevalue of the parent element 'startIndent' value minus the value ofthe labelWidth property.

Default: auto

labelWidth dim

If type is set to 'fixed', width of the list label area.

<ListLabel ... >



Property ValueIf labelIndent is set to 'auto' the distance to the start of the label areafrom the start side of its containing text frame or table cell is the value ofthe parent element 'startIndent' value minus the value of the la-belWidth property.

Default: 12mm

Label formatting properties

When the type property is set to 'fixed' the following properties are used for formatting the textin the list label area. These properties are ignored in the case of run into paragraph text list la-bels i.e. when the type property is set to 'runin'. See Note 1 on page 75.

textAlign start | end | justify

If type is set to 'fixed', alignment of list label text within the list label area.If <ListLabel ... > contains a <leader ... > sub-element (see page 74),the value of textAlign is forced to 'start'.

Default: start

lineSpacing dim

If type is set to 'fixed', leading between text lines in the label area.

Default: Same as for associated paragraph

firstLineIndent dim

If type is set to 'fixed', start indent of first line of label text within the listlabel area.

Default: 0

startIndent dim

If type is set to 'fixed', start indent of the second and following lines of la-bel text within the list label area.

Default: 0

endIndent dim

If type is set to 'fixed', end indent of label text within the list label area.

Default: 0

Label font properties

The following properties apply both in the case the type property is set to 'fixed', and in thecase it is set to 'runin'. See Note 1 on page 75.


See the and <FontDef ... /> elements on pages 40–48and 151–156).

Autonumbered series

seriesLabel string

string is a tag identifier for a ‘series label’ for the auto-labeling sequence.Several numbering series, e.g. for for table numbering and figure number-ing, may be maintained within a single document.

<ListLabel ... >



Property ValueThe seriesLabel property is ignored if there is no <counter ... /> sub-ele-ment.

Default: ""

PDF bookmark properties

showInPDFbookmark N | Y

Set to 'Y' to include the list label in PDF bookmark text if the parent<ParaDef ... > element PDFbookmarkLevel property is set (see page182).

Default: N

>

<ListLabel> sub-elements

The following elements may be included between <ListLabel> and </ListLabel>.

 

Include newline.

<Var varDef ="name" />

Include the value of variable name in the paragraph label.

<counter [numberStart ="increment | int"][numberStyle = "key | hidden"] [parent = "paragraph format"][hideParentNumber = "N | Y"] [numberPrefix = "string"] [ fontProp-erties ] />

Include autonumber in the paragraph label.

The numberStart property indicates whether the counter value for theparagraph should be incremented (numberStart='increment'), or be set toa specific starting value (numberStart="int"). The default is 'increment',starting from 1.

The parent property may be used to reference a paragraph format thathas a <ListLabel ... > sub-element with a higher-level <counter ... /> sub-element. The higher level counter value precedes the current countervalue, optionally separated by the value of the numberPrefix property.

If the hideParentNumber property is set to 'Y' the higher level counter isnot displayed.

The numberStyle property determines if and how the number should bedisplayed, based on the key value.

The key value for the numberStyle property, e.g. 'westernArabic', 'up-percaseAlpha', 'lowercaseAlpha', 'uppercaseRoman', 'lowercaseRo-man', 'indicArabic', indicates the numbering scheme and style. The fulllist of key values for the numberStyle property is shown in Table A 3.1 on pages 235–235.


If the numberStyle property is set to 'hidden' the number is not dis-played.

<ListLabel ... >



<ListLabel> sub-elements (Continued )

fontProperties may be used to override the <ListLabel ... > fontPropertieswithin the scope of the <counter ... /> sub-element. See the element on pages 40–48.

The use of the <counter ... /> sub-element for autonumbering lists andparagraphs is described in detail in Appendix 3– Autonumbering onpages 224–235.

<leader [ fontProperties ]>content</leader>

When the type property is set to 'fixed', include leader string (content).The leader string starts after the label text and optional counter values,and extends horizontally to the end of the list label area, as specified bythe labelWidth property. When the <ListLabel ... > element containsa <leader ... > sub-element the setting of the <ListLabel ... > textAlignproperty is forced to 'start' (see page 72). See Using list label leaderstrings on page 78.

The <leader ... > sub-element is ignored if the type property is set to 'run-in'.

fontProperties may be used to override the <ListLabel ... > fontPropertieswithin the scope of the <leader ... > sub-element. See the ele-ment on pages 40–48.

<chapterNumber/>

Include auto-label instance.

<Imagefile = "filename" (required)width = "dim"height = "dim"top = "dim" />

The <ListLabel ... > <Image ... > sub-element enables an image to be in-cluded in the list label. The <ListLabel ... > type property must be set to‘fixed’. If an <Image ... > sub-element is included, all other sub-elementsare ignored.

By default the image width is set to the value of the <ListLabel ... >labelWidth property (see page 71). and the height is the width timesthe image's aspect ratio. The start position of the image corresponds withthe value of the <ListLabel ... > labelIndent property (see page 71).The top of the image is aligned at the top of the paragraph body text.

file Required Name of image file.

width Override for the default image width.

height Override for the default image height.

top Upshift/downshift the vertical position of the image relative tothe paragraph body text. Negative values shift the image up-wards.

See Including an image in a list label on page 79 for examples.

</ListLabel>

<ListLabel ... >



Notes1 The <ListLabel ... > element is used for two distinct types of lists:

i Standard lists having either static or auto-labeled indented or outdented con-tiguous list label items in a list label area associated with a parent paragraph.See Static list labels on page 75 and Autonumbered list labels on page 76.

ii Or as an auto-labeled sequence of in-text labels for a series of non-contiguousitems. E.g. table titles, procedure steps and example and figure captions. SeeRun into paragraph autonumbering on page 77.

Examples

Static list labels

Static, and other, list labels may be generated via paragraph format definition or dir-ectly inline. Examples 28 and 29 (and Examples 34 and 35 on page 79) show simpleways to create bulleted lists using the inline markup element with an included<ListLabel ... > sub-element.

1 

2 <ListLabel type="fixed" labelWidth="8mm"

3 textColor="Red" textSize="10pt"4 >•</ListLabel>Lorem ipsum dolor5 sit amet, consectetuer adipiscing elit, sed diam ...6 

Example 28 Bulleted list using inline markup (1)

lWlI

pgf.fLI

pgf.sI

• Lorem ipsum dolor sit amet,

consectetuer adipiscing elit,

sed diam ...


The output from Example 28 is shown in Fig-ure 30. The dimensions ‘lI’ (label indent) and‘lW’ (label width) shown in Figures 30 through32 represent the values of the <ListLabel ... >labelIndent and labelWidth properties (see line2 in Example 29). The dimensions ‘pgf.fLI’ and‘pgf.sI’ represent the values of the parent element firstLineIndent and startIndent

properties (see line 1 in Example 28).

In the special case the <ListLabel ... > has no labelIndent property (as in Example 28, line2) the start side of the label area starts at the element startIndent minus the valueof the <ListLabel ... > labelWidth property.

In the general case, for both static and auto-labeled lists, the start of the list label area isindented to the value specified by the <ListLabel ... > labelIndent property as illustratedin Example 29 (line 2).


2 <ListLabel type="fixed" labelIndent="7mm" textAlign="end" labelWidth="8mm"

3 textColor="Red" textSize="10pt"

<ListLabel ... >



4 >•</ListLabel>Lorem ipsum dolor5 sit amet, consectetuer adipiscing elit, sed diam ...6 

Example 29 Bulleted list using inline markup (2)

lWlI

pgf.fLI

pgf.sI

• Lorem ipsum dolor sit

amet, consectetuer adipis-

cing elit, sed diam ...


The output from Example 29 is shown inFigure 31. The gap between the end side ofthe label area and the start indent of the as-sciated paragraph text is the ele-ment startIndent value minus the sum of the<ListLabel ... > labelIndent and labelWidth val-ues. In Figure 31 the red bullet character is aligned at the end of the label area owing tothe introduction of the <ListLabel ... > textAlign property with a setting of 'end' (line 2in Example 29).

lWlI

pgf.fLI

pgf.sI

• Lorem ipsum dolor sit amet,

consectetuer adipiscing

elit, sed diam ...

Figure 32 A trespassing label area

If the sum of the <ListLabel ... > labelIndent

and labelWidth values is greater than element startIndent value the label area willtrespass into the paragraph body text, as illus-trated in Figure 32.

The values of the <ListLabel ... > labelIndent

and labelWidth properties have no effect on the location of the parent paragraph's firstline indent or the start indent for the remaining lines in the paragraph.

Autonumbered list labels

The positioning of auto-labeled, or autonumbered, list label areas is the same as de-scribed in the previous section (see Static list labels on page 75), and is illustrated inExamples 28 and 29 and Figures 30 through 32.

The process for defining the structure of auto-labeled lists and their usage is illustratedin Example 30.

1 2 <ParaDef paraDef="firstStep" textSize="6.0pt" textAlign="start" spaceAbove="1pt"

3 firstLineIndent="18mm" startIndent="20.5mm" hyphenate="N" fontFamily="Arial" >4 <ListLabel seriesLabel="Steps" labelWidth="11mm" labelIndent="5mm"

5 type="fixed" >Step S<counter/>.16 </ListLabel> </ParaDef>

7 8 <ParaDef paraDef="nextStep" textSize="6.0pt" textAlign="start" spaceAbove="1pt"

9 firstLineIndent="18mm" startIndent="20.5mm" hyphenate="N" fontFamily="Arial" >

10 <ListLabel seriesLabel="Steps" labelWidth="11mm" labelIndent="5mm"

11 type="fixed" >Step S<counter parent="firstStep" numberPrefix="." numberStart="2" />12 </ListLabel> </ParaDef>

13 14 Find key. Search everywhere. Search high and low.

<ListLabel ... >



15 Find door.16 Say abracadabra.17 Push the door open.

Example 30 Autonumbered list (1)

lWlI

pgf.fLIpgf.sI

Step S1.1 Find key. Searcheverywhere. Searchhigh and low.

Step S1.2 Find door.Step S1.3 Say abracadabra.Step S1.4 Push the door open.

Figure 33 Output fromExample 30

The output from Example 30 is shown in Figure33.

Two paragraph formats with <ListLabel ... ><counter ... /> sub-elements are defined in Example30. The first, lines 2 to 6, defines the firstStep para-graph to initialize a ‘Steps’ list. The first of the two<counter ... /> sub-elements in the associated <ListLabel ... > (line 4) specifies numberincrementing. The second specifies restart numbering from 1.

The second paragraph format definition, nextStep, on lines 8 to 12, is exactly the sameas the first except that the first <counter ... /> sub-element is set not to increment and thesecond is set to auto-increment (line 10).

The four-item autonumbered list is produced via a succession of paragraphs, the firstwith paragraph format 'firstStep' and the remainder with paragraph format 'nextStep'

(lines 14 to 17).

Any number of subsequent auto-labeled ‘Steps’ lists may be produced by including a‘firstStep’ paragraph followed by a series of ‘nextStep’ paragraphs, e.g. as illustrated in Ex-ample 31.

Find chest.Break open the lock.Look for metal box.

Example 31 Autonumbered list (1)

Step S2.1 Find chest.Step S2.2 Break open the lock.Step S2.3 Look for metal box.

Figure 34 Output from Example31.


In Figure 13 the primary counter value, ‘S1’ in Fig-ure 33, is increased by one and becomes ‘S2’. Thesecondary counter is reset to one and increments foreach list item in the ‘Steps’ list instance.

Run into paragraph autonumbering

An autonumbered label may be run into the start of paragraph text, e.g. for auto-labelingcaptions, by setting both the <ListLabel ... > element labelIndent and width propertiesto 'auto'.

1 2 <ParaDef paraDef="figCaption" textSize="6.0pt" firstLineIndent="10mm" startIndent="14mm"

>

3 <ListLabel seriesLabel="exFigures" >Figure <counter numberStart="increment"

<ListLabel ... >



4 fontWeight="Bold" />: </ListLabel> </ParaDef>

5 6 Starting

7 Assembling the bobbulator with the scrivenor8 Dog swimming9 Sky diving 12/10/2022

10 Re-starting.

11 Sky diving 12/10/2023

Example 32 Run into paragraph text auto-labeling (1).

pgf.fLI

pgf.sI

Figure 1: StartingFigure 2: Assembling the bobbulator

with the scrivenorFigure 3: Dog swimmingFigure 4: Sky diving 12/10/2022

Figure 1: Re-starting.Figure 2: Sky diving 12/10/2023

Figure 35 In-text auto-labeling: out-put from Example 32

Example 32 includes a paragraph format definitionfor an autonumbered list (lines 2—4), followed bydocument content comprising a series of paragraphinstances (lines 6—11). Numbering is re-initializedusing element numberValue property (line10). The output from Example 32 is shown in Fig-ure 35.

Example 33 is nearly identical to Example 32. Themajor difference is that the value of the paragraph's startIndent is less than the value ofthe firstLineIndent.

<ParaDef paraDef="figCaptionDE" textSize="6.0pt" firstLineIndent="13mm"startIndent="10mm" >

<ListLabel seriesLabel="exFiguresDE" >Abbildung <counter numberStart="increment"fontWeight="Bold" />: </ListLabel> </ParaDef>

StartingAssembling the bobbulator with the scrivenorDog swimmingSky diving 12/10/2022Re-starting.Sky diving 12/10/2023

Example 33 Run into paragraph text auto-labeling (2).

pgf.fLI

pgf.sI

Abbildung 1: StartingAbbildung 2: Assembling the bobbulator

with the scrivenorAbbildung 3: Dog swimmingAbbildung 4: Sky diving 12/10/2022

Abbildung 1: Re-starting.Abbildung 2: Sky diving 12/10/2023

Figure 36 In-text auto-labeling: outputfrom Example 33

The output from Example 33 is shown in Fig-ure 36.

More illustrations of run into paragraph lay-outs are shown in Examples A3.7–A3.10 andFigures A3.5–A3.9 (pages 227–230).

Using list label leader strings

A list label leader string comprises a set of one or more characters that are repeated with-in the available space. The list label leader is constrained within the list label area, start-ing at the end of the list label text and extending horizontally to the end of the list labelarea.


<ListLabel ... >




3 textColor="Red" textSize="10pt"4 >•<leader>.</leader></ListLabel>Lorex ipsum dolor

5 sit amet, consectetuer miletus ...6 

Example 34 Using a list label leader string (1)

lWlI

pgf.fLI

pgf.sI

•...........Lorex ipsum dolor sit

amet, consectetuer

miletus ...

Figure 37 List label leader string (1)

A list label leader string is included in a list la-bel using the <leader ... > sub-element, as illus-trated in Example 34 (line 4).

By default the list label string has the samebaseline as the list label text. The output fromExample 34 is shown in Figure 37.



3 textColor="Red" textSize="10pt"4 >•<leader textColor="Black" textSize="7pt" verticalShift="-40%"

5 fontFamily="TimesNewRoman" >. .</leader></ListLabel>Lorey ipsum avit

6 sit amet, consectetuer millennia...7 

Example 35 Using a list label leader string (2)

lWlI

pgf.fLI

pgf.sI

•. .. .. .. .. .. .Lorey ipsum avit sit

amet, consectetuer

millennia...

Figure 38 List label leader string (2)

Example 35 illustrates using font propertieswith the <leader ... > sub-element to changethe leader string text size, color and verticalposition (lines 4 and 5). The output from Ex-ample 35 is shown in Figure 38.

Including an image in a list label

lWlI

pgf.fLIpgf.sI

Red ampersand in black circle

Figure 39 An image in a list label (1)

Example 36 illustrates including an image in a listlabel using the <Image ... > sub-element. The out-put from Example 36 is shown in Figure 39.

Images within list labels are always laterallyaligned with the start offset of the <ListLabel ... >labelIndent, as shown by the ‘lI’ dimension in Fig-ure 39. By default the width of the image is the same as the <ListLabel ... > labelWidth, asshown by the ‘lW’ dimension in Figure 39. The height of the image is derived from theimage width multiplied by the image aspect ratio. By default the top of a list label imageis aligned with the top of the body paragraph text.


2 <ListLabel type="fixed" labelIndent="5mm" labelWidth="6mm"

3 > <Image file="${images}/circleAmp2.svg"

<ListLabel ... >



4 fillColor="Black" fillTint="30%"5 /> </ListLabel>Red ampersand in black circle6 

Example 36 Including an image in a list label (1)

<MathML ... >



<MathML ... >

SummaryThe <MathML ... > element may be used within paragraphs (and within paragraphswithin table

The <MathML ... > element may contain MathML markup or may reference an externalfile using the file property (see below).

The positioning of equations relative to their anchor point within a element isspecified by setting the position property to any of the following: ‘below’, ‘inline’, ‘runin’

and ‘outsideTextFrame’. In the case the <MathML ... > element is included at the top level,outside a element, equation is positioned either at the location point, or outsidethe text frame if the position property is set to ‘outsideTextFrame’.

Properties

Property Value<MathML

Reference pre-defined equation format

mathMLDef name

name is the name of a <MathMLDef ... /> equation format definition. Seepages 161–167.

If a <MathMLDef ... /> format definition is referenced via the mathMLDefproperty all the following properties, with the exception of the mathMLDefproperty are overrides on the values specified by the <MathMLDef ... />equation format definition.

file filename

Relative or absolute file name of file containing equation in MathMLmarkup. If the file property is used, all content within the <MathML ... >element is ignored except for the <ObjectTitle ... > and <description ... >subelements.


Equation dimensionsThe width and height of an equation is the smallest bounding box that contains the equationpresentation area. See Margins (on page 84) for properties to add margins around the equa-tion bounding box.

Equation location


Position of equation relative to anchor or insertion point. The positionproperty is applicable only when the equation is within a element.

<MathML ... >




inline Within paragraph text. If position is set to ‘inline’ the align

property is ignored.


runin Run into paragraph. A maximum of one element withina element may have a position property set to'runin'. The equation should not be located immediatelybefore a page or column boundary.


If the <MathML> element is at the top level, outside a element, the‘below’, ‘inline’ and ‘runin’ values are not applicable.

If position is not set to ‘inline’ the lateral alignment of the equation is spe-cified using the align property (see below).

When position is set to ‘outsideTextFrame’ the lateral position of the equa-tion may be further adjusted using the sideOffset property (see below).

When position is set to ‘runin’ the top of the equation is aligned with thetop of the text (at caps height) in the first line of the paragraph. Whenposition is set to ‘outsideTextFrame’ the top of the equation is aligned withthe top of the text (at caps height) in the first line of the paragraph by de-fault. This position may be adjusted using the verticalOffset property (seebelow).

Default: inline

positionOverride none | fromInput

If positionOverride is set to ‘fromInput’ use the setting specified by theequation's <math> element display attribute,


Lateral alignment of the equation. The align property is ignored if positionis set to ‘inline’.


Value Description


center Center the equation between the left and right textframe borders.


Default: end

sideOffset dim

Offset of equation from the alignment position specified by the alignproperty.


Default: 0

<MathML ... >



Property Value

verticalOffset dim

Vertical offset of equation.

Effective only if the position property is set to 'outsideTextFrame'. Valuemay be positive or negative. By default the top of the equation is alignedwith the top of the text (at caps height) in the first line of the containerparagraph.

Default: 0

Text runaround gapThe following runaround properties are effective only if the <MathML ... > element is includedwithin a element and the position property is set to ‘runin’.

runAroundGap dim

Specify the gap between the equation and text flowing around it. Thevalue of dim may be negative.

Default: 6pt

sideGap dim

Specify the side gap between the equation and text flowing around it. Thevalue of dim may be negative.


belowGap dim

Specify the gap below the equation and text flowing around it. The valueof dim may be negative.


Vertical spacing properties

The following properties apply only if the <MathML ... > element is included at the top level, i.e.outside a element or the position element is set to ‘below’.

spaceAbove dim

Space above equation.

In the case the <MathML ... > is at the top level, the actual spacing is de-termined by the larger of the space above the equation and the space be-low the preceding paragraph, not the sum of the two (see Note 1 on page184). If the <MathML ... > is within a element spaceAbove is thesole determinant of the vertical space between the equation and the pre-ceding text.

spaceBelow dim

Space below equation. Ignored unless the <MathML ... > element is in-cluded at the top level.

Actual spacing is determined by the larger of the space below the equation(or the equation title, if present) and the space above the following para-graph, not the sum of the two. See Note 1 on page 184.

<MathML ... >



Property Value


startIndent dim

Position of equation relative to the start side of the container. Ignored un-less the align property is set to ‘start’.

endIndent dim

Position of equation relative to the end side of the container. Ignored un-less the align property is set to ‘end’.



fontFamily name


textSize dim

Text size.


textColor name

Text color.

Fallback font properties

Specify the fallback font to use for characters in the equation that are not contained in the cur-rently-applicable font.

The ‘currently applicable font’ is either the font used in the current text context, or the font spe-cified by the <MathML ... > or the <MathMLDef ... /> element fontFamily property.

fallbackFontFamily name

Fallback font family. E.g. ‘Cambria Math’, ‘Quivira’.

Default: ‘Quivira’

Margins

Specify margins around the equation bounding box. Equation margin properties are inapplicablewhen position is is set to inline.

startMargin dim

Margin at the beginning of the equation.

Default: 0pt

topMargin dim

Margin above the equation.

Default: 0pt

endMargin dim

Margin at the end of the equation.

Default: 0pt

<MathML ... >



Property Value

bottomMargin dim

Margin below the equation.

Default: 0pt

Border rulings

In the following name> must be the name of a ruling defined in a template file or by using the<RuleDef ... /> element, see page 188. Set name to "none" for no ruling.

startRule name

Start-side ruling.

Default: none

topRule name

Top-side ruling.

Default: none

endRule name

End-side ruling.

Default: none

bottomRule name

Bottom-side outside ruling.

Default: none


Background fill properties apply uniformly to both the equation bounding box area and to themargin areas. If the <math> markup includes mathbackground, e.g. on the <math> or <mstyle>elements, the maximum area of application for mathbackground is the equation bounding box,excluding the margin areas.

fillColor name


fillTint percent


fillOpacity 0 | 100


>

<MathML ... >



<MathML> sub-elements

The following elements may be included between <MathML> and </MathML>.


Include a caption for the equation. See the <ObjectTitle ... > element onpages 88–90 for properties. Not applicable when position is set to‘inline’ (see page 81).


Include a description of the equation. This is for a read out loud applica-tion. The description text is not included in the displayed output.

</MathML>

Notes1 See the Notes for the <MathMLDef ... /> element on page 165.

Examples

Inline equations

Example 37 illustrates using the <MathML ... > element to produce an equation withinparagraph text.

1 An Equation: <MathML textSize="7pt"3 fontFamily="Cambria Math" >4 <math>5 <munderover>6 <mo>∫</mo><mi>a</mi><mi>b</mi>7 </munderover>8 <mfenced separators=''>9 <mn>5</mn><mi>x</mi><mo>+</mo><mn>2</mn><mi>sin</mi>

10 <mfenced separators=''><mi>x</mi></mfenced>11 </mfenced>12 <mi>dx</mi>13 </math>14 </MathML> from Math ML

Example 37 A simple equation in <MathML ... >

An Equation: from

Math ML



<MkDest ... />



<MkDest ... />

SummaryUse the <MkDest ... /> element to create a hypertext and / or cross-reference destinationlink.

Properties

Property Value<MkDest

Hypertext and X-ref type and destination

id string

string is a unique value indentifying a hypertext or cross-reference destina-tion target, or both.

For exampleHorses usually have four legs, a head,<MkDestid="horses42" /> and a tail.

produces the following text containing a hidden hypertext destinationhorses42

Horses usually have four legs, a head, and a tail.

/>

Notes1 The element startID and endID properties (see page 99) provide an al-

ternative, shorthand way of creating hypertext and cross-reference destinations atthe beginning and end of paragraphs.

<ObjectTitle ... >



<ObjectTitle ... >

SummaryUse <ObjectTitle ... > within <AFrame ... >, <ATextFrame ... >, <MathML ... > and<MathMLDef ... /> elements (provided the position property is not set to ‘inline’) toinclude a simple title or caption above or below the object.

Properties

Property Value<ObjectTitle

Default paragraph format

paraDef name

Name of paragraph format to use as default for the title text.

Title location properties

position above | below

Place title area above or below object.

Default: below

titleGap dim

Gap between title area and object.

Default: 2pt

Title area margin properties

marginAbove dim

Margin between the top of the object title area and the object title text.

Default: 2pt

marginBelow dim

Margin between the bottom of the object title area and the object titletext.

Default: 2pt


penWidth dim



Border pen style.

Default: solid

<ObjectTitle ... >



Property Value

penColor name


penTint percent


penOpacity 0 | 100



fillColor name


fillTint percent


fillOpacity 0 | 100


</ObjectTitle>

Notes1 Paragraph text within a <ObjectTitle ... > element may contain cross-references and

hyperlink destinations.

2 The width of the object title area is the same as the width of the associated<AFrame ... > or <ATextFrame ... >.

ExamplesExample 38 illustrates <ObjectTitle ... > usage.

1 An end-aligned run in anchored object (<AFrame>) with2 a object title (<ObjectTitle>).3 <AFrame wrapContent="Y" align="end" position="runin" >4 <ObjectTitle position="below" titleGap="5.3mm"5 marginAbove="4mm"6 marginBelow="3mm"7 penWidth="0.3pt" penStyle="dashed" penColor="Blue"8 >9 ObjectTitle text12 More title text.

<ObjectTitle ... >



13 </ObjectTitle>14 <Image width="29mm" height="20.0mm" file="${images}/dunes.jpg" />15 </AFrame>16 

Example 38 Using <ObjectTitle ... >

titleGap="5.3mm"title area

topMargin="4mm"

total text height (9.5mm)

bottomMargin="3mm"

ObjectTitle text

More title text.

An end-aligned runin anchored object(<AFrame>) witha object title (<Ob-jectTitle>).


The output from Example 38 is shownin Figure 41, along with annotationsshowing the object title area and the<ObjectTitle ... > element titleGap, top-

Margin and bottomMargin dimensions.







SummaryUse the element to begin a new paragraph or as a container for other objects,such as tables, anchored frames, and anchored text frames.

Paragraph auto-labeling properties may be set using the <ListLabel ... > element (seepages 71 –80).

Properties

Property Value element on pages175–186.



fontFamily name


textSize dim

Text size.


fontAngle name


See the description of fontAngle in the element on page41.

fontWeight name

Font weight. E.g. 'Bold', 'Medium'.

See the description of fontWeight in the element on page41.

textColor name

Text color.

textOpacity 100 | 0

Text opacity.

See the description of textOpacity in the element on page41.

Default: 100





Property Value

language key

Set the paragraph language to key. The key values for the language prop-erty are listed in Table A 2.1 on pages 223–223.


Horizontal alignment

textAlign start | end | center | justify

Text alignment and justification.

Value Description

start Align text at the beginning of lines. Ragged line ends.

end Align text at line ends. Ragged line starts.

center Align text lines at the center. Ragged line starts and ends.

justify Align text lines at start and end. Text justification at bothends.

firstLineIndent dim

First line indent.

Indent of the first line of paragraph text from the start side of a textcolumn or from the margin of a table cell.

startIndent dim

Start indent (excluding the first line of the paragraph).

Distance of the second and succeeding lines of text from the start side of atext column or from the start margin of a table cell.

endIndent dim

End indent.

Distance of lines of text from the end side of a text column or from theend margin of a table cell.

indentMode absolute | relative

Set indent from edge of container or relative to the indent of the preced-ing paragraph.

Line spacing

spaceAbove dim

Space above paragraph.

Actual inter-paragraph spacing is determined by the larger of the spaceabove the current paragraph and the space before the preceding para-graph, not the sum of the two. See Note 1 on page 184.

deltaSpaceAbove dim

Maximum additional space above paragraph allowable when feathering isenabled for a document section.





Property ValueSee the description of the feather property for the <Section ... /> and<SectionDef ... /> elements (on pages 114 and 195).

Default: 0

spaceBelow dim

Space below.


leading dim

Leading. Default units are points.

Leading is the space between lines within a paragraph. Line spacing(baseline to baseline) is leading plus point size of the text.

lineSpacingMode fixed | proportional

Line spacing mode.

Setting lineSpacingMode to 'fixed' results in no adjustment for extralarge characters, superscripts, inline anchored frames, etc. When lineSpa-cingMode is set to 'proportional' the inter-line spacing is adjusted to pre-vent contact between text lines in cases where the text contains either lar-ger than normal characters or inline anchored frames.

Paragraph placement


Paragraph start position. The position property is effective only if the element is within the body text flow.

Value Description

normal Start paragraph immediately after preceding para-graph.

topOfColumn Start paragraph at the top of the next column.

topOfPage Start paragraph at the top of the next page.

topOfLeftPage Start paragraph at the top of the next left page.

topOfRightPage Start paragraph at the top of the next right page.

For single-sided documents (see the <DocDef ... /> doubleSided prop-erty on page 143) setting the position property to any of 'topOfPage','topOfLeftPage', or 'topOfRightPage', has the same effect, which is toforce the paragraph to start at the top of a page.

The position property has no effect if the paragraph will in any case startin the requested position. For example, if the position property is set to'topOfPage' on the first paragraph in a document then that paragraph willbe output at the beginning of the first page. No preceding blank first pagewill be produced. (To get such a blank page include two paragraphs withthe position property set to 'topOfPage', the first paragraph being empty.)

Default: 'normal'

minimumLines int

Minimum number of widow/orphan lines.





Property Value

withNext none | all | namelist

Keep with next paragraph setting.

Value Description

none Do not force keeping this paragraph with any fol-lowing paragraph.

all Keep this paragraph with the following paraagraph.

namelist If this paragraph is followed by any paragraph innamelist, then keep this paragraph on the samepage as that paragraph.

withPrevious N | Y

Keep with previous paragraph.

List label & autonumbering

listLabel Y | N

Enable/disable list label. If listLabel property is set to ‘N’ and the paragraphhas an associated <ListLabel ... > element the contents of the list label arenot displayed. In this case any counters that the list label may contain arenot incremented.

See the <ListLabel ... > element on page 71 for information on how toset up list labels for paragraphs.

Default: Y

numberValue increment | int

If the element contains a <ListLabel ... > with a <counter ... /> ele-ment, replace the current value of the counter with the value of the num-berValue property when the numberValue property is set to int. See Ex-ample A3.2 on page 225.

Default: increment

Text capitalization



See the description of capitalization in the element on page41.

Default: normal




Default: fromFont





Property Value



Default: 80%

Font features

fontFeatures N | Y




See the description of fontFeaturesList in the element on page42.



Underline style.

Value Description

none | N No underline.

single | Y Normal underline.

numeric Numeric (low) underline.

double Double underline.


See the description of textUnderline in the element on page42.



See the description of underlineOffset in the element on page43.



See the description of underlineThickness in the element onpage 43.



See the description of underlineGap in the element on page44.





Property ValueUnderline gap between the centers of the underlines as an absolute valueor a percentage of the text size. Applicable only when underline is set to'double'.

underlineColor name

Underline color.

See the description of underlineColor in the element on page44.

textOverline N | Y

Overline.

See the description of textOverline in the element on page44.

Default: 'N'

strikeThrough N | Y

Strike through.

See the description of strikeThrough in the element on page44.

Text background color

For an alternative method of specifying paragraph background fills (and border rulings), see the<paraFrame ... /> sub-element on page 99.

fillColor name

Apply a background color to the paragraph text.

The background color is applied to the rectangle that has vertical sides atthe values of startIndent and endIndent and horizontal sides at the topof the first line of text and at the bottom of the last line of text.

See the description of fillColor in the element on page 96.

E.g. the followingArma virumque cano, Troiae qui primus ab oris. Italiam, fato profugus

produces:Arma virumque cano, Troiae qui primus ab

oris. Italiam, fato profugus


fillTint percent


See the description of fillTint in the element on page 96.

E.g. the followingText with a blue-tint background.

produces: Text with a blue-tint background.

Default: 100%

fillOpacity 100 | 0

See the description of fillOpacity in the element on page 96.





Property ValueOpacity of text background color. Applicable only if fillColor is set.

E.g. the followingText with a 20% opacitybackground.

Default: 100%

paraFrame Y | N

Set the paraFrame property to ‘N’ to disable the background fill and bor-ders specified by a <paraFrame ... /> sub-element, if any.

Default: Y

Line breaking

hyphenate Y | N


maximumHyphens int






minimumWordSize int












textKern Y | N


See the description of textKern in the element on page 46.







Property Value

ligatures N | Y

Enable ligatures.

textSpread percent



See the description of textSpread in the element on page46.

Default: '0'

letterSpacing N | Y







See the description of optimumWordSpace in the element onpage 46.



PDF output properties

See also: <ListLabel ... > element showInPDFbookmark on page 73.

PDFbookmarkLevel int

PDF bookmark level applied to the paragraph format during conversion toPDF. If the bookmark level is zero, the paragraph is not included as an PDFbookmark in the resulting PDF file.

PDFbookmarkVerticalShift dim

Vertically shift the location of the book mark target. Negative values movethe target upwards. Positive values move the target downwards (i.e. in theinitial page display the target will be located above the top of the page dis-play.)

By default the bookmark target is located some distance above the refer-enced paragraph text. The distance above corresponds to the value of theparagraph spaceAbove property.

Default: 0





Property Value

Reference frames above and belowSee in the description of the <TextFrameDef ... > element, Using <TextFrameDef ... > to defineabove and below frames on pages 210–211.

frameAbove none | name

Top or above separator frame. name refers to the value of a <Text-FrameDef ... > element textFrameDef property.

Default: none

frameBelow none | name

Bottom or below separator frame. name refers to the value of a <Text-FrameDef ... > element textFrameDef property.

See frameAbove property above.

startID string

Create a hypertext and cross-reference destination link, string, at the be-ginning of the paragraph.

endID string

Create a hypertext and cross-reference destination link, string, at the endof the paragraph.

>

 sub-elements

The following elements may be included between and .

<endTab fontProperties>content</endTab>

Insert an end tab in paragraph text. The end of the text following the endtab element is aligned with the end edge of an enclosing text frame orthe start of the endMargin area in a table cell.

If the <endTab ... > has text content, the text content is used to form aleader string pattern. A content-free <endTab/> element has no leaderstring.

The <endTab ... > sub-element is effective only if the text following it isshorter than the width of the enclosing text frame.

fontProperties are element properties. See pages40–48.

<paraFrame[ fillColor = "name" ] [ fillTint = "percent" ][ fillOpacity = "percent" ] [ topMargin = "dim" ][ endMargin = "dim" ] [ bottomMargin = "dim" ][ startRule = "name" ] [ topRule = "name" ][ endRule = "name" ] [ bottomRule = "name" ]/>

The <paraFrame ... /> sub-element specifies a background fill in andaround a paragraph, and/or rulings around a paragraph. A paragraphcontaining a <paraFrame ... /> sub-element cannot be split acrosscolumns or pages.





 sub-elements (Continued )

See the <ParaDef ... > <paraFrame ... /> sub-element on pages 183 fora detailed description of <paraFrame ... /> properties.



Examples

Using the <endTab ... > sub-element

Example 39 illustrates the usage of the <endTab ... > sub-element.

1 Find key.<endTab textColor="Red">.</endTab>X2 Find door <endTab fontFamily="Symbol Std"3 textSize="4pt" verticalShift="-20%" >→ </endTab>Y4 5 <endTab>.</endTab> 

6 Say abracadabra.<endTab>.</endTab> 7 Say abracadabra <endTab/>Z8 9 Read Chapter <XRef xRefDef="paragraphNumber"

10 id="inlineMarkupElements.start"/> <endTab>.</endTab>Page <XRef11 xRefDef="pageNumber" id="inlineMarkupElements.start" /> 12 13 Die Kunst der Kommunikation<endTab>.</endTab>A14 Die Fähigkeit der Kommunikation am Montag<endTab>.</endTab>B

Example 39 Using the <endTab ... > sub-element

Step S1.1 Find key......................................... XStep S1.2 Find door → → → → → → → → → → → → → Y

Step S1.3 .........................................................Step S1.4 Say abracadabra..............................Step S1.5 Say abracadabra Z

Step S1.6 Read Chapter 3 ................... Page 5

Step S1.7 Die Kunst der Kommunikation....... AStep S1.8 Die Fähigkeit der

Kommunikation am Montag.......B


The firstStep and nextStep paragraphformats referenced in Example 39 aredefined in lines 2 to 12 in Example 30 onpage 77.

If a paragraph contains only a <endTab ... >sub-element, e.g. as in line 5 in Example 39the leader string starts at the firstLineIndent

and extends to the end edge of an enclosingtext frame, or the endMargin of an enclosingtable cell.


<ParaGroup ... >



<ParaGroup ... >

SummaryUse the <ParaGroup ... > element around a group of elements, usually a set oflist items, to change the space above the first and the space below the last paragraph inthe group.

Properties

Property Value<ParaGroup

Reference pre-defined list format

See the <ParaGroupDef ... /> element (page 187).

paraGroupDef name

name is optional list format name.

Space above and below paragraph group

spaceAboveParaGroup dim

Override for the first paragraph's spaceAbove value.

spaceBelowParaGroup dim

Override for the last paragraph's spaceBelow value.

> content </ParaGroup>

Notes1 See Note 1 on page 184.

Examples

Ipso lorem ipso loremviz ipso lorem

• Archimedes• Euclid• Pythagoras

Ipso lorem ipso lorem

Figure 43 Output fromExample 40.

Example 40 illustrates vertical spacing of paragraph textwhen the <ParaGroup ... > element is not used.

1 Ipso lorem ipso lorem2 viz ipso lorem 3 Archimedes4 Euclid5 Pythagoras6 Ipso lorem ipso lorem

Example 40 Not using <ParaGroup ... >


<ParaGroup ... >



Ipso lorem ipso loremviz ipso lorem

• Archimedes• Euclid• Pythagoras

Ipso lorem ipso lorem

Figure 44 Output fromExample 41.

Example 41 illustrates vertical spacing of the same para-graph text when the <ParaGroup ... > element is used.

1 Ipso lorem ipso lorem2 viz ipso lorem 3 <ParaGroup4 spaceAboveParaGroup="3pt"5 spaceBelowParaGroup="8pt"6 >7 Archimedes8 Euclid9 Pythagoras

10 </ParaGroup>11 Ipso lorem ipso lorem

Example 41 Using <ParaGroup ... >


<Row ... >



<Row ... >

SummaryUse the <Row ... > element within a <Tbl ... > element (see page 115), to begin a rowwithin a table. Data is included in table cells using one or more <Cell ... > elements (seepage 17).

Properties

Property Value<Row

Row type and location

type header | body | footer

Type of row.

Value Description

header Header row.

body Body row.

footer Footer row.

Default: body

withNext N | Y

Keep row with next row.

Ignored if the withPrevious property on the next row is explicitly set to'N'.

Default: N

withPrevious N | Y

Keep row with previous row.

Default: N

Row height

maximumHeight dim

Maximum permissible height of row.

minimumHeight dim

Minimum permissible height of row.

height dim

Fixed height of row.

If the height property is set, the minimumHeight and maximumHeightproperties are ignored.

<Row ... >



Property Value

Cell properties

Cell background (default for all cells in row)

fillColor color


fillOpacity 0 | 100

Fill opacity.

Default: 0

fillTint percent

Fill tint.

Default: 100%

Cell border rulings (default for all cells in row)

startRule name

Start ruling.

name is the name of a ruling format in a referenced template, or definedusing the <RuleDef ... /> format definition element (see page 188).

Default: none

topRule name

Top ruling. See startRule above.

endRule name

End ruling. See startRule above.

bottomRule name

Bottom ruling. See startRule above.

Cell margins (default for all cells in row)

allMargins dim




startMargin dim


topMargin dim


endMargin dim


<Row ... >



Property Value

bottomMargin dim


Vertical alignment of cell text (default for all cells in row)


Vertical alignment of the cell text block within the startMargin andendMargin cell margins.

If the cellOrientation property is set to ‘90’ or ‘-90’, the vertical text blockis aligned horzontally.

</Row>

<RunningText ... >



<RunningText ... >

SummaryUse the <RunningText ... > element within a background <TextFrame ... >, or a<TextFrameDef ... > element with it's type property set to 'background' (see pages 125and 207), to include running text derived from paragraph text of the first- or last-encountered paragraph text within the body (foreground) text flow on the currentpage. That is, one or all of: the paragraph text referenced using <paragraphText/>, theparagraph label text referenced using <paragraphLabel/> or the paragraph autonumbercounter values (and any text between them) referenced using <paragraphNumber/> sub-elements.

The <RunningText ... > element may also be used to include text contained within hid-den <RunningTextMarker> elements (see pages 111–111) within the body text flow.

Each of the <paragraphText/>, <paragraphLabel/> and <paragraphNumber/> sub-ele-ments supports a select property to specify whether the text of the first or last occurrenceparagraph should be included in the running text.

Properties

Property Value<RunningText

Define running text for background text frame

runningTextDef name

name is the name of a running text format defined either in a template orby using the <RunningTextDef ... > element (see pages 189–192).

The runningTextDef property is optional. The sub-element contents of run-ning text may be specified either inline within a <RunningText ... > elementor by using the runningTextDef property to reference a running text formatdefinition, not both.

>

<RunningText> sub-elements

The following elements may be included between <RunningText> and</RunningText>.(The following sub-elements are ignored if the runningTextDef property is used.)

deftext

deftext consists of text and newline characters. All binary newlines andtabs are ignored.

<RunningText ... >



<RunningText> sub-elements (Continued )

Special characters may be encoded using the character entity name string(&name;), or the numeric character reference (&#nn; or &#xhhhh;). If therequested character is not available in the current font, it is ignored with awarning message.

 

Inserts hard return in definition text.



The element may be used within <RunningText ... >.

<paragraphText names="namelist" [select="first | last"]keepFormatting = "N | Y" />

Expands to the paragraph text (excluding label text and autonumber text)of the first paragraph on the current page which has one of the para-graph formats listed by the names property.

namelist is a comma or bar separated list of one or more para-graph formats defined using the <ParaDef ... > element (see pages175–186).

If there is no paragraph on the current page with a format name listedby the names property, then the paragraphText of the nearest preced-ing paragraph that has one of the paragraph formats listed by the namesproperty is used.

If the select property is set to 'last', then the <paragraphText ... /> sub-element expands to the paragraphText the last paragraph on the pagethat has one of the paragraph formats listed by the names property, or,if there is no such paragraph, to the paragraphText of the nearest follow-ing paragraph that has one of the paragraph formats listed by the namesproperty.

If the <paragraphText ... /> names property contains more than onename value, then these values are treated as ORs.

The names property is required.



<paragraphLabel names="namelist" select="first | last" />

Expands to the label text (including autonumber text, if any) of the firstparagraph on the current page which has one of the paragraph formatslisted by the names property.


<RunningText ... >



<RunningText> sub-elements (Continued )

If there is no paragraph on the current page with a format name listedby the names property, then the text of the nearest preceding paragraphthat has one of the paragraph formats listed by the names property isused.

If the select property is set to 'last', then the <paragraphLabel ... /> sub-element expands to the text the last paragraph on the page that has oneof the paragraph formats listed by the names property, or, if there is nosuch paragraph, to the text of the nearest following paragraph that hasone of the paragraph formats listed by the names property.

If the <paragraphLabel ... /> names property contains more than onename value, then these values are treated as ORs.


<paragraphNumber names="namelist" select="first | last" />

Expands to the autonumber text only (i.e. excluding the paragraph bodytext and label text that is not between the first and last <counter/> ele-ments) of the first paragraph on the current page which has one of theparagraph formats listed by the names property.


If there is no paragraph on the current page with a format name listedby the names property, then the autonumber text of the nearest preced-ing paragraph that has one of the paragraph formats listed by the namesproperty is used.

If the select property is set to 'last', then the <paragraphNumber ... />sub-element expands to the autonumber text the last paragraph on thepage that has one of the paragraph formats listed by the names property,or, if there is no such paragraph, to the autonumber text of the nearestfollowing paragraph that has one of the paragraph formats listed by thenames property.

If the <paragraphNumber ... /> names property contains more than onename value, then these values are treated as ORs.


<marker names="namelist" select="first | last" />

Expands to the text included within the first instance of a corresponding(name="string" ) <RunningTextMarker> element on the current page.

If there is no instance of a corresponding <RunningTextMarker> elementon the current page, then the text from the nearest preceding or thenearest following, depending on the setting of the select property, <Run-ningTextMarker> element is used.

The <RunningTextMarker> element is described on page 111.

</RunningText>

<RunningText ... >



Examples

Pararagraph-based running text

Example 42 shows how to define a background text frame that picks up paragraph text,specifically the selected paragraph's label text, from the body text flow.

1 <TextFrame type="background"2 left="25mm" top="20mm" width="160mm" height="7mm" >

3 <Line top="4.5mm" /> 4 <RunningText> <paragraphLabel

textColor="DarkBlue"

5 names="P_chapterTitle|P_chapterTitle.ExA|P_appendixTitle" />

6 </RunningText>7 8 </TextFrame>

Example 42 Pararagraph-based running text

Example 42 shows how a background text frame may be positioned within a containing<PageDef ... > element (line 2) and how to include a <RunningText ... > element for pick-ing up a paragraph text component from the body text flow, in this case the paragraphlabel text via the <paragraphLabel/> element (line 4). The names property (line 5) con-tains the set of paragraphs that may be included. It is always the contents of the first (orlast) paragraph format in the names set that is encountered that is included. The orderof the paragraphs in the names property is insignificant.

To include the paragraph text itself as running text in a background text frame add in the<paratext/> element, as illustrated in Example 43.

1 <RunningText>2 <paragraphText names="P_chapterTitle|P_chapterTitle.ExA|P_appendixTitle" />

3 </RunningText>

Example 43 Including paragraph text in running header

To include the paragraph label and the paragraph text, line 2 in Example 43 may be ad-ded to Example 42 after line 5.

Marker-based running text

Example 44 shows how to define a background text frame that picks up hidden markertext, included using the <RunningTextMarker> element (see pages 111–111), fromthe body text flow.


3 <RunningText>4 <marker names="elementNameMarker" />

5 </RunningText>6 

<RunningText ... >



7 </TextFrame>


The value of the <marker ... /> sub-element names property, ‘elementNameMarker’, inExample 44 (line 4) is arbitrary. It is the means of identifying which <RunningTextMark-er> element's contents should be included in the background text frame, i.e. the contentsof the first or preceding (or last or next nearest later) <RunningTextMarker> element thathas a name value of 'elementNameMarker'.

<RunningTextMarker>



<RunningTextMarker>

SummaryUse the <RunningTextMarker> element within the body text flow to specify running textthat may change from page to page, but which does not appear in a paragraph of its ownwith the body flow of a document.

The <RunningTextMarker> element defines a marker for expansion within the<marker ... /> sub-element of a <RunningTextDef ... > element (see pages 189–192)located within a <TextFrameDef ... > element with its type property set to 'background'.

<RunningTextMarker> may be used any number of times in the document body textflow.

If the <RunningTextMarker> element has no content the value of the corresponding<RunningTextDef ... > <marker ... /> sub-element is empty.

Properties

Property Value<RunningTextMarker

Marker text for background text frame

name string

string is the marker name identifier for the marker text to be expanded inthe <marker ... /> sub-element in a <RunningTextDef ... > variable defini-tion.

>

<RunningTextMarker> sub-elements

The following elements may be included between <RunningTextMarker> and</RunningTextMarker>.

deftext



 


</RunningTextMarker>

ExamplesSee Example 44 on page 110.

<Section ... />



<Section ... />

SummaryUse the <Section ... /> element at the top level to begin a new document section and mas-ter page usage scheme. The <Section ... /> element always creates a page break.

Unless otherwise specified by settings in the <DocDef ... /> element (see pages193–197) all pages in single-sided documents have the layout of the ‘Right’ masterpage. Similarly double-sided documents use alternating ‘Right’ and ‘Left’ master pages,starting with the ‘Right’ page layout for the first page of the document.

Notes and examples applicable to the <Section ... /> element are included in the descrip-tion of the <SectionDef ... /> element on pages 193–197.

Properties

Property Value<Section

sectionDef name

Name of section format definition.See the <SectionDef ... /> element on pages 193–197.

pageCount any | even | odd

If set to ‘even’ or ‘odd’ force the number of pages in the document sectionto an even or odd number.

Default: Inherited from <DocDef ... /> (see ‘pageCount’ on page 143)

hyphenate Y | N


maximumHyphens int






minimumWordSize int


language key

Set the context language to key. The key values for the language propertyare listed in Table A 2.1 on pages 223–223.


<Section ... />



Property Value

Default master page usage properties

Specify new default rules for applying master pages to the destination page and to subsequentmatching pages. See Note 1 on page 196 for the definition of ‘destination page’.The rules for resolving conflicts when more than one property from the following set of Defaultmaster page usage properties is used are described in Note 2 on page 196.

oddPages name

Apply master page name to the first destination page, if it is an odd page,and to all subsequent pages in the document that are odd pages, countingthe first page as 1. See Note 3 on page 196.

Default: Inherited from <DocDef ... /> (see ‘oddPages’ on page 144)

evenPages name

If the document is double-sided, apply master page name to the first evendestination page, and to all subsequent pages in the document that areeven pages, counting the first page as 1. See Note 3 on page 196.

Default: Inherited from <DocDef ... /> (see ‘evenPages’ on page 145)

allPages name

Apply master page name to the first destination page and all subsequentpages in the document.

Default: Inherited from <DocDef ... /> (see ‘allPages’ on page 145)

Last-page master page usage properties

Specify a rule for applying an exception master page to the last page in a document, or to thelast page in a chapter in a book, that contains non-background text or graphics. All the properties in the following set of Last-page master page usage properties are ignored ifthe document contains only one page.

lastPage name

Apply background from master page name to the last non-empty page inthe document. If the document section is a single page and the Page prop-erty is set, the value of the Page property overrides the value of lastPage.

Empty-page master page usage properties

Specify which master pages to apply to empty pages. An empty page is a page that has no con-tent in its main text flow. An empty page may occur when an element is set to start at the topof a page, or at the end of the document section when the pageCount property is set to 'odd'or 'even'.

emptyPage name

Apply background from master page name to all empty pages.

Default: Inherited from <DocDef ... /> (see ‘emptyPage’ on page 145)

emptyEvenPage name

Apply background from master page name to empty even pages only.

Default: Inherited from <DocDef ... /> (see ‘emptyEvenPage’ on page145)

<Section ... />



Property Value

emptyOddPage name

Apply background from master page name to empty odd pages only.

Default: Inherited from <DocDef ... /> (see ‘emptyOddPage’ on page145)

Exception master page usage property

Specify a rule for applying a single exception master page to a destination page. See Note 1 onpage 196 for the definition of ‘destination page’. The rules for resolving conflicts when more than one property from the following Exceptionmaster page usage property is used are described in Note 2 on page 196.

Page name

Apply exception master page name to destination page regardless ofwhether the page is odd or even.

Page numbering

For setting the page numbering style and sequencing


Specifies how to compute sequential page number values.

Value Description

increment Continue the current numbering sequence.

int Reset the current numbering sequence to integer valueint.

Default: increment

pageNumberStyle key

Sets page number style.



Paragraph numbering



feather N | Y

Enable inter-paragraph feathering in this section. Feathering is only appliedto paragraphs which have the deltaSpaceAbove property set to a valuegreater than ‘0’.

See the and <ParaDef ... > deltaSpaceAbove properties on pages92 and 176.

Default: N

/>

<Tbl ... >



<Tbl ... >

SummaryUse the <Tbl ... > element to create a table instance. The table is anchored to a point inthe text immediately preceding the <Tbl ... > element.

Every table must include at least one body row.

Properties

Property Value<Tbl

Reference pre-defined table format

tblDef name

name is the table format name.

Width of table with proportional column(s)

width dim | column

Specify the overall width of table when one or more column widths are setto be proportional.

Value Description

dim Fixed table width, independent of text column ortext frame width.

column Adjust table width to width of text column or tablecontainer. If the table is within a table cell, the widthis adjusted to the width of the table cell, less the sizeof the lateral cell margins.

Ignored if all table column widths are specified as fixed using the<TblColumn ... /> element ‘ width=dim’ property. Otherwise, the tablewidth is used to calculate column widths for unspecified or proportionalwidth table columns.

See the <TblColumn ... /> element on pages 121–122, especially Note2 on page 121, for more details and examples.

Increase or chop column count

columns int

Number of columns in table, if different to the number of columns in a ref-erenced table format, and greater than the number of column widths spe-cified using <TblColumn ... /> elements.

If the <Tbl ... > element is followed by one or more <TblColumn ... /> ele-ments (see pages 121–122) specifying more than n column widths,then the number of table columns will be set to the number of tablecolumn widths specified using the <TblColumn ... /> element.

<Tbl ... >



Property Value

Basic properties

startIndent dim

Start indent. Or right indent in the case of right-to-left text.

Ignored if the align property is set to 'end' (see below).

endIndent dim

End indent. Or left indent in the case of right-to-left text.

Ignored if the align property is set to 'start' (see below).

spaceAbove dim

Space above.

spaceBelow dim

Space below.


Horizontal alignment of table within text column.

Value Description

start Align table with start of text direction.

center Center table

end Align table with end of text direction.


Table placement.

Value Description

normal Start table at the current position.

topOfColumn Start table at top of next column

topOfPage Start table at top of next page

topOfLeftPage Start table at top of next left page

topOfRightPage Start table at top of next right page

minimumRows int

Minimum number of widow/orphan rows.

Cell margins (default for all cells in table)

allMargins dim




startMargin dim


topMargin dim


<Tbl ... >



Property Value

endMargin dim


bottomMargin dim


Cell background (default for all cells in table)

fillColor color


fillOpacity 0 | 100

Fill opacity.

Default: 0

fillTint percent

Fill tint.

Default: 100%

Header, footer and body row fills

headerRowFillColor name

Background color for header rows. headerRowFillOpacity must be set to'100' for the specified color to display.

headerRowFillOpacity 0 | 100

Fill opacity for header rows.

headerRowFillTint percent

Background tint for header rows.

bodyRowFillColor name

Background color for body rows. bodyRowFillOpacity must be set to'100' for the specified color to display.

bodyRowFillOpacity 0 | 100

Fill opacity for body rows.

bodyRowFillTint percent

Background tint for body rows.

footerRowFillColor name

Background color for footer rows. footerRowFillOpacity must be set to'100' for the specified color to display.

footerRowFillOpacity 0 | 100

Fill opacity for footer rows.

footerRowFillTint percent

Background tint for footer rows.

<Tbl ... >



Property Value

Outside border rulings

(In the following name must be the name of a ruling defined in a template file or by using the<RuleDef ... /> element, see page 188. Set name to "none" for no ruling.)

startRule name

Start outside ruling.

topRule name

Top outside ruling.

endRule name

End outside ruling.

bottomRule name

Bottom outside ruling.

Header, footer and body row rulings

(In the following name must be the name of a Ruling defined in a template file or by using the<RuleDef ... /> element, see page 188. Set name to "none" for no ruling.)

bodyRowRule name

Ruling used between rows in the table body.

headerSeparatorRule name

name is the name of the ruling to use between the last heading row andthe first body row.

footerSeparatorRule name

name is the name of the ruling to use between the last body row and thefirst footer row.

Column rulings

(In the following name must be the name of a Ruling defined in a template file or by using the<RuleDef ... /> element, see page 188. Set name to "none" for no ruling.)

columnRule name

name is the name of the ruling to use between columns.

Footnote properties

When <FNote ... > elements (see pages 38–39) are contained within a table the outputfootnotes may be located either at the end of the table or repeated after the table footer onevery page. Footnote numbering within tables is always restarted from 1.

footnotePosition atEnd | atFoot

Locate all table footnotes either at the end of the table or repeated at thebottom of every page of the table.

Value Description

atEnd Locate all footnotes within the table at the end of thetable.

<Tbl ... >



Property ValueatFoot Locate all footnotes within the table at foot of the table.

Default: atEnd

fNoteDef name

Name of the <FNoteDef ... /> format definition to use for this table format.See pages 147–150).

Default: tableFootnote

</Tbl>

ExamplesExample 45 illustrates the components of a simple table.

1 2 <Tbl tblDef="noRulings" columns="4" topMargin="2.5pt" bottomMargin="1pt"3 columnRule="Thin" >4 <TblColumn width="2.2cm"/> <TblColumn width="1.5cm"/>5 <TblColumn width="10.0mm"/>6 <TblTitle fontFamily="Arial" >Long Rivers of the World</TblTitle>78 9 <Row type="header" >

10 <Cell>Region</Cell> <Cell>Name</Cell> <Cell>km</Cell> <Cell>Miles</Cell>11 </Row>12 <Row height="1.0pt" fillColor="Red" /> 13 14 <Row> <Cell>Africa</Cell> <Cell>Nile</Cell> <Cell bottomRule="Thin" >6,695</Cell>15 <Cell fontWeight="Bold" >4,155</Cell> </Row>16 <Row> <Cell/> <Cell>Congo</Cell> <Cell>4,490</Cell> <Cell>3,270</Cell> </Row>17 <Row> <Cell/> <Cell>Limpopo</Cell> <Cell>2,327</Cell> <Cell>1,511</Cell> </Row>18 <Row height="1.0pt" fillColor="Red" /> 19 <Row> <Cell rowSpan="3" >South America</Cell> <Cell>Amazon</Cell>20 <Cell>6,565</Cell> <Cell> 4,077 </Cell> </Row>21 <Row> <Cell>Orinoco</Cell> <Cell>2,603</Cell> <Cell>1,601</Cell> </Row>22 <Row> <Cell>Parana</Cell> <Cell>2,588</Cell> <Cell>1,845</Cell> </Row>23 <Row height="1.0pt" fillColor="Red" /> 24 </Tbl>25 

Example 45 Simple table

<Tbl ... >



Long Rivers of the WorldRegion Name km MilesAfrica Nile 6,695 4,155

Congo 4,490 3,270Limpopo 2,327 1,511Amazon 6,565 4,077Orinoco 2,603 1,601

SouthAmerica

Parana 2,588 1,845



<TblColumn ... />



<TblColumn ... />

SummaryUse one or more <TblColumn ... /> elements immediately after a <Tbl ... > elementto set fixed or proportional table column widths, as overrides for the <TblDef ... ><TblColumnDef ... > sub-element (see pages 121–122).

Properties

Property Value<TblColumn

Specify fixed or proportional table column width(s)

width dim | p*

Column width, either fixed ( width="dim", eg width="2cm") or propor-tional ( width="p*", eg width="2.5*").

p may be any positive number.

In the case of a proportional table column width, the actual width is cal-culated automatically from the overall width of the table, taking the othercolumn widths into account, and using the number (p) before the ‘*’ char-acter as a proportional weighting to apply to the column width.

See Notes 2 through 6, starting on page 121.

columns int

Apply the column width to the following int columns, counting from onefor this column.

Default: 1

minimumWidth dim

For proportional column widths only ( width="p*"), set the minimum al-lowed column width. See Note 5 on page 122.

Default: 5mm

/>

Notes1 The number of columns in the table is set to the number of column widths specified

using the <TblColumn ... /> element.

2 Assuming the table is not in a table cell, the calculation of actual column widthsfrom proportional column widths takes the following values into account:

width:Overall width of table specified by the <Tbl ... > element width property (seepage 115) or, if the width property is set to 'auto', the text frame or text

<TblColumn ... />



column width, depending on the setting of the 'tblWidthExtent' property, lessthe table start and end indents.

fixedWidthTotal:Sum of all fixed width columns in the table (each specified using the<TblColumn ... /> element width=dim property).

propWidthAvailable:Total width available for all proportional column widths in the table, i.e.(width - fixedWidthTotal).

propTotal:Sum of all proportional column width values in the table (specified using the<TblColumn ... /> element ‘ width=p*’ property).

The actual width of each proportional width column is calculated using the for-mula:

width = ( p / propTotal ) × propWidthAvailable

where ‘width’ is the calculated width of a proportional column, and ‘p’ is the valuespecified using width=p* property for the column.

If the calculated ‘width’ is less than the minimum column width for the column(set using the <TblColumn ... /> minimumWidth property, or as the default 5 mm)then the width is fixed at the minimum column width, and all proportional columnwidths are recalculated taking the new fixed value into account.

3 The number of <TblColumn ... /> width values specified may be less than the totalnumber of columns in the table. The column width set for the missing values de-pends on whether the <Tbl ... > element width property was specified, and onwhether the table includes any proportional column widths, as follows:

4 If the <Tbl ... > element width property is set, or the table includes one or moreproportional <TblColumn ... /> ‘ width=p*’, then the missing values are assumed tobe proportional, and are set to <TblColumn ... /> width=1* (missing columns areequally proportionally sized).

If only fixed table column widths are given, and there is no <Tbl ... > element width

property, the missing column widths are assumed to be fixed, and are set to thevalue of the last column width specified.

5 If the total of the widths of the fixed-width columns, combined with the totalof minimumWidth values for the proportional-width columns, is greater than thevalue specified or implied by the <Tbl ... > element width property, the latter valueis overridden. The column widths of any additional proportional columns are setto the value of the minimumWidth property.

6 If no <TblColumn ... /> elements are included, the fixed column widths are takenfrom the specified table format.

<TblContinuation ... />



<TblContinuation ... />

SummaryUse the <TblContinuation ... /> element to include table continuation text in a table titleor in a table header or footer row.

The table continuation text inserted by the <TblContinuation ... /> element is definedeither in a template file or by using the <TblContinuationDef> element (see page 205).

Properties

Property Value<TblContinuation

tblContinuationDef default | name

name is a reference to the name of a table continuation format definitioncreated using the <TblContinuationDef> element (see page 205).

If there is no explicit <TblContinuationDef> format definition, or none witha name value corresponding to the value of tblContinuationDef, then thevalue 'default' is assumed (see page 205).

Default: default

/>

ExamplesExample 46 illustrates using the <TblContinuation ... /> element in a table header row.

1 <Row type="header" bottomRule="none" > <Cell columnSpan="remainder" >2 My table title<TblContinuation3 tblContinuationDef="TC_englishRed" /> <MkDest id="my_table_title_1" /> 

4 </Cell> </Row>

Example 46 Using <TblContinuationDef>

The table continuation format ‘TC_englishRed’ referenced in Example 46 (line 3) isdefined in Example 77 on page 206 (see lines 7–8).

<TblTitle ... >



<TblTitle ... >

SummaryUse the <TblTitle ... > element within a <Tbl ... > element to specify a table title.

Properties

Property Value<TblTitle

Positioning properties


Place table title above or below table.

Default: above

titleGap dim

Gap between table title and first (if position is set to 'above') or last (if po-sition is set to 'below') row in the table.

</TblTitle>

<TextFrame ... >



<TextFrame ... >

SummaryUse the <TextFrame ... > element within a <PageDef ... > element (see pages171–174 to define the dimensions, position, and properties of either a series of‘background’ text frames (e.g. for running headers/footers) or a ‘foreground’ text framefor the main body text flow.

Properties

Property Value<TextFrame

Reference pre-defined text frame format

textFrameDef name

name is text frame format name. See the <TextFrameDef ... > element onpages 207–211.

Type setting

type foreground | background

Ignored unless the <TextFrame ... > element is used within a <PageDef ...> (i.e. on a master page, see pages 171–174).

Use 'foreground' to specify a main-flow text frame layout and 'back-ground' to specify a background text frame layout containing text andgraphics (such as running headers and footers) to be used on body pageswhich are formatted using the master page name specified in the enclos-ing <PageDef ... > element.

Default: foreground

Text frame dimensions

width dim

Width of text frame.

Default: 40 mm

height dim

Height of text frame.

Default: 60 mm

Text frame position

left dim

Distance of left side of text frame from left side of enclosing frame orpage.

Default: 0

<TextFrame ... >



Property Value

top dim

Distance of top of text frame from top of enclosing frame or page.

Default: 0

Multi-column layout

These properties apply only in the case of the foreground text flow

columns int

Number of equally sized sub-columns within text frame.

Default: 1

columnGap dim

Gap between sub-columns within the text frame.


penWidth dim



Border pen style.

Default: solid

penColor name


penTint percent


penOpacity 0 | 100



fillColor name


fillTint percent


fillOpacity 0 | 100


</TextFrame>

<TextFrame ... >



ExamplesSee Examples 42 and 44 on pages 109–110, and Examples 64–66 on pages172–173.

<Var ... />



<Var ... />

SummaryUse the <Var ... /> element to include a user variable instance (i.e. the variable's value.)

Variable values are defined either in a template file or by using the <VarDef ... > element(see page 212).

Properties

Property Value<Var

Name of variable to include at this point

varDef name

name is the name of the variable.

/>

ExamplesSee Example 81 on page 213 for an example of using the <Var ... /> element to inserta named variable in paragraph text.

<XRef ... />



<XRef ... />

SummaryUse the <XRef ... /> element to make a cross-reference to a destination identifier.

The cross-reference must have a format. The cross-reference format may be defined in atemplate file or by using the <XRefDef ... > element (see page 214).

A destination identifier is created using the <MkDest ... /> element (see page 87).

Properties

Property Value<XRef

Cross-reference format name and ID

xRefDef name

name is the name of a cross-reference format, either defined in a templatefile or by using the <XRefDef ... > element (see page 214).

Default: pageNumber

id string

Requiredstring is the destination identifier.

The destination identifier, specified using the <MkDest ... /> element,must be unique within a document, but a document may contain multiple<XRef ... /> elements to the same destination identifier.

/>

Notes1 There are four pre-defined, unadorned <XRefDef ... > format definitions:

<XRefDef xRefDef="pageNumber" > <pageNumber/> </XRefDef><XRefDef xRefDef="paragraphLabel" > <paragraphLabel/> </XRefDef><XRefDef xRefDef="paragraphNumber"> <paragraphNumber/> </XRefDef><XRefDef xRefDef="paragraphText" > <paragraphText/> </XRefDef>

These <XRefDef ... > format definitions may be either re-defined or supplementedusing the <XRefDef ... > element (see pages 214–216).

ExamplesExample 47 illustrates using the default built-in cross-reference definitions.

1 2 These are default cross-references: 3 See page number: <XRef id="inlineMarkupElements.start" />. 

<XRef ... />



4 See: <XRef xRefDef="paragraphLabel" id="inlineMarkupElements.start" />. 5 See chapter: <XRef xRefDef="paragraphText" id="inlineMarkupElements.start" />. 6 See chapter number: <XRef xRefDef="paragraphNumber" id="inlineMarkupElements.start"/>.7 

Example 47 Using default cross-reference definitions

These are default cross-references:See page number: 5.See: Chapter 3.See chapter: Inline markup elements.See chapter number: 3.



The output shown in Figure 46 assumes theexistence of a paragraph instance containing a<MkDest ... /> element with its id property setto 'inlineMarkupElements.start' (see page 87), ora paragraph instance with startID property set to 'inlineMarkupElements.start' (see page99). It also assumes that the paragraph has a text label including an autonumber<counter ... /> element.

By default <XRef ... /> returns the page number of the page in which the destination idis located, as illustrated on line 3 in Example 47.

See Example 83 on page 216 for an illustration of using <XRef ... /> with custom<XRefDef ... > format definitions.


Chapter 4Format definitions

Introduction

Format definition elements specify reusable, named objects, e.g. table, paragraph, TOC andmaster page formats.

The name identifier property for each format definition element is unique to the element. Theidintifier property name always has the same name as the element name itself, except with thefirst character in lower-case. This is illustrated in Example 48.

<PageDef pageDef="name" specification properties > sub-elements </PageDef>

<ContentsDef contentsDef="name" specification properties > sub-elements </ContentsDef>

<ParaDef paraDef="name" specification properties > sub-elements </ParaDef>

<FontDef fontDef="name" specification properties />

Example 48 Format definition identifier property names

The MiramoDesigner GUI save format (.mfd) comprises a subset of format definition elementsand properties described in this chapter. See the '-mfd' command line option on page 1and the <MiramoXML ... > mfd property on page 4.

Like inline markup elements, format definition elements, along with their properties/attributesand content, conform with XML syntax.2

2 See http://www.w3schools.com/xml/xml_syntax.asp for a summary of XML syntax rules.

http://www.w3schools.com/xml/xml_syntax.asp

<ChangeBarDef ... />

Chapter 4 – Format definitions



SummaryThe <ChangeBarDef ... /> element defines a location and presentational format forchangebars specified by the <ChangeBarBegin ... /> and <ChangeBarEnd ... /> elements(see pages 21–23).

Properties

Property Value<ChangeBarDef

General properties

changeBarDef name

name is <ChangeBarDef ... /> format name.



Position of the change bar.

Default: start


Change bar style.

Default: solid

width dim

Overall width of the change bar.In the case style is set to ‘double’ the change bar comprises two verticalrules each of which has a width equal to one third the value of width. Thegap between the rules is one third the value of width.

Default: 3pt

colorDef dim

Color of the change bar.

Default: Red

opacity percent

Opacity of the change bar.

Default: Red

offset dim

Offset to the center of the change bar width from the start or end edge ofthe container text column. The text column edge anchor point depends onthe setting of the position property. Positive values move the changebaroutside away from the container edge. Negative values move the change-bar inside away from the container edge.

Default: 6pt




Property Value/>

Examples

Defining change bar formats

Example 49 illustrates how to use the <ChangeBarDef ... /> element to define a changebar format.

1 <ChangeBarDef2 changeBarDef="myChangeBar"3 offset="26pt"4 width="22pt"5 colorDef="Red"6 style="ridge"7 position="start"8 />

Example 49 Change bar definition (1)

A change bar format, e.g. as defined in Example 49, may be used as shown in Example50.

1 The Orangan forest has: bears<ChangeBarBegin2 changeBarDef="myChangeBar" /> and wolves<ChangeBarEnd/>.

Example 50 Change bar usage (1)

The Orangan forest has:bears and wolves.

text frame width

offset

width


The output from Example 50 is shown in Fig-ure 47. The dotted red lines delimit the containerframe border.

<ColorDef ... />



<ColorDef ... />

SummaryUse <ColorDef ... /> to define a color format.

Properties

Property Value<ColorDef

Color format name

colorDef name

Requiredname is color format name.

CMYK values

If one or more of the following CMYK properties is set, the color specification is assumed to beCMYK and the values are converted to RGB.

cyan | c percent

Percentage cyan.

Default: 0

magenta | m percent

Percentage magenta.

Default: 0

yellow | y percent

Percentage yellow.

Default: 0

black | k percent

Percentage black.

Default: 0

RGB values

If one or more of the following RGB properties is set, and no CMYK properties are set, the colorspecification is assumed to be RGB.

red | r percent

Percentage red.

Default: 0

green | g percent

Percentage green.

Default: 0

<ColorDef ... />



Property Value

blue | b percent

Percentage blue.

Default: 0

/>

<ContentsDef ... >



<ContentsDef ... >

SummaryThe <ContentsDef ... > element specifies the inclusion criteria and the layout and format-ting properties for an auto-generated table of contents.

Properties

Property Value<ContentsDef

Contents format name

contentsDef default | name

RequiredName of contents format definition.


Contents placement.

Value Description

normal Start contents at the current position.

topOfColumn Start contents at top of next column

topOfPage Start contents at top of next page

topOfLeftPage Start contents at top of next left page

topOfRightPage Start contents at top of next right page

For single-sided documents (see the <DocDef ... /> doubleSided prop-erty on page 143), setting the position property to any of ‘topOfPage’,‘topOfLeftPage’, or ‘topOfRightPage’, has the same effect, which is toforce the paragraph to start at the top of a page.

chapterOnly N | Y

If chapterOnly is set to ‘Y’ and the <Contents ... > element occurs within a<Chapter ... > element (see pages 24–25), the generated TOC willonly include paragraphs present within the <Chapter ... > element.

Default: N

>

<ContentsDef> sub-elements

The following elements may be included between <ContentsDef> and</ContentsDef>. fontProperties refers to element properties. See the element on pages 40–48).

<ContentsInclude properties>sub-elements</ContentsInclude>

See the description of the <ContentsInclude ... > element on pages32–34).

<ContentsDef ... >



<ContentsDef> sub-elements (Continued )

The default values for <ContentsInclude ... > are described in Note 1.

</ContentsDef>

Notes1 Figure 48 shows the default configuration for <ContentsDef ... >.

1 <ContentsDef contentsDef="default">2 <ContentsInclude names="Title" paraDef="contentsLevel1"3 > <paragraphText/> <leader>.</leader> <pageNumber/> </ContentsInclude>4 <ContentsInclude names="Heading1" paraDef="contentsLevel2"5 > <paragraphText/> <leader>.</leader> <pageNumber/> </ContentsInclude>6 <ContentsInclude names="Heading2" paraDef="contentsLevel3"7 > <paragraphText/> <leader>.</leader> <pageNumber/> </ContentsInclude>8 </ContentsDef>

Figure 48 Default values for <ContentsDef ... >

The following is the simplest markup for generating a table of contents:

<Contents/>

produces a table of contents which includes ‘Title’ paragraph text from the cur-rent document, formatted with the paragraph text, dot leader and page numberusing paragraph format ‘contentsLevel1’. If the current document includes ‘Head-ing1’ and ‘Heading2’ paragraphs these will also be included in the table of con-tents, formatted using paragraph formats ‘contentsLevel2’ and ‘contentsLevel3’ re-spectively.

In the case the main headings in the document have the paragraph format name‘title’, for example, instead of ‘Title’, and ‘H1’ and ‘H2’ instead of ‘Heading1’ and‘Heading2’, then

<Contents><ContentsInclude names="title" /><ContentsInclude names="H1" /><ContentsInclude names="H2" />

</Contents>

produces an equivalent table of contents.

If the <Contents ... > element contains more than three <ContentsInclude ... > ele-ments, the formatting specified by the last <ContentsInclude ... > element in the<ContentsDef ... > provides default values for any succeeding <ContentsInclude ...> elements in the <Contents ... > instance.

For example

<Contents><ContentsInclude names="title" /><ContentsInclude names="H1" />

<ContentsDef ... >



<ContentsInclude names="H2" /><ContentsInclude names="TableTitle" />

</Contents>

is equivalent to

<Contents><ContentsInclude names="title" /><ContentsInclude names="H1" /><ContentsInclude names="H2|TableTitle" />

</Contents>

This is because there are only three pre-defined default table of contents para-graph formats: ‘contentsLevel1’, ‘contentsLevel2’ and ‘contentsLevel3’. These para-graph formats are arbitrary. In the general case the user should provide their owndefinitions for the paragraph formats, or specify a custom paragraph format foreach table of contents level. There is no limit to the number of levels or applicableparagraph formats.

2 Any or all of the attributes and sub-element contents of the <ContentsDef ... >format definition can be overridden by the <Contents ... > element (see pages26–31).

Examples

Single-level table of contents format definition

Example 51 illustrates a simple single-level contents format definition.

1 <ContentsDef contentsDef="listOfTables" >2 <ContentsInclude names="P_tableTitle|P_appendixTableTitle"

3 paraDef="P_listOfTables1" endMargin="3mm" >

4 <paragraphLabel/> <paragraphText/> <pageNumber/>5 </ContentsInclude>6 </ContentsDef>

Example 51 <ContentsDef ... > format definition for list of tables

The ‘P_listOfTables1’ paragraph format used for formatting the contents (list) entries inExample 51 (line 3) is shown in Example 52.

1 <ParaDef paraDef="P_listOfTables1" fontFamily="Arial" textSize="6pt"2 align="start" endIndent="6mm"3 letterSpacing="Y" textKern="N" spaceBelow="3.3pt"4 leading="2.3pt" startIndent="16pt" />

Example 52 <ContentsDef ... > format definition for list of tables

Example 53 shows one way to include a contents list inline.

1 List of all tables2 <Contents contentsDef="listOfTables" />

Example 53 Including a list of tables (1)

<ContentsDef ... >



List of all tables

Table 1 List of command line options 1

Table A 1.1 Font feature tag names and de-scriptions 218

Table A 2.1 List of language values 223

Table A 3.1 List of numberStyle values 235

Figure 49 Output from Examples 51–53


Example 54 uses the same<ContentsDef ... > format definition,‘listOfTables’, as in Example 53, ex-cept that the paragraph format selec-tion is reduced from ‘P_tableTitle’ and‘P_appendixTableTitle’ (line 2 in Example51) to ‘P_appendixTableTitle’ only (line 3 in Example 54).

1 List of tables in Appendices2 <Contents contentsDef="listOfTables" >3 <ContentsInclude names="P_appendixTableTitle" />

4 </Contents>

Example 54 Including a list of tables (2)

List of tables in Appendices

Table A 1.1 Font feature tag names and descriptions 218

Table A 2.1 List of language values 223

Table A 3.1 List of numberStyle values 235



<DateDef ... >



<DateDef ... >

SummaryUse <DateDef ... > to define the format of auto-generated date and time data. The dateand time is when the document is generated. This data is included using the <Date ... >element (see page 37).

Properties

Property Value<DateDef

Define a date format

dateDef name

Identifying label for the date format.

>

<DateDef> sub-elements

The following elements may be included between <DateDef> and </DateDef>.

deftext



 


<second/>

Second of the minute.

content

One or more elements (see pages 40–48) may be in-cluded anywhere within a <DateDef ... > element.

<second00/>

Second of the minute, zero padded if the second is below 10.

<minute/>

Minute of the hour.

<minute00/>

Minute of the hour, zero padded if the minute is below 10.

<DateDef ... >



<DateDef> sub-elements (Continued )

<hour/>

Hour of the day, using a 12 hour clock.

<hour01/>

Hour of the day, using a 12 hour clock. Zero padded if the hour is below10.

<hour24/>

Hour of the day, using a 24-hour clock. Zero padded if the hour is below10.

<ampm/>

Expand to am if the time is before midday, otherwise expand to pm.

<AMPM/>

Expand to AM if the time is before midday, otherwise expand to PM.

<dayNumber/>

Day of the month number.

<dayNumber01/>

Day of the month number, zero padded if the day number is below 10.

<dayName/>

Day name.

<shortDayName/>

Short day name.

<monthNumber/>

Month number.

<monthNumber01/>

Month number. Zero padded if month number is below 10.

<monthName/>

Month name.

<shortMonthName/>

Short month name.

<year/>

Year, expressed as four digits, e.g. 2028.

<shortYear/>

Short year, expressed as two digits, e.g. 28.

</DateDef>

<DateDef ... >



Notes1 The output text produced is dependent on the value of the language property cur-

rently in effect.

ExamplesExample 55 illustrates defining a date and time format using <DateDef ... >.

1 <DateDef dateDef="myDateFormat" >2 <monthName/> <dayNumber/> (<dayName/>), <year/>, <hour01/>:<minute00/> <Font3 textColor="Red" fontWeight="Bold"4 > <AMPM/> (<hour24/>.<minute00/>.<second00/> hrs)</DateDef>

Example 55 Defining <DateDef ... > variables

Example 56 illustrates using the <Date ... > element to display date and time information.

(1) Language = German <Date dateDef="myDateFormat" />(2) Language = French <Date dateDef="myDateFormat" />(3) Language = usEnglish <Date dateDef="myDateFormat" />

Example 56 Defining <DateDef ... > variables

(1) Language = GermanNovember 19 (Montag), 2018, 08:21 VORM. (08.21.48 hrs)

(2) Language = Frenchnovembre 19 (lundi), 2018, 08:21 AM (08.21.48 hrs)

(3) Language = usEnglishNovember 19 (Monday), 2018, 08:21 AM (08.21.48 hrs)

Figure 51 Output from Example 55 when lan-guage is German, French and English.

The ouput from Examples 55 and 56is shown in Figure 51.

Note that non-numeric values, e.g.for month and day names, reflectthe currently-applicable value of thelanguage property.

Default date formats

The default <DateDef ... > formats are shown in the listing below:

<DateDef fmt="lcdate"> <monthName/> <dayNumber/>, <year/> </DateDef>

<DateDef fmt="scdate"> <monthNumber/>/<dayName/>/<shortYear/> </DateDef>

<DocDef ... />



<DocDef ... />

SummaryUse the <DocDef ... /> element to set default document-wide properties such as masterpage usage, page numbering, and footnote properties.

For complex page layouts, with multiple background text frames or multi-page layouts,use the <PageDef ... > and <TextFrameDef ... > elements (see pages 171–174 and207–211), which enable parameterization of complex page layouts. Alternatively,use a template file saved in ‘.mfd’ format.

Properties

Property Value<DocDef

Page size properties

width dim

Page width. If the value of the width property is less than the value of theheight property (see below) the document is portrait; otherwise it is land-scape. The minimum width allowed is 1 mm (ca. 0.04 inches).

height dim

Page height. If the value of the height property is greater than the valueof the width property (see above) the document is portrait; otherwise it islandscape. The minimum height allowed is 1 mm (ca. 0.04 inches).

Pagination properties

doubleSided N | Y

Y = "double-sided". N = "single-sided".



Default: any

hyphenate Y | N


maximumHyphens int






<DocDef ... />



Property Value

minimumWordSize int


language key



Page numbering




Value Description



Default: increment

pageNumberStyle key




Paragraph numbering




Specify default rules for applying master pages to the destination page and to subsequentmatching pages. See Note 1 on page 196 for the definition of ‘destination page’.The rules for resolving conflicts when more than one property from the following set of Defaultmaster page usage properties is used are described in Note 2 on page 196.

oddPages name


Default: Right

<DocDef ... />



Property Value

evenPages name


Default: Left

allPages name


Default: Right



lastPage name




emptyPage name


Default: Blank

emptyEvenPage name


Default: Blank

emptyOddPage name


Default: Blank

Default bitmap image scaling

defaultDPI int

Default scaling factor to use for bitmap images that have no dpi metadata.

Footnote properties

fNoteDef name

Name of the <FNoteDef ... /> format definition to use for the document.

<DocDef ... />



Property Value/>

<FNoteDef ... />



<FNoteDef ... />

SummaryUse the <FNoteDef ... /> element to specify the formatting of footnotes.

The <FNoteDef ... /> may be referenced via either the <DocDef ... /> or <TblDef ... > ele-ments' fNoteDef properties. See pages 145 and 201. The <FNoteDef ... /> is not ap-plicable to the <FNote ... > element.

Properties

Property Value<FNoteDef

Footnote format name

fNoteDef name

Requiredname is footnote format name.

Anchor properties

Footnote 'anchor' properties relate to the footnote indicator within body text.

anchorPosition superscript | baseline | subscript

Footnote anchor position.

Default: superscript

anchorFontDef name

Use a text style and format defined by a <FontDef ... /> element (see pages151–156).

Default: same as parent paragraph

anchorPrefix string

Footnote anchor prefix text. The prefix text uses the style and format spe-cified by the anchorFontDef property. Default is no prefix.

anchorSuffix string

Footnote anchor suffix text. The suffix text uses the style and format spe-cified by the anchorFontFormat property. Default is no suffix.

Numbering

numberStyle custom | key

Footnote numbering mode.

If numberStyle is set to 'custom', the numbering sequence is as definedby the numberSequence property. Alternatively the numberStyle may beset to one of the following key values.

Key Description

westernArabic Western arabic numerals: 1, 2, 3, ...

<FNoteDef ... />



Property ValueuppercaseAlpha Uppercase ASCII letter sequence: A, B, C, ...

lowercaseAlpha Lowercase ASCII letter sequence: a, b, c, ...

uppercaseRoman Uppercase roman numerals: I, II, III, ...

lowercaseRoman Lowercase roman numerals: i, ii, iii, ...

indicArabic Eastern/Indic Arabic numerals: ١, ٢, ٣, ٤, ٥, ٦ ...

Persian | Urdu Persian / Urdu numerals: ۱, ۲, ۳, ۴, ۵, ۶ ...


numberSequence list

Ordered, bar or comma separated list of footnote indicators.

The numberSequence property is ignored unless the numberStyle prop-erty is set to 'custom'

E.g.(1) numberSequence="*|**|***"

(2) numberSequence=" *|**| ***"

(1) and (2) above are equivalent since whitespace (binary spaces, tabs andnewlines) are ignored in list values.

Default: "* | † | ‡ | § | ¶ | ** | †† | ‡‡"

numberRestart perDocument | perPage

Continue numbering through the document or restart numbering on everypage.

Footnote ruling

rule Y | N

Include a horizontal rule above the footnotes. The rule graphical and po-sitioing properties are specified using the <FNoteSeparator ... /> sub-ele-ment (see page 149).

Default: Y

Footnote instance formatting

paraDef name

Default paragraph format for footnotes. A paragraph format defined by a<ParaDef ... > element (see pages 175–186). <ListLabel ... > propertiesassociated with paragraph 'name' are ignored.

Default: Footnote

labelFontDef name

Use a text style and format defined by a <FontDef ... /> element (see pages151–156) for the footnote label.

Default: same as for paraDef

<FNoteDef ... />



Property Value

labelWidth dim

Width of the footnote label. Analogous to the <ListLabel ... > element la-belWidth property (see page 71).

Default: 10pt

labelAlign start | center | end

Alignment of the footnote label within the labelWidth Analogous to the<ListLabel ... > element textAlign property (see page 72).

Default: start

labelIndent dim

Indent of the footnote label from the start side of the footnote area. Ana-logous to the <ListLabel ... > element labelIndent property (see page71).

labelPrefix string

Footnote label prefix text. The prefix text uses the style and format spe-cified by the labelFontDef property.

Default: same as for anchorPrefix

labelSuffix string

Footnote label suffix text. The suffix text uses the style and format specifiedby the labelFontDef property.

Default: same as for anchorSuffix

Footnote gap

minimumGap name

In the general case: minimum distance between the bottom of the bodytext and the footnote ruling when the rule property is set to ‘Y’; otherwisethe minimum distance between the body text and the first footnote.

In the case of a table footnote, the gap between the preceding row andthe first footnote.

Default: 8pt

>

<FNoteDef> sub-element

The following element may be included between <FNoteDef> and</FNoteDef>.

<FNoteSeparator minimumGap="dim" ruleGap="dim" ruleStart="dim"ruleLength="dim | percent" penProperties />

Specify footnote gap and ruling properties. The ruling properties are ig-nored if the rule property (see page 148) is set to ‘N’.

Property Description

ruleGap Distance between the footnote separator ruling and thetop of the first footnote.Default: '3pt'

<FNoteDef ... />



<FNoteDef> sub-element (Continued )

ruleStart Indent of footnote separator ruling from start side of textframe.Default: '0'

ruleLength Length of footnote separator ruling.Default: '80%'

penProperties penWidth (dim), penColor (name), penTint (percent) andpenStyle (solid | dashed | dotted).

Use penWidth to specify the width of the footnote separator ruling.

/>

<FontDef ... />



<FontDef ... />

SummaryUse the <FontDef ... /> element to create a font format which may be referenced by the, <ParaDef ... >, and elements.

Properties

Property Value<FontDef

Name of font format

fontDef name

Requiredname is font format name.


fontDef name

Font format name.

shortYear is the name of a font format defined either in a template docu-ment or by using the <FontDef ... /> element (see pages 151–156).



fontFamily name


textSize dim

Text size.


fontAngle name



fontWeight name



textColor name

Text color.

textOpacity 100 | 0

Text opacity.

<FontDef ... />



Property ValueSee the description of textOpacity in the element on page41.

Default: 100

language key



Text capitalization




Default: normal




Default: fromFont



Default: 80%

Font features

fontFeatures N | Y







Underline style.

<FontDef ... />



Property ValueBy default the underline color is as specified by the textColor property,i.e. the color of the text above the underline. Underline color may bechanged by setting the underlineColor property. Underline thicknessesand baseline offsets may be changed by setting the underlineThicknessand underlineOffset properties.









underlineColor name


textOverline N | Y

Overline.


Default: 'N'

strikeThrough N | Y

Strike through.


fillColor name

See the description of fillColor in the element on page 44.


fillTint percent

See the description of fillTint in the element on page 45.


Default: 100%

fillOpacity 100 | 0

See the description of fillOpacity in the element on page45.


Default: 100%

<FontDef ... />



Property Value

Line breaking

lineBreak Y | N

Suppress line breaks within a word or phrase.

If the lineBreak property is set to ‘N’, all other hyphenation and linebreaking properties are ineffective.

hyphenate Y | N


maximumHyphens int






minimumWordSize int












textKern Y | N



ligatures N | Y

Enable ligatures.

textSpread percent




<FontDef ... />



Property Valuepercent is relative i n c r e a s e / decrease in character spread. Negativevalues reduce character spread. Spread is expressed as a percentage of thefont size.


Default: '0'

letterSpacing N | Y











superscript N | Y

Superscript.

See the description of superscript in the element on page47.

Default: 'N'

subscript N | Y

Subscript.

See the description of subscript in the element on page 47.

Default: 'N'


Vertical displacement of text.

See the description of verticalShift in the element on page47.

Default: '0'

/>

<FontDef ... />



Notes1 In the case of a <FontDef ... /> defined with missing properties the values of the

missing properties are inherited from the values applicable to the preceding text.

Examples

Using rdim

Example 57 illustrates using <FontDef ... /> to pre-define larger and smaller text formats.

1 <FontDef fontDef="larger" textSize="+20%" />2 <FontDef fontDef="smaller" textSize="-20%" />3 5 Text is bigger and bigger 6 Text is bigger and smaller 7 Text is bigger and smaller 8 Text is bigger and bigger 9 

Example 57 Using rdim

Text is bigger and biggerText is bigger and smaller

Text is bigger and smaller

Text is bigger and biggerFigure 52 Output from Example 57


<IndexDef ... >



<IndexDef ... >

SummaryThe <IndexDef ... > element specifies the inclusion criteria and the layout and sortingproperties of an index.

Properties

Property Value<IndexDef

Index format name

indexDef string

RequiredName of index format definition.

Index contents selection

names namelist

Bar or comma separated list of index format names to include in the index.

E.g. the following:names="generalIndex|authors"

includes index entries from <IX ... > elements that have name values 'gen-eralIndex' or 'authors'. See the <IX ... > element indexDef property onpage 64.

Default: index

Collation properties

Apart from the language property, the following collation properties are rarely needed.

language unicode | key

Value Description

unicode Use default unicode collation, without regard to lan-guage-specific collation rules.

key Use language-specific collation rules.The key values for the language property are listed inTable A 2.1 on pages 223–223.

Default: unicode

casePrecedence default | lower | upper

Override the language-specific case precedence rules. If casePrecedenceis set to 'upper' two strings which are identical except in respect of letter-case are listed in uppercase-first order, and vice versa if casePrecedence isset to 'lower'.

If casePrecedence is set to 'default' the default language-specific caseprecedence rules are used. (In most cases a lowercase entry is listed beforea corresponding uppercase entry.)

Default: default

<IndexDef ... >



Property Value

ignorePunctuation N | Y

Override the language-specific punctuation rules to ignore punctuationcharacters when sorting.

Default: N

ignoreSpace N | Y

Override the language-specific space rules to ignore space characters whensorting.

Default: N

numberOrdering Y | N

Sort a series of digits in order of their numerical value, from lowest tohighest. Applies to decimal digits (Nd) only, not to letter or other types ofdigits (see List of numbers, type Decimal Digit).

Default: Y

specialCollation phonebook | big5han | hindiDirect | gb2312han | pinyin| stroke | traditional

The specialCollation property is used to modify some language-specificcollations.

Value Description

phonebook Special phone book collation. Applicable only when lan-guage is set to 'German' or 'Finnish'.

big5han Pinyin ordering for Latin and Big5 charset ordering forChinese, Japanese, and Korean characters. Typically usedwith Traditional Chinese.

hindiDirect Hindi variant collation.

gb2312han Pinyin ordering for Latin and gb2312han charset order-ing for Chinese, Japanese, and Korean characters.

pinyin Ordering for Chinese, Japanese, and Korean charactersbased on character-by-character transliteration into Piny-in. Typically used with Simplified Chinese.

stroke Ordering for Chinese, Japanese, and Korean charactersbased on character-by-character transliteration into Piny-in. Typically used with simplified Chinese.

traditional Spanish variant collation.

Group titles

groupTitles Y | N

Include group title headings.

Default: Y

>

http://www.fileformat.info/info/unicode/category/Nd/list.htm

<IndexDef ... >



<IndexDef> sub-elements

The following elements may be included between <IndexDef> and</IndexDef>. fontProperties refers to element properties. See the element on pages 40–48).

<groupTitles paraDef="name" paragraphProperties>content</groupTitles>

Wrapper for <groupTitle ... > elements.

The paraDef property specifies the name of a paragraph format definedusing the <ParaDef ... > element (see pages 175–186).

The default value of paraDef is 'groupTitles'.

paragraphProperties refers to element properties. See the element on pages 91–100).

<groupTitle before="string">content</groupTitle>

Specify where to place index entry group titles. <groupTitle ... > sub-ele-ments must be contained within the <groupTitles ... > element. The be-fore property indicates the sort position which the group title should pre-cede. E.g.<groupTitles paraDef="myGroupTitlesPgfFormat" >

<groupTitle before="A" >A - I</groupTitle><groupTitle before="J" >J - Z</groupTitle>

</groupTitles>

Group title text is included only if the <IndexDef ... > or <Index ... > ele-ment groupTitles property is not set to 'N'.

<levelFormat paraDef="name" />

The paraDef property specifies the name of a paragraph format definedusing the <ParaDef ... > element (see pages 175–186). The first level-Format sub-element specifies the paragraph format to be used for thetop-level index entry (an index entry with no <IXsub ... /> sub-elements).

Successive <levelFormat ... > sub-elements specify the paragraph formatsto be used at lower levels.

<entrySuffix>content</entrySuffix>

content is suffix text to be used immediately following the index entry textif the index entry contains page number references. --indextextsuffix--

Default value for content: a single space character " "

<pageReferenceSeparator fontProperties>content</pageReferenceSeparator>

content appears between each page or page range reference.

Default value for content: ", " (comma, space)

<pageRangeSeparator entryType="normal | primary" fontProperties>content</pageRangeSeparator>

content appears between the start and end page number in a page rangereference.

<IndexDef ... >



<IndexDef> sub-elements (Continued )

The <pageRangeSeparator ... > sub-element entryType property en-ables different formatting for normal and primary entries, specified bythe <IX ... > entryType property (see page 64). The default value forentryType is 'normal'.

If there is more than one <pageRangeSeparator ... > sub-element with thesame entryType value only the first is applicable.

Default value for content: "–" (En dash)

<pageNumber entryType="normal | primary" fontProperties />

Expands to the referenced page number or to the first and last referencedpage numbers in a page number range.

The <pageNumber ... /> sub-element entryType property enables differ-ent formatting for normal and primary entries, specified by the <IX ... >and <IXsub ... /> entryType property (see page 64). The default valuefor entryType is 'normal'.

If there is more than one <pageNumber ... /> sub-element with the sameentryType value, the first is used.

By default the page number references have the same font properties asthe index entry text, as specified by the paragraph formats referenced bythe <IndexDef ... > <levelFormat ... > sub-elements see page 159). font-Properties override the may be used with the <pageNumber ... /> sub-ele-ment to override the default properties.

Default: normal

</IndexDef>

Examples

Simple index format definition

Example illustrates a simple index format definition.

1 <IndexDef indexDef="simpleIndex"2 names="Index" >3 <groupTitles paraDef="GroupTitlesIX">4 <GroupTitle before="\ ">Symbols</GroupTitle>5 <GroupTitle before="0">Numerics</GroupTitle>6 <GroupTitle before="A">A-M</GroupTitle>7 <GroupTitle before="N">N-Z</GroupTitle>8 </groupTitles>9 <levelFormat paraDef="Level1IX" />

10 <entrySuffix>, </entrySuffix>11 <pageReferenceSeparator>, </pageReferenceSeparator>12 <pageRangeSeparator>–</pageRangeSeparator>13 <pageNumber fontDef="_IndexPageNum"/>14 </IndexLevel>15 </IndexDef>

Example 58 Simple <IndexDef ... > format definition

<MathMLDef ... />



<MathMLDef ... />

SummaryThe <MathMLDef ... /> element defines formats for the location and decorative proper-ties for equations expressed in presentation Math ML. The <MathMLDef ... /> elementmay be referenced by the <MathML ... > mathMLDef element (see page 81).

Properties

Property Value<MathMLDef


mathMLDef name

name is the name of a <MathMLDef ... /> equation format definition.

Equation location


Position of equation relative to anchor or insertion point. The positionproperty is applicable only when the equation is within a element.

Value Description

inline Inline at the insertion point within paragraph text.


runin Run into paragraph. A maximum of one element withina element may have a position property set to'runin'. The equation should not be located immediatelybefore a page or column boundary.


If the <MathMLDef> element is at the top level, outside a element,the ‘below’, ‘inline’ and ‘runin’ values are not applicable.

If position is not set to ‘inline’ the lateral alignment of the equation is spe-cified using the align property (see below).

When position is set to ‘outsideTextFrame’ the lateral position of the equa-tion may be further adjusted using the sideOffset property (see below).

When position is set to ‘runin’ the top of the equation is aligned with thetop of the text (at caps height) in the first line of the paragraph. Whenposition is set to ‘outsideTextFrame’ the top of the equation is aligned withthe top of the text (at caps height) in the first line of the paragraph by de-fault. This position may be adjusted using the verticalOffset property (seebelow).

Default: inline


If positionOverride is set to ‘fromInput’ use the setting specified by theequation's <math> element display attribute,

<MathMLDef ... />



Property Value


Lateral alignment of the equation. The align property is ignored if positionis set to ‘inline’.


Value Description


center Center the equation between the left and right textframe borders.


Default: end

sideOffset dim

Offset of equation from the alignment position specified by the alignproperty.


Default: 0

verticalOffset dim

Vertical offset of equation.

Effective only if the position property is set to 'outsideTextFrame'. Valuemay be positive or negative. By default the top of the equation is alignedwith the top of the text (at caps height) in the first line of the containerparagraph.

Default: 0

Text runaround gapThe following runaround properties are effective only if the <MathML ... > element is includedwithin a element and the position property is set to ‘runin’.

runAroundGap dim

Specify the gap between the equation and text flowing around it. Thevalue of dim may be negative.

Default: 6pt

sideGap dim

Specify the side gap between the equation and text flowing around it. Thevalue of dim may be negative.


belowGap dim

Specify the gap below the equation and text flowing around it. The valueof dim may be negative.


<MathMLDef ... />



Property Value


The following properties apply only if the <MathML ... > element is included at the top level, i.e.outside a element or the position element is set to ‘below’.

spaceAbove dim

Space above equation.

In the case the <MathML ... > is at the top level, the actual spacing is de-termined by the larger of the space above the equation and the space be-low the preceding paragraph, not the sum of the two (see Note 1 on page184). If the <MathML ... > is within a element spaceAbove is thesole determinant of the vertical space between the equation and the pre-ceding text.

spaceBelow dim

Space below equation. Ignored unless the <MathML ... > element is in-cluded at the top level.

Actual spacing is determined by the larger of the space below the equation(or the equation title, if present) and the space above the following para-graph, not the sum of the two. See Note 1 on page 184.


startIndent dim

Position of equation relative to the start side of the container. Ignored un-less the align property is set to ‘start’.

endIndent dim

Position of equation relative to the end side of the container. Ignored un-less the align property is set to ‘end’.



fontFamily name


textSize dim

Text size.


textColor name

Text color.

<MathMLDef ... />



Property Value


Specify the fallback font to use for characters in the equation that are not contained in the cur-rently-applicable font.

The ‘currently applicable font’ is either the font used in the current text context, or the font spe-cified by the <MathML ... > or the <MathMLDef ... /> element fontFamily property.


Fallback font family. E.g. ‘Cambria Math’, ‘Quivira’.

Default: ‘Quivira’

Margins

Specify margins around the equation bounding box. Equation margin properties are inapplicablewhen position is is set to inline.

startMargin dim

Margin at the beginning of the equation.

Default: 0pt

topMargin dim

Margin above the equation.

Default: 0pt

endMargin dim

Margin at the end of the equation.

Default: 0pt

bottomMargin dim

Margin below the equation.

Default: 0pt

Border rulings

In the following name> must be the name of a ruling defined in a template file or by using the<RuleDef ... /> element, see page 188. Set name to "none" for no ruling.

startRule name

Start-side ruling.

Default: none

topRule name

Top-side ruling.

Default: none

endRule name

End-side ruling.

Default: none

<MathMLDef ... />



Property Value

bottomRule name

Bottom-side outside ruling.

Default: none


Background fill properties apply uniformly to both the equation bounding box area and to themargin areas. If the <math> markup includes mathbackground, e.g. on the <math> or <mstyle>elements, the maximum area of application for mathbackground is the equation bounding box,excluding the margin areas.

fillColor name


fillTint percent


fillOpacity 0 | 100


Include title

objectTitle N | Y

Include title/caption for equation. See the <ObjectTitle ... > element onpages 88–90.

>

<MathMLDef> sub-elements

The following elements may be included between <MathMLDef> and</MathMLDef>.

<ObjectTitle properties />

Define caption properties for the equation. See the <ObjectTitle ... > ele-ment on pages 88–90 for properties. Not applicable when positionis set to ‘inline’ (see page 161).

/>

Notes1 The text and other components in Math ML equations are rendered as vector out-

line contours that exactly correspond to the shapes of the specified characters andglyph shapes of the applicable fontFamily or fallbackFontFamily, not the charactersper se .

2 If the included or referenced Math ML equation contains a <math> element with adisplay attribute set to '‘inline’', then the <MathML ... > position property is overrid-den, i.e. the <MathML ... > position property is also set to ‘inline’.

<MathMLDef ... />



3 If the <math> element in the referenced Math ML markup includes the displayproperty it is ignored unless the positionproperty is set to ‘fromInput’. xxxxxxxxxx

4 In the general case any MathML namespace prefix may be used. An exception oc-curs when MiramoPDF is run in the context of the DITA Open ToolKit. In this caseequations must have either no namespace prefix or just one namespace prefix: 'm:',as in:

<m:math xmlns:m="http://www.w3.org/1998/Math/MathML">Math ML markup with namespace prefix

</m:math>

Examples

Non-inline equations

Example 59 illustrates using the <MathMLDef ... /> element to define an equationformat.

1 <MathMLDef2 mathMLDef="equationFormat1" position="below"

3 fillColor="Black" fillTint="4%"4 fontFamily="Arial" textSize="9pt"5 fallbackFontFamily="Cambria Math"

6 topRule="equationTopRule" topMargin="14pt"

7 startRule="equationStartRule" endRule="equationEndRule"8 bottomRule="equationBottomRule" bottomMargin="12pt"9 startMargin="22pt" endMargin="18pt"

10 spaceAbove="14pt" spaceBelow="32pt" align="start"

11 >12 <ObjectTitle paraDef="exEquation" />13 </MathMLDef>

Example 59 A <MathMLDef ... /> format definition

In Example 59 the position property is set to ‘below’ (see line 2). If the position propertyis set to ‘inline’ all space, ruling, margin and rule properties are silently ignored (see lines6-10).

Example 60 illustrates using the <MathMLDef ... /> format defined in Example 59.

1 An Equation in Math ML.2 <MathML3 mathMLDef="equationFormat1"4 file="${inline}/include/mathml/equation1b" >

5 <ObjectTitle>Caption text</ObjectTitle>

6 </MathML>7 Next paragraph

Example 60 A simple equation in <MathML ... >

<MathMLDef ... />



An Equation in Math ML.

exEqn 1: Caption text

Next paragraph

sM eM

spaceAbove

dY

topMargin

bottomMargin


The output from Example 59 is shown in Fig-ure 53. If a <MathML ... > instance containsan <ObjectTitle ... > sub-element (e.g. line5) and the position property is set to ‘inline’ awarning message is generated, the equation isrendered without a title.

In Figure 53 the spaceAbove, topMargin andbottomMargin annotations represent the val-ues of the corresponding <MathML ... > or<MathMLDef ... /> properties. The sM andeM annotations represent the values of thestartMargin and endMargin properties. The dYannotation represents the thickness of theruling in the <RuleDef ... /> element refer-enced by the <MathML ... > or <MathMLDef ... /> topRule property.

Note that the startMargin and endMargin properties extend from and to the mid-points ofthe side rulings, whereas the topMargin and bottomMargin properties extend from and tothe nearest edges of the top and bottom rulings.

Example 61 shows the Math ML markup contained in the file referenced in Example 61(see line 4).

1 <math mathbackground="#D7DBDD" display="inline" >2 <munderover>3 <mo>∫</mo><mi>a</mi><mi>b</mi>4 </munderover>5 <mfenced separators=''>6 <mn>5</mn><mi>ℝ</mi><mo>+</mo><mn>2</mn><mi>sin</mi>7 <mfenced separators=''><mi>x</mi></mfenced>8 </mfenced>9 <mi>dx</mi>

10 </math>

Example 61 Math ML in file referenced in Example 60

<MetaData ... >



<MetaData ... >

SummaryInclude one or more <MetaData ... > elements to specify a simple subset of XMPMetadata3 in the PDF output.

Typically, the <MetaData ... > element is used to create PDF properties such as ‘Title’, ‘Au-thor’, ‘Subject’ and ‘Keywords’ which are visible using a tool such as Adobe Acrobat, viathe document properties dialog.

Properties

Property Value<MetaData

name copyright | createdDate | creator | description | keyword |modifiedDate | publisher | rights | subject | title

Required. Every <MetaData ... > element must contain a name property.

name Description

copyright Maps to XMP ‘xmpRights:CopyRight’.In Adobe Acrobat PDF document viewers ‘copyright’corresponds to ‘Advanced:’ ‘XMP Rights Manage-ment’ metadata.Type: ‘rdfAlt’.

createdDate Maps to XMP ‘xmp:CreateDate’.In Adobe Acrobat PDF document viewers‘createdDate’ corresponds to ‘Created:’, ‘dc:date:’and ‘xmp:CreateDate:’ metadata. See Note 1 onpage 169.Type: ‘Date’.

creator Maps to XMP ‘dc:creator’.In Adobe Acrobat PDF document viewers ‘creator’corresponds to ‘Author:’ metadata.Type: ‘rdfSeq’.

description Maps to XMP ‘dc:description’. In Adobe AcrobatPDF document viewers ‘description’ corresponds toboth ‘Subject:’ and ‘Description:’ metadata.Type: ‘rdfAlt’.

keyword Same as ‘subject’ below. See Note 2 on page 169.

modifiedDate Maps to XMP ‘xmp:ModifyDate’.In Adobe Acrobat PDF document viewers‘modifyDate’ corresponds to ‘Modified:’ metadata.See Note 1 on page 169.Type: ‘Date’.

publisher Maps to XMP ‘dc:publisher’.In Adobe Acrobat PDF document viewers ‘publisher’corresponds to ‘Author:’ metadata.Type: ‘rdfBag’.

3 Detailed information relating to XMP Metadata is provided here.

https://www.adobe.com/devnet/xmp.html

<MetaData ... >



Property Valuerights Maps to XMP ‘dc:rights’.

Copyright text.In Adobe Acrobat PDF document viewers ‘rights’ cor-responds to ‘Copyright Notice:’ metadata.Type: ‘rdfAlt’.

subject Maps to XMP ‘dc:subject’.In Adobe Acrobat PDF document viewers ‘subject’corresponds to ‘Keywords:’ and ‘pdf:Keywords:’metadata.Type: ‘rdfBag’.

title Maps to XMP ‘dc:title’.In Adobe Acrobat PDF document viewers ‘title’ corres-ponds to ‘Title:’, ‘Document Title:’ mnd ‘dc:title’metadata.Type: ‘rdfAlt’.

</MetaData>

Notes1 When there are multiple occurences of a <MetaData ... > element with the same

name value, the behavior is determined by the Type of the XMP metadata: if 'Type'is a simple type (e.g. ‘Date’) later definitions override earlier definitions, otherwiserepeated occurences ad more items to the list.

2 The name values ‘subject’ and ‘keyword’ may be used interchangeably.

For example, the effect of

<MetaData name="subject" >dolphins</MetaData><MetaData name="keyword" >whales</MetaData>

is identical to

<MetaData name="keyword" >dolphins</MetaData><MetaData name="subject" >whales</MetaData>

3 When a name value is a date it must conform to the following date/time format.

YYYY-MM-DDThh:mmTZDYYYY-MM-DDThh:mm:ssTZDYYYY-MM-DDThh:mm:ss.sTZD

If a date-based metadata property is not specified via a <MetaData ... > elementvalue, the value defaults to the date/time that the document is processed.

If a date-based metadata property is specified with trailing data missing from thedate/time format, the missing parts of the format specification default to the follow-ing:

1000-01-01T00:00:00

For example:

<MetaData ... >



<MetaData name="modifiedDate" >2024-05</MetaData><MetaData name="modifiedDate" >2024-05-23</MetaData>

is equivalent to:

<MetaData name="modifiedDate" >2024-05-01T00:00:00</MetaData><MetaData name="modifiedDate" >2024-05-23T00:00:00</MetaData>

ExamplesExample 62 contains a set of <MetaData ... > elements which illustrate typical usage.

1 <MetaData name="title" >Latest news about Dolphins and Whales</MetaData>2 <MetaData name="title" xml:lang="fr" >Nouvelles sur les dauphins et les baleines</

MetaData>3 <MetaData name="creator" >Ozymandias</MetaData>4 <MetaData name="creator" >Shelley</MetaData>5 <MetaData name="subject" >Dolphins</MetaData>6 <MetaData name="subject" >Whales</MetaData>7 <MetaData name="subject" >Marine ecosystems</MetaData>8 <MetaData name="modifiedDate" >2022-08-08T00:22:23+01:00</MetaData>9 <MetaData name="modifiedDate" >2024-08-08T00:22:23+01:00</MetaData>

10 <MetaData name="createdDate" >2012-08-08T00:22:23+01:00</MetaData>11 <MetaData name="publisher" >Palace Enterprises Inc.</MetaData>12 <MetaData name="publisher" >Halo Enterprises Inc.</MetaData>13 <MetaData name="description" >A study of large sea creatures</MetaData>14 <MetaData name="description" xml:lang="fr">L'histoire de la mer</MetaData>15 <MetaData name="rights" >Society Brodnibadgians</MetaData>

Example 62 Typical <MetaData ... > usage

<PageDef ... >



<PageDef ... >

SummaryUse the <PageDef ... > element to define a named master page layout, specifying textcolumns and background text (e.g. running headers and footers) and graphic objects.

The special page names ‘Left’ and ‘Right’ may be used to define default page layouts usedwithin a document.

Properties

Property Value<PageDef

Create new master or reference page

pageDef name

Requiredname is the name of master page.

width dim

Page width. Overrides the value of the <DocDef ... /> width property (seepage 143).. If the value of the width property is less than the value ofthe height property (see below) the document is portrait; otherwise it islandscape. The minimum width allowed is 1 mm (ca. 0.04 inches).

height dim

Page height. Overrides the value of the <DocDef ... /> height property (seepage 143).. If the value of the height property is greater than the valueof the page property (see above) the document is portrait; otherwise it islandscape. The minimum height allowed is 1 mm (ca. 0.04 inches).

</PageDef>

Notes1 The <TextFrame ... > element is used to define text column layouts on body pages

which are formatted using this master page.

The <Frame ... > element specifies a fixed graphics frame or rectangle. The<Image ... > element enables external graphics to be imported onto the master page.

If a background image or tint on a master page will be behind or intersect a textframe containing a foreground text flow, then the <Frame ... > element should notbe used as a container for a tint, graphic or image. Instead the <Image ... > elementmay be used directly within the <PageDef ... > element, as illustrated in Example63.

<Image width="8.5in" height="11.5in" top="-.25in" left="-.25in"file="myBackgroundImage"/>

<PageDef ... >



or<Frame width="8.5in" height="11.5in" top="-.25in" left="-.25in"

penOpacity="0" fillColor="myBackgroundTint"/>

Example 63 Including a background image or tint with bleed

The <Frame ... > element is described on pages 49–50.

2 A single document may include pages with different sizes.

ExamplesExample 64 illustrates using the <PageDef ... > element to set up two-column and three-column master pages.

1 2 <DocDef pageWidth="8.5in" pageHeight="11in" />3 4 <PageDef pageDef="MP_twoColumns" >5 6 <TextFrame type="background"

7 left="1.4in" width="6in" height="0.5in" top="1in" >8 <Line top="0.4in" /> 9 Document title </TextFrame>

10 11 <TextFrame type="background"12 left="1.4in" width="6in" height="0.5in" top="10in" >13 > <currentPageNumber/> of <lastPageNumber/> </TextFrame>

14 15 <TextFrame type="foreground"16 left="1.4in" width="6in" height="7.5in" top="2in" columns="2" />17 </PageDef>18 19 <PageDef pageDef="MP_threeColumns" >20 repeat header and footer format definitions here (lines 6 to 13 above)21 22 <TextFrame type="foreground"23 left="1.4in" width="6in" height="7.5in" top="2in" columns="3" />24 </PageDef>

Example 64 Using the <PageDef ... > element (1)

Example 65 combined with Example 66 illustrates a different way of using the<PageDef ... > element to set up two-column and three-column master pages.

1 2 <TextFrameDef textFrameDef="BT_header" type="background"

3 left="1.2in" width="6in" height="0.5in" top="1in" penColor="Black" penStyle="dotted" >4 Document title5 <Line top="13pt" penWidth="3pt" /> 6 </TextFrameDef>

7 8 <TextFrameDef textFrameDef="BT_footer" type="background"

<PageDef ... >



9 left="1.2in" width="6in" height="0.5in" top="10in" penColor="Blue" penStyle="dotted" >10 > <currentPageNumber/> of <lastPageNumber/> 

11 </TextFrameDef>

12 13 <TextFrameDef textFrameDef="FT_mainflow" type="foreground" penColor="Red"

14 penStyle="dotted" left="1.2in" width="6in" height="7.5in" top="2in" columns="2" />

Example 65 Using the <PageDef ... > element (2a)

Example 65 defines two background text frames, ‘BT_header’ and ‘BT_footer’ (lines 2–6and 8–11), and a foreground text frame ‘FT_mainflow’ (lines 13–14).

Example 66 does the same thing as Example 64 except the <PageDef ... > elements usethe text frames pre-defined in Example 65.

1 <DocDef pageWidth="8.5in" pageHeight="11in" />2 <PageDef pageDef="MP_twoColumns" >3 <TextFrame textFrameDef="BT_header" /> <TextFrame textFrameDef="BT_footer" />4 <TextFrame textFrameDef="FT_mainflow" />5 </PageDef>6 <PageDef pageDef="MP_threeColumns" >7 <TextFrame textFrameDef="BT_header" /> <TextFrame textFrameDef="BT_footer" />8 <TextFrame textFrameDef="FT_mainflow" columns="3"/>

9 </PageDef>

Example 66 Using the <PageDef ... > element (2b)

<TextFrame ... > elements that reference <TextFrameDef ... > elements may contain over-rides, as illustrated by the use of the columns property on line 8 in Example 66.

Example 67 illustrates combining the <PageDef ... > and <TextFrameDef ... > formatdefinitions in Examples 65 and 66 with input data to produce an entire document.

1 <?xml version="1.0" encoding="UTF-8" standalone="yes" ?>2 <MiramoXML>3 4 5 6 7 <Section Page="MP_twoColumns" />8 Page 1 Column 19 Page 1 Column 2

10 <Section Page="MP_threeColumns" />11 Page 2 Column 112 Page 2 Column 213 Page 2 Column 314 </MiramoXML>

Example 67 Using the <PageDef ... > element (2c)

Assuming the contents of Example 67 is saved to a file called ‘pageDefTest.mmxml’, thenrunning the following command:

miramo -composer mmc -Opdf pageDefTest.pdf pageDefTest.mmxml

<PageDef ... >



produces a two-page output document. The first page is in two columns. The secondpage is in three columns.

<ParaDef ... >



<ParaDef ... >

SummaryUse <ParaDef ... > to create a new paragraph format, which may be referenced by the, <TblTitle ... > and <FNote ... > element paraDef properties to set the appearanceof paragraph text the document.

Properties

Property Value<ParaDef

Paragraph format name

paraDef name

Requiredname is paragraph format name.



fontFamily name


textSize dim

Text size.


fontAngle name



fontWeight name



textColor name

Text color.

textOpacity 100 | 0

Text opacity.

See the description of textOpacity in the element on page41.

Default: 100

<ParaDef ... >



Property Value

language key

Set the paragraph language to key. The key values for the language prop-erty are listed in Table A 2.1 on pages 223–223.




Text alignment and justification.

Value Description

start Align text at the beginning of lines. Ragged line ends.

end Align text at line ends. Ragged line starts.

center Align text lines at the center. Ragged line starts and ends.

justify Align text lines at start and end. Text justification at bothends.

firstLineIndent dim

First line indent.

Indent of the first line of paragraph text from the start side of a textcolumn or from the margin of a table cell.

startIndent dim

Start indent (excluding the first line of the paragraph).

Distance of the second and succeeding lines of text from the start side of atext column or from the start margin of a table cell.

endIndent dim

End indent.

Distance of lines of text from the end side of a text column or from theend margin of a table cell.


Set indent from edge of container or relative to the indent of the preced-ing paragraph.

Line spacing

spaceAbove dim

Space above paragraph.


deltaSpaceAbove dim

Maximum additional space above paragraph allowable when feathering isenabled for a document section.

<ParaDef ... >



Property ValueSee the description of the feather property for the <Section ... /> and<SectionDef ... /> elements (on pages 114 and 195).

Default: 0

spaceBelow dim

Space below.


leading dim

Leading. Default units are points.

Leading is the space between lines within a paragraph. Line spacing(baseline to baseline) is leading plus point size of the text.


Line spacing mode.

Setting lineSpacingMode to 'fixed' results in no adjustment for extralarge characters, superscripts, inline anchored frames, etc. When lineSpa-cingMode is set to 'proportional' the inter-line spacing is adjusted to pre-vent contact between text lines in cases where the text contains either lar-ger than normal characters or inline anchored frames.

Paragraph placement


Paragraph start position. The position property is effective only if the element is within the body text flow.

Value Description

normal Start paragraph immediately after preceding para-graph.

topOfColumn Start paragraph at the top of the next column.

topOfPage Start paragraph at the top of the next page.

topOfLeftPage Start paragraph at the top of the next left page.

topOfRightPage Start paragraph at the top of the next right page.

For single-sided documents (see the <DocDef ... /> doubleSided prop-erty on page 143) setting the position property to any of 'topOfPage','topOfLeftPage', or 'topOfRightPage', has the same effect, which is toforce the paragraph to start at the top of a page.

The position property has no effect if the paragraph will in any case startin the requested position. For example, if the position property is set to'topOfPage' on the first paragraph in a document then that paragraph willbe output at the beginning of the first page. No preceding blank first pagewill be produced. (To get such a blank page include two paragraphs withthe position property set to 'topOfPage', the first paragraph being empty.)

Default: 'normal'

minimumLines int

Minimum number of widow/orphan lines.

<ParaDef ... >



Property Value


Keep with next paragraph setting.

Value Description

none Do not force keeping this paragraph with any fol-lowing paragraph.

all Keep this paragraph with the following paraagraph.

namelist If this paragraph is followed by any paragraph innamelist, then keep this paragraph on the samepage as that paragraph.

withPrevious N | Y

Keep with previous paragraph.


listLabel Y | N

Enable/disable list label. If listLabel property is set to ‘N’ and the paragraphhas an associated <ListLabel ... > element the contents of the list label arenot displayed. In this case any counters that the list label may contain arenot incremented.

See the <ListLabel ... > element on page 71 for information on how toset up list labels for paragraphs.

Default: Y


If the element contains a <ListLabel ... > with a <counter ... /> ele-ment, replace the current value of the counter with the value of the num-berValue property when the numberValue property is set to int. See Ex-ample A3.2 on page 225.

Default: increment

Text capitalization




Default: normal




Default: fromFont

<ParaDef ... >



Property Value



Default: 80%

Font features

fontFeatures N | Y







Underline style.

Value Description

none | N No underline.

single | Y Normal underline.

numeric Numeric (low) underline.

double Double underline.












<ParaDef ... >



Property ValueUnderline gap between the centers of the underlines as an absolute valueor a percentage of the text size. Applicable only when underline is set to'double'.

underlineColor name

Underline color.


textOverline N | Y

Overline.


Default: 'N'

strikeThrough N | Y

Strike through.



For an alternative method of specifying paragraph background fills (and border rulings), see the<paraFrame ... /> sub-element on page 183.

fillColor name

Apply a background color to the paragraph text.

See the description of fillColor in the element on page 96.


fillTint percent


See the description of fillTint in the element on page 96.

Default: 100%

fillOpacity 100 | 0

See the description of fillOpacity in the element on page 96.


Default: 100%

paraFrame Y | N

Set the paraFrame property to ‘N’ to disable the background fill and bor-ders specified by a <paraFrame ... /> sub-element, if any.

Default: Y

Line breaking

hyphenate Y | N


<ParaDef ... >



Property Value

maximumHyphens int






minimumWordSize int












textKern Y | N



ligatures N | Y

Enable ligatures.

textSpread percent




Default: '0'

letterSpacing N | Y




<ParaDef ... >



Property ValueInter-word spacing in justified text may sometimes have to exceed themaximum specified by the maximumWordSpace property (see below). Insuch cases, setting the letterSpacing property to 'Y' will allow additionalspace to be added between letters within words to reduce excessive spa-cing between words.









See also: <ListLabel ... > element showInPDFbookmark on page 73.


PDF bookmark level applied to the paragraph format during conversion toPDF. If the bookmark level is zero, the paragraph is not included as an PDFbookmark in the resulting PDF file.


Vertically shift the location of the book mark target. Negative values movethe target upwards. Positive values move the target downwards (i.e. in theinitial page display the target will be located above the top of the page dis-play.)

By default the bookmark target is located some distance above the refer-enced paragraph text. The distance above corresponds to the value of theparagraph spaceAbove property.

Default: 0

Reference frames above and belowSee in the description of the <TextFrameDef ... > element, Using <TextFrameDef ... > to defineabove and below frames on pages 210–211.


Top or above separator frame. name refers to the value of a <Text-FrameDef ... > element textFrameDef property.

Default: none


Bottom or below separator frame. name refers to the value of a <Text-FrameDef ... > element textFrameDef property.

See frameAbove property above.

<ParaDef ... >



Property Value>

<ParaDef> sub-element

The following element may be included between <ParaDef> and </ParaDef>.

<paraFrame[ fillColor = "name" ] [ fillTint = "percent" ][ fillOpacity = "percent" ] [ topMargin = "dim" ][ endMargin = "dim" ] [ bottomMargin = "dim" ][ startRule = "name" ] [ topRule = "name" ][ endRule = "name" ] [ bottomRule = "name" ]/>

The <paraFrame ... /> sub-element specifies a background fill in andaround a paragraph, and/or rulings around a paragraph. A paragraphcontaining a <paraFrame ... /> sub-element cannot be split acrosscolumns or pages.

fillColor, fillTint, fillOpacitySpecify the background fill color, tint and opacity for the para-graph. Default is transparent.

topMargin, bottomMarginMargin area above and below paragraph text to include in thebackground fill area and/or for adjusting the positions of the topand bottom rules. The values of the top and bottom margins addto the vertical positioning of the current paragraph text, and thevertical positioning of the following paragraphs. Default value is‘0’.

startMargin, endMarginMargin area at the start and end paragraph text to include inthe background fill area and/or for adjusting the positions ofthe start and end rules. The start and end margins extend out-wards from the paragraph text, without affecting the position-ing of the text. In other words, the position of the paragraph textfirstLineIndent, startIndent and endIndent relative to its startand end container borders is not changed by by the values ofstartMargin and endIndent. The start margin anchor point is thelesser of firstLineIndent or startIndent. Default value is ‘0’.

topRule, bottomRuleSpecify the names of rulings defined by the <RuleDef ... /> ele-ment (see page 188) to apply horizontally above and below thetop and bottom margins. The widths of the top and bottom rulesadd to the vertical positioning of the current paragraph text. De-fault value is ‘none’.

startRule, endRuleSpecify the names of rulings defined by the <RuleDef ... /> ele-ment (see page 188) to apply vertically outside the start andend of the start and end margins. Default value is ‘none’.

In the case a paragaph contains a <paraFrame ... /> sub-element the element spaceAbove and spaceBelow property values specify offset dis-tances from the tops and bottoms of top and bottom margins plus thecorresponding ruling thicknesses.

<ParaDef ... >



<ParaDef> sub-element (Continued )

See pages 185–186 for further details on the operation of the <para-Frame ... /> sub-element.

</ParaDef>

Notes1 Inter-paragraph spacing is observed as the distance between the bottom edge of

the text descenders of the upper paragraph and the top edge of the text (e.g. thetop of the capital letters) of the lower paragraph.4 This space is determined by themaximum of the upper paragraph's space below, spaceBelow, value and the lowerparagraph's space above, spaceAbove, value.

A. ÉytayeB. ÅpljbreadAyl

textSize="28pt"

Paragraph A leading: 10pt

textSize="28pt"

max(spaceBelow A (12pt), spaceAbove B (15pt)) = 15pt

space

Paragrap

h A

textSize="16pt"

Paragraph B leading: 8pt

textSize="16pt"

Paragraph B leading: 8pt

textSize="16pt"

textSize="16pt"

Paragrap

h B

Figure 54 Inter-paragraph spacing

Negative values for paragraph spacebelow and space above settings maybe used to bring particular paragraphscloser together than normal, or evento make them overlap.

In mmComposer the only precisemetric for inter-paragraph spacing isthe offset between the baselines of thelast line of the upper paragraph andthe first line of the next paragraph.This baseline offset is actually great-er than the sum of values mentionedabove, by an amount equal to onethird the pointsize of the upper para-graph plus two thirds the pointsize ofthe lower paragraph.

The relationship between the element spaceBelow, spaceAbove and leading

properties is illustrated in Figure 54. The paragraph settings and input text used inFigure 54 is shown in Example 68.

1 2 A. Éy taye4 5 B. Åplj bread Ayl

Example 68 Paragraph input for Figure 54

4 This perception is applicable primarily in the case of Latin script, which does not have a high frequency ofsingle or stacking diacritcs. Even then, this perception would probably not persist if the Latin text is set is astylistic font with swashes.

<ParaDef ... >



In the case a <ParaDef ... > or element has either or both a frameAbove andframeBelow property set to the name of a text frame, the paragraph spacing metricsare as illustrated in Figure 60, on page 211.

Examples

Operation of the <paraFrame ... /> sub-element

The <paraFrame ... /> sub-element enables background color fills and border rulings tobe applied to paragraph text. Paragraphs containing the <paraFrame ... /> sub-elementcannot be split across pages or columns, and so are normally heading or other shortparagraphs. Border rulings are specified by reference to rulings define by the <RuleDef .../> element (see pages 188–188).

Example 69 contains a set of ruling format definitions used in illustrating the operationof the <paraFrame ... /> sub-element.

1 <RuleDef ruleDef="Gold" penWidth="6pt" penColor="xGold" />2 <RuleDef ruleDef="DenseBlue" penWidth="6pt" penColor="xDenseBlue" />3 <RuleDef ruleDef="Khaki" penWidth="4pt" penColor="xKhaki" />4 <RuleDef ruleDef="Ruby" penWidth="4pt" penColor="xRuby" />

Example 69 <RuleDef ... />s used in Figures 55 and 56

④

③

②

①

④

③

②

①Auriga

Cassiopeia

Cygnus

Hydra

Auriga

Cassiopeia

Cygnus

HydraContainer A Container B

max(pgfSpaceAbove, pgfSpaceBelow)

④

③

②

①

Figure 55 Lateral <paraFrame ... /> extents

Figure 55 illustrates the operation of the<paraFrame ... /> sub-element when lat-eral margins and rulings are specified, i.e.when any or all of the startRule, startMargin,endMargin or endRule properties are spe-cified. These settings have no effect on thepositioning of the paragraph body text.This can be seen by comparing the textpositioning in ‘Container A’ and ‘Contain-er B’ in Figure 55: the background fills andlateral margins and rulings applied within‘Container B’ do not affect the text positioning.

By default, assuming the value of either firstLineIndent or startIndent is ‘0’ and the valueof firstLineIndent is ‘0’, the fill area extends from the start to the end of the paragraphcontainer. When fillColor is the only setting, the paragraph fill is aligned with the top ofthe first line of text and the bottom of the last line of text, as illustrated in case ① in Fig-ure 55.

Equation E.2 shows the relationship between the start edge of the text container and thestart of the paragraph fill and ruling area.

E.2 start = min(firstLineIndent, startIndent, labelIndent) - (startMargin + ruling width)

<ParaDef ... >



In Equation E.2 ‘start’ is the offset of the outer starting edge of the fill area plus the rul-ing width from the start side of the paragraph container. ‘ruling width’ is the width of theruling specified by the startRule property, if any.

Equation E.3 shows the relationship between the start edge of the text container and thestart of the paragraph fill and ruling area.

E.3 end = endIndent - (endMargin + ruling width)

In Equation E.3 ‘end ’ is the offset of the outer end edge of the fill area plus the rulingwidth from the end side of the paragraph container. ‘ruling width’ is the width of the rul-ing specified by the endRule property, if any.

The <paraFrame ... /> fillColor used in Figures 55 and 56 is as shown here: .

⑧topMargin

bottomMargin

⑦topMargin

bottomMargin

⑥topMargin

bottomMargin

⑤topMargin

Auriga

Cassiopeia

Cygnus

Hydra

max(pgfSpaceAbove, pgfSpaceBelow)

⑧topMargin

bottomMargin

⑦topMargin

bottomMargin

⑥topMargin

bottomMargin

⑤topMargin

Figure 56 Additative vertical paragraphadjustment when <paraFrame ... /> is

used

Figure 56 illustrates the operation of the<paraFrame ... /> sub-element in the case anyor all of the topRule, topMargin, bottomMargin

or bottomRule properties are specified. Thesesettings, unlike the corresponding lateral set-tings which do not affect the lateral lateral po-sitioning of the paragraph text, increase thevertical spacing between the applicable para-graphs.

<ParaGroupDef ... />



<ParaGroupDef ... />

SummaryThe <ParaGroupDef ... /> element specifies a format definition for use by the<ParaGroup ... > element (see pages 101–102).

Properties

Property Value<ParaGroupDef

Defined list format

paraGroupDef name

Requiredname is optional list format name.


spaceAbove dim

Override for the first paragraph's spaceAbove value.

spaceBelow dim

Override for the last paragraph's spaceBelow value.

/>

Notes1 See Note 1 on page 184.

ExamplesSee Example 41 on page 102.

<RuleDef ... />



<RuleDef ... />

SummaryUse <RuleDef ... /> to define a ruling for use in tables. A ruling may be referenced via:<TblDef ... >, <Tbl ... >, <Row ... >, or <Cell ... > elements.

Properties

Property Value<RuleDef

Table ruling names and properties

ruleDef name

Requiredname is ruling format name.

penWidth dim

Pen width. Default units are points.

Default: 0.5pt

penColor name

Ruling colour.

Default: Black

penTint percent

Ruling tint.

Default: 100%

/>

<RunningTextDef ... >




SummaryUse the <RunningTextDef ... > element to create a running text format definition whichmay be referenced by the <RunningText ... > element.

Properties

Property Value<RunningTextDef


runningTextDef name

Identifier for the background ‘running text’ format definition.

>

<RunningTextDef> sub-elements

The following elements may be included between <RunningTextDef> and</RunningTextDef>.

deftext



 




The element may be used within <RunningTextDef ... >.

<paragraphText names="namelist" select="first | last"keepFormatting = "N | Y" />

Expands to the paragraph text (excluding label text and autonumber text)of the first paragraph on the current page which has one of the para-graph formats listed by the names property.


If there is no paragraph on the current page with a format name listedby the names property, then the paragraphText of the nearest preced-ing paragraph that has one of the paragraph formats listed by the namesproperty is used.




<RunningTextDef> sub-elements (Continued )

If the select property is set to 'last', then the <paragraphText ... /> sub-element expands to the paragraphText the last paragraph on the pagethat has one of the paragraph formats listed by the names property, or,if there is no such paragraph, to the paragraphText of the nearest follow-ing paragraph that has one of the paragraph formats listed by the namesproperty.

If the <paragraphText ... /> names property contains more than onename value, then these values are treated as ORs.




<paragraphLabel names="namelist" select="first | last" />

Expands to the label text (including autonumber text, if any) of the firstparagraph on the current page which has one of the paragraph formatslisted by the names property.


If there is no paragraph on the current page with a format name listedby the names property, then the text of the nearest preceding paragraphthat has one of the paragraph formats listed by the names property isused.

If the select property is set to 'last', then the <paragraphLabel ... /> sub-element expands to the text the last paragraph on the page that has oneof the paragraph formats listed by the names property, or, if there is nosuch paragraph, to the text of the nearest following paragraph that hasone of the paragraph formats listed by the names property.

If the <paragraphLabel ... /> names property contains more than onename value, then these values are treated as ORs.


<paragraphNumber names="namelist" select="first | last" />

Expands to the autonumber text only (i.e. excluding the paragraph bodytext and label text that is not between the first and last <counter/> ele-ments) of the first paragraph on the current page which has one of theparagraph formats listed by the names property.


If there is no paragraph on the current page with a format name listedby the names property, then the autonumber text of the nearest preced-ing paragraph that has one of the paragraph formats listed by the namesproperty is used.




<RunningTextDef> sub-elements (Continued )

If the select property is set to 'last', then the <paragraphNumber ... />sub-element expands to the autonumber text the last paragraph on thepage that has one of the paragraph formats listed by the names property,or, if there is no such paragraph, to the autonumber text of the nearestfollowing paragraph that has one of the paragraph formats listed by thenames property.

If the <paragraphNumber ... /> names property contains more than onename value, then these values are treated as ORs.


<marker names="namelist" select="first | last" />

Expands to the text included within the first instance of a corresponding(name="string" ) <RunningTextMarker> element on the current page.

If there is no instance of a corresponding <RunningTextMarker> elementon the current page, then the text from the nearest preceding or thenearest following, depending on the setting of the select property, <Run-ningTextMarker> element is used.

The <RunningTextMarker ... > element is described on page 111.

</RunningTextDef>

Examples

Pararagraph-based running text

Example 42 shows how to define a background text frame that picks up paragraph text,specifically the selected paragraph's label text, from the body text flow.


3 <Line top="4.5mm" /> 4 <RunningTextDef> <paragraphLabel

textColor="DarkBlue"

5 names="P_chapterTitle|P_chapterTitle.ExA|P_appendixTitle" />

6 </RunningTextDef>7 8 </TextFrame>


Example 42 shows how a background text frame may be positioned within a containing<PageDef ... > element (line 2) and how to include a <RunningTextDef ... > element forpicking up a paragraph text component from the body text flow, in this case the para-graph label text via the <paragraphLabel/> element (line 4). The names property (line 5)contains the set of paragraphs that may be included. It is always the contents of the first(or last) paragraph format in the names set that is encountered that is included. The or-der of the paragraphs in the names property is insignificant.




To include the paragraph text itself as running text in a background text frame add in the<paratext/> element, as illustrated in Example 43.

1 <RunningTextDef>2 <paragraphText names="P_chapterTitle|P_chapterTitle.ExA|P_appendixTitle" />

3 </RunningTextDef>

Example 71 Including paragraph text in running header

To include the paragraph label and the paragraph text, line 2 in Example 43 may be ad-ded to Example 42 after line 5.

Marker-based running text

Example 44 shows how to define a background text frame that picks up hidden markertext, included using the <RunningTextMarker> element (see pages 111–111), fromthe body text flow.


3 <RunningTextDef>4 <marker names="elementNameMarker" />

5 </RunningTextDef>6 7 </TextFrame>


The value of the <marker ... /> sub-element names property, ‘elementNameMarker’, inExample 44 (line 4) is arbitrary. It is the means of identifying which <RunningTextMark-er> element's contents should be included in the background text frame, i.e. the contentsof the first or preceding (or last or next nearest later) <RunningTextMarker> element thathas a name value of 'elementNameMarker'.

<SectionDef ... />



<SectionDef ... />

SummaryUse the <SectionDef ... /> element to define a set of master page usage rules.

Unless otherwise specified by settings in the <DocDef ... /> element (see pages193–197) all pages in single-sided documents have the layout of the ‘Right’ masterpage. Similarly double-sided documents use alternating ‘Right’ and ‘Left’ master pages,starting with the ‘Right’ page layout for the first page of the document.

Properties

Property Value<SectionDef

Section format name

sectionDef name

RequiredName of section format definition.



Default: Inherited from <DocDef ... /> (see ‘pageCount’ on page 143)

hyphenate Y | N


maximumHyphens int






minimumWordSize int


language key



<SectionDef ... />



Property Value


Specify new default rules for applying master pages to the destination page and to subsequentmatching pages. See Note 1 on page 196 for the definition of ‘destination page’.The rules for resolving conflicts when more than one property from the following set of Defaultmaster page usage properties is used are described in Note 2 on page 196.

oddPages name


Default: Inherited from <DocDef ... /> (see ‘oddPages’ on page 144)

evenPages name


Default: Inherited from <DocDef ... /> (see ‘evenPages’ on page 145)

allPages name


Default: Inherited from <DocDef ... /> (see ‘allPages’ on page 145)



lastPage name




emptyPage name


Default: Inherited from <DocDef ... /> (see ‘emptyPage’ on page 145)

emptyEvenPage name


Default: Inherited from <DocDef ... /> (see ‘emptyEvenPage’ on page145)

<SectionDef ... />



Property Value

emptyOddPage name


Default: Inherited from <DocDef ... /> (see ‘emptyOddPage’ on page145)


Specify a rule for applying a single exception master page to a destination page. See Note 1 onpage 196 for the definition of ‘destination page’. The rules for resolving conflicts when more than one property from the following Exceptionmaster page usage property is used are described in Note 2 on page 196.

Page name

Apply exception master page name to destination page regardless ofwhether the page is odd or even.

Page numbering




Value Description



Default: increment

pageNumberStyle key




Paragraph numbering



feather N | Y

Enable inter-paragraph feathering in this section. Feathering is only appliedto paragraphs which have the deltaSpaceAbove property set to a valuegreater than ‘0’.

See the and <ParaDef ... > deltaSpaceAbove properties on pages92 and 176.

Default: N

/>

<SectionDef ... />



Notes1 The destination page, or pages, is the page or set of pages initiated by the

<SectionDef ... /> element and terminated when either another <SectionDef ... />element or the end of document is encountered.

2 A destination page, or a set of destination pages, may satisfy several conditions sim-ultaneously. For example, the target page specified by the Page page property maybe an odd page targetted by the oddPage property.

Such conflicts are resolved as follows:

– In multi-page documents the values for last-page properties listed under Last-page master page usage properties override all other properties.

– The value for Page has the highest priority.

3 Odd pages refer to odd numbered pages (i.e. 1,3,5,7...). Even numbered pages referto even numbered pages (i.e. 2,4,6,8...). In both cases pages are numbered sequen-tially starting at 1 for the first page in the document, regardless of the in-documentnumbering scheme.

For single-sided documents, all pages are considered to be odd pages and will usethe ‘Right’ master page layout by default.

In the case of single-sided documents, specified by setting the <DocDef ... />doubleSided property to ‘N’ (see page 143), the <SectionDef ... /> evenPages andemptyEvenPage properties are ignored.

4 For single-sided documents all pages are considered to be recto pages so the defaultis always to apply the ‘Right’ master page layout.

The <SectionDef ... /> element may be used to change this default behavior at anypoint.

5 A document beginning, for example,

<SectionDef Page="First"/>The Book Title

will have its first page, containing the paragraph text ‘The Book Title’, formatted as‘First’, assuming that a master page called ‘First’ has been defined either in a tem-plate file or by using the <PageDef ... > element.

Examples

Document sections

Example 73 illustrates how the <SectionDef ... /> element may be used to create differentsections that have special filler pages and distinct page numbering sequences and styles.The special filler pages are included only when required to ensure an even page countfor a section when the <SectionDef ... /> pageCount property is set to ‘even’ (see lines andin Example 73).

<SectionDef ... />



1 2 <Section Page="Cover" emptyPage="Blank1" pageCount="even" />

3 A Short History of the World45 6 <Section oddPages="ContentsRight" evenPages="ContentsLeft" emptyPage="Blank2"

7 pageCount="even" pageNumberStart="1" pageNumberStyle="lowercaseRoman" />

8 <Contents position="topOfRightPage" >9 <ContentsInclude names="Heading1Auto" paraDef="contentsLevel1" >

10 <paragraphLabel/> <paragraphText/> <leader>.</leader> <pageNumber/>11 </ContentsInclude>12 <ContentsInclude names="Heading2Auto" paraDef="contentsLevel2" >13 <paragraphLabel/> <paragraphText/> <leader>.</leader> <pageNumber/>14 </ContentsInclude>15 </Contents>1617 18 <Section oddPages="Right" evenPages="Left" pageNumberStart="1"19 pageNumberStyle="westernArabic" />20 The Beginning21 Uncertainty22 Doubt23 ...

Example 73 MasterRageRule usage

The output from Example 73 is shown in schematic form in Figure 57.

[ Mas

ter p

age:

Cov

er ]

A ShortHistory

ofthe

World

[ Mas

ter p

age:

Bla

nk1

] BLANK 1

[ Mas

ter p

age:

Con

tent

sRig

ht ]

History of the WorldCONTENTS Page

Page i

1 The Beginning............. 11.1 Uncertainty....................... 11.2 Doubt................................1

2 Next steps.................... 22.1 Magma............................. 22.2 Lava formation................. 22.3 Continents........................ 22.4 Oceans.............................32.5 Continental drift................ 42.6 Scrub................................5

[ Mas

ter p

age:

Bla

nk2

] BLANK 2

[ Mas

ter p

age:

Rig

ht ]

History of the World

Page 1

1 The Beginning

1.1 Uncertainty

1.2 Doubt

[ Mas

ter p

age:

Lef

t ]

History of the World

Page 2

2 Next steps

2.1 Magma

2.2 Lava formation

2.3 Continents

Figure 57 Schematic output from Example 73

Example 73 assumes the following pre-defined paragraph formats: ‘bookTitle’,‘Heading1Auto’, ‘Heading2Auto’, ‘contentsLevel1’ and ‘contentsLevel2’; and the follow-ing pre-defined master pages: ‘Cover’, ‘Blank1’, ‘ContentsRight’, ‘ContentsLeft’, ‘Blank2’,‘Right’ and ‘Left’. It also assumes that the <DocDef ... /> doubleSided property is set to ‘Y’.

In Example 73 the referenced filler pages, ‘Blank1’ and ‘Blank2’ specified using theemptyPage property (lines and ), may refer to any master page layout and may be com-pletely empty or show running headers and/or footers and special text like ‘This page in-tentionally blank’, as desired. If the table of contents listing in the ‘TOC’ section extendsto an even number of pages, the ‘Blank2’ page is not included.

If the <DocDef ... /> doubleSided property is set to ‘N’, the output from Example 73 relat-ing to the first two scections is unchanged, i.e. the output for the first four pages is thesame as shown in Figure . In this case the pages in the body section are always ‘Right’pages, instead of alternating between ‘Right’ and ‘Left’

<TblDef ... >



<TblDef ... >

SummaryUse <TblDef ... > to define a named table format which may be referred to later usinga <Tbl ... > (table instance) element tblDef property to determine the appearance of thetable.

Properties

Property Value<TblDef

Table format name

tblDef name

Requiredname is table format name.

Basic properties

startIndent dim

Start indent. Or right indent in the case of right-to-left text.

Ignored if the align property is set to 'end' (see below).

endIndent dim

End indent. Or left indent in the case of right-to-left text.

Ignored if the align property is set to 'start' (see below).

spaceAbove dim

Space above.

spaceBelow dim

Space below.


Horizontal alignment of table within text column.

Value Description

start Align table with start of text direction.

center Center table

end Align table with end of text direction.


Table placement.

Value Description

normal Start table at the current position.

topOfColumn Start table at top of next column

topOfPage Start table at top of next page

<TblDef ... >



Property ValuetopOfLeftPage Start table at top of next left page

topOfRightPage Start table at top of next right page

minimumRows int

Minimum number of widow/orphan rows.

allMargins dim




startMargin dim


topMargin dim


endMargin dim


bottomMargin dim



fillColor color


fillOpacity 0 | 100

Fill opacity.

Default: 0

fillTint percent

Fill tint.

Default: 100%



Background color for header rows. headerRowFillOpacity must be set to'100' for the specified color to display.


Fill opacity for header rows.


Background tint for header rows.


Background color for body rows. bodyRowFillOpacity must be set to'100' for the specified color to display.

<TblDef ... >



Property Value


Fill opacity for body rows.


Background tint for body rows.


Background color for footer rows. footerRowFillOpacity must be set to'100' for the specified color to display.


Fill opacity for footer rows.


Background tint for footer rows.


(In the following shortYear must be the name of a ruling defined in a template file or by usingthe <RuleDef ... /> element, see page 188. Set name to "none" for no ruling.)

startRule name

Start outside ruling.

topRule name

Top outside ruling.

endRule name

End outside ruling.

bottomRule name

Bottom outside ruling.


(In the following shortYear must be the name of a Ruling defined in a template file or by usingthe <RuleDef ... /> element, see page 188. Set name to "none" for no ruling.)

bodyRowRule name

Ruling used between rows in the table body.


name is the name of the ruling to use between the last heading row andthe first body row.


name is the name of the ruling to use between the last body row and thefirst footer row.

<TblDef ... >



Property Value

Column rulings

(In the following shortYear must be the name of a Ruling defined in a template file or by usingthe <RuleDef ... /> element, see page 188. Set name to "none" for no ruling.)

columnRule name

name is the name of the ruling to use between columns.

Footnote properties

When <FNote ... > elements (see pages 38–39) are contained within a table the outputfootnotes may be located either at the end of the table or repeated after the table footer onevery page. Footnote numbering within tables is always restarted from 1.


Locate all table footnotes either at the end of the table or repeated at thebottom of every page of the table.

Value Description

atEnd Locate all footnotes within the table at the end of thetable.

atFoot Locate all footnotes within the table at foot of the table.

Default: atEnd

fNoteDef name

Name of the <FNoteDef ... /> format definition to use for this table format.See pages 147–150).

Default: tableFootnote

</TblDef>

<TblColumnDef ... >



<TblColumnDef ... >

SummaryUse one or more <TblColumnDef ... > elements immediately after a <TblDef ... > elementto set fixed or proportional table column widths. <TblColumnFormat ... /> sub-elementsmay be included within <TblColumnDef ... > elements to specify the default paragraphformats for the table column header, body and footer rows.

Properties

Property Value<TblColumnDef


width dim | p*

Column width, either fixed ( width="dim", eg width="2cm") or propor-tional ( width="p*", eg width="2.5*").

p may be any positive number.

In the case of a proportional table column width, the actual width is cal-culated automatically from the overall width of the table, taking the othercolumn widths into account, and using the number (p) before the ‘*’ char-acter as a proportional weighting to apply to this column width.

See Note 1 on page 203.

columns int

Apply this column width to the following int columns, counting from onefor this column.

Default: 1

minimumWidth dim

For proportional column widths only ( width="p*"), set the minimum al-lowed column width. See Note 5 on page 122.

Default: 5mm

>

<TblColumnDef> sub-elements

The following elements may be included between <TblColumnDef> and</TblColumnDef>.The <TblColumnDef ... > sub-element may be used to specify the default para-graph format to be used in header, body and footer rows in this table column.

<TblColumnFormat paraDef="name"[ rowType = "header | body | footer" ] />

Up to three <TblColumnFormat ... /> sub-elements may be included with-in a <TblColumnDef ... > element, one each for header, body or footerrows.

<TblColumnDef ... >



<TblColumnDef> sub-elements (Continued )

name is the default paragraph format to use for this table column. By de-fault, if no rowType property is specified, the paragraph format is used forall header, body and footer rows.USPTO

</TblColumnDef>

Notes1 Notes 2 through 6, for the <TblColumn ... /> element (see pages 121–122), de-

scribing the calculation basis for proportional table column widths, apply also inthe case of <TblColumnDef ... > proportional width values.

Examples

Tables with fixed-width columns

The following examples illustrate fixed-width columns.

Example 74 illustrates a table format definition that uses <TblColumnFormat ... /> ele-ments within <TblColumnDef ... > elements.

1 <TblDef tblDef="myTable" headerSeparatorRule="Thick" >2 <TblColumnDef width="1cm" > 3 <TblColumnFormat paraDef="P_Output" rowType="header" />4 <TblColumnFormat paraDef="Body" rowType="body" />5 </TblColumnDef>6 <TblColumnDef width="2cm" > 7 <TblColumnFormat paraDef="P_Output" rowType="header" />8 <TblColumnFormat paraDef="P_Red" rowType="body" />9 </TblColumnDef>

10 <TblColumnDef width="1cm" > 11 <TblColumnFormat paraDef="P_Output" rowType="body" />12 </TblColumnDef>13 </TblDef>

Example 74 Using <TblColumnDef ... > in a <TblDef ... >

Example 75 shows a table instance that uses the ‘myTable’ <TblDef ... > format definitionshown in Example 74.

1 <Tbl tblDef="myTable" >2 <Row type="header" >3 <Cell> Code </Cell> <Cell> Description </Cell>4 <Cell> $/lb </Cell> </Row>5 <Row>6 <Cell> A </Cell> <Cell> Planets </Cell>7 <Cell> $2.43 </Cell> </Row>8 <Row>9 <Cell> B </Cell> <Cell> Stars </Cell>

<TblColumnDef ... >



10 <Cell> $3.10 </Cell> </Row>11 </Tbl> 

Example 75 The effect of <TblColumnDef ... > in a <Tbl ... > instance

Code Description $/lbA Planets $2.43

B Stars $3.10

Figure 58 Output from Examples 74and 75

The output from Examples 74 and 75 is shown inFigure 58.

Tables with proportional-width columns

The following examples illustrate proportional-width columns.

Example 76 illustrates a table format definition,named myTable2, that uses <TblColumnFormat ... /> elements within <TblColumnDef ...> elements that have proportional column width values..

1 <TblDef tblDef="myTable2" headerSeparatorRule="Thick"2 startIndent="6mm" endIndent="5.5mm" >3 <TblColumnDef width="9.5mm" > 4 <TblColumnFormat paraDef="P_Output" rowType="header" />5 <TblColumnFormat paraDef="Body" rowType="body" />6 </TblColumnDef>7 <TblColumnDef width="2*" > 8 <TblColumnFormat paraDef="P_Output" rowType="header" />9 <TblColumnFormat paraDef="P_Red" rowType="body" />

10 </TblColumnDef>11 <TblColumnDef width="1*" > 12 <TblColumnFormat paraDef="P_Output" rowType="body" />13 </TblColumnDef>14 </TblDef>

Example 76 Using <TblColumnDef ... > in a <TblDef ... >

container width

cw1 cw2 cw3tblSI tblEI

Code Description $/lbA Planets $2.43

B Stars $3.10

Figure 59 Output from Examples 76 and 75

Figure 59 shows the output tablewhen the input shown in Example74 is modified to reference themyTable2 (Example 76) in place ofthe myTable table format definition.The output from Examples 76 and75 is shown in Figure 59.

<TblContinuationDef>




SummaryUse <TblContinuationDef> to define a table continuation format. The <TblContinu-ationDef> determines how instances of the <TblContinuation ... /> element (see page123) are expanded when included in a table title or header/footer row.

Multiple table continuation formats may be defined for different styles or for differentlanguages.

Properties

Property Value<TblContinuationDef

tblContinuationDef name

name is the identifier of a table continuation format definition.

Default: default

>

<TblContinuationDef> sub-elements

The following elements may be included between <TblContinuationDef> and</TblContinuationDef>.

deftext



 




One or more elements may be included within the<TblContinuationDef> element. See the element on pages40–48.

</TblContinuationDef>

ExamplesExample 77 illustrates using the <TblContinuationDef> element to define a multi-styleand multilingual catalog of ‘table continued’ styles.

1 <TblContinuationDef tblContinuationDef="TC_style1" >(Continued from previous page)</TblContinuationDef>3




4 <TblContinuationDef tblContinuationDef="TC_english"5 >(Continued&hairsp;)</TblContinuationDef>67 <TblContinuationDef tblContinuationDef="TC_englishRed"

8 >(Continued)</TblContinuationDef>

910 <TblContinuationDef tblContinuationDef="TC_deutsch"11 >(Weiter)</TblContinuationDef>1213 <TblContinuationDef tblContinuationDef="TC_francais"14 >(Continue)</TblContinuationDef>151617 <TblContinuationDef tblContinuationDef="TC_norwegian"18 >(fortsatt)</TblContinuationDef>1920 <TblContinuationDef tblContinuationDef="TC_dansk"21 >(fortsat)</TblContinuationDef>2223 <TblContinuationDef tblContinuationDef="TC_svenska"24 >(fortsättning)</TblContinuationDef>

Example 77 Multi-style and multi-lingual <TblContinuationDef> format definitions

For an illustration of using a table continuation format definition see Example 46 onpage 123.

<TextFrameDef ... >



<TextFrameDef ... >

SummaryUse the <TextFrameDef ... > element to create a text frame format that may be referencedby the <TextFrame ... > element (see pages 125–127) textFrameDef property withinthe <PageDef ... > element, or by the element frameAbove and frameBelow prop-erties (see Note 1 on page 209).

Properties

Property Value<TextFrameDef

Type, flow and auto-connect settings

textFrameDef name

Requiredname is text frame format name.


Ignored unless the <TextFrameDef ... > element is used within a<PageDef ... > (i.e. on a master page, see pages 171–174).

Use 'foreground' to specify a main-flow text frame layout and 'back-ground' to specify a background text frame layout containing text andgraphics (such as running headers and footers) to be used on body pageswhich are formatted using the master page name specified in the enclos-ing <PageDef ... > element.

Default: foreground


width auto | dim

Width of text frame. If width is set to ‘auto’ the width of the text frame isthe container width minus the value of the left property.

Default: auto

height dim

Height of text frame.

Default: 60 mm

Text frame position

left auto | dim

Distance of left side of text frame from left side of enclosing container. Inthe general case setting the left property to ‘auto’ is equivalent to setting itto ‘0’.

<TextFrameDef ... >



Property ValueIn the case the <TextFrameDef ... > element is referenced by the element frameAbove or frameBelow properties setting the left propertyto ‘auto’ results in the left indent of the text frame being the same as thestartIndent of the associated element. See page 99 and seeNote 1 on page 209.

Default: auto

top dim

Distance of top of text frame from top of enclosing frame or page.

Ignored when the <TextFrameDef ... > is referenced by the elementframeAbove or frameBelow properties See page 99 and see Note 1 onpage 209.

Default: 0

Top margin

The following property applies only when the type property is set to ‘background’.

topMargin dim

Distance from top of text frame to the top of the capitals height of the firstline of text within the text frame.

The topMargin property affects only the positioning of paragraph text.Other objects, e.g. <Line ... /> and <Image ... >, are positioned relative tothe text frame itself.

Default: 0

Multi-column layout

These properties apply only in the case of the foreground text flow.

columns int

Number of equally sized sub-columns within text frame.

Default: 1

columnGap dim

Gap between sub-columns within the text frame.


penWidth dim



Border pen style.

Default: solid

penColor name


penTint percent


<TextFrameDef ... >



Property Value

penOpacity 0 | 100



fillColor name


fillTint percent


fillOpacity 0 | 100


</TextFrameDef>

Notes1 A <TextFrameDef ... > element referenced by the element frameAbove or

frameBelow properties (see page 99) cannot contain a <RunningTextDef ... >element (see pages 189–192). If the <TextFrameDef ... > element contains a<RunningTextDef ... > element a warning message is issued and the text frame isignored.

Examples

Using <TextFrameDef ... > to define a page header

Example 78 illustrates how to to use the <TextFrameDef ... > element to define a pageheader containing running text, for use within a <PageDef ... > element.

1 <TextFrameDef textFrameDef="exRunningHeader" type="background"

2 left="10mm" top="5mm" width="50mm" height="10mm" >

3 <RunningTextDef> <paralabel textColor="Red"

4 names="P_chapterTitle|P_appendixTitle|P_chapterTitleTOC"

5 /> – <paratext

6 names="P_chapterTitle|P_appendixTitle"

7 /> </RunningTextDef> 

8 <Line top="4.5mm" />

9 </TextFrameDef>

Example 78 Defining a page header

<TextFrameDef ... >



The text frame format definition in Example 78 is for a background text frame (the type

property is set to 'background') and has a format name of ‘exRunningHeader’ (line 1).

Using <TextFrameDef ... > to define above and below frames

Example 79 illustrates defining two <TextFrameDef ... > elements, ‘tfWarnStart’ and‘tfWarnEnd’ (lines 1 to 15), for use as values for the element frameAbove andframeBelow properties. The formatted output of the <TextFrameDef ... > elements is in-dicated by Ⓐ and Ⓑ symbols in Figure 60 (on page 211). Example 79 also containsthe paragraph format definitions (lines 17 to 24) need to produce the output shown inFigure 60.

1 

2 <TextFrameDef textFrameDef="tfWarnStart" height="22pt" topMargin="4.5pt"

3 fillOpacity="20" fillColor="Red" >

4 <Line top="0mm" penColor="Blue" penWidth="1.5pt" />

5 Warning6 <Line top="18pt" penColor="Red" penWidth="1.5pt" />

7 <Image file="${images}/warningSign1.png" width="11pt" height="11pt" clip="N" />8 </TextFrameDef>9

10 11 <TextFrameDef textFrameDef="tfWarnEnd" height="12pt" fillOpacity="16"

12 topMargin="4pt" fillColor="Green" >

13 <Line top="0.7mm" penColor="DarkOlive" penWidth="1pt" />

14 Warning End15 </TextFrameDef>

1617 

18 <ParaDef paraDef="pWarning" fontFamily="Arial" fontWeight="Regular" textSize="9pt"19 spaceAbove="18pt" spaceBelow="8pt" leading="10pt"20 frameAbove="tfWarnStart" frameBelow="tfWarnEnd" />21 <ParaDef paraDef="pWarnHead" fontFamily="Arial" fontWeight="Bold" textSize="12pt" />22 <ParaDef paraDef="pWarnEnd" fontFamily="Arial" fontWeight="Regular" textSize="6pt" />23 <ParaDef paraDef="normalText" fontFamily="Arial" fontWeight="Regular" textSize="9pt"24 spaceAbove="15pt" spaceBelow="10pt" leading="6pt" />

Example 79 Defining a frame above/below

In Example 79 no left or width properties are set for the <TextFrameDef ... > elements(lines 2-3 and 11-12). This is because the default value for left is the value of thestartIndent of the associated paragraph when the <TextFrameDef ... > is used in a para-graph frame above or below context. The default value of width is the width of thecontainer, the main text flow in this case, minus the effective value of left. Similarlyhorizontal rulings within the above and below text frames are specified using the<Line ... /> element without left or width properties (lines 4, 6 and 13) and so default tostarting at the beginning of the enclosing text frame and extenging to its full width.

The usage of the format definitions contained in Example 79 is illustrated in Example 80.

<TextFrameDef ... >



1 To avoid hypothermia,2 wear thick clothing before abandoning ship.3 Normal text. More normal text. Normal text.4 5 Close the door before take-off.6 

Example 80 Using the <TextFrameDef ... > elements defined in Example 79

The output from Examples 79 and 80 is shown in Figure 60. For illustration purposesthe thin blue dashed rectangles in Figure 60 indicate the borders of the text frame. Theseborder rectangles would not be drawn with the markup shown in Example 79.

WarningTo avoid hypothermia, wear thick

clothing before abandoning ship.Warning End

Normal text.

More normal text.

Normal text.

WarningClose the door before take-off.

Warning End

Frame above height="22pt" Ⓐ

Paragraph A leading: 10pt

Frame below height="12pt" Ⓑ

max(spaceBelow A (8pt), spaceAbove B (15pt)) = 15pt

spaceParag

raph

AParag

raph

B

max(spaceBelow B (10pt), spaceAbove C (18pt)) = 18pt

space

Frame above height="22pt" Ⓐ

Frame below height="12pt" Ⓑ

Paragrap

h C

Container width = "56mm"

Figure 60 Annotated output from Examples 79 and80

The paragraph frame above andbelow text frames, indicated byⒶ and Ⓑ symbols, are loc-ated immediately above and be-low the associated paragraph text,and their heights form part of theparagraph's vertical extent, as il-lustrated in Figure 60.

See also: Example 42 on page109, and Examples 65 and 66on page 173.

<VarDef ... >



<VarDef ... >

SummaryUse <VarDef ... > element to define a named variable.

The contents of a <VarDef ... > definition are included using the <Var varDef="name" />element (see page 128 ).

Thousands of named variables may be created using the <VarDef ... > element.

Properties

Property Value<VarDef

Define (assign value to) variable

varDef name

name is the name of the variable.

>

<VarDef> sub-elements

The following elements may be included between <VarDef> and </VarDef>.

deftext



 


</VarDef>

ExamplesExample 81 illustrates defining (<VarDef ... >) and using (<Var ... />) a variable named‘Progname’:

<VarDef varDef="Progname"> Miramo </VarDef><Var varDef="Progname" /> is a software application forautomated document composition.<Var varDef="Progname" /> command line properties are shown

<VarDef ... >



on page ...

Example 81 Defining and using named variables with <VarDef ... > and <Var ... />

<XRefDef ... >



<XRefDef ... >

SummaryUse the <XRefDef ... > element to define a cross-reference format.

The text and sub-elements contained within the <XRefDef ... > element are used to ex-pand instances of the <XRef ... /> inline markup element which reference this formatdefinition (see page 129).

The <XRef ... /> element creates a cross reference to a <MkDest ... /> element whose idproperty value matches the <XRef ... /> element id property value. The <MkDest ... />element is described on page 87.

Properties

Property Value<XRefDef

Define cross-reference format

xRefDef name

Requiredname is the name of the cross-reference format.

>

<XRefDef> sub-elements

The following elements may be included between <XRefDef> and </XRefDef>.

deftext



 




The element may be used within <XRefDef ... >

<pageNumber/>

The <pageNumber/> sub-element expands to the page number of the<MkDest ... /> element whose id value is referenced by an <XRef ... />element (see page 129).

<XRefDef ... >



<XRefDef> sub-elements (Continued )

<paragraphText keepFormatting = "N | Y" />

The <paragraphText/> sub-element expands to the paragraph text of theparagraph containing the <MkDest ... /> element whose id value is ref-erenced by an <XRef ... /> element (see page 129). ‘Paragraph text’ isparagraph text exclusive of list label text, autonumber counters, etc.



<paragraphLabel/>

The <paragraphLabel/> sub-element expands to the autonumber andautonumber text, if any, of the <MkDest ... /> element whose id value isreferenced by an <XRef ... /> element (see page 129).

<paragraphNumber/>

The <paragraphNumber/> sub-element expands to the autonumber (ex-cluding both the autonumber text and the paragraph text) of the <MkD-est ... /> element whose id value is referenced by an <XRef ... /> element(see page 129).

</XRefDef>

ExamplesExample 82 contains multiple <XRefDef ... > format definition instances.

1 <XRefDef xRefDef="seeFigureRef">See <paragraphLabel/>, <paragraphText/> </XRefDef>

2 <XRefDef xRefDef="figureRef"> <paragraphLabel/>, <paragraphText/> </XRefDef>

34 <XRefDef xRefDef="pageRef" > <pageNumber/> </XRefDef>

56 <XRefDef xRefDef="redPageNum"

7 > page <pageNumber/> </XRefDef>89 <XRefDef xRefDef="paragraphNumber"> <paragraphNumber/> </XRefDef>

1011 <XRefDef xRefDef="paragraphText" > <paragraphText/> </XRefDef>

1213 <XRefDef xRefDef="seeChapter"

14 >See <paragraphLabel/>– ‘<paragraphText fontAngle="Italic"15 />’</XRefDef>

Example 82 <XRefDef ... > format definition examples

<XRefDef ... >



The values of the xRefDef property in Example 82, ‘seeFigureRef’, ‘figureRef’, ‘pageRef’, etc,are arbitrary identifiers: any values may be used.

Example 83 illustrates how to use the <XRef ... /> element (see page 129) to referencea <XRefDef ... > format definition.

1 2 This is a cross-reference: 3 <XRef xRefDef="seeChapter" id="inlineMarkupElements.start" /> on <XRef4 xRefDef="redPageNum" id="inlineMarkupElements.start" />.

Example 83 Referencing an <XRefDef ... > format definition

This is a cross-reference:See Chapter 3– ‘Inline markup elements’ on page 5.



The <XRefDef ... > formats used inExample 83 are defined on lines 6and 13 in Example 82.

APPENDICES


Appendices

Appendix 1Fonts

Introduction

This Appendix provides information about the supported font types, how to select fonts andspecialized features relating to fonts.

Supported font types

In the general case the following font types are supported by mmComposer:

– TrueType fonts (.ttf). Both old-style TrueType fonts and newer TrueType fontssupporting OpenType advanced features.

– TrueType Collection fonts (.ttc). These are for Chinese, Japanese and Korean text.

– OpenType fonts (.otf). These include fonts with CFF/PostScript outlines, except inthe case of Asian CFF fonts.

In all cases fonts must contain a character to glyph Unicode mapping table. Fonts that includeonly national standard or platform encodings are not supported.

Font installation

Additional fonts may be installed in the ‘%SYSTEMROOT%\Fonts’ folder using the standard Win-dows font install process. Alternatively, additional fonts may be installed in the Miramo in-stalldir/fonts folder by copying .ttf or .otf font files.

After installing a new font the ‘mmServer’ service must be stopped and re-started to make thenew font available to mmComposer. This requires Administrator privileges.

Font selection

Particular fonts are specified and selected using the following three identifiers:

1 Font family name.E.g. 'Times New Roman', 'Arial', 'Gabriola', etc.

2 Font angle.E.g. 'Regular' and 'Italic'.

3 Font weight.E.g. 'Regular', 'Light', 'Bold', 'Heavy'.

The font name specifiers are as those used by MS Word and FrameMaker, not the group namesbased on preferred family name used by InDesign.

Fonts must be installed in the Windows/Fonts folder or the Miramo installdir/fonts folder.

Fonts for complex scripts

When the language property is set to a complex script language, e.g. Thai, Arabic, and so on,a font that supports that language script must also be selected.

Appendix 1 – Fonts


For example, if the language property is set to Thai, and the selected font is Times New Roman,then Thai text will appear as a series of # characters. This is because the Times New Romanfont does not contain Thai characters, as illustrated in Example 1.1 and Figure 1.1.

1 ประ-วัติศาสตร์-ไทย

2 ประ-วัติศาสตร์-ไทย

Example A1.1 Characters not included in a font's character set

ประ ัว ิตศาสต ์รไทย

��

Figure A1.1 Output from Ex-ample A1.1

The output from Example A1.1 is shown in Figure A1.1 .

OpenType font features

Advanced OpenType font features are supported via the element fontFeatures property (see page 42).

A list of OpenType font feature tag names is shown in Table A 1.1 .

Table A 1.1 Font feature tag names and descriptions

Tag name Description

aalt Access All Alternates

abvf Above-base Forms

abvm Above-base Mark Positioning

abvs Above-base Substitutions

afrc Alternative Fractions

akhn Akhands

blwf Below-base Forms

blwm Below-base Mark Positioning

blws Below-base Substitutions

calt Contextual Alternates

case Case-Sensitive Forms

ccmp Glyph Composition / Decomposition

cfar Conjunct Form After Ro

cjct Conjunct Forms

clig Contextual Ligatures

cpct Centered CJK Punctuation

cpsp Capital Spacing

cswh Contextual Swash

curs Cursive Positioning

cv01-cv99 Character Variants

c2pc Petite Capitals From Capitals

c2sc Small Capitals From Capitals

dist Distances

dlig Discretionary Ligatures



Table A 1.1 Font feature tag names and descriptions (Continued )


dnom Denominators

expt Expert Forms

falt Final Glyph on Line Alternates

fin2 Terminal Forms #2

fin3 Terminal Forms #3

fina Terminal Forms

frac Fractions

fwid Full Widths

half Half Forms

haln Halant Forms

halt Alternate Half Widths

hist Historical Forms

hkna Horizontal Kana Alternates

hlig Historical Ligatures

hngl Hangul

hojo Hojo Kanji Forms (JIS X 0212-1990 Kanji Forms)

hwid Half Widths

init Initial Forms

isol Isolated Forms

ital Italics

jalt Justification Alternates

jp78 JIS78 Forms

jp83 JIS83 Forms

jp90 JIS90 Forms

jp04 JIS2004 Forms

kern Kerning

lfbd Left Bounds

liga Standard Ligatures

ljmo Leading Jamo Forms

lnum Lining Figures

locl Localized Forms

ltra Left-to-right alternates

ltrm Left-to-right mirrored forms

mark Mark Positioning

med2 Medial Forms #2

medi Medial Forms

mgrk Mathematical Greek

mkmk Mark to Mark Positioning

mset Mark Positioning via Substitution





nalt Alternate Annotation Forms

nlck NLC Kanji Forms

nukt Nukta Forms

numr Numerators

onum Oldstyle Figures

opbd Optical Bounds

ordn Ordinals

ornm Ornaments

palt Proportional Alternate Widths

pcap Petite Capitals

pkna Proportional Kana

pnum Proportional Figures

pref Pre-Base Forms

pres Pre-base Substitutions

pstf Post-base Forms

psts Post-base Substitutions

pwid Proportional Widths

qwid Quarter Widths

rand Randomize

rkrf Rakar Forms

rlig Required Ligatures

rphf Reph Forms

rtbd Right Bounds

rtla Right-to-left alternates

rtlm Right-to-left mirrored forms

ruby Ruby Notation Forms

salt Stylistic Alternates

sinf Scientific Inferiors

size Optical size

smcp Small Capitals

smpl Simplified Forms

ss01 — ss20 Stylistic Set 1 — Stylistic Set 20

subs Subscript

sups Superscript

swsh Swash

titl Titling

tjmo Trailing Jamo Forms

tnam Traditional Name Forms

tnum Tabular Figures





trad Traditional Forms

twid Third Widths

unic Unicase

valt Alternate Vertical Metrics

vatu Vattu Variants

vert Vertical Writing

vhal Alternate Vertical Half Metrics

vjmo Vowel Jamo Forms

vkna Vertical Kana Alternates

vkrn Vertical Kerning

vpal Proportional Alternate Vertical Metrics

vrt2 Vertical Alternates and Rotation

zero Slashed Zero


Appendix 2Setting text language

language usage

The language property is used to:

– Invoke the appropriate script and language text layout rules in a font.

Many fonts support multiple scripts. For example in the case of the Tahoma fontthe supported scripts include ‘arab’ ‘cyrl’, ‘hebr’, ‘latn’ and ‘thai’. To get correctlytypeset Thai, Hebrew, etc, text it is not sufficient to set the fontFamily property to'Tahoma': the language property must also be set appropriately.

– Perform a bi-directional override in the case of documents containing bi-direction-al text (left to right and right to left text).

– Determine how text lines are hyphenated when the hyphenate property is set to 'Y'.

The language property is supported on the following elements:

– <MiramoXML ... > See page 4.

Sets the default language for the entire document.

– <ParaDef ... > See pages 175–186

Sets the default language for every instance of the paragraph format. Overrides thelanguage setting on the <MiramoXML ... > element.

– See pages 91–100

Sets the default language for a paragraph. Overrides the language setting on the<MiramoXML ... > and <ParaDef ... > elements.

– <FontDef ... /> See pages 151–156

Sets the default language for every instance of the font format. Overrides the lan-guage setting on the <MiramoXML ... >, <ParaDef ... > and elements.

– See pages 40–48

Sets the default language for the contents of a element. Overrides thelanguage setting on the <MiramoXML ... >, <ParaDef ... >, and <FontDef .../> elements.

Languages values

Appendix 2 – Setting text language


Table A 2.1 List of language values

language value Description

Afrikaans Latin script

Bulgarian Latin script

Arabic Arabic script

Catalan Latin script

Czech Latin script

ukEnglish Latin script

usEnglish Latin script

Danish | Dansk Latin script

Dutch Latin script

French | français Latin script

German Latin script. 1901 German rules.

newGerman Latin script. 1996 German rules.

Hungarian Latin script

Italian Latin script

Japanese Multi-script

Korean Hangul script

norwegianBokmål Latin script

norwegianNynorsk Latin script

Polish | polski Latin script

Portuguese Latin script

Russian Cyrillic script

Serbian Cyrillic script

latinSerbian Latin script

simplifiedChinese Simplified Chinese script. Used in the People's Republic ofChina.

Spanish Latin script

Swedish | Svenska Latin script

Thai Thai script

traditionalChinese Traditional Chinese script. Used in Taiwan, Hong Kong and oth-er regions.

Turkish Latin script.


Appendix 3Autonumbering

Introduction

Autonumbering of paragraphs and lists is achieved using the <ListLabel ... > element combinedwith its <counter ... /> sub-element (see pages 71–80).

This Appendix provides additional information about the layout of list labels and about theusage of autonumber, or auto-sequence, counters. Several illustrations are also included..

All autonumbering is achieved using <counter ... /> sub-elements within <ListLabel ... > ele-ments associated with or <ParaDef ... > elements.

Autonumbering layout

The two main types of autonumbered list label layouts:

1 Run into to paragraph. The list label, including the autonumber, runs into thefirst line of paragraph text. This is achieved by setting the <ListLabel ... > typeproperty to 'runin' (the default).

By default, or when the <ListLabel ... > type property is set to 'runin', several<ListLabel ... > properties are ignored. The ignored properties are listed in the de-scription of the type property on page 71. <Listlabel ... > and <counter ... />font properties are effective in the case a list label runs into the first line of para-graph text.

Some illustrations of run into paragraph layouts are shown in Examples A3.7–A3.10 and Figures A3.5–A3.8 (pages 227–229).

2 Fixed-width in/outdented label area. The list label, including the autonumber,is start or end-aligned within a fixed-width geometrically positioned list label area,usually outdented from the paragraph text. The width of the list label area is spe-cified by a dimension value on <ListLabel ... > labelWidth property. In this case ifthe <ListLabel ... > labelIndent property is omitted, or set to 'auto' (default), the po-sition of the end of the list label area is contiguous with the start of the paragraphstartIndent value. If the <ListLabel ... > labelIndent property is set to a dimensionvalue, the list label area starts at the specified indent from the start side of the textframe border. In both cases the <ListLabel ... > labelWidth must be specified with adimension value. Fixed-width, geometrically positioned list labels are achieved bysetting the type property to 'runin'.

When there is a fixed-width, geometrically positioned list label, i.e. when the<ListLabel ... > type property is set 'fixed', the <ListLabel ... > textAlign through en-

Appendix 3 – Autonumbering


dIndent properties, as described on pages 72–72, apply in addition to fontproperties. The <leader ... > sub-element is also effective in this case, if included.

Simple autonumbered lists

Example A3.1 shows two paragraph format definitions for simple, independent numberingschemes.

1 2 <ParaDef paraDef="P_ex1Header" firstLineIndent="4mm" startIndent="4mm"3 > <ListLabel seriesLabel="ex1Header" type="fixed"4 labelWidth="4mm" > <counter/> </ListLabel>5 </ParaDef>6 <ParaDef paraDef="P_ex1ListItem" firstLineIndent="9mm" startIndent="9mm"7 > <ListLabel seriesLabel="ex1ListItem" type="fixed"8 labelWidth="5mm" > <counter/> </ListLabel>9 </ParaDef>

Example A3.1 Paragraph format definitions for simple autonumbering (1)

1 First steps1 Board train.2 Find seat.

2 Next steps3 Open book.4 Read.

Figure A3.1 Outputfrom Example A3.1 and

Example A3.2

Example A3.2 shows a series of paragraph input instances, toillustrate the output numbering produced when using the para-graph formats defined in Example A3.1 .

1 2 First steps3 Board train.4 Find seat.5 Next steps6 Open book.

7 Read.

Example A3.2 Autonumbered input (1)

The output from Example A3.1 and Example A3.2 is shown in Figure A3.1 .

The number counter of paragraph ‘P_ex1ListItem’ is automatically incremented for every in-stance, independent of the numbering of higher level ‘P_ex1Header’ paragraphs. The number-ing of ‘P_ex1ListItem’ may be explicitly reset at any time, by setting the element num-berValue property (see page 94) to the desired value. For example, explicitly setting num-berValue to '1' in line 6, i.e. replacing line 6 with the markup shown in Example A3.3 :

Open book.

Example A3.3 Resetting numbering (modification to Example A3.2 )



Figure A3.2 Outputfrom Example A3.1 andmodified Example A3.2

The output from Example A3.1 and Example A3.2 , with line 6replaced by the line shown in Example A3.3 , is shown in FigureA3.2 .

Alternatively, the number resetting of ‘P_ex1ListItem’ paragraphsmay be automated by setting the value of the ‘P_ex1ListItem’<xcounter ... /> parent property to 'P_ex1Header', as illustrated inExample A3.4 (see line 8) and Example A3.5 (see line 7).

1 2 <ParaDef paraDef="P_ex1Header" firstLineIndent="4mm" startIndent="4mm"3 > <ListLabel seriesLabel="ex1Header" type="fixed"



4 labelWidth="4mm" > <counter/> </ListLabel>5 </ParaDef>6 <ParaDef paraDef="P_ex1ListItem" firstLineIndent="9mm" startIndent="9mm"7 > <ListLabel type="fixed" labelWidth="5mm" seriesLabel="ex1ListItem" > <counter

8 parent="P_ex1Header" numberPrefix="." /> </ListLabel>

9 </ParaDef>


1 First steps1.1 Board train.1.2 Find seat.

2 Next steps2.1 Open book.2.2 Read.


Example A3.2

The output from Example A3.4 and Example A3.2 is shown inFigure A3.3 . Note: the seriesLabel property of the <ListLabel ... >sub-element associated with the ‘P_ex1ListItem’ paragraph formatdefinition (see line 7 in Example A3.4 ) is ignored. This is becausethe counter seriesLabel value of the reference parent pararagraphformat is always applicable.

Example A3.5 illustrates the effect of setting the <counter ... />hideParentNumber property to 'Y' (line 8).

1 2 <ParaDef paraDef="P_ex1Header" firstLineIndent="4mm" startIndent="4mm"3 > <ListLabel seriesLabel="ex1Header" type="fixed"4 labelWidth="4mm" > <counter/> </ListLabel>5 </ParaDef>6 <ParaDef paraDef="P_ex1ListItem" firstLineIndent="9mm" startIndent="9mm"7 > <ListLabel type="fixed" labelWidth="5mm" > <counter parent="P_ex1Header"

8 hideParentNumber="Y" /> </ListLabel>

9 </ParaDef>





Example A3.2

The output from Example A3.5 and Example A3.2 is shown inFigure A3.4 .

Complex autonumbering schemes

Autonumbering may be specfied for multiple, inter-dependentlevels. as illustrated in Examples A3.7 through A3.10 and corres-ponding Figures A3.5 through A3.8.

Example A3.6 shows a series of paragraph input instances, to il-lustrate the output numbering produced when using the paragraph formats defined in Ex-amples A3.7 through A3.10.

1 2 First title

3 Figure caption

4 Second title

5 Table title

6 Table Title

7 Third title




11 Table title




Example A3.6 Autonumbered input (2)

Example A3.6 contains 12 paragraph instances with three different paragraph formats:

1 P_ex2AddendumTitle. Actually or notionally at the top level in the following ex-amples. Corresponds with e.g. a chapter or section title.

2 P_ex2FigureCaption. Actually or notionally at a second level in the following ex-amples. This paragraph format might typically be used within a <ObjectTitle ... >element.

3 P_ex2TableTitle. Actually or notionally at a second level in the following ex-amples. This paragraph format might typically be used within a <TblTitle ... > ele-ment within a <Tbl ... > element. The text content of paragraphs is preceded by aspace character, with the exception of the instance on line 11.

Note that none of the paragraph format definitions shown in the following Examples A3.7through A3.10 contain the <ListLabel ... > width property, unlike in Examples A3.1 and A3.5(on pages 225–226). This is because all the autonumbering labels in Examples A3.7through A3.10 are run into the paragraph text rather than being outdented as in ExamplesA3.1 through A3.5.

Addendum 1 First titleFigure A1—Figure caption

Addendum 2 Second titleTable A1Table title

Table A2Table Title

Addendum 3 Third titleTable A3Table title

Figure A2—Figure caption

Table A4Table title

Table A5Table titleFigure A3—Figure caption

Figure A3.5 Output from Ex-ample A3.7 and Example A3.6

Example A3.7 shows paragraph format definitions inwhich the numbering sequences for addenda, figures andtables are independent.

1 2 <ParaDef paraDef="P_ex2AddendumTitle" >

3 <ListLabel seriesLabel="ex2AddendumNumber"

4 >Addendum <counter/> </ListLabel>5 </ParaDef>

6 <ParaDef paraDef="P_ex2TableTitle"

7 firstLineIndent="3mm" >8 <ListLabel seriesLabel="ex2Tables"

9 >Table A<counter numberPrefix="."

10 /> </ListLabel>11 </ParaDef>

12 <ParaDef paraDef="P_ex2FigureCaption"

13 firstLineIndent="6mm" >14 <ListLabel seriesLabel="ex2Figures"

15 >Figure A<counter numberPrefix="."

16 />—</ListLabel>

17 </ParaDef>

Example A3.7 Paragraph formats for complex autonumbering (E1)

In Example A3.7 each of the paragraph formats for addendum, figure and table numberinghas a different value for its <ListLabel ... > seriesLabel property (lines 3, 8 and 14). The outputfrom Example A3.7 and Example A3.6 is shown in Figure A3.5 .



Addendum 1 First titleFigure A1—Figure caption

Addendum 2 Second titleTable A2Table title

Table A3Table Title

Addendum 3 Third titleTable A4Table title

Figure A5—Figure caption

Table A6Table title

Table A7Table titleFigure A8—Figure caption


Example A3.8 is the same as Example A3.7 except that theparagraph formats for figure and table numbering have thesame values for their <ListLabel ... > seriesLabel properties(8 and 14).


3 <ListLabel seriesLabel="ex2AddendumNumber"4 >Addendum <counter/> </ListLabel>5 </ParaDef>6 <ParaDef paraDef="P_ex2TableTitle"7 firstLineIndent="3mm" >8 <ListLabel seriesLabel="inAddenda"


10 /> </ListLabel>11 </ParaDef>12 <ParaDef paraDef="P_ex2FigureCaption"13 firstLineIndent="6mm" >14 <ListLabel seriesLabel="inAddenda"



17 </ParaDef>



Addendum 1 First titleFigure A1.1—Figure caption

Addendum 2 Second titleTable A2.1Table title

Table A2.2Table Title

Addendum 3 Third titleTable A3.1Table title

Figure A3.2—Figure caption

Table A3.3Table title

Table A3.4Table titleFigure A3.5—Figure caption


Example A3.9 shows paragraph format definitions fora two-level, hierarchical numbering scheme in which thelower level numbering, for figures and tables, is shared.



4 >Addendum <counter/> </ListLabel>5 </ParaDef>6 <ParaDef paraDef="P_ex2TableTitle"7 firstLineIndent="3mm" >8 <ListLabel seriesLabel="inAddenda"


10 parent="P_ex2AddendumTitle"

11 /> </ListLabel>12 </ParaDef>13 <ParaDef paraDef="P_ex2FigureCaption"14 firstLineIndent="6mm" >15 <ListLabel seriesLabel="inAddenda"




19 </ParaDef>




In Example A3.9 the figure and table numbering each has two counters. The first countervalue is set to the current value of the parent paragraph counter, i.e. the autonumber of the ad-dendum paragraphs. The shared secondary numbering for figures and tables is reset to one atthe start of each addendum. The output from Example A3.9 and Example A3.6 is shown inFigure A3.7 . The output from Example A3.9 and Example A3.6 is shown in Figure A3.7 .

Addendum 1 First titleFigure A1.1—Figure caption

Addendum 2 Second titleTable A2.1Table title

Table A2.2Table Title

Addendum 3 Third titleTable A3.1Table title

Figure A3.1—Figure caption

Table A3.2Table title

Table A3.3Table titleFigure A3.2—Figure caption


Example A3.10 is the same as Example A3.9 except thatthe figures and tables have distinct numbering sequences,as is often required.



4 >Addendum <counter/> </ListLabel>5 </ParaDef>6 <ParaDef paraDef="P_ex2TableTitle"7 firstLineIndent="3mm" >8 <ListLabel seriesLabel="ex2Tables"



11 /> </ListLabel>12 </ParaDef>13 <ParaDef paraDef="P_ex2FigureCaption"14 firstLineIndent="6mm" >15 <ListLabel seriesLabel="ex2Figures"




19 </ParaDef>



Unlimited-level hierarchical autonumbering

Previous sections have illustrated two-level numbering schemes. This section shows howautonumbering schemes may be extended to any desired hierarchical level.

Example A3.11 shows the paragraph text input used to illustrate a three-level hierarchicalnumbering scheme. The corresponding paragraph format definitions are shown in ExampleA3.12 .

1 2 First title

3 Section title


5 Second title






11 Table title




Example A3.11 Input for three-level autonumbering (E5)

Addendum 1 First title

Section A1.1Section titleFigure A1.1.1—Figure caption

Addendum 2 Second title

Section A2.1Section titleTable A « 2.1.1 » Table titleFigure A2.1.1—Figure caption

Section A2.2Section titleTable A « 2.2.1 » Table titleTable A « 2.2.2 » Table titleFigure A2.2.1—Figure caption

Figure A3.9 Output from ExampleA3.12 and Example A3.6

The <ParaDef ... > and associated <ListLabel ... > formatdefinitions in Example A3.12 are similar to those inExample A3.10 with the primary exception that thenumbering scheme illustrates a three-level hierarchy.

1 2 <FontDef fontDef="ex3TableNumber"3 fontFamily="Arial" fontWeight="Bold"4 textColor="DarkOlive" textSize="+20%" />5 6 <ParaDef paraDef="P_ex3AddendumTitle" >


8 >Addendum <counter/> </ListLabel>9 </ParaDef>

10 <ParaDef paraDef="P_ex3AddendumSection"11 firstLineIndent="4mm" >12 <ListLabel seriesLabel="ex3Sections"

13 >Section A<counter numberPrefix="."


15 /> </ListLabel>16 </ParaDef>17 <ParaDef paraDef="P_ex3TableTitle"18 firstLineIndent="8mm" >19 <ListLabel seriesLabel="ex3Tables"

20 textColor="Blue"21 >Table A « <counter numberPrefix="."

22 fontDef="ex3TableNumber"

23 parent="P_ex3AddendumSection"

24 /> » </ListLabel>25 </ParaDef>26 <ParaDef paraDef="P_ex3FigureCaption"27 firstLineIndent="8mm" >28 <ListLabel seriesLabel="ex3Figures"


30 parent="P_ex3AddendumSection"


32 </ParaDef>

Example A3.12 Paragraph formats for multi-level autonumbering (E5)

The output from Example A3.12 and Example A3.6 is shown in Figure A3.9 . The scenarioillustrated in Example A3.12 may be extended to an any-level hierarchy. For example, to getsay, three, or any number of, descending nested autonumbered paragraphs within each ‘Sec-tion’ within each ‘Addendum’ a ‘P_sectionLevel1’ paragraph format could be defined with its<ListLabel ... > <counter ... /> parent property set to ‘P_ex3AddendumSection’. Another para-graph format, ‘P_sectionLevel2’, could be defined with its <ListLabel ... > <counter ... /> parent

property set to ‘P_sectionLevel1’. And then another paragraph format, ‘P_sectionLevel3’, couldbe defined with its <ListLabel ... > <counter ... /> parent property set to ‘P_sectionLevel2’. Andso on, up to any desired nesting level.



Alignment of autonumbering

In the case the <ListLabel ... > labelWidth property is set, as in Examples A3.1 through A3.5(on pages 225–226), the autonumbering is aligned at the start of the label area by default.When no <ListLabel ... > labelIndent property is set, the end of the label area is contiguous withthe start of the paragraph start indent, as specified by the element startIndent property(see Figures 30 through 33, on pages 75–77).

The paragraph format definitions shown in Example A3.13 are identical to those shown in Ex-ample A3.4 (see page 226), except for the addition of the numberStart property (see line 3),included and set to '9' to better illustrate the start (left in this case) alignment of the autonum-bers.

1 2 <ParaDef paraDef="P_ex1Header" firstLineIndent="4mm" startIndent="4mm"3 > <ListLabel seriesLabel="ex1Header" type="fixed" labelWidth="4mm" > <counter number-

Start="9"

4 /> </ListLabel>5 </ParaDef>6 <ParaDef paraDef="P_ex1ListItem" firstLineIndent="11mm" startIndent="11mm"7 > <ListLabel type="fixed" labelWidth="7mm" > <counter8 parent="P_ex1Header" numberPrefix="." /> </ListLabel>9 </ParaDef>

Example A3.13 Paragraph format definitions for start-aligned numbering




Example A3.2

The output from Example A3.13 and Example A3.2 (see page225) is shown in Figure A3.10 .

End-alignment of text, including autonumbers, within the list la-bel area is achieved by setting the <ListLabel ... > textAlign prop-erty to 'end'. The default result of this is that the end of the labeltext will be contiguous with the start of the associated paragraphtext. There are two ways to achieve a gap between the list labeltext and the associated paragraph text:

1 Use the <ListLabel ... > endIndent property to set an end margin for text, includingautonumbers, in the list label area. This method is illustrated in Example A3.14 .

2 Set the <ListLabel ... > labelIndent property so that the sum of the values of the<ListLabel ... > labelIndent and labelWidth properties is less than the value of the element firstLineIndent property. This method is illustrated in ExampleA3.15 .

In Example A3.14 the 1 mm gap between the right-aligned second level autonumber andthe associated paragraph text is specified by setting the value of the ‘P_exListItem’ paragraph<ListLabel ... > endIndent property to '1mm' (line 13).

1 2 <ParaDef paraDef="P_ex1Header" firstLineIndent="5mm" startIndent="5mm"3 > <ListLabel seriesLabel="ex1Header" type="fixed" labelWidth="4mm"4 labelIndent="0"5 textAlign="end"6 endIndent="1.0mm"7 > <counter numberStart="9"




10 <ParaDef paraDef="P_ex1ListItem" firstLineIndent="13mm" startIndent="13mm"11 > <ListLabel type="fixed" labelWidth="6mm"12 textAlign="end"13 endIndent="1.0mm"

14 > <counter15 parent="P_ex1Header" numberPrefix="." /> </ListLabel>16 </ParaDef>

Example A3.14 Paragraph format definitions for end-aligned numbering (1)




Figure A3.11 Outputfrom Example A3.14

and Example A3.2

In Example A3.15 the gap between the right-aligned second levelautonumber and the first line of the associated paragraph textis determined by the value of the ‘P_exListItem’ paragraph first-LineIndent property (line 11) minus the sum of the <ListLabel ...> labelIndent and labelWidth values (lines 13 and 12), since the<ListLabel ... > endIndent is not set, i.e. defaults to '0'.

1 2 <ParaDef paraDef="P_ex1Header"3 firstLineIndent="5mm" startIndent="5mm"4 > <ListLabel seriesLabel="ex1Header" type="fixed" labelWidth="4mm"5 labelIndent="0"6 textAlign="end"7 endIndent="1.0mm"8 > <counter numberStart="9"

9 /> </ListLabel>10 </ParaDef>11 <ParaDef paraDef="P_ex1ListItem" firstLineIndent="13mm" startIndent="13mm"

12 > <ListLabel type="fixed" labelWidth="6mm"

13 labelIndent="4mm"

14 textAlign="end"15 > <counter16 parent="P_ex1Header" numberPrefix="." /> </ListLabel>17 </ParaDef>

Example A3.15 Paragraph format definitions for end-aligned numbering (2)




and Example A3.2

The output from Example A3.15 and Example A3.2 is shown inFigure A3.11 .

Indented autonumbering

In the case the <ListLabel ... > labelWidth property is set, as in Ex-amples A3.1 through A3.5 (on pages 225–226), the autonum-bering is aligned at the start of the label area. By default, when no<ListLabel ... > labelIndent property is set, the end of the label areacontiguous with the start of the paragraph start indent, as specified by the elementstartIndent property (see Figures 30 through 33, on pages 75–77).

The ‘P_ex1ListItem’ paragraph format definition in Example A3.16 shows how to produce alist label that runs into the paragraph text. The width of the list label area is the width of the listlabel text, including the autonumber. A run-in list label is produced by when the labelWidthproperty is omitted from the <ListLabel ... > sub-element.



In Example A3.16 the paragraph format definition.

1 2 <ParaDef paraDef="P_ex1Header" firstLineIndent="4mm" startIndent="4mm"

3 > <ListLabel seriesLabel="ex1Header" type="fixed" labelWidth="4mm" > <counter number-Start="9"


6 <ParaDef paraDef="P_ex1ListItem" firstLineIndent="4mm" startIndent="4mm"7 > <ListLabel> <counter8 textColor="Red" parent="P_ex1Header" numberPrefix="." /> </ListLabel>9 </ParaDef>

Example A3.16 Paragraph format definitions for run into text numbering (1)

9 First steps9.1 Board train. Best to boardat correct carriage.9.2 Find seat. No need to rushif you have a reservation.

10 Next steps10.1 Sit down comfortably,then open book.10.2 Read.


The output from Example A3.16 and Example A3.2 (seepage 225) is shown in Figure A3.13 .

The ‘P_ex1ListHeader’ paragraph format definition shownin Example A3.16 (lines 2-5) is identical to that shown inExample A3.4 (see page 226), except for the yyy addi-tion of the numberStart property, included and set to '9' tobetter illustrate the start (left in this case) alignment of theautonumbers (line 3 in Example A3.16).

In the case the <ListLabel ... > labelWidth property is set, asin Examples A3.1 through A3.5 (on pages 225–226),the autonumbering is aligned at the start of the label area. By default, when no <ListLabel ... >labelIndent property is set, the end of the label area contiguous with the start of the paragraphstart indent, as specified by the element startIndent property (see Figures 30 through33, on pages 75–77).

The paragraph format definitions shown in Example A3.17.

1 2 <ParaDef paraDef="P_ex1Header" firstLineIndent="4mm" startIndent="4mm"3 > <ListLabel seriesLabel="ex1Header" type="fixed" labelWidth="4mm" > <counter number-

Start="9"

4 /> </ListLabel>5 </ParaDef>6 <ParaDef paraDef="P_ex1ListItem" firstLineIndent="11mm" startIndent="4mm"7 > <ListLabel type="fixed" labelWidth="7mm" labelIndent="4mm" > <counter

8 textColor="Red" parent="P_ex1Header" numberPrefix="." /> </ListLabel>9 </ParaDef>

Example A3.17 Paragraph format definitions for run into text numbering (2)



9 First steps9.1 Board train. Best toboard at correct carriage.9.2 Find seat. No need torush if you have a reserva-tion.

10 Next steps10.1 Sit down comfortably,then open book.10.2 Read.

Figure A3.14 Output from Ex-ample A3.17 and Example

A3.2

The paragraph format definitions shown in Example A3.17are identical to those shown in Example A3.4 (see page226), except for the addition of the numberStart, includedand set to '9' to better illustrate the start (left in this case)alignment of the autonumbers (line 3 in Example A3.17).

The output from Example A3.17 and Example A3.2 (seepage 225) is shown in Figure A3.14 .

Arabic lists

Example A3.18 shows two paragraph format definitions forsimple, independent numbering schemes in arabic.

1 2 <ParaDef paraDef="P_arabic1Header" firstLineIndent="4mm" startIndent="4mm"3 language="Arabic"4 > <ListLabel seriesLabel="arabic1Header" type="fixed" labelWidth="4mm"5 > <counter numberStyle="indicArabic" /> </ListLabel>6 </ParaDef>7 <ParaDef paraDef="P_arabic1ListItem" firstLineIndent="9mm" startIndent="9mm"8 language="Arabic"9 > <ListLabel type="fixed" labelWidth="5mm"

10 > <counter numberPrefix="٫" numberStyle="indicArabic"11 parent="P_arabic1Header" hideParentNumber="N" /> </ListLabel>

12 </ParaDef>

Example A3.18 Paragraph format definitions for Arabic autonumbering

الخطوات الاولى١اركب القطار.١٫١حدد المقعد.١٫٢

الخطوات المقبلة٢افتح الكتاب.٢٫١اقرأ.٢٫٢


and Example A3.19

Example A3.19 shows a series of paragraph input instances, to il-lustrate the output numbering produced when using the paragraphformats defined in Example A3.18 .

1 2 

3 ى ل و ا ل ا ت ا و ط خ ل ا

4 

5 ر ا ط ق ل ا ب ك ر ا .

6 

7 د ع ق م ل ا د د ح .

8 

9 ة ل ب ق م ل ا ت ا و ط خ ل ا

10 

11 ب ا ت ك ل ا ح ت ف ا .

12 

13 أ ر ق ا .

Example A3.19 Arabic input

In Example A3.19 the Arabic text is shown in logical order (as typed) from left to right, andeach input character is shown in isolated form (lines 3, 5, 7, 9, 11, 13). Each line of Arabic textis preceded by a comment line containing a bar-separated list of hexadecimal Unicode charac-ter numbers, one for each Arabic character in the following line of text (lines 2, 4, 6, 8, 10, 12).

The output from Example A3.18 and Example A3.19 is shown in Figure A3.15.



numberStyle values

The numberStyle property is used for autonumbering lists using the <ListLabel ... > <counter .../> sub-element and for page numbering and footnote numbering.

Table A 3.1 List of numberStyle values

numberStyle value Notes

westernArabic Western arabic numerals. E.g. 1, 2, 3, ...

uppercaseAlpha Uppercase ASCII letter sequence. E.g. A, B, C, ...

lowercaseAlpha Lowercase ASCII letter sequence. E.g. a, b, c, ...

uppercaseRoman Uppercase roman numerals: I, II, III, IV ...

lowercaseRoman Lowercase roman numerals: i, ii, iii, iv ...

indicArabic Tamil numerals.E.g. ١, ٢, ٣, ٤, ٥, ٦ ...

Persian | Urdu Persian / Urdu numerals.E.g. ۱, ۲, ۳, ۴, ۵, ۶ ...

Bengali Bengali numerals.E.g. ০, ১, ২, ৩, ৪, ৫, ৬, ৭, ৮, ৯,

Brahmi Brahmi numerals.E.g. ᄆ�, ᄆ�, ᄆ�, ᄆ�, ᄆ�, ᄆ�, ᄆ�, ᄆ�, ᄆ�, ᄆ�,

fullwidthNumerals Chinese / Japanese full width numerals.E.g. ０, １, ２, ３, ４, ５, ６, ７, ８, ９,

Gujarati Gujarati numerals.E.g. ૦, ૧, ૨, ૩, ૪, ૫, ૬, ૭, ૮, ૯,

Gurmukhi Gurmukhi numerals.E.g. ੦, ੧, ੨, ੩, ੪, ੫, ੬, ੭, ੮, ੯,

Kannada Kannada numerals.E.g. ೦, ೧, ೨, ೩, ೪, ೫, ೬, ೭, ೮, ೯,

Lao Lao numerals.E.g. ໐, ໑, ໒, ໓, ໔, ໕, ໖, ໗, ໘, ໙,

Malayalam Malayalam numerals.E.g. ൦, ൧, ൨, ൩, ൪, ൫, ൬, ൭, ൮, ൯,

NKo N'ko numerals.E.g. ߉ ,߈ ,߇ ,߆ ,߅ ,߄ ,߃ ,߂ ,߁ ,߀,

Oriya Oriya numerals.E.g. ୦, ୧, ୨, ୩, ୪, ୫, ୬, ୭, ୮, ୯,

Tamil Tamil numerals.E.g. ௦, ௧, ௨, ௩, ௪, ௫, ௬, ௭, ௮, ௯, ௰, ... ௱, ...௲

Thai Thai numerals.E.g. ๐, ๑, ๒, ๓, ๔, ๕, ๖, ๗, ๘, ๙ ...

Khmer Khmer numerals.E.g. ០, ១, ២, ៣, ៤, ៥, ៦, ៧, ៨, ៩,

Mongolian Mongolian numerals.E.g. ᠐, ᠑, ᠒, ᠓, ᠔, ᠕, ᠖, ᠗, ᠘, ᠙,

Telugu Telugu numerals.E.g. ౦, ౧, ౨, ౩, ౪, ౫, ౬, ౭, ౮, ౯,

Tibetan Tibetan numerals.E.g. ༠, ༡, ༢, ༣, ༤, ༥, ༦, ༧, ༨, ༩,


Appendix 4Summary of element properties &values

Introduction

This Appendix comprises a summary of element properties and values.

Appendix 4 – Summary of element properties & values


MiramoXML element

MiramoXML Opdf filename

mfd filename

PDFbookmarks all | none | n

cropMarks N | Y

mediaSize a3 | a4 | a5 | b5 | tabloid | legal | letter | ndimndim

language key (See Table A 2.1 on pages 223–223.)

showProperties N | Y



Inline markup elements

AFrame

Frame dimensions

width dim

height dim

Content auto wrapping

wrapContent N | Y

Anchored frame location



sideOffset dim

verticalOffset dim

Text runaround gap

runAroundGap dim

sideGap dim

belowGap dim


startIndent dim

endIndent dim


penWidth dim


penColor name

penTint percent

penOpacity 0 | 100


fillColor name

fillTint percent

fillOpacity 0 | 100

Include title

objectTitle N | Y

Sub-elements:<ObjectTitle properties >content</ObjectTitle><description language ="name" >content</description>

ATextFrame

Overall dimensions

width dim

minimumHeight dim

maximumHeight dim

Anchored text frame location



sideOffset dim

verticalOffset dim

Text runaround gap

runAroundGap dim

sideGap dim



ATextFrame ContinuedbelowGap dim


penWidth dim


penColor name

penTint percent

penOpacity 0 | 100


fillColor name

fillTint percent

fillOpacity 0 | 100

Text frame inside margins (for text frame within <ATextFrame>)

allMargins dim

leftMargin dim

topMargin dim

rightMargin dim

bottomMargin dim

Include title

objectTitle N | Y


Cell (in <Row>)

Cell background

fillColor color

fillOpacity 0 | 100

fillTint percent

Cell border rulings

startRule name

topRule name

endRule name

bottomRule name

Vertical alignment of cell text


Rotation of cell text

cellOrientation 0 | +90 | -90

Column and row span properties

columnSpan int | remainder

rowSpan int

Cell margins

allMargins dim

startMargin dim

topMargin dim

endMargin dim

bottomMargin dim



ChangeBarBegin

General properties

changeBarDef name

id string




width dim

colorDef dim

opacity percent

offset dim

ChangeBarEnd

General properties

id string

Chapter

Format definitions

mfd filename

Chapter numbering

chapterNumberStyle key

chapterNumberStart increment | int

Page numbering

pageNumberStyle key


Paragraph numbering


Page starting side

startSide Left | Right | continue

Contents (must include <ContentsInclude>)

contentsDef name

position normal | topOfColumn | topOfPage | topOfLeftPage | topOfRightPage

chapterOnly N | Y

ContentsInclude (in <Contents>)

Specify paragraph types to include

names namelist

Contents list formatting properties

endMargin dim

Sub-elements:<paragraphText [keepFormatting = "N | Y"] fontProperties /><paragraphLabel [type ="runin | fixed"] [numberOnly = "N | Y"] [labelIndent = "auto |

dim"] [labelWidth = "dim"] [textAlign = "start | end | justify"] fontProperties /><paragraphNumber [type ="runin | fixed"] [labelIndent = "auto | dim"] [labelWidth =

"dim"] [textAlign = "start | end | justify"] fontProperties /><leader fontProperties >content</leader><pageNumber fontProperties /> 



currentPageNumber

Font properties

Date

Date format

dateDef name

FNote


paraDef name

Font


fontDef name


fontFamily name

textSize dim | rdim

fontAngle name

fontWeight name

textColor name

textOpacity 100 | 0


Text capitalization




Font features

fontFeatures N | Y







underlineColor name

textOverline N | Y

strikeThrough N | Y

fillColor name

fillTint percent

fillOpacity 100 | 0

Line breaking

lineBreak Y | N

hyphenate Y | N

maximumHyphens int



minimumWordSize int






Font ContinuedallowLineBreakAfter chars


textKern Y | N

ligatures N | Y

textSpread percent

letterSpacing N | Y





superscript N | Y

subscript N | Y


Specify prefix and suffix text

prefix string

Frame

Dimensions

width | W dim

height | H dim

Position

left | L dim

top | T dim


penWidth dim


penColor name

penTint percent

penOpacity 0 | 100


fillColor name

fillTint percent

fillOpacity 0 | 100

HyperCmd

General hypertext properties

file filename

openURL url

jumptopage firstpage | lastpage | nextpage | prevpage | int

jumptodest string

Hyper command font properties

Image

Import properties (1)

file filename

Image location

left dim

top dim



Image Continued

Image dimensions

width dim

height dim


fillColor name

fillTint percent

fillOpacity 0 | 100

Image rotation

rotate degrees

keepAspectRatio N | Y

dpi int

pdfPageNumber int

Sub-elements:<imageReplace locationName = "name" [active = "Y | N"] [align = "topLeft | topRight | bot-

tomLeft | bottomRight"] [fit = "width | height | withinBox | adjust | fromImage"] [dpi = "int"][crop = "Y | N"] />

ImageDef

Replacement file

file none | filename

locationName name

Index

Index format name and selector properties

indexDef string

names namelist

Sub-elements:<levelFormat paraDef="name" /><entrySuffix>content</entrySuffix><pageReferenceSeparator fontProperties >content</pageReferenceSeparator><pageRangeSeparator fontProperties >content</pageRangeSeparator><pageNumber entryType="normal | primary" fontProperties />

IX

Define index entry

name string

pageType single | start | end | nopage

sortKey string

entryType normal | primary

Index entry font properties

Sub-elements:<IXsub [sortKey="string"] fontProperties />

lastPageNumber

Font properties

Line

Line position, length and angle

left dim



Line Continuedtop dim

length dim

angle number

Line pen properties

penWidth dim


penColor name

penTint percent

penOpacity 0 | 100

ListLabel (in or <ParaDef>)

Label format

type runin | fixed

Label position properties

labelIndent auto | dim

labelWidth dim

Label formatting properties

textAlign start | end | justify

lineSpacing dim

firstLineIndent dim

startIndent dim

endIndent dim

Label font properties

Autonumbered series

seriesLabel string

PDF bookmark properties

showInPDFbookmark N | Y

Sub-elements: <Var varDef ="name" /><counter [numberStart ="increment | int"] [numberStyle = "key | hidden"] [parent = "para-

graph format "] [hideParentNumber = "N | Y"] [numberPrefix = "string"] [ fontProperties ]/>

<leader [ fontProperties ] >content </leader><chapterNumber/><Image file = "filename" (required) width = "dim" height = "dim" top = "dim" />

MathML


mathMLDef name

file filename

Equation dimensions

Equation location




sideOffset dim

verticalOffset dim



MathML Continued

Text runaround gap

runAroundGap dim

sideGap dim

belowGap dim


spaceAbove dim

spaceBelow dim


startIndent dim

endIndent dim


fontFamily name

textSize dim

textColor name



Margins

startMargin dim

topMargin dim

endMargin dim

bottomMargin dim

Border rulings

startRule name

topRule name

endRule name

bottomRule name


fillColor name

fillTint percent

fillOpacity 0 | 100


MkDest

Hypertext and X-ref type and destination

id string

ObjectTitle

Default paragraph format

paraDef name

Title location properties


titleGap dim

Title area margin properties

marginAbove dim

marginBelow dim



ObjectTitle Continued


penWidth dim


penColor name

penTint percent

penOpacity 0 | 100


fillColor name

fillTint percent

fillOpacity 0 | 100

P (see <ParaDef> element on page 255 for additional element properties)

startID string

endID string

Sub-elements:<endTab fontProperties >content</endTab><paraFrame [ fillColor = "name" ] [ fillTint = "percent" ] [ fillOpacity = "percent" ]

[ topMargin = "dim" ] [ endMargin = "dim" ] [ bottomMargin = "dim" ] [ startRule ="name" ] [ topRule = "name" ] [ endRule = "name" ] [ bottomRule = "name" ] />

ParaGroup

Reference pre-defined list format

paraGroupDef name


spaceAboveParaGroup dim

spaceBelowParaGroup dim

Row (in <Tbl>)

Row type and location

type header | body | footer

withNext N | Y

withPrevious N | Y

Row height

maximumHeight dim

minimumHeight dim

height dim

Cell properties

Cell background (default for all cells in row)

fillColor color

fillOpacity 0 | 100

fillTint percent

Cell border rulings (default for all cells in row)

startRule name

topRule name

endRule name

bottomRule name

Cell margins (default for all cells in row)

allMargins dim



Row Continued (in <Tbl>)

startMargin dim

topMargin dim

endMargin dim

bottomMargin dim

Vertical alignment of cell text (default for all cells in row)


RunningText


runningTextDef name

Sub-elements:deftext

 <paragraphText names="namelist" [select="first | last"] keepFormatting = "N | Y" /><paragraphLabel names="namelist" select="first | last" /><paragraphNumber names="namelist" select="first | last" /><marker names="namelist" select="first | last" />

RunningTextMarker

Marker text for background text frame

name string


 

Section sectionDef name


hyphenate Y | N

maximumHyphens int



minimumWordSize int



oddPages name

evenPages name

allPages name


lastPage name


emptyPage name

emptyEvenPage name

emptyOddPage name


Page name



Section Continued

Page numbering


pageNumberStyle key

Paragraph numbering


feather N | Y

Tbl

Reference pre-defined table format

tblDef name

Width of table with proportional column(s)

width dim | column

Increase or chop column count

columns int

Basic properties

startIndent dim

endIndent dim

spaceAbove dim

spaceBelow dim



minimumRows int

Cell margins (default for all cells in table)

allMargins dim

startMargin dim

topMargin dim

endMargin dim

bottomMargin dim


fillColor color

fillOpacity 0 | 100

fillTint percent












startRule name

topRule name

endRule name

bottomRule name



Tbl Continued


bodyRowRule name



Column rulings

columnRule name

Footnote properties


fNoteDef name

TblColumn


width dim | p*

columns int

minimumWidth dim

TblContinuation (in <TblTitle> or within a within a <Cell> in a header row)

tblContinuationDef default | name

TblTitle (in <Tbl>)

Positioning properties


titleGap dim

TextFrame

Reference pre-defined text frame format

textFrameDef name

Type setting



width dim

height dim

Text frame position

left dim

top dim

Multi-column layout

columns int

columnGap dim


penWidth dim


penColor name

penTint percent

penOpacity 0 | 100


fillColor name

fillTint percent

fillOpacity 0 | 100



Var

Name of variable to include at this point

varDef name

XRef

Cross-reference format name and ID

xRefDef name

id string



Format definition elements

ChangeBarDef

General properties

changeBarDef name




width dim

colorDef dim

opacity percent

offset dim

ColorDef

Color format name

colorDef name

CMYK values

cyan | c percent

magenta | m percent

yellow | y percent

black | k percent

RGB values

red | r percent

green | g percent

blue | b percent

ContentsDef

Contents format name

contentsDef default | name


chapterOnly N | Y

Sub-elements:<ContentsInclude properties >sub-elements</ContentsInclude>

DateDef

Define a date format

dateDef name


 <second/>content<second00/><minute/><minute00/><hour/><hour01/><hour24/><ampm/><AMPM/>



DateDef Continued<dayNumber/><dayNumber01/><dayName/><shortDayName/><monthNumber/><monthNumber01/><monthName/><shortMonthName/><year/><shortYear/>

DocDef

Page size properties

width dim

height dim

Pagination properties

doubleSided N | Y


hyphenate Y | N

maximumHyphens int



minimumWordSize int


Page numbering


pageNumberStyle key

Paragraph numbering



oddPages name

evenPages name

allPages name


lastPage name


emptyPage name

emptyEvenPage name

emptyOddPage name

Default bitmap image scaling

defaultDPI int

Footnote properties

fNoteDef name

FNoteDef

Footnote format name

fNoteDef name



FNoteDef Continued

Anchor properties

anchorPosition superscript | baseline | subscript

anchorFontDef name

anchorPrefix string

anchorSuffix string

Numbering

numberStyle custom | key

numberSequence list

numberRestart perDocument | perPage

Footnote ruling

rule Y | N

Footnote instance formatting

paraDef name

labelFontDef name

labelWidth dim

labelAlign start | center | end

labelIndent dim

labelPrefix string

labelSuffix string

Footnote gap

minimumGap name

Sub-elements:<FNoteSeparator minimumGap="dim " ruleGap="dim" ruleStart="dim" ruleLength="dim |

percent" penProperties/>

FontDef

IndexDef

Index format name

indexDef string

Index contents selection

names namelist

Collation properties

language unicode | key (See Table A 2.1 on pages 223–223.)

casePrecedence default | lower | upper

ignorePunctuation N | Y

ignoreSpace N | Y

numberOrdering Y | N

specialCollation phonebook | big5han | hindiDirect | gb2312han | pinyin | stroke | tradi-tional

Group titles

groupTitles Y | N

Sub-elements:<groupTitles paraDef="name" paragraphProperties >content</groupTitles><groupTitle before="string" >content</groupTitle><levelFormat paraDef="name" /><entrySuffix>content</entrySuffix><pageReferenceSeparator fontProperties >content</pageReferenceSeparator>



IndexDef Continued<pageRangeSeparator entryType="normal | primary" fontProperties

>content</pageRangeSeparator><pageNumber entryType="normal | primary" fontProperties />

MathMLDef


mathMLDef name

Equation location




sideOffset dim

verticalOffset dim

Text runaround gap

runAroundGap dim

sideGap dim

belowGap dim


spaceAbove dim

spaceBelow dim


startIndent dim

endIndent dim


fontFamily name

textSize dim

textColor name



Margins

startMargin dim

topMargin dim

endMargin dim

bottomMargin dim

Border rulings

startRule name

topRule name

endRule name

bottomRule name


fillColor name

fillTint percent

fillOpacity 0 | 100

Include title

objectTitle N | Y

Sub-elements:<ObjectTitle properties />



MathMLDef Continued

MetaData name copyright | createdDate | creator | description | keyword | modified-

Date | publisher | rights | subject | title

PageDef

Create new master or reference page

pageDef name

width dim

height dim

ParaDef

Paragraph format name

paraDef name


fontFamily name

textSize dim

fontAngle name

fontWeight name

textColor name

textOpacity 100 | 0




firstLineIndent dim

startIndent dim

endIndent dim


Line spacing

spaceAbove dim

deltaSpaceAbove dim

spaceBelow dim

leading dim


Paragraph placement


minimumLines int


withPrevious N | Y


listLabel Y | N


Text capitalization




Font features

fontFeatures N | Y




ParaDef Continued






underlineColor name

textOverline N | Y

strikeThrough N | Y


fillColor name

fillTint percent

fillOpacity 100 | 0

paraFrame Y | N

Line breaking

hyphenate Y | N

maximumHyphens int



minimumWordSize int






textKern Y | N

ligatures N | Y

textSpread percent

letterSpacing N | Y







Reference frames above and below



Sub-elements:<paraFrame [ fillColor = "name" ] [ fillTint = "percent" ] [ fillOpacity = "percent" ]

[ topMargin = "dim" ] [ endMargin = "dim" ] [ bottomMargin = "dim" ] [ startRule ="name" ] [ topRule = "name" ] [ endRule = "name" ] [ bottomRule = "name" ] />

ParaGroupDef

Defined list format

paraGroupDef name


spaceAbove dim



ParaGroupDef ContinuedspaceBelow dim

RuleDef

Table ruling names and properties

ruleDef name

penWidth dim

penColor name

penTint percent

RunningTextDef (in background <TextFrameDef>)


runningTextDef name


 <paragraphText names="namelist" select="first | last" keepFormatting = "N | Y" /><paragraphLabel names="namelist" select="first | last" /><paragraphNumber names="namelist" select="first | last" /><marker names="namelist" select="first | last" />

SectionDef

Section format name

sectionDef name


hyphenate Y | N

maximumHyphens int



minimumWordSize int



oddPages name

evenPages name

allPages name


lastPage name


emptyPage name

emptyEvenPage name

emptyOddPage name


Page name

Page numbering


pageNumberStyle key

Paragraph numbering




SectionDef Continuedfeather N | Y

TblDef

Table format name

tblDef name

Basic properties

startIndent dim

endIndent dim

spaceAbove dim

spaceBelow dim



minimumRows int

allMargins dim

startMargin dim

topMargin dim

endMargin dim

bottomMargin dim


fillColor color

fillOpacity 0 | 100

fillTint percent












startRule name

topRule name

endRule name

bottomRule name


bodyRowRule name



Column rulings

columnRule name

Footnote properties




TblDef ContinuedfNoteDef name

TblColumnDef


width dim | p*

columns int

minimumWidth dim

Sub-elements:<TblColumnFormat paraDef="name" [ rowType = "header | body | footer" ] />

TblContinuationDef tblContinuationDef name


 

TextFrameDef (in <PageDef>)

Type, flow and auto-connect settings

textFrameDef name



width auto | dim

height dim

Text frame position

left auto | dim

top dim

Top margin

topMargin dim

Multi-column layout

columns int

columnGap dim


penWidth dim


penColor name

penTint percent

penOpacity 0 | 100


fillColor name

fillTint percent

fillOpacity 0 | 100

VarDef

Define (assign value to) variable

varDef name


 



VarDef Continued

XRefDef

Define cross-reference format

xRefDef name


 <pageNumber/><paragraphText keepFormatting = "N | Y" /><paragraphLabel/><paragraphNumber/>

Documents

Miramo · Contents mmComposer Reference Guide (v 1.5) iii Font selection