doc_incomplete
doc_incomplete ([doc[, flags]])
This function returns 1 (true) if the document specified by doc is currently marked incomplete. If the flags parameter is specified and non-zero, then a check_completeness command is run first to update the incomplete status.
|
|
Normally, once a document is marked incomplete, the state is not reset until a completeness check is requested.
|
The flags parameter is a bitmask that controls the options passed to the check_completeness command. It is constructed by using OR for the flags from the following list:
• 1 — run the check_completeness command
If this value is used alone, the function checks the document for completeness and sets its completeness flag to 0 or 1 accordingly.
If this value is not specified, but 2, 4, or 8 are, it is assumed that 1 was also specified.
• 2 — do not insert missing required elements
• 4 — generate error messages from the check_completeness command, including any parser error messages caused by the loading of required file entities, and display them in dialog windows as needed
• 8 — generate error messages from the check_completeness command, but do not display them in a window
With this flag set, a completeness check will complete without stopping to wait for a user to acknowledge message windows.
Each message generated is offered to ACL code via the context error hook. A batch ACL script can use doc_incomplete(doc, 8) to execute a full completeness check and obtain errors without any dialogs being displayed.
If both 4 and 8 are set, 8 is ignored.
Note the following when working with doc_incomplete():
• If flags is omitted or 0, the check_completeness command is not run.
• If doc is omitted or 0, the current document is used.
• Running doc_incomplete() will only include checks for empty elements if this combination of settings exists:
◦ The preference emptyelementswarnings is set to on (this is not the default value)
◦ doc_incomplete() specifies flag 4 or flag 8
Related Topics
