3 Overview of the Combinat Files

This section is intended to describe all files that belong to the Combinat library project. Files that are not mentioned in this section and not tagged via the LATEX command ∖sourcefile will not appear in the documentation. For each file a short summary should be given

• of the file’s contents,
• why this file exists, and
• what relations it has to other files.

combinat.tex.nw:

First of all, the file combinat.tex.nw which you are currently reading is a Combinat file. It provides the overall documentation of Combinat and should not be confused with the generated file combinat.tex (without extension .nw) which is given through the following code chunk. This generated file serves as the root of the project documentation.

13⟨* 13⟩≡   20 ⊳
\documentclass{article}
\usepackage{allprose}
\begin{document}
\author{Ralf Hemmecke and Martin Rubey}
\title{\xProject{} \LIBRARYVERSION}
\maketitle
\begin{abstract}
  \xProject{} is an attempt to port \xMuPADCombinat{} to \xAldor{}.
\end{abstract}
\ifShowPROJECTROOT\begin{center}\SOURCEROOT\end{center}\fi
\hypertarget{sec:Contents}{}\tableofcontents
\input{\projectname.tex.nw}
\end{document}

Uses projectname 32.

combinat.sty.nw:

Since combinat.sty.nw will be included at the end of allprose.sty.nw, it provides additional styles to the styles defined in allprose.sty.nw.

combinat.bib.nw:

All references appear in that file.

Makefile.def.nw:

The project Combinat is built on the ALLPROSE framework. So there is an interface Makefile.def.nw between Combinat and ALLPROSE.

cs.as.nw:

That is the source code of the main executable which is tighly connected to src/cs.as.nw.

The Aldor source files reside under the directory src. The source code for the testsuite resides under test. The general include files are in directory include.