freecodecamp/offliner-definition.json at main · openzim/freecodecamp · 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
131
132
{
  "offliner_id": "freecodecamp",
  "stdOutput": true,
  "stdStats": false,
  "flags": {
    "course": {
      "type": "string",
      "required": true,
      "title": "Course(s)",
      "description": "Course or course list (separated by commas)"
    },
    "language": {
      "type": "string-enum",
      "required": true,
      "title": "Language",
      "description": "Language of curriculum.",
      "choices": [
        {
          "title": "English",
          "value": "eng"
        },
        {
          "title": "Espanol",
          "value": "spa"
        },
        {
          "title": "German",
          "value": "deu"
        },
        {
          "title": "Italian",
          "value": "ita"
        },
        {
          "title": "Japanese",
          "value": "jpn"
        },
        {
          "title": "Portuguese",
          "value": "por"
        },
        {
          "title": "Ukrainian",
          "value": "ukr"
        },
        {
          "title": "Swahili",
          "value": "swa"
        },
        {
          "title": "Chinese Simplified",
          "value": "zh-hans"
        },
        {
          "title": "Chinese Traditional",
          "value": "zh-hant"
        }
      ]
    },
    "name": {
      "type": "string",
      "required": true,
      "title": "Name",
      "description": "ZIM name",
      "pattern": "^([a-z0-9\\-\\.]+_)([a-z\\-]+_)([a-z0-9\\-\\.]+)$"
    },
    "title": {
      "type": "string",
      "required": true,
      "title": "Title",
      "description": "ZIM title",
      "minLength": 1,
      "maxLength": 30
    },
    "description": {
      "type": "string",
      "required": true,
      "title": "Description",
      "description": "ZIM description",
      "minLength": 1,
      "maxLength": 80
    },
    "long_description": {
      "type": "string",
      "required": false,
      "title": "Long description",
      "description": "ZIM long description",
      "minLength": 1,
      "maxLength": 4000
    },
    "creator": {
      "type": "string",
      "required": false,
      "title": "Creator",
      "description": "Name of content creator. “freeCodeCamp” otherwise"
    },
    "publisher": {
      "type": "string",
      "required": false,
      "title": "Publisher",
      "isPublisher": true,
      "description": "Custom publisher name (ZIM metadata). “openZIM” otherwise"
    },
    "debug": {
      "type": "boolean",
      "required": false,
      "title": "Debug",
      "description": "Enable verbose output"
    },
    "output": {
      "type": "string",
      "required": false,
      "title": "Output folder",
      "description": "Output folder for ZIM file(s). Leave it as `/output`",
      "pattern": "^/output$"
    },
    "zim_file": {
      "type": "string",
      "required": false,
      "title": "ZIM filename",
      "description": "ZIM file name (based on --name if not provided). Include {period} to insert date period dynamically",
      "pattern": "^([a-z0-9\\-\\.]+_)([a-z\\-]+_)([a-z0-9\\-\\.]+_)([a-z0-9\\-\\.]+_|)([\\d]{4}-[\\d]{2}|\\{period\\}).zim$"
    },
    "illustration": {
      "type": "blob",
      "kind": "image",
      "required": false,
      "title": "Illustration",
      "description": "URL for ZIM illustration. Freecodecamp default logo if missing"
    }
  }
}