update metadata schema and index link

This commit is contained in:
dukeeagle 2023-01-02 17:53:21 -05:00
parent 55081ade3f
commit 5c0405c3f4
2 changed files with 97 additions and 1 deletions

96
viewer/metadata_schema.md Normal file
View File

@ -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":, ""
}
}
```

View File

@ -40,7 +40,7 @@ const Home: NextPage = () => {
documentary metadata viewer
</h1>
{/* hug the left-hand side of the screen */}
<h2 className=" tracking-tight text-gray-500 dark:text-white top-20 left-6 absolute"><i>current film</i>: <a href="https://www.youtube.com/watch?v=TGKk3iwoI9I&ab_channel=MIT%3AREGRESSIONS">MIT: REGRESSIONS intro</a> &nbsp; | &nbsp; <a href="https://github.com/mit-regressions/viewer/blob/igel-t3-initial/viewer/public/data/MIT%20Regressions%20intro%20metadata.vtt">metadata source</a></h2>
<h2 className=" tracking-tight text-gray-500 dark:text-white top-20 left-6 absolute"><i>current film</i>: <a href="https://www.youtube.com/watch?v=TGKk3iwoI9I&ab_channel=MIT%3AREGRESSIONS">MIT: REGRESSIONS intro</a> &nbsp; | &nbsp; <a href="https://github.com/mit-regressions/viewer/blob/main/viewer/public/data/MIT%20Regressions%20intro%20metadata.vtt">metadata source</a></h2>
{/* <h2 className=" tracking-tight text-gray-500 dark:text-white top-24 left-6 absolute"><i>metadata file source (VTT)</i>: <a href="https://www.youtube.com/watch?v=TGKk3iwoI9I&ab_channel=MIT%3AREGRESSIONS">MIT: REGRESSIONS intro</a></h2> */}
</div>