Draft v8.0 replacement structure for personal names. #524
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -1048,64 +1048,91 @@ See `SHARED_NOTE_RECORD` for advice on choosing between `NOTE` and `SNOTE`. | |||||
|
|
||||||
| A `NOTE_STRUCTURE` can contain a `SOURCE_CITATION`, which in turn can contain a `NOTE_STRUCTURE`, allowing potentially unbounded nesting of structures. Because each dataset is finite, this nesting is also guaranteed to be finite. | ||||||
|
|
||||||
| #### `PERSONAL_NAME_STRUCTURE` := | ||||||
|
|
||||||
| ```gedstruct | ||||||
| n NAME {1:1} g8:INDI-NAME | ||||||
| +1 TYPE <List:Enum> {0:1} g8:NAME-TYPE | ||||||
| +2 PHRASE <Text> {0:1} g7:PHRASE | ||||||
| +1 PART <Text> {0:M} g8:NAME-PART | ||||||
| +2 TYPE <List:Enum> {1:1} g8:NAME-PART-TYPE | ||||||
| +2 LANG <Language> {0:1} g7:LANG | ||||||
| +2 TRAN <Text> {0:M} g8:TRAN | ||||||
| +3 LANG <Language> {1:1} g7:LANG | ||||||
| +2 DATE <DateValue> {0:M} g7:DATE | ||||||
| +2 <<SOURCE_CITATION>> {0:M} | ||||||
| +1 FORM <Text> {1:M} g8:NAME-FORM | ||||||
| +2 TYPE <List:Enum> {0:1} g8:NAME-FORM-TYPE | ||||||
| +2 LANG <Language> {0:1} g7:LANG | ||||||
| +2 TRAN <Text> {0:M} g8:TRAN | ||||||
| +3 LANG <Language> {1:1} g7:LANG | ||||||
| +2 DATE <DateValue> {0:M} g7:DATE | ||||||
| +2 <<SOURCE_CITATION>> {0:M} | ||||||
| +1 <<NOTE_STRUCTURE>> {0:M} | ||||||
|
There was a problem hiding this comment. I think we need a |
||||||
| ``` | ||||||
|
|
||||||
| A name identifying an individual, which may have multiple forms and be composed of multiple parts. | ||||||
| Both name forms and name parts are called "names" in some situations, but may be distinguished as follows: | ||||||
|
|
||||||
| - A `g8:NAME-FORM` stores a string used to identify the individual by name; for example "`John Farmer`". | ||||||
| - A `g8:NAME-PART` stores a distinct component of a name; for example, "`John`". | ||||||
| - A `g8:INDI-NAME` stores all the variants and parts of an individual's name that are considered part of a single name. | ||||||
|
|
||||||
| :::example | ||||||
| Leonardo da Vinci might have a name structure like this: | ||||||
|
|
||||||
| ```gedcom | ||||||
| 1 NAME | ||||||
| 2 FORM Leonardo da Vinci | ||||||
| 2 FORM Leonardo di ser Piero da Vinci | ||||||
| 2 PART Leonardo | ||||||
| 3 TYPE GIVN | ||||||
| 2 PART di ser Piero | ||||||
| 3 TYPE PATRONYMIC | ||||||
| 2 PART da Vinci | ||||||
| 3 TYPE LOCATION | ||||||
| 2 PART da | ||||||
| 3 TYPE PARTICLE | ||||||
| 2 PART Vinci | ||||||
| 3 TYPE LOCATION | ||||||
| ``` | ||||||
|
|
||||||
| There are other ways this could be encoded; the how many parts and forms to add is up to the user. | ||||||
|
There was a problem hiding this comment.
Suggested change
Can't parse grammar, not sure if this suggestion is what was intended |
||||||
| ::: | ||||||
|
|
||||||
| The decision of whether two name forms count as a variants of a single name or as distinct names varies by culture and individual. | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| It is common for much of each name form to be identified in an name part, | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| but there many be components of a name with no identified name part | ||||||
| and name parts that do not appear in any name form. | ||||||
|
|
||||||
| :::example | ||||||
| The Polish family name `Kowalski` has a feminine variant `Kowalska` and plural variant `Kowalscy`. | ||||||
| Including all three variants as name parts even though only one appears in any name form may facilitate searching and indexing in some applications. | ||||||
|
|
||||||
| ```gedcom | ||||||
| 1 NAME | ||||||
| 2 FORM Alfred Jan Maksymillian Kowalski | ||||||
| 2 PART Kowalski | ||||||
| 3 TYPE SURN | ||||||
| 2 PART Kowalska | ||||||
| 3 TYPE SURN, HIDDEN | ||||||
|
There was a problem hiding this comment. Per line 1110, should we have a type for "feminine"? And a type for "plural"? |
||||||
| 2 PART Kowalscy | ||||||
| 3 TYPE SURN, HIDDEN | ||||||
| ``` | ||||||
| ::: | ||||||
|
|
||||||
| As with other structures, the first `NAME` in and `INDI` provides the most-preferred name | ||||||
|
There was a problem hiding this comment.
Suggested change
See issue #528 about whether we should replace this statement with some other means of designating the most preferred name. |
||||||
| and its first `FORM` structure provides the most-preferred form of that name. | ||||||
| It is recommended that the first form of the first name be used to label individuals in a user interface or report when a single name string is desired. | ||||||
|
There was a problem hiding this comment. I'm somewhat averse to adding new structure ordering constraints in v8. See discussion in issue #528. |
||||||
|
|
||||||
| The order of name parts is not significant; name parts may be reorganized within a name without any change in meaning. | ||||||
|
|
||||||
| The name may be translated or transliterated into different languages or scripts using the `TRAN` substructures. | ||||||
|
|
||||||
| A `TYPE` is used to specify the particular variation that this name, name part, or name form is. | ||||||
| For example; it could indicate that this name is a name taken at immigration or that it could be an ‘also known as’ name. | ||||||
| See `g8:enumset-NAME-TYPE`, `g8:enumset-NAME-PART-TYPE`, and `g8:enumset-NAME-FORM-TYPE` for more details. | ||||||
|
|
||||||
| #### `PLACE_STRUCTURE` := | ||||||
|
|
||||||
|
|
||||||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -230,14 +230,83 @@ and applications should be prepared to encounter non-current values. | |||||
| | `SUBMITTED` | All | Ordinance was previously submitted. | Deprecated. This status was defined for use with TempleReady which is no longer in use. | | ||||||
| | `UNCLEARED` | All | Data for clearing the ordinance request was insufficient. | Deprecated. This status was defined for use with TempleReady which is no longer in use. | | ||||||
|
|
||||||
| ### `g8:enumset-NAME-TYPE` | ||||||
|
|
||||||
| | Value | Meaning | | ||||||
| | ----- | :---------------------------- | | ||||||
| | `ADOPTED` | Given as part of being adopted into a family. | | ||||||
| | `AKA` | Also known as, alias, etc. | | ||||||
| | `BIRTH` | Name given at or near birth. | | ||||||
| | `DIVORCED` | Name used after a divorce. | | ||||||
| | `FORMAL` | A name only used official, formal settings. | | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| | `GENERAL` | A name used in a wide variety of settings, both formal and informal. | | ||||||
| | `NICK` | A descriptive or familiar name that is used instead of, or in addition to, one’s official or legal name. Some cultures use this for any name that is not used in legal documents, others only for names that would be inappropriate in formal settings. | | ||||||
|
There was a problem hiding this comment. Should we get rid of |
||||||
| | `IMMIGRANT` | Name assumed at the time of immigration. | | ||||||
| | `INFORMAL` | A name only used in casual, intimate, or informal settings. | | ||||||
| | `LEGAL` | A name used for legal and official documents, but not in daily use. | | ||||||
| | `MAIDEN` | Maiden name, name before first marriage. | | ||||||
| | `MARRIED` | Married name, assumed as part of marriage. | | ||||||
| | `PROFESSIONAL` | Name used professionally (pen, screen, stage name). | | ||||||
| | `RELIGIOUS` | Religious name, name adopted when joining a religious order. | | ||||||
|
There was a problem hiding this comment.
Suggested change
The pieces separated by comma are not synonymous (since a religious name might be given at a ceremony other than a joining ceremony). Perhaps add "or"? |
||||||
| | `VARIANT` | Different spelling for a name, also spellings based on other languages such as Latin, French. | | ||||||
| | `OTHER` | A value not listed here; should have a `PHRASE` substructure. | | ||||||
|
|
||||||
| Five of these types deserve additional comparison: | ||||||
|
|
||||||
| - A `LEGAL` name would be used on a contract but not in formal or informal settings | ||||||
|
There was a problem hiding this comment.
Suggested change
Can you give a well-known example of this? There was a problem hiding this comment. Example "James Earl Carter Jr." (rather than Jimmy Carter) |
||||||
| - A `FORMAL` would be used in formal settings but not informal ones; it is generally also used on contracts unless a different `LEGAL` name is present. | ||||||
| - A `GENERAL` name is used in both formal and informal settings, and on contracts unless a different `LEGAL` name is present. | ||||||
| - An `INFORMAL` name is used in informal settings but not in formal ones. | ||||||
| - A `NICK` is in some way unofficial, though exactly how varies by culture and individual, and may have any of the other types listed here. | ||||||
|
|
||||||
| ### `g8:enumset-NAME-FORM-TYPE` | ||||||
|
|
||||||
| | Value | Meaning | | ||||||
| | ----- | :---------------------------- | | ||||||
| | `FULL` | How a name is displayed when written out in full. Incompatible with `SHORT`. | | ||||||
| | `SHORT` | An abbreviated version of a name. Incompatible with `SHORT`. | | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| | `INFERRED` | A form not found in a source, but inferred from what was in the source and the local naming patterns. | | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| | `OTHER` | A value not listed here; should have a `PHRASE` substructure. | | ||||||
|
|
||||||
| It is expected that many name forms will have no `TYPE`. | ||||||
| The researcher-preferred name form is indicated by its being the first `FORM` of the `NAME`, not by any `TYPE` value. | ||||||
|
|
||||||
| ### `g8:enumset-NAME-PART-TYPE` | ||||||
|
|
||||||
| | Value | Meaning | | ||||||
| | ----- | :---------------------------- | | ||||||
| | `ADOPTED` | Given as part of being adopted into a family. | | ||||||
| | `DIVORCED` | Name used after a divorce. | | ||||||
| | `ESTATE` | House name, farm name, or name after moving into or marrying into a house/farm. Implies `LOCATION`. Incompatible with `SURN`. | | | ||||||
| | `FORMAL` | A name only used official, formal settings. | | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| | `GENERAL` | A name used in a wide variety of settings, both formal and informal. | | ||||||
| | `GENERATIONAL` | A name part shared by particular generation of a family (i.e. siblings or first cousins, but not their parents or children). Implies a cultural pattern of sharing this part, not just a particular family's aesthetic naming patterns. | | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| | `GIVN` | A name given to an individual by someone's choice, rather than dictated by the rules of the culture, often to be used to identify that individual that individual and differentiate them from other members of the same family or community. Incompatible with `SURN`. | | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| | `HONORIFIC` | A word or phrase attached to a name in formal or polite context to indicate station, such as "Miss", "Doctor", "さん", "様", "mademoiselle", and so on. | | ||||||
| | `IMMIGRANT` | Name assumed at the time of immigration. | | ||||||
|
There was a problem hiding this comment. I'd propose a strawman guideline: only have enum values where there is a known reason an application would treat it differently in some algorithm (not just with a different label in UI). Name assumed at time of immigration or divorce or some other event would be better off, in my view, of having an event associated with the name change rather than having some type that has to be indirectly associated with some event by trying to associate some enum type with some event type of a different name ("Immigraton" / |
||||||
| | `INFORMAL` | A name only used in casual, intimate, or informal settings. | | ||||||
| | `LEGAL` | A name used for legal and official documents, but not in daily use. | | ||||||
| | `LOCATION` | A name indicating a location of note, such as a city associated with the person. Often includes "of" or "from" type particles. Incompatible with `SURN`. | | ||||||
|
There was a problem hiding this comment. There should be a way to associate a |
||||||
| | `MAIDEN` | Maiden name, name before first marriage. | | ||||||
| | `MARRIED` | Married name, assumed as part of marriage. | | ||||||
| | `MATERNAL` | A name inherited from the individuals' mother's family. Implies `SURN`. | | ||||||
| | `MATRONYMIC` | A name of the individual's mother, possibly with a matronymic modifier. | | ||||||
| | `NICK` | A descriptive or familiar name that is used instead of, or in addition to, one’s official or legal name. Some cultures use this for any name that is not used in legal documents, others only for names that would be inappropriate in formal settings. | | ||||||
| | `NPFX` | Text that appears on a name line before the given and surname parts of a name. Implies that the person attaches this part to their name, but does not consider it part of the name itself. | | ||||||
|
There was a problem hiding this comment. This description is not, in my opinion, useful in light of |
||||||
| | `NSFX` | Text which appears on a name line after or behind the given and surname parts of a name. Implies that the person attaches this part to their name, but does not consider it part of the name itself. | | ||||||
| | `PARTICLE` | A name part that connects or modifies other name parts but is not itself considered a name, like "of" or "son of". | | ||||||
|
There was a problem hiding this comment. Discussion: what about |
||||||
| | `PATERNAL` | A name inherited from the individuals' father's family. Implies `SURN`. | | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| | `PATRONYMIC` | A name of the individual's father, possibly with a patronymic modifier like prefix "bar" or "di ser" or suffix "sen" or "dotter". | | ||||||
| | `PRIMARY` | The name of most prominent in importance among the names of that type. Requires `GIVN`, `SURN`, `NPFX`, or `NSFX`. | | ||||||
|
There was a problem hiding this comment.
Suggested change
I'm not yet convinced this is a good way to designate primary, based on the discussion in #528, since it requires special handling (i.e., apps are much more likely to do it wrong) when merging two individuals with different |
||||||
| | `PROFESSIONAL` | Name used professionally (pen, screen, stage name). | | ||||||
| | `RANK` | A designation of rank or position, for example in a military ("private first class"), nobility ("viscount de Spoelberch"), or educational ("Ph.D.") system. | | ||||||
| | `RELIGIOUS` | Religious name, name adopted when joining a religious order. | | ||||||
| | `ROEPNAAM` | A name provided at birth for use in all situations except legal documents. Implies `GIVN` and `BIRTH`. The tag of this value comes from Dutch instead of English because no suitable English word was found; the value does not imply Dutch culture or ancestry. | | ||||||
| | `RUFNAME` | A given name underlined or otherwise indicated on documents as one not to be omitted when only one given name is used. Implies `GIVN` and `PRIMARY`. The tag of this value comes from German instead of English because no suitable English word was found; the value does not imply German culture or ancestry. | | ||||||
|
There was a problem hiding this comment. The "only one" part of this definition is confusing/ambiguous. Does that mean it is only permitted to have one |
||||||
| | `SPFX` | A name piece used as a non-indexing pre-part of a surname. Should be displayed as part of surname, but ignored when sorting by surname. | | ||||||
| | `SURN` | A family name passed on or used by members of a family. Because `SURN` was part of GEDCOM before most other non-`GIVN` name part types, some existing data labels name parts as `SURN` that are more correctly labeled as `LOCATION` or `PATRONYMIC`; that use of `SURN` is not recommended for new data. Incompatible with `GIVN`. | | ||||||
| | `UNIFIED` | Unified spelling for a name part. Usually, though not always, paired with `VARIANT` and `SURN`. | | ||||||
| | `VARIANT` | Different spelling for a name, such as an alternative spelling or gendered form; generally used for variants that are not part the name's written forms but may be useful for indexing or searching. | | ||||||
| | `OTHER` | A value not listed here; should have a `PHRASE` substructure. | | ||||||
|
|
||||||
| See also `g8:enumset-NAME-TYPE` for comparisons of some of these values. | ||||||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also need to bump
g7:record-INDItog8:record-INDIas a result of this change