diff --git a/viewer/metadata_schema.md b/viewer/metadata_schema.md new file mode 100644 index 0000000..e21338c --- /dev/null +++ b/viewer/metadata_schema.md @@ -0,0 +1,96 @@ +### Base data point + +```jsx +{ + "start": "", + "end": "", + "uid": "", + "type": {"music","commentary","transcript","video_source","narration_source", "ohms"} + "data": {} +} + +``` + +### Special data types + +##### music + +```jsx +{ + "type": "music" + "title": "", + "artist": "", + "year": "" + + "hyperlink": "" +} +``` + +### **transcript** + +```jsx +{ + "type": "transcript" + "text": "", // note: may contain VTT-compatible styling +} +``` + +### **footage_source** + +```jsx +{ + "type": "footage_source", + "title": "" + "attribution": "", + "year": "" + + "hyperlinks": { + "hyperlink": "http://example.org", + "hyperlink_text": "", + "hyperlink_text_alt":, "" + } +} +``` + +### **narration_source** + +```jsx +{ + "type": "narration_source" + "title": "" + "attribution": "", + "year": "" + + "hyperlinks": { + "hyperlink": "http://example.org", + "hyperlink_text": "", + "hyperlink_text_alt":, "" + } +} +``` + +### **ohms** (or **concept**) ([http://ohda.matrix.msu.edu/2014/11/indexing-interviews-in-ohms/](http://ohda.matrix.msu.edu/2014/11/indexing-interviews-in-ohms/)) + +```jsx +{ // directly copied from webvtt-player (which copies the OHMS standard) + "title": "", + "title_alt": "", + "synopsis": "", + "synopsis_alt": "", + "keywords": "", + "keywords_alt": "", + "subjects": "", + "subjects_alt": "", + "gpspoints": { + "gps": "00.0000000, 00.0000000", + "gps_zoom": "0", + "gps_text": "", + "gps_text_alt": "" + }, + "hyperlinks": { + "hyperlink": "http://example.org", + "hyperlink_text": "", + "hyperlink_text_alt":, "" + } +} +``` \ No newline at end of file diff --git a/viewer/src/pages/index.tsx b/viewer/src/pages/index.tsx index ffedb86..0bcb271 100644 --- a/viewer/src/pages/index.tsx +++ b/viewer/src/pages/index.tsx @@ -40,7 +40,7 @@ const Home: NextPage = () => { documentary metadata viewer {/* hug the left-hand side of the screen */} -