-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathocw-studio.yaml
599 lines (545 loc) · 15.2 KB
/
ocw-studio.yaml
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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
---
root-url-path: ""
collections:
- category: Content
folder: content/pages
label: Pages
name: page
fields:
- label: Draft
name: draft
required: true
widget: boolean
help: Enable this setting to prevent publishing in production
- label: Title
name: title
widget: string
required: true
- label: Description
name: description
widget: text
help: The plain text description of this page as seen by search engines
required: true
- label: Body
name: body
widget: markdown
minimal: false
allowed_html:
- sub
- sup
link:
- course_collections
- resource_collections
- resource
- page
- external-resource
embed:
- resource
- category: Content
folder: content/resource_collections
label: "Resource Collections"
name: "resource_collections"
fields:
- label: Draft
name: draft
required: true
widget: boolean
help: Enable this setting to prevent publishing in production
- label: Title
name: title
widget: string
required: true
- label: Description
name: description
widget: markdown
- widget: relation
name: resources
label: Resources
collection: resource
display_field: title
cross_site: true
sortable: true
- category: Content
folder: content/course-lists
label: "Course Lists"
name: "course-lists"
fields:
- label: Draft
name: draft
required: true
widget: boolean
help: Enable this setting to prevent publishing in production
- label: Title
name: title
widget: string
required: true
- label: Description
name: description
widget: text
help: The plain text description of the list as seen by search engines
- label: Body
name: body
widget: markdown
minimal: false
allowed_html:
- sub
- sup
link:
- course_collections
- resource_collections
- resource
- page
- external-resource
embed:
- resource
- label: Courses
name: courses
widget: website-collection
- category: Content
folder: content/collections
label: "Course Collections"
name: "course-collection"
fields:
- label: Draft
name: draft
required: true
widget: boolean
help: Enable this setting to prevent publishing in production
- label: Title
name: title
widget: string
required: true
- label: Description
name: description
widget: text
help: The plain text description of collection as seen by search engines
- label: Body
name: body
widget: markdown
minimal: false
allowed_html:
- sub
- sup
link:
- course_collections
- resource_collections
- resource
- page
- external-resource
embed:
- resource
- label: Cover Image
name: cover-image
widget: relation
collection: resource
display_field: title
multiple: false
filter:
field: "resourcetype"
filter_type: "equals"
value: "Image"
- label: Featured Courses List
name: featured-courses
widget: relation
multiple: false
collection: course-lists
display_field: title
sortable: false
- label: Course Lists
name: courselists
widget: relation
multiple: true
collection: course-lists
display_field: title
sortable: true
- category: Content
folder: content/promos
label: Promo
name: promos
fields:
- label: Draft
name: draft
required: true
widget: boolean
help: Enable this setting to prevent publishing in production
- label: Title
name: title
widget: string
required: true
- label: Subtitle
name: subtitle
widget: string
- label: Link Title
name: link_title
widget: string
- label: Url
name: link_url
widget: string
- label: Image
name: image
widget: relation
collection: resource
display_field: title
required: true
multiple: false
min: 1
max: 1
filter:
field: "resourcetype"
filter_type: "equals"
value: "Image"
- category: Content
folder: content/notifications
label: Notification
name: notifications
fields:
- label: Draft
name: draft
required: true
widget: boolean
help: Enable this setting to prevent publishing in production
- label: Title
name: title
widget: string
required: true
- label: Body
name: body
widget: markdown
- label: Headless
name: headless
widget: hidden
default: true
- category: Content
folder: content/stories
label: Stories
name: stories
fields:
- label: Draft
name: draft
required: true
widget: boolean
help: Enable this setting to prevent publishing in production
- label: Title
name: title
widget: string
required: true
- label: Location
name: location
widget: string
- label: Occupation
name: occupation
widget: string
- label: Image
name: image
widget: relation
collection: resource
display_field: title
multiple: false
min: 1
max: 1
filter:
field: "resourcetype"
filter_type: "equals"
value: "Image"
- label: Lead Quote
name: leadquote
widget: string
- label: Is Quote
name: is_quote
widget: boolean
help: >
Enable this setting if the testimonial is a quote only.
If enabled, the Body will not be used,
and the Lead Quote will be displayed instead.
default: false
- label: Body
name: body
widget: markdown
minimal: false
help: "Note: Body is ignored if 'Is Quote' is enabled."
- category: Content
folder: content/resources
label: Resources
name: resource
fields:
- label: Draft
name: draft
required: true
widget: boolean
help: Enable this setting to prevent publishing in production
default: false
- label: Title
name: title
required: true
widget: string
help: If this is a video, this will be published as the YouTube title
- label: Description
name: body
widget: markdown
minimal: true
link:
- resource
- page
- label: Resource Type
name: resourcetype
required: true
widget: select
options:
- Image
- Video
- Document
- Other
- label: Mime Type
name: file_type
widget: hidden
- label: Size
name: file_size
widget: hidden
required: false
default: null
help: The size of the file resource in bytes
- label: File
name: file
widget: file
- label: "Learning Resource Types"
name: "learning_resource_types"
widget: select
multiple: true
options:
- "Activity Assignments"
- "Activity Assignments with Examples"
- "Competition Videos"
- "Course Introduction"
- "Demonstration Audio"
- "Demonstration Videos"
- "Design Assignments"
- "Design Assignments with Examples"
- "Exam Materials"
- Exams
- "Exams with Solutions"
- "Image Gallery"
- "Instructor Insights"
- Labs
- "Lecture Audio"
- "Lecture Notes"
- "Lecture Videos"
- "Media Assignments"
- "Media Assignments with Examples"
- "Multiple Assignment Types"
- "Multiple Assignment Types with Solutions"
- Music
- "Online Textbook"
- "Other Audio"
- "Other Video"
- "Presentation Assignments"
- "Presentation Assignments with Examples"
- "Problem Sets"
- "Problem Sets with Solutions"
- "Programming Assignments"
- "Programming Assignments with Examples"
- Projects
- "Projects with Examples"
- Readings
- "Recitation Notes"
- "Recitation Videos"
- "Simulation Videos"
- Simulations
- Tools
- "Tutorial Videos"
- "Video Materials"
- Videos
- "Workshop Videos"
- "Written Assignments"
- "Written Assignments with Examples"
- label: License
name: license
options:
- label: CC BY
value: https://creativecommons.org/licenses/by/4.0/
- label: CC BY-NC
value: https://creativecommons.org/licenses/by-nc/4.0/
- label: CC BY-NC-SA
value: https://creativecommons.org/licenses/by-nc-sa/4.0/
- label: CC BY-SA
value: https://creativecommons.org/licenses/by-sa/4.0/
- label: public domain
value: https://creativecommons.org/publicdomain/zero/1.0/
widget: select
default: https://creativecommons.org/licenses/by-nc-sa/4.0/
required: true
# show the field below only if the type of resource is "image"
- label: Image Metadata
name: image_metadata
widget: object
condition: { field: resourcetype, equals: Image }
fields:
- label: ALT text
name: image_alt
widget: string
- label: Caption
name: caption
widget: markdown
- label: Credit
name: credit
widget: markdown
# show the sections below only if the type of resource is "Video"
- label: Video Metadata
name: video_metadata
widget: object
condition: { field: resourcetype, equals: Video }
help: These fields will be published to YouTube
fields:
- label: Youtube ID
name: youtube_id
widget: string
- label: Youtube Description
name: youtube_description
widget: text
- label: Youtube Speakers
name: video_speakers
widget: string
- label: Youtube Tags (comma separated; max 100 characters)
name: video_tags
widget: text
- label: Video Files
name: video_files
widget: object
condition: { field: resourcetype, equals: Video }
help: >
Internal related resource URLs, don't edit
unless you know what you're doing
fields:
- label: Video Thumbnail URL
name: video_thumbnail_file
widget: string
- label: Video Captions (WebVTT) URL
name: video_captions_file
widget: string
- label: Video Transcript (PDF) URL
name: video_transcript_file
widget: string
- label: Internet Archive URL
name: archive_url
widget: string
- category: Content
name: external-resource
label: External Resources
folder: content/external-resources
fields:
- label: Title
name: title
widget: string
required: true
help: The default link text for this external resource.
- label: URL
name: external_url
widget: string
required: true
help: >
The URL. For example,
https://owl.english.purdue.edu/owl/resource/747/01/
- label: Wayback URL
name: wayback_url
widget: string
required: false
readOnly: true
help: URL to the last Wayback Machine snapshot of the resource.
- label: License
name: license
widget: select
options:
- label: CC BY
value: https://creativecommons.org/licenses/by/4.0/
- label: CC BY-NC
value: https://creativecommons.org/licenses/by-nc/4.0/
- label: CC BY-NC-SA
value: https://creativecommons.org/licenses/by-nc-sa/4.0/
- label: CC BY-SA
value: https://creativecommons.org/licenses/by-sa/4.0/
- label: public domain
value: https://creativecommons.org/publicdomain/zero/1.0/
- label: All Rights Reserved
value: https://en.wikipedia.org/wiki/All_rights_reserved
default: https://en.wikipedia.org/wiki/All_rights_reserved
required: true
- label: Include non-OCW licensing warning
name: has_external_license_warning
widget: boolean
default: false
required: true
help: >
If true, user sees warning that external content is not
covered by OCW licensing.
- label: Status
name: status
widget: hidden
required: false
help: >
The current status of the external resource
(e.g., valid, broken, unchecked, check_failed).
- category: Content
folder: content/instructors
label: Instructor
name: instructor
slug: text_id
fields:
- label: Draft
name: draft
required: true
widget: boolean
help: Enable this setting to prevent publishing in production
- label: Title
name: title
widget: string
required: true
- label: First name
name: first_name
widget: string
required: true
- label: Middle initial
name: middle_initial
widget: string
required: false
- label: Last name
name: last_name
widget: string
required: true
- label: Salutation
name: salutation
widget: string
required: false
- label: Headless
name: headless
widget: hidden
default: true
- category: Settings
label: Menu
name: menu
files:
- file: config/_default/menus.yaml
name: navmenu
label: Navigation Menu
fields:
- { "label": "Menu", "name": "mainmenu", "widget": "menu" }
- category: Settings
label: Homepage
name: homepage
files:
- file: data/homepage.yaml
name: homepage_settings
label: Homepage Settings
fields:
- label: Featured Promos
name: featured_promos
widget: relation
collection: promos
display_field: title
multiple: true
sortable: true
- label: Featured Stories
name: featured_stories
widget: relation
collection: stories
display_field: title
multiple: true
sortable: true