[Pymerase-cvs-commit] Docs/pymweb pymweb-manual.tex,1.1,1.2

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

Update of /cvsroot/pymerase/Docs/pymweb
In directory sc8-pr-cvs1:/tmp/cvs-serv12466

Modified Files:
	pymweb-manual.tex 
Log Message:
Mostly complete Pymweb Manual


Index: pymweb-manual.tex
===================================================================
RCS file: /cvsroot/pymerase/Docs/pymweb/pymweb-manual.tex,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** pymweb-manual.tex	25 Apr 2003 02:12:24 -0000	1.1
--- pymweb-manual.tex	25 Apr 2003 19:41:29 -0000	1.2
***************
*** 28,32 ****
  \author{Brandon King \\
  Copyright \copyright  ~2003 California Institute of Technology}
! \date{Version 0.1.1\\\today}
  \maketitle
  \thispagestyle{empty}
--- 28,32 ----
  \author{Brandon King \\
  Copyright \copyright  ~2003 California Institute of Technology}
! \date{Version 0.1.2\\\today}
  \maketitle
  \thispagestyle{empty}
***************
*** 161,165 ****
--- 161,270 ----
  
  \subsection{\cb Output File/Dir Name}
+ Every output module has a different type of output, so you need to
+ give a proper output name for them work correctly. If you take a look
+ at the 'Output' format column in section \ref{output}, you will see
+ what type of output each module generates. This table should by mostly
+ sufficiant in guiding you in choosing a File or Directory
+ name. Although a few output modules are a little sensitive to the
+ names you choose. Below is more information you will need to know
+ about the output modules and their output.
+ 
+ \subsubsection{\cb CreateDBAPI}
+ CreateDBAPI creates a Python package (directory of python files) that
+ need to know about the name of their package.
+ 
+ If you are using UML/XMI, it's currently defined as the namespace, or
+ package. So, if you followed 'Pymerase Docs - ArgoUML for Pymerase',
+ there is a step where you change the name of the namespace. What ever
+ you entered as the name of the namespace, is the name you should use
+ as the output directory name in Pymweb. If you do not do this, you
+ will likely get an error while trying to use the generated DBAPI.
+ 
+ If you decided to use table.dtd XML file format, what ever the name of
+ the output directory you choose will be the name of the package.
+ 
+ Note: Renaming the generated package directory name without changing
+ any of the Python code may cause an error. The easiest way to rename
+ the package is to regenerate it with the proper name.
+ 
+ In future versions of Pymerase, this particular issue should be less
+ of a problem. We plan to implement a 'Package' system which should
+ simplify the output file naming.
+ 
+ \subsubsection{\cb CreatePyTkWidgets \& CreatePyTkDBWidgets}
+ CreatePyTkWidgets generates a Python Tkinter library based on your
+ schema. These widgets allow you to write your own custom applications
+ quickly. The Entry Widgets are designed to be sub-classed so you can
+ override their save() and load() functions. Without this, they won't
+ do very much.
+ 
+ CreatePyTkDBWidgets generates sub-classed Entry widgets that know how
+ to load and save data to your generated database via the generated
+ DBAPI. To get this widgets to work, you need to put them in the same
+ directory as your file from CreatePyTkWidgets. Also, you need to copy
+ a generated DBAPI package into the widget library directory. Once that
+ is complete you should be able to launch any of the DbEntry widgets
+ and start accessing data from your database.
+ 
+ Note: Only one-to-one and many-to-one associations have been
+ implemented in the current CreatePyTkDBWidgets. One-to-many and
+ many-to-many associations need to be implemented before it will be
+ complete. I can still be useful in it's current state, and you can
+ always sub-class the Entry library files to implement your own
+ features.
  
+ \subsection{\cb Compression Type}
+ Pymweb currently offers the following three types of compression.
+ 
+ \begin{tabular}{ll}
+ \bf Compression & \bf Extraction Command \\
+ Tar \& Gzip & tar xvzf fileName.tar.gz \\
+ Zip & unzip fileName.zip \\
+ None & None
+ \end{tabular}
+ 
+ Tar \& Gzip is most common on Linux/Unix based systems. Zip is most
+ common on Windows systems. None is offered to make downloads easier
+ for single file downloads, and for debuging.
+ 
+ \subsection{\cb Launch}
+ Once you've made your choices, press the submit button and hope for
+ the best.
+ 
+ \section{\cb Pymweb Output}
+ \subsection{\cb Succesful Output}
+ 
+ \begin{figure}[h]
+   \includegraphics[width=\textwidth]{images/pymweb-output.eps}
+   \caption{\cb Pymweb - Succesful Output}
+ \end{figure}
+ 
+ Assuming everything went smoothly, you should get an output like the
+ one showed in Figure 2. Below is a table describing what you should
+ see when Pymweb ran successfully.
+ 
+ \begin{tabular}{ll}
+ \bf Item & \bf Description \\
+ Version & Pymerase and Pymweb CGI script version numebers \\
+ Session & Link to session directory for returning and Session ID \\
+ Input & Name of input module used \\
+ Output & Name of output module used \\
+ Schema & Schema file uploaded \\
+ Destination & Name of output file or directory \\
+ Compression & Compression type used \\
+ Generation Complete & Tells you that generation was successful \\
+ Download & Link to the generated file \\
+ \end{tabular}
+ 
+ \subsection{\cb Pymweb Failure / Debugging}
+ I am going to leave this section blank for the time being as I plan to
+ improve debugging and error messages in Pymweb. I don't want to waste
+ my time documenting something that I know is going to be absolete in
+ the near future.
+ 
+ For now, if you have any trouble with Pymweb, please join the
+ pymerase-devel mailing list and send an e-mail to the list asking for
+ help. Please visit http://pymerase.sf.net and click on the ``Mail
+ Lists'' if you wish to join the mailing list.
  
  \end{document}