--- /dev/null
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+ <title>Libgedcom interface details</title>
+
+ <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1">
+</head>
+ <body>
+
+<h1 align="center">Libgedcom interface details</h1>
+ <br>
+
+<h2>Index</h2>
+
+<ul>
+ <li><a href="#Record_identifiers">Record identifiers</a></li>
+ <li><a href="#Element_identifiers">Element identifiers</a></li>
+ <li><a href="#Gedcom_val_types">Gedcom_val types</a></li>
+ <ul>
+ <li><a href="#struct_date_value">struct date_value</a></li>
+ <li><a href="#struct_date">struct date</a><br>
+ </li>
+ </ul>
+
+</ul>
+ <br>
+
+<hr width="100%" size="2">
+<h2><a name="Record_identifiers"></a>Record identifiers</h2>
+ The following table describes the identifiers to be used in the record callbacks.
+ The last column gives the <a href="#Gedcom_val_types"><code>Gedcom_val</code>
+ type</a> of the <code>xref</code> argument in the header start callback.<br>
+ <br>
+
+<table width="100%" border="1" cellspacing="2" cellpadding="2">
+ <tbody>
+ <tr>
+ <td valign="top" align="center"><b>Record</b><br>
+ </td>
+ <td valign="top" align="center"><b>Meaning</b><br>
+ </td>
+ <td valign="top" align="center"><b>Possible<br>
+ <code>xref</code> types</b><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>REC_HEAD</code><br>
+ </td>
+ <td valign="top">The header of the GEDCOM file<br>
+ </td>
+ <td valign="top"><code>NULL</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>REC_FAM</code><br>
+ </td>
+ <td valign="top">A record describing a family<br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>REC_INDI</code><br>
+ </td>
+ <td valign="top">A record describing an individual<br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>REC_OBJE</code><br>
+ </td>
+ <td valign="top">A record describing a multimedia object<br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>REC_NOTE</code><br>
+ </td>
+ <td valign="top">A record describing a note<br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>REC_REPO</code><br>
+ </td>
+ <td valign="top">A record describing a source repository<br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>REC_SOUR</code><br>
+ </td>
+ <td valign="top">A record describing a source<br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>REC_SUBN</code><br>
+ </td>
+ <td valign="top">A record describing the submission<br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>REC_SUBM</code><br>
+ </td>
+ <td valign="top">A record describing the submitter<br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>REC_USER</code><br>
+ </td>
+ <td valign="top">An application-specific record (the <code>tag</code>
+ in the start callback contains the actually used tag).<br>
+ </td>
+ <td valign="top"><code>NULL</code><br>
+ <code>STRING</code><br>
+ </td>
+ </tr>
+
+ </tbody>
+</table>
+
+<hr width="100%" size="2">
+<h2><a name="Element_identifiers"></a>Element identifiers</h2>
+The following table describes the identifiers to be used in the element callbacks.
+ The last column gives the <a href="file:///home/verthezp/src/external/gedcom-parse/doc/interface.html#Gedcom_val_types"><code>
+Gedcom_val</code> type</a> of the <code>val</code> argument in the element
+start callback. (TO BE COMPLETED)<br>
+<br>
+<table cellpadding="2" cellspacing="2" border="1" width="100%">
+ <tbody>
+ <tr>
+ <td valign="top" align="center"><b>Element</b><br>
+ </td>
+ <td valign="top" align="center"><b>Possible<br>
+tags<br>
+ </b><br>
+ </td>
+ <td valign="top" align="center"><b>Used within</b><br>
+ </td>
+ <td valign="top" align="center"><b>Possible<br>
+ <code>val</code> types<br>
+ </b><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_HEAD_SOUR</code><br>
+ </td>
+ <td valign="top"><code>SOUR</code><br>
+ </td>
+ <td valign="top"><code>REC_HEAD</code><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_HEAD_SOUR_VERS</code><br>
+ </td>
+ <td valign="top"><code>VERS</code><br>
+ </td>
+ <td valign="top"><code>ELT_HEAD_SOUR</code><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_HEAD_SOUR_NAME</code><br>
+ </td>
+ <td valign="top"><code>NAME</code><br>
+ </td>
+ <td valign="top"><code>ELT_HEAD_SOUR</code><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_HEAD_SOUR_CORP</code><br>
+ </td>
+ <td valign="top"><code>CORP</code><br>
+ </td>
+ <td valign="top"><code>ELT_HEAD_SOUR</code><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_HEAD_SOUR_DATA</code><br>
+ </td>
+ <td valign="top"><code>DATA</code><br>
+ </td>
+ <td valign="top"><code>ELT_HEAD_SOUR</code><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_HEAD_SOUR_DATA_DATE</code><br>
+ </td>
+ <td valign="top"><code>DATE</code><br>
+ </td>
+ <td valign="top"><code>ELT_HEAD_SOUR_DATA</code><br>
+ </td>
+ <td valign="top"><code>DATE</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_HEAD_SOUR_DATA_COPR</code><br>
+ </td>
+ <td valign="top"><code>COPR</code><br>
+ </td>
+ <td valign="top"><code>ELT_HEAD_SOUR_DATA</code><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_HEAD_DEST</code><br>
+ </td>
+ <td valign="top"><code>DEST</code><br>
+ </td>
+ <td valign="top"><code>REC_HEAD</code><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_HEAD_DATE</code><br>
+ </td>
+ <td valign="top"><code>DATE</code><br>
+ </td>
+ <td valign="top"><code>REC_HEAD</code><br>
+ </td>
+ <td valign="top"><code>DATE</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_HEAD_DATE_TIME</code><br>
+ </td>
+ <td valign="top"><code>TIME</code><br>
+ </td>
+ <td valign="top"><code>ELT_HEAD_DATE</code><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_HEAD_SUBM</code><br>
+ </td>
+ <td valign="top"><code>SUBM</code><br>
+ </td>
+ <td valign="top"><code>REC_HEAD</code><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_HEAD_SUBN</code><br>
+ </td>
+ <td valign="top"><code>SUBN</code><br>
+ </td>
+ <td valign="top"><code>REC_HEAD</code><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_HEAD_FILE</code><br>
+ </td>
+ <td valign="top"><code>FILE</code><br>
+ </td>
+ <td valign="top"><code>REC_HEAD</code><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_HEAD_COPR</code><br>
+ </td>
+ <td valign="top"><code>COPR</code><br>
+ </td>
+ <td valign="top"><code>REC_HEAD</code><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_HEAD_GEDC</code><br>
+ </td>
+ <td valign="top"><code>GEDC</code><br>
+ </td>
+ <td valign="top"><code>REC_HEAD</code><br>
+ </td>
+ <td valign="top"><code>NULL</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_HEAD_GEDC_VERS</code><br>
+ </td>
+ <td valign="top"><code>VERS</code><br>
+ </td>
+ <td valign="top"><code>ELT_HEAD_GEDC</code><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_HEAD_GEDC_FORM</code><br>
+ </td>
+ <td valign="top"><code>FORM</code><br>
+ </td>
+ <td valign="top"><code>ELT_HEAD_GEDC</code><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_HEAD_CHAR</code><br>
+ </td>
+ <td valign="top"><code>CHAR</code><br>
+ </td>
+ <td valign="top"><code>REC_HEAD</code><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_HEAD_CHAR_VERS</code><br>
+ </td>
+ <td valign="top"><code>VERS</code><br>
+ </td>
+ <td valign="top"><code>ELT_HEAD_CHAR</code><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_HEAD_LANG</code><br>
+ </td>
+ <td valign="top"><code>LANG</code><br>
+ </td>
+ <td valign="top"><code>REC_HEAD</code><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_HEAD_PLAC</code><br>
+ </td>
+ <td valign="top"><code>PLAC</code><br>
+ </td>
+ <td valign="top"><code>REC_HEAD</code><br>
+ </td>
+ <td valign="top"><code>NULL</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_HEAD_PLAC_FORM</code><br>
+ </td>
+ <td valign="top"><code>FORM</code><br>
+ </td>
+ <td valign="top"><code>ELT_HEAD_PLAC</code><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_HEAD_NOTE</code><br>
+ </td>
+ <td valign="top"><code>NOTE</code><br>
+ </td>
+ <td valign="top"><code>REC_HEAD</code><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_FAM_HUSB</code><br>
+ </td>
+ <td valign="top"><code>HUSB</code><br>
+ </td>
+ <td valign="top"><code>REC_FAM</code><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_FAM_WIFE</code><br>
+ </td>
+ <td valign="top"><code>WIFE</code><br>
+ </td>
+ <td valign="top"><code>REC_FAM</code><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_FAM_CHIL</code><br>
+ </td>
+ <td valign="top"><code>CHIL</code><br>
+ </td>
+ <td valign="top"><code>REC_FAM</code><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_FAM_NCHI</code><br>
+ </td>
+ <td valign="top"><code>NCHI</code><br>
+ </td>
+ <td valign="top"><code>REC_FAM</code><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_FAM_SUBM</code><br>
+ </td>
+ <td valign="top"><code>SUBM</code><br>
+ </td>
+ <td valign="top"><code>REC_FAM</code><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_INDI_RESN</code><br>
+ </td>
+ <td valign="top"><code>RES</code><code>N</code><br>
+ </td>
+ <td valign="top"><code>REC_INDI</code><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_INDI_SEX</code><br>
+ </td>
+ <td valign="top"><code>SEX</code><br>
+ </td>
+ <td valign="top"><code>REC_INDI</code><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_INDI_SUBM</code><br>
+ </td>
+ <td valign="top"><code>SUBM</code><br>
+ </td>
+ <td valign="top"><code>REC_INDI</code><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_INDI_ALIA</code><br>
+ </td>
+ <td valign="top"><code>ALIA</code><br>
+ </td>
+ <td valign="top"><code>REC_INDI</code><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_INDI_ANCI</code><br>
+ </td>
+ <td valign="top"><code>ANCI</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_INDI_DESI</code><br>
+ </td>
+ <td valign="top"><code>DESI</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_INDI_RFN</code><br>
+ </td>
+ <td valign="top"><code>RFN</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_INDI_AFN</code><br>
+ </td>
+ <td valign="top"><code>AFN</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_OBJE_FORM</code><br>
+ </td>
+ <td valign="top"><code>FORM</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_OBJE_TITL</code><br>
+ </td>
+ <td valign="top"><code>TITL</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_OBJE_BLOB</code><br>
+ </td>
+ <td valign="top"><code>BLOB</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>NULL</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_OBJE_BLOB_CONT</code><br>
+ </td>
+ <td valign="top"><code>CONT</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_OBJE_OBJE</code><br>
+ </td>
+ <td valign="top"><code>OBJE</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_REPO_NAME</code><br>
+ </td>
+ <td valign="top"><code>NAME</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SOUR_DATA</code><br>
+ </td>
+ <td valign="top"><code>DATA</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>NULL</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SOUR_DATA_EVEN</code><br>
+ </td>
+ <td valign="top"><code>EVEN</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SOUR_DATA_EVEN_DATE</code><br>
+ </td>
+ <td valign="top"><code>DATE</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>DATE</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SOUR_DATA_EVEN_PLAC</code><br>
+ </td>
+ <td valign="top"><code>PLAC</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SOUR_DATA_AGNC</code><br>
+ </td>
+ <td valign="top"><code>AGNC</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SOUR_AUTH</code><br>
+ </td>
+ <td valign="top"><code>AUTH</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SOUR_TITL</code><br>
+ </td>
+ <td valign="top"><code>TITL</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SOUR_ABBR</code><br>
+ </td>
+ <td valign="top"><code>ABBR</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SOUR_PUBL</code><br>
+ </td>
+ <td valign="top"><code>PUBL</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SOUR_TEXT</code><br>
+ </td>
+ <td valign="top"><code>TEXT</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUBN_SUBM</code><br>
+ </td>
+ <td valign="top"><code>SUBM</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUBN_FAMF</code><br>
+ </td>
+ <td valign="top"><code>FAMF</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUBN_TEMP</code><br>
+ </td>
+ <td valign="top"><code>TEMP</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUBN_ANCE</code><br>
+ </td>
+ <td valign="top"><code>ANCE</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUBN_DESC</code><br>
+ </td>
+ <td valign="top"><code>DESC</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUBN_ORDI</code><br>
+ </td>
+ <td valign="top"><code>ORDI</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUBN_RIN</code><br>
+ </td>
+ <td valign="top"><code>RIN</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUBM_NAME</code><br>
+ </td>
+ <td valign="top"><nobr><code>NAME</code></nobr><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUBM_LANG</code><br>
+ </td>
+ <td valign="top"><code>LANG</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUBM_RFN</code><br>
+ </td>
+ <td valign="top"><code>RFN</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUBM_RIN</code><br>
+ </td>
+ <td valign="top"><code>RIN</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_ADDR</code><br>
+ </td>
+ <td valign="top"><code>ADDR</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_ADDR_CONT</code><br>
+ </td>
+ <td valign="top"><code>CONT</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_ADDR_ADR1</code><br>
+ </td>
+ <td valign="top"><code>ADR1</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_ADDR_ADR2</code><br>
+ </td>
+ <td valign="top"><code>ADR2</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_ADDR_CITY</code><br>
+ </td>
+ <td valign="top"><code>CITY</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_ADDR_STAE</code><br>
+ </td>
+ <td valign="top"><code>STAE</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_ADDR_POST</code><br>
+ </td>
+ <td valign="top"><code>POST</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_ADDR_CTRY</code><br>
+ </td>
+ <td valign="top"><code>CTRY</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_PHON</code><br>
+ </td>
+ <td valign="top"><code>PHON</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_ASSO</code><br>
+ </td>
+ <td valign="top"><code>ASSO</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_ASSO_TYPE</code><br>
+ </td>
+ <td valign="top"><code>TYPE</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_ASSO_RELA</code><br>
+ </td>
+ <td valign="top"><code>RELA</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_CHAN</code><br>
+ </td>
+ <td valign="top"><code>CHAN</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>NULL</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_CHAN_DATE</code><br>
+ </td>
+ <td valign="top"><code>DATE</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>DATE</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_CHAN_TIME</code><br>
+ </td>
+ <td valign="top"><code>TIME</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_FAMC</code><br>
+ </td>
+ <td valign="top"><code>FAMC</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_FAMC_PEDI</code><br>
+ </td>
+ <td valign="top"><code>PEDI</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_CONT</code><br>
+ </td>
+ <td valign="top"><code>CONT</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_CONC</code><br>
+ </td>
+ <td valign="top"><code>CONC</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_EVT_TYPE</code><br>
+ </td>
+ <td valign="top"><code>TYPE</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_EVT_DATE</code><br>
+ </td>
+ <td valign="top"><code>DATE</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>DATE</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_EVT_AGE</code><br>
+ </td>
+ <td valign="top"><code>AGE</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_EVT_AGNC</code><br>
+ </td>
+ <td valign="top"><code>AGNC</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_EVT_CAUS</code><br>
+ </td>
+ <td valign="top"><code>CAUS</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_FAM_EVT</code><br>
+ </td>
+ <td valign="top"><code>ANUL, CENS, DIV,<br>
+DIVF, ENGA, MARR,<br>
+MARB, MARC, MARL,<br>
+MARS</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>NULL<br>
+STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_FAM_EVT_HUSB</code><br>
+ </td>
+ <td valign="top"><code>HUSB</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>NULL</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_FAM_EVT_WIFE</code><br>
+ </td>
+ <td valign="top"><code>WIFE</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>NULL</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_FAM_EVT_AGE</code><br>
+ </td>
+ <td valign="top"><code>AGE</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_FAM_EVT_EVEN</code><br>
+ </td>
+ <td valign="top"><code>EVEN</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>NULL</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_IDENT_REFN</code><br>
+ </td>
+ <td valign="top"><code>REFN</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_IDENT_REFN_TYPE</code><br>
+ </td>
+ <td valign="top"><code>TYPE</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_IDENT_RIN</code><br>
+ </td>
+ <td valign="top"><code>RIN</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_INDIV_ATTR</code><br>
+ </td>
+ <td valign="top"><code>CAST, DSCR, EDUC,<br>
+IDNO, NATI, NCHR,<br>
+NMR, OCCU, PROP,<br>
+RELI, SSN, TITL</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_INDIV_RESI</code><br>
+ </td>
+ <td valign="top"><code>RESI</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>NULL</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_INDIV_BIRT</code><br>
+ </td>
+ <td valign="top"><code>BIRT, CHR</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>NULL<br>
+STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_INDIV_BIRT_FAMC</code><br>
+ </td>
+ <td valign="top"><code>FAMC</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_INDIV_GEN</code><br>
+ </td>
+ <td valign="top"><code>DEAT, BURI, CREM,<br>
+BAPM, BARM, BASM,<br>
+BLES, CHRA, CONF,<br>
+FCOM, ORDN, NATU,<br>
+EMIG, IMMI, CENS,<br>
+PROB, WILL, GRAD,<br>
+RETI</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>NULL<br>
+STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_INDIV_ADOP</code><br>
+ </td>
+ <td valign="top"><code>ADOP</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>NULL<br>
+STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_INDIV_ADOP_FAMC</code><br>
+ </td>
+ <td valign="top"><code>FAMC</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_INDIV_ADOP_FAMC_ADOP</code><br>
+ </td>
+ <td valign="top"><code>ADOP</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_INDIV_EVEN</code><br>
+ </td>
+ <td valign="top"><code>EVEN</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>NULL</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_LIO_BAPL</code><br>
+ </td>
+ <td valign="top"><code>BAPL, CONL, ENDL</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>NULL</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_LIO_BAPL_STAT</code><br>
+ </td>
+ <td valign="top"><code>STAT</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_LIO_BAPL_DATE</code><br>
+ </td>
+ <td valign="top"><code>DATE</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>DATE</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_LIO_BAPL_TEMP</code><br>
+ </td>
+ <td valign="top"><code>TEMP</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_LIO_BAPL_PLAC</code><br>
+ </td>
+ <td valign="top"><code>PLAC</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_LIO_SLGC</code><br>
+ </td>
+ <td valign="top"><code>SLGC</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>NULL</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_LIO_SLGC_FAMC</code><br>
+ </td>
+ <td valign="top"><code>FAMC</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_LSS_SLGS</code><br>
+ </td>
+ <td valign="top"><code>SLGS</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>NULL</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_LSS_SLGS_STAT</code><br>
+ </td>
+ <td valign="top"><code>STAT</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_LSS_SLGS_DATE</code><br>
+ </td>
+ <td valign="top"><code>DATE</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>DATE</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_LSS_SLGS_TEMP</code><br>
+ </td>
+ <td valign="top"><code>TEMP</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_LSS_SLGS_PLAC</code><br>
+ </td>
+ <td valign="top"><code>PLAC</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_MULTIM_OBJE</code><br>
+ </td>
+ <td valign="top"><code>OBJE</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>NULL</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_MULTIM_OBJE_FORM</code><br>
+ </td>
+ <td valign="top"><code>FORM</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_MULTIM_OBJE_TITL</code><br>
+ </td>
+ <td valign="top"><code>TITL</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_MULTIM_OBJE_FILE</code><br>
+ </td>
+ <td valign="top"><code>FILE</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_NOTE</code><br>
+ </td>
+ <td valign="top"><code>NOTE</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>NULL<br>
+STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_PERS_NAME</code><br>
+ </td>
+ <td valign="top"><code>NAME</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_PERS_NAME_NPFX</code><br>
+ </td>
+ <td valign="top"><code>NPFX</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_PERS_NAME_GIVN</code><br>
+ </td>
+ <td valign="top"><code>GIVN</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_PERS_NAME_NICK</code><br>
+ </td>
+ <td valign="top"><code>NICK</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_PERS_NAME_SPFX</code><br>
+ </td>
+ <td valign="top"><code>SPFX</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_PERS_NAME_SURN</code><br>
+ </td>
+ <td valign="top"><code>SURN</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_PERS_NAME_NSFX</code><br>
+ </td>
+ <td valign="top"><code>NSFX</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_PLAC</code><br>
+ </td>
+ <td valign="top"><code>PLAC</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_PLAC_FORM</code><br>
+ </td>
+ <td valign="top"><code>FORM</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_SOUR</code><br>
+ </td>
+ <td valign="top"><code>SOUR</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_SOUR_PAGE</code><br>
+ </td>
+ <td valign="top"><code>PAGE</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_SOUR_EVEN</code><br>
+ </td>
+ <td valign="top"><code>EVEN</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_SOUR_EVEN_ROLE</code><br>
+ </td>
+ <td valign="top"><code>ROLE</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_SOUR_DATA</code><br>
+ </td>
+ <td valign="top"><code>DATA</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>NULL</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_SOUR_DATA_DATE</code><br>
+ </td>
+ <td valign="top"><code>DATE</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>DATE</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_SOUR_TEXT</code><br>
+ </td>
+ <td valign="top"><code>TEXT</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_SOUR_QUAY</code><br>
+ </td>
+ <td valign="top"><code>QUAY</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_REPO</code><br>
+ </td>
+ <td valign="top"><code>REPO</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_REPO_CALN</code><br>
+ </td>
+ <td valign="top"><code>CALN</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_REPO_CALN_MEDI</code><br>
+ </td>
+ <td valign="top"><code>MEDI</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_SUB_FAMS</code><br>
+ </td>
+ <td valign="top"><code>FAMS</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>STRING</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>ELT_USER</code><br>
+ </td>
+ <td valign="top"><code>any tag starting<br>
+with an underscore</code><br>
+ </td>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><code>NULL<br>
+STRING</code><br>
+ </td>
+ </tr>
+ </tbody>
+</table>
+
+<hr width="100%" size="2">
+<h2><a name="Gedcom_val_types"></a>Gedcom_val types<br>
+ </h2>
+ Currently, the specific <code>Gedcom_val</code> types are (with <code>val</code>
+ of type <code>Gedcom_val</code>):<br>
+<br>
+<table cellpadding="2" cellspacing="2" border="1" width="100%">
+ <tbody>
+ <tr>
+ <td valign="top"><br>
+ </td>
+ <td valign="top"><b>type checker</b><br>
+ </td>
+ <td valign="top"><b>cast operator</b><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top">null value<br>
+ </td>
+ <td valign="top"><code>GEDCOM_IS_NULL(val)</code><br>
+ </td>
+ <td valign="top">N/A<br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top">string<br>
+ </td>
+ <td valign="top"><code>GEDCOM_IS_STRING(val)</code><br>
+ </td>
+ <td valign="top"><code>char* str = GEDCOM_STRING(val);</code><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top">date<br>
+ </td>
+ <td valign="top"><code>GEDCOM_IS_DATE(val)</code><br>
+ </td>
+ <td valign="top"><code>struct date_value dv = GEDCOM_DATE(val);</code></td>
+ </tr>
+ </tbody>
+</table>
+<br>
+<br>
+ The type checker returns a true or a false value according to the type
+of the value, but this is in principle only necessary in the rare circumstances
+that two types are possible, or where an optional value can be provided. In
+most cases, the type is fixed for a specific tag.<br>
+<br>
+ The null value is used for when the GEDCOM spec doesn't allow a value, or
+when an optional value is allowed but none is given.<br>
+ <br>
+ The string value is the most general used value currently, for all those
+values that don't have a more specific meaning. In essence, the value
+that is returned by GEDCOM_STRING is always the same as the raw_value passed
+to the start callback, and is thus in fact redundant.<br>
+<br>
+ The date value is used for all elements that return a date. (<i>Description
+of struct date_value TBD: look in the header file for the moment</i>).<br>
+<br>
+<h3><a name="struct_date_value"></a>struct date_value</h3>
+This struct describes a date as given in the GEDCOM file, and has the following
+definition:<br>
+<blockquote><code>struct date_value {<br>
+ Date_value_type type;<br>
+ struct date date1;<br>
+ struct date date2;<br>
+ char phrase[MAX_PHRASE_LEN
++ 1];<br>
+};</code><br>
+ </blockquote>
+ It depends on the first member, the type, which members are actually relevant:<br>
+ <br>
+ <table cellpadding="2" cellspacing="2" border="1" width="100%">
+ <tbody>
+ <tr>
+ <td valign="top" align="center"><b>Date_value_type</b><br>
+ </td>
+ <td valign="top" align="center"><b>Meaning</b><br>
+ </td>
+ <td valign="top" align="center"><b>Relevant members</b><br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>DV_NO_MODIFIER</code><br>
+ </td>
+ <td valign="top">just a simple date<br>
+ </td>
+ <td valign="top">date1<br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>DV_BEFORE</code><br>
+ </td>
+ <td valign="top">a range (BEFORE date1)<br>
+ </td>
+ <td valign="top">date1<br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>DV_AFTER</code><br>
+ </td>
+ <td valign="top">a range (AFTER date1)<br>
+ </td>
+ <td valign="top">date1<br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>DV_BETWEEN</code><br>
+ </td>
+ <td valign="top">a range (BETWEEN date1 AND date2)<br>
+ </td>
+ <td valign="top">date1, date2<br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>DV_FROM</code><br>
+ </td>
+ <td valign="top">a period (FROM date1)<br>
+ </td>
+ <td valign="top">date1<br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>DV_TO</code><br>
+ </td>
+ <td valign="top">a period (TO date1)<br>
+ </td>
+ <td valign="top">date1<br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>DV_FROM_TO</code><br>
+ </td>
+ <td valign="top">a period (FROM date1 TO date2)<br>
+ </td>
+ <td valign="top">date1, date2<br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>DV_ABOUT</code><br>
+ </td>
+ <td valign="top">an approximation (ABOUT date1)<br>
+ </td>
+ <td valign="top">date1<br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>DV_CALCULATED</code><br>
+ </td>
+ <td valign="top">an approximation (CALCULATED date1)<br>
+ </td>
+ <td valign="top">date1<br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>DV_ESTIMATED</code><br>
+ </td>
+ <td valign="top">an approximation (ESTIMATED date1)<br>
+ </td>
+ <td valign="top">date1<br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>DV_INTERPRETED</code><br>
+ </td>
+ <td valign="top">INTERPRETED date1 FROM a given free form date phrase<br>
+ </td>
+ <td valign="top">date1, phrase<br>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top"><code>DV_PHRASE</code><br>
+ </td>
+ <td valign="top">a free form date phrase<br>
+ </td>
+ <td valign="top">phrase<br>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ <br>
+ <h3><a name="struct_date"></a>struct date<br>
+ </h3>
+The <code>date1</code> and <code>date2</code> also have a strict syntax:<br>
+ <blockquote><code>struct date {<br>
+ Calendar_type cal;<br>
+ char day_str[MAX_DAY_LEN + 1];<br>
+ char month_str[MAX_MONTH_LEN +
+1];<br>
+ char year_str[MAX_YEAR_LEN + 1];<br>
+ <br>
+ int day;<br>
+ int month;<br>
+ int year;<br>
+ Year_type year_type;<br>
+ <br>
+ Date_type type;<br>
+ long int sdn1;<br>
+ long int sdn2;<br>
+};</code><br>
+ </blockquote>
+The first four fields are the primary fields parsed from the value in the
+GEDCOM file. The <code>day_str</code>, <code>month_str</code> and <code>
+year_str</code> are the literal parts of the date that denote the day, month
+and year. The calendar type <code>cal</code> is one of (see calendar
+overview <i>LINK TBD</i>):<br>
+ <ul>
+ <li><code>CAL_GREGORIAN</code> : the Gregorian calendar</li>
+ <li><code>CAL_JULIAN</code> : the Julian calendar</li>
+ <li><code>CAL_HEBREW</code> : the Hebrew (Jewish) calendar</li>
+ <li><code>CAL_FRENCH_REV</code> : the calendar used after the French
+Revolution</li>
+ <li><code>CAL_UNKNOWN</code> : an unknown calendar type</li>
+ </ul>
+The next four fields are deduced from the first four:<br>
+ <ul>
+ <li>the <code>day</code> is just the numeric representation of the
+ <code>day_str</code> (starting from 1)</li>
+ <li>the <code>month</code> is the month number of <code>month_str</code>
+ in the given calendar type (also starting from 1)</li>
+ <li>the <code>year</code> is the numeric representation of the <code>
+year_str</code></li>
+ </ul>
+It is possible that the <code>year_str</code> is given as e.g. "1677/78".
+ This is coming from a date in a so called "annunciation style", where
+the year began on 25 March, so that "20 March 1677/78" is 20 March 1677 in
+"annunciation style" and 20 March 1678 in "circumcision style" (the current
+style). See calendar overview (<i>LINK TBD</i>).<br>
+ <br>
+In this case, the <code>year</code> will contain the "circumcision style"
+year (1678 in the example), and <code>year_type</code> will be <code>YEAR_DOUBLE.</code>
+ Normal dates will have a <code>year_type</code> equal to <code>YEAR_SINGLE</code>
+.<br>
+ <br>
+Finally, the last three fields are probably the most interesting values for
+applications that want to process dates. Basically, the date is converted
+to a serial day number (aka Julian day), which is the unique day number since
+November 25, 4714 BC in the Gregorian calendar. The advantage of these
+day numbers is that they are unique and independent of the calendar system.
+ Furthermore, date differences can just be computed by subtracting the
+serial day numbers.<br>
+ <br>
+However, since dates in GEDCOM are not necessarily exact (e.g. "MAR 1990"),
+it is not possible to represent all GEDCOM dates with 1 serial day number.
+ Two cases can be distinguished:<br>
+ <ul>
+ <li>Exact dates (e.g. "25 MAR 1990"):</li>
+ </ul>
+ <blockquote>
+ <blockquote>These are represented by a serial day number in <code>sdn1</code>
+ and a <code>Date_type</code> equal to <code>DATE_EXACT</code>.<br>
+ </blockquote>
+ </blockquote>
+ <ul>
+ <li>Incomplete dates (e.g. "MAR 1990"):</li>
+ </ul>
+ <blockquote>
+ <blockquote>These are represented by 2 serial day numbers (<code>
+sdn1</code> and <code>sdn2</code>) and a <code>Date_type</code> equal to
+ <code>DATE_BOUNDED</code>.<br>
+ <br>
+For example, the Gregorian date "MAR 1990" is represented by the serial day
+numbers for "1 MAR 1990" and "31 MAR 1990", and the Gregorian date "1990"
+is represented by the serial day numbers for "1 JAN 1990" and "31 DEC 1990".
+ Similarly for the other calendar types.<br>
+ </blockquote>
+ </blockquote>
+ <br>
+ <hr width="100%" size="2">$Id$<br>
+ $Name$<br>
+ <br>
+
+ </body>
+ </html>
<html>
<head>
<title>Using the GEDCOM parser library</title>
-
+
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1">
</head>
-<body>
-
+ <body>
+
<h1 align="center">Using the GEDCOM parser library</h1>
- <br>
-
+ <br>
+
<h2>Index</h2>
+
<ul>
- <li><a href="#anchor">Overview</a></li>
- <li><a href="#Error_handling">Error handling</a></li>
- <li><a href="#Data_callback_mechanism">Data callback mechanism</a></li>
+ <li><a href="#anchor">Overview</a></li>
+ <li><a href="#Error_handling">Error handling</a></li>
+ <li><a href="#Data_callback_mechanism">Data callback mechanism</a></li>
+
+ <ul>
+ <li><a href="#Start_and_end_callbacks">Start and end callbacks</a></li>
+ <li><a href="#Default_callbacks">Default callbacks</a></li>
+
+ </ul>
+ <li><a href="#Other_API_functions">Other API functions</a></li>
<ul>
- <li><a href="#Start_and_end_callbacks">Start and end callbacks</a></li>
- <li><a href="#Default_callbacks">Default callbacks</a><br>
- </li>
+ <li><a href="#Debugging">Debugging</a></li>
+ <li><a href="#Error_treatment">Error treatment</a></li>
+ <li><a href="#Compatibility_mode">Compatibility mode</a></li>
</ul>
+ <li><a href="interface.html">Interface details</a><br>
+ </li>
+
</ul>
-<hr width="100%" size="2">
-<h2><a name="Overview"></a>Overview<br>
- </h2>
- The GEDCOM parser library is built as a callback-based parser (comparable
-to the SAX interface of XML). It comes with:<br>
+<hr width="100%" size="2">
+<h2><a name="Overview"></a>Overview<br>
+ </h2>
+ The GEDCOM parser library is built as a callback-based parser (comparable
+ to the SAX interface of XML). It comes with:<br>
+
<ul>
- <li>a library (<code>libgedcom.so</code>), to be linked in the application
-program</li>
- <li>a header file (<code>gedcom.h</code>), to be used in the sources of
-the application program</li>
-
+ <li>a library (<code>libgedcom.so</code>), to be linked in the application
+ program</li>
+ <li>a header file (<code>gedcom.h</code>), to be used in the sources
+of the application program</li>
+
</ul>
- Next to these, there is also a data directory in <code>$PREFIX/share/gedcom-parse</code>
- that contains some additional stuff, but which is not immediately important
-at first. I'll leave the description of the data directory for later.<br>
- <br>
- The very simplest call of the gedcom parser is simply the following piece
-of code (include of the gedcom header is assumed, as everywhere in this manual):<br>
-
+ Next to these, there is also a data directory in <code>$PREFIX/share/gedcom-parse</code>
+ that contains some additional stuff, but which is not immediately important
+ at first. I'll leave the description of the data directory for later.<br>
+ <br>
+ The very simplest call of the gedcom parser is simply the following piece
+ of code (include of the gedcom header is assumed, as everywhere in this
+manual):<br>
+
<blockquote><code>int result;<br>
- ...<br>
- result = <b>gedcom_parse_file</b>("myfamily.ged");<br>
- </code> </blockquote>
- Although this will not provide much information, one thing it does is parse
-the entire file and return the result. The function returns 0 on success
-and 1 on failure. No other information is available using this function
+ ...<br>
+ result = <b>gedcom_parse_file</b>("myfamily.ged");<br>
+ </code> </blockquote>
+ Although this will not provide much information, one thing it does is parse
+the entire file and return the result. The function returns 0 on success
+and 1 on failure. No other information is available using this function
only.<br>
- <br>
-The next sections will refine this to be able to have meaningful errors and
-the actual data that is in the file.<br>
- <hr width="100%" size="2">
+ <br>
+ The next sections will refine this to be able to have meaningful errors
+and the actual data that is in the file.<br>
+
+ <hr width="100%" size="2">
<h2><a name="Error_handling"></a>Error handling</h2>
-Since this is a relatively simple topic, it is discussed before the actual
+ Since this is a relatively simple topic, it is discussed before the actual
callback mechanism, although it also uses a callback...<br>
- <br>
-The library can be used in several different circumstances, both terminal-based
-as GUI-based. Therefore, it leaves the actual display of the error
-message up to the application. For this, the application needs to register
-a callback before parsing the GEDCOM file, which will be called by the library
+ <br>
+ The library can be used in several different circumstances, both terminal-based
+as GUI-based. Therefore, it leaves the actual display of the error message
+up to the application. For this, the application needs to register a
+callback before parsing the GEDCOM file, which will be called by the library
on errors, warnings and messages.<br>
- <br>
-A typical piece of code would be:<br>
- <blockquote><code>void <b>my_message_handler</b> (Gedcom_msg_type type,
+ <br>
+ A typical piece of code would be:<br>
+
+ <blockquote><code>void <b>my_message_handler</b> (Gedcom_msg_type type,
char *msg)<br>
-{<br>
- ...<br>
-}<br>
-...<br>
- <b>gedcom_set_message_handler</b>(my_message_handler);<br>
-...<br>
-result = <b>gedcom_parse_file</b>("myfamily.ged");</code><br>
- </blockquote>
-In the above piece of code, <code>my_message_handler</code> is the callback
+ {<br>
+ ...<br>
+ }<br>
+ ...<br>
+ <b>gedcom_set_message_handler</b>(my_message_handler);<br>
+ ...<br>
+ result = <b>gedcom_parse_file</b>("myfamily.ged");</code><br>
+ </blockquote>
+ In the above piece of code, <code>my_message_handler</code> is the callback
that will be called for errors (<code>type=ERROR</code>), warnings (<code>
-type=WARNING</code>) and messages (<code>type=MESSAGE</code>). The
-callback must have the signature as in the example. For errors, the
- <code>msg</code> passed to the callback will have the format:<br>
+type=WARNING</code>) and messages (<code>type=MESSAGE</code>). The callback
+must have the signature as in the example. For errors, the <code>
+msg</code> passed to the callback will have the format:<br>
+
<blockquote><code>Error on line</code> <i><lineno></i>: <i><actual_message></i><br>
- </blockquote>
-Note that the entire string will be properly internationalized, and encoded
-in UTF-8 (see "Why UTF-8?" <i>LINK TBD</i>). Also, no newline
-is appended, so that the application program can use it in any way it wants.
- Warnings are similar, but use "Warning" instead of "Error". Messages
+ </blockquote>
+ Note that the entire string will be properly internationalized, and encoded
+in UTF-8 (see "Why UTF-8?" <i>LINK TBD</i>). Also, no newline
+is appended, so that the application program can use it in any way it wants.
+ Warnings are similar, but use "Warning" instead of "Error". Messages
are plain text, without any prefix.<br>
- <br>
-With this in place, the resulting code will already show errors and warnings
+ <br>
+ With this in place, the resulting code will already show errors and warnings
produced by the parser, e.g. on the terminal if a simple <code>printf</code>
- is used in the message handler.<br>
- <hr width="100%" size="2">
+ is used in the message handler.<br>
+
+ <hr width="100%" size="2">
<h2><a name="Data_callback_mechanism"></a>Data callback mechanism</h2>
-The most important use of the parser is of course to get the data out of
-the GEDCOM file. As already mentioned, the parser uses a callback mechanism
+ The most important use of the parser is of course to get the data out of
+the GEDCOM file. As already mentioned, the parser uses a callback mechanism
for that. In fact, the mechanism involves two levels.<br>
- <br>
-The primary level is that each of the sections in a GEDCOM file is notified
-to the application code via a "start element" callback and an "end element"
-callback (much like in a SAX interface for XML), i.e. when a line containing
-a certain tag is parsed, the "start element" callback is called for that
-tag, and when all its subordinate lines with their tags have been processed,
-the "end element" callback is called for the original tag. Since GEDCOM
-is hierarchical, this results in properly nested calls to appropriate "start
+ <br>
+ The primary level is that each of the sections in a GEDCOM file is notified
+to the application code via a "start element" callback and an "end element"
+callback (much like in a SAX interface for XML), i.e. when a line containing
+a certain tag is parsed, the "start element" callback is called for that tag,
+and when all its subordinate lines with their tags have been processed, the
+"end element" callback is called for the original tag. Since GEDCOM
+is hierarchical, this results in properly nested calls to appropriate "start
element" and "end element" callbacks.<br>
- <br>
-However, it would be typical for a genealogy program to support only a subset
-of the GEDCOM standard, certainly a program that is still under development.
- Moreover, under GEDCOM it is allowed for an application to define its
-own tags, which will typically not be supported by another application.
- Still, in that case, data preservation is important; it would hardly
-be accepted that information that is not understood by a certain program
-is just removed.<br>
- <br>
-Therefore, the second level of callbacks involves a "default callback". An
-application needs to subscribe to callbacks for tags it does support, and
-need to provide a "default callback" which will be called for tags it doesn't
-support. The application can then choose to just store the information
-that comes via the default callback in plain textual format.<br>
- <br>
-After this introduction, let's see what the API looks like...<br>
- <br>
+ <br>
+ However, it would be typical for a genealogy program to support only a subset
+of the GEDCOM standard, certainly a program that is still under development.
+ Moreover, under GEDCOM it is allowed for an application to define its
+own tags, which will typically not be supported by another application.
+ Still, in that case, data preservation is important; it would hardly
+be accepted that information that is not understood by a certain program is
+just removed.<br>
+ <br>
+ Therefore, the second level of callbacks involves a "default callback".
+ An application needs to subscribe to callbacks for tags it does support,
+and need to provide a "default callback" which will be called for tags it
+doesn't support. The application can then choose to just store the
+information that comes via the default callback in plain textual format.<br>
+ <br>
+ After this introduction, let's see what the API looks like...<br>
+ <br>
+
<h3><a name="Start_and_end_callbacks"></a>Start and end callbacks</h3>
+
<h4><i>Callbacks for records</i> <br>
- </h4>
-As a simple example, we will get some information from the header of a GEDCOM
+ </h4>
+ As a simple example, we will get some information from the header of a GEDCOM
file. First, have a look at the following piece of code:<br>
- <blockquote><code>Gedcom_ctxt <b>my_header_start_cb</b> (int level,
+
+ <blockquote><code>Gedcom_ctxt <b>my_header_start_cb</b> (int level,
Gedcom_val xref, char *tag)<br>
-{<br>
- printf("The header starts\n");<br>
- return (Gedcom_ctxt)1;<br>
-}<br>
- <br>
-void <b>my_header_end_cb</b> (Gedcom_ctxt self)<br>
-{<br>
- printf("The header ends, context is %d\n", self); /* context
+ {<br>
+ printf("The header starts\n");<br>
+ return (Gedcom_ctxt)1;<br>
+ }<br>
+ <br>
+ void <b>my_header_end_cb</b> (Gedcom_ctxt self)<br>
+ {<br>
+ printf("The header ends, context is %d\n", self); /* context
will print as "1" */<br>
-}<br>
- <br>
-...<br>
- <b>gedcom_subscribe_to_record</b>(REC_HEAD, my_header_start_cb, my_header_end_cb);<br>
-...<br>
-result = <b>gedcom_parse_file</b>("myfamily.ged");</code><br>
- </blockquote>
- Using the <code>gedcom_subscribe_to_record</code> function, the application
-requests to use the specified callbacks as start and end callback. The end
-callback is optional: you can pass <code>NULL</code> if you are not interested
-in the end callback. The identifiers to use as first argument to the
-function (here <code>REC_HEAD</code>) are described in <i>TBD (use the header
-file for now...)</i>.<br>
- <br>
-From the name of the function it becomes clear that this function is specific
-to complete records. For the separate elements in records there is
-another function, which we'll see shortly. Again, the callbacks need
-to have the signatures as shown in the example.<br>
- <br>
-The <code>Gedcom_ctxt</code> type that is used as a result of the start callback
-and as an argument to the end callback is vital for passing context necessary
-for the application. This type is meant to be opaque; in fact, it's
-a void pointer, so you can pass anything via it. The important thing
-to know is that the context that the application returns in the start callback
-will be passed in the end callback as an argument, and as we will see shortly,
-also to all the directly subordinate elements of the record.<br>
- <br>
-The example passes a simple integer as context, but an application could
-e.g. pass a <code>struct</code> that will contain the information for the
-header. In the end callback, the application could then e.g. do some
+ }<br>
+ <br>
+ ...<br>
+ <b>gedcom_subscribe_to_record</b>(REC_HEAD, my_header_start_cb,
+my_header_end_cb);<br>
+ ...<br>
+ result = <b>gedcom_parse_file</b>("myfamily.ged");</code><br>
+ </blockquote>
+ Using the <code>gedcom_subscribe_to_record</code> function, the application
+requests to use the specified callbacks as start and end callback. The end
+callback is optional: you can pass <code>NULL</code> if you are not interested
+in the end callback. The identifiers to use as first argument to the
+function (here <code>REC_HEAD</code>) are described in the <a href="interface.html#Record_identifiers">
+interface details</a>.<br>
+ <br>
+ From the name of the function it becomes clear that this function is specific
+to complete records. For the separate elements in records there is another
+function, which we'll see shortly. Again, the callbacks need to have
+the signatures as shown in the example.<br>
+ <br>
+ The <code>Gedcom_ctxt</code> type that is used as a result of the start
+callback and as an argument to the end callback is vital for passing context
+necessary for the application. This type is meant to be opaque; in
+fact, it's a void pointer, so you can pass anything via it. The important
+thing to know is that the context that the application returns in the start
+callback will be passed in the end callback as an argument, and as we will
+see shortly, also to all the directly subordinate elements of the record.<br>
+ <br>
+ The example passes a simple integer as context, but an application could
+e.g. pass a <code>struct</code> that will contain the information for the
+header. In the end callback, the application could then e.g. do some
finalizing operations on the <code>struct</code> to put it in its database.<br>
- <br>
-(Note that the <code>Gedcom_val</code> type for the <code>xref</code> argument
+ <br>
+ (Note that the <code>Gedcom_val</code> type for the <code>xref</code> argument
was not discussed, see further for this)<br>
- <br>
+ <br>
+
<h4><i>Callbacks for elements</i></h4>
-We will now retrieve the SOUR field (the name of the program that wrote the
-file) from the header:<br>
- <blockquote><code>Gedcom_ctxt <b>my_header_source_start_cb</b>(Gedcom_ctxt
+ We will now retrieve the SOUR field (the name of the program that wrote
+the file) from the header:<br>
+
+ <blockquote><code>Gedcom_ctxt <b>my_header_source_start_cb</b>(Gedcom_ctxt
parent,<br>
-
- int
+
+ int
level,<br>
-
- char*
+
+ char*
tag,<br>
-
- char*
+
+ char*
raw_value,<br>
-
+
Gedcom_val parsed_value)<br>
-{<br>
- char *source = GEDCOM_STRING(parsed_value);<br>
- printf("This file was written by %s\n", source);<br>
- return parent;<br>
-}<br>
- <br>
-void <b>my_header_source_end_cb</b>(Gedcom_ctxt parent,<br>
-
+ {<br>
+ char *source = GEDCOM_STRING(parsed_value);<br>
+ printf("This file was written by %s\n", source);<br>
+ return parent;<br>
+ }<br>
+ <br>
+ void <b>my_header_source_end_cb</b>(Gedcom_ctxt parent,<br>
+
Gedcom_ctxt self,<br>
-
+
Gedcom_val parsed_value)<br>
-{<br>
- printf("End of the source description\n");<br>
-}<br>
- <br>
-...<br>
- <b>gedcom_subscribe_to_element</b>(ELT_HEAD_SOUR,<br>
-
+ {<br>
+ printf("End of the source description\n");<br>
+ }<br>
+ <br>
+ ...<br>
+ <b>gedcom_subscribe_to_element</b>(ELT_HEAD_SOUR,<br>
+
my_header_source_start_cb,<br>
-
+
my_header_source_end_cb);<br>
-...<br>
-result = <b>gedcom_parse_file</b>("myfamily.ged");</code><br>
- </blockquote>
-The subscription mechanism for elements is similar, only the signatures of
-the callbacks differ. The signature for the start callback shows that
-the context of the parent line (e.g. the <code>struct</code> that describes
-the header) is passed to this start callback. The callback itself returns
-here the same context, but this can be its own context object of course.
- The end callback is called with both the context of the parent and
-the context of itself, which will be the same in the example.<br>
- <br>
-If we look at the other arguments of the start callback, we see the level
-number (the initial number of the line in the GEDCOM file), the tag (e.g.
-"SOUR"), and then a raw value and a parsed value. The raw value is
-just the raw string that occurs as value on the line next to the tag (in
-UTF-8 encoding). The parsed value is the meaningful value that is parsed
-from that raw string.<br>
- <br>
-The <code>Gedcom_val</code> type is meant to be an opaque type. The
-only thing that needs to be known about it is that it can contain specific
-data types, which have to be retrieved from it using pre-defined macros.
- Currently, the specific types are (with <code>val</code> of type <code>
-Gedcom_val</code>):<br>
- <br>
- <table cellpadding="2" cellspacing="2" border="1" width="100%">
- <tbody>
- <tr>
- <td valign="top"><br>
- </td>
- <td valign="top"><b>type checker</b><br>
- </td>
- <td valign="top"><b>cast operator</b><br>
- </td>
- </tr>
- <tr>
- <td valign="top">null value<br>
- </td>
- <td valign="top"><code>GEDCOM_IS_NULL(val)</code><br>
- </td>
- <td valign="top">N/A<br>
- </td>
- </tr>
- <tr>
- <td valign="top">string<br>
- </td>
- <td valign="top"><code>GEDCOM_IS_STRING(val)</code><br>
- </td>
- <td valign="top"><code>char* str = GEDCOM_STRING(val);</code><br>
- </td>
- </tr>
- <tr>
- <td valign="top">date<br>
- </td>
- <td valign="top"><code>GEDCOM_IS_DATE(val)</code><br>
- </td>
- <td valign="top"><code>struct date_value dv = GEDCOM_DATE(val)
-;</code><br>
- </td>
- </tr>
- </tbody>
- </table>
- <br>
-The null value is used for when the GEDCOM spec doesn't allow a value, or
-when an optional value is allowed but none is given.<br>
- <br>
-The string value is the most general used value currently, for all those
-values that don't have a more specific meaning. In essence, the value
-that is returned by GEDCOM_STRING is always the same as the raw_value passed
-to the start callback, and is thus in fact redundant.<br>
- <br>
-The date value is used for all elements that return a date. (<i>Description
-of struct date_value TBD: look in the header file for the moment</i>).<br>
- <br>
-The type checker returns a true or a false value according to the type of
-the value, but this is in principle only necessary in the rare circumstances
-that two types are possible, or where an optional value can be provided.
- In most cases, the type is fixed for a specific tag (<i>types per tag
-to be described</i>).<br>
+ ...<br>
+ result = <b>gedcom_parse_file</b>("myfamily.ged");</code><br>
+ </blockquote>
+ The subscription mechanism for elements is similar, only the signatures
+of the callbacks differ. The signature for the start callback shows
+that the context of the parent line (e.g. the <code>struct</code> that describes
+the header) is passed to this start callback. The callback itself returns
+here the same context, but this can be its own context object of course. The
+end callback is called with both the context of the parent and the context
+of itself, which will be the same in the example. Again, the list of
+identifiers to use as a first argument for the subscription function are
+detailed in the <a href="interface.html#Element_identifiers">interface details</a>
+.<br>
+ <br>
+ If we look at the other arguments of the start callback, we see the level
+number (the initial number of the line in the GEDCOM file), the tag (e.g.
+"SOUR"), and then a raw value and a parsed value. The raw value is just
+the raw string that occurs as value on the line next to the tag (in UTF-8
+encoding). The parsed value is the meaningful value that is parsed from
+that raw string.<br>
+ <br>
+ The <code>Gedcom_val</code> type is meant to be an opaque type. The
+only thing that needs to be known about it is that it can contain specific
+data types, which have to be retrieved from it using pre-defined macros. These
+data types are described in the <a href="interface.html#Gedcom_val_types">
+interface details</a>. <br>
<br>
-Some extra notes:<br>
+ Some extra notes:<br>
+
<ul>
- <li>The <code>Gedcom_val</code> argument of the end callback
+ <li>The <code>Gedcom_val</code> argument of the end callback
is currently not used. It is there for future enhancements.</li>
- <li>There is also a <code>Gedcom_val</code> argument in the start
-callback for records. This argument is currently a string value giving
-the pointer in string form.</li>
+ <li>There is also a <code>Gedcom_val</code> argument in the
+start callback for records. This argument is currently a string value
+giving the pointer in string form.</li>
+
</ul>
+
<h3><a name="Default_callbacks"></a>Default callbacks<br>
- </h3>
-TO BE COMPLETED<br>
- <hr width="100%" size="2">$Id$<br>
- $Name$<br>
- <br>
-
- </body>
- </html>
+ </h3>
+ As described above, an application doesn't always implement the entire GEDCOM
+spec, and application-specific tags may have been added by other applications.
+ To preserve this extra data anyway, a default callback can be registered
+by the application, as in the following example:<br>
+ <blockquote><code>void <b>my_default_cb</b> (Gedcom_ctxt parent,
+int level, char* tag, char* raw_value)<br>
+{<br>
+ ...<br>
+}<br>
+ <br>
+...<br>
+ <b>gedcom_set_default_callback</b>(my_default_cb);<br>
+...<br>
+result = <b>gedcom_parse_file</b>("myfamily.ged");</code><br>
+ </blockquote>
+ This callback has a similar signature as the previous ones, but
+it doesn't contain a parsed value. However, it does contain the parent
+context, that was returned by the application for the most specific containing
+tag that the application supported.<br>
+ <br>
+Suppose e.g. that this callback is called for some tags in the header that
+are specific to some other application, then our application could make sure
+that the parent context contains the struct or object that represents the
+header, and use the default callback here to add the level, tag and raw_value
+as plain text in a member of that struct or object, thus preserving the information.
+ The application can then write this out when the data is saved again
+in a GEDCOM file. To make it more specific, consider the following
+example:<br>
+ <blockquote><code>struct header {<br>
+ char* source;<br>
+ ...<br>
+ char* extra_text;<br>
+};<br>
+ <br>
+Gedcom_ctxt my_header_start_cb(int level, Gedcom_val xref, char* tag)<br>
+{<br>
+ struct header head = my_make_header_struct();<br>
+ return (Gedcom_ctxt)head;<br>
+}<br>
+ <br>
+void my_default_cb(Gedcom_ctxt parent, int level, char* tag, char* raw_value)<br>
+{<br>
+ struct header head = (struct header)parent;<br>
+ my_header_add_to_extra_text(head, level, tag, raw_value);<br>
+}<br>
+ <br>
+gedcom_set_default_callback(my_default_cb);<br>
+gedcom_subscribe_to_record(REC_HEAD, my_header_start, NULL);<br>
+...<br>
+result = gedcom_parse_file(filename);</code><br>
+ </blockquote>
+Note that the default callback will be called for any tag that isn't specifically
+subscribed upon by the application, and can thus be called in various contexts.
+ For simplicity, the example above doesn't take this into account (the
+ <code>parent</code> could be of different types, depending
+on the context).<br>
+ <hr width="100%" size="2">
+ <h2><a name="Other_API_functions"></a>Other API functions<br>
+ </h2>
+Although the above describes the basic interface of libgedcom, there are
+some other functions that allow to customize the behaviour of the library.
+ These will be explained in the current section.<br>
+ <h3><a name="Debugging"></a>Debugging</h3>
+The library can generate various debugging output, not only from itself,
+but also the debugging output generated by the yacc parser. By default,
+no debugging output is generated, but this can be customized using the following
+function:<br>
+ <blockquote><code>void <b>gedcom_set_debug_level</b> (int level,
+FILE* trace_output)</code><br>
+ </blockquote>
+The <code>level</code> can be one of the following values:<br>
+ <ul>
+ <li>0: no debugging information (this is the default)</li>
+ <li>1: only debugging information from libgedcom
+itself</li>
+ <li>2: debugging information from libgedcom and yacc</li>
+ </ul>
+If the <code>trace_output</code> is <code>NULL</code>, debugging information
+will be written to <code>stderr</code>, otherwise the given file handle is
+used (which must be open).<br>
+ <br>
+ <h3><a name="Error_treatment"></a>Error treatment</h3>
+One of the previous sections already described the callback to be registered
+to get error messages. The library also allows to customize what happens
+on an error, using the following function:<br>
+ <blockquote><code>void <b>gedcom_set_error_handling</b> (Gedcom_err_mech
+mechanism)</code><br>
+ </blockquote>
+The <code>mechanism</code> can be one of:<br>
+ <ul>
+ <li><code>IMMED_FAIL</code>: immediately fail the parsing
+on an error (this is the default)</li>
+ <li><code>DEFER_FAIL</code>: continue parsing after an
+error, but return a failure code eventually</li>
+ <li><code>IGNORE_ERRORS</code>: continue parsing after
+an error, return success always</li>
+ </ul>
+This doesn't influence the generation of error or warning messages, only
+the behaviour of the parser and its return code.<br>
+ <br>
+ <h3><a name="Compatibility_mode"></a>Compatibility mode<br>
+ </h3>
+Applications are not necessarily true to the GEDCOM spec (or use a different
+version than 5.5). The intention is that the library is resilient to
+this, and goes in compatibility mode for files written by specific programs
+(detected via the HEAD.SOUR tag). This compatibility mode can be enabled
+and disabled via the following function:<br>
+ <blockquote><code>void <b>gedcom_set_compat_handling</b>
+ (int enable_compat)</code><br>
+ </blockquote>
+The argument can be:<br>
+ <ul>
+ <li>0: disable compatibility mode</li>
+ <li>1: allow compatibility mode (this is the default)<br>
+ </li>
+ </ul>
+Note that, currently, no actual compatibility code is present, but this is
+on the to-do list.<br>
+ <hr width="100%" size="2">$Id: usage.html,v 1.1 2001/12/30
+22:45:43 verthezp Exp $<br>
+ $Name$<br>
+ <br>
+
+ </body>
+ </html>
projects / gedcom-parse.git / commitdiff