Merge pull request #90 from OvertureMaps/dev

December Schema Update
OvertureMaps · Dec 13, 2023 · 3377141 · 3377141
2 parents 7e593ad + d2d6323
commit 3377141
Show file tree

Hide file tree

Showing 87 changed files with 552 additions and 136 deletions.
diff --git a/counterexamples/places/bad-address-missing-required-property.yaml b/counterexamples/places/bad-address-missing-required-property.yaml
diff --git a/docusaurus/docs/reference/buildings/part.mdx b/docusaurus/docs/reference/buildings/part.mdx
@@ -0,0 +1,51 @@
+---
+title: part
+---
+
+import CodeBlock from '@theme/CodeBlock';
+import JSONSchemaViewer from "@theme/JSONSchemaViewer";
+import generateResolverOptions from "@site/src/components/shared-libs/generateResolverOptions"
+import yamlLoad from "@site/src/components/yamlLoad"
+import BuildingPartSchema from "!!raw-loader!@site/docs/_schema/buildings/part.yaml";
+
+import BuildingPartExample from "!!raw-loader!@site/docs/_examples/buildings/building-part-basic.yaml";
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# Building Part
+
+<table>
+  <tr>
+    <th>Geometry Type</th>
+    <td><code>Polygon</code> or <code>MultiPolygon</code></td>
+  </tr>
+  <tr>
+    <th>Theme</th>
+    <td><code>buildings</code></td>
+  </tr>
+  <tr>
+    <th>Type</th>
+    <td><code>part</code></td>
+  </tr>
+</table>
+
+
+## Schema
+
+<Tabs>
+  <TabItem value="browsable" label="Browsable" default>
+    <JSONSchemaViewer schema={ yamlLoad(BuildingPartSchema) } resolverOptions={ generateResolverOptions({remote: true, yamlBasePath: '/buildings'})}/>
+  </TabItem>
+  <TabItem value="yaml" label="YAML" default>
+    <CodeBlock language="jsx">{BuildingPartSchema}</CodeBlock>
+  </TabItem>
+</Tabs>
+
+## Examples
+
+<Tabs>
+  <TabItem value="1" label="Building Part" default>
+    <CodeBlock language="json">{ JSON.stringify(yamlLoad(BuildingPartExample), null, 2) }</CodeBlock>
+  </TabItem>
+</Tabs>
diff --git a/docusaurus/docs/reference/transportation/segment.mdx b/docusaurus/docs/reference/transportation/segment.mdx
@@ -13,6 +13,9 @@ import ExampleTurnRestrictionConnector1 from '!!raw-loader!@site/docs/_examples/
 import ExampleTurnRestrictionConnector2 from '!!raw-loader!@site/docs/_examples/transportation/docusaurus/turn-restriction-02-connector2.yaml';
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
+import ThemedImage from '@theme/ThemedImage';
+import useBaseUrl from '@docusaurus/useBaseUrl';
+
 
 # segment
 
@@ -131,7 +134,13 @@ The schema for `water` segments is under development.
 
 <div style={{textAlign: 'center'}}>
 
-![Diagram of the "via" transition from source to destination segment.](/img/transportation/turn-restriction-02.svg)
+<ThemedImage
+  alt='Diagram of the "via" transition from source to destination segment'
+  sources={{
+    light: useBaseUrl('/img/transportation/turn-restriction-02-light.png'),
+    dark: useBaseUrl('/img/transportation/turn-restriction-02-dark.png'),
+  }}
+/>
 
 </div>
 

diff --git a/docusaurus/docs/themes/transportation/roads.mdx b/docusaurus/docs/themes/transportation/roads.mdx
@@ -1,6 +1,8 @@
 import CodeBlock from '@theme/CodeBlock';
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
+import ThemedImage from '@theme/ThemedImage';
+import useBaseUrl from '@docusaurus/useBaseUrl';
 import ExampleAccessRestrictionsBlanketDeny from '!!raw-loader!@site/docs/_examples/transportation/docusaurus/access-restriction-01-blanket.yaml';
 import ExampleAccessRestrictionPrivateAccessWithDeliveries from '!!raw-loader!@site/docs/_examples/transportation/docusaurus/access-restriction-02-private-with-deliveries.yaml';
 import ExampleAccessRestrictionMotorVehiclesDestinationOnly from '!!raw-loader!@site/docs/_examples/transportation/docusaurus/access-restriction-03-motor-vehicles-destination-only.yaml';
@@ -56,7 +58,7 @@ granularities. For example, a single road segment can represent:
 The `road.class` property of a road specifies its general purpose of use
 and its relative importance within the transportation network. The
 `road.class` property also helps establish reasonable default values.
