Skip to content

Commit

Permalink
Merge branch 'master' into master
Browse files Browse the repository at this point in the history
  • Loading branch information
Qrrbrbirlbel authored Oct 28, 2024
2 parents d281941 + 6e970a1 commit 3b2e7e7
Show file tree
Hide file tree
Showing 55 changed files with 266 additions and 204 deletions.
5 changes: 5 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# https://github.com/github-linguist/linguist/blob/master/docs/overrides.md#using-gitattributes
*.cfg linguist-language=tex
*.def linguist-language=tex
*.lvt linguist-language=tex
*.pvt linguist-language=tex
2 changes: 1 addition & 1 deletion .github/workflows/check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ jobs:
- name: Archive failed test output
if: failure()
uses: actions/upload-artifact@v3
uses: actions/upload-artifact@v4
with:
name: test-diff-files
path: build/test*/*.diff
23 changes: 22 additions & 1 deletion .github/workflows/doc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,32 @@ jobs:
run: |
l3build doc -q
- uses: actions/upload-artifact@v3
- name: Analyze manual log
run: |
# set a notice message
# https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions?tool=bash#setting-a-notice-message
# create multiline annotations by using URL-encoded newline "%0A"
# https://github.com/actions/toolkit/issues/193#issuecomment-605394935
OVERFULL_HBOX=$(
grep -r '^Overfull \\hbox' build/doc/pgfmanual.log |
awk 'BEGIN {RS=""}{gsub(/\n/,"%0A",$0); print $0}'
)
echo "::notice file=build/doc/pgfmanual.log,title=Overfull hbox(es)::$OVERFULL_HBOX"
- name: Upload manual
uses: actions/upload-artifact@v4
with:
name: pgfmanual
path: build/doc/pgfmanual.pdf

- name: Upload manual with aux
uses: actions/upload-artifact@v4
with:
name: pgfmanual-with-aux
path: |
build/doc/pgfmanual.*
!build/doc/pgfmanual.tex
- name: Deploy tlcontrib
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ jobs:
run: |
l3build ctan
- uses: actions/upload-artifact@v3
- uses: actions/upload-artifact@v4
with:
name: pgfmanual
path: build/doc/pgfmanual.pdf
Expand Down Expand Up @@ -89,7 +89,7 @@ jobs:
body_path: RELEASE_NOTES.md

- name: "Release: upload assets"
uses: actions/github-script@v6
uses: actions/github-script@v7
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
script: |
Expand Down
17 changes: 1 addition & 16 deletions build.lua
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,13 @@ docfiledir = "./doc/generic/pgf"
docfiles =
{
"RELEASE_NOTES.md", "description.html", -- Part of the release script
"color.cfg", "pgfmanual.cfg", "images/*.jpg", "*.tex" -- Build the PDF
"color.cfg", "pgfmanual.cfg", "images", "plots", "*.tex" -- Build the manual
}
tdsroot = "generic"
typesetfiles = {"pgfmanual.tex"}
typesetexe = "lualatex"
flatten = false

-- To allow writing
function docinit_hook()
mkdir(typesetdir .. "/plots")
return 0
end

-- Set up to allow testing dvips, etc.
specialformats = specialformats or {}
specialformats["latex"] = specialformats["latex"] or
Expand All @@ -43,9 +37,6 @@ checkengines = {"pdftex", "latexdvips", "latexdvisvgm", "luatex", "xetex"}
-- Use multiple sets of tests
checkconfigs = { "build", "config-gd" }

--- Keep all \special data (may one day be the l3build default)
maxprintline = 9999

-- For release
ctanzip = "pgf.ctan.flatdir"
packtdszip = true
Expand Down Expand Up @@ -89,9 +80,3 @@ function tag_hook(tagname, tagdate)
return 0
end

target_list = target_list or { }
target_list.revisionfile =
{
desc = "Create revision data file",
func = revisionfile
}
22 changes: 22 additions & 0 deletions doc/generic/pgf/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,23 +10,45 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).

### Added

- Add `RGB` and `gray` color model support for ConTeXt #1130

### Fixed

- Typo in animations `end on` key #1273
- `sloped` should consider the current transformation #1058
- Output bounding box adjustment in pgfsys-dvisvgm.def #1275
- Fix shadings under LuaMetaTeX
- Resolve missing `gnuplot` plots in manual #1238
- Treat varargs for `min` and `max` in `luamath` pgf-tikz/pgfplots#492 #1359
- Fixed support for the `\tikz` command in the `dvisvgm4ht` driver for TeX4ht

### Changed

- Typo fixes in the manual
- Simplify short verb `|...|` or add required preamble for it
- Harden parser for math expressions against active chars
- Resolve overfull hboxes >=20pt in the manual
- Adapt `\graphicspath` setting for flattened doc tree #1191
- Promote warning "Plot data file \`...' not found" to error
- Allow empty value for /pgf/arrow keys/fill to make it behave more like /tikz/fill #1352
- Added support for alt text in the `dvisvgm4ht` driver for TeX4ht

### Contributors

- Andreas Deininger
- Joseph Wright
- Marcel Krüger
- Matthias Hetzenberger
- Qrrbrbirlbel
- quark67
- thinbold
- Yukai Chou (muzimuzhi)
- Rocky Zhang (@rockyzhz)
- Romano Giannetti (@rmano)
- Yukai Chou (@muzimuzhi)
- Alexander Grahn
- Max Chernoff
- Volker Diels-Grabsch

## [3.1.10] - 2023-01-13 Henri Menke

Expand Down
2 changes: 1 addition & 1 deletion doc/generic/pgf/pgfmanual-en-base-shadings.tex
Original file line number Diff line number Diff line change
Expand Up @@ -357,7 +357,7 @@ \subsubsection{General (Functional) Shadings}
defined, which store the individual components of \meta{color name}.
These can also be used in the \meta{type 4 function} argument.
%
\begin{codeexample}[]
\begin{codeexample}[preamble={\usepackage{shortvrb} \MakeShortVerb{\|}}]
\pgfshadecolortorgb{orange}{\mycol}
|\mycol|=\mycol |\mycolred|=\mycolred |\mycolgreen|=\mycolgreen |\mycolblue|=\mycolblue
\end{codeexample}
Expand Down
2 changes: 1 addition & 1 deletion doc/generic/pgf/pgfmanual-en-dv-visualizers.tex
Original file line number Diff line number Diff line change
Expand Up @@ -740,7 +740,7 @@ \subsection{Advanced: Creating New Visualizers}
Now, let's see how this works:

% TODOsp: codeexamples: This stuff is all needed for the next `codeexample`
% but cannot be stored (simply) in `setup code`, `preample` or `pre`
% but cannot be stored (simply) in `setup code`, `preamble` or `pre`
\pgfooclass{circle visualizer} {
% Stores the name of the visualizer. This is needed for filtering
% and configuration
Expand Down
2 changes: 1 addition & 1 deletion doc/generic/pgf/pgfmanual-en-gd-algorithms-in-c.tex
Original file line number Diff line number Diff line change
Expand Up @@ -755,7 +755,7 @@ \subsubsection{The Hello World of Graph Drawing in OGDF -- Adapting Existing Cla
// File HelloWorldLayout.h
#include <ogdf/module/LayoutModule.h>

class HelloWorldLayout : puplic ogdf::LayoutModule {
class HelloWorldLayout : public ogdf::LayoutModule {
public:

virtual void call(ogdf::GraphAttributes &GA)
Expand Down
6 changes: 3 additions & 3 deletions doc/generic/pgf/pgfmanual-en-gd-usage-pgf.tex
Original file line number Diff line number Diff line change
Expand Up @@ -410,9 +410,9 @@ \subsubsection{Graph Drawing Scopes}
|(10pt,20pt)--(30pt,40pt)| in \tikzname-syntax and may include the path
commands |--|, |..| (followed by Bézier coordinates), and |--cycle|.

The parameter \meta{animations} contains algorithmically-generated
animation commands (calls to |\pgfanimateattribute|. The |whom| will be set
to |pgf@gd|.
The last parameter \meta{animations} contains algorithmically-generated
animation commands (calls to |\pgfanimateattribute|). The |whom|
will be set to |pgf@gd|.

The default \meta{macro} simply draws a line between the nodes. When the
|graphdrawing| library of the \tikzname\ layer is loaded, a more fancy
Expand Down
2 changes: 1 addition & 1 deletion doc/generic/pgf/pgfmanual-en-introduction.tex
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ \section{Introduction}
will teach you almost all you should know about \tikzname\ without your having
to read the rest.

I wish to start with the questions ``What is \tikzname?'' Basically, it just
I wish to start with the question ``What is \tikzname?'' Basically, it just
defines a number of \TeX\ commands that draw graphics. For example, the code
|\tikz \draw (0pt,0pt) -- (20pt,6pt);| yields the line \tikz \draw (0pt,0pt) --
(20pt,6pt); and the code |\tikz \fill[orange] (1ex,1ex) circle (1ex);| yields
Expand Down
11 changes: 6 additions & 5 deletions doc/generic/pgf/pgfmanual-en-library-automata.tex
Original file line number Diff line number Diff line change
Expand Up @@ -284,10 +284,11 @@ \subsection{Examples}
are orange. Then, we must find a path from a red state to a green state.
%
\begin{codeexample}[preamble={\usetikzlibrary{arrows.meta,automata,positioning,shadows}}]
\begin{tikzpicture}[shorten >=1pt,node distance=2cm,on grid,>={Stealth[round]},thick,
every state/.style={fill,draw=none,orange,text=white,circular drop shadow},
accepting/.style ={green!50!black,text=white},
initial/.style ={red,text=white}]
\begin{tikzpicture}
[shorten >=1pt,node distance=2cm,on grid,>={Stealth[round]},thick,
every state/.style={fill,draw=none,orange,text=white,circular drop shadow},
accepting/.style ={green!50!black,text=white},
initial/.style ={red,text=white}]

\node[state,initial] (q_0) {$q_0$};
\node[state] (q_1) [above right=of q_0] {$q_1$};
Expand All @@ -306,7 +307,7 @@ \subsection{Examples}
The next example is the current candidate for the five-state busiest beaver:
%
\begin{codeexample}[preamble={\usetikzlibrary{arrows.meta,automata,positioning}}]
\begin{tikzpicture}[->,>={Stealth[round]},shorten >=1pt,%
\begin{tikzpicture}[->,>={Stealth[round]},shorten >=1pt,
auto,node distance=2cm,on grid,semithick,
inner sep=2pt,bend angle=45]
\node[initial,state] (A) {$q_a$};
Expand Down
2 changes: 1 addition & 1 deletion doc/generic/pgf/pgfmanual-en-library-calendar.tex
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,7 @@ \subsection{Calendar Command}
\end{codeexample}
\end{key}

\begin{key}{/tikz/every day (initially anchor=base east)}
\begin{key}{/tikz/every day (initially {anchor=base east})}
This style is executed by the default node code for each day. The
|every day| style is useful for changing the way days look. For
example, let us make all days red:
Expand Down
2 changes: 1 addition & 1 deletion doc/generic/pgf/pgfmanual-en-library-circuits.tex
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ \subsubsection{A First Example}
\emph{exactly the same source code}, with only the options of the
|{tikzpicture}| environment replaced by
|[rotate=-90,circuit ee IEC,x=3.25cm,y=2.25cm]|:
%

\begin{tikzpicture}[rotate=-90,circuit ee IEC,x=3cm,y=2.25cm]
% Let us start with some contacts:
\foreach \contact/\y in {1/1,2/2,3/3.5,4/4.5,5/5.5}
Expand Down
4 changes: 2 additions & 2 deletions doc/generic/pgf/pgfmanual-en-library-math.tex
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,8 @@ \subsection{Overview}
if \n == 0 then {
return 0;
} else {
return fibonacci2(\n, 0, 1);
};
return fibonacci2(\n, 0, 1);
};
};
function fibonacci2(\n, \p, \q) {
if \n == 1 then {
Expand Down
5 changes: 3 additions & 2 deletions doc/generic/pgf/pgfmanual-en-library-patterns.tex
Original file line number Diff line number Diff line change
Expand Up @@ -221,8 +221,9 @@ \subsection{User-Defined Patterns}
just rotate in the drawing code.

\begin{pattern}{Lines}
The |Lines| pattern replaces the |horizontal lines|, |vertical lines|,
|north east lines|, and |north west lines| patterns. Unfortunately, due to
The |Lines| pattern replaces four patterns: |horizontal lines|,
|vertical lines|, |north east lines|, and |north west lines|.
Unfortunately, due to
the way the old patterns are constructed, namely that they are not simply
related to each other by rotation, the |Lines| pattern cannot be used as a
drop-in replacement.
Expand Down
10 changes: 5 additions & 5 deletions doc/generic/pgf/pgfmanual-en-library-rdf.tex
Original file line number Diff line number Diff line change
Expand Up @@ -254,16 +254,16 @@ \subsection{Creating Statements}
\item As for |subject| and |predicate|, you can use the syntax
|(|\meta{name of node or scope}|)| to create and use a curie
for the node or scope.
\item If the \meta{object} starts with |"|, it must have the syntax
|"|\meta{literals}|"|. In this case, the object of the
\item If the \meta{object} starts with |"| and is of the form
|"|\meta{literals}|"|, the object of the
statement is not a curie (not a normal ``resource'') but the
string of \meta{literals} given.
\item If the \meta{object} is the text ``|scope content|'', the
object of the statement is actually the whole contents of the
scope to which this statement is attached.
\item The two previous cases can be combined in the form of an
object of the form |"|\meta{literals}|" and scope content|. In
this case, the contents of the scope is ``normally'' the
\item Finally if the \meta{object} is of the form
|"|\meta{literals}|" and scope content|, the contents of the
scope is ``normally'' the
object, but this gets ``overruled'' by the \meta{literals}.
Formally, this means that the object is the \meta{literals},
but the intended semantics is that the object is the scope
Expand Down
2 changes: 1 addition & 1 deletion doc/generic/pgf/pgfmanual-en-library-shapes.tex
Original file line number Diff line number Diff line change
Expand Up @@ -461,7 +461,7 @@ \subsection{Geometric Shapes}
Sets the angle of the apex of the isosceles triangle.
\end{key}

\begin{key}{/pgf/isosceles triangle stretches=\meta{boolean} (default true)}
\begin{key}{/pgf/isosceles triangle stretches=\meta{boolean} (default false)}
By default \meta{boolean} is |false|. This means, that when applying
any minimum width or minimum height requirements, increasing the height
will increase the width (and vice versa), in order to keep the apex
Expand Down
11 changes: 2 additions & 9 deletions doc/generic/pgf/pgfmanual-en-main-preamble.tex
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@
perspective,
}

\usepackage{ifluatex}
\usepackage{iftex}
\newif\ifgdccodebasic
\newif\ifgdccodeogdf

Expand Down Expand Up @@ -168,22 +168,15 @@
% required by luatextra. Needs to be \relaxed since
% pgfmanual-en-macros.tex defines an environment named filedescription
\let\filedescription\relax
\usepackage[utf8]{luainputenc}
% dvisvgm does not support OpenType fonts so we have to bite the bullet and
% use T1 where quotes are weird. In LuaTeX \outputmode=0 means DVI.
\ifnum\outputmode=0
\usepackage[T1]{fontenc}
\fi
\else
\usepackage[utf8]{inputenc}
\usepackage[T1]{fontenc}
\fi

% Promote `Missing character` reports to full errors
% require texlive 2021 or above
\tracinglostchars=3

\graphicspath{{../../images/}}
\graphicspath{{images/}}
\input{pgfmanual-en-macros}

\usepackage{todonotes}
Expand Down
2 changes: 1 addition & 1 deletion doc/generic/pgf/pgfmanual-en-pgffor.tex
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ \section{Repeating Things: The Foreach Statement}
``missing values''. More precisely, the following happens:

Normally, when a list item |...| is encountered, there should already have
been \emph{two} list items before it, which where numbers. Examples of
been \emph{two} list items before it, which were numbers. Examples of
\emph{numbers} are |1|, |-10|, or |-0.24|. Let us call these numbers $x$
and $y$ and let $d := y-x$ be their difference. Next, there should also be
one number following the three dots, let us call this number~$z$.
Expand Down
10 changes: 5 additions & 5 deletions doc/generic/pgf/pgfmanual-en-pgfkeys.tex
Original file line number Diff line number Diff line change
Expand Up @@ -565,12 +565,12 @@ \subsubsection{Keys That Execute Commands}
``\meta{text}|+|\meta{more text}'' and wishes to store \meta{text} and
\meta{more text} in two different macros. This can be achieved as follows:
%
\begin{codeexample}[]
\begin{codeexample}[preamble={\usepackage{shortvrb} \MakeShortVerb{\|}}]
\def\mystore#1+#2\pgfeov{\def\a{#1}\def\b{#2}}
\pgfkeyslet{/my key/.@cmd}{\mystore}
\pgfkeys{/my key=hello+world}

|\a| is \a, |\b| is \b.
|\a| is `\a', |\b| is `\b'.
\end{codeexample}

Naturally, defining the code to be stored in a key in the above manner is too
Expand Down Expand Up @@ -604,7 +604,7 @@ \subsubsection{Keys That Execute Commands}
This command works like |\pgfkeysdef|, but it allows you to provide an
arbitrary \meta{argument count} between $0$ and $9$ (inclusive).
%
\begin{codeexample}[]
\begin{codeexample}[preamble={\usepackage{shortvrb} \MakeShortVerb{\|}}]
\pgfkeysdefnargs{/my key}{2}{\def\a{#1}\def\b{#2}}
\pgfkeys{/my key=
{hello}
Expand All @@ -624,11 +624,11 @@ \subsubsection{Keys That Execute Commands}
This command works like |\pgfkeysdefnargs|, but it allows you to provide an
arbitrary \meta{argument pattern} rather than just a number of arguments.
%
\begin{codeexample}[]
\begin{codeexample}[preamble={\usepackage{shortvrb} \MakeShortVerb{\|}}]
\pgfkeysdefargs{/my key}{#1+#2}{\def\a{#1}\def\b{#2}}
\pgfkeys{/my key=hello+world}

|\a| is \a, |\b| is \b.
|\a| is `\a', |\b| is `\b'.
\end{codeexample}
%
Note that |\pgfkeysdefnargs| is \emph{better} when it comes to simple
Expand Down
Loading

0 comments on commit 3b2e7e7

Please sign in to comment.