Line Numbering
PTC Arbortext Layout Developer can output labels on a page to indicate the line number.
Line numbering is provided as a frame property. You can define a set of line numbering options and then apply it to one or more frames. With this, footnotes, headers, footers and floats can be included in the line numbering for a page.
|
To ensure line numbering is correct, you must ensure that the fields in a frame are set to be formatted in the relevant order.
|
Line numbers are output on the same level as frame guides and other guides. They can be printed if required. When printing to PDF, you can print line numbers to their own PDF layer. They can then be deactivated by the reader if required.
Properties for line numbering can either be set in the PTC Arbortext Layout Developer UI, or defined with JavaScript/FOM code. These properties are available:
• Color — Standard or custom (named) color
• Font
• Text height
• Prefix — string to be output before the number
• Number format — numbering sequence to use
• Number separator — character inserted into the number string after a specified number of numbers (separator width), for example a comma every 3 characters in 1,000,000
• Number separator width — number of characters between each separator
• Location — the horizontal position with relation to a specific part of the page
◦ Line edge
◦ Frame edge
◦ Column edge
◦ Page edge
• Side — position with relation to the specified location
Left or right
• Offset — the size of offset from the specified location
• Ignore empty lines — do not number lines that do not contain text
• Count — what to number:
◦ Paragraphs — number paragraph starts instead of individual lines
◦ Table column — number lines in table columns
• Restart — line numbering continuation options:
◦ continuous within a document
◦ restarted per frame
• Multiple — output number every x number of lines
You can also activate/deactive line numbers by setting an option in the PTC Arbortext Layout Developer UI or in JavaScript/FOM code.
UI Enhancements Supporting this Feature
• Line Numbering dialog box
The dialog box includes the options On and Off to activate or deactivate the generation of line numbering.
When On is selected, the dialog box presents the options for configuring line numbering.
You can use the tflinenum macro to invoke the dialog box.
• Line Numbers option in the Screen Draw Level (tdslevel macro) and Printer Draw Level (tdplevel macro) dialog boxes
Select these options to display line numbers in the WYSIWYG view and print output, respectively.
FOM Objects Supporting this Feature
• fLineNumbering object
The object defines properties for line numbering
• lineNumbering property for the fFrame object
The property specifies the fLineNumbering object that holds the required line numbering properties
• LineNumberReset() method for the fFormatting object
The method resets the current line number count to the specified value.
Macros and Processing Instructions Supporting this Feature
• The tdslevel and tdplevel macros include the option 33554432
The option specifies that line numbering should be displayed
For more information, see tdplevel and tdslevel.