D3web: Doc Properties

This page (revision-2) was last changed on 16-Oct-2026 10:31 by Albrecht Striffler

This page was created on 26-Oct-2012 10:15 by Joachim Baumeister

Only authorized users are allowed to rename pages.

Only authorized users are allowed to delete pages.

Page revision history

Version	Date Modified	Size	Author	Changes ...	Change note
2	16-Oct-2026 10:31	3 KB	Albrecht Striffler	to previous	Use current project URLs in the link example instead of the old SourceForge sites
1	26-Oct-2012 10:15	3 KB	Joachim Baumeister	to last

Page References

Incoming links	Outgoing links
Doc Properties Doc Overview	Doc Properties


1	1		It is possible to attach properties to a terminology object (e.g., a question or a solution).
2	2
3	3		For instance, for the following terminology objects we can define some properties:
4	4
5	5		{{{%%Question
6	6		Questionnaire
7	7		- question1 [oc]
8	8		-- answer1
9	9		-- answer2
10	10		- question2 [num]
11	11		%
12	12		}}}
13	13
14	14		{{{%%Solution
15	15		Solution1
16	16		Solution2
17	17		%
18	18		}}}
19	19
20	20		!!! Prompts in different languages
21	21
22	22		{{{%%Property
23	23		question1.prompt = Default prompt for question1
24	24		question1.prompt.de = German prompt for question1
25	25		question1.prompt.en = English prompt for question1
26	26		question1#answer1.prompt = Default prompt for answer1 of question1
27	27		question1#answer1.prompt.de = German prompt for answer1 of question1
28	28		question1#answer1.prompt.en = English prompt for answer1 of question1
29	29
30	30		solution1.prompt.de = German text for solution1
31	31		%
32	32		}}}
33	33
34	34		!!! Set same property for choices with same name
35	35
36	36		In case you want to set the same property for choices with the same name, e.g. in a scenario where you add another language to a knowledge base via the prompt property, you can just assign the property to the choice name without a question in front of it. To make clear that it is a choice you still need the # in front.
37	37
38	38		{{{%%Property
39	39		#Yes.prompt.de = Ja
40	40		#No.prompt.de = Nein
41	41		%
42	42		}}}
43	43
44	44		Here we added the translated prompts for all yes/no choices in the whole knowledge base.
45	45
46	46		!!! Unknown visible and verbalisation
47	47
48	48		Each question can be answered with the default value "unknown", when activated. You can active/deactivate the presentation of the "unknown" in the dialog globally for the entire knowledge base by
49	49
50	50		{{{%%Property
51	51		KNOWLEDGEBASE.unknownVisible = true/false
52	52		KNOWLEDGEBASE.unknown_verbalisation = An unknown text
53	53		%
54	54		}}}
55	55
56	56		The second setting "unknown_verbalisation" globally defines the answer text, that is displayed in the dialog for the presentation of the unknown value.
57	57
58	58		You can change these settings locally for single question. The default answer "unknown" of question1 and question2 to be visible and invisible, respectively, is set as following.
59	59
60	60		{{{%%Property
61	61		question1.unknownVisible = true
62	62		question2.unknownVisible = false
63	63		%
64	64		}}}
65	65
66	66		The unknown answer can have different prompt for different languages:
67	67
68	68		{{{%%Property
69	69		question1.unknown_verbalisation.de = unbekannt
70	70		question2.unknown_verbalisation.en = unknown
71	71		%
72	72		}}}
73	73
74	74
75	75		!!! Links for questions and solutions
76	76
77	77		You can attach links to a solution or a question:
78	78
79	79		{{{%%Property
80		−	question1.link = https://www.d3web.de/
81		−	solution1.link = https://github.com/denkbares/d3web-KnowWE
	80	+	question1.link = http://d3web.sourceforge.net/
	81	+	solution1.link = http://knowwe.sourceforge.net/
82	82		%
83	83		}}}
84	84

85	85		!!! Descriptions for questions and solutions
86	86
87	87		You can attach textual descriptions to a solution or a question:
88	88
89	89		{{{%%Property
90	90		question1.description = This is a description test for question1
91	91		%
92	92		}}}
93	93
94	94
95	95
96	96
97	97		!!! Special chars and Quoting
98	98
99	99		You can set most properties without using quotes. Some letters however are reserved for special purposes (like # . or =), so having names or content containing these letters require you to quote.
100	100
101	101		{{{%%Property
102	102		"question.1".description = "This is a description containing some special chars: .=# "
103	103		%
104	104		}}}
105	105
106	106		Of course there are situations where you might have quotes in the content of the property or content that is to long to fit in one line. For these cases there is the possibility to use triple quotes.
107	107
108	108		{{{%%Property
109	109		"question.1".description =
110	110		"""This is a description containing
111	111		some "special" and is even spanning
112	112		over several lines."""
113	113		%
114	114		}}}
115	115
116	116		%%tags
117	117		Documentation properties
118	118		%
119	119

Page revision history

Page References

Annotate

Version management