updated documentation.

This commit is contained in:
brad Arant 2024-11-02 10:52:25 -07:00
parent 4b24c21893
commit b08d2b59eb
5 changed files with 155 additions and 46 deletions

View File

@ -8,13 +8,20 @@
\@writefile{toc}{\contentsline {chapter}{\numberline {3}Variables and Variable Types}{9}{}\protected@file@percent } \@writefile{toc}{\contentsline {chapter}{\numberline {3}Variables and Variable Types}{9}{}\protected@file@percent }
\@writefile{lof}{\addvspace {10\p@ }} \@writefile{lof}{\addvspace {10\p@ }}
\@writefile{lot}{\addvspace {10\p@ }} \@writefile{lot}{\addvspace {10\p@ }}
\@writefile{toc}{\contentsline {section}{\numberline {3.1}Global Variables}{9}{}\protected@file@percent }
\@writefile{toc}{\contentsline {section}{\numberline {3.2}Local Variables}{9}{}\protected@file@percent }
\@writefile{toc}{\contentsline {section}{\numberline {3.3}Environment Variables}{9}{}\protected@file@percent }
\@writefile{toc}{\contentsline {section}{\numberline {3.4}CGI Variables}{9}{}\protected@file@percent }
\@writefile{toc}{\contentsline {chapter}{\numberline {4}Expressions}{11}{}\protected@file@percent } \@writefile{toc}{\contentsline {chapter}{\numberline {4}Expressions}{11}{}\protected@file@percent }
\@writefile{lof}{\addvspace {10\p@ }} \@writefile{lof}{\addvspace {10\p@ }}
\@writefile{lot}{\addvspace {10\p@ }} \@writefile{lot}{\addvspace {10\p@ }}
\@writefile{toc}{\contentsline {section}{\numberline {4.1}Functions and Operators}{11}{}\protected@file@percent } \@writefile{toc}{\contentsline {section}{\numberline {4.1}Operators}{11}{}\protected@file@percent }
\@writefile{toc}{\contentsline {subsection}{\numberline {4.1.1}left(string, number-of-characters)}{11}{}\protected@file@percent } \@writefile{toc}{\contentsline {subsection}{\numberline {4.1.1}Arithmentic Operators}{11}{}\protected@file@percent }
\@writefile{toc}{\contentsline {subsection}{\numberline {4.1.2}random()}{11}{}\protected@file@percent } \@writefile{toc}{\contentsline {subsection}{\numberline {4.1.2}Boolean Operators}{11}{}\protected@file@percent }
\@writefile{toc}{\contentsline {subsection}{\numberline {4.1.3}substring(string, start-position, number-of-characters}{11}{}\protected@file@percent } \@writefile{toc}{\contentsline {section}{\numberline {4.2}Function Reference}{11}{}\protected@file@percent }
\@writefile{toc}{\contentsline {subsection}{\numberline {4.2.1}left(string, number-of-characters)}{11}{}\protected@file@percent }
\@writefile{toc}{\contentsline {subsection}{\numberline {4.2.2}random()}{11}{}\protected@file@percent }
\@writefile{toc}{\contentsline {subsection}{\numberline {4.2.3}substring(string, start-position, number-of-characters}{11}{}\protected@file@percent }
\@writefile{toc}{\contentsline {chapter}{\numberline {5}Common Gateway Interface Features}{13}{}\protected@file@percent } \@writefile{toc}{\contentsline {chapter}{\numberline {5}Common Gateway Interface Features}{13}{}\protected@file@percent }
\@writefile{lof}{\addvspace {10\p@ }} \@writefile{lof}{\addvspace {10\p@ }}
\@writefile{lot}{\addvspace {10\p@ }} \@writefile{lot}{\addvspace {10\p@ }}
@ -31,12 +38,13 @@
\@writefile{toc}{\contentsline {section}{\numberline {6.8}mysql}{16}{}\protected@file@percent } \@writefile{toc}{\contentsline {section}{\numberline {6.8}mysql}{16}{}\protected@file@percent }
\@writefile{toc}{\contentsline {section}{\numberline {6.9}read}{16}{}\protected@file@percent } \@writefile{toc}{\contentsline {section}{\numberline {6.9}read}{16}{}\protected@file@percent }
\@writefile{toc}{\contentsline {section}{\numberline {6.10}set}{16}{}\protected@file@percent } \@writefile{toc}{\contentsline {section}{\numberline {6.10}set}{16}{}\protected@file@percent }
\@writefile{toc}{\contentsline {section}{\numberline {6.11}sql}{17}{}\protected@file@percent } \@writefile{toc}{\contentsline {section}{\numberline {6.11}sql}{16}{}\protected@file@percent }
\@writefile{toc}{\contentsline {section}{\numberline {6.12}stream}{17}{}\protected@file@percent } \@writefile{toc}{\contentsline {section}{\numberline {6.12}stream}{16}{}\protected@file@percent }
\@writefile{toc}{\contentsline {section}{\numberline {6.13}system}{17}{}\protected@file@percent } \@writefile{toc}{\contentsline {section}{\numberline {6.13}system}{17}{}\protected@file@percent }
\@writefile{toc}{\contentsline {section}{\numberline {6.14}tag}{17}{}\protected@file@percent } \@writefile{toc}{\contentsline {section}{\numberline {6.14}tag}{17}{}\protected@file@percent }
\@writefile{toc}{\contentsline {section}{\numberline {6.15}while}{17}{}\protected@file@percent } \@writefile{toc}{\contentsline {section}{\numberline {6.15}until}{17}{}\protected@file@percent }
\@writefile{toc}{\contentsline {section}{\numberline {6.16}whiledir}{17}{}\protected@file@percent } \@writefile{toc}{\contentsline {section}{\numberline {6.16}while}{17}{}\protected@file@percent }
\@writefile{toc}{\contentsline {section}{\numberline {6.17}whilerow}{17}{}\protected@file@percent } \@writefile{toc}{\contentsline {section}{\numberline {6.17}whiledir}{17}{}\protected@file@percent }
\@writefile{toc}{\contentsline {section}{\numberline {6.18}write}{17}{}\protected@file@percent } \@writefile{toc}{\contentsline {section}{\numberline {6.18}whilerow}{17}{}\protected@file@percent }
\gdef \@abspage@last{17} \@writefile{toc}{\contentsline {section}{\numberline {6.19}write}{18}{}\protected@file@percent }
\gdef \@abspage@last{18}

View File

@ -1,4 +1,4 @@
This is pdfTeX, Version 3.141592653-2.6-1.40.25 (TeX Live 2023/Debian) (preloaded format=pdflatex 2024.6.24) 1 NOV 2024 12:47 This is pdfTeX, Version 3.141592653-2.6-1.40.25 (TeX Live 2023/Debian) (preloaded format=pdflatex 2024.6.24) 1 NOV 2024 14:40
entering extended mode entering extended mode
restricted \write18 enabled. restricted \write18 enabled.
%&-line parsing enabled. %&-line parsing enabled.
@ -60,18 +60,18 @@ LaTeX Font Info: External font `cmex10' loaded for size
] ]
(./JetCore.toc (./JetCore.toc
LaTeX Font Info: External font `cmex10' loaded for size LaTeX Font Info: External font `cmex10' loaded for size
(Font) <7> on input line 5. (Font) <7> on input line 4.
LaTeX Font Info: External font `cmex10' loaded for size LaTeX Font Info: External font `cmex10' loaded for size
(Font) <5> on input line 5. (Font) <5> on input line 4.
) [3])
\tf@toc=\write3 \tf@toc=\write3
\openout3 = `JetCore.toc'. \openout3 = `JetCore.toc'.
[3] [4 [4]
]
Chapter 1. Chapter 1.
[5] [6 [5
] [6
] ]
Chapter 2. Chapter 2.
@ -79,12 +79,12 @@ Chapter 2.
] ]
Chapter 3. Chapter 3.
[9] [10 [9{/usr/share/texmf/fonts/enc/dvips/cm-super/cm-super-ts1.enc}] [10
] ]
Chapter 4. Chapter 4.
Overfull \hbox (8.39041pt too wide) in paragraph at lines 53--53 Overfull \hbox (8.39041pt too wide) in paragraph at lines 100--100
[]\OT1/cmr/bx/n/12 substring(string, start-position, number-of-characters []\OT1/cmr/bx/n/12 substring(string, start-position, number-of-characters
[] []
@ -96,22 +96,18 @@ Chapter 5.
] ]
Chapter 6. Chapter 6.
[15] [15] [16] [17] [18] (./JetCore.aux)
Underfull \vbox (badness 7415) has occurred while \output is active []
[16]
[17] (./JetCore.aux)
*********** ***********
LaTeX2e <2023-11-01> patch level 1 LaTeX2e <2023-11-01> patch level 1
L3 programming layer <2024-01-22> L3 programming layer <2024-01-22>
*********** ***********
) )
Here is how much of TeX's memory you used: Here is how much of TeX's memory you used:
502 strings out of 476182 508 strings out of 476182
9170 string characters out of 5795595 9280 string characters out of 5795595
1931975 words of memory out of 5000000 1932975 words of memory out of 5000000
22569 multiletter control sequences out of 15000+600000 22573 multiletter control sequences out of 15000+600000
564057 words of font info for 56 fonts, out of 8000000 for 9000 564392 words of font info for 57 fonts, out of 8000000 for 9000
14 hyphenation exceptions out of 8191 14 hyphenation exceptions out of 8191
35i,6n,50p,185b,189s stack positions out of 10000i,1000n,20000p,200000b,200000s 35i,6n,50p,185b,189s stack positions out of 10000i,1000n,20000p,200000b,200000s
</usr/share/texlive/texmf-dist/fonts/type1/public/amsfonts/cm/cmbx10.pfb></us </usr/share/texlive/texmf-dist/fonts/type1/public/amsfonts/cm/cmbx10.pfb></us
@ -120,11 +116,12 @@ e/texlive/texmf-dist/fonts/type1/public/amsfonts/cm/cmr10.pfb></usr/share/texli
ve/texmf-dist/fonts/type1/public/amsfonts/cm/cmr12.pfb></usr/share/texlive/texm ve/texmf-dist/fonts/type1/public/amsfonts/cm/cmr12.pfb></usr/share/texlive/texm
f-dist/fonts/type1/public/amsfonts/cm/cmr17.pfb></usr/share/texlive/texmf-dist/ f-dist/fonts/type1/public/amsfonts/cm/cmr17.pfb></usr/share/texlive/texmf-dist/
fonts/type1/public/amsfonts/cm/cmsl10.pfb></usr/share/texlive/texmf-dist/fonts/ fonts/type1/public/amsfonts/cm/cmsl10.pfb></usr/share/texlive/texmf-dist/fonts/
type1/public/amsfonts/cm/cmtt10.pfb> type1/public/amsfonts/cm/cmtt10.pfb></usr/share/texmf/fonts/type1/public/cm-sup
Output written on JetCore.pdf (17 pages, 116147 bytes). er/sfrm1000.pfb>
Output written on JetCore.pdf (18 pages, 126208 bytes).
PDF statistics: PDF statistics:
94 PDF objects out of 1000 (max. 8388607) 103 PDF objects out of 1000 (max. 8388607)
60 compressed objects within 1 object stream 66 compressed objects within 1 object stream
0 named destinations out of 1000 (max. 500000) 0 named destinations out of 1000 (max. 500000)
1 words of extra memory for PDF output out of 10000 (max. 10000000) 1 words of extra memory for PDF output out of 10000 (max. 10000000)