-For example, the class `footway` implies that the default
+For example, the class `sidewalk` implies that the default
 [access restrictions](#access-restrictions) for the segment allow access
 for the [travel mode](travel-modes) `foot` and deny access to all other
 travel modes.
@@ -202,7 +204,13 @@ where the sequence of maneuvers is important.
 
 <figure>
 
-![A simple transition restriction prohibiting a right turn](/img/transportation/turn-restriction-01.svg)
+<ThemedImage
+  alt="A simple transition restriction prohibiting a right turn"
+  sources={{
+    light: useBaseUrl('/img/transportation/turn-restriction-01-light.png'),
+    dark: useBaseUrl('/img/transportation/turn-restriction-01-dark.png'),
+  }}
+/>
 
 <figcaption>
 
@@ -284,7 +292,13 @@ real-world context to the example.*
 
 <figure>
 
-![A via restriction](/img/transportation/turn-restriction-02.svg)
+<ThemedImage
+  alt="A via restriction"
+  sources={{
+    light: useBaseUrl('/img/transportation/turn-restriction-02-light.png'),
+    dark: useBaseUrl('/img/transportation/turn-restriction-02-dark.png'),
+  }}
+/>
 
 <figcaption>
 
@@ -439,27 +453,57 @@ respectively.
 
 <div style={{ display: "flex", alignItems: "center" }}>
 
-<div style={{ width: "24.625%", float: "left", textAlign: "center" }}>
+<div style={{ width: "27%", float: "left", textAlign: "center" }}>
 
-![West-oriented road segment with two lanes](/img/transportation/lane-number-01-west.svg)
+<ThemedImage
+  alt='West-oriented road segment with two lanes'
+  sources={{
+    light: useBaseUrl('/img/transportation/lane-number-01-west-light.png'),
+    dark: useBaseUrl('/img/transportation/lane-number-01-west-dark.png'),
+  }}
+/>
 
 </div>
 
-<div style={{ width: "24.625%", float: "left", textAlign: "center" }}>
+<div style={{ width: "10px", float: "left" }}/>
 
-![North-oriented road segment with two lanes](/img/transportation/lane-number-02-north.svg)
+<div style={{ width: "23%", float: "left", textAlign: "center" }}>
+
+<ThemedImage
+  alt='North-oriented road segment with two lanes'
+  sources={{
+    light: useBaseUrl('/img/transportation/lane-number-02-north-light.png'),
+    dark: useBaseUrl('/img/transportation/lane-number-02-north-dark.png'),
+  }}
+/>
 
 </div>
 
-<div style={{ width: "24.625%", float: "left", textAlign: "center" }}>
+<div style={{ width: "10px", float: "left" }}/>
+
+<div style={{ width: "27%", float: "left", textAlign: "center" }}>
 
-![East-oriented road segment with two lanes](/img/transportation/lane-number-03-east.svg)
+<ThemedImage
+  alt='East-oriented road segment with two lanes'
+  sources={{
+    light: useBaseUrl('/img/transportation/lane-number-03-east-light.png'),
+    dark: useBaseUrl('/img/transportation/lane-number-03-east-dark.png'),
+  }}
+/>
 
 </div>
 
-<div style={{ width: "24.625%", float: "left", textAlign: "center" }}>
+<div style={{ width: "10px", float: "left" }}/>
+
+<div style={{ width: "23%", float: "left", textAlign: "center" }}>
 
-![East-oriented road segment with two lanes](/img/transportation/lane-number-04-south.svg)
+<ThemedImage
+  alt='South-oriented road segment with two lanes'
+  sources={{
+    light: useBaseUrl('/img/transportation/lane-number-04-south-light.png'),
+    dark: useBaseUrl('/img/transportation/lane-number-04-south-dark.png'),
+  }}
+/>
 
 </div>
 
@@ -586,7 +630,13 @@ segments.
 
 <figure>
 
-![A segment with two geometrically-scoped lane blocks connected to a segment oriented in the opposite direction](/img/transportation/lane-blocks.svg)
+<ThemedImage
+  alt='A segment with two geometrically-scoped lane blocks connected to a segment oriented in the opposite direction'
+  sources={{
+    light: useBaseUrl('/img/transportation/lane-blocks-light.png'),
+    dark: useBaseUrl('/img/transportation/lane-blocks-dark.png'),
+  }}
+/>
 
 <figcaption>
 

diff --git a/docusaurus/docs/themes/transportation/scoping-rules.mdx b/docusaurus/docs/themes/transportation/scoping-rules.mdx
@@ -1,6 +1,8 @@
 import CodeBlock from '@theme/CodeBlock';
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
+import ThemedImage from '@theme/ThemedImage';
+import useBaseUrl from '@docusaurus/useBaseUrl';
 import ExampleGeometricScoping from '!!raw-loader!@site/docs/_examples/transportation/docusaurus/geometric-scoping.yaml';
 import ExampleTemporalScoping from '!!raw-loader!@site/docs/_examples/transportation/docusaurus/temporal-scoping.yaml';
 import ExampleSubjectiveUsagePurposeScoping from '!!raw-loader!@site/docs/_examples/transportation/docusaurus/subjective-usage-purpose-scoping.yaml';
@@ -60,7 +62,13 @@ start.
 
 <figure>
 
-![Diagram showing a single geometrically-scoped position.](/img/transportation/geometric-scoping-position.svg)
+<ThemedImage
+  alt="Diagram showing a single geometrically-scoped position"
+  sources={{
+    light: useBaseUrl('/img/transportation/geometric-scoping-position-light.svg'),
+    dark: useBaseUrl('/img/transportation/geometric-scoping-position-dark.svg'),
+  }}
+/>
 
 <figcaption>
 
@@ -83,7 +91,13 @@ length from the start.
 
 <figure>
 
-![Diagram showing a geometrically-scoped range.](/img/transportation/geometric-scoping-range.svg)
+<ThemedImage
+  alt="Diagram showing a geometrically-scoped range"
+  sources={{
+    light: useBaseUrl('/img/transportation/geometric-scoping-range-light.svg'),
+    dark: useBaseUrl('/img/transportation/geometric-scoping-range-dark.svg'),
+  }}
+/>
 
 <figcaption>