advertisement

This page describes a set of tests included in version 1.05 of the GEDCOM file assess.ged (download - view). Details change between versions.

Area Summary

People with the surname "Flag" have GEDCOM records intended to set the value of a "flag". A flag is a simple name and value data structure used by some programs to determine group membership or to assign a simple attribute value to a person.

All the tests attempt to set a flag to the value "Y" or similar.

These tests help determine the best method for an application to export flags for the target application. The tests represent the flag export choices in GEDCOM Assessment.

Some target applications support flags using custom GEDCOM records. At present, there are no tests for those custom GEDCOM records. I am not aware of any custom GEDCOM records for flags that are used by more than one target application.

01-Export as Fact-Type

The 01-Export as Fact-Type person's INDI record uses GEDCOM FACT and TYPE records to set a flag value. If the target application implements GEDCOM 5.5.1's generic FACT attribute, this method will define an attribute accurately and succintly.

Test Result Criteria

  1. If a target application imports the FACT record and its value, and its TYPE value is used as the label for that record, set the test result to "Supported".
  2. If a target application rejects the FACT record with a message in its import log, set the test result to "Rejected".
  3. If a target application ignores the FACT record, set the test result to "Ignored".
  4. For any other outcome, set the test result to "Imported Incorrectly" and describe the outcome in the comment.

GEDCOM Records for @I186@

1 FACT Y
2 TYPE CustomFactFlag

02-Export as Fact-Type (VP)

The 02-Export as Fact-Type (VP) person's INDI record uses GEDCOM FACT and TYPE records to set a flag value. Unlike the prior person, the value includes a prefix, "V:". A flag prefix is useful for target applications that suppress the "Y" value when reading the FACT record.

If this person has a value for CustomFlag but 01-Export as Fact-Type Flag does not, then a value prefix is necessary to avoid suppression of "Y" values.

Test Result Criteria

  1. If a target application imports the FACT record and its value, and its TYPE value is used as the label for that record, set the test result to "Supported".
  2. If a target application rejects the FACT record with a message in its import log, set the test result to "Rejected".
  3. If a target application ignores the FACT record, set the test result to "Ignored".
  4. For any other outcome, set the test result to "Imported Incorrectly" and describe the outcome in the comment.

GEDCOM Records for @I187@

1 FACT V:Y
2 TYPE CustomFactFlag

Letters N and S indicating non-standard 03-Export as Even-Type

The 03-Export as Even-Type person's INDI record uses GEDCOM EVEN and TYPE records to set a flag value. If the target application does not implement GEDCOM 5.5.1's generic FACT attribute, using EVEN and TYPE is the next best alternative. However, the GEDCOM 5.5.1 specification is ambiguous regarding placing a text value on the EVEN record, so the target application may ignore the value and/or reject the record.

Using FACT is better than EVEN because storing a flag value aligns with the intended purpose of the FACT record and does not align as well with the purpose of the EVEN record. Target applications that recognize FACT records will often provide a superior user interface for displaying, manipulating, and using custom facts.

Test Result Criteria

  1. If a target application imports the EVEN record and its value, and its TYPE value is used as the label for that record, set the test result to "Supported".
  2. If a target application rejects the EVEN record with a message in its import log, set the test result to "Rejected".
  3. If a target application ignores the EVEN record, set the test result to "Ignored".
  4. For any other outcome, set the test result to "Not Supported (non-standard)" and describe the outcome in the comment.

Non-Standard Content

This test includes a text value on the EVEN record. The GEDCOM 5.5.1 specification is somewhat ambiguous about whether or not text is allowed in that location. The structure descriptions do not show a value there, but examples elsewhere in the document do show a value there. Some target applications will load a value from the text field, and some even require it.

GEDCOM Records for @I188@

1 EVEN Y
2 TYPE CustomEventFlag

Letters N and S indicating non-standard 04-Export as Even-Type (VP)

The 04-Export as Even-Type (VP) person's INDI record uses GEDCOM EVEN and TYPE records to set a flag value. Unlike the prior person, the value includes a prefix, "V:". A flag prefix is useful for target applications that suppress the "Y" value when reading the EVEN record.

If this person has a value for CustomFlag but 03-Export as Even-Type Flag does not, then a value prefix is necessary to avoid suppression of "Y" values.

Test Result Criteria

  1. If a target application imports the EVEN record and its value, and its TYPE value is used as the label for that record, set the test result to "Supported".
  2. If a target application rejects the EVEN record with a message in its import log, set the test result to "Rejected".
  3. If a target application ignores the EVEN record, set the test result to "Ignored".
  4. For any other outcome, set the test result to "Not Supported (non-standard)" and describe the outcome in the comment.

Non-Standard Content

This test includes a text value on the EVEN record. The GEDCOM 5.5.1 specification is somewhat ambiguous about whether or not text is allowed in that location. The structure descriptions do not show a value there, but examples elsewhere in the document do show a value there. Some target applications will load a value from the text field, and some even require it.

GEDCOM Records for @I189@

1 EVEN V:Y
2 TYPE CustomEventFlag

05-Export as Even-Type-Note

The 05-Export as Even-Type-Note person's INDI record uses GEDCOM EVEN, TYPE, and NOTE records to set a flag value. This method is reliable, but it is only the best choice if none of the prior methods succceed. Note values are often only visible after clicking a button and that makes custom flags less useful than when the flag value is prominent.

Test Result Criteria

  1. If a target application imports the EVEN record and its value as a NOTE, and its TYPE value is used as the label for that record, set the test result to "Supported".
  2. If a target application rejects the EVEN record with a message in its import log, set the test result to "Rejected".
  3. If a target application ignores the EVEN record, set the test result to "Ignored".
  4. For any other outcome, set the test result to "Imported Incorrectly" and describe the outcome in the comment.

GEDCOM Records for @I190@

1 EVEN
2 TYPE CustomEventFlag
2 NOTE Y
On This Page