diff options
author | Karl Berry <karl@freefriends.org> | 2021-06-11 15:53:27 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2021-06-11 15:53:27 +0000 |
commit | f8b1cbc1449ba06de5f9aeefc824f4afc1a2b115 (patch) | |
tree | 1f82a8a15ab1b2c9416fef47a98efaa884e95d70 /Master/texmf-dist/doc | |
parent | e50b9b4afdd29cf778579c72fff7d0f6ac7c6248 (diff) |
ffcode (11jun21)
git-svn-id: svn://tug.org/texlive/trunk@59549 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc')
-rw-r--r-- | Master/texmf-dist/doc/latex/ffcode/DEPENDS.txt | 5 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/ffcode/README.md | 31 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/ffcode/ffcode.pdf | bin | 0 -> 107272 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/ffcode/ffcode.tex | 89 |
4 files changed, 125 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/ffcode/DEPENDS.txt b/Master/texmf-dist/doc/latex/ffcode/DEPENDS.txt new file mode 100644 index 00000000000..e1cb6ed5640 --- /dev/null +++ b/Master/texmf-dist/doc/latex/ffcode/DEPENDS.txt @@ -0,0 +1,5 @@ +hard microtype +hard xkeyval +hard minted +hard minted +hard tcolorbox diff --git a/Master/texmf-dist/doc/latex/ffcode/README.md b/Master/texmf-dist/doc/latex/ffcode/README.md new file mode 100644 index 00000000000..1c95d6ece31 --- /dev/null +++ b/Master/texmf-dist/doc/latex/ffcode/README.md @@ -0,0 +1,31 @@ +[](https://github.com/yegor256/ffcode/actions/workflows/make.yml) +[](https://github.com/yegor256/ffcode/blob/master/LICENSE.txt) + +This LaTeX package helps you write source code in your academic papers +and make sure it looks neat. + +First, [install it](https://en.wikibooks.org/wiki/LaTeX/Installing_Extra_Packages) +from [CTAN](https://ctan.org/pkg/ffcode) +and then use in the preamble: + +```tex +\documentclass{article} +\usepackage{ffcode} +\begin{document} +The function \ff{r()} reads the file: +\begin{ffcode} +void r() { + // read the file +} +\end{ffcode} +\end{document} +``` + +The full example and all commands are available in the +[`ffcode.tex`](https://github.com/yegor256/ffcode/blob/master/ffcode.tex) file. + +If you want to contribute yourself, make a fork, then create a branch, +then run `make` in the root directory. +It should compile everything without errors. If not, submit an issue and wait. +Otherwise, make your changes and then run `make` again. If the build is +still clean, submit a pull request. diff --git a/Master/texmf-dist/doc/latex/ffcode/ffcode.pdf b/Master/texmf-dist/doc/latex/ffcode/ffcode.pdf Binary files differnew file mode 100644 index 00000000000..ee829bd0373 --- /dev/null +++ b/Master/texmf-dist/doc/latex/ffcode/ffcode.pdf diff --git a/Master/texmf-dist/doc/latex/ffcode/ffcode.tex b/Master/texmf-dist/doc/latex/ffcode/ffcode.tex new file mode 100644 index 00000000000..dcefc532682 --- /dev/null +++ b/Master/texmf-dist/doc/latex/ffcode/ffcode.tex @@ -0,0 +1,89 @@ +% (The MIT License) +% +% Copyright (c) 2021 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. + +\documentclass[12pt]{article} +\usepackage[tt=false,type1=true]{libertine} +\usepackage{amsmath} +\usepackage{multicol} +\usepackage{ffcode} +\title{\ff{ffcode}: \LaTeX{} Package \\ for Fixed-Font Code Blocks} +\author{Yegor Bugayenko} +\date{0.1.0 2021/06/10} +\begin{document} +\pagenumbering{gobble} +\raggedbottom +\setlength{\topskip}{0mm} +\setlength{\parindent}{0pt} +\setlength{\columnsep}{32pt} +\setlength{\parskip}{6pt} +\maketitle + +This package helps you write source code in your articles +and make sure it looks nice. Install it from CTAN and then +use like this (pay attention to the \ff{\char`\\ff} command +and the \ff{ffcode} environment): + +\begin{multicols}{2} +\setlength{\parskip}{0pt} +\scriptsize +\raggedcolumns +\begin{verbatim}\documentclass{article} +\usepackage{ffcode} +\begin{document} +The function \ff{fibo()} is recursive: +\begin{ffcode} +void fibo(int n) { + if (n < 2) { + return n; |$\label{ln:ret}$| + } + return fibo(n - 1) + fibo(n - 2); +} +\end{ffcode} +The line~\ref{ln:ret} terminates it. +\end{document} +\end{verbatim} + +\columnbreak + +The function \ff{fibo()} is recursive: + +\begin{ffcode} +void fibo(int n) { + if (n < 2) { |$\label{ln:ret}$| + return n; + } + return fibo(n - 1) + fibo(n - 2); +} +\end{ffcode} + +The line~\ref{ln:ret} terminates it. +\end{multicols} + +You have to run \ff{pdflatex} with the \ff{--shell-escape} flag +in order to let \ff{minted} (the package we use) to run Pygments +and format the code. If you don't want this to happen, +just use the \ff{nopygments} option. + +More details about this package you can find +in the \ff{yegor256/ffcode} GitHub repository. + +\end{document}
\ No newline at end of file |