summaryrefslogtreecommitdiff
path: root/data/types/object.tt
blob: 330c9d1bf7144f94f8ad2be9c613cf44c736eafb (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
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
[meta]
prefix: com.tangiblebit.type # prefix used for all IDs in this document
id: object
description: The root of the object hierarchy.

[req] # Required properties
name(freetext): An informal name of the object.

id(string):
  An ID uniquely identifying the object; to avoid name clashes, you should
  use "reverse domain name notation" (like Java package) starting with a
  domain you control. Sample: com.example.coffeemaker if you own the
  example.com domain.

summary(freetext): A short (one line) description of what the object is and
  what it can be used for.

license(string):
  The license under which the object is made available (must be compatible
  with CC-SA-BY or a free software/open source license in order to allow
  inclusion in the TB object database). On the TBit website there is
  controlled vocabulary of license names that should be used in this field
  and in the *softwareLicense* field.

[opt] # Optional properties
homepage(string): The homepage of the object.

orderpage(string): A web page where prebuilt copies of the object or kits
  or components can be ordered.

producer(string): The company or organization typically (or initially)
  producing the object.

description(freetext):
  A longer description of the object.

lastModified(timestamp): Timestamp showing when the object metadata or the
  files or processes connected with the object where last modified.

weight(mass):
  The weight of the object (set to 0 if this is a non-material object).

width(length): The total width of the object, when fitting it into a box (0
  if this is a non-material object).

depth(length): The total depth of the object, when fitting it into a box (0
  if this is a non-material object).

height(length): The total height of the object, when fitting it into a box
  (0 if this is a non-material object).

softwareLicense(string):
  The license under which the software related to the object is made
  available (must be compatible with CC-SA-BY or a free software/open
  source license in order to allow inclusion in the TB object
  database). If omitted, the value given in the *license* field is used
  instead.

[list] # Properties occurring once or more
category(identifier): List of categories the object belongs to.

maintainer(contact):
  List of people to contact regarding questions about the object.

replaces(string):
  List of object IDs this object is meant to replace/make obsolete.

[optlist] # Properties occurring any number of times
author(contact):
  List of the people which created/packaged the object.

thumbnail(file): List of small visual depictions of the object (pointers to
  image files--stored in the *thumbnails* folder).

file(file): List of files associated with the object (pointers to files
  stored in the *files* folder).

# Lists of processes associated with the object
build:
  List of processes (IDs) explaining how to build/produce the object.

setup:
  List of processes (IDs) explaining how to setup the object prior to using
  it (comes between build and usage, and can optionally later be repeated
  when necessary.) Sample: program channel list on a TV set.

use: List of processes (IDs) explaining how to use the object, in general
  or for some specific purpose.

dismantle: List of processes (IDs) explaining how to dismantle/disassemble
  the object.

maintain:
  List of processes (IDs) explaining how to maintain the object--describes
  operations that need to be performed regularly or occasionally to keep
  the object in good order. Sample: change oil in a car.

repair: List of processes (IDs) explaining how to repair the object or some
  parts of it.

replace: List of processes (IDs) explaining how to replace same part of the
  object.