decentral1se/pandora
1
0
Fork 0
forked from 0x2620/pandora
Code Issues Pull requests Projects Releases Wiki Activity

update confic docs (minor changes)

Browse source
This commit is contained in:
rolux 2014-12-21 11:53:29 +00:00
parent 1e3daf4b33
commit 2ba41cd89d
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
pandora/config.pandora.jsonc
View file

@ -98,7 +98,7 @@ examples (config.SITENAME.jsonc) that are part of this pan.do/ra distribution.
with "name", "biography", "photo" etc). The HTML representation for with "name", "biography", "photo" etc). The HTML representation for
entities can be customized by adding "/static/js/entity.SITENAME.js". entities can be customized by adding "/static/js/entity.SITENAME.js".
Each entity has the following properties: Each entity has the following properties:
"id": Internal ID (can be referenced in "layers") "id": Unique internal ID (can be referenced in "layers")
"title": Human-readable title "title": Human-readable title
"keys": List of properties "keys": List of properties
"sortType": Optional. If set to "person" or "title", then the sort "sortType": Optional. If set to "person" or "title", then the sort
@ -106,7 +106,7 @@ examples (config.SITENAME.jsonc) that are part of this pan.do/ra distribution.
Each key has the properties "id", "title" and "type". "type" can be Each key has the properties "id", "title" and "type". "type" can be
"boolean", "number", "string", "text", "document" (reference to the id of a "boolean", "number", "string", "text", "document" (reference to the id of a
document added via "Manage Documents") or ["string"] (list of strings). document added via "Manage Documents") or ["string"] (list of strings).
"id" and "name" keys are required. If "additional_names" is present, these "id" and "name" keys are required. If "additionalNames" is present, these
will act as synonyms when autocompleting values entered as annotations. will act as synonyms when autocompleting values entered as annotations.
*/ */
"entities": [], "entities": [],
@ -143,7 +143,7 @@ examples (config.SITENAME.jsonc) that are part of this pan.do/ra distribution.
are "*", "id" and "title". Adding a key with "random" as id will produce a are "*", "id" and "title". Adding a key with "random" as id will produce a
random value; this can be used for a "random" sort order. random value; this can be used for a "random" sort order.
An itemKey must have the following properties: An itemKey must have the following properties:
"id": The id of the key (as known by the server) "id": The unique id of the key (as known by the server)
"title": The title of the key (as displayed by the client) "title": The title of the key (as displayed by the client)
"type": Can be "boolean", "date", "enum", "float", "hue", "integer", "type": Can be "boolean", "date", "enum", "float", "hue", "integer",
"layer", "string", "text", "time" or ["..."] (list of values of "layer", "string", "text", "time" or ["..."] (list of values of
@ -552,7 +552,7 @@ examples (config.SITENAME.jsonc) that are part of this pan.do/ra distribution.
"type": Can be "entity", "string" or "text" (strings cannot contain "type": Can be "entity", "string" or "text" (strings cannot contain
line breaks, text can contain HTML markup). line breaks, text can contain HTML markup).
Optional keys are: Optional keys are:
"canAddAnnotations": "canAddAnnotations": Permissions per user level
"entity": ID of the referenced entity (if type is "entity") "entity": ID of the referenced entity (if type is "entity")
"hasEvents": If true, the calendar will be populated with matches from "hasEvents": If true, the calendar will be populated with matches from
this layer this layer