Started writing a manual for PCLc and run-time.

12 files changed, 139 insertions, 0 deletions

diff --git a/documentation/chapters/background/background.tex b/documentation/chapters/background/background.tex
new file mode 100644
index 0000000..ef91110
--- /dev/null
+++ b/documentation/chapters/background/background.tex
@@ -0,0 +1 @@
+\chapter{Background}
diff --git a/documentation/chapters/compiler/compiler.tex b/documentation/chapters/compiler/compiler.tex
new file mode 100644
index 0000000..ed399d8
--- /dev/null
+++ b/documentation/chapters/compiler/compiler.tex
@@ -0,0 +1,37 @@
+\chapter{PCLc}
+
+\section{Syntax}
+\begin{figure}[!h]
+  \centering
+    \includegraphics[width=1.0\textwidth]{chapters/compiler/diagrams/pcl-top-level}
+  \caption{PCL file syntax.}
+  \label{fig:pcl-top-level}
+\end{figure}
+
+\subsection{Imports}
+\begin{figure}[!h]
+  \centering
+    \includegraphics[width=1.0\textwidth]{chapters/compiler/diagrams/pcl-imports}
+  \caption{Importing PCL files.}
+  \label{fig:pcl-imports}
+\end{figure}
+
+\subsection{Port Definitions}
+\begin{figure}[!h]
+  \centering
+    \includegraphics[width=1.0\textwidth]{chapters/compiler/diagrams/pcl-port-defs}
+  \caption{Component Port Definition.}
+  \label{fig:pcl-port-defs}
+\end{figure}
+
+\subsection{Configuration}
+\begin{figure}[!h]
+  \centering
+    \includegraphics[width=1.0\textwidth]{chapters/compiler/diagrams/pcl-config}
+  \caption{Component Configuraton.}
+  \label{fig:pcl-config}
+\end{figure}
+
+\subsection{Declarations}
+
+\subsection{Definition}
diff --git a/documentation/chapters/compiler/diagrams/pcl-imports.dia b/documentation/chapters/compiler/diagrams/pcl-imports.dia
new file mode 100644
index 0000000..4449974
--- /dev/null
+++ b/documentation/chapters/compiler/diagrams/pcl-imports.dia
diff --git a/documentation/chapters/compiler/diagrams/pcl-imports.png b/documentation/chapters/compiler/diagrams/pcl-imports.png
new file mode 100644
index 0000000..8516645
--- /dev/null
+++ b/documentation/chapters/compiler/diagrams/pcl-imports.png
diff --git a/documentation/chapters/compiler/diagrams/pcl-port-defs.dia b/documentation/chapters/compiler/diagrams/pcl-port-defs.dia
new file mode 100644
index 0000000..76951e0
--- /dev/null
+++ b/documentation/chapters/compiler/diagrams/pcl-port-defs.dia
diff --git a/documentation/chapters/compiler/diagrams/pcl-port-defs.png b/documentation/chapters/compiler/diagrams/pcl-port-defs.png
new file mode 100644
index 0000000..7dcc567
--- /dev/null
+++ b/documentation/chapters/compiler/diagrams/pcl-port-defs.png
diff --git a/documentation/chapters/compiler/diagrams/pcl-top-level.dia b/documentation/chapters/compiler/diagrams/pcl-top-level.dia
new file mode 100644
index 0000000..6cea47a
--- /dev/null
+++ b/documentation/chapters/compiler/diagrams/pcl-top-level.dia
diff --git a/documentation/chapters/compiler/diagrams/pcl-top-level.png b/documentation/chapters/compiler/diagrams/pcl-top-level.png
new file mode 100644
index 0000000..00ddf7a
--- /dev/null
+++ b/documentation/chapters/compiler/diagrams/pcl-top-level.png
diff --git a/documentation/chapters/introduction/introduction.tex b/documentation/chapters/introduction/introduction.tex
new file mode 100644
index 0000000..f4ec3a1
--- /dev/null
+++ b/documentation/chapters/introduction/introduction.tex
@@ -0,0 +1 @@
+\chapter{Introduction}
diff --git a/documentation/chapters/run-time/run-time.tex b/documentation/chapters/run-time/run-time.tex
new file mode 100644
index 0000000..517eb79
--- /dev/null
+++ b/documentation/chapters/run-time/run-time.tex
@@ -0,0 +1 @@
+\chapter{PCL Runtime}
diff --git a/documentation/pcl-manual.bib b/documentation/pcl-manual.bib
new file mode 100644
index 0000000..dbb9c77
--- /dev/null
+++ b/documentation/pcl-manual.bib
@@ -0,0 +1,9 @@
+@article{arrows2000hughes,
+  title = "{G}eneralising {M}onads to {A}rrows",
+  author = "John Hughes",
+  year = "2000",
+  journal = "{S}cience of {C}omputer {P}rogramming",
+  volume = "37",
+  month = "May",
+  pages = "67--111"
+}
diff --git a/documentation/pcl-manual.tex b/documentation/pcl-manual.tex
new file mode 100644
index 0000000..d84285f
--- /dev/null
+++ b/documentation/pcl-manual.tex
@@ -0,0 +1,90 @@
+%%%
+%%% PCL Manual
+%%% By Ian Johnson
+%%%
+
+\documentclass[11pt,a4paper,openright]{report}
+\includeonly{%
+  chapters/introduction/introduction,
+  chapters/background/background,
+  chapters/compiler/compiler,
+  chapters/run-time/run-time
+}
+
+
+
+%%% Some commonly used packages (make sure your LaTeX installation
+%%% contains these packages, if not ask your senior to help installing
+%%% the packages)
+
+\usepackage[bookmarks,%
+            a4paper,%
+            breaklinks,%
+            backref=false,%
+            dvips,ps2pdf,%
+            pdfhighlight=/I,%
+            pdffitwindow=true,%
+            pdfstartview=Fit,%
+            pdfcenterwindow=true,%
+            linkbordercolor={1 0 1},%
+            %colorlinks,%
+            pdftitle=PCL Manual,%
+            pdfauthor=Ian Johnson]%
+            {hyperref}
+
+
+\usepackage{cite}
+
+\usepackage{listings}
+
+\usepackage{amsmath}
+
+\usepackage{natbib}
+\usepackage{booktabs}
+\usepackage{graphicx}
+\graphicspath{{expt/}}
+
+\usepackage{setspace}
+
+\usepackage{times}
+\usepackage[varg]{txfonts}
+
+
+%%% Macro definitions for Commonly used symbols
+\newcommand{\ReleaseVersion}{1.0.0}
+
+\begin{document}
+\title{\huge{Pipeline Creation Language (PCL)}\\
+\LARGE{Users' Manual}\\
+\normalsize{Version: \ReleaseVersion}}
+\author{Ian Johnson}
+\date{\today}
+
+\maketitle
+
+\tolerance=5000
+\onehalfspacing
+
+\begin{abstract}
+PCL was developed as part of the MosesCore project sponsored by the European Commission's Seveth Framework Programme (Grant Number 288487) \url{http://www.statmt.org/mosescore/}. For more information on the Seventh Framework Programme please see \url{http://cordis.europa.eu/fp7/home_en.html}.
+\end{abstract}
+
+\pagenumbering{roman}
+
+\tableofcontents
+\listoffigures
+\listoftables
+
+\cleardoublepage
+\setcounter{page}{1}
+\pagenumbering{arabic}
+
+\include{chapters/introduction/introduction}
+\include{chapters/background/background}
+\include{chapters/compiler/compiler}
+\include{chapters/run-time/run-time}
+
+\bibliographystyle{plain}{}
+\bibliography{pcl-manual}
+
+\end{document}