summaryrefslogtreecommitdiff
path: root/design/xmlformat.tex
blob: 9daaf89cfe6bdcb287bacf97aeb585cbd66a8c81 (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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
\section{XML Formatet}
Al kommunikation mellem serveren og klienten (og vice versa)
foreg�r ved hj�lp af XML.\\
Dokumenterne skal starte med en header som specificerer hvilken
XML verison som benyttes, efterfulgt af rodknuden som skal v�re af
typen \texttt{pracro}.\\
\begin{verbatim}
<?xml version="1.0" encoding="UTF-8"?>
<pracro version="1.0" cpr="1505050505">
    .
    .
    .
</pracro>
\end{verbatim}
Det er vigtigt at pointere at alt data i xml dokumentet skal v�re i
UTF-8 formatering.

\subsection{\texttt{pracro} elementet}
Pracro elementet bruges som indpakning til hele dokumentet. Den
identificerer blandt andet dokumentversionen og kan indeholde alle
typer data forbundet med Pracro systemet.\\
Pracro elementet har flg. attributter:
\begin{itemize}
\item \textit{cpr} - CPR nummeret p� den patient som dataene i filen
  er knyttet til. Det bruges blandt andet ved genfinding af data og 
  den afsluttende lagring af data.\\
  Dette felt m� ikke undlades.
\item \textit{version} - Dette felt fort�ller hvilken dokument
  version der er benyttet.\\
  Denne variabel skal matche den version klienten forventer.\\
  Dette felt m� ikke udelades.
\end{itemize}

\subsection{Request}
En request sektion sendt til serveren skal bevirke at serveren inl�ser og
sender den angivne makro til klienten.\\
Hvis klienten modtager en request sektion skal den blot ignorere den.
\begin{verbatim}
<?xml version="1.0" encoding="UTF-8"?>
<pracro version="1.0" cpr="1505050505">
  <request macro="visus"/>
</pracro>
\end{verbatim}

\subsection{Makro}
En makro definerer en makro som grafisk viser og eller indsamler data.\\
En makro sektion sendt til klienten skal bevirke at den beskrevne
grafisk makro vises p� sk�rmen.\\
Hvis serveren modtager en makro sektion skal den blot ignorere den.
Vi starter med et eksempel:
\begin{verbatim}
<?xml version="1.0" encoding="UTF-8"?>
<pracro version="1.0" cpr="1505050505">
  <macro name="macro" version="1.0">
    <window name="mainwindow"
            caption="This is the mainwindow"
            width="800"
            height="600"
            layout="vbox">
      <include name="patient"/>
      <frame name="data_frame" layout="hbox">
        <label caption="Some field"/>
        <lineedit name="lineedit1" regexp="[0-9]+"/>
      </frame>
      <frame name="bottom_frame" layout="hbox">
        <spacer />
        <button caption="Close window" action="abort"/>
        <button caption="Commit changes" action="commit"/>
      </frame>
    </window>
  </macro>
</pracro>
\end{verbatim}
Eksemplet illustrerer flg. funktionaliteter: Makroen og den
properties, main vinduet, includes, frames, labels, lineedits og
knapper.\\
\\
Includes foreg�r serverside, dvs. klienten modtager det sammensatte
dokument og vil dermed aldrig se \verb|<include ...>| tagget.\\
\\
Der skelnes mellem input felter og ikke-input felter. Et input felt er
et felt som ved endt indtastning vil bidrage med input til serveren,
f.eks. LineEdit, Combo eller CheckBox. Ikke-input felter er
felter som udelukkende bidrager til layout og brugerens forst�else af
inputfelterne, f.eks. Frame, Image eler Label.

\subsubsection{\texttt{macro} elementet}
Makro elementet bruges som indpakning til hele makroen. Den
identificerer makroen og angiver en r�kke v�rdier som skal bruges til
ops�tning p� klienten.\\
Makroen har flg. attributter:
\begin{itemize}
\item \textit{name} - Navnet p� makroen. Navnet skal matche det navn
  som klienten har bedt om.\\
  Navnet m� udelukkende indeholdene de almindelige bogstaver, samt
  underscore, dvs. \verb|[a-z0-9_]+|, hvis det skrives ud som regul�rt
  udtryk.\\
  Dette felt m� ikke undlades.
\item \textit{version} - Dette felt fort�ller hvilken version 
  den konkrete makro har.\\
  Dette felt m� ikke udelades.
\end{itemize}

%%
%% This element has been removed
%%
%\subsubsection{\texttt{include} elementet}
%Include elementet kan kun frekomme serverside, hvor det vil blive
%udvidet med den angivne makro.\\
%Serveren inds�tter alle elementer fra (og ikke med) makroens rodvindue
%og indad p� det sted hvor include elementet befinder sig.\\
%Include har flg. attributter: 
%\begin{itemize}
%\item \textit{name} - Navnet p� den makro som skal inkluderes.
%\item \textit{disabled} - Angiver om den indsatte makro skal
%  disables. Kan have v�rdierne ``true'' eller ``false''. Hvis udeladt
%  benyttes v�rdien ``false''.
%\end{itemize}

\subsubsection{Generelle GUI attributter}
Alle GUI elementerne i xml dokumentet har flg. attributter:
\begin{itemize}
\item \textit{name} - Navnet p� elementet. Bruges ved data
  nedl�sning.\\
  Navnet m� udelukkende indeholdene de almindelige bogstaver, samt
  underscore, dvs. \verb|[a-z0-9_]+|, hvis det skrives ud som regul�rt
  udtryk.\\
  Navnet skal v�re unikt p� det niveau hvor elementet befinder sig.\\
  Navnet m� ikke undlades.
\item \textit{width} - Et positivt heltal som s�tter bredden af
  elementet. Hvis den er udeladt benyttes elementets default bredde.
\item \textit{height} - Et positivt heltal som s�tter h�jden p�
  elementet. Hvis den er udeladt benyttes elementets default h�jde.
\item \textit{help} - Elementets hj�lpetekst. En beskrivende tekst som
  vises p� sk�rmen n�r elementet er aktivt. Hvis udeladt vises
  ingenting.
\item \textit{disabled} - Denne attribut kan v�re enten ``true'' eller
  ``false''. Hvis den er ``true'' vil elementet blive tegnet disabled
  samt alle dets children rekursivt. Hvis undladt benyttes v�rdien ``false''.
\end{itemize}

\input{widgets/window}
\input{widgets/frame}
\input{widgets/spacer}
\input{widgets/label}
\input{widgets/lineedit}
\input{widgets/textedit}
\input{widgets/button}
\input{widgets/checkbox}
\input{widgets/togglebutton}
\input{widgets/radiobuttons}
\input{widgets/combobox}
\input{widgets/listbox}
\input{widgets/multilist}

\subsection{Commit}
En commit sektion sendt til serveren skal  bevirke at serveren lagrer de
sendte data i databasen, samt genererer et resum� som kan blive sendt
tilbage til klienten.\\
Hvis klienten modtager en commit sektion skal den blot ignorere den.
\begin{verbatim}
<?xml version="1.0" encoding="UTF-8"?>
<pracro version="1.0" cpr="1505050505">
  <commit user="johndoe" macro="visus" version="1.0">
    <field name="visus_objektiv" value="42"/>
    <field name="visus_subjektiv" value="42"/>
  </commit>
</pracro>
\end{verbatim}

\subsubsection{\texttt{commit} elementet}
Commit elementet har flg. attributter:
\begin{itemize}
\item \textit{user} - Brugernavnet p� den bruger som har udfyldt makroen.
\item \textit{macro} - Navnet p� den makro som dataene er indtastet i.
\item \textit{version} - Versionsnummeret p� den makro som er blevet udfyldt.
\end{itemize}

\subsubsection{\texttt{field} elementet}
Field elementet har flg. attributter:
\begin{itemize}
\item \textit{name} - Navnet p� feltet.
\item \textit{value} - V�rdien af feltet.
\end{itemize}

%\subsection{Resum�}
%En resum� sektion sendt til klienten skal bevirke at klienten appender den
%sendte tekst til PC-Praxis journalfilen.\\
%Hvis serveren modtager en resum� sektion skal den blot ignorere den.
%\begin{verbatim}
%<?xml version="1.0" encoding="UTF-8"?>
%<pracro version="1.0" cpr="1505050505">
%  <resume macro="visus" version="1.0">Det objektive synsm�l var
%42 dioptri, og det subjektive synsm�l var 42 dioptri.</resume>
%</pracro>
%\end{verbatim}