summaryrefslogtreecommitdiff
path: root/data/types/file.tt
blob: 3c0ba63056279e946700ba07fcf7a5e2c7cf3502 (plain)
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
[meta]
prefix: com.tangiblebit.type # prefix used for all IDs in this document
id: file
description: Metadata describing a file

[req] # Required properties
name(string): The name of the file.

[opt] # Optional properties
role(string):
  The role of the file in regard to the object, e.g. "depiction"
  (audio/visual of the object, e.g. a photo, drawing, or movie), "faq",
  "whitepaper". The default role is "thumbnail". On the TBit website there
  is a controlled vocabulary of recommended values for this field. Note:
  files such as "manual" should be associated with a *use process*, not
  with an object.

description(freetext):
  A (preferably short) description of the file and its purpose.

mimetype(string): The MIME type; if omitted, the file extension is used to
  determine to likely MIME type.

software(bool):
  If true, this file is licensed under the conditions specified in the
  *softwareLicense* field, otherwise (default) under the conditions of the
  *license* field. This field is only used to provide licensing information
  (it does not matter whether the file really contains software).