midgard/mapcomplete
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

More docs

Browse source
This commit is contained in:
pietervdvn 2021-02-23 19:34:34 +01:00
parent b55473c750
commit 7c701c5d2f
2 changed files with 12 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
Docs/Making_Your_Own_Theme.md
View file

@ -21,6 +21,7 @@ The custom theme generator is a special page of MapComplete, where one can creat
However, the custom theme generator is extremely buggy and built before some updates. This means that some features are _not_ available through the custom theme generator. The custom theme generator is good to get the basics of the theme set up, but you will have to edit the raw JSON-file anyway afterwards. However, the custom theme generator is extremely buggy and built before some updates. This means that some features are _not_ available through the custom theme generator. The custom theme generator is good to get the basics of the theme set up, but you will have to edit the raw JSON-file anyway afterwards.
[A quick tutorial for the custom theme generator can be found here](https://www.youtube.com/watch?v=nVbFrNVPxPw).
Loading your theme Loading your theme
------------------ ------------------
@ -56,7 +57,7 @@ The preferred way to add your theme is via a Pull Request. A Pull Request is les
- Open [AllKnownLayouts.ts](https://github.com/pietervdvn/MapComplete/blob/master/Customizations/AllKnownLayouts.ts) - Open [AllKnownLayouts.ts](https://github.com/pietervdvn/MapComplete/blob/master/Customizations/AllKnownLayouts.ts)
- Add an import statatement, e.g. `import * as yourtheme from "../assets/themes/yourtheme/yourthemes.json";` - Add an import statatement, e.g. `import * as yourtheme from "../assets/themes/yourtheme/yourthemes.json";`
- Add your theme to the `LayoutList`, by adding a line `FromJSON.LayoutFromJSON(yourtheme)` - Add your theme to the `LayoutList`, by adding a line `FromJSON.LayoutFromJSON(yourtheme)`
6) Test your theme: run the project as described [above](#Dev) 6) Test your theme: run the project as described [above](../README.md#Dev)
7) Happy with your theme? Time to open a Pull Request! 7) Happy with your theme? Time to open a Pull Request!
8) Thanks a lot for improving MapComplete! 8) Thanks a lot for improving MapComplete!
@ -91,6 +92,15 @@ The correct way to handle this is to use _This bench does have a backrest_ and _
One has to think first in terms of _what is shown to the user if it is known_, only then in terms of _what is the question I want to ask_ One has to think first in terms of _what is shown to the user if it is known_, only then in terms of _what is the question I want to ask_
### Using layers to distinguish on attributes
One layer should portray one kind of physical object, e.g. "benches" or "restaurants". It should contain all of them, disregarding other properties.
One should not make one layer for benches with a backrest and one layer for benches without. This is confusing for users and poses problems: what if the backrest status is unknown? What if it is some weird value?
Also, it isn't possible to 'move' an attribute to another layer.
Instead, make one layer for one kind of object and change the icon based on attributes.
### Using layers as filters ### Using layers as filters
Using layers as filters - this doesn't work! Using layers as filters - this doesn't work!

2
README.md
View file

@ -21,7 +21,7 @@ An explicit non-goal of MapComplete is to modify geometries of ways. Although ad
# Creating your own theme # Creating your own theme
It is possible to quickly make and distrubute your own theme - [please read the documentation on how to do this](Docs/Making_Your_Own_Theme.md). It is possible to quickly make and distribute your own theme - [please read the documentation on how to do this](Docs/Making_Your_Own_Theme.md).
## Examples ## Examples