summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/hvextern/doc/hvextern.tex
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/hvextern/doc/hvextern.tex')
-rw-r--r--macros/latex/contrib/hvextern/doc/hvextern.tex99
1 files changed, 56 insertions, 43 deletions
diff --git a/macros/latex/contrib/hvextern/doc/hvextern.tex b/macros/latex/contrib/hvextern/doc/hvextern.tex
index 724f779a73..d3f81f7447 100644
--- a/macros/latex/contrib/hvextern/doc/hvextern.tex
+++ b/macros/latex/contrib/hvextern/doc/hvextern.tex
@@ -1,4 +1,4 @@
-%% $Id: hvextern.tex 574 2022-06-09 19:34:31Z herbert $
+%% $Id: hvextern.tex 577 2022-06-20 16:35:21Z herbert $
\RequirePackage{pdfmanagement-testphase}
\DeclareDocumentMetadata{}
\documentclass[ngerman,a4paper,twoside]{article}
@@ -10,7 +10,7 @@
\usepackage{fancyhdr}
\pagestyle{fancy}
\usepackage{hvlogos}
-\usepackage{hvextern}
+\usepackage[checkCode]{hvextern}
\usepackage{hvindex}
\usepackage{hvdoctools}
\usepackage{listings}
@@ -34,14 +34,24 @@ from within a main\newline \LaTeX\ document~--v. \hvexternFileversion}
%\newpage
\setkeys{hv}{moveToExampleDir,ExampleDir=Exa,showFilename,verbose}
-\section{Syntax}
+
+
+\clearpage
+
+\section{Loading the package}
\begin{verbatim}
-\usepackage{hvextern}
+\usepackage[Option]{hvextern}
\end{verbatim}
-\addtocontents{toc}{\protect\enlargethispage{2ex}}
+There exists only one option \Loption{checkCode} which is only valid
+for the use of \LuaLaTeX. In this case an already existing external file will only be compiled, if the
+code changed. This dosn't depends on the setting of the option \Lkeyword{force}.
+The package option will speed up the compilation time.
+\section{Syntax}
+
+\addtocontents{toc}{\protect\enlargethispage{2ex}}
\begin{sloppypar}
This package allows to write external \MP, \TeX, \ConTeXt, \LaTeX, \LuaTeX, \LuaLaTeX, \XeTeX, \XeLaTeX,
@@ -96,7 +106,7 @@ outside of the main document and then to insert the output
we can do this from within this \LuaLaTeX\ document itself. The external document is compiled
with \XeLaTeX\ and the output is insert as pdf image:
\begin{externalDocument}[%
- compiler=xelatex, inline, force, runs=2, grfOptions={height=8pt},%
+ compiler=xelatex, inline, force=false, runs=2, grfOptions={height=8pt},%
crop, cropmargin=0, cleanup, docType=latex]{voss}
\documentclass{ctexart}
\pagestyle{empty}
@@ -112,7 +122,7 @@ shown by the environment \Lenv{externalDocument}.
\begin{minipage}{.59\linewidth}
\begin{lstlisting}
\begin{externalDocument}[
- compiler=pdflatex,force,cleanup]{voss}
+ compiler=pdflatex,force=false,cleanup]{voss}
\documentclass{standalone}
%StartVisiblePreamble
\usepackage{fontenc}
@@ -136,7 +146,7 @@ shown by the environment \Lenv{externalDocument}.
\end{minipage}
\begin{minipage}{.39\linewidth}
\begin{externalDocument}[
- compiler=pdflatex,force=true,cleanup={log,aux},showFilename=false]{voss}
+ compiler=pdflatex,force=false,cleanup={log,aux},showFilename=false]{voss}
\documentclass{standalone}
%StartVisiblePreamble
\usepackage{fontenc}
@@ -192,7 +202,7 @@ catagory, which is done internally by the package. The complete definition of th
compiler=python3,
code,
ext=py,
- force=true,
+ force=false,
docType=py,
usefancyvrb,
grfOptions={width=\linewidth}]{python}
@@ -242,7 +252,7 @@ line in the above code shows how it can be done with Python.
\begin{externalDocument}[
compiler=python3,
progpath=/usr/local/bin/,
- force=true,
+ force=false,
runs=1,
code,
ext=py,
@@ -292,6 +302,8 @@ set in twocolumn mode but inside a starred floating environment over both
column, then use the keyword \Lkeyword{outerFN}. Then \Lpack{hvextern} doesn't
test for twocolumn mode.
+\enlargethispage{\normalbaselineskip}
+
A vertical shift of the filename is possible by setting a length to the keyword \Lkeyword{shiftFN},
e.g. \texttt{shiftFN=5ex}.
@@ -300,7 +312,7 @@ e.g. \texttt{shiftFN=5ex}.
\begin{externalDocument}[grfOptions={width=0.95\linewidth},
compiler=xelatex,code,mpwidth=0.6\linewidth,
- crop,cleanup,force=true,usefancyvrb=false,ext=tex,showFilename=false]{voss}
+ crop,cleanup,force=false,usefancyvrb=false,ext=tex,showFilename=false]{voss}
\documentclass{article}
%StartVisiblePreamble
\usepackage{tikz}
@@ -412,7 +424,7 @@ runsequence={lualatex,biber,xindex -l de -c AU,lualatex,lualatex}
runsequence={lualatex,biber,xindex -l de -c AU,lualatex,lualatex},
,
verbose,
- force=true,
+ force=false,
cleanup={log,aux,toc,bbl,blg},
code,docType=latex,
lstOptions={columns=fixed}]{voss}
@@ -451,7 +463,7 @@ the environment \Lenv{externalDocument} is:
\begin{externalDocument}[
verbose,
compiler=java,ext=java,code,
- force=true,docType=java,includegraphic,
+ force=false,docType=java,includegraphic,
usefancyvrb,grfOptions={width=0.9\linewidth}]{java}
import java.awt.Color;
import java.awt.Graphics;
@@ -582,7 +594,7 @@ to \Lcs{VerbatimInput}. The following example uses
mpwidth=0.6\linewidth,
crop,
cleanup,
- force=true,
+ force=false,
docType=latex]{voss}
\RequirePackage{pdfmanagement-testphase}
\DeclareDocumentMetadata{}
@@ -630,7 +642,7 @@ The color of the frame is set to the same values, hence not seen. The following
mpwidth=0.6\linewidth,
crop,
cleanup,
- force=true,
+ force=false,
usefancyvrb,
docType=latex]{voss}
\RequirePackage{pdfmanagement-testphase}
@@ -717,7 +729,7 @@ The following example uses:
% mpwidth=0.6\linewidth,
% crop,
cleanup,
- force=true,
+ force=false,
frame,
% usefancyvrb,
% float,
@@ -770,7 +782,7 @@ which is the default. Using a caption and a label are optional.
% mpwidth=0.6\linewidth,
crop,
cleanup,
- force=true,
+ force=false,
usefancyvrb,
float,
floatsetting=!ht,
@@ -833,7 +845,7 @@ The follwoing example was created with
% mpwidth=0.6\linewidth,
crop, cropmargin=5,
cleanup,
- force=true,
+ force=false,
frame,
% usefancyvrb,
% float,
@@ -894,7 +906,7 @@ or \Lkeyval{b}.
showFilename=false,
crop,
cleanup,
- force=true,
+ force=false,
docType=latex]{voss}
\documentclass{article}
\pagestyle{empty}
@@ -918,7 +930,7 @@ or \Lkeyval{b}.
code,
crop,
cleanup,
- force=true,
+ force=false,
docType=latex]{voss}
\documentclass{article}
\pagestyle{empty}
@@ -943,7 +955,7 @@ or \Lkeyval{b}.
showFilename=false,
crop,
cleanup,
- force=true,
+ force=false,
docType=latex]{voss}
\documentclass{article}
\pagestyle{empty}
@@ -968,7 +980,7 @@ or \Lkeyval{b}.
crop,
showFilename=false,
cleanup,
- force=true,
+ force=false,
mpwidth=0.5\linewidth,
docType=latex]{voss}
\documentclass{article}
@@ -993,7 +1005,7 @@ or \Lkeyval{b}.
showFilename=false,
crop,
cleanup,
- force=true,
+ force=false,
mpwidth=0.5\linewidth,
docType=latex]{voss}
\documentclass{article}
@@ -1019,7 +1031,7 @@ or \Lkeyval{b}.
showFilename=false,
crop,
cleanup,
- force=true,
+ force=false,
mpwidth=0.5\linewidth,
docType=latex]{voss}
\documentclass{article}
@@ -1049,7 +1061,7 @@ next Chinese characters
\begin{externalDocument}[
compiler=xelatex, inline, runs=2, grfOptions={height=8pt},
crop, cropmargin=0,
- cleanup, force=true, docType=latex]{voss}%
+ cleanup, force=false, docType=latex]{voss}%
\documentclass{ctexart}
\pagestyle{empty}
\begin{document}
@@ -1065,7 +1077,7 @@ With \Lkeyset{inline} the optional argument \Lkeyword{code} is
automatically set to false. The next Chinese characters
\begin{externalDocument}[
compiler=xelatex, inline, runs=2, grfOptions={height=8pt},
- crop, cropmargin=0, cleanup, force=true, docType=latex]{voss}
+ crop, cropmargin=0, cleanup, force=false, docType=latex]{voss}
\documentclass{ctexart}
\pagestyle{empty}
\begin{document}
@@ -1104,7 +1116,7 @@ sorted digits of the number $A$: $495=954-459$.
\begin{externalDocument}[
- compiler=perl, force=true, docType=pl, ext=pl, includegraphic=false,
+ compiler=perl, force=false, docType=pl, ext=pl, includegraphic=false,
code, mpwidth=0.6\linewidth]{voss}
#!/usr/bin/perl
#
@@ -1159,7 +1171,7 @@ outFile = io.open(shortFN..".txt","w+") -- open external file
\begin{externalDocument}[
- compiler=lua, force=true, docType=lua, ext=lua, includegraphic=false,
+ compiler=lua, force=false, docType=lua, ext=lua, includegraphic=false,
code, usefancyvrb=false,textOptions={basicstyle=\ttfamily\footnotesize},
shiftFN=6ex]{voss}
#!/usr/bin/env lua
@@ -1234,7 +1246,7 @@ The following examples uses
pages=2,
crop,
cleanup,
- force=true,
+ force=false,
xindex,
xindexOptions={-l DE --config AU},
mpwidth=0.6\linewidth,
@@ -1290,7 +1302,7 @@ runsequence={lualatex,biber,{xindex -l de -c AU},lualatex,lualatex}
frame,
runsequence={lualatex,biber,xindex -l de -c AU,lualatex,lualatex},
verbose,
- force=true,
+ force=false,
cleanup={log,aux,toc,bbl,blg},
code,docType=latex,
lstOptions={columns=fixed}]{voss}
@@ -1330,7 +1342,7 @@ The default is using \Lcs{lstinputlisting} for the printed code sequences.
pages={1,3},
frame,compiler=pdflatex,
% crop,
- force=true,runs=2,code,docType=latex,
+ force=false,runs=2,code,docType=latex,
frame,
lstOptions={columns=fixed}]{voss}
%StartVisiblePreamble
@@ -1390,7 +1402,7 @@ it makes no difference using the optional argument \Lkeyword{usefancyvrb} or not
frame,compiler=pdflatex,
showFilename,
% crop,
- force=true,runs=2,code,docType=latex,
+ force=false,runs=2,code,docType=latex,
frame,framesep=0pt,usefancyvrb]{voss}
%StartVisiblePreamble
\documentclass[chapterprefix=on,parskip=half-,DIV=12,fontsize=12pt]{scrbook}
@@ -1474,7 +1486,7 @@ other examples, you can set \Lkeyword{showoutput} to false.
showoutput=false,
frame,compiler=pdflatex,
crop,
- force,runs=2,code,docType=latex,
+ force=false,runs=2,code,docType=latex,
frame,usefancyvrb]{voss}
%StartVisiblePreamble
\documentclass[chapterprefix=on,parskip=half-,DIV=12,fontsize=12pt]{scrbook}
@@ -1550,7 +1562,7 @@ Whith this definition and the setting \Lkeyset{docType=ltx} the last example loo
frame,
compiler=pdflatex,
showFilename,
- force=true,
+ force=false,
runs=2,code,docType=ltx,
usefancyvrb]{voss}
\documentclass[chapterprefix=on,parskip=half-,DIV=12,fontsize=12pt]{scrreprt}
@@ -1614,7 +1626,7 @@ It is already internally defined.
compiler=mpost,
showFilename,
% crop,
- force=true,
+ force=false,
cleanup,
code,
docType=mp,
@@ -1650,7 +1662,7 @@ It is already internally defined.
compiler=tex,
showFilename,
% crop,
- force=true,
+ force=false,
code,
docType=tex,
ext=tex,]{voss}
@@ -1716,7 +1728,7 @@ not needed. The \texttt{pdf} is directly created.
compiler=lualatex,
showFilename,
crop,
- force=true,
+ force=false,
code,
docType=latex,
ext=tex,]{voss}
@@ -1758,7 +1770,7 @@ not needed. The \texttt{pdf} is directly created.
compiler=context,
showFilename,
runs=2,
- force=true,
+ force=false,
code,
docType=context,
ext=tex,]{voss}
@@ -1769,9 +1781,9 @@ not needed. The \texttt{pdf} is directly created.
\setuphead
[myhead]
[numberstyle=bold,
- textstyle=bold,
- before=\hairline\blank,
- after=\nowhitespace\hairline]
+ textstyle =bold,
+ before =\hairline\blank,
+ after =\nowhitespace\hairline]
%StopVisiblePreamble
\starttext
\startstandardmakeup
@@ -1797,7 +1809,7 @@ not needed. The \texttt{pdf} is directly created.
\chapter[cuyler]{The Cuyler family}
... much later Tydeman Cuyler ...
\input knuth
-\myhead[headlines]{And the end}
+\myhead[headlines]{And the end of all}
foo
\stoptext
\end{externalDocument}
@@ -1829,7 +1841,8 @@ to get the directory listed:
% to get the filename on the right or left of the whole page.
%\item[\Lkeyword{shiftFN}] A length to move the printed filename up or down.
\item[\Lkeyset{force=false}] can speed up the comiling time for the document. If a created image/output
-already exists, there is no need to create it with the next run again and again.
+already exists, there is no need to create it with the next run again and again. \emph This option is not valid
+if the package option \Loption{checkCode} exists.
\item[\Lkeyword{cleanup}] the auxiliary files of a \LaTeX-run are deleted, preset to \texttt{aux}, \texttt{log}.
It must be a comma seperated list of the extensions of the main file, s.g. \texttt{cleanup=\{aux,log\}}.
\item[\Lkeyword{copyToExampleDir}] name of a directory for the examples, must first be created by the user himself