summaryrefslogtreecommitdiff
path: root/data/types/process.tt
blob: 59dd13568fbf7b56b4913bf9c0ff58832b6d0894 (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
[meta]
prefix: com.tangiblebit.type # prefix used for all IDs in this document
id: process
description: A process description

[req] # Required properties
name(freetext): An informal name and short summary of the process.

id(string):
  An ID uniquely identifying the process. Tip: derive from the ID of the
  corresponding object (e.g. "com.example.coffeemaker.buildit" for a
  process documenting how to build a "com.example.coffeemaker" object).

license(string):
  The license under which the process 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 process 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
description(freetext): A description of the process.

homepage(string): The homepage of the process.

lastModified(timestamp):
  Timestamp showing when the process description or the files connected
  with the process were last modified.

softwareLicense(string):
  The license under which the software related to the process 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 process database).
  If omitted, the value given in the *license* field is used instead.

[list] # Properties occurring once or more
maintainer(contact): List of people to contact regarding questions about
  the process (typically same as for the corresponding object).

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

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

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

file(file):
  List of files that are helpful in order to better understand the process,
  but aren't generally necessary in order to execute it (pointers to files
  stored in the *files* folder).