Skip to content

Commit

Permalink
Update README.md to v2.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
praszuk committed Sep 12, 2024
1 parent 18783f8 commit 5b17375
Show file tree
Hide file tree
Showing 6 changed files with 36 additions and 17 deletions.
53 changes: 36 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,52 @@
# PLBuildings plugin

## Description
PLBuildings is a [JOSM](https://josm.openstreetmap.de/) plugin
which allows to easily import buildings from Polish public datasets to add it to the OpenStreetMap.
PLBuildings is a [JOSM](https://josm.openstreetmap.de/) plugin
easily allows users to import buildings from Polish public datasets to add it to the OpenStreetMap.
It communicates with the [PLBuildings server](https://github.com/praszuk/josm-plbuildings-server) that obtains this data.

## Features
- Easy import of building at cursor position.
- Replacing geometry if old building is selected.
- Updating tags with the possibility of skipping most common replacement conflicts like from `building=yes` to `building=house` without conflict tag dialog.
- Joining building other existing buildings. Adjacent nodes will be shared between 2 buildings. It means no overlapping duplicated nodes.
- Updating tags with the possibility of skipping most common replacement conflicts like from `building=yes` to `building=house` without showing the conflict tag dialog.
- Merging a building with an existing building. Adjacent nodes will be shared between the two buildings, meaning no overlapping or duplicated nodes.
- Avoiding duplicated imports.
- Simple statistics (counting imported buildings).
- Simple statistics (counting imported/replaced buildings).
- Multilingual with i18n (English and Polish).
- Pre-checking buildings before replacing:
- Looking for "survey" value.
- Preventing house details simplification (e.g. detached->house)
- Avoiding breaking `building:levels` if selected `building:levels` + `roof:levels` are equal to a new `building:levels`.
- Preventing tags simplification (e.g. `detached` -/> `house`)
- Avoiding breaking `building:levels` if selected budilings has `roof:levels` tag.
- Post-checking imported building (looking for uncommon tags).
- Statuses (current state of import action).
- GUI Sidebar (Toggle Dialog) with (current: status, data source, section with the latest tags and uncommon tag indicator).
- Import modes:
- Full – default (full import of new building or full replace)
- Geometry – geometry only update of selected building
- Tags – tags only update of selected building
- Settings:
- Multiple servers configurations
- Multiple data sources including combined data sources (1st for geometry, 2nd for tags) – it also contains resolver if one source is missing
- Notifications
- Uncommon tags
- ...more settings in JOSM advanced preferences with searching by key `plbuildings.`
- GUI Sidebar (Toggle Dialog) with:
- Current status (of import operation)
- Import mode
- Data source
- Latest tags (with Uncommon tags indicator)
- Auto-inject `source:building` and `source:geometry` tags
- Autoremove `source=geoportal.gov.pl` tag

## How to use it
Move the cursor to a building and press `CTRL + SHIFT + 1`.
If you select other building before pressing shortcut combination, then it will use _Replace Geometry_ feature (from [utilsplugin2](https://wiki.openstreetmap.org/wiki/JOSM/Plugins/utilsplugin2))
to replace old shape and tags with the new one. It can show the conflict window.
1. Install plugin in JOSM (same as other plugins via JOSM plugin settings).
2. Open ToggleDialog: On the left sidebar should be visible icon with houses (logo of this plugin) – click it. On the right side should appear toggle dialog same as below on the GIF.
3. Select Import mode and Data source – it will be remembered, but I recommend to keep dialog always open at importing to easily switching and keep looking on latest import.
4. Move the mouse cursor on a visible building and press `CTRL + SHIFT + 1`.
5. If you select other building before pressing shortcut combination, then it will use _Replace Geometry_ feature (from [utilsplugin2](https://wiki.openstreetmap.org/wiki/JOSM/Plugins/utilsplugin2)).
to replace old shape and tags with the new one. It can show the tag conflict dialog window.

Note: If shortcut doesn't work (it may happen) or you want to just change it, go to the JOSM Keyboard Shortcut Settings and type `plbuildings`,
then change it for `Download building` .

Simple building import:
![Simple building import](media/simple_import.gif)
Expand All @@ -36,15 +58,12 @@ To show statistics, go to:`Menu->Data->Buildings import stats`

Example stats:

![Buildings import statistics](media/import_stats.jpg)

GUI with status changing at import:
![Buildings import statistics](media/import_stats2.jpg)

![Toggle dialog at import action](media/toggledialog.gif)
Toggle dialog (GUI Sidebar) with a status changing at import:

![Toggle dialog at import action](media/toggledialog2.gif)

### Simplified buildings import action flow
![Simplified buildings import action flow](media/simple_import_activity_diagram.jpg)

## License
[GPLv3](LICENSE)
Binary file removed media/import_stats.jpg
Binary file not shown.
Binary file added media/import_stats2.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed media/simple_import_activity_diagram.jpg
Binary file not shown.
Binary file removed media/toggledialog.gif
Binary file not shown.
Binary file added media/toggledialog2.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 5b17375

Please sign in to comment.