2025-09-02T14:49:30Z

Featherless: Featherless moved page Tags to Facts

This article and Scout's Facts concept take inspiration from [https://wiki.openstreetmap.org/wiki/Tags OpenStreetMap's Tags documentation].

A '''fact''' consists of two components: a ''key'' and a ''value''. Facts describe specific attributes of locations that drivers can observe and update, such as gas prices, amenities, and services available at various establishments. Both components are free-format text fields but often represent numeric or structured data. Conventions for the meaning and use of facts are documented on this wiki, though interpretations may vary among drivers.

== Keys and values ==

Facts are applied to locations (tagging them with facts), resulting in a collection of any size. However, each collection may contain a given fact key only once per location. When a fact is absent, default values or inherited assumptions often apply.

The ''key'' describes a topic, category, or type of attribute. Keys can be qualified with prefixes, infixes, or suffixes (usually separated by underscores), forming super- or sub-categories, or [[namespace|namespaces]]. Common namespaces include fuel prices and amenities.

The ''value'' represents the current state of the fact. Values are typically numbers (integer or decimal) or boolean (e.g., <code>true</code> or <code>false</code>). Values are required for all facts.

Here are examples used in practice:
* {{fact|amenity_car_wash|true}} – indicates that a car wash is present at this location.
* {{fact|octane_87|1.316}} – numeric price for regular gasoline. The fact will also have a volume and currency property in this case.

== Optional properties ==

Beyond the basic key-value structure, facts can include optional properties for additional context.

The ''volume'' property specifies units for measurable quantities (e.g., <code>G</code> for gas prices). It clarifies the unit of volume measurement for the value.

The ''currency'' property specifies the monetary unit for price-related facts (e.g., <code>USD</code> for US dollars, <code>CAD</code> for Canadian dollars). This ensures price facts are properly contextualized for drivers.

== key=value syntax ==
In discussions and tools, facts are commonly referenced using <code>key=value</code> syntax. For facts with volume or currency properties, use the extended syntax: <code>key=value|volume=unit|currency=code</code>. Keys or values may be quoted to avoid confusion: <code>key="value"</code> or <code>"key"="value"</code>. The quotes, equals signs, and pipe symbols are not part of the actual fact content.

On this wiki, you can refer to a fact using key=value syntax by including the {{tl|fact}} template.

[[Category:Facts| ]]
[[Category:Concepts]]
[[Category:Location Data]]

Facts

2025-09-02T14:48:52Z

Featherless: Add initial facts documentation.

This article and Scout's Facts concept take inspiration from [https://wiki.openstreetmap.org/wiki/Tags OpenStreetMap's Tags documentation].

A '''fact''' consists of two components: a ''key'' and a ''value''. Facts describe specific attributes of locations that drivers can observe and update, such as gas prices, amenities, and services available at various establishments. Both components are free-format text fields but often represent numeric or structured data. Conventions for the meaning and use of facts are documented on this wiki, though interpretations may vary among drivers.

== Keys and values ==

Facts are applied to locations (tagging them with facts), resulting in a collection of any size. However, each collection may contain a given fact key only once per location. When a fact is absent, default values or inherited assumptions often apply.

The ''key'' describes a topic, category, or type of attribute. Keys can be qualified with prefixes, infixes, or suffixes (usually separated by underscores), forming super- or sub-categories, or [[namespace|namespaces]]. Common namespaces include fuel prices and amenities.

The ''value'' represents the current state of the fact. Values are typically numbers (integer or decimal) or boolean (e.g., <code>true</code> or <code>false</code>). Values are required for all facts.

Here are examples used in practice:
* {{fact|amenity_car_wash|true}} – indicates that a car wash is present at this location.
* {{fact|octane_87|1.316}} – numeric price for regular gasoline. The fact will also have a volume and currency property in this case.

== Optional properties ==

Beyond the basic key-value structure, facts can include optional properties for additional context.

The ''volume'' property specifies units for measurable quantities (e.g., <code>G</code> for gas prices). It clarifies the unit of volume measurement for the value.

The ''currency'' property specifies the monetary unit for price-related facts (e.g., <code>USD</code> for US dollars, <code>CAD</code> for Canadian dollars). This ensures price facts are properly contextualized for drivers.

== key=value syntax ==
In discussions and tools, facts are commonly referenced using <code>key=value</code> syntax. For facts with volume or currency properties, use the extended syntax: <code>key=value|volume=unit|currency=code</code>. Keys or values may be quoted to avoid confusion: <code>key="value"</code> or <code>"key"="value"</code>. The quotes, equals signs, and pipe symbols are not part of the actual fact content.

On this wiki, you can refer to a fact using key=value syntax by including the {{tl|fact}} template.

[[Category:Facts| ]]
[[Category:Concepts]]
[[Category:Location Data]]