mirror of
https://github.com/enzet/map-machine.git
synced 2025-06-05 20:31:51 +02:00
Rename Röntgen to Map Machine.
This commit is contained in:
Sergey Vartanov
parent
38c4e00de3
commit
2bd89a6539
57 changed files with 252 additions and 236 deletions
|
|
@ -1,6 +1,6 @@
|
|||
\1 {Contributing} {contributing}
|
||||
|
||||
Thank you for your interest in the Röntgen project. Since the primary goal of the project is to cover as many tags as possible, the project is crucially depend on contributions as OpenStreetMap itself.
|
||||
Thank you for your interest in the Map Machine project. Since the primary goal of the project is to cover as many tags as possible, the project is crucially depend on contributions as OpenStreetMap itself.
|
||||
|
||||
\2 {Suggest a tag to support} {}
|
||||
|
||||
|
|
@ -17,7 +17,7 @@ Please, create an issue with \m {bug} and \m {generator} labels.
|
|||
/*
|
||||
\2 {Fix a typo in documentation} {}
|
||||
|
||||
This action is not that easy as it supposed to be. We use \ref {http://github.com/enzet/Moire} {Moire} markup and converter to automatically generate documentation for GitHub, website, and \ref {http://wiki.openstreetmap.org/} {OpenStreetMap wiki}. That's why editing Markdown files is not allowed. To fix a typo, open corresponding Moire file in \m {doc} directory (e.g. \m {doc/readme.moi} for \m {README.md}), modify it, and run \m {python roentgen doc} script.
|
||||
This action is not that easy as it supposed to be. We use \ref {http://github.com/enzet/Moire} {Moire} markup and converter to automatically generate documentation for GitHub, website, and \ref {http://wiki.openstreetmap.org/} {OpenStreetMap wiki}. That's why editing Markdown files is not allowed. To fix a typo, open corresponding Moire file in \m {doc} directory (e.g. \m {doc/readme.moi} for \m {README.md}), modify it, and run \m {map-machine doc} script.
|
||||
*/
|
||||
|
||||
\2 {Modify the code} {}
|
||||
|
|
|
|||
|
|
@ -1,31 +1,31 @@
|
|||
\title {Röntgen}
|
||||
\title {Map Machine}
|
||||
\page_icon {out/icons_by_id/book.svg}
|
||||
|
||||
\b {Röntgen} (or \b {Roentgen} when ASCII is preferred) project consists of
|
||||
\b {Map Machine} project consists of
|
||||
|
||||
\list
|
||||
{simple Python \ref {http://openstreetmap.org} {OpenStreetMap} renderer and tile generator (see \ref {#usage-example} {usage}, \ref {#map-generation} {renderer documentation}, \ref {#tile-generation} {tile generation}),}
|
||||
{\ref {#icon-set} {set of CC-BY 4.0 icons} that can be used outside the project.}
|
||||
{\ref {#icon-set} {Röntgen icon set}\: unique CC-BY 4.0 icons.}
|
||||
|
||||
The idea behind the Röntgen project is to \b {show all the richness of the OpenStreetMap data}\: to have a possibility to \i {display any map feature} represented by OpenStreetMap data tags by means of colors, shapes, and icons. Röntgen is created for OpenStreetMap contributors\: to display all changes one made on the map even if they are small, and for users\: to dig down into the map and find every detail that was mapped.
|
||||
The idea behind the Map Machine project is to \b {show all the richness of the OpenStreetMap data}\: to have a possibility to \i {display any map feature} represented by OpenStreetMap data tags by means of colors, shapes, and icons. Map Machine is created for OpenStreetMap contributors\: to display all changes one made on the map even if they are small, and for users\: to dig down into the map and find every detail that was mapped.
|
||||
|
||||
Unlike standard OpenStreetMap layers, \b {Röntgen is a playground for experiments} where one can easily try to support proposed tags, tags with little or even single usage, deprecated tags.
|
||||
Unlike standard OpenStreetMap layers, \b {Map Machine is a playground for experiments} where one can easily try to support proposed tags, tags with little or even single usage, deprecated tags.
|
||||
|
||||
Röntgen is intended to be highly configurable, so it can generate precise but messy maps for OSM contributors as well as pretty and clean maps for OSM users, can use slow algorithms for some experimental features.
|
||||
Map Machine is intended to be highly configurable, so it can generate precise but messy maps for OSM contributors as well as pretty and clean maps for OSM users, can use slow algorithms for some experimental features.
|
||||
|
||||
\2 {Usage example} {usage-example}
|
||||
|
||||
\code {roentgen render -b 2.284,48.860,2.290,48.865} {bash}
|
||||
\code {map-machine render -b 2.284,48.860,2.290,48.865} {bash}
|
||||
|
||||
will automatically download OSM data and write output SVG map of the specified area to \m {out/map.svg}. See \ref {#map-generation} {Map generation}.
|
||||
|
||||
\code {roentgen tile -b 2.361,48.871,2.368,48.875} {bash}
|
||||
\code {map-machine tile -b 2.361,48.871,2.368,48.875} {bash}
|
||||
|
||||
will automatically download OSM data and write output PNG tiles that cover the specified area to \m {out/tiles} directory. See \ref {#tile-generation} {Tile generation}.
|
||||
|
||||
\2 {Map features} {features}
|
||||
|
||||
Röntgen features\:
|
||||
Map Machine features\:
|
||||
\list
|
||||
{detailed icons to display subtypes like \ref {#power-tower-design} {power tower design},}
|
||||
{can display multiple icons for one entity to cover more features,}
|
||||
|
|
@ -89,11 +89,11 @@ There are \ref {https://en.wikipedia.org/wiki/List_of_Japanese_map_symbols} {spe
|
|||
|
||||
\2 {Icon set} {icon-set}
|
||||
|
||||
The central feature of the project is Röntgen icon set. It is a set of monochrome 14 × 14 px pixel-aligned icons. Unlike the Röntgen source code, which is under MIT license, all icons are under \ref {http://creativecommons.org/licenses/by/4.0/} {CC BY} license. So, with the appropriate credit icon set can be used outside the project. Some icons can be used as emoji symbols.
|
||||
The central feature of the project is Röntgen icon set. It is a set of monochrome 14 × 14 px pixel-aligned icons. Unlike the Map Machine source code, which is under MIT license, all icons are under \ref {http://creativecommons.org/licenses/by/4.0/} {CC BY} license. So, with the appropriate credit icon set can be used outside the project. Some icons can be used as emoji symbols.
|
||||
|
||||
All icons tend to support common design style, which is heavily inspired by \ref {https://github.com/mapbox/maki} {Maki}, \ref {https://github.com/gmgeo/osmic} {Osmic}, and \ref {https://github.com/ideditor/temaki} {Temaki}.
|
||||
|
||||
Icons are used to visualize tags for nodes and areas. Unlike other renderers, Röntgen can use more than one icon to visualize an entity and use colors to visualize \osm {colour} value or other entity properties (like \osm {material} or \osm {genus}).
|
||||
Icons are used to visualize tags for nodes and areas. Unlike other renderers, Map Machine can use more than one icon to visualize an entity and use colors to visualize \osm {colour} value or other entity properties (like \osm {material} or \osm {genus}).
|
||||
|
||||
\image {doc/grid.png} {Icons}
|
||||
|
||||
|
|
@ -103,7 +103,7 @@ Generate icon grid and sets of individual icons with \m {\command {Test icon gen
|
|||
|
||||
\3 {Shape combination} {shape_combination}
|
||||
|
||||
Röntgen constructs icons from the shapes extracted from the sketch SVG file. Some icons consists of just one shape, to construct other it may be necessary to combine two or more shapes.
|
||||
Map Machine constructs icons from the shapes extracted from the sketch SVG file. Some icons consists of just one shape, to construct other it may be necessary to combine two or more shapes.
|
||||
|
||||
\image {doc/bus_stop.png} {Bus stop icon combination}
|
||||
|
||||
|
|
@ -172,7 +172,7 @@ pip install .} {bash}
|
|||
|
||||
Command \m {render} is used to generates SVG map from OpenStreetMap data. You can run it using\:
|
||||
|
||||
\code {roentgen render \\
|
||||
\code {map-machine render \\
|
||||
-b \formal {min longitude},\formal {min latitude},\formal {max longitude},\formal {max latitude} \\
|
||||
-o \formal {output file name} \\
|
||||
-z \formal {OSM zoom level} \\
|
||||
|
|
@ -180,7 +180,7 @@ Command \m {render} is used to generates SVG map from OpenStreetMap data. You c
|
|||
|
||||
\3 {Example} {example-2}
|
||||
|
||||
\code {roentgen render \\
|
||||
\code {map-machine render \\
|
||||
--boundary-box 2.284,48.860,2.290,48.865 \\
|
||||
--output out/esplanade_du_trocadéro.svg} {bash}
|
||||
|
||||
|
|
@ -194,7 +194,7 @@ plus \ref {#map-options} {map configuration options}
|
|||
|
||||
\2 {Tile generation} {tile-generation}
|
||||
|
||||
Command \m {tile} is used to generate PNG tiles for \ref {https://wiki.openstreetmap.org/wiki/Slippy_Map} {slippy maps}. To use them, run \ref {#tile-server} {Röntgen tile server}.
|
||||
Command \m {tile} is used to generate PNG tiles for \ref {https://wiki.openstreetmap.org/wiki/Slippy_Map} {slippy maps}. To use them, run \ref {#tile-server} {Map Machine tile server}.
|
||||
|
||||
\options {tile}
|
||||
|
||||
|
|
@ -204,11 +204,11 @@ plus \ref {#map-options} {map configuration options}
|
|||
|
||||
Specify tile coordinates\:
|
||||
|
||||
\code {roentgen tile --tile \formal {OSM zoom level}/\formal {x}/\formal {y}} {bash}
|
||||
\code {map-machine tile --tile \formal {OSM zoom level}/\formal {x}/\formal {y}} {bash}
|
||||
|
||||
or specify any geographical coordinates inside a tile\:
|
||||
|
||||
\code {roentgen tile \\
|
||||
\code {map-machine tile \\
|
||||
--coordinates \formal {latitude},\formal {longitude} \\
|
||||
--zoom \formal {OSM zoom levels}} {bash}
|
||||
|
||||
|
|
@ -216,7 +216,7 @@ Tile will be stored as SVG file \m {out/tiles/tile_<zoom level>_<x>_<y>.svg} and
|
|||
|
||||
Example\:
|
||||
|
||||
\code {roentgen tile -c 55.7510637,37.6270761 -z 18} {bash}
|
||||
\code {map-machine tile -c 55.7510637,37.6270761 -z 18} {bash}
|
||||
|
||||
will generate SVG file \m {out/tiles/tile_18_158471_81953.svg} and PNG file \m {out/tiles/tile_18_158471_81953.png}.
|
||||
|
||||
|
|
@ -224,7 +224,7 @@ will generate SVG file \m {out/tiles/tile_18_158471_81953.svg} and PNG file \m {
|
|||
|
||||
Specify boundary box to get the minimal set of tiles that covers the area\:
|
||||
|
||||
\code {roentgen tile \\
|
||||
\code {map-machine tile \\
|
||||
--boundary-box \formal {min longitude},\formal {min latitude},\formal {max longitude},\formal {max latitude} \\
|
||||
--zoom \formal {OSM zoom levels}} {bash}
|
||||
|
||||
|
|
@ -232,7 +232,7 @@ Boundary box will be extended to the boundaries of the minimal tile set that cov
|
|||
|
||||
Example\:
|
||||
|
||||
\code {roentgen tile -b 2.361,48.871,2.368,48.875} {bash}
|
||||
\code {map-machine tile -b 2.361,48.871,2.368,48.875} {bash}
|
||||
|
||||
will generate 36 PNG tiles at zoom level 18 from tile 18/132791/90164 all the way to 18/132796/90169 and two cached files \m {cache/2.360,48.869,2.370,48.877_18.svg} and \m {cache/2.360,48.869,2.370,48.877_18.png}.
|
||||
|
||||
|
|
@ -240,7 +240,7 @@ will generate 36 PNG tiles at zoom level 18 from tile 18/132791/90164 all the wa
|
|||
|
||||
Command \m {server} is used to run tile server for slippy maps.
|
||||
|
||||
\code {roentgen server}
|
||||
\code {map-machine server}
|
||||
|
||||
Stop server interrupting process with \kbd {Ctrl} + \kbd {C}.
|
||||
|
||||
|
|
@ -250,11 +250,11 @@ Stop server interrupting process with \kbd {Ctrl} + \kbd {C}.
|
|||
|
||||
Create a minimal amount of tiles that cover specified boundary box for zoom levels 16, 17, 18, and 19\:
|
||||
|
||||
\code {roentgen tile -b 2.364,48.854,2.367,48.857 -z 16-19} {bash}
|
||||
\code {map-machine tile -b 2.364,48.854,2.367,48.857 -z 16-19} {bash}
|
||||
|
||||
Run tile server on 127.0.0.1\:8080\:
|
||||
|
||||
\code {roentgen server} {bash}
|
||||
\code {map-machine server} {bash}
|
||||
|
||||
Use JavaScript code for \ref {https://leafletjs.com/} {Leaflet}\:
|
||||
|
||||
|
|
@ -265,8 +265,8 @@ L.tileLayer('http://127.0.0.1:8080/tiles/\{z\}/\{x\}/\{y\}', \{
|
|||
attribution: 'Map data © ' +
|
||||
'<a href="https://www.openstreetmap.org/copyright">OpenStreetMap</a> ' +
|
||||
'contributors, imagery © ' +
|
||||
'<a href="https:/github.com/enzet/Roentgen">Röntgen</a>',
|
||||
id: 'roentgen',
|
||||
'<a href="https:/github.com/enzet/map-machine">Map Machine</a>',
|
||||
id: 'map_machine',
|
||||
tileSize: 256,
|
||||
zoomOffset: 0
|
||||
\}).addTo(map);} {js}
|
||||
|
|
@ -283,22 +283,22 @@ Map configuration options used by \m {render} and \m {tile} commands:
|
|||
|
||||
\2 {MapCSS 0.2 generation} {mapcss-0-2-generation}
|
||||
|
||||
Command \m {mapcss} is used to generate MapCSS scheme. \m {\command {Test MapCSS 0.2 generation}} will create \m {out/roentgen_mapcss} directory with simple MapCSS 0.2 scheme adding icons from Röntgen icon set to nodes and areas\: \m {.mapcss} file and directory with icons.
|
||||
Command \m {mapcss} is used to generate MapCSS scheme. \m {\command {Test MapCSS 0.2 generation}} will create \m {out/map_machine_mapcss} directory with simple MapCSS 0.2 scheme adding icons from Röntgen icon set to nodes and areas\: \m {.mapcss} file and directory with icons.
|
||||
|
||||
To create MapCSS with Röntgen style also for ways and relations, run \m {roentgen mapcss --ways}.
|
||||
To create MapCSS with Map Machine style also for ways and relations, run \m {map-machine mapcss --ways}.
|
||||
|
||||
\options {mapcss}
|
||||
|
||||
\3 {Use Röntgen as JOSM map paint style}
|
||||
\3 {Use Map Machine as JOSM map paint style}
|
||||
|
||||
\list
|
||||
{Run \m {\command {Test MapCSS 0.2 generation}}.}
|
||||
{Open \ref {https://josm.openstreetmap.de/} {JOSM}.}
|
||||
{Go to \kbd {Preferences} → Third tab on the left → \kbd {Map Paint Styles}.}
|
||||
{Active styles: press \kbd {+}.}
|
||||
{URL / File: set path to \m {out/roentgen_mapcss/roentgen.mapcss}.}
|
||||
{URL / File: set path to \m {out/map_machine_mapcss/map_machine.mapcss}.}
|
||||
|
||||
To enable / disable Röntgen map paint style go to \kbd {View} → \kbd {Map Paint Styles} → \kbd {Röntgen}.
|
||||
To enable / disable Map Machine map paint style go to \kbd {View} → \kbd {Map Paint Styles} → \kbd {Map Machine}.
|
||||
|
||||
\4 {Example}
|
||||
|
||||
|
|
@ -307,4 +307,4 @@ To enable / disable Röntgen map paint style go to \kbd {View} → \kbd {Map Pai
|
|||
Example of using Röntgen icons on top of Mapnik style in JOSM. Map Paint Styles look like\:
|
||||
\list
|
||||
{✓ Mapnik (true)}
|
||||
{✓ Röntgen}
|
||||
{✓ Map Machine}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue