Commande: HQ

HQ command description

Description: This command looks for a hidden reference in a document. The command returns the page number and the content (ASCII format) of the reference. This command returns the actual page numbers in a QuarkXPress document. You may use it, for example, to create indexes and TOCs.

Syntax: [ HQ = Reference ; WithText ]

Reference Long Integer	•	Unique number. 0 < numeric value < 0x7FFFFFFF. The reference is searched for in the internal tables of PageMakeUp.

WithText Boolean	•	This flag determines if the text must be returned. TRUE = Return text followed by [hf] FALSE = Return only page number

Note: This command implies permanent references for the blocks, so you must use block numbers > 2000. In the present version of PageMakeUp, references are hidden for the QuarkXPress user, but, however, the user may delete them. This may cause layout problems.

Example: [hq=25485; TRUE] This command looks for the reference 25485 in the document. If the reference is found, PageMakeUp returns (either in a file with the [ul] command, or in 4DPageLink) the following : [HQ=25485; "PageNum"]Referenced text[hf]. PageNum is the number of the page where the reference is located. The page number is the actual page number displayed on the bottom left of the QuarkXPress document. If the user has modified the page numbers, you will find here the actual number of the page (eventually different of the number used to create the document). Then, you find the referenced text ending with the [hq] command. If the reference is not found in the document, PageMakeUp returns [HQ=25485; -1]. The [hf] command delimiting the end of the referenced text is present only if the 'withText' parameter is TRUE and if the reference is found.

See also: [hd] Start Reference, [hf] End Reference

The • sign indicates a mandatory parameter