Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Resolve large-enough overfull hboxes #1210

Merged
merged 2 commits into from
Dec 26, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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@v4
- 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
1 change: 1 addition & 0 deletions doc/generic/pgf/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
- 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

### Contributors

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
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-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
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
6 changes: 5 additions & 1 deletion doc/generic/pgf/pgfmanual-en-pgfsys-commands.tex
Original file line number Diff line number Diff line change
Expand Up @@ -922,10 +922,14 @@ \subsection{Transparency System Commands}
transformation should not apply to the following graphics, however.
\end{command}

\pagebreak[2]
Mo-Gul marked this conversation as resolved.
Show resolved Hide resolved
\begin{command}{\pgfsys@clipfading}
This command has a default implementation and need not be implemented by
driver files other than |pgfsys-dvips.def|. The macro is called
in |\pgfsetfadingforcurrentpath| and |\pgfsetfadingforcurrentpathstroked|
in
\begin{quote}
|\pgfsetfadingforcurrentpath| and |\pgfsetfadingforcurrentpathstroked|
\end{quote}
of the basic layer, where it invokes the current path for clipping the
shading just before installing it as an opacity mask for fading. The
default implementation is actually a non-operation, but with |dvips| it
Expand Down
11 changes: 6 additions & 5 deletions doc/generic/pgf/pgfmanual-en-tikz-transparency.tex
Original file line number Diff line number Diff line change
Expand Up @@ -455,9 +455,9 @@ \subsubsection{Creating Fadings}
%
\begin{codeexample}[preamble={\usetikzlibrary{fadings,patterns}}]
\begin{tikzfadingfrompicture}[name=tikz]
\node [text=transparent!20]
{\fontencoding{T1}\fontfamily{ptm}\fontsize{45}{45}\bfseries\selectfont
Ti\emph{k}Z};
\node [text=transparent!20,
font=\fontencoding{T1}\fontfamily{ptm}\fontsize{45}{45}\bfseries]
{Ti\emph{k}Z};
\end{tikzfadingfrompicture}

% Now we use the fading in another picture:
Expand Down Expand Up @@ -856,8 +856,9 @@ \subsection{Transparency Groups}
\shade [left color=red,right color=blue] (-2,-1) rectangle (2,1);
\begin{scope}[transparency group=knockout]
\fill [white] (-1.9,-.9) rectangle (1.9,.9);
\node [opacity=0,font=\fontencoding{T1}\fontfamily{ptm}\fontsize{45}{45}\bfseries]
{Ti\emph{k}Z};
\node [opacity=0,
font=\fontencoding{T1}\fontfamily{ptm}\fontsize{45}{45}\bfseries]
{Ti\emph{k}Z};
\end{scope}
\end{tikzpicture}
\end{codeexample}
Expand Down
Loading