summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/docshots/docshots.dtx
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2022-10-15 20:25:06 +0000
committerKarl Berry <karl@freefriends.org>2022-10-15 20:25:06 +0000
commitec281bf8032a69f84b4b584c76158dc2c6ecdb57 (patch)
tree98c0d66a83e8f15a5f3384d7e6a471ab2ccbfc6a /Master/texmf-dist/source/latex/docshots/docshots.dtx
parent3f6f2deec08918d9165fe4c72bcf4b8380c299c6 (diff)
docshots (14oct22)
git-svn-id: svn://tug.org/texlive/trunk@64716 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/source/latex/docshots/docshots.dtx')
-rw-r--r--Master/texmf-dist/source/latex/docshots/docshots.dtx203
1 files changed, 203 insertions, 0 deletions
diff --git a/Master/texmf-dist/source/latex/docshots/docshots.dtx b/Master/texmf-dist/source/latex/docshots/docshots.dtx
new file mode 100644
index 00000000000..3fa5c9ac13a
--- /dev/null
+++ b/Master/texmf-dist/source/latex/docshots/docshots.dtx
@@ -0,0 +1,203 @@
+% \iffalse meta-comment
+% (The MIT License)
+%
+% Copyright (c) 2021-2022 Yegor Bugayenko
+%
+% Permission is hereby granted, free of charge, to any person obtaining a copy
+% of this software and associated documentation files (the 'Software'), to deal
+% in the Software without restriction, including without limitation the rights
+% to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+% copies of the Software, and to permit persons to whom the Software is
+% furnished to do so, subject to the following conditions:
+%
+% The above copyright notice and this permission notice shall be included in all
+% copies or substantial portions of the Software.
+%
+% THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+% IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+% FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+% AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+% LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+% OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+% SOFTWARE.
+% \fi
+
+% \CheckSum{0}
+%
+% \CharacterTable
+% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z
+% Lower-case \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z
+% Digits \0\1\2\3\4\5\6\7\8\9
+% Exclamation \! Double quote \" Hash (number) \#
+% Dollar \$ Percent \% Ampersand \&
+% Acute accent \' Left paren \( Right paren \)
+% Asterisk \* Plus \+ Comma \,
+% Minus \- Point \. Solidus \/
+% Colon \: Semicolon \; Less than \<
+% Equals \= Greater than \> Question mark \?
+% Commercial at \@ Left bracket \[ Backslash \\
+% Right bracket \] Circumflex \^ Underscore \_
+% Grave accent \` Left brace \{ Vertical bar \|
+% Right brace \} Tilde \~}
+
+% \GetFileInfo{docshots.dtx}
+% \DoNotIndex{\endgroup,\begingroup,\let,\else,\s,\n,\r,\\,\1,\fi}
+
+% \iffalse
+%<*driver>
+\ProvidesFile{docshots.dtx}
+%</driver>
+%<package>\NeedsTeXFormat{LaTeX2e}
+%<package>\ProvidesPackage{docshots}
+%<*package>
+[2022-10-14 0.0.1 TeX Samples Next to Their PDF Snapshots in DTX]
+%</package>
+%<*driver>
+\documentclass{ltxdoc}
+\usepackage[tt=false, type1=true]{libertine}
+\usepackage{microtype}
+\usepackage{docshots}
+\usepackage{href-ul}
+\PageIndex
+\EnableCrossrefs
+\CodelineIndex
+\RecordChanges
+\begin{document}
+ \DocInput{docshots.dtx}
+ \PrintChanges
+ \PrintIndex
+\end{document}
+%</driver>
+% \fi
+
+% \title{|docshots|: \TeX{} Samples Next to Their \\ PDF Snapshots in DTX\thanks{The sources are in GitHub at \href{https://github.com/yegor256/docshots}{yegor256/docshots}}}
+% \author{Yegor Bugayenko \\ \texttt{yegor256@gmail.com}}
+% \date{\filedate, \fileversion}
+%
+% \maketitle
+%
+% \textbf{NB!}
+% You must run \TeX{} processor with |--shell-escape| option
+% and you must have \href{https://www.perl.org}{Perl} installed.
+
+% \section{Introduction}
+%
+% You put this into your |.dtx| file:
+%
+% \vspace{0pt}\begingroup\ttfamily\noindent
+% \% \char`\\begin\char`\{docshot\char`\} \\
+% \% \char`\\documentclass\char`\{article\char`\} \\
+% \% \char`\\begin\char`\{document\char`\} \\
+% \% \char`\\pagestyle\char`\{empty\char`\} \\
+% \% ~~Hello, \char`\\LaTeX! \\
+% \% \char`\\end\char`\{document\char`\} \\
+% \% \char`\\end\char`\{docshot\char`\}
+% \endgroup\vspace{0pt}
+%
+% It will be rendered as such:
+%
+% \begin{docshot}
+% \documentclass{article}
+% \begin{document}
+% \pagestyle{empty}
+% Hello, \LaTeX!
+% \end{document}
+% \end{docshot}
+
+% Here is a more complex example:
+%
+% \begin{docshot}
+% \documentclass{article}
+% \usepackage{tikz}
+% \begin{document}\pagestyle{empty}
+% \begin{tikzpicture}
+% \node [circle,draw] (v0) {$v_0$};
+% \node [circle,draw,
+% below right of=v0] (v1) {$v_1$};
+% \draw [->] (v0) -- (v1);
+% \end{tikzpicture}
+% \end{document}
+% \end{docshot}
+
+% The pictures you see on the left sides are rendered by a subprocess
+% executing |pdflatex| with the |.tex| content taken from |dtx| file.
+% After a successful processing of \TeX{} sources, we use
+% \href{https://ctan.org/pkg/pdfcrop}{pdfcrop} to trim the document. Then,
+% the trimmed PDF is embedded into the final document.
+
+% \StopEventually{}
+
+% \section{Implementation}
+
+% \changes{v0.0.1}{2022/10/09}{Initial version}
+
+% First, we include a few packages:
+% \begin{macrocode}
+\RequirePackage{iexec}
+\RequirePackage{fancyvrb}
+\RequirePackage{xcolor}
+\RequirePackage{graphicx}
+\RequirePackage{tikz}
+\usetikzlibrary{shadows.blur}
+% \end{macrocode}
+
+% Then, we show the version of |pdflatex|:
+% \begin{macrocode}
+\iexec[log,quiet]{pdflatex --version}%
+% \end{macrocode}
+
+% Then, we show the version of |pdfcrop|:
+% \begin{macrocode}
+\iexec[log,quiet]{pdfcrop --version}%
+% \end{macrocode}
+
+% Then, we show the version of |ghostscript|:
+% \begin{macrocode}
+\iexec[log,quiet]{gs --version}%
+% \end{macrocode}
+
+% Then, we make a directory where all temporary files will be kept:
+% \begin{macrocode}
+\iexec[null]{mkdir -p _docshots/\jobname}%
+% \end{macrocode}
+
+% \begin{macro}{docshot}
+% Then, we define |docshot| environment:
+% \begin{macrocode}
+\newenvironment{docshot}
+{\VerbatimEnvironment\begin{VerbatimOut}{_docshots/\jobname/verbatim.tex}}
+{\end{VerbatimOut}%
+ \iexec[null]{perl -i -0777pe "s/(\\n|^)\\x{25} /\\1/g"
+ _docshots/\jobname/verbatim.tex}%
+ \def\hash{\pdfmdfivesum file {_docshots/\jobname/verbatim.tex}}%
+ \message{^^Jdocshots: name set to "\hash"^^J}%
+ \iexec[log,quiet]{cp _docshots/\jobname/verbatim.tex
+ _docshots/\jobname/\hash.tex}%
+ \iexec[log,quiet]{(cd _docshots/\jobname;
+ pdflatex -interaction=batchmode -shell-escape \hash.tex)}%
+ \iexec[log,quiet]{pdfcrop --margins 5 _docshots/\jobname/\hash.pdf
+ _docshots/\jobname/\hash.crop.pdf}%
+ \fvset{frame=leftline,numbers=left,numbersep=3pt,
+ framerule=.4pt,rulecolor=\color{gray},
+ samepage=true}%
+ \par%
+ \tikz[baseline=(a.north)] \node[draw=gray] (a)
+ {\includegraphics[width=.3\linewidth]{_docshots/\jobname/\hash.crop.pdf}};%
+ \hspace{1.8em}%
+ \begin{minipage}[t]{.65\linewidth}%
+ \vspace{0pt}%
+ \VerbatimInput{_docshots/\jobname/\hash.tex}%
+ \vspace{0pt}%
+ \end{minipage}%
+ \par%
+}
+% \end{macrocode}
+% \end{macro}
+
+% \Finale
+
+%\clearpage
+
+%\PrintChanges
+%\clearpage
+%\PrintIndex