Editor Generalisation: Configurations

Owned by Kartheek Palla
Last updated: Feb 25, 2021
3 min read

Collection Editor Config - (Course / Question Set)

The editor library will expect two configurations as Inputs - EditorConfig and FormConfig.

EditorConfig will carry two objects - context and config.

FormConfig will carry the array of form configs as desired.

Library - Two inputs 1. EditorConfig - context - channel - framework - tragetFwIds - additionalCategories - sid - telemetryData - userInfo - awsUrls - config - mode - primaryCategory HierarchyConfig - playerConfig - toolbarConfig 2. FormConfig - rootNodeFrom - unitNodeForm - leafNodeFrom - searchForm

Hierarchy Config:

Hierarchy Configuration will define how the a collection - (Course, DigitalTextbook etc) will be rendered within the Editor.

Following are the configuration for different types of collections.

1. Course:

{ "maxDepth": 2, "objectType": "Collection", "primaryCategory": "Course", "isRoot": true, "iconClass": "fa fa-book", "children": {}, "hierarchy": { "level1": { "name": "Chapter", "type": "unit", "mimeType": "application/vnd.ekstep.content-collection", "contentType": "Course Unit", "iconClass": "fa fa-folder-o", "children": {} }, "level2": { "name": "Sub-Chapter", "type": "unit", "mimeType": "application/vnd.ekstep.content-collection", "contentType": "Course Unit", "iconClass": "fa fa-folder-o", "children": { "Content": [ "Explanation Content", "Learning Resource", "eTextbook", "Teacher Resource", "Course Assessment" ], "QuestionSet": [ "Practice Question Set" ] } } } }

2. Digital textbook:

{ "maxDepth": 2, "objectType": "Collection", "primaryCategory": "Digital Textbook", "isRoot": true, "iconClass": "fa fa-book", "children": {}, "hierarchy": { "level1": { "name": "Chapter", "type": "unit", "mimeType": "application/vnd.ekstep.content-collection", "contentType": "Textbook Unit", "iconClass": "fa fa-folder-o", "children": {} }, "level2": { "name": "Sub-Chapter", "type": "unit", "mimeType": "application/vnd.ekstep.content-collection", "contentType": "Textbook Unit", "iconClass": "fa fa-folder-o", "children": { "Content": [] } } } }

QuestionSet: