tidied version

HowToCodeModules/CodingModulesCreationProcess.tex

@@ -5,7 +5,7 @@ \section{The Module Creation Process}
 
 Before getting into the nitty-gritty specifics of how to structure {\tt module.xml}, it's useful to review what the overall process of creating a module will look like. Below is an overview of the steps you'll follow.
 
-Back on your Ubuntu install in the virtual machine, open up a Terminal window using the Ubuntu Dash program. You can read how here: \useURL[url20][https://help.ubuntu.com/community/UsingTheTerminal][][{\em https://help.ubuntu.com/community/UsingTheTerminal}]\from[url20].
+Back on your Ubuntu install in the virtual machine, open up a Terminal window using the Ubuntu Dash program. You can read how here: \useURL[url20][https://help.ubuntu.com/community/UsingTheTerminal][][{\tt\tfx\hyphenatedurl{https://help.ubuntu.com/community/UsingTheTerminal}}]\from[url20].
 
 The Terminal is Ubuntu's command line tool that we'll use to navigate the file system and run commands and programs, so this is probably a good time to make sure you're acquainted with it before proceeding.
 

HowToCodeModules/ExploringSimpleModule.tex

@@ -37,6 +37,7 @@ \section{Exploring a Simple Module}
 ~~</User> 
 </User>
 
+
 }
  
  Setting \inlXML{t="button"}, as in the case of \inlXML{<Login>}, creates a button you can tap. The purpose of the button is described by the text that comes after it; otherwise, it's just a button, which probably isn't going to be very useful for your module. Here we've included the code \inlXML{l="Control"} within the tag, which causes FAIMS to link to the \quotation{Control} tab group when it is tapped. In fact, the \inlXML{l} attribute works not only for buttons, but many other GUI elements as well. Note carefully that the \quotation{Control} tab group linked to by the \inlXML{l} attribute's value is defined further down in the {\tt module.xml} file; this code only functions because the destination is valid. If we had \inlXML{1="Control"} and then didn't actually have a \quotation{Control} to link to, it's safe to say this wouldn't work. Also note that references are case-sensitive, so writing \inlXML{control} with a lower-case \quotation{c} would fail.
@@ -69,7 +70,7 @@ \section{Exploring a Simple Module}
 
 The \inlXML{<Main>} element creates the first tab. Inside that tab we have a GUI element, \inlXML{Record_Interview.} The \inlXML{t="button"}, which means this element is a button; \inlXML{1="Interview"}, so the button links to another tab somewhere else in the module called \quotation{Interview.} The other GUI element here is \quotation{GPS Diagnostics,} which has the element type \inlXML{gpsdiag.} This element type specifically means that in the final module, it will create text labels and display information about the Android device's GPS location. In the screenshot, we see the \inlXML{gpsdiag} element at work: it's telling us that our phone's GPS is \quotation{not initialized,} a charming way of sayingn \quotation{not turned on.} Until we do turn it on, this is the best \inlXML{gpsdiag} is going to do.
 
-Let's turn on our Android device's internal GPS antenna by tapping \useURL[url22][https://www.youtube.com/watch?v=o_eSwq1ewsU][][{\em the three vertical dots}]\from[url22] in the upper right of the screen to open the settings menu.
+Let's turn on our Android device's internal GPS antenna by tapping \useURL[url22][https://www.youtube.com/watch?v=o_eSwq1ewsU][][{the three vertical dots}]\from[url22] in the upper right of the screen to open the settings menu.
 
 \placefigure[force][on-GPS]{Turn on internal GPS by tapping the dots in the red box.}{
 \startcombination[2*1]

HowToCodeModules/UnderstandingXMLDocuments.tex

@@ -84,7 +84,7 @@
 There's no point in having an opening AND closing tag if there's nothing you're going to put between them. Hence the name, \quotation{empty element tags}; they denote elements which do not contain any other elements.
 
 \quiz{Test your knowledge}{
-  \item What's the connection between "tags" and "elements"?
+  \item What's the connection between \quotation{tags} and \quotation{elements}?
   \item If you've got two of the same opening tag and neither has been closed yet, which will the first closing tag you write belong to?
   \item Where do you put the slash (\inlXML{/}) to denote an empty element tag?
 }

MakingYourOwn/PartsOfModule.tex

@@ -24,7 +24,7 @@ \section{The Parts of a Module}
 
 \subsection{Data Schema}
 
-This file, which should appear on your computer as {\tt data_schema.xml}, defines what kinds of data you want to record and how they're related to each other. We go into a little more technical detail about what a Data Schema is and does in the section below, \quotation{Tour from the Data Schema}.
+This file, which should appear on your computer as {\tt data_schema.xml}, defines what kinds of data you want to record and how they're related to each other. We go into a little more technical detail about what a Data Schema is and does in the section below, \about[tour-from-the-data-schema].
 
 The Data Schema is one of the most fundamental and important necessary files of a FAIMS module. Unlike other necessary files, which can be replaced and updated even after the module's in use by your team, the Data Schema cannot be replaced. If for some reason your Data Schema no longer provides satisfactory results, you'll need to create a whole new module and instruct your team to transition over to it. This is the one part you should be absolutely certain you're happy with before you proceed.
 

SettingUpDev/DeployingVM.tex

@@ -19,7 +19,7 @@
 
 Every computer is different, and unless you're using exactly the machine we used when writing these instructions (an HP laptop with a Core i7 processor and 8GB of RAM, running Windows 7) you probably won't be able to follow each step exactly as it's written. Many of the differences will be very minor; an option might have a slightly different name or be located somewhere else on your computer, for example. When you find an option isn't present as we describe it, take a deep breath. Click around or use your computer's \quotation{search} feature to see if you can find the option or setting somewhere else. If necessary, web search the terms we use in our instructions along with the system you're using in order to find equivalents. A good rule of thumb for general computer configuration is: whatever you can't figure out right now, someone else has had the same problem and a third person has fixed it for them.
 
-As a last resort, we offer technical support services. See the appendix for further information.
+As a last resort, we offer technical support services. See \about[can't-solve-your-problem] for further information.
 
 \subsection[before-you-start]{Before You Start}
 
@@ -95,7 +95,7 @@
 
 Back on the main screen, click on the \quotation{Network} section.
 
-\placefigure[force][click-network]{Scroll on the right hand panel and click "Network".}{\externalfigure[image30.png][width=.5\textwidth]}
+\placefigure[force][click-network]{Scroll on the right hand panel and click \quotation{Network}.}{\externalfigure[image30.png][width=.5\textwidth]}
 
 In the popup window that appears, check the \quotation{Enable Network Adapter} box on the \quotation{Adapter 1} tab, and select \quotation{Bridged Adapter} from the \quotation{Attached to:} menu.
 

SettingUpDev/InstallingTools.tex

@@ -22,7 +22,7 @@
 
 For each of these, download their installers and follow their installation wizards. If you're using a Linux device that isn't the virtual machine, you can install gEdit, Vim, Emacs, or another text editor using apt-get.
 
-\section{Access to local files via VirtualBox}
+% \section{Access to local files via VirtualBox}
 
 %TODO This section seems important. And blank. Ruts, ideas?
 

WhatIsFaims/WelcomeToFaims.tex

@@ -81,17 +81,16 @@ \subsection{Some framing questions for FAIMS Mobile}
 
 \section[sharedata]{Exporters: how to share data with others.}
 
-To get the data in a viewable, usable fashion, you'll need to find and download a type of program called an exporter. What form you want the data to be in decides which exporter you'll want to use. You can find exporters for formats like shapefile and json by visiting {\tt github.com/FAIMS/} and searching for the correct program. Look for something called \quotation{(x)Exporter} or \quotation{(x)Export,} where (x) is the desired end format (e.g. \quotation{jsonExporter} or \quotation{shapefileExport}).
+To get the data in a viewable, usable fashion, you'll need to find and download a type of program called an exporter. What form you want the data to be in decides which exporter you'll want to use. You can find exporters for formats like shapefile and json by visiting {\tt github.com/FAIMS} and searching for the correct program. Look for something called \quotation{(x)Exporter} or \quotation{(x)Export,} where (x) is the desired end format (e.g. \quotation{jsonExporter} or \quotation{shapefileExport}).
 
-On a PC, you can simply download the file from github. If you're using your UNIX virtual machine, you can do so by entering at the command prompt in \in{Codeblock}[copy-remote-code] (denoted by \$. Don't copy the \$).
+On a PC, you can simply download the file from github. If you're using your UNIX virtual machine, you can do so by entering at the command prompt in \in{Codeblock}[copy-remote-code] (denoted by \$. Don't copy the \$) with the name of whatever exporter you want, in this example shapefileExport, in the final position.
 
 \promptref{copy-remote-code}{A command to use the program \quotation{git} to make a copy of the remote code onto your computer}{\bashprompt{git clone https://github.com/FAIMS/shapefileExport/}}
 
-...with the name of whatever exporter you want, in this example shapefileExport, in the final position.
 
 Once you've got the exporter program, you're going to put it in a usable form. To do that with a PC, create a tarball from the exporter using a program like 7zip; if you're using UNIX, enter something like \in{Codeblock}[compress].
 
-\promptref{compress}{A command to: tell the {\tt tar} command to compress, gzip, and save the folder \quotation{shapefileExport} to the file {\tt shapefileExport.tar.gz}}{tar -czf shapefileExport.tar.gz shapefileExport/}
+\promptref{compress}{A command to: tell the {\tt tar} command to compress, gzip, and save the folder \quotation{shapefileExport} to the file {\tt shapefileExport.tar.gz}}{\tt\tfx tar -czf shapefileExport.tar.gz shapefileExport/}
 
 Now, if you navigate on the server to your module, you'll see a tab at the top labeled \quotation{Plugin Management.} Click that and you'll be brought to a page with the handy feature, \quotation{Upload Exporter.} Choose the tarball you've just created and hit \quotation{upload.} You now have an exporter permanently stored to your FAIMS server and may make use of it whenever you'd like.