X-Git-Url: https://git.dlugolecki.net.pl/?a=blobdiff_plain;f=doc%2Finterface.html;h=5e9d8b23cb980f4eaef7fa1002067c3e40331fc8;hb=133000dc1075930c51adae600c732ee1ab9ffab0;hp=46ccd08ce9338d09783b91d201f8564ea480ace1;hpb=a6f453d612fe285d2585b689e3e4d675de455510;p=gedcom-parse.git diff --git a/doc/interface.html b/doc/interface.html index 46ccd08..5e9d8b2 100644 --- a/doc/interface.html +++ b/doc/interface.html @@ -1,1880 +1,2295 @@ - - -
-Gedcom_val
- type of the xref
argument in the header start callback.
+ Gedcom_val
type of the xref
and
+val
arguments in the header start callback.Record - |
- Meaning - |
+ |||
Record + |
+ Meaning + |
+ Possible + xref types+ |
Possible - xref types- |
- |
REC_HEAD - |
- The header of the GEDCOM file + val types+ |
+ |||
REC_HEAD + |
+ The header of the GEDCOM file + |
+ NULL + |
NULL |
- |
REC_FAM - |
- A record describing a family - |
- STRING - |
- ||
REC_INDI - |
- A record describing an individual - |
- STRING - |
- ||
REC_OBJE - |
- A record describing a multimedia object - |
- STRING - |
- ||
REC_NOTE - |
- A record describing a note - |
- STRING - |
- ||
REC_REPO - |
- A record describing a source repository - |
- STRING + | ||
REC_FAM + |
+ A record describing a family + |
+ XREF_PTR(FAM) + |
+ NULL |
- |
REC_SOUR + | ||||
REC_INDI + |
+ A record describing an individual + |
+ XREF_PTR(INDI) + |
+ NULL |
- A record describing a source + |
REC_OBJE + |
+ A record describing a multimedia object + |
+ XREF_PTR(OBJE) + |
+ NULL |
+ |
REC_NOTE + |
+ A record describing a note + |
+ XREF_PTR(NOTE) + |
STRING |
- |
REC_SUBN - |
- A record describing the submission + | |||
REC_REPO + |
+ A record describing a source repository + |
+ XREF_PTR(REPO) + |
+ NULL |
- STRING + |
REC_SOUR + |
+ A record describing a source + |
+ XREF_PTR(SOUR) + |
+ NULL |
- |
REC_SUBM + | ||||
REC_SUBN + |
+ A record describing the submission + |
+ XREF_PTR(SUBN) + |
+ NULL |
- A record describing the submitter + |
REC_SUBM + |
+ A record describing the submitter + |
+ XREF_PTR(SUBM )+ |
+ NULL |
- STRING + |
REC_USER + |
+ An application-specific record (the tag
+ in the start callback contains the actually used tag).+ |
+ NULL + |
+ NULL |
-
+ Gedcom_val
type of the val
argument in the
+element start callback.Element + |
+ Possible + tags + + |
+ Used within + |
+ Possible + val types+ + |
+
ELT_HEAD_SOUR + |
+ SOUR + |
+ REC_HEAD + |
+ STRING + |
+
ELT_HEAD_SOUR_VERS + |
+ VERS + |
+ ELT_HEAD_SOUR + |
+ STRING + |
+
ELT_HEAD_SOUR_NAME + |
+ NAME + |
+ ELT_HEAD_SOUR + |
+ STRING + |
+
ELT_HEAD_SOUR_CORP + |
+ CORP + |
+ ELT_HEAD_SOUR + |
+ STRING + |
+
ELT_HEAD_SOUR_DATA + |
+ DATA + |
+ ELT_HEAD_SOUR + |
+ STRING + |
+
ELT_HEAD_SOUR_DATA_DATE + |
+ DATE + |
+ ELT_HEAD_SOUR_DATA + |
+ DATE + |
+
ELT_HEAD_SOUR_DATA_COPR + |
+ COPR + |
+ ELT_HEAD_SOUR_DATA + |
+ STRING + |
+
ELT_HEAD_DEST + |
+ DEST + |
+ REC_HEAD + |
+ STRING + |
+
ELT_HEAD_DATE + |
+ DATE + |
+ REC_HEAD + |
+ DATE + |
+
ELT_HEAD_DATE_TIME + |
+ TIME + |
+ ELT_HEAD_DATE + |
+ STRING + |
+
ELT_HEAD_SUBM + |
+ SUBM + |
+ REC_HEAD + |
+ XREF_PTR(SUBM) + |
+
ELT_HEAD_SUBN + |
+ SUBN + |
+ REC_HEAD + |
+ XREF_PTR(SUBN) + |
+
ELT_HEAD_FILE + |
+ FILE + |
+ REC_HEAD + |
+ STRING + |
+
ELT_HEAD_COPR + |
+ COPR + |
+ REC_HEAD + |
+ STRING + |
+
ELT_HEAD_GEDC + |
+ GEDC + |
+ REC_HEAD + |
+ NULL + |
+
ELT_HEAD_GEDC_VERS + |
+ VERS + |
+ ELT_HEAD_GEDC + |
+ STRING + |
+
ELT_HEAD_GEDC_FORM + |
+ FORM + |
+ ELT_HEAD_GEDC + |
+ STRING + |
+
ELT_HEAD_CHAR + |
+ CHAR + |
+ REC_HEAD + |
+ STRING + |
+
ELT_HEAD_CHAR_VERS + |
+ VERS + |
+ ELT_HEAD_CHAR + |
+ STRING + |
+
ELT_HEAD_LANG + |
+ LANG + |
+ REC_HEAD + |
+ STRING + |
+
ELT_HEAD_PLAC + |
+ PLAC + |
+ REC_HEAD + |
+ NULL + |
+
ELT_HEAD_PLAC_FORM + |
+ FORM + |
+ ELT_HEAD_PLAC + |
+ STRING + |
+
ELT_HEAD_NOTE + |
+ NOTE + |
+ REC_HEAD + |
+ STRING + |
+
ELT_FAM_HUSB + |
+ HUSB + |
+ REC_FAM + |
+ XREF_PTR(INDI) + |
+
ELT_FAM_WIFE + |
+ WIFE + |
+ REC_FAM + |
+ XREF_PTR(INDI) + |
+
ELT_FAM_CHIL + |
+ CHIL + |
+ REC_FAM + |
+ XREF_PTR(INDI) + |
+
ELT_FAM_NCHI + |
+ NCHI + |
+ REC_FAM + |
+ STRING + |
+
ELT_FAM_SUBM + |
+ SUBM + |
+ REC_FAM + |
+ XREF_PTR(SUBM) + |
+
ELT_INDI_RESN + |
+ RES N + |
+ REC_INDI + |
+ STRING + |
+
ELT_INDI_SEX + |
+ SEX + |
+ REC_INDI + |
+ STRING + |
+
ELT_INDI_SUBM + |
+ SUBM + |
+ REC_INDI + |
+ XREF_PTR(SUBM) + |
+
ELT_INDI_ALIA + |
+ ALIA + |
+ REC_INDI + |
+ XREF_PTR(INDI) + |
+
ELT_INDI_ANCI + |
+ ANCI + |
+ REC_INDI + |
+ XREF_PTR(SUBM) + |
+
ELT_INDI_DESI + |
+ DESI + |
+ REC_INDI + |
+ XREF_PTR(SUBM) + |
+
ELT_INDI_RFN + |
+ RFN + |
+ REC_INDI + |
+ STRING + |
+
ELT_INDI_AFN + |
+ AFN + |
+ REC_INDI + |
+ STRING + |
+
ELT_OBJE_FORM + |
+ FORM + |
+ REC_OBJE + |
+ STRING + |
+
ELT_OBJE_TITL + |
+ TITL + |
+ REC_OBJE + |
+ STRING + |
+
ELT_OBJE_BLOB + |
+ BLOB + |
+ REC_OBJE + |
+ NULL + |
+
ELT_OBJE_BLOB_CONT + |
+ CONT + |
+ ELT_OBJE_BLOB + |
+ STRING + |
+
ELT_OBJE_OBJE + |
+ OBJE + |
+ REC_OBJE + |
+ XREF_PTR(OBJE) + |
+
ELT_REPO_NAME + |
+ NAME + |
+ REC_REPO + |
+ STRING + |
+
ELT_SOUR_DATA + |
+ DATA + |
+ REC_SOUR + |
+ NULL + |
+
ELT_SOUR_DATA_EVEN + |
+ EVEN + |
+ ELT_SOUR_DATA + |
+ STRING + |
+
ELT_SOUR_DATA_EVEN_DATE + |
+ DATE + |
+ ELT_SOUR_DATA_EVEN + |
+ DATE + |
+
ELT_SOUR_DATA_EVEN_PLAC + |
+ PLAC + |
+ ELT_SOUR_DATA_EVEN + |
+ STRING + |
+
ELT_SOUR_DATA_AGNC + |
+ AGNC + |
+ ELT_SOUR_DATA + |
+ STRING + |
+
ELT_SOUR_AUTH + |
+ AUTH + |
+ REC_SOUR + |
+ STRING + |
+
ELT_SOUR_TITL + |
+ TITL + |
+ REC_SOUR + |
+ STRING + |
+
ELT_SOUR_ABBR + |
+ ABBR + |
+ REC_SOUR + |
+ STRING + |
+
ELT_SOUR_PUBL + |
+ PUBL + |
+ REC_SOUR + |
+ STRING + |
+
ELT_SOUR_TEXT + |
+ TEXT + |
+ REC_SOUR + |
+ STRING + |
+
ELT_SUBN_SUBM + |
+ SUBM + |
+ REC_SUBN + |
+ XREF_PTR(SUBM) + |
+
ELT_SUBN_FAMF + |
+ FAMF + |
+ REC_SUBN + |
+ STRING + |
+
ELT_SUBN_TEMP + |
+ TEMP + |
+ REC_SUBN + |
+ STRING + |
+
ELT_SUBN_ANCE + |
+ ANCE + |
+ REC_SUBN + |
+ STRING + |
+
ELT_SUBN_DESC + |
+ DESC + |
+ REC_SUBN + |
+ STRING + |
+
ELT_SUBN_ORDI + |
+ ORDI + |
+ REC_SUBN + |
+ STRING + |
+
ELT_SUBN_RIN + |
+ RIN + |
+ REC_SUBN + |
+ STRING + |
+
ELT_SUBM_NAME + |
+ NAME + |
+ REC_SUBM + |
+ STRING + |
+
ELT_SUBM_LANG + |
+ LANG + |
+ REC_SUBM + |
+ STRING + |
+
ELT_SUBM_RFN + |
+ RFN + |
+ REC_SUBM + |
+ STRING + |
+
ELT_SUBM_RIN + |
+ RIN + |
+ REC_SUBM + |
+ STRING + |
+
ELT_SUB_ADDR + |
+ ADDR + |
+ ELT_HEAD_SOUR_CORP, ELT_SUB_FAM_EVT ,+ ELT_SUB_FAM_EVT_EVEN, + |
+ STRING + |
+
ELT_SUB_ADDR_CONT + |
+ CONT + |
+ ELT_SUB_ADDR + |
+ STRING + |
+
ELT_SUB_ADDR_ADR1 + |
+ ADR1 + |
+ ELT_SUB_ADDR + |
+ STRING + |
+
ELT_SUB_ADDR_ADR2 + |
+ ADR2 + |
+ ELT_SUB_ADDR + |
+ STRING + |
+
ELT_SUB_ADDR_CITY + |
+ CITY + |
+ ELT_SUB_ADDR + |
+ STRING + |
+
ELT_SUB_ADDR_STAE + |
+ STAE + |
+ ELT_SUB_ADDR + |
+ STRING + |
+
ELT_SUB_ADDR_POST + |
+ POST + |
+ ELT_SUB_ADDR + |
+ STRING + |
+
ELT_SUB_ADDR_CTRY + |
+ CTRY + |
+ ELT_SUB_ADDR + |
+ STRING + |
+
ELT_SUB_PHON + |
+ PHON + |
+ ELT_HEAD_SOUR_CORP, ELT_SUB_FAM_EVT, ELT_SUB_FAM_EVT_EVEN, + |
+ STRING + |
+
ELT_SUB_ASSO + |
+ ASSO + |
+ REC_INDI + |
+ XREF_PTR(FAM), + |
+
ELT_SUB_ASSO_TYPE + |
+ TYPE + |
+ ELT_SUB_ASSO + |
+ STRING + |
+
ELT_SUB_ASSO_RELA + |
+ RELA + |
+ ELT_SUB_ASSO + |
+ STRING + |
+
ELT_SUB_CHAN + |
+ CHAN + |
+ REC_FAM, REC_INDI, + |
+ NULL + |
+
ELT_SUB_CHAN_DATE + |
+ DATE + |
+ ELT_SUB_CHAN + |
+ DATE + |
+
ELT_SUB_CHAN_TIME + |
+ TIME + |
+ ELT_SUB_CHAN_DATE + |
+ STRING + |
+
ELT_SUB_FAMC + |
+ FAMC + |
+ REC_INDI + |
+ XREF_PTR(FAM) + |
+
ELT_SUB_FAMC_PEDI + |
+ PEDI + |
+ ELT_SUB_FAMC + |
+ STRING + |
+
ELT_SUB_CONT + |
+ CONT + |
+ ELT_HEAD_NOTE, REC_NOTE, + |
+ STRING + |
+
ELT_SUB_CONC + |
+ CONC + |
+ ELT_HEAD_NOTE, REC_NOTE, + |
+ STRING + |
+
ELT_SUB_EVT_TYPE + |
+ TYPE + |
+ ELT_SUB_FAM_EVT, ELT_SUB_FAM_EVT_EVEN, + |
+ STRING + |
+
ELT_SUB_EVT_DATE + |
+ DATE + |
+ ELT_SUB_FAM_EVT ,+ ELT_SUB_FAM_EVT_EVEN, , + |
+ DATE + |
+
ELT_SUB_EVT_AGE + |
+ AGE + |
+ ELT_SUB_FAM_EVT, ELT_SUB_FAM_EVT_EVEN, , + |
+ AGE + |
+
ELT_SUB_EVT_AGNC + |
+ AGNC + |
+ ELT_SUB_FAM_EVT, ELT_SUB_FAM_EVT_EVEN, , + |
+ STRING + |
+
ELT_SUB_EVT_CAUS + |
+ CAUS + |
+ ELT_SUB_FAM_EVT, ELT_SUB_FAM_EVT_EVEN, , + |
+ STRING + |
+
ELT_SUB_FAM_EVT + |
+ ANUL, CENS, DIV, + |
+ REC_FAM + |
+ NULL + |
+
ELT_SUB_FAM_EVT_HUSB + |
+ HUSB + |
+ ELT_SUB_FAM_EVT ,+ ELT_SUB_FAM_EVT_EVEN + |
+ NULL + |
+
ELT_SUB_FAM_EVT_WIFE + |
+ WIFE + |
+ ELT_SUB_FAM_EVT ,+ ELT_SUB_FAM_EVT_EVEN + |
+ NULL + |
+
ELT_SUB_FAM_EVT_AGE + |
+ AGE + |
+ ELT_SUB_FAM_EVT_HUSB ,+ ELT_SUB_FAM_EVT_WIFE + |
+ AGE + |
+
ELT_SUB_FAM_EVT_EVEN + |
+ EVEN + |
+ REC_FAM + |
+ NULL + |
+
ELT_SUB_IDENT_REFN + |
+ REFN + |
+ REC_FAM, REC_INDI, + |
+ STRING + |
+
ELT_SUB_IDENT_REFN_TYPE + |
+ TYPE + |
+ ELT_SUB_IDENT_REFN + |
+ STRING + |
+
ELT_SUB_IDENT_RIN + |
+ RIN + |
+ REC_FAM, REC_INDI, + |
+ STRING + |
+
ELT_SUB_INDIV_ATTR + |
+ CAST, DSCR, EDUC, + |
+ REC_INDI + |
+ STRING + |
+
ELT_SUB_INDIV_RESI + |
+ RESI + |
+ REC_INDI + |
+ NULL + |
+
ELT_SUB_INDIV_BIRT + |
+ BIRT, CHR + |
+ REC_INDI + |
+ NULL + |
+
ELT_SUB_INDIV_BIRT_FAMC + |
+ FAMC + |
+ ELT_SUB_INDIV_BIRT + |
+ XREF_PTR(FAM) + |
+
ELT_SUB_INDIV_GEN + |
+ DEAT, BURI, CREM, + |
+ REC_INDI + |
+ NULL + |
+
ELT_SUB_INDIV_ADOP + |
+ ADOP + |
+ REC_INDI + |
+ NULL + |
+
ELT_SUB_INDIV_ADOP_FAMC + |
+ FAMC + |
+ ELT_SUB_INDIV_ADOP + |
+ XREF_PTR(FAM) + |
+
ELT_SUB_INDIV_ADOP_FAMC_ADOP + |
+ ADOP + |
+ ELT_SUB_INDIV_ADOP_FAMC + |
+ STRING + |
+
ELT_SUB_INDIV_EVEN + |
+ EVEN + |
+ REC_INDI + |
+ NULL + |
+
ELT_SUB_LIO_BAPL + |
+ BAPL, CONL, ENDL + |
+ REC_INDI + |
+ NULL + |
+
ELT_SUB_LIO_BAPL_STAT + |
+ STAT + |
+
ELT_SUB_LIO_BAPL, + |
+ STRING + |
+
ELT_SUB_LIO_BAPL_DATE + |
+ DATE + |
+ ELT_SUB_LIO_BAPL , + + |
+ DATE + |
+
ELT_SUB_LIO_BAPL_TEMP + |
+ TEMP + |
+ ELT_SUB_LIO_BAPL , + + |
+ STRING + |
+
ELT_SUB_LIO_BAPL_PLAC + |
+ PLAC + |
+ ELT_SUB_LIO_BAPL , + + |
+ STRING + |
+
ELT_SUB_LIO_SLGC + |
+ SLGC + |
+ REC_INDI + |
+ NULL + |
+
ELT_SUB_LIO_SLGC_FAMC + |
+ FAMC + |
+ ELT_SUB_LIO_SLGC + |
+ XREF_PTR(FAM) + |
+
ELT_SUB_LSS_SLGS + |
+ SLGS + |
+ REC_FAM + |
+ NULL + |
+
ELT_SUB_LSS_SLGS_STAT + |
+ STAT + |
+ ELT_SUB_LSS_SLGS + |
+ STRING + |
+
ELT_SUB_LSS_SLGS_DATE + |
+ DATE + |
+ ELT_SUB_LSS_SLGS + |
+ DATE + |
+
ELT_SUB_LSS_SLGS_TEMP + |
+ TEMP + |
+ ELT_SUB_LSS_SLGS + |
+ STRING + |
+
ELT_SUB_LSS_SLGS_PLAC + |
+ PLAC + |
+ ELT_SUB_LSS_SLGS + |
+ STRING + |
+
ELT_SUB_MULTIM_OBJE + |
+ OBJE + |
+ REC_FAM, REC_INDI, ELT_SUB_FAM_EVT, , + |
+ NULL + |
+
ELT_SUB_MULTIM_OBJE_FORM + |
+ FORM + |
+ ELT_SUB_MULTIM_OBJE + |
+ STRING + |
+
ELT_SUB_MULTIM_OBJE_TITL + |
+ TITL + |
+ ELT_SUB_MULTIM_OBJE + |
+ STRING + |
+
ELT_SUB_MULTIM_OBJE_FILE + |
+ FILE + |
+ ELT_SUB_MULTIM_OBJE + |
+ STRING + |
+
ELT_SUB_NOTE + |
+ NOTE + |
+ REC_FAM, REC_INDI, ELT_SUB_FAM_EVT, , + |
+ NULL + |
+
ELT_SUB_PERS_NAME + |
+ NAME + |
+ REC_INDI + |
+ STRING + |
+
ELT_SUB_PERS_NAME_NPFX + |
+ NPFX + |
+ ELT_SUB_PERS_NAME + |
+ STRING + |
+
ELT_SUB_PERS_NAME_GIVN + |
+ GIVN + |
+ ELT_SUB_PERS_NAME + |
+ STRING + |
+
ELT_SUB_PERS_NAME_NICK + |
+ NICK + |
+ ELT_SUB_PERS_NAME + |
+ STRING + |
+
ELT_SUB_PERS_NAME_SPFX + |
+ SPFX + |
+ ELT_SUB_PERS_NAME + |
+ STRING + |
+
ELT_SUB_PERS_NAME_SURN + |
+ SURN + |
+ ELT_SUB_PERS_NAME + |
+ STRING + |
+
ELT_SUB_PERS_NAME_NSFX + |
+ NSFX + |
+ ELT_SUB_PERS_NAME + |
+ STRING + |
+
ELT_SUB_PLAC + |
+ PLAC + |
+ ELT_SUB_FAM_EVT ,+ ELT_SUB_FAM_EVT_EVEN, ,
+ + |
+ STRING + |
+
ELT_SUB_PLAC_FORM + |
+ FORM + |
+ ELT_SUB_PLAC + |
+ STRING + |
+
ELT_SUB_SOUR + |
+ SOUR + |
+ REC_FAM, REC_INDI, ELT_SUB_FAM_EVT, ELT_SUB_FAM_EVT_EVEN, , + |
+ STRING + |
+
ELT_SUB_SOUR_PAGE + |
+ PAGE + |
+ ELT_SUB_SOUR + |
+ STRING + |
+
ELT_SUB_SOUR_EVEN + |
+ EVEN + |
+ ELT_SUB_SOUR + |
+ STRING + |
+
ELT_SUB_SOUR_EVEN_ROLE + |
+ ROLE + |
+ ELT_SUB_SOUR_EVEN + |
+ STRING + |
+
ELT_SUB_SOUR_DATA + |
+ DATA + |
+ ELT_SUB_SOUR + |
+ NULL + |
+
ELT_SUB_SOUR_DATA_DATE + |
+ DATE + |
+ ELT_SUB_SOUR_DATA + |
+ DATE + |
+
ELT_SUB_SOUR_TEXT + |
+ TEXT + |
+ ELT_SUB_SOUR + |
+ STRING + |
+
ELT_SUB_SOUR_QUAY + |
+ QUAY + |
+ ELT_SUB_SOUR + |
+ STRING + |
+
ELT_SUB_REPO + |
+ REPO + |
+ REC_SOUR + |
+ XREF_PTR(REPO) + |
+
ELT_SUB_REPO_CALN + |
+ CALN + |
+ ELT_SUB_REPO + |
+ STRING + |
+
ELT_SUB_REPO_CALN_MEDI + |
+ MEDI + |
+ ELT_SUB_REPO_CALN + |
+ STRING + |
+
ELT_SUB_FAMS + |
+ FAMS + |
+ REC_INDI + |
+ XREF_PTR(FAM) + |
+
ELT_USER + |
+ any tag starting + |
+ anywhere + |
+ NULL + |
+
Gedcom_val
types are (with
+ val
of type Gedcom_val
):+ |
+ type checker + |
+ cast operator + |
+ ||
null value + |
+ GEDCOM_IS_NULL(val) + |
+ N/A + |
+ ||
string + |
+ GEDCOM_IS_STRING(val) + |
+ char* str = GEDCOM_STRING(val); + |
+ ||
date + |
+ GEDCOM_IS_DATE(val) + |
+ struct date_value dv = GEDCOM_DATE(val); |
+ ||
REC_USER + | age + |
+ GEDCOM_IS_AGE(val) + |
+ struct age_value age = GEDCOM_AGE(val); + |
+ |
xref pointer |
- An application-specific record (the tag
- in the start callback contains the actually used tag).+ | GEDCOM_IS_XREF_PTR(val) |
- NULL - STRING + | struct xref_value *xr = GEDCOM_XREF_PTR(val); |
-Gedcom_val
type of the val
argument in the element
-start callback. (TO BE COMPLETED)GEDCOM_STRING(val)
is always the same as the
+raw_value
passed to the start callback, and is thus in fact redundant.+ It depends on the first member, the type, which members are actually + relevant:struct date_value {
+ Date_value_type type;
+ struct date date1;
+ struct date date2;
+ char phrase[MAX_PHRASE_LEN + + 1];
+ };
+
Date_value_type + |
+ Meaning + |
+ Relevant members + |
+
DV_NO_MODIFIER + |
+ just a simple date + |
+ date1 + |
+
DV_BEFORE + |
+ a range (BEFORE date1) + |
+ date1 + |
+
DV_AFTER + |
+ a range (AFTER date1) + |
+ date1 + |
+
DV_BETWEEN + |
+ a range (BETWEEN date1 AND date2) + |
+ date1, date2 + |
+
DV_FROM + |
+ a period (FROM date1) + |
+ date1 + |
+
DV_TO + |
+ a period (TO date1) + |
+ date1 + |
+
DV_FROM_TO + |
+ a period (FROM date1 TO date2) + |
+ date1, date2 + |
+
DV_ABOUT + |
+ an approximation (ABOUT date1) + |
+ date1 + |
+
DV_CALCULATED + |
+ an approximation (CALCULATED date1) + |
+ date1 + |
+
DV_ESTIMATED + |
+ an approximation (ESTIMATED date1) + |
+ date1 + |
+
DV_INTERPRETED + |
+ INTERPRETED date1 FROM a given free form date
+ phrase + |
+ date1, phrase + |
+
DV_PHRASE + |
+ a free form date phrase + |
+ phrase + |
+
date1
and date2
also have a strict syntax:+ The first four fields are the primary fields parsed from the value in + the GEDCOM file. Thestruct date {
+ Calendar_type cal;
+ char day_str[MAX_DAY_LEN + +1];
+ char month_str[MAX_MONTH_LEN + + 1];
+ char year_str[MAX_YEAR_LEN ++ 1];
+
+ int day;
+ int month;
+ int year;
+ Year_type year_type;
+
+ Date_type type;
+ long int sdn1;
+ long int sdn2;
+ };
+
day_str
, month_str
+ and year_str
are the literal parts of the date that denote
+ the day, month and year (the day_str
and month_str
+ can be empty) . The calendar type cal
is one of (see
+ calendar overview LINK TBD):CAL_GREGORIAN
: the Gregorian calendarCAL_JULIAN
: the Julian calendarCAL_HEBREW
: the Hebrew (Jewish) calendarCAL_FRENCH_REV
: the calendar used after the
+French RevolutionCAL_UNKNOWN
: an unknown calendar typeday
is just the numeric representation of
+the day_str
(starting from 1), -1 if the day_str
+ is emptymonth
is the month number of month_str
+ in the given calendar type (also starting from 1), -1 if the
+month_str
is emptyyear
is the numeric representation of the
+ year_str
year_str
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: "20 March 1677/78" is 20 March 1677 in "annunciation
+ style" and 20 March 1678 in "circumcision style" (the current style). See
+ calendar overview (LINK TBD).year
will contain the "circumcision style"
+ year (1678 in the example), and year_type
will be YEAR_DOUBLE.
+ Normal dates will have a year_type
equal to
+ YEAR_SINGLE
.++ +These are represented by a serial day number in+sdn1
+ and aDate_type
equal toDATE_EXACT
.
+
+ + ++These are represented by 2 serial day numbers (+ +sdn1
andsdn2
) and aDate_type
equal +toDATE_BOUNDED
.
+
+ + 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.
+
+
+struct age_value {
+ Age_type type;
+ Age_modifier mod;
+ int years;
+ int months;
+ int days;
+ char phrase[MAX_PHRASE_LEN + + 1];
+ };
+
++ + + + It depends on the first member, the type, which members are actually + relevant:
Element - |
- Possible -tags - - |
- Used within - |
- Possible - val types- - |
-
ELT_HEAD_SOUR - |
- SOUR - |
- REC_HEAD - |
- STRING - |
-
ELT_HEAD_SOUR_VERS - |
- VERS - |
- ELT_HEAD_SOUR - |
- STRING - |
-
ELT_HEAD_SOUR_NAME - |
- NAME - |
- ELT_HEAD_SOUR - |
- STRING - |
-
ELT_HEAD_SOUR_CORP - |
- CORP - |
- ELT_HEAD_SOUR - |
- STRING - |
-
ELT_HEAD_SOUR_DATA - |
- DATA - |
- ELT_HEAD_SOUR - |
- STRING - |
-
ELT_HEAD_SOUR_DATA_DATE - |
- DATE - |
- ELT_HEAD_SOUR_DATA - |
- DATE - |
-
ELT_HEAD_SOUR_DATA_COPR - |
- COPR - |
- ELT_HEAD_SOUR_DATA - |
- STRING - |
-
ELT_HEAD_DEST - |
- DEST - |
- REC_HEAD - |
- STRING - |
-
ELT_HEAD_DATE - |
- DATE - |
- REC_HEAD - |
- DATE - |
-
ELT_HEAD_DATE_TIME - |
- TIME - |
- ELT_HEAD_DATE - |
- STRING - |
-
ELT_HEAD_SUBM - |
- SUBM - |
- REC_HEAD - |
- STRING - |
-
ELT_HEAD_SUBN - |
- SUBN - |
- REC_HEAD - |
- STRING - |
-
ELT_HEAD_FILE - |
- FILE - |
- REC_HEAD - |
- STRING - |
-
ELT_HEAD_COPR - |
- COPR - |
- REC_HEAD - |
- STRING - |
-
ELT_HEAD_GEDC - |
- GEDC - |
- REC_HEAD - |
- NULL - |
-
ELT_HEAD_GEDC_VERS - |
- VERS - |
- ELT_HEAD_GEDC - |
- STRING - |
-
ELT_HEAD_GEDC_FORM - |
- FORM - |
- ELT_HEAD_GEDC - |
- STRING - |
-
ELT_HEAD_CHAR - |
- CHAR - |
- REC_HEAD - |
- STRING - |
-
ELT_HEAD_CHAR_VERS - |
- VERS - |
- ELT_HEAD_CHAR - |
- STRING - |
-
ELT_HEAD_LANG - |
- LANG - |
- REC_HEAD - |
- STRING - |
-
ELT_HEAD_PLAC - |
- PLAC - |
- REC_HEAD - |
- NULL - |
-
ELT_HEAD_PLAC_FORM - |
- FORM - |
- ELT_HEAD_PLAC - |
- STRING - |
-
ELT_HEAD_NOTE - |
- NOTE - |
- REC_HEAD - |
- STRING - |
-
ELT_FAM_HUSB - |
- HUSB - |
- REC_FAM - |
- STRING - |
-
ELT_FAM_WIFE - |
- WIFE - |
- REC_FAM - |
- STRING - |
-
ELT_FAM_CHIL - |
- CHIL - |
- REC_FAM - |
- STRING - |
-
ELT_FAM_NCHI - |
- NCHI - |
- REC_FAM - |
- STRING - |
-
ELT_FAM_SUBM - |
- SUBM - |
- REC_FAM - |
- STRING - |
-
ELT_INDI_RESN - |
- RES N - |
- REC_INDI - |
- STRING - |
-
ELT_INDI_SEX - |
- SEX - |
- REC_INDI - |
- STRING - |
-
ELT_INDI_SUBM - |
- SUBM - |
- REC_INDI - |
- STRING - |
-
ELT_INDI_ALIA - |
- ALIA - |
- REC_INDI - |
- STRING - |
-
ELT_INDI_ANCI - |
- ANCI - |
- - |
- STRING - |
-
ELT_INDI_DESI - |
- DESI - |
- - |
- STRING - |
-
ELT_INDI_RFN - |
- RFN - |
- - |
- STRING - |
-
ELT_INDI_AFN - |
- AFN - |
- - |
- STRING - |
-
ELT_OBJE_FORM - |
- FORM - |
- - |
- STRING - |
-
ELT_OBJE_TITL - |
- TITL - |
- - |
- STRING - |
-
ELT_OBJE_BLOB - |
- BLOB - |
- - |
- NULL - |
-
ELT_OBJE_BLOB_CONT - |
- CONT - |
- - |
- STRING - |
-
ELT_OBJE_OBJE - |
- OBJE - |
- - |
- STRING - |
-
ELT_REPO_NAME - |
- NAME - |
- - |
- STRING - |
-
ELT_SOUR_DATA - |
- DATA - |
- - |
- NULL - |
-
ELT_SOUR_DATA_EVEN - |
- EVEN - |
- - |
- STRING - |
-
ELT_SOUR_DATA_EVEN_DATE - |
- DATE - |
- - |
- DATE - |
-
ELT_SOUR_DATA_EVEN_PLAC - |
- PLAC - |
- - |
- STRING - |
-
ELT_SOUR_DATA_AGNC - |
- AGNC - |
- - |
- STRING - |
-
ELT_SOUR_AUTH - |
- AUTH - |
- - |
- STRING - |
-
ELT_SOUR_TITL - |
- TITL - |
- - |
- STRING - |
-
ELT_SOUR_ABBR - |
- ABBR - |
- - |
- STRING - |
-
ELT_SOUR_PUBL - |
- PUBL - |
- - |
- STRING - |
-
ELT_SOUR_TEXT - |
- TEXT - |
- - |
- STRING - |
-
ELT_SUBN_SUBM - |
- SUBM - |
- - |
- STRING - |
-
ELT_SUBN_FAMF - |
- FAMF - |
- - |
- STRING - |
-
ELT_SUBN_TEMP - |
- TEMP - |
- - |
- STRING - |
-
ELT_SUBN_ANCE - |
- ANCE - |
- - |
- STRING - |
-
ELT_SUBN_DESC - |
- DESC - |
- - |
- STRING - |
-
ELT_SUBN_ORDI - |
- ORDI - |
- - |
- STRING - |
-
ELT_SUBN_RIN - |
- RIN - |
- - |
- STRING - |
-
ELT_SUBM_NAME - |
- NAME - |
- - |
- STRING - |
-
ELT_SUBM_LANG - |
- LANG - |
- - |
- STRING - |
-
ELT_SUBM_RFN - |
- RFN - |
- - |
- STRING - |
-
ELT_SUBM_RIN - |
- RIN - |
- - |
- STRING - |
-
ELT_SUB_ADDR - |
- ADDR - |
- - |
- STRING - |
-
ELT_SUB_ADDR_CONT - |
- CONT - |
- - |
- STRING - |
-
ELT_SUB_ADDR_ADR1 - |
- ADR1 - |
- - |
- STRING - |
-
ELT_SUB_ADDR_ADR2 - |
- ADR2 - |
- - |
- STRING - |
-
ELT_SUB_ADDR_CITY - |
- CITY - |
- - |
- STRING - |
-
ELT_SUB_ADDR_STAE - |
- STAE - |
- - |
- STRING - |
-
ELT_SUB_ADDR_POST - |
- POST - |
- - |
- STRING - |
-
ELT_SUB_ADDR_CTRY - |
- CTRY - |
- - |
- STRING - |
-
ELT_SUB_PHON - |
- PHON - |
- - |
- STRING - |
-
ELT_SUB_ASSO - |
- ASSO - |
- - |
- STRING - |
-
ELT_SUB_ASSO_TYPE - |
- TYPE - |
- - |
- STRING - |
-
ELT_SUB_ASSO_RELA - |
- RELA - |
- - |
- STRING - |
-
ELT_SUB_CHAN - |
- CHAN - |
- - |
- NULL - |
-
ELT_SUB_CHAN_DATE - |
- DATE - |
- - |
- DATE - |
-
ELT_SUB_CHAN_TIME - |
- TIME - |
- - |
- STRING - |
-
ELT_SUB_FAMC - |
- FAMC - |
- - |
- STRING - |
-
ELT_SUB_FAMC_PEDI - |
- PEDI - |
- - |
- STRING - |
-
ELT_SUB_CONT - |
- CONT - |
- - |
- STRING - |
-
ELT_SUB_CONC - |
- CONC - |
- - |
- STRING - |
-
ELT_SUB_EVT_TYPE - |
- TYPE - |
- - |
- STRING - |
-
ELT_SUB_EVT_DATE - |
- DATE - |
- - |
- DATE - |
-
ELT_SUB_EVT_AGE - |
- AGE - |
- - |
- STRING - |
-
ELT_SUB_EVT_AGNC - |
- AGNC - |
- - |
- STRING - |
-
ELT_SUB_EVT_CAUS - |
- CAUS - |
- - |
- STRING - |
-
ELT_SUB_FAM_EVT - |
- ANUL, CENS, DIV, - |
- - |
- NULL - |
-
ELT_SUB_FAM_EVT_HUSB - |
- HUSB - |
- - |
- NULL - |
-
ELT_SUB_FAM_EVT_WIFE - |
- WIFE - |
- - |
- NULL - |
-
ELT_SUB_FAM_EVT_AGE - |
- AGE - |
- - |
- STRING - |
-
ELT_SUB_FAM_EVT_EVEN - |
- EVEN - |
- - |
- NULL - |
-
ELT_SUB_IDENT_REFN - |
- REFN - |
- - |
- STRING - |
-
ELT_SUB_IDENT_REFN_TYPE - |
- TYPE - |
- - |
- STRING - |
-
ELT_SUB_IDENT_RIN - |
- RIN - |
- - |
- STRING - |
-
ELT_SUB_INDIV_ATTR - |
- CAST, DSCR, EDUC, - |
- - |
- STRING - |
-
ELT_SUB_INDIV_RESI - |
- RESI - |
- - |
- NULL - |
-
ELT_SUB_INDIV_BIRT - |
- BIRT, CHR - |
- - |
- NULL - |
-
ELT_SUB_INDIV_BIRT_FAMC - |
- FAMC - |
- - |
- STRING - |
-
ELT_SUB_INDIV_GEN - |
- DEAT, BURI, CREM, - |
- - |
- NULL - |
-
ELT_SUB_INDIV_ADOP - |
- ADOP - |
- - |
- NULL - |
-
ELT_SUB_INDIV_ADOP_FAMC - |
- FAMC - |
- - |
- STRING - |
-
ELT_SUB_INDIV_ADOP_FAMC_ADOP - |
- ADOP - |
- - |
- STRING - |
-
ELT_SUB_INDIV_EVEN - |
- EVEN - |
- - |
- NULL - |
-
ELT_SUB_LIO_BAPL - |
- BAPL, CONL, ENDL - |
- - |
- NULL - |
-
ELT_SUB_LIO_BAPL_STAT - |
- STAT - |
- - |
- STRING - |
-
ELT_SUB_LIO_BAPL_DATE - |
- DATE - |
- - |
- DATE - |
-
ELT_SUB_LIO_BAPL_TEMP - |
- TEMP - |
- - |
- STRING - |
-
ELT_SUB_LIO_BAPL_PLAC - |
- PLAC - |
- - |
- STRING - |
-
ELT_SUB_LIO_SLGC - |
- SLGC - |
- - |
- NULL - |
-
ELT_SUB_LIO_SLGC_FAMC - |
- FAMC - |
- - |
- STRING - |
-
ELT_SUB_LSS_SLGS - |
- SLGS - |
- - |
- NULL - |
-
ELT_SUB_LSS_SLGS_STAT - |
- STAT - |
- - |
- STRING - |
-
ELT_SUB_LSS_SLGS_DATE - |
- DATE - |
- - |
- DATE - |
-
ELT_SUB_LSS_SLGS_TEMP - |
- TEMP - |
- - |
- STRING - |
-
ELT_SUB_LSS_SLGS_PLAC - |
- PLAC - |
- - |
- STRING - |
-
ELT_SUB_MULTIM_OBJE - |
- OBJE - |
- - |
- NULL - |
-
ELT_SUB_MULTIM_OBJE_FORM - |
- FORM - |
- - |
- STRING - |
-
ELT_SUB_MULTIM_OBJE_TITL - |
- TITL - |
- - |
- STRING - |
-
ELT_SUB_MULTIM_OBJE_FILE - |
- FILE - |
- - |
- STRING - |
-
ELT_SUB_NOTE - |
- NOTE - |
- - |
- NULL - |
-
ELT_SUB_PERS_NAME - |
- NAME - |
- - |
- STRING - |
-
ELT_SUB_PERS_NAME_NPFX - |
- NPFX - |
- - |
- STRING - |
-
ELT_SUB_PERS_NAME_GIVN - |
- GIVN - |
- - |
- STRING - |
-
ELT_SUB_PERS_NAME_NICK - |
- NICK - |
- - |
- STRING - |
-
ELT_SUB_PERS_NAME_SPFX - |
- SPFX - |
- - |
- STRING - |
-
ELT_SUB_PERS_NAME_SURN - |
- SURN - |
- - |
- STRING - |
-
ELT_SUB_PERS_NAME_NSFX - |
- NSFX - |
- - |
- STRING - |
-
ELT_SUB_PLAC - |
- PLAC - |
- - |
- STRING - |
-
ELT_SUB_PLAC_FORM - |
- FORM - |
- - |
- STRING - |
-
ELT_SUB_SOUR - |
- SOUR - |
- - |
- STRING - |
-
ELT_SUB_SOUR_PAGE - |
- PAGE - |
- - |
- STRING - |
-
ELT_SUB_SOUR_EVEN - |
- EVEN - |
- - |
- STRING - |
-
ELT_SUB_SOUR_EVEN_ROLE - |
- ROLE - |
- - |
- STRING - |
-
ELT_SUB_SOUR_DATA - |
- DATA - |
- - |
- NULL - |
-
ELT_SUB_SOUR_DATA_DATE - |
- DATE - |
- - |
- DATE - |
-
ELT_SUB_SOUR_TEXT - |
- TEXT - |
- - |
- STRING - |
-
ELT_SUB_SOUR_QUAY - |
- QUAY - |
- - |
- STRING - |
-
ELT_SUB_REPO - |
- REPO - |
- - |
- STRING - |
-
ELT_SUB_REPO_CALN - |
- CALN - |
- - |
- STRING - |
-
ELT_SUB_REPO_CALN_MEDI - |
- MEDI - |
- - |
- STRING - |
-
ELT_SUB_FAMS - |
- FAMS - |
- - |
- STRING - |
-
ELT_USER - |
- any tag starting - |
- - |
- NULL - |
-
Gedcom_val
types are (with val
- of type Gedcom_val
):- |
- type checker - |
- cast operator - |
-
null value - |
- GEDCOM_IS_NULL(val) - |
- N/A - |
-
string - |
- GEDCOM_IS_STRING(val) - |
- char* str = GEDCOM_STRING(val); - |
-
date - |
- GEDCOM_IS_DATE(val) - |
- struct date_value dv = GEDCOM_DATE(val); |
-
Age_type + |
+ Meaning + |
+ Relevant members + |
+
AGE_UNRECOGNIZED + |
+ format not recognized, full raw value in phrase + |
+ phrase + |
+
AGE_CHILD + |
+ the indication 'CHILD' + |
+ mod + |
+
AGE_INFANT + |
+ the indication 'INFANT' + |
+ mod + |
+
AGE_STILLBORN + |
+ the indication 'STILLBORN' + |
+ mod + |
AGE_NUMERIC + |
+ an indication in years, months and/or days (each can be -1 if not given) + |
+ mod, years, months, days + |
+
AGE_NO_MODIFIER
: no modifierAGE_LESS_THAN
: the modifier '<' is addedAGE_GREATER_THAN
: the modifier '>' is addedGedcom_val
contains a pointer to such a struct, not the struct
+itself). It is defined as:+ Thestruct xref_value {
+ Xref_type type,
+ char* string,
+ Gedcom_ctxt object
+ };
+
Xref_type
gives the type of the cross-reference and can
+be one of:XREF_NONE
(used as default value)XREF_FAM
XREF_INDI
XREF_NOTE
XREF_OBJE
XREF_REPO
XREF_SOUR
XREF_SUBM
XREF_SUBN
XREF_ANY
(if the type is not known, see below)XREF_USER
(for application-specific cross-references)
string
gives the actual cross-reference string from the
+GEDCOM file, and the object
is initially NULL,
but
+can be filled by the application with an object (of any type) that corresponds
+with the cross-reference, and then later extracted when the cross-reference
+is used or defined again in the file. This relieves the application
+from the burden of maintaining the mapping between cross-references and objects.XREF_ANY
is used when the type of the object is not
+immediately known: it has to come from further information. This is
+the case in an association (ELT_SUB_ASSO
): the type is then given by the TYPE
subtag.struct date_value {
- Date_value_type type;
- struct date date1;
- struct date date2;
- char phrase[MAX_PHRASE_LEN -+ 1];
-};
+The following functions are available to manipulate xref_value objects:
++struct xref_value* gedcom_get_by_xref (const char *key)
+Retrieve an xref_value by its key. Returns- It depends on the first member, the type, which members are actually relevant:NULL
if the given key isn't a valid cross-reference key (see below) or isn't used.
-
-- -
-- -Date_value_type -
-Meaning -
-Relevant members -
-- -- DV_NO_MODIFIER
-just a simple date -
-date1 -
-- -- DV_BEFORE
-a range (BEFORE date1) -
-date1 -
-- -- DV_AFTER
-a range (AFTER date1) -
-date1 -
-- -- DV_BETWEEN
-a range (BETWEEN date1 AND date2) -
-date1, date2 -
-- -- DV_FROM
-a period (FROM date1) -
-date1 -
-- -- DV_TO
-a period (TO date1) -
-date1 -
-- -- DV_FROM_TO
-a period (FROM date1 TO date2) -
-date1, date2 -
-- -- DV_ABOUT
-an approximation (ABOUT date1) -
-date1 -
-- -- DV_CALCULATED
-an approximation (CALCULATED date1) -
-date1 -
-- -- DV_ESTIMATED
-an approximation (ESTIMATED date1) -
-date1 -
-- -- DV_INTERPRETED
-INTERPRETED date1 FROM a given free form date phrase -
-date1, phrase -
-- - -- DV_PHRASE
-a free form date phrase -
-phrase -
-
-struct date
-The
-date1
anddate2
also have a strict syntax:
--The first four fields are the primary fields parsed from the value in the -GEDCOM file. Thestruct date {
- Calendar_type cal;
- char day_str[MAX_DAY_LEN + 1];
- char month_str[MAX_MONTH_LEN + -1];
- char year_str[MAX_YEAR_LEN + 1];
-
- int day;
- int month;
- int year;
- Year_type year_type;
-
- Date_type type;
- long int sdn1;
- long int sdn2;
-};
-day_str
,month_str
and-year_str
are the literal parts of the date that denote the day, month -and year. The calendar typecal
is one of (see calendar -overview LINK TBD):
+struct xref_value* gedcom_add_xref (Xref_type type, const char* key, Gedcom_ctxt object)
+Add an xref_value of the given+type
(see list above), with the givenkey
, to the givenobject
, with a use count equal to 0. Returns the new xref_value if success. ReturnsNULL
in one of the following cases:
-
-The next four fields are deduced from the first four:- -
CAL_GREGORIAN
: the Gregorian calendar- -
CAL_JULIAN
: the Julian calendar- -
CAL_HEBREW
: the Hebrew (Jewish) calendar- -
CAL_FRENCH_REV
: the calendar used after the French -Revolution- +
CAL_UNKNOWN
: an unknown calendar type- the key isn't a valid cross-reference key (see below)
+- there is already an xref_value with the same key
+- there was a memory allocation error
+int gedcom_delete_xref (const char* key)
+
+Delete the xref_value corresponding to the given key. Returns 0 if success. Returns 1 in one of the following cases:+
-
-It is possible that the- the
-day
is just the numeric representation of the -day_str
(starting from 1)- the
-month
is the month number ofmonth_str
- in the given calendar type (also starting from 1)- the
+year
is the numeric representation of the-year_str
- the key isn't a valid cross-reference key (see below)
+- there is no xref_value with the given key
+- the xref_value is still in use, i.e. its use count is not 0 (see
gedcom_link_xref
andgedcom_unlink_xref
below)year_str
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 (LINK TBD).
-
-In this case, theyear
will contain the "circumcision style" -year (1678 in the example), andyear_type
will beYEAR_DOUBLE.
- Normal dates will have ayear_type
equal toYEAR_SINGLE
-.
-
-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.
+struct xref_value* gedcom_link_xref (Xref_type type, const char* key)
+struct xref_value* gedcom_unlink_xref (Xref_type type, const char* key)
+Declare the xref_value corresponding to the given key as being +used/no longer used (linked to or unlinked) as the given type. The +use of these functions is not mandatory, but it can aid in spotting places in the code where xref_value objects are deleted while they are still referenced.+
-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:
+Returns the xref_value object if success, and its use count is incremented/decremented. ReturnsNULL
in one of the following cases:
-
-- Exact dates (e.g. "25 MAR 1990"):
+- the key isn't a valid cross-reference key (see below)
+- there is no xref_value with the given key
+- the xref_value was previously added as another type than the type provided here
+--These are represented by a serial day number in-sdn1
- and aDate_type
equal toDATE_EXACT
.
--
-- Incomplete dates (e.g. "MAR 1990"):
---These are represented by 2 serial day numbers (--sdn1
andsdn2
) and aDate_type
equal to -DATE_BOUNDED
.
-
-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.
-
-
$Id$
- $Name$
-
- - - +++ +A cross-reference key must be a string of maximum 22 characters, of the following format:
++
+An example would thus be: "@This is an xref_val@".- an at sign ('@')
+- followed by an alphanumeric character (A-Z, a-z, 0-9 or underscore)
+- followed by zero or more characters, which can be any character except an at sign
+- terminated by an at sign ('@')
+
+ + +
+$Id$+
$Name$
+ +
+
+
+
+
+ \ No newline at end of file