Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

December Schema Update #90

Merged
merged 29 commits into from
Dec 13, 2023
Merged

December Schema Update #90

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
f0cf9aa
Initial building part definition
jwass Sep 18, 2023
3b7ac99
adding building_part to documentation
jenningsanderson Sep 18, 2023
7d83760
Update descriptions for buildings and parts fields
jwass Sep 19, 2023
e8ff604
renaming of building_part -> part
jenningsanderson Sep 26, 2023
3facd53
one more place to update building part
jenningsanderson Sep 26, 2023
298c26c
another spot to update
jenningsanderson Sep 26, 2023
63cc73d
Add building id to part example and make required
jwass Oct 3, 2023
0edd6e7
Added multipart OSM building example
skmoore Oct 27, 2023
24caa18
Added parts for OSM multipart example
skmoore Oct 27, 2023
9705e7c
converting to yaml
jenningsanderson Oct 31, 2023
09489d0
In building part: building -> buildingId
jwass Nov 13, 2023
55fe1bd
Added facadeMaterial, roofMaterial and facadeColor properties for bui…
LukaszMichalski-TomTom Nov 13, 2023
7d04629
Add additional road classes for pedestrian transportation
brad-richardson Nov 9, 2023
15f7bc7
Add sidewalk example
brad-richardson Nov 13, 2023
3beeeab
Remove path from road class list
brad-richardson Nov 15, 2023
36f76f9
postCode -> postcode and remove requirement on address
jenningsanderson Nov 15, 2023
bb01881
removing failing counter example because it no longer fails
jenningsanderson Nov 16, 2023
1fe3d43
Removed option 'other' from roofShape, roofMaterial, facedMaterial
LukaszMichalski-TomTom Dec 3, 2023
af02442
Fix typo in name `cemetery`
jenningsanderson Nov 20, 2023
f9ffe8f
Fix type maxiumum->maximum on linearlyReferencedPosition
DavidKarlas Nov 3, 2023
be85c92
Fix failing example
DavidKarlas Dec 6, 2023
e4cd4a6
Add footway to road class enum
brad-richardson Dec 7, 2023
a40b1e5
fix: fix the spelling of cafetaria to cafeteria
JanCallewaert-TomTom Nov 30, 2023
5991175
fix: fix the spelling of cafetaria to cafeteria in the taxonomy
JanCallewaert-TomTom Dec 5, 2023
2163324
Improve scrappy diagrams with dark/light theme and Overture colors
vcschapp Dec 9, 2023
f020b9e
Merge pull request #93 from OvertureMaps/footway-road-class
brad-richardson Dec 12, 2023
7cd9167
Merge pull request #94 from OvertureMaps/transportation_better_docs
RobSoetewey-TomTom Dec 13, 2023
1aaa878
Merge pull request #86 from OvertureMaps/users/callewaertjan-tomtom/c…
RobSoetewey-TomTom Dec 13, 2023
d2d6323
Merge pull request #73 from OvertureMaps/users/davidkarlas/fixMaxiumum
RobSoetewey-TomTom Dec 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 0 additions & 20 deletions counterexamples/places/bad-address-missing-required-property.yaml
View file
Open in desktop

This file was deleted.

51 changes: 51 additions & 0 deletions docusaurus/docs/reference/buildings/part.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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>
11 changes: 10 additions & 1 deletion docusaurus/docs/reference/transportation/segment.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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>

Expand Down
74 changes: 62 additions & 12 deletions docusaurus/docs/themes/transportation/roads.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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';
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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>

Expand Down Expand Up @@ -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>

Expand Down Expand Up @@ -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>

Expand Down Expand Up @@ -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>

Expand Down
18 changes: 16 additions & 2 deletions docusaurus/docs/themes/transportation/scoping-rules.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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';
Expand Down Expand Up @@ -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>

Expand All @@ -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>

Expand Down
Loading
Loading