ArborX


tformat

Longname: t format   Open the Documentation Legend
Released: not available 
Created: not available 
Last modified: 8.10k 
See also: tfcmodes tfmtlog tpacopy trf tindmk ttocmk

Summary
Re-formats the current document. Re-formatting a document using tformat correctly positions footnotes and anchored frames and is more powerful and effective than trf or wdr.
Example extract

The macro below formats the whole document, using index and contents control streams ic1 and cc1:

 tformat "ic1","cc1"

Syntax (SVNNA)
tformat Ø
tformat  ?:L?  ;:L?  start page:n?  end page:n?  scan fwd:n?  )  )  ic stream:t?  cc stream:t?  ac stream:t?  )  )  repos anchors:n?  autocopy create:n?  autocopy purge:n?  freeze create:n?  freeze purge:n?  )  )  )  )
Ø:

The whole document is re-formatted without using control streams.

?:L

Invokes the re-format dialogue box.

;:L

Followed by the option number listed below, this parameter specifies which page to go to after formatting. For example "tformat ;1" - tformat whole doc and stay on last page. This can be useful before a freeze because it ensures that the freeze will use the page information generated by the tformat and not some subsequent trf which may desynchronise it.

Goto First
Goto Last
Goto Start of document.
start page:n

The start page of the range of pages to be re-formatted. If this parameter is omitted, Arbortext APP will re-format the entire document.

end page:n

The end page of the range of pages to be re-formatted. If this parameter is omitted, Arbortext APP will re-format the entire document.

scan fwd:n

The 'forward scan limit'; the number of paragraphs Arbortext APP should scan ahead when moving paragraphs to fill the available space in a frame for which Fill mode has been enabled with tfcol and tffill. Forward Scan is unique in that it is the only feature that can change your main text stream during formatting and for this reason it is well protected. The feature is only available through tformat and even then it must be specifically altered from its default value of 0, in effect giving Arbortext APP 'permission' to change your text stream as necessary. In the event that re-formatting produces unsatisfactory results or modifies your text in an unacceptable way then selecting [Edit/Undo], (tundo) will restore all changes made; it may then be necessary to perform another format to restore Arbortext APP's internal structures.

ic stream:t

Index control stream to be used during re-formatting to generate an index. See tindmk

cc stream:t

Contents control stream to be used during re-formatting to generate a table of contents. see ttocmk

ac stream:t

Anchor control stream, controlling the position of anchored frames within the document.

repos anchors:n
Removal and replacement of anchored frames will not be performed during this format.
Ø or 1  Frames which have an anchor name will be removed from the specified range of pages before formatting begins. Whenever frame references are found, with matching frame names, the appropriate frames will be replaced in the document (possibly using anchor conditions as specified in the ac stream control stream). Any frames which have not been replaced at the end of the format operation will be returned to their original page and position.
autocopy create:n
'Master' pages will not be duplicated (as 'Copied' pages) in order to format to the end of a main text stream.
Ø or 1  Whenever Arbortext APP finds a 'Master' page (see tpacopy), that page will be duplicated (as 'Copied' pages) enough times to ensure that the associated text stream is formatted to its end.
autocopy purge:n
'Copied' pages within the specified range of pages will not be removed from the document before formatting begins. This may be useful if manual changes have been made to 'Copied' pages which need to be preserved (this is not recommended).
Ø or 1  All 'Copied' pages within the specified range of pages which also have an associated 'Master' page within that range will be removed from the document before formatting begins. This allows the AutoCopy feature to start with a minimum-sized document and increase it to the number of pages necessary. It may sometimes be appropriate to set autocopy purge to 1 and autocopy create to 0 to reduce the document to the minimum number of pages, for example, to prepare a template under development for saving.
freeze create:n
Additional pages will not be inserted.
Ø or 1  Additional pages which are necessary will be inserted.
freeze purge:n
Previously added pages will not be removed.
Ø or 1  Previously added pages will be removed before the format.
Example

This example will format pages 15 to 30 without control streams.

 tformat 15,30
Example

The macro below uses the wdb macro to get then number of the current page from the Goto page dialogue box, and then uses the current page number as parameters to tformat. This is a more thorough re-formatting than trf alone provides, and is most useful when assigned to a keystroke, which you can then, for example, use after adding a footnote reference:

 (wdb "Current"):(tpgoto):(tformat ^current,^current^)

Document created on 08-Feb-2003, last reviewed on 26-Aug-2005 (revision 2)