Summary

• Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

...	...	@@ -28,4 +28,13 @@
28	28
29	29	We propose that a domain be packaged as a directory which can be shared as a repository and to contain the following directory organization:
30	30
31		-- the directory-name contains a recognizable
	31	+- the directory-name reflects the course name
	32	+- the directory contains a file `about.json` with the properties `title`, `description`, `language` (in iso-639-3) and an array of strings for the authors, `subjects` an array of strings containing the LC-subject-classification, and `logo` (the link to a logo)
	33	+- the directory contains a file `license.txt` with the license text
	34	+- the directory contains a `labels.txt` file with a list of label names, organized in a hierarchy by simple indenting
	35	+- the directory contains a file `pipeline.json` with the steps of the analysis and aggregation (TODO: more details, THINKME: added CSS?)
	36	+ - the pipeline refers to the model spacy directories (level 1 and one for the children of each level 1) which are included
	37	+- any extra file or directory mentioned as link
	38	+- any file used for development, documented by a `README.md`
	39	+
	40	+All paths of links used in the `about.json` and `pipeline.json` files can be resolved in a relative manner. For them to be recognized, we recommend to express relative paths with the syntax of starting with `./` as in `"logo":"./my-logo.svg"`. This allows the web-app to perform relative resolution in a secure way (not going outside of the domain directory except for known places) before it is given to the web-server or to the analysis scripts.