LibKEduVocDocument

kvtmldefs.h
1/*
2 * Vocabulary Document for KDE Edu
3 * SPDX-FileCopyrightText: 1999-2001 Ewald Arnold <kvoctrain@ewald-arnold.de>
4 * SPDX-FileCopyrightText: 2005, 2007 Peter Hedlund <peter.hedlund@kdemail.net>
5 * SPDX-FileCopyrightText: 2007 Frederik Gladhorn <frederik.gladhorn@kdemail.net>
6 * SPDX-License-Identifier: GPL-2.0-or-later
7 */
8
9#ifndef KVTMLDEFS_H
10#define KVTMLDEFS_H
11
12/** XML tags and attribute names */
13
14static const QLatin1String KV_DOCTYPE("kvtml"); // doctype
15#define KV_TITLE "title" // doc title
16#define KV_AUTHOR "author" // doc author
17#define KV_LICENSE "license" // doc license
18#define KV_DOC_REM "remark" // doc remark
19#define KV_LINES "lines" // entries
20#define KV_GENERATOR "generator" // who generated the doc
21#define KV_COLS "cols" // columns
22#define KV_ENCODING "encoding" // document encoding (obsolete!)
23
24#define KV_EXPR "e" // entry for one expression
25static const QLatin1String KV_ORG("o"); // original expression in specified language
26static const QLatin1String KV_TRANS("t"); // translated expression in specified language
27#define KV_LANG "l" // language: en, de, it, fr ...
28#define KV_QUERY "q" // query: org or translation
29#define KV_O "o" // org
30#define KV_T "t" // translation
31#define KV_GRADE "g" // grade of knowledge: 0=well known, x=not known for x times
32#define KV_LESS_MEMBER "m" // member of lesson 1 .. x
33#define KV_COUNT "c" // number of times queried
34#define KV_SIZEHINT "width" // recommended column width
35#define KV_CHARSET "charset" // recommended charset (obsolete!)
36#define KV_BAD "b" // number of times failed
37#define KV_DATE "d" // last query date
38#define KV_DATE2 "w" // last query date, compressed format, deprecated, currently ignored
39#define KV_REMARK "r" // remark for this entry
40#define KV_FAUX_AMI_F "ff" // false friend of this entry from org
41#define KV_FAUX_AMI_T "tf" // false friend of this entry to org
42#define KV_SYNONYM "y" // synonym (same meaning) of expr
43#define KV_ANTONYM "a" // antonym (opposite) of expr
44#define KV_PRONUNCE "p" // how to pronounce this expression
45#define KV_SELECTED "s" // entry selected for queries
46#define KV_INACTIVE "i" // entry inactive (for queries)
47#define KV_EXPRTYPE "t" // type of expression
48#define KV_EXAMPLE "x" // example string with word
49#define KV_USAGE "u" // usage label
50#define KV_PARAPHRASE "h" // paraphrase for expression
51
52/*
53 <type>
54 <desc no="1">My type 1</desc>
55 <desc no="2">My type 2</desc>
56 </type>
57*/
58
59#define KV_TYPE_GRP "type" // type descriptor group
60#define KV_TYPE_DESC "desc" // type descriptor
61#define KV_TYPE_NO "no" // type descriptor number
62
63/*
64 <usage>
65 <desc no="1">My usage 1</desc>
66 <desc no="2">My usage 2</desc>
67 </type>
68*/
69
70#define KV_USAGE_GRP "usage" // usage descriptor group
71#define KV_USAGE_DESC "desc" // usage descriptor
72#define KV_USAGE_NO "no" // usage descriptor number
73
74/*
75 <lesson width="138">
76 <desc no="1">Lesson #1</desc>
77 <desc no="2" query="1">Lesson #2</desc>
78 </lesson>
79*/
80
81#define KV_LESS_GRP "lesson" // lesson descriptor group
82#define KV_LESS_CURR "current" // is current lesson
83#define KV_LESS_DESC "desc" // lesson descriptor
84#define KV_LESS_QUERY "query" // lesson contained in query
85#define KV_LESS_NO "no" // lesson descriptor number
86
87/*
88 <tense>
89 <desc no="1">user tense #1</desc>
90 <desc no="2">user tense #2</desc>
91 </tense>
92*/
93
94#define KV_TENSE_GRP "tense" // tense descriptor group
95#define KV_TENSE_DESC "desc" // tense descriptor
96#define KV_TENSE_NO "no" // tense descriptor number
97
98/*
99 <options>
100 <sort on="1"/>
101 </options>
102*/
103
104#define KV_OPTION_GRP "options" // internal options group
105#define KV_OPT_SORT "sort" // allow sorting
106#define KV_BOOL_FLAG "on" // general boolean flag
107
108/*
109 <article>
110 <e l="de"> lang determines also lang order in entries !!
111 <fi>eine</fi> which must NOT differ
112 <fd>die</fd>
113 <mi>ein</mi>
114 <md>der</md>
115 <ni>ein</ni>
116 <nd>das</nd>
117 </e>
118 </article>
119*/
120
121#define KV_ARTICLE_GRP "article" // article descriptor group
122static const QLatin1String KV_ART_ENTRY("e"); // article entry
123#define KV_ART_FD "fd" // female definite
124#define KV_ART_MD "md" // male definite
125#define KV_ART_ND "nd" // natural definite
126#define KV_ART_FI "fi" // female indefinite
127#define KV_ART_MI "mi" // male indefinite
128#define KV_ART_NI "ni" // natural indefinite
129
130/*
131 <comparison>
132 <l1>good</l1>
133 <l2>better</l2>
134 <l3>best</l3>
135 </comparison>
136*/
137
138#define KV_COMPARISON_GRP "comparison" // comparison descriptor group
139#define KV_COMP_L1 "l1" // base form
140#define KV_COMP_L2 "l2" // next form
141#define KV_COMP_L3 "l3" // last form
142
143/*
144 <multiplechoice>
145 <mc1>good</mc1>
146 <mc2>better</mc2>
147 <mc3>best</mc3>
148 <mc4>best 2</mc4>
149 <mc5>best 3</mc5>
150 </multiplechoice>
151*/
152
153#define KV_MULTIPLECHOICE_GRP "multiplechoice" // multiple choice descriptor group
154#define KV_MC_1 "mc1" // choice 1
155#define KV_MC_2 "mc2" // choice 2
156#define KV_MC_3 "mc3" // choice 3
157#define KV_MC_4 "mc4" // choice 4
158#define KV_MC_5 "mc5" // choice 5
159
160/*
161 <conjugation> used in header for definition of "prefix"
162 <e l="de"> lang determines also lang order in entries !!
163 <s1>I</s1> which must NOT differ in subsequent <e>-tags
164 <s2>you<2>
165 <s3f>he</s3f>
166 <s3m>she</s3m>
167 <s3n>it</s3n>
168 <p1>we</p1>
169 <p2>you</p2>
170 <p3f>they</p3f>
171 <p3m>they</p3m>
172 <p3n>they</p3n>
173 </e>
174 </conjugation>
175
176 <conjugation> and in entry for definition of tenses of (irreg.) verbs
177 <t n="sipa">
178 <s1>go</s1>
179 <s2>go</s2>
180 <s3f>goes</s3f>
181 <s3m>goes</s3m>
182 <s3n>goes</s3n>
183 <p1>go</p1>
184 <p2>go</p2>
185 <p3f>go</p3f>
186 <p3m>go</p3m>
187 <p3n>go</p3n>
188 </t>
189 </conjugation>
190*/
191
192#define KV_CONJUG_GRP "conjugation" // conjugation descriptor group
193#define KV_CON_ENTRY "e" // conjugation entry (header)
194#define KV_CON_TYPE "t" // conjugation type (voc entries)
195#define KV_CON_NAME "n" // conjugation type name (voc entries)
196#define KV_CON_P1S "s1" // 1. person singular
197#define KV_CON_P2S "s2" // 2. person singular
198#define KV_CON_P3SF "s3f" // 3. person singular female
199#define KV_CON_P3SM "s3m" // 3. person singular male
200#define KV_CON_P3SN "s3n" // 3. person singular natural
201#define KV_CON_P1P "p1" // 1. person plural
202#define KV_CON_P2P "p2" // 2. person plural
203#define KV_CON_P3PF "p3f" // 3. person plural female
204#define KV_CON_P3PM "p3m" // 3. person plural male
205#define KV_CON_P3PN "p3n" // 3. person plural natural
206#define KV_CONJ_COMMON "common" // female contains common for all three
207
208#endif // KVTMLDEFS_H
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Sat Dec 21 2024 17:05:43 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.