From 641ed69c504f2e0577cffb3ec466c3d3579e2ed1 Mon Sep 17 00:00:00 2001 From: Yukai Chou Date: Fri, 21 Oct 2022 07:01:56 +0800 Subject: [PATCH 1/2] ci: analyse and show overfull hbox(es) and upload a second artifact containing pdf and all aux files Signed-off-by: Yukai Chou --- .github/workflows/doc.yml | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml index 74def94df..9052eb07c 100644 --- a/.github/workflows/doc.yml +++ b/.github/workflows/doc.yml @@ -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 }} From 0f683175a26f1cc33bcf9f660481ff4bb86c9795 Mon Sep 17 00:00:00 2001 From: Yukai Chou Date: Sat, 16 Jan 2021 07:44:06 +0800 Subject: [PATCH 2/2] docs: resolve overfull hboxes >=20pt Signed-off-by: Yukai Chou --- doc/generic/pgf/CHANGELOG.md | 1 + doc/generic/pgf/pgfmanual-en-gd-usage-pgf.tex | 6 +++--- doc/generic/pgf/pgfmanual-en-library-automata.tex | 11 ++++++----- doc/generic/pgf/pgfmanual-en-library-circuits.tex | 2 +- doc/generic/pgf/pgfmanual-en-library-patterns.tex | 5 +++-- doc/generic/pgf/pgfmanual-en-library-rdf.tex | 10 +++++----- doc/generic/pgf/pgfmanual-en-pgfsys-commands.tex | 6 +++++- doc/generic/pgf/pgfmanual-en-tikz-transparency.tex | 11 ++++++----- 8 files changed, 30 insertions(+), 22 deletions(-) diff --git a/doc/generic/pgf/CHANGELOG.md b/doc/generic/pgf/CHANGELOG.md index d08a6e9ab..b068edb9b 100644 --- a/doc/generic/pgf/CHANGELOG.md +++ b/doc/generic/pgf/CHANGELOG.md @@ -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 diff --git a/doc/generic/pgf/pgfmanual-en-gd-usage-pgf.tex b/doc/generic/pgf/pgfmanual-en-gd-usage-pgf.tex index 0bed352e7..63af27c8f 100644 --- a/doc/generic/pgf/pgfmanual-en-gd-usage-pgf.tex +++ b/doc/generic/pgf/pgfmanual-en-gd-usage-pgf.tex @@ -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 diff --git a/doc/generic/pgf/pgfmanual-en-library-automata.tex b/doc/generic/pgf/pgfmanual-en-library-automata.tex index c56bb6fd1..7fc516f9b 100644 --- a/doc/generic/pgf/pgfmanual-en-library-automata.tex +++ b/doc/generic/pgf/pgfmanual-en-library-automata.tex @@ -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$}; @@ -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$}; diff --git a/doc/generic/pgf/pgfmanual-en-library-circuits.tex b/doc/generic/pgf/pgfmanual-en-library-circuits.tex index a0d29f60a..7595a0fd3 100644 --- a/doc/generic/pgf/pgfmanual-en-library-circuits.tex +++ b/doc/generic/pgf/pgfmanual-en-library-circuits.tex @@ -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} diff --git a/doc/generic/pgf/pgfmanual-en-library-patterns.tex b/doc/generic/pgf/pgfmanual-en-library-patterns.tex index 5a36c9217..3fcdd413d 100644 --- a/doc/generic/pgf/pgfmanual-en-library-patterns.tex +++ b/doc/generic/pgf/pgfmanual-en-library-patterns.tex @@ -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. diff --git a/doc/generic/pgf/pgfmanual-en-library-rdf.tex b/doc/generic/pgf/pgfmanual-en-library-rdf.tex index 0e8a88de6..e582f3321 100644 --- a/doc/generic/pgf/pgfmanual-en-library-rdf.tex +++ b/doc/generic/pgf/pgfmanual-en-library-rdf.tex @@ -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 diff --git a/doc/generic/pgf/pgfmanual-en-pgfsys-commands.tex b/doc/generic/pgf/pgfmanual-en-pgfsys-commands.tex index 03d697b98..dd80accf0 100644 --- a/doc/generic/pgf/pgfmanual-en-pgfsys-commands.tex +++ b/doc/generic/pgf/pgfmanual-en-pgfsys-commands.tex @@ -922,10 +922,14 @@ \subsection{Transparency System Commands} transformation should not apply to the following graphics, however. \end{command} +\pagebreak[2] \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 diff --git a/doc/generic/pgf/pgfmanual-en-tikz-transparency.tex b/doc/generic/pgf/pgfmanual-en-tikz-transparency.tex index 1e2a20aba..54cd7839f 100644 --- a/doc/generic/pgf/pgfmanual-en-tikz-transparency.tex +++ b/doc/generic/pgf/pgfmanual-en-tikz-transparency.tex @@ -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: @@ -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}