[Pymerase-cvs-commit] Docs/linkDB-tutorial linkdb-tutorial.tex,NONE,1.1

[<ki...@us...>]

Update of /cvsroot/pymerase/Docs/linkDB-tutorial
In directory sc8-pr-cvs1:/tmp/cvs-serv15568

Added Files:
	linkdb-tutorial.tex 
Log Message:
start of linkdb-tutorial


--- NEW FILE: linkdb-tutorial.tex ---
% Pymerase Docs - LinkDB Tutorial
% Copyright (c) California Institute of Technology
%
% Authors: Brandon King
% $Revision: 1.1 $
% Modified $Date: 2003/03/07 23:32:55 $

\documentclass{article}
\usepackage{graphicx}
\usepackage{color}
%\usepackage{makeidx}

\setlength{\parindent}{0in}
\setlength{\parskip}{2mm}

%colors
%\definecolor{light-blue}{rgb}{0.42,0.54,1}
\newcommand{\cb}{\color{blue}}

%\makeindex

%new commands
\newcommand{\pymlink}{http://pymerase.sf.net}

%document
\begin{document}

%title page
\begin{titlepage}
\title{\cb Pymerase Docs - LinkDB Tutorial}
\author{Brandon King \\
Copyright \copyright  California Institute of Technology}
\date{Version 0.1.1\\\today}
\maketitle
\thispagestyle{empty}
\end{titlepage}

\tableofcontents
\thispagestyle{empty}
\newpage
\setcounter{page}{1}

%\chapter{\cb Introduction}

\section{\cb The Goal}
The goal of this tutorial is to use Pymerase to help us create a
simple application to help us with the task of updating keywords on a
webpage with links. Why might we want to create such a program? For
example, you might be writting a webpage about all your favorate Python
modules and what you've done with them. If you decide you want to
create a link to http://www.python.org/ every time the word 'Python'
appears, it would consome much of your time adding links at every
occurance. Add ten more keywords like 'Python' that you would like to
link to, and then updating your webpage with links could become a
nightmare.

It is true this python program would be fairly easy to create by
creating your own file format and parser. Although, it's a good
example of how Pymerase works and it's potential benifits.

\section{\cb Tutorial Requirements}
\subsection{\cb Software Requirements}
  \begin{itemize}
    \item Python 2.1\footnote{http://www.python.org} or greater
      \begin{itemize}
	\item Pymerase\footnote{\pymlink}
	\begin{itemize}
	  \item Input: parseXMI
	  \item Output: CreateDBAPI
	  \item Output: CreateSQL
	  \item Output: CreatePyTkWidgets
	  \item Output: CreatePyTkDbWidgets
	\end{itemize}
	\item mxDateTime
	  \footnote{http://www.egenix.com/files/python/mxDateTime.html}
	\item PyGresql\footnote{http://www.druid.net/pygresql/}
	\item maybe more %FIXME: Needs updating
      \end{itemize}
    \item Jython 2.1\footnote{http://www.jython.org/} or greater
      \begin{itemize}
	\item Java Xerces 2 Lib
	  \footnote{http://xml.apache.org/xerces2-j/index.html}
      \end{itemize}
    \item PostgreSQL 7.2\footnote{http://www.postgresql.org/} or greater
    \item Java 1.3\footnote{http://java.sun.com/} or greater
    \item ArgoUML %FIXME: Need to set version dependancies
  \end{itemize}

\subsection{\cb Previous Knowledge Requirements}
  \begin{itemize}
    \item ArgoUML\footnote{See \pymlink /docs/
      for ArgoUML information} 
    \item Python Language\footnote{Python Tutorial:
      http://www.python.org/doc/current/tut/tut.html}
  \end{itemize}

\section{\cb Getting Help}
\subsection{\cb Pymerase Web Site}
One of the first places you should check out if you need help is the
Pymerase web site at \pymlink. Most of the documentation you will
need, if it's available, will be in the Docs section of the web site.

\subsection{\cb Pymerase-devel Mailing List}
Pymerase developers and users are using pymerase-devel at
lists.sourceforge.net as a means of communication. If you need
help or would like to track development status of Pymerase,
subscribing to the mailing list is a good idea. You can do this by
going to \pymlink~and clicking on the 'Mail Lists' button. Note that
everyone is welcome to make posts related to Pymerase, not just
developers.

\subsection{\cb Trackers: Bugs, Feature Request, etc.}
Currently, there are four trackers in use by the pymerase project on
the development site\footnote{http://www.sf.net/projects/pymerase} at
sourceforge.net. 
\begin{itemize}
  \item Bugs
  \item Support Requests
  \item Patches
  \item Feature Requests
\end{itemize}
Please submit Bugs and Feature Requests using these trackers. If you
have a patch for pymerase, but do not want to become a developer,
please use the Patch tracker. Support Requests can be submitted to the
tracker or the Pymerase-devel mailing list.

\end{document}

%\printindex