maps/offliner-definition.json at main · openzim/maps · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
{
  "offliner_id": "maps",
  "stdOutput": true,
  "stdStats": true,
  "flags": {
    "include-poly": {
      "type": "string",
      "required": false,
      "title": "Include Poly",
      "description": "Comma-separated URL(s) of .poly file(s) defining regions to include"
    },
    "default-view": {
      "type": "string",
      "required": false,
      "title": "Default View",
      "description": "Default map view as latitude,longitude,zoom (e.g. 46.51,6.63,14 for Kiwix headquarters). Sets the initial center and zoom level of the map when UI loads."
    },
    "name": {
      "type": "string",
      "required": true,
      "title": "ZIM name",
      "description": "Name of the ZIM",
      "pattern": "^([a-z0-9\\-\\.]+_)([a-z\\-]+_)([a-z0-9\\-\\.]+)$"
    },
    "title": {
      "type": "string",
      "required": true,
      "title": "ZIM title",
      "description": "Title of the ZIM",
      "minLength": 1,
      "maxLength": 30
    },
    "description": {
      "type": "string",
      "required": true,
      "title": "ZIM description",
      "description": "Description of the ZIM",
      "minLength": 1,
      "maxLength": 80
    },
    "long-description": {
      "type": "string",
      "required": false,
      "title": "ZIM long description",
      "description": "Long description of the ZIM",
      "minLength": 1,
      "maxLength": 4000
    },
    "creator": {
      "type": "string",
      "required": false,
      "title": "Creator",
      "description": "Name of content creator"
    },
    "publisher": {
      "type": "string",
      "required": false,
      "title": "Publisher",
      "isPublisher": true,
      "description": "Publisher name"
    },
    "file-name": {
      "type": "string",
      "required": false,
      "title": "ZIM filename",
      "description": "ZIM filename. Do not input trailing `.zim`, it will be automatically added. Defaults to {name}_{period}"
    },
    "tags": {
      "type": "string",
      "required": false,
      "title": "ZIM tags",
      "description": "Semicolon (;) delimited list of tags to add to the ZIM"
    },
    "secondary-color": {
      "type": "string",
      "required": false,
      "title": "Secondary Color",
      "description": "Secondary (background) color of ZIM UI. Hex/HTML syntax (#424242)",
      "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$"
    },
    "illustration-url": {
      "type": "string",
      "required": false,
      "title": "Illustration URL",
      "description": "URL to illustration to use for ZIM illustration and favicon"
    },
    "include_up_to_zoom": {
      "type": "integer",
      "required": false,
      "title": "Include Up To Zoom",
      "description": "Include all tiles up to this zoom level, ignoring any poly filtering",
      "min": 1,
      "max": 14
    },
    "debug": {
      "type": "boolean",
      "required": false,
      "title": "Debug",
      "description": "Enable verbose output"
    },
    "zim-workers": {
      "type": "integer",
      "required": false,
      "title": "ZIM workers",
      "description": "Number of threads to process items in libzim at ZIM creation",
      "min": 4
    },
    "area": {
      "type": "string",
      "required": false,
      "title": "Area",
      "description": "Area to download, either planet or monaco",
      "pattern": "^planet|monaco$"
    },
    "output": {
      "type": "string",
      "required": false,
      "title": "Output Folder",
      "description": "Output folder for ZIMs. Default: /output",
      "pattern": "^/output$"
    },
    "stats-filename": {
      "type": "string",
      "required": false,
      "title": "Stats Filename",
      "description": "Scraping progress file. Leave it as `/output/task_progress.json`",
      "pattern": "^/output/task_progress\\.json$"
    }
  }
}