diff --git a/Doc/Makefile b/Doc/Makefile index eae53df..a041ada 100644 --- a/Doc/Makefile +++ b/Doc/Makefile @@ -3,23 +3,28 @@ intro_ := mufasa_intro psbook_ := mufasa_ps_handbook +book_ := mufasa_handbook - -default: intro +default: tex clean: rm -rvf $(intro_) rm -rvf $(psbook_) + rm -rvf $(book_) find -iname "$(intro_)*" | grep -v svn | grep -v tex | xargs rm -vf find -iname "$(psbook_)*" | grep -v svn | grep -v tex | xargs rm -vf + find -iname "$(book_)*" | grep -v svn | grep -v tex | xargs rm -vf $(MAKE) -C Pics/ clean -intro: +tex: $(MAKE) -C Pics/ texi2pdf $(intro_).tex #--silent texi2pdf $(psbook_).tex #--silent + texi2pdf $(book_).tex #--silent + html: $(MAKE) -C Pics/ latex2html $(intro_).tex -local_icons -nofootnode latex2html $(psbook_).tex -local_icons -nofootnode + latex2html $(book_).tex -local_icons -nofootnode diff --git a/Doc/mufasa_handbook.tex b/Doc/mufasa_handbook.tex new file mode 100644 index 0000000..bb293db --- /dev/null +++ b/Doc/mufasa_handbook.tex @@ -0,0 +1,63 @@ +\documentclass[a4paper]{report} +\usepackage{amsmath} +\usepackage{color} + +\begin{document} +\title{Mufasa Handbook} +\author{Merlijn Wajer \and Raymond van Veneti\"{e}} + +\maketitle +\tableofcontents + +\chapter{Foreword} + +This document is aimed at proving a more in depth description on the +functions in the Mufasa Macro Library, and it's extensions. +This can vary from developer notes to extensive explanations on certain +algorithms. \\ +Developer notes include: +\begin{itemize} + \item Implementation Decisions + \item Bugs +\end{itemize} + + +\chapter{Core} + +\section{TClient} + +The TClient class bundles all the other Core classes. +It's main use is to make using the Mufasa Macro Library trivial, by bundling +the for Mufasa classes into one class, and provides the methods to make them +cooperate. + +\section{TMWindow} + +\subsection{Main features} + +Retreiving information from the target Application/Window. + +% All useful functions documented here. +\subsection{ReturnData} + +\section{TMInput} + +\section{TMFiles} + +\section{TMBitmaps} + +\section{TMDTM} + +\section{TMOCR} + +\chapter{Add on} + +\section{Colour Picker} + +\section{Window Selector} + +\section{Pascal Script Integration} + +\section{Plugins} + +\end{document} diff --git a/Doc/mufasa_ps_handbook.tex b/Doc/mufasa_ps_handbook.tex index 09fec53..47f4ed1 100644 --- a/Doc/mufasa_ps_handbook.tex +++ b/Doc/mufasa_ps_handbook.tex @@ -3,7 +3,7 @@ \usepackage{color} \begin{document} -\title{Mufasa PS Handbook} +\title{Mufasa PascalScript Handbook} \author{Merlijn Wajer \and Raymond van Veneti\"{e}} \definecolor{typeGreen}{rgb}{0.0, 0.6, 0.0} @@ -14,7 +14,10 @@ \chapter{Foreword} -HOI DIT IS DE MUFASA FUNCTIE LIJST! +This document provides a simple but helpful explanation on every function that +the Mufasa macro library exports to it's Interpreter, PS\footnote{Pascal +Script}. For a real in depth explanation, the Mufasa Handbook would be a better +place to look. \chapter{Input}