summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/hvextern/hvextern.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/hvextern/hvextern.tex')
-rw-r--r--Master/texmf-dist/doc/latex/hvextern/hvextern.tex37
1 files changed, 25 insertions, 12 deletions
diff --git a/Master/texmf-dist/doc/latex/hvextern/hvextern.tex b/Master/texmf-dist/doc/latex/hvextern/hvextern.tex
index a170457a7d6..d691aa3bed0 100644
--- a/Master/texmf-dist/doc/latex/hvextern/hvextern.tex
+++ b/Master/texmf-dist/doc/latex/hvextern/hvextern.tex
@@ -30,7 +30,7 @@ from within a main\newline \LaTeX\ document~--v. \hvexternFileversion}
%\newpage
-\setkeys{hv}{moveToExampleDir,ExampleDir=Examples,showFilename,verbose}
+\setkeys{hv}{moveToExampleDir,ExampleDir=Exa,showFilename,verbose}
\section{Syntax}
\begin{verbatim}
@@ -268,6 +268,18 @@ image.save(imageName+".png", "PNG")
\end{externalDocument}
+The external filename, extended by a consequtive number, kan be printed in the
+margin by setting the keyword \Lkeyword{showFilename}. In general it is printed
+in the outer margin or in twocolumn mode in the outer column. If the example is
+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.
+
+A vertical shift of the filename is possible by setting a length to the keyword \Lkeyword{shiftFN},
+e.g. \texttt{shiftFN=5ex}.
+
+
+\clearpage%%%%%%%%%%%%
\begin{externalDocument}[grfOptions={width=0.95\linewidth},
compiler=xelatex,code,mpwidth=0.6\linewidth,
@@ -412,9 +424,6 @@ Sort with xindex \verb|-l DE --config AU|
\end{externalDocument}
-
-
-
The following \Java-program creates the Mandelbrot set as png image. The valid setting for
the environment \Lenv{externalDocument} is:
@@ -681,6 +690,7 @@ The following example uses:
\begin{externalDocument}[
pages={1,2,3},
pagesep=2pt,
+ shiftFN=5ex,
grfOptions={width=0.3\linewidth},
% lstOptions={fontsize=\small,fontfamily=tt},
compiler=lualatex, runs=2,
@@ -690,7 +700,7 @@ The following example uses:
% mpwidth=0.6\linewidth,
% crop,
cleanup,
- force=true,
+ force=false,
frame,
% usefancyvrb,
% float,
@@ -743,7 +753,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,
@@ -1016,7 +1026,7 @@ not part of your current font.
\hv@extern@showFilenamefalse}
\end{verbatim}
-With the setting \LKeyset{inline=true} the optional keyword \Lkeyword{code}
+With the setting \LKeyset{inline=true} the optional keyword \Lkeyword{code} and \Lkeyword{showFilename}
is automatically set to false. The
next Chinese characters
\begin{externalDocument}[
@@ -1078,7 +1088,7 @@ sorted digits of the number $A$: $495=954-459$.
\begin{externalDocument}[
compiler=perl, force=false, docType=pl, ext=pl, includegraphic=false,
- code, mpwidth=0.6\linewidth, showFilename=false]{voss}
+ code, mpwidth=0.6\linewidth]{voss}
#!/usr/bin/perl
#
# Herbert Voss 2005-05-31
@@ -1133,7 +1143,8 @@ outFile = io.open(shortFN..".txt","w+") -- open external file
\begin{externalDocument}[
compiler=lua, force=false, docType=lua, ext=lua, includegraphic=false,
- code, usefancyvrb=false,textOptions={basicstyle=\ttfamily\footnotesize}]{voss}
+ code, usefancyvrb=false,textOptions={basicstyle=\ttfamily\footnotesize},
+ shiftFN=6ex]{voss}
#!/usr/bin/env lua
local filename = arg[0]
local shortFN = filename:match("(.+)%..+")
@@ -1211,7 +1222,6 @@ The following examples uses
xindexOptions={-l DE --config AU},
mpwidth=0.6\linewidth,
usefancyvrb=false,
- showFilename=false,
docType=latex]{voss}
\documentclass[paper=a6,DIV=18,parskip=half-]{screxa}
\pagestyle{empty}
@@ -1262,7 +1272,6 @@ runsequence={lualatex,biber,{xindex -l de -c AU},lualatex,lualatex}
pagesep=2pt,
frame,
runsequence={lualatex,biber,xindex -l de -c AU,lualatex,lualatex},
- showFilename,
verbose,
force=false,
cleanup={log,aux,toc,bbl,blg},
@@ -1304,7 +1313,6 @@ The default is using \Lcs{lstinputlisting} for the printed code sequences.
grfOptions={width=0.45\linewidth},
pages={1,3},
frame,compiler=pdflatex,
- showFilename,
% crop,
force=false,runs=2,code,docType=latex,
frame,
@@ -1641,6 +1649,11 @@ to get the directory listed:
\section{Other options}
\begin{description}
+%\item[\Lkeyword{showFilename}] Prints the filename in the outer margin (right for oneside) or in twocolumn mode for
+% the first column in the left and the second column in the right margin.
+%\item[\Lkeyword{outerFN}] Only valid for the twocolumn mode with onecolumn floats (environment \texttt{figure*}),
+% 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.
\item[\Lkeyword{cleanup}] the auxiliary files of a \LaTeX-run are deleted, preset to \texttt{aux}, \texttt{log}.