| 1 |
\ProvidesFile{blogexec.tex}[2012/12/20 documenting blogexec.sty] |
| 2 |
\title{{\huge\pkg{blogexec.sty}}\\---\\Overcoming |
| 3 |
\pkg{blog.sty}'s Pure Expansion\thanks{This |
| 4 |
document describes version |
| 5 |
\textcolor{blue}{\UseVersionOf{\jobname.sty}} |
| 6 |
of \textsf{\jobname.sty} as of \UseDateOf{\jobname.sty}.}} |
| 7 |
% \listfiles |
| 8 |
{ \RequirePackage{makedoc} |
| 9 |
\ProcessLineMessage{} %%% {\message{.}} |
| 10 |
\MakeJobDoc{17} |
| 11 |
{\SectionLevelThreeParseInput} } |
| 12 |
\documentclass[fleqn]{article}%% TODO paper dimensions!? |
| 13 |
\input{makedoc.cfg} %% shared formatting settings |
| 14 |
\usepackage{filesdo} \MDfinaldatechecks %% 2012/12/20 |
| 15 |
\providecommand*{\HTML}{\acro{HTML}} |
| 16 |
\ReadPackageInfos{blogexec} |
| 17 |
\sloppy |
| 18 |
\begin{document} |
| 19 |
\maketitle |
| 20 |
\begin{abstract}\noindent |
| 21 |
'blog.sty' before v0.7 generated \HTML\ by pure macro expansion |
| 22 |
and could use \LaTeX\ macros (redefined) only to a very limited |
| 23 |
extent. On adding 'blogexec.sty', some macros (configurable) are |
| 24 |
``intercepted" before expansion in a 'blog' run for |
| 25 |
``running" some code, basically `\begin', `\end', |
| 26 |
and a new general `\EXECUTE'. |
| 27 |
A table environment with active characters inside only is |
| 28 |
provided---perhaps ``nicer than \LaTeX." |
| 29 |
\end{abstract} |
| 30 |
\tableofcontents |
| 31 |
|
| 32 |
% \newpage |
| 33 |
\section{Features and Usage} |
| 34 |
|
| 35 |
% \subsection{Installing and Calling} |
| 36 |
The file 'blogexec.sty' is provided ready, installation only requires |
| 37 |
putting it somewhere where \TeX\ finds it |
| 38 |
(which may need updating the filename data |
| 39 |
base).\urlfoot{ukfaqref}{inst-wlcf} %% corr. 2011/02/08 |
| 40 |
|
| 41 |
'blogexec.sty' may be loaded by |
| 42 |
\begin{verbatim} |
| 43 |
\RequirePackage{blogexec} |
| 44 |
\end{verbatim} |
| 45 |
in a driver file for 'blog.sty'. \strong{Alternatively}, |
| 46 |
the following commands in a 'blog' driver file |
| 47 |
(in a certain way even in a \emph{source} file) |
| 48 |
load 'blogexec.sty' and then are carried out according to their |
| 49 |
definitions in 'blogexec': |
| 50 |
\begin{description} |
| 51 |
\cmdboxitem|\BlogInterceptExecute| \ intercepts |\EXECUTE| only. |
| 52 |
\cmdboxitem|\BlogInterceptEnvironments| \ intercepts |\EXECUTE|, |
| 53 |
|\begin|, and |\end| only; the latter two then work much |
| 54 |
as with \LaTeX. They expand to \HTML\ code as with 'blog'; |
| 55 |
`\begin{<env>}' additionally executes commands according |
| 56 |
to an (optional) |
| 57 |
\[|\MakeBlogBeginRun{<env>}<arguments>{<begin-code>}|.\] |
| 58 |
\cmdboxitem|\BlogInterceptExtra| \ intercepts all the commands |
| 59 |
in certain lists (using the \ctanpkgref{dowith} package), |
| 60 |
including `\EXECUTE', `\begin', `\end'. E.g., |
| 61 |
\[|\MakeBlogOneArgInterception{<cmd>}{<run>}{<write>}|\] |
| 62 |
adds <cmd> to such a list and tells that <run> should be |
| 63 |
carried out and that <cmd><one-argument> should be replaced |
| 64 |
by <write> in a line containing <cmd> |
| 65 |
(not hidden in braces, and there better should not be much more |
| 66 |
in the line). |
| 67 |
\cmdboxitem|\BlogInterceptHash| \ does \emph{not} choose an |
| 68 |
\strong{``interception level"} as the previous commands do, |
| 69 |
but may be necessary for allowing parameters in macro |
| 70 |
definitions to be run in the course of an interception. |
| 71 |
It is automatically (``implicitly") envoked by the star forms |
| 72 |
of the above commands, i.e., by either of |
| 73 |
\begin{itemize} |
| 74 |
\item |\BlogInterceptExecute*| |
| 75 |
\item |\BlogInterceptEnvironments*| |
| 76 |
\item |\BlogInterceptExtra*| |
| 77 |
\end{itemize} |
| 78 |
\end{description} |
| 79 |
The reader may find additional details in the following sections |
| 80 |
near the code implementing the commands. |
| 81 |
|
| 82 |
'blogexec.sty' also modifies 'blog.sty''s (v0.7) |
| 83 |
|{stdallrulestable}| environment as follows: |
| 84 |
\begin{itemize} |
| 85 |
\item[\InlineCmdBox{\texttt{&|}}] |
| 86 |
The vertical stroke becomes an active character |
| 87 |
that closes a table cell and opens another one |
| 88 |
(being an alias for 'blog.sty''s v0.7 `\endcell')---just |
| 89 |
as |&| does it with \TeX/\LaTeX. |
| 90 |
\cmdboxitem|&| The ampersand becomes an active character |
| 91 |
that---\strong{differently to \TeX\slash\LaTeX}---as an alias for |
| 92 |
'blog.sty''s |\figurespace| produces the Unicode figure space |
| 93 |
for alignment of figures. |
| 94 |
\end{itemize} |
| 95 |
\emph{Outside} the `{stdallrules}' environment, both characters |
| 96 |
have their ``usual" meaning, i.e., |&| may be used for accessing |
| 97 |
\HTML\ entities (as 'blog.sty' allows it). |\cr| (and |\endline|, |
| 98 |
provided by 'blog.sty' v0.7) ends a table row and starts a new one. |
| 99 |
|\\| is not touched---a \strong{difference to \LaTeX} and may still be |
| 100 |
used for breaking a line within a table cell. |
| 101 |
|
| 102 |
% \section{Example} |
| 103 |
|
| 104 |
% \pagebreak |
| 105 |
% \section{Implementation} |
| 106 |
\section{Package File Header (Legalize)} |
| 107 |
\input{blogexec.doc} |
| 108 |
\end{document} |
| 109 |
|
| 110 |
VERSION HISTORY |
| 111 |
|
| 112 |
2011/11/04 for v0.1 very first |
| 113 |
2011/11/09f. something more |
| 114 |
2011/11/20 star forms |
| 115 |
2012/12/20 for v0.21 date checks |
| 116 |
|
| 117 |
|