From e4b12b96233038a21b3caa434a0bbbc237801dfb Mon Sep 17 00:00:00 2001 From: Dominic Bosch Date: Tue, 18 Feb 2014 10:03:49 +0100 Subject: [PATCH] documentation preparation --- documentation/.gitignore | 4 + documentation/techdoc/compileTEX | 8 ++ documentation/techdoc/techdoc.bib | 112 ++++++++++++++++++++++ documentation/techdoc/techdoc.tex | 60 ++++++++++++ documentation/user-manual/compileTEX | 8 ++ documentation/user-manual/user-manual.bib | 112 ++++++++++++++++++++++ documentation/user-manual/user-manual.tex | 60 ++++++++++++ 7 files changed, 364 insertions(+) create mode 100644 documentation/.gitignore create mode 100755 documentation/techdoc/compileTEX create mode 100644 documentation/techdoc/techdoc.bib create mode 100644 documentation/techdoc/techdoc.tex create mode 100755 documentation/user-manual/compileTEX create mode 100644 documentation/user-manual/user-manual.bib create mode 100644 documentation/user-manual/user-manual.tex diff --git a/documentation/.gitignore b/documentation/.gitignore new file mode 100644 index 0000000..7aedbdd --- /dev/null +++ b/documentation/.gitignore @@ -0,0 +1,4 @@ +*/* +!compileTEX +!*.tex +!*.bib \ No newline at end of file diff --git a/documentation/techdoc/compileTEX b/documentation/techdoc/compileTEX new file mode 100755 index 0000000..f19c550 --- /dev/null +++ b/documentation/techdoc/compileTEX @@ -0,0 +1,8 @@ +#!/bin/bash +DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" +cd $DIR +latex techdoc +bibtex techdoc +latex techdoc +latex techdoc +pdflatex techdoc diff --git a/documentation/techdoc/techdoc.bib b/documentation/techdoc/techdoc.bib new file mode 100644 index 0000000..c48eea9 --- /dev/null +++ b/documentation/techdoc/techdoc.bib @@ -0,0 +1,112 @@ + +@INPROCEEDINGS{Papamarkos03event-condition-actionrule, + author = {George Papamarkos and Alexandra Poulovassilis and Ra Poulovassilis and Peter T. Wood}, + title = {Event-Condition-Action Rule Languages for the Semantic Web}, + booktitle = {In: Workshop on Semantic Web and Databases}, + year = {2003}, + pages = {309--327} +} + +@ARTICLE{ + 2005-Bry_etal-XChange.pdf, + author = {Francois Bry and Paula-lavinia Patranjan}, + title = {Reactivity on the Web: Paradigms and Applications of the Language XChange}, + journal = {J. of Web Engineering}, + year = {2005}, + volume = {5}, + pages = {2006} +} + +@Inproceedings{anicic2010arlfcepar, + booktitle = {Web Reasoning and Rule Systems - Fourth International Conference}, + editor = {Pascal Hitzler, Thomas Lukasiewicz}, + month = {September}, + pages = {42-57}, + publisher = {Springer}, + series = {LNCS}, + title = {A Rule-Based Language for Complex Event Processing and Reasoning}, + volume = {6333}, + year = {2010}, + type = {Inproceedings}, + author = {Darko Anicic and Paul Fodor and Sebastian Rudolph and Roland St{\"u}hmer and Nenad Stojanovic and Rudi Studer}, + evastar_pdf = {AFRSSS-RR2010-ETALIS.pdf} +} + +@paper{ + 2012-Giurca_etal-RuleTheWeb.pdf, + year="2012", + title="RuleTheWeb!: Rule-based Adaptive User Experience", + author="Giurca, A. and Tylkowski, M. and Mueller, M." +} + +@article{ + 2008-Giurca_Pascalau-JSON_Rules.pdf, + title={Json rules}, + author={Giurca, Adrian and Pascalau, Emilian}, + journal={Proceedings of the Proceedings of 4th Knowledge Engineering and Software Engineering, KESE}, + volume={425}, + pages={7--18}, + year={2008} +} + +@incollection{ + 2006-Boley-RuleML.pdf, + title={The RuleML family of web rule languages}, + author={Boley, Harold}, + booktitle={Principles and Practice of Semantic Web Reasoning}, + pages={1--17}, + year={2006}, + publisher={Springer} +} + +@incollection{ + 2012-Paschke_etal-ReactionRuleML.pdf, + year={2012}, + isbn={978-3-642-32688-2}, + booktitle={Rules on the Web: Research and Applications}, + volume={7438}, + series={Lecture Notes in Computer Science}, + editor={Bikakis, Antonis and Giurca, Adrian}, + doi={10.1007/978-3-642-32689-9_9}, + title={Reaction RuleML 1.0: Standardized Semantic Reaction Rules}, + url={http://dx.doi.org/10.1007/978-3-642-32689-9_9}, + publisher={Springer Berlin Heidelberg}, + author={Paschke, Adrian and Boley, Harold and Zhao, Zhili and Teymourian, Kia and Athan, Tara}, + pages={100-119} +} + +@incollection{ + 2009-Paschke_Boley-RCER.pdf, + year={2009}, + month={May}, + booktitle={Handbook of Research on Emerging Rule-Based Languages and Technologies: Open Solutions and Approaches}, + editor={Giurca, Adrian and Gasevic, Dragan and Taveter, Kuldar}, + title={Rules Capturing Events and Reactivity}, + publisher={IGI Publishing}, + author={Paschke, Adrian and Boley, Harold}, + pages={215-252} +} +@phdthesis{ + 2005-Patranjan-TLE.pdf, + author = "Patranjan, Paula-lavinia", + title = "The Language XChange", + school = "Ludwig-Maximilians-Universit{\"a}t M{\"u}nchen", + year = "2005" +} + +@book{ + bookTheLiveWeb, + author = "Windley, P.", + title = "The Live Web: Building Event-Based Connections in the Cloud", + publisher = "Cengage Learning PTR", + year = "2011" +} + +@webpage{ + wwwn3, + title="Notation 3 Logic", + howpublished = {\url{http://www.w3.org/DesignIssues/Notation3.html}}, + note = {Accessed: 2013-10-21}, + year = "2005", + author="Berners-Lee, Tim" +} diff --git a/documentation/techdoc/techdoc.tex b/documentation/techdoc/techdoc.tex new file mode 100644 index 0000000..012e83e --- /dev/null +++ b/documentation/techdoc/techdoc.tex @@ -0,0 +1,60 @@ +\documentclass{article} + +\newcommand*{\createTitlePage}{\begingroup +\centering +\vspace*{6\baselineskip} + +{\Huge WebAPI ECA-Engine}\\[4\baselineskip] + +{\LARGE Technical Documentation} \\[\baselineskip] + +\vspace*{25\baselineskip} + +{Dominic Bosch\par} +{\itshape University of Basel\par} + + + + +\endgroup} + + +\begin{document} + +\clearpage\createTitlePage +\thispagestyle{empty} +% \title{\huge WebAPI-ECA Engine\vspace*{15 mm}} +% \subtitle{Master Thesis Report} +% %\date{} +% %\author{Dominic Bosch \\ Departement Mathematics and Computer Science \\ University of Basel} +% \author{ +% Technical Documentation\\ +% \date{\today} +% \vspace*{50 mm}\\ +% \fontsize{10}{9}\selectfont +% Dominic Bosch\\ +% \fontsize{10}{9}\selectfont +% Departement Mathematics and Computer Science\\ +% \fontsize{10}{9}\selectfont +% University of Basel +% } +% \maketitle + +% \renewcommand{\abstractname}{} +% \begin{abstract} +% %\textbf{Abstract.} +% This docuemnt describes the technical features of the WebAPI-ECA engine reference implementation. +% \end{abstract} + + +\newpage +\tableofcontents +\newpage + + +\section{Introduction} +\subsection{section} +\subsubsection{subsection} +t.b.d. + +\end{document} \ No newline at end of file diff --git a/documentation/user-manual/compileTEX b/documentation/user-manual/compileTEX new file mode 100755 index 0000000..5c411be --- /dev/null +++ b/documentation/user-manual/compileTEX @@ -0,0 +1,8 @@ +#!/bin/bash +DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" +cd $DIR +latex user-manual +bibtex user-manual +latex user-manual +latex user-manual +pdflatex user-manual diff --git a/documentation/user-manual/user-manual.bib b/documentation/user-manual/user-manual.bib new file mode 100644 index 0000000..c48eea9 --- /dev/null +++ b/documentation/user-manual/user-manual.bib @@ -0,0 +1,112 @@ + +@INPROCEEDINGS{Papamarkos03event-condition-actionrule, + author = {George Papamarkos and Alexandra Poulovassilis and Ra Poulovassilis and Peter T. Wood}, + title = {Event-Condition-Action Rule Languages for the Semantic Web}, + booktitle = {In: Workshop on Semantic Web and Databases}, + year = {2003}, + pages = {309--327} +} + +@ARTICLE{ + 2005-Bry_etal-XChange.pdf, + author = {Francois Bry and Paula-lavinia Patranjan}, + title = {Reactivity on the Web: Paradigms and Applications of the Language XChange}, + journal = {J. of Web Engineering}, + year = {2005}, + volume = {5}, + pages = {2006} +} + +@Inproceedings{anicic2010arlfcepar, + booktitle = {Web Reasoning and Rule Systems - Fourth International Conference}, + editor = {Pascal Hitzler, Thomas Lukasiewicz}, + month = {September}, + pages = {42-57}, + publisher = {Springer}, + series = {LNCS}, + title = {A Rule-Based Language for Complex Event Processing and Reasoning}, + volume = {6333}, + year = {2010}, + type = {Inproceedings}, + author = {Darko Anicic and Paul Fodor and Sebastian Rudolph and Roland St{\"u}hmer and Nenad Stojanovic and Rudi Studer}, + evastar_pdf = {AFRSSS-RR2010-ETALIS.pdf} +} + +@paper{ + 2012-Giurca_etal-RuleTheWeb.pdf, + year="2012", + title="RuleTheWeb!: Rule-based Adaptive User Experience", + author="Giurca, A. and Tylkowski, M. and Mueller, M." +} + +@article{ + 2008-Giurca_Pascalau-JSON_Rules.pdf, + title={Json rules}, + author={Giurca, Adrian and Pascalau, Emilian}, + journal={Proceedings of the Proceedings of 4th Knowledge Engineering and Software Engineering, KESE}, + volume={425}, + pages={7--18}, + year={2008} +} + +@incollection{ + 2006-Boley-RuleML.pdf, + title={The RuleML family of web rule languages}, + author={Boley, Harold}, + booktitle={Principles and Practice of Semantic Web Reasoning}, + pages={1--17}, + year={2006}, + publisher={Springer} +} + +@incollection{ + 2012-Paschke_etal-ReactionRuleML.pdf, + year={2012}, + isbn={978-3-642-32688-2}, + booktitle={Rules on the Web: Research and Applications}, + volume={7438}, + series={Lecture Notes in Computer Science}, + editor={Bikakis, Antonis and Giurca, Adrian}, + doi={10.1007/978-3-642-32689-9_9}, + title={Reaction RuleML 1.0: Standardized Semantic Reaction Rules}, + url={http://dx.doi.org/10.1007/978-3-642-32689-9_9}, + publisher={Springer Berlin Heidelberg}, + author={Paschke, Adrian and Boley, Harold and Zhao, Zhili and Teymourian, Kia and Athan, Tara}, + pages={100-119} +} + +@incollection{ + 2009-Paschke_Boley-RCER.pdf, + year={2009}, + month={May}, + booktitle={Handbook of Research on Emerging Rule-Based Languages and Technologies: Open Solutions and Approaches}, + editor={Giurca, Adrian and Gasevic, Dragan and Taveter, Kuldar}, + title={Rules Capturing Events and Reactivity}, + publisher={IGI Publishing}, + author={Paschke, Adrian and Boley, Harold}, + pages={215-252} +} +@phdthesis{ + 2005-Patranjan-TLE.pdf, + author = "Patranjan, Paula-lavinia", + title = "The Language XChange", + school = "Ludwig-Maximilians-Universit{\"a}t M{\"u}nchen", + year = "2005" +} + +@book{ + bookTheLiveWeb, + author = "Windley, P.", + title = "The Live Web: Building Event-Based Connections in the Cloud", + publisher = "Cengage Learning PTR", + year = "2011" +} + +@webpage{ + wwwn3, + title="Notation 3 Logic", + howpublished = {\url{http://www.w3.org/DesignIssues/Notation3.html}}, + note = {Accessed: 2013-10-21}, + year = "2005", + author="Berners-Lee, Tim" +} diff --git a/documentation/user-manual/user-manual.tex b/documentation/user-manual/user-manual.tex new file mode 100644 index 0000000..715191b --- /dev/null +++ b/documentation/user-manual/user-manual.tex @@ -0,0 +1,60 @@ +\documentclass{article} + +\newcommand*{\createTitlePage}{\begingroup +\centering +\vspace*{6\baselineskip} + +{\Huge WebAPI ECA-Engine}\\[4\baselineskip] + +{\LARGE User Manual} \\[\baselineskip] + +\vspace*{25\baselineskip} + +{Dominic Bosch\par} +{\itshape University of Basel\par} + + + + +\endgroup} + + +\begin{document} + +\clearpage\createTitlePage +\thispagestyle{empty} +% \title{\huge WebAPI-ECA Engine\vspace*{15 mm}} +% \subtitle{Master Thesis Report} +% %\date{} +% %\author{Dominic Bosch \\ Departement Mathematics and Computer Science \\ University of Basel} +% \author{ +% Technical Documentation\\ +% \date{\today} +% \vspace*{50 mm}\\ +% \fontsize{10}{9}\selectfont +% Dominic Bosch\\ +% \fontsize{10}{9}\selectfont +% Departement Mathematics and Computer Science\\ +% \fontsize{10}{9}\selectfont +% University of Basel +% } +% \maketitle + +% \renewcommand{\abstractname}{} +% \begin{abstract} +% %\textbf{Abstract.} +% This docuemnt describes the technical features of the WebAPI-ECA engine reference implementation. +% \end{abstract} + + +\newpage +\tableofcontents +\newpage + + +\section{Introduction} +\subsection{section} +\subsubsection{subsection} +t.b.d. + +\end{document} \ No newline at end of file