Arbortext Command Language > Commands > preview
  
preview
preview [ onepass | allpasses | noformat | noprompt | quit | stop] [ auto | force] [ wait | nowait]
This command formats the current document and displays it in the Print Preview window. The abbreviation pre is a valid substitute for preview.
onepass — (The default.) Displays the document in the Print Preview window after performing a single formatting pass. If one pass is not sufficient for final output, then the Arbortext Editor status bar will indicate re-fmt needed and another preview command will trigger another pass.
* 
The onepass option is the default for the preview command, but allpasses is the default for the print command.
allpasses — Displays the document in the Print Preview window after performing as many formatting passes as necessary for final output. Arbortext Editor performs one pass if there are no page number references in the document, or if the value of the page numbers can be correctly inferred from a previous formatting operation during the current Arbortext Editor session.
noformat — Displays the document in the Print Preview window using the existing formatting data file (.dvi file) for the document (if it exists). Use this option carefully. It is useful if you need draft output for a large document in a hurry and do not want to take the time to reformat minor changes you have made. It could also be used in carefully controlled applications to format in one Arbortext Editor session, and print or preview in another Arbortext Editor without the need to reformat the document.
If formatting was done in a previous Arbortext Editor session, then Arbortext Editor's ability to match the display in the Print Preview window to the cursor location in the Edit view is disabled until a formatting pass has been done in the current Arbortext Editor session.
The force and auto arguments have no effect when noformat is specified.
The preview noformat command does not affect the document's formatting status (that is, fmt-needed, refmt-needed).
noprompt — Suppresses the Print Preview window. This option is ignored when publishing using Arbortext Publishing Engine.
When noprompt is in effect, the print stylesheet (as specified by the printstylesheet Advanced Preference and set option) is used to generate the preview of the document. If no print stylesheet is set, the edit stylesheet is used.
Independent of this option, the Print Preview window is suppressed when publishing without using Arbortext Publishing Engine when the document’s document type has its AllowComposeStylesheetlist attribute set to no in the .dcf file.
quit — Closes the Print Preview window and continues formatting.
stop — Halts document formatting and leaves the Print Preview window open.
auto — (The default.) Lets Arbortext Editor decide whether the document needs to be formatted or not before being previewed. Arbortext Editor will trigger formatting if the document has not been formatted yet during the current session, or if the previous formatting command left the document in the refmt-needed state, or if the document has been modified since the preceding formatting command. If the document is up to date with regard to formatting, then preview auto will cause Arbortext Editor to position the Print Preview window to the page containing the cursor.
force — Performs at least one formatting pass regardless of whether Arbortext Editor thinks it is necessary.
wait — Makes editing unavailable in Arbortext Editor until a preview request completes.
nowait — (The default.) Allows editing in Arbortext Editor while a preview request is being processed.
Examples
preview (invokes preview onepass auto)
pre onepass
pre onepass force
pre allpasses auto
pre stop
pre quit
Related Topics
format command
print command
Formatting pass reduction in ACL