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

Better documentation

Browse source
This commit is contained in:
Pieter Vander Vennet 2020-12-23 18:58:57 +01:00
parent 779c36051d
commit 95f3ce87b4
1 changed files with 7 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
Customizations/JSON/LayoutConfigJson.ts
View file

@ -9,7 +9,11 @@ import {TagRenderingConfigJson} from "./TagRenderingConfigJson";
export interface LayoutConfigJson { export interface LayoutConfigJson {
/** /**
* The id of this layout. * The id of this layout.
* This should be a simple, lowercase string which is used to create the html-page, e.g. *
* This is used as hashtag in the changeset message, which will read something like "Adding data with #mapcomplete for theme #<the theme id>"
* Make sure it is something decent and descriptive, it should be a simple, lowercase string.
*
* On official themes, it'll become the name of the page, e.g.
* 'cyclestreets' which become 'cyclestreets.html' * 'cyclestreets' which become 'cyclestreets.html'
*/ */
id: string; id: string;
@ -39,7 +43,8 @@ export interface LayoutConfigJson {
title: string | any; title: string | any;
/** /**
* A short description, showed as social description and in the 'more theme'-buttons * A short description, showed as social description and in the 'more theme'-buttons.
* Note that if this one is not defined, the first sentence of 'description' is used
*/ */
shortDescription?: string | any; shortDescription?: string | any;