diff options
Diffstat (limited to 'design/xmlformat.tex')
-rw-r--r-- | design/xmlformat.tex | 97 |
1 files changed, 49 insertions, 48 deletions
diff --git a/design/xmlformat.tex b/design/xmlformat.tex index 9daaf89..00e4ec9 100644 --- a/design/xmlformat.tex +++ b/design/xmlformat.tex @@ -1,8 +1,9 @@ +% -*- coding: utf-8 -*- \section{XML Formatet} Al kommunikation mellem serveren og klienten (og vice versa) -foregår ved hjælp af XML.\\ +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 +XML verison som benyttes, efterfulgt af rodknuden som skal være af typen \texttt{pracro}.\\ \begin{verbatim} <?xml version="1.0" encoding="UTF-8"?> @@ -12,7 +13,7 @@ typen \texttt{pracro}.\\ . </pracro> \end{verbatim} -Det er vigtigt at pointere at alt data i xml dokumentet skal være i +Det er vigtigt at pointere at alt data i xml dokumentet skal være i UTF-8 formatering. \subsection{\texttt{pracro} elementet} @@ -21,18 +22,18 @@ 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 +\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 + 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. + Dette felt mÃ¥ ikke udelades. \end{itemize} \subsection{Request} -En request sektion sendt til serveren skal bevirke at serveren inlæser og +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} @@ -45,7 +46,7 @@ Hvis klienten modtager en request sektion skal den blot ignorere den. \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.\\ +grafisk makro vises pÃ¥ skærmen.\\ Hvis serveren modtager en makro sektion skal den blot ignorere den. Vi starter med et eksempel: \begin{verbatim} @@ -75,30 +76,30 @@ 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 +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 +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.\\ +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 +\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 + 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 + Dette felt mÃ¥ ikke undlades. +\item \textit{version} - Dette felt fortæller hvilken version den konkrete makro har.\\ - Dette felt må ikke udelades. + Dette felt mÃ¥ ikke udelades. \end{itemize} %% @@ -107,36 +108,36 @@ Makroen har flg. attributter: %\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.\\ +%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{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''. +% 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 +\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 + 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 +\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 +\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''. + samt alle dets children rekursivt. Hvis undladt benyttes værdien ``false''. \end{itemize} \input{widgets/window} @@ -155,7 +156,7 @@ Alle GUI elementerne i xml dokumentet har flg. attributter: \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 +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} @@ -171,26 +172,26 @@ Hvis klienten modtager en commit sektion skal den blot ignorere den. \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. +\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. +\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 +%\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. +%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> +% <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} |