File indexing completed on 2024-04-14 03:46:40

0001 /*
0002  * Vocabulary Document for KDE Edu
0003  * SPDX-FileCopyrightText: 1999-2001 Ewald Arnold <kvoctrain@ewald-arnold.de>
0004  * SPDX-FileCopyrightText: 2005, 2007 Peter Hedlund <peter.hedlund@kdemail.net>
0005  * SPDX-FileCopyrightText: 2007 Frederik Gladhorn <frederik.gladhorn@kdemail.net>
0006  * SPDX-License-Identifier: GPL-2.0-or-later
0007  */
0008 
0009 #ifndef KVTMLDEFS_H
0010 #define KVTMLDEFS_H
0011 
0012 /** XML tags and attribute names */
0013 
0014 static const QLatin1String KV_DOCTYPE("kvtml"); // doctype
0015 #define KV_TITLE "title" // doc title
0016 #define KV_AUTHOR "author" // doc author
0017 #define KV_LICENSE "license" // doc license
0018 #define KV_DOC_REM "remark" // doc remark
0019 #define KV_LINES "lines" // entries
0020 #define KV_GENERATOR "generator" // who generated the doc
0021 #define KV_COLS "cols" // columns
0022 #define KV_ENCODING "encoding" // document encoding  (obsolete!)
0023 
0024 #define KV_EXPR "e" // entry for one expression
0025 static const QLatin1String KV_ORG("o"); // original expression in specified language
0026 static const QLatin1String KV_TRANS("t"); // translated expression in specified language
0027 #define KV_LANG "l" // language: en, de, it, fr ...
0028 #define KV_QUERY "q" // query: org or translation
0029 #define KV_O "o" // org
0030 #define KV_T "t" // translation
0031 #define KV_GRADE "g" // grade of knowledge: 0=well known, x=not known for x times
0032 #define KV_LESS_MEMBER "m" // member of lesson 1 .. x
0033 #define KV_COUNT "c" // number of times queried
0034 #define KV_SIZEHINT "width" // recommended column width
0035 #define KV_CHARSET "charset" // recommended charset (obsolete!)
0036 #define KV_BAD "b" // number of times failed
0037 #define KV_DATE "d" // last query date
0038 #define KV_DATE2 "w" // last query date, compressed format, deprecated, currently ignored
0039 #define KV_REMARK "r" // remark for this entry
0040 #define KV_FAUX_AMI_F "ff" // false friend of this entry from org
0041 #define KV_FAUX_AMI_T "tf" // false friend of this entry to org
0042 #define KV_SYNONYM "y" // synonym (same meaning) of expr
0043 #define KV_ANTONYM "a" // antonym (opposite) of expr
0044 #define KV_PRONUNCE "p" // how to pronounce this expression
0045 #define KV_SELECTED "s" // entry selected for queries
0046 #define KV_INACTIVE "i" // entry inactive (for queries)
0047 #define KV_EXPRTYPE "t" // type of expression
0048 #define KV_EXAMPLE "x" // example string with word
0049 #define KV_USAGE "u" // usage label
0050 #define KV_PARAPHRASE "h" // paraphrase for expression
0051 
0052 /*
0053  <type>
0054   <desc no="1">My type 1</desc>
0055   <desc no="2">My type 2</desc>
0056  </type>
0057 */
0058 
0059 #define KV_TYPE_GRP "type" // type descriptor group
0060 #define KV_TYPE_DESC "desc" // type descriptor
0061 #define KV_TYPE_NO "no" // type descriptor number
0062 
0063 /*
0064  <usage>
0065   <desc no="1">My usage 1</desc>
0066   <desc no="2">My usage 2</desc>
0067  </type>
0068 */
0069 
0070 #define KV_USAGE_GRP "usage" // usage descriptor group
0071 #define KV_USAGE_DESC "desc" // usage descriptor
0072 #define KV_USAGE_NO "no" // usage descriptor number
0073 
0074 /*
0075  <lesson width="138">
0076   <desc no="1">Lesson #1</desc>
0077   <desc no="2" query="1">Lesson #2</desc>
0078  </lesson>
0079 */
0080 
0081 #define KV_LESS_GRP "lesson" // lesson descriptor group
0082 #define KV_LESS_CURR "current" // is current lesson
0083 #define KV_LESS_DESC "desc" // lesson descriptor
0084 #define KV_LESS_QUERY "query" // lesson contained in query
0085 #define KV_LESS_NO "no" // lesson descriptor number
0086 
0087 /*
0088  <tense>
0089   <desc no="1">user tense #1</desc>
0090   <desc no="2">user tense #2</desc>
0091  </tense>
0092 */
0093 
0094 #define KV_TENSE_GRP "tense" // tense descriptor group
0095 #define KV_TENSE_DESC "desc" // tense descriptor
0096 #define KV_TENSE_NO "no" // tense descriptor number
0097 
0098 /*
0099  <options>
0100   <sort on="1"/>
0101  </options>
0102 */
0103 
0104 #define KV_OPTION_GRP "options" // internal options group
0105 #define KV_OPT_SORT "sort" // allow sorting
0106 #define KV_BOOL_FLAG "on" // general boolean flag
0107 
0108 /*
0109  <article>
0110   <e l="de">        lang determines also lang order in entries !!
0111    <fi>eine</fi>    which must NOT differ
0112    <fd>die</fd>
0113    <mi>ein</mi>
0114    <md>der</md>
0115    <ni>ein</ni>
0116    <nd>das</nd>
0117   </e>
0118  </article>
0119 */
0120 
0121 #define KV_ARTICLE_GRP "article" // article descriptor group
0122 static const QLatin1String KV_ART_ENTRY("e"); // article entry
0123 #define KV_ART_FD "fd" // female definite
0124 #define KV_ART_MD "md" // male definite
0125 #define KV_ART_ND "nd" // natural definite
0126 #define KV_ART_FI "fi" // female indefinite
0127 #define KV_ART_MI "mi" // male indefinite
0128 #define KV_ART_NI "ni" // natural indefinite
0129 
0130 /*
0131  <comparison>
0132    <l1>good</l1>
0133    <l2>better</l2>
0134    <l3>best</l3>
0135  </comparison>
0136 */
0137 
0138 #define KV_COMPARISON_GRP "comparison" // comparison descriptor group
0139 #define KV_COMP_L1 "l1" // base form
0140 #define KV_COMP_L2 "l2" // next form
0141 #define KV_COMP_L3 "l3" // last form
0142 
0143 /*
0144  <multiplechoice>
0145    <mc1>good</mc1>
0146    <mc2>better</mc2>
0147    <mc3>best</mc3>
0148    <mc4>best 2</mc4>
0149    <mc5>best 3</mc5>
0150  </multiplechoice>
0151 */
0152 
0153 #define KV_MULTIPLECHOICE_GRP "multiplechoice" // multiple choice descriptor group
0154 #define KV_MC_1 "mc1" // choice 1
0155 #define KV_MC_2 "mc2" // choice 2
0156 #define KV_MC_3 "mc3" // choice 3
0157 #define KV_MC_4 "mc4" // choice 4
0158 #define KV_MC_5 "mc5" // choice 5
0159 
0160 /*
0161  <conjugation>        used in header for definition of "prefix"
0162   <e l="de">          lang determines also lang order in entries !!
0163    <s1>I</s1>         which must NOT differ in subsequent <e>-tags
0164    <s2>you<2>
0165    <s3f>he</s3f>
0166    <s3m>she</s3m>
0167    <s3n>it</s3n>
0168    <p1>we</p1>
0169    <p2>you</p2>
0170    <p3f>they</p3f>
0171    <p3m>they</p3m>
0172    <p3n>they</p3n>
0173   </e>
0174  </conjugation>
0175 
0176  <conjugation>        and in entry for definition of tenses of (irreg.) verbs
0177   <t n="sipa">
0178    <s1>go</s1>
0179    <s2>go</s2>
0180    <s3f>goes</s3f>
0181    <s3m>goes</s3m>
0182    <s3n>goes</s3n>
0183    <p1>go</p1>
0184    <p2>go</p2>
0185    <p3f>go</p3f>
0186    <p3m>go</p3m>
0187    <p3n>go</p3n>
0188   </t>
0189  </conjugation>
0190 */
0191 
0192 #define KV_CONJUG_GRP "conjugation" // conjugation descriptor group
0193 #define KV_CON_ENTRY "e" // conjugation entry (header)
0194 #define KV_CON_TYPE "t" // conjugation type  (voc entries)
0195 #define KV_CON_NAME "n" // conjugation type name (voc entries)
0196 #define KV_CON_P1S "s1" // 1. person singular
0197 #define KV_CON_P2S "s2" // 2. person singular
0198 #define KV_CON_P3SF "s3f" // 3. person singular female
0199 #define KV_CON_P3SM "s3m" // 3. person singular male
0200 #define KV_CON_P3SN "s3n" // 3. person singular natural
0201 #define KV_CON_P1P "p1" // 1. person plural
0202 #define KV_CON_P2P "p2" // 2. person plural
0203 #define KV_CON_P3PF "p3f" // 3. person plural female
0204 #define KV_CON_P3PM "p3m" // 3. person plural male
0205 #define KV_CON_P3PN "p3n" // 3. person plural natural
0206 #define KV_CONJ_COMMON "common" // female contains common for all three
0207 
0208 #endif // KVTMLDEFS_H