DOCWRTALTOXMLOPTIONS (original) (raw)
Summary
The DOCWRTALTOXMLOPTIONS structure provides information about an Analyzed Layout and Text Object format (ALTO XML).
Syntax
typedef struct _DOCWRTALTOXMLOPTIONS
{
[DOCWRTOPTIONS](docwrtoptions.html) Options;
[DOCWRTALTOXMLMEASUREMENTUNIT](docwrtaltoxmlmeasurementunit.html) MeasurementUnit; // Default = DOCWRTALTOXMLMEASUREMENTUNIT_MM10
[L_TCHAR](leadtools-basic-data-types.html) *FileName; // Optional
[L_TCHAR](leadtools-basic-data-types.html) *ProcessingDateTime; // Optional
[L_TCHAR](leadtools-basic-data-types.html) *ProcessingAgency; // Optional
[L_TCHAR](leadtools-basic-data-types.html) *ProcessingStepDescription; // Optional
[L_TCHAR](leadtools-basic-data-types.html) *ProcessingStepSettings; // Optional
[L_TCHAR](leadtools-basic-data-types.html) *SoftwareCreator; // Optional
[L_TCHAR](leadtools-basic-data-types.html) *SoftwareName; // Optional
[L_TCHAR](leadtools-basic-data-types.html) *SoftwareVersion; // Optional
[L_TCHAR](leadtools-basic-data-types.html) *ApplicationDescription; // Optional
[L_INT](leadtools-basic-data-types.html) FirstPhysicalPageNumber; // Default = 1
[L_BOOL](leadtools-basic-data-types.html) Formatted; // Default = L_FALSE (output formatted XML, if L_TRUE, Indentation is used)
[L_TCHAR](leadtools-basic-data-types.html) Indentation[80]; // Default = " "
[L_UINT](leadtools-basic-data-types.html) uFlags; // Default = 0. One or more DOCWRT_ALTOXML_xxx flags (eg: DOCWRT_ALTOXML_Sort)
[L_INT](leadtools-basic-data-types.html) nDesiredVersion; // Default = 4. Only 4 is supported at the moment
} DOCWRTALTOXMLOPTIONS, *pDOCWRTALTOXMLOPTIONS;
Members
DOCWRTOPTIONS Options
Options structure containing options for the ALTO XML format.
DOCWRTALTOXMLMEASUREMENTUNIT MeasurementUnit
The measurement unit to use. The default value is DOCWRTALTOXMLMEASUREMENTUNIT_MM10.
L_TCHAR *FileName
Optional string containing the file name.
L_TCHAR *ProcessingDateTime
Optional string containing the processing date/time.
L_TCHAR *ProcessingAgency
Optional string containing the processing agency.
L_TCHAR *ProcessingStepDescription
Optional string containing the processing step description.
L_TCHAR *ProcessingStepSettings
Optional string containing the processing step settings.
L_TCHAR *SoftwareCreator
Optional string containing the software creator.
L_TCHAR *SoftwareName
Optional string containing the software name.
L_TCHAR *SoftwareVersion
Optional string containing the software version.
L_TCHAR *ApplicationDescription
Optional string containing the application description.
L_INT FirstPhysicalPageNumber
The first physical page number. Default = 1.
L_BOOL Formatted
TRUE to output formatted XML using the value of Indentation. Default = FALSE.
L_TCHAR Indentation[80]
String containing the values to be used for indentation when Formatted is TRUE. Default is " ".
L_UINT uFlags
Optional flags parameter that can contain several of the values listed below. The flags can be combined using the bitwise OR operation ( | ). Default = 0. Possible values are:
| Value | Meaning |
|---|---|
| DOCWRT_ALTOXML_Sort | [0x00000001] If set, the text will be sorted from top-left to bottom-right; otherwise, the text will be saved to the output file in the same order as the input data. |
| DOCWRT_ALTOXML_PlainText | [0x00000002] If set, the font information will be discarded and the text will be written without any font style. |
| DOCWRT_ALTOXML_ShowGlyphInfo | [0x00000004] If set, extra information is displayed for each glyph (position, bounding rectangle). |
| DOCWRT_ALTOXML_ShowGlyphVariants | [0x00000008] If set, text from OCR will display variants for some glyphs. This options is used only when the input comes from an OCR operation. This flag implies DOCWRT_ALTOXML_ShowGlyphInfo. |
L_INT nDesiredVersion
Can be used to specify that the output should conform to a particular version of the AltoXML specification. The only supported value at the moment is 4.
Comments
pDOCWRTALTOXMLOPTIONS is a pointer to a DOCWRTALTOXMLOPTIONS structure. Generally, where a function parameter type is pDOCWRTALTOXMLOPTIONS, you can declare a DOCWRTALTOXMLOPTIONS variable, update the structure's fields, and pass the variable's address in the parameter. Declaring a pDOCWRTALTOXMLOPTIONS variable is necessary only if your program requires a pointer.
ALTO (Analyzed Layout and Text Object) is an open XML Schema developed by the Library of Congress for OCR text and layout information.
The LEADTOOLS Document Writers support creating ALTO documents. The following features are supported:
- Unlimited number of pages
- Fully searchable documents
- Full support for ALTO standard XML elements and attributes
The uStructSize at Options structure should be set to the size of DOCWRTALTOXMLOPTIONS, Use the sizeof() operator to calculate this value.
The structure is used by: