Merge branch 'praszuk/docs/update-readme-to-v2' into v2.0.0

README.en.md

@@ -0,0 +1,70 @@
+# PLBuildings plugin
+[Czytaj po polsku](README.md).
+
+## Description
+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 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/replaced buildings).
+- Multilingual with i18n (English and Polish).
+- Pre-checking buildings before replacing:
+  - Looking for "survey" value.
+  - 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).
+- 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
+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)
+
+Import with replacing old building geometry:
+![Import with replacing old building geometry](media/import_with_replace.gif)
+
+To show statistics, go to:`Menu->Data->Buildings import stats`
+
+Example stats:
+
+![Buildings import statistics](media/import_stats2.jpg)
+
+Toggle dialog (GUI Sidebar) with a status changing at import:
+
+![Toggle dialog at import action](media/toggledialog2.gif)
+
+
+## License
+[GPLv3](LICENSE)

README.md

@@ -1,50 +1,69 @@
 # PLBuildings plugin
+[Read in English](README.en.md).
 
-## 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.
-It communicates with the [PLBuildings server](https://github.com/praszuk/josm-plbuildings-server) that obtains this data.
+## Opis
+PLBuildings to wtyczka do [JOSMa](https://josm.openstreetmap.de/), która umożliwia użytkownikom łatwe importowanie budyków z publicznych polskich zbiorów danych w celu dodania ich do OpenStreetMap.
 
-## 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.
-- Avoiding duplicated imports.
-- Simple statistics (counting imported 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`.
-- 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).
+Wtyczka komunikuje się z [serwerem PLBuildings](https://github.com/praszuk/josm-plbuildings-server) w celu pozyskiwania danych.
 
-## 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.
+## Funkcjonalności
+- Prosty import budynku w miejscu kursora myszy.
+- Zastępowanie geometrii jeśli stary budynek jest zaznaczony.
+- Aktualizacja tagów z możliwością pominięcia konfliktów _częstych tagów_ np. takich jak z `building=yes` na `building=house` bez wyświetlania okna dialogowego z konfliktem tagów.
+- Łączenie budynku z istniejącym budynkiem. Sąsiadujące węzły będą współdzielone między budynkami – zapobiega to nakładającym/duplikującym się węzłom.
+- Zapobieganie zduplikowanych importów.
+- Proste statystyki (zliczanie zaimportowanych/podmienionych budynków).
+- Wielojęzyczność z użyciem i18n (polski i angielski).
+- Wstępne sprawdzanie budynków przed zastąpieniem:
+    - Szukanie wartości "survey".
+    - Zapobieganie zubożeniu tagów (np. `detached` -/> `house`)
+    - Unikanie błędów związanych z `building:levels` w zależności od tego, czy zaznaczony budynek ma tag `roof:levels`.
+- Sprawdzanie zaimportowanych budynków pod względem nietypowych tagów.
+- Statusy (aktualny stan akcji importu).
+- Tryby importu:
+    - Pełny – domyślny (pełny import nowego budynku lub pełna zamiana)
+    - Geometria – aktualizacja tylko geometrii dla zaznaczonego budynku
+    - Tagi – aktualizacja tylko tagów dla zaznaczonego budynku
+- Ustawienia:
+    - Konfiguracje wielu serwerów
+    - Wiele źródeł danych, w tym złączone źródła danych (np. 1 dla geometrii, 2 dla tagów) – zawiera to również mechanizm, który obsługuje braki w wybranym źródle.
+    - Powiadomienia
+    - Nietypowe tagi
+    - ...więcej ustawień można znaleźć w ustawieniach zaawansowanych JOSMa, szukając po kluczu `plbuildings.`
+- Boczny panel GUI (tzw. Toggle Dialog), który zawiera:
+    - Aktualny status
+    - Tryb importu
+    - Źródło danych
+    - Ostatnie tagi (wraz ze wskaźnikiem nietypowych tagów)
+- Automatyczne dodawanie tagów `source:building` i `source:geometry`.
+- Automatyczne usuwanie tagu `source=geoportal.gov.pl`
 
-Simple building import:
-![Simple building import](media/simple_import.gif)
+## Jak z niej korzystać
+1. Zainstaluj wtyczkę w JOSMie (tak jak jak każdy inną – przez ustawienia JOSMa).
+2. Otwórz boczny panel (Toggle Dialog): Po lewej stronie powinna być widoczna ikonka z budynkami (logiem tej wtyczki) – klknij na nią. Po prawej stornie powinien otworzyć się boczny panel wtyczki taki jak na GIFie poniżej.
+3. Wybierz tryb importu i źródło danych – zostanie to zapamiętane, ale rekomenduję aby zawsze mieć otwarty ten boczny panel dla łatwiejszej zmiany trybu/źródła i aby mieć uwagę na ostatni import.
+4. Nakieruj kursor myszy na widoczny budynek i naciśnij `CTRL + SHIFT + 1`.
+5. Jeśli przed wciśnięciem skrótu został zaznaczony inny budynek, zostanie użyta funkcja zamiany geometrii z pluginu [utilsplugin2](https://wiki.openstreetmap.org/wiki/JOSM/Plugins/utilsplugin2) w celu aktualizacji starego kształtu. Może to wyświetlić okno dialogowe konfliktów tagów.
 
-Import with replacing old building geometry:
-![Import with replacing old building geometry](media/import_with_replace.gif)
+Uwaga: Jeśli skrót nie działa (może się tak zdarzyć) lub po prostu chcesz go zmienić na inny, wejdź w ustawienia skrótów w JOSMie i wpisz: `plbuildings`, następnie zmień skrót dla `Pobierz budynek`.
 
-To show statistics, go to:`Menu->Data->Buildings import stats`
 
-Example stats:
+Prosty import budynku:
+![Prosty import budynku](media/simple_import.gif)
 
-![Buildings import statistics](media/import_stats.jpg)
+Import z zamianą starej geometrii budynku:
+![Import z zamianą starej geometrii budynku](media/import_with_replace.gif)
 
-GUI with status changing at import:
+W celu wyświetlenia statystyk, otwórz: `Menu->Dane->Statystyki importowania budynków`
 
-![Toggle dialog at import action](media/toggledialog.gif)
+Przykładowe statystyki:
 
+![Statystyki importowania budynków](media/import_stats2.jpg)
 
-### Simplified buildings import action flow
-![Simplified buildings import action flow](media/simple_import_activity_diagram.jpg)
+Boczny panel ze statusem zmieniającym się podczas importu:
 
-## License
+![Boczny panel podczas importu](media/toggledialog2.gif)
+
+
+## Licencja
 [GPLv3](LICENSE)