summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/ffcode/ffcode.tex
blob: e14a39517f0ab85a263c859e423a2dfc2aa15591 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
% (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.2.0 2021/06/13}
\begin{document}
\pagenumbering{gobble}
\raggedbottom
\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}
int 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}
int fibo(int n) {
  if (n < 2) {
    return n; |$\label{ln:ret}$|
  }
  return fibo(n - 1) + fibo(n - 2);
}
\end{ffcode}

The line no.~\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.

If you want to omit the light gray frames around \ff{\char`\\ff}
texts, use the package option \ff{noframes}.

To omit the line numbers, use the \ff{nonumbers} option of the package.

More details about this package you can find
in the \ff{yegor256/ffcode} GitHub repository.

\end{document}