{"id":9093,"date":"2026-08-25T00:50:08","date_gmt":"2026-08-25T00:50:08","guid":{"rendered":"https:\/\/metaphaze.com\/gazettebuilder\/?page_id=9093"},"modified":"2026-08-25T00:51:14","modified_gmt":"2026-08-25T00:51:14","slug":"documentation-relationship-definitions","status":"publish","type":"page","link":"https:\/\/metaphaze.com\/gazettebuilder\/documentation-relationship-definitions\/","title":{"rendered":"Documentation: Relationship Definitions"},"content":{"rendered":"\n

Relationship Definitions control the vocabulary GazetteBuilder uses for semantic relationships between Entries.<\/p>\n\n\n\n

Open:<\/p>\n\n\n\n

GazetteBuilder \u2192 Relationship Definitions<\/strong><\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

A Relationship Definition determines the relationship name, the types of Entries that may use it, the types of Entries it may point to, and the label used when GazetteBuilder presents the relationship in reverse on the target Entry.<\/p>\n\n\n\n

Add a Relationship Definition<\/h2>\n\n\n\n

The fields at the top of the page create a new Relationship Definition.<\/p>\n\n\n\n

The visible fields are:<\/p>\n\n\n\n

    \n
  • ID<\/strong><\/li>\n\n\n\n
  • Name<\/strong><\/li>\n\n\n\n
  • Inverse Label<\/strong><\/li>\n\n\n\n
  • Source Types<\/strong><\/li>\n\n\n\n
  • Target Types<\/strong><\/li>\n<\/ul>\n\n\n\n

    After completing the fields, select Add<\/strong>.<\/p>\n\n\n\n

    ID<\/h2>\n\n\n\n

    The ID<\/strong> is the internal identifier for the Relationship Definition.<\/p>\n\n\n\n

    For example:<\/p>\n\n\n\n

    located_in<\/pre>\n\n\n\n
    The ID is separate from the human-readable relationship name.<\/p>\n\n\n\n
    Name<\/h2>\n\n\n\n
    The Name<\/strong> is the canonical relationship text used when entering the relationship on an Entry.<\/p>\n\n\n\n
    For example:<\/p>\n\n\n\n
    Located in<\/pre>\n\n\n\n
    An Entry using that Relationship Definition would therefore contain:<\/p>\n\n\n\n
    Located in: Syrtis Major<\/pre>\n\n\n\n
    The Name is the controlled vocabulary for the relationship. Use the defined Name when entering relationships rather than substituting alternate wording.<\/p>\n\n\n\n
    Inverse Label<\/h2>\n\n\n\n
    The Inverse Label<\/strong> controls how GazetteBuilder labels the generated reverse listing on the Target Entry.<\/p>\n\n\n\n
    For example:<\/p>\n\n\n\n
    Name: Located inInverse Label: Locations<\/pre>\n\n\n\n
    If several Location Entries contain:<\/p>\n\n\n\n
    Located in: Syrtis Major<\/pre>\n\n\n\n
    GazetteBuilder can use the inverse label Locations<\/strong> when presenting those Entries on the Syrtis Major Entry.<\/p>\n\n\n\n
    Another definition shown in the page is:<\/p>\n\n\n\n
    Name: In District
    Inverse Label: Locations in this District<\/pre>\n\n\n\n
    That allows a district Entry to present an appropriately named reverse section rather than a generic relationship label.<\/p>\n\n\n\n
    Source Types<\/h2>\n\n\n\n
    Source Types<\/strong> identifies which Entry Types are permitted to use the relationship.<\/p>\n\n\n\n
    For example, the displayed located_in<\/code> definition uses:<\/p>\n\n\n\n
    Location<\/pre>\n\n\n\n
    as its Source Type.<\/p>\n\n\n\n
    That means the relationship is intended to originate from Location Entries.<\/p>\n\n\n\n
    Target Types<\/h2>\n\n\n\n
    Target Types<\/strong> identifies which Entry Types may be used as the relationship target.<\/p>\n\n\n\n
    For the displayed located_in<\/code> definition, the Target Type is also:<\/p>\n\n\n\n
    Location<\/pre>\n\n\n\n
    This makes a declaration such as:<\/p>\n\n\n\n
    Located in: Syrtis Major<\/pre>\n\n\n\n
    valid when both the source and target are Location Entries.<\/p>\n\n\n\n
    Existing Relationship Definitions<\/h2>\n\n\n\n
    The table lists the currently configured Relationship Definitions.<\/p>\n\n\n\n
    The visible columns are:<\/p>\n\n\n\n
      \n
    • ID<\/strong><\/li>\n\n\n\n
    • Name<\/strong><\/li>\n\n\n\n
    • Inverse Label<\/strong><\/li>\n\n\n\n
    • Source Types<\/strong><\/li>\n\n\n\n
    • Target Types<\/strong><\/li>\n\n\n\n
    • Definition and Actions<\/strong><\/li>\n<\/ul>\n\n\n\n
      The screenshot shows examples including:<\/p>\n\n\n\n
      father
      in_district
      located_in
      on_street<\/pre>\n\n\n\n
      with corresponding names and inverse labels.<\/p>\n\n\n\n
      For example:<\/p>\n\n\n\n
      ID: in_district
      Name: In District
      Inverse Label: Locations in this District
      Source Type: Location
      Target Type: Location<\/pre>\n\n\n\n
      and:<\/p>\n\n\n\n
      ID: on_street
      Name: On Street
      Inverse Label: Locations
      Source Type: Location
      Target Type: Location<\/pre>\n\n\n\n
      Edit<\/h2>\n\n\n\n
      Select Edit<\/strong> to change an existing Relationship Definition.<\/p>\n\n\n\n
      Changes to the definition affect how GazetteBuilder interprets and presents relationships using that definition, so care should be taken when editing definitions already in use.<\/p>\n\n\n\n
      \"\"<\/figure>\n\n\n\n
      Delete<\/h2>\n\n\n\n
      Select Delete<\/strong> to remove a Relationship Definition.<\/p>\n\n\n\n
      Because relationship declarations in Entries depend on these definitions, a definition should not be removed while it is still intentionally being used without first reviewing the affected Entries.<\/p>\n\n\n\n
      Relationship Definitions and Entry Editing<\/h2>\n\n\n\n
      Relationship Definitions directly control what should be entered in the Relationships<\/strong> field of an Entry.<\/p>\n\n\n\n
      If the definition is:<\/p>\n\n\n\n
      Name: Located in
      Source Type: Location
      Target Type: Location<\/pre>\n\n\n\n
      then a Location Entry can contain:<\/p>\n\n\n\n
      Located in: Syrtis Major<\/pre>\n\n\n\n
      The text before the colon comes from the Relationship Definition\u2019s Name<\/strong>.<\/p>\n\n\n\n
      The text after the colon identifies the Target Entry.<\/p>\n\n\n\n
      The format is:<\/p>\n\n\n\n
      Relationship Name: Target Entry<\/pre>\n\n\n\n
      one relationship per line.<\/p>\n\n\n\n
      For example:<\/p>\n\n\n\n
      Located in: Syrtis Major
      In District: Residency
      On Street: Bedford Road<\/pre>\n\n\n\n
      The available relationship names are therefore not free-form prose. They come from the Relationship Definitions configured on this page.<\/p>\n\n\n\n
      Why Definitions Matter<\/h2>\n\n\n\n
      Relationship Definitions give GazetteBuilder enough information to understand more than a simple link.<\/p>\n\n\n\n
      They establish:<\/p>\n\n\n\n
        \n
      • what the relationship is called;<\/li>\n\n\n\n
      • what kind of Entry may originate it;<\/li>\n\n\n\n
      • what kind of Entry may receive it;<\/li>\n\n\n\n
      • how the reverse side should be labeled.<\/li>\n<\/ul>\n\n\n\n
        That allows a single declaration such as:<\/p>\n\n\n\n
        Located in: Syrtis Major<\/pre>\n\n\n\n
        to support both the forward relationship on the source Entry and a generated reverse listing on the target Entry.<\/p>\n","protected":false},"excerpt":{"rendered":"
        Relationship Definitions control the vocabulary GazetteBuilder uses for semantic relationships between Entries. Open: GazetteBuilder \u2192 Relationship Definitions A Relationship Definition determines the relationship name, the types of Entries that may use it, the types of Entries it may point to, and the label used when GazetteBuilder presents the relationship in reverse on the target Entry. […]<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":""},"class_list":["post-9093","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/metaphaze.com\/gazettebuilder\/wp-json\/wp\/v2\/pages\/9093","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/metaphaze.com\/gazettebuilder\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/metaphaze.com\/gazettebuilder\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/metaphaze.com\/gazettebuilder\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/metaphaze.com\/gazettebuilder\/wp-json\/wp\/v2\/comments?post=9093"}],"version-history":[{"count":2,"href":"https:\/\/metaphaze.com\/gazettebuilder\/wp-json\/wp\/v2\/pages\/9093\/revisions"}],"predecessor-version":[{"id":9097,"href":"https:\/\/metaphaze.com\/gazettebuilder\/wp-json\/wp\/v2\/pages\/9093\/revisions\/9097"}],"wp:attachment":[{"href":"https:\/\/metaphaze.com\/gazettebuilder\/wp-json\/wp\/v2\/media?parent=9093"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}