PDFlib Text Extraction Toolkit (TET) Manual

10.8 TET Markup Language (TETML) Functions
C++ int process_page(int doc, int pagenumber, string optlist)
C# Java int process_page(int doc, int pagenumber, String optlist)
Perl PHP long TET_process_page(resource tet, long doc, long pagenumber, string optlist)
VB Function process_page(doc As Long, pagenumber As Long, optlist As String) As Int
C
int TET_process_page(TET *tet, int doc, int pagenumber, const char *optlist)
Process a page and create TETML output.
doc A valid document handle obtained with TET_open_document*( ).
pagenumber The physical number of the page to be processed. The first page has page
number 1. The total number of pages can be retrieved with TET_pcos_get_number( ) and
the pCOS path length:pages. The pagenumber parameter may be 0 if trailer=true.
optlist An option list specifying options from the following groups:
> General page-related options according to Table 10.5 (these will be ignored if
pagenumber=0): clippingarea, contentanalysis, excludebox, fontsizerange, granularity,
ignoreinvisibletext, imageanalysis, includebox, layoutanalysis, skipengines
> Option specifying processing details according to Table 10.13: tetml
Table 10.13 Additional options for TET_process_page( )
option
tetml
description
(Option list) Controls details of TETML. The following options are available:
glyphdetails
(Option list; only for granularity=glyph and word) Specify which members of the TET_char_
info structure will be reported for each Glyph element:
geometry (Boolean) Emit attributes x, y, width, alpha, beta. Default: false
font (Boolean) Emit attributes font, fontsize, textrendering, unknown. Default:
false
trailer (Boolean) If true, document trailer data, i.e. data after the last page, will be emitted (it must
be appended to the page-specific data emitted earlier). This option is required in the last call
to this function in order to emit trailer data. If pagenumber=0 only trailer data (without any
page-specific data) will be emitted. Once trailer=true has been supplied, no more calls to
TET_process_page( ) are allowed for the same document. Default: false
Returns
Details
-1 on error, or 1 otherwise. However, in TETML mode this function will always succeed
since problems related to the input document will be reported in a TETML element, and
all other problems will raise an exception.
This function will open a page, create output according to the format-related options
supplied to TET_open_document*( ), and close the page. The generated data can be retrieved
with TET_get_xml_data( ).
This function must only be called if the option tetml has been supplied in the corresponding
call to TET_open_document*( ). Header data, i.e. document-specific data before
the first page, will be created by TET_open_document*( ) before the first page data. It can
be retrieved separately by calling TET_get_xml_data( ) before the first call to TET_process_
page( ), or in combination with page-related data.
10.8 TET Markup Language (TETML) Functions 149