Binary file not shown.

View File

@ -1,11 +1,18 @@
\contentsline {chapter}{\numberline {1}Introduction}{5}{}% \contentsline {chapter}{\numberline {1}Introduction}{5}{}%
\contentsline {chapter}{\numberline {2}Tags and Attributes}{7}{}% \contentsline {chapter}{\numberline {2}Tags and Attributes}{7}{}%
\contentsline {chapter}{\numberline {3}Variables and Variable Types}{9}{}% \contentsline {chapter}{\numberline {3}Variables and Variable Types}{9}{}%
\contentsline {section}{\numberline {3.1}Global Variables}{9}{}%
\contentsline {section}{\numberline {3.2}Local Variables}{9}{}%
\contentsline {section}{\numberline {3.3}Environment Variables}{9}{}%
\contentsline {section}{\numberline {3.4}CGI Variables}{9}{}%
\contentsline {chapter}{\numberline {4}Expressions}{11}{}% \contentsline {chapter}{\numberline {4}Expressions}{11}{}%
\contentsline {section}{\numberline {4.1}Functions and Operators}{11}{}% \contentsline {section}{\numberline {4.1}Operators}{11}{}%
\contentsline {subsection}{\numberline {4.1.1}left(string, number-of-characters)}{11}{}% \contentsline {subsection}{\numberline {4.1.1}Arithmentic Operators}{11}{}%
\contentsline {subsection}{\numberline {4.1.2}random()}{11}{}% \contentsline {subsection}{\numberline {4.1.2}Boolean Operators}{11}{}%
\contentsline {subsection}{\numberline {4.1.3}substring(string, start-position, number-of-characters}{11}{}% \contentsline {section}{\numberline {4.2}Function Reference}{11}{}%
\contentsline {subsection}{\numberline {4.2.1}left(string, number-of-characters)}{11}{}%
\contentsline {subsection}{\numberline {4.2.2}random()}{11}{}%
\contentsline {subsection}{\numberline {4.2.3}substring(string, start-position, number-of-characters}{11}{}%
\contentsline {chapter}{\numberline {5}Common Gateway Interface Features}{13}{}% \contentsline {chapter}{\numberline {5}Common Gateway Interface Features}{13}{}%
\contentsline {chapter}{\numberline {6}Tag Reference}{15}{}% \contentsline {chapter}{\numberline {6}Tag Reference}{15}{}%
\contentsline {section}{\numberline {6.1}call}{15}{}% \contentsline {section}{\numberline {6.1}call}{15}{}%
@ -18,11 +25,12 @@
\contentsline {section}{\numberline {6.8}mysql}{16}{}% \contentsline {section}{\numberline {6.8}mysql}{16}{}%
\contentsline {section}{\numberline {6.9}read}{16}{}% \contentsline {section}{\numberline {6.9}read}{16}{}%
\contentsline {section}{\numberline {6.10}set}{16}{}% \contentsline {section}{\numberline {6.10}set}{16}{}%
\contentsline {section}{\numberline {6.11}sql}{17}{}% \contentsline {section}{\numberline {6.11}sql}{16}{}%
\contentsline {section}{\numberline {6.12}stream}{17}{}% \contentsline {section}{\numberline {6.12}stream}{16}{}%
\contentsline {section}{\numberline {6.13}system}{17}{}% \contentsline {section}{\numberline {6.13}system}{17}{}%
\contentsline {section}{\numberline {6.14}tag}{17}{}% \contentsline {section}{\numberline {6.14}tag}{17}{}%
\contentsline {section}{\numberline {6.15}while}{17}{}% \contentsline {section}{\numberline {6.15}until}{17}{}%
\contentsline {section}{\numberline {6.16}whiledir}{17}{}% \contentsline {section}{\numberline {6.16}while}{17}{}%
\contentsline {section}{\numberline {6.17}whilerow}{17}{}% \contentsline {section}{\numberline {6.17}whiledir}{17}{}%
\contentsline {section}{\numberline {6.18}write}{17}{}% \contentsline {section}{\numberline {6.18}whilerow}{17}{}%
\contentsline {section}{\numberline {6.19}write}{18}{}%

View File

@ -35,6 +35,34 @@ in combination with the <ifrow>, <whilerow> and <sql> tags.
\chapter{Variables and Variable Types} \chapter{Variables and Variable Types}
Variables are used to contain dynamic content values and can be
sourced from several locations and limited in scope depending on use.
Some variable types can be set to reflect script state or are read
only from other outside sources of data. The following is a list of
variable types and a brief description of their source:
\begin{itemize}
\item Global - values can be initiaized using the set tag and
specifying the scope of global.
\item Local -
\end{itemize}
\section{Global Variables}
Global is the default if the scope is
not specified for any function that writes to a variable.
\section{Local Variables}
\section{Environment Variables}
\section{CGI Variables}
\chapter{Expressions} \chapter{Expressions}
@ -42,7 +70,26 @@ Expressions are used to perform complicated calculations (arithmetic), perform
comparisons between values (boolean), manipulate strings (string) or comparisons between values (boolean), manipulate strings (string) or
perform operations on dates (date). perform operations on dates (date).
\section{Functions and Operators} \section{Operators}
Operators are used to perform arithmetic or boolean operations on
arguments to derive a particular result. There are two types of
operators, as follows:
\begin{itemize}
\item Arithmetic -
\item Boolean -
\end{itemize}
\subsection{Arithmentic Operators}
\subsection{Boolean Operators}
\section{Function Reference}
\subsection{left(string, number-of-characters)} \subsection{left(string, number-of-characters)}
@ -161,21 +208,70 @@ contents of the set tag container.
\section{sql} \section{sql}
Use the sql tag to specify an sql statement to run on the sql server
specified in the mysql tag.
As long as sql statements are executed within the same mysql
containing tag then the same mysql session is used for each sql
statement.
\section{stream} \section{stream}
Use stream tag to output data from the server without waiting for the
standard output buffering and processing of the JET script. This is
useful for outputting images and streams for audio and video without
the server having to load the whole thing into RAM first.
\section{system} \section{system}
Use the system tag to execute a bash shell command within the JET
script.
\section{tag} \section{tag}
Use the tag tag to define a new tag definition for use within the
script.
Tags are normally defined globally and can be used anywhere within the
script.
Tags can also be defined within other tags and the scope of those tags
is only within the defining tag's container. The enclosed tag
definition will not be available globally.
\section{until}
Use the until tag to process a container at least once and
continue to process the container until the specified condition is met.
Note that this tag always processes the container at least once.
Be careful not to create a never ending loop by not modifying any of
the condition parameters specified in the condition clause.
\section{while} \section{while}
Use the while tag to process a container if the specified condition is
true.
Note that the container may not be processed if the condition is never
met.
Be careful not to create a never ending loop by not modifying any of
the condition parameters specified in the condition clause.
\section{whiledir} \section{whiledir}
Use the whiledir tag to loop a directory path to the container for
processing.
\section{whilerow} \section{whilerow}
Use the whilerow tag in combination with mysql and sql tags to provide
a container to process for each row retrieved by the sql statement.
\section{write} \section{write}
Use the write tag to write data to the local file system.
\end{document} \end{document}