Skip to content

Commit ccc261b

Browse files
committed
docs: complete paragraph on meta information
1 parent d15d5d9 commit ccc261b

2 files changed

Lines changed: 26 additions & 5 deletions

File tree

docs/user_manual/01-First-Steps.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ out about the tags. It is also always useful to consult
140140
different keys and value in actual use.
141141

142142
Tags are common to all OSM objects. After that there are three kinds of
143-
objects in OSM: nodes, ways and relations.
143+
object types in OSM: nodes, ways and relations.
144144

145145
### Nodes
146146

@@ -187,7 +187,7 @@ backward references when talking about the dependencies between objects:
187187

188188
* A __forward reference__ means that an object is referenced to by another.
189189
Nodes appear in ways. Ways appear in relations. And a node may even have
190-
an indirect forward reference to a relation through a way it appear in.
190+
an indirect forward reference to a relation through a way it appears in.
191191
Forward references are important when tracking changes. When the location
192192
of a node changes, then all its forward references have to be reevaluated.
193193

@@ -198,6 +198,10 @@ backward references when talking about the dependencies between objects:
198198
to follow the backward references for ways and relations until we reach
199199
the nodes.
200200

201+
Closely related to backward references is the concept of __reference
202+
completeness__. A dataset or file is considered reference complete when
203+
all backward references can be resolved.
204+
201205
## Order in OSM files
202206

203207
OSM files usually follow a sorting convention to make life easier for

docs/user_manual/02-Extracting-Object-Data.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ Finally, there is a type for changesets, which contains information about
1414
edits in the OSM database. It can only appear in special changeset files
1515
and explained in more detail [below](#changeset).
1616

17-
The FileProcessor may return any of these objects, when iterating over a file.
17+
When iterating over a file, then the FileProcessor may return any of these
18+
objects.
1819
Therefore, a script will usually first need to determine the type of object
1920
received. There are a couple of ways to do this.
2021

@@ -83,7 +84,7 @@ You can simply test for this object type:
8384
## Reading object tags
8485

8586
Every object has a list of properties, the tags. They can be accessed through
86-
the `tags` property, which provides a simple dictionary-like view of the tags.
87+
the `tags` property. It provides a simple dictionary-like view of the tags.
8788
You can use the bracket notation to access a specific tag or use the more
8889
explicit `get()` function. Just like for Python dictionaries, an access by
8990
bracket raises a `ValueError` when the key you are looking for does not exist,
@@ -140,7 +141,23 @@ list into a Python dictionary:
140141
## Other common meta information
141142

142143
Next to the tags, every OSM object also carries some meta information
143-
describing its ID, version and information regarding the editor.
144+
which all can be accessed through read-only properties.
145+
146+
The most important meta information is the object's ID in the `id` property.
147+
This is the ID used when object reference each other.
148+
149+
The other meta information mostly relates when and by whom it was edited.
150+
The following table gives a quick overview over the properties:
151+
152+
| Property | Description |
153+
|-----------|--------------------------|
154+
| version | Version of the object. A newly created object starts with version 1. |
155+
| deleted | A boolean property saying if the object should be used or ignored. Only relevant for [change](08-Working-With-Change-Files.md) and [history](09-Working-With-History-Files.md) files. |
156+
| changeset | The ID of the change set this object was created with. A change set contains a set of edits that have been uploaded by an editor in a single session. |
157+
| timestamp | UTC time at which the object was created, or more precisely, added into the database. |
158+
| uid | The ID of the user who created this version of the object. User IDs are univocal and prepetual. |
159+
| user | The name of the user who created this version of the object. This is the name the user had when the object was created. User names may be changed over time. The same name in different objects doesn't necessarily mean that the change was made by the same user. |
160+
144161

145162
## Properties of OSM object types
146163

0 commit comments

Comments
 (0)