From 544a172ed965b166027e3594f1eb6105584730f9 Mon Sep 17 00:00:00 2001 From: Luther Tychonievich Date: Tue, 19 Nov 2024 11:52:21 -0600 Subject: [PATCH 1/3] Add `fragment` to YAML format A first pass at adding `fragment` to the YAML format, which is part of the changes requested in #220. I'm not completely satisfied with the text I've put in this draft and welcome refinements. --- _pages/yaml-file-format.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/_pages/yaml-file-format.md b/_pages/yaml-file-format.md index 5e308c26..58139f15 100644 --- a/_pages/yaml-file-format.md +++ b/_pages/yaml-file-format.md @@ -99,6 +99,9 @@ Three keys are always present: The URI that identifies the concept documented in this YAML file. + If the YAML file also includes the key fragment, + this URI should be followed by a fragment identifier when used; + the meaning of the fragment is defined by the fragment entry. ## Other keys @@ -184,6 +187,19 @@ Their names may be changed a YAML file with a `lang` other than `en`. Standard structures may have an `extension tags` entry to list *fully compatible* extensions that predated the standard and can be converted to the `standard tag` without any other modification. For example, 7.0's `UID` structure is fully compatible with the common 5.5.1 extension identified by tag `_UID`. +- + + + + +
Keyfragment
Typestr
Required by—
Allowed bytype: uri
+ + When combined with the fragment identifer of a URI, + creates a brief name or label to show to users to describe the fragment identifier. + It is recommended that applications use this instead of `label` in UI elements. + + By being present in the YAML file, this field also implies that the URI should have a fragment identifier appended to it when used. + - From d2c2ee85c241713f144e74a459ba0411a85f5892 Mon Sep 17 00:00:00 2001 From: Luther Tychonievich Date: Wed, 20 Nov 2024 07:39:18 -0600 Subject: [PATCH 2/3] Update _pages/yaml-file-format.md Co-authored-by: Dave Thaler --- _pages/yaml-file-format.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/_pages/yaml-file-format.md b/_pages/yaml-file-format.md index 58139f15..7092c55a 100644 --- a/_pages/yaml-file-format.md +++ b/_pages/yaml-file-format.md @@ -103,6 +103,10 @@ Three keys are always present: this URI should be followed by a fragment identifier when used; the meaning of the fragment is defined by the fragment entry. + For example, if uri is "https://gedcom.io/terms/v7/RIN" and + fragment is "Source System", then a full URI might be + "https://gedcom.io/terms/v7/RIN#MyProgram" where the fragment identifier + "MyProgram" indicates the source system that generated the RIN payload value. ## Other keys The following keys may appear in a YAML file. From 7e8b0e253c9f31c2e6661be531da0121de822857 Mon Sep 17 00:00:00 2001 From: Luther Tychonievich Date: Tue, 3 Dec 2024 11:00:35 -0600 Subject: [PATCH 3/3] Update _pages/yaml-file-format.md Co-authored-by: Dave Thaler --- _pages/yaml-file-format.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/_pages/yaml-file-format.md b/_pages/yaml-file-format.md index 7092c55a..4ff0e3c8 100644 --- a/_pages/yaml-file-format.md +++ b/_pages/yaml-file-format.md @@ -198,9 +198,9 @@ Their names may be changed a YAML file with a `lang` other than `en`.
Keyhelp text
Typestr
Allowed bytype: uri
- When combined with the fragment identifer of a URI, - creates a brief name or label to show to users to describe the fragment identifier. - It is recommended that applications use this instead of `label` in UI elements. +A recommended brief name or label for a fragment identifier, to show to users. Labels are user-centric; for programmer-centric explanations of the concept, see `specification`. + +Labels are short to fit in forms and other constrained-space UI elements; for more detailed text see `help text`. By being present in the YAML file, this field also implies that the URI should have a fragment identifier appended to it when used.