Repository navigation
Expand file tree
/
Copy pathCodingModulesIntro.tex
More file actions
28 lines (20 loc) · 1.71 KB
/
Copy pathCodingModulesIntro.tex
File metadata and controls
28 lines (20 loc) · 1.71 KB
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
\startcomponent[codingmodulesintro]
\starttext
For this tutorial, we'll work together and create a simple FAIMS module. For illustrative purposes, we're going to recreate a simple module available from the FAIMS demo server--the \quotation{Oral History} module.
We're going to start by showing you how to make a basic but fully functional version of the module that can be made only by constructing a relevant {\tt module.xml}. Then, after you've run that through the FAIMS-tools and produced a fully functioning but simple version, we'll teach you some ways to add complexity and functionality by modifying the necessary files directly.
\section{Introduction to {\tt Module.xml}}
Earlier sections introduced the basic necessary files of a module. You should already have some idea what these were:
\startitemize[n]
\item a Data Definition Schema ({\tt data_schema.xml}).
\item a User Interface Schema ({\tt ui_schema.xml})
\item a User Interface Logic file ({\tt ui_logic.bsh})
\item a Translation (Arch16n) file ({\tt faims.properties})
\item A server-side validation file ({\tt validation.xml})
\item CSS Files for styling the modules ({\tt ui_styling.css})
\stopitemize
You've already learned that you don't have to design and code all of these files from scratch. Instead, you'll create one file that serves as a set of instructions for the FAIMS Tools to create the necessary files for you. That one file is called {\tt module.xml}.
\quiz{Test your knowledge: a gentle descent into {\tt module.xml}}{
\item What are some programs you can use when modifying {\tt module.xml}? Which programs should you avoid? If you don't remember, review the previous section, \quotation{Setting Up Your Development Environment.}
}
\stoptext
\stopcomponent