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

manual typos and formatting inconsistencies #886

Closed
wants to merge 15 commits into from
4 changes: 2 additions & 2 deletions doc/generic/pgf/text-en/pgfmanual-en-base-actions.tex
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ \subsubsection{Graphic Parameter: Caps and Joins}
\end{command}
%
\begin{command}{\pgfsetmiterlimit\marg{miter limit factor}}
Sets the miter limit to \meta{miter limit factor}. See again
Sets the miter limit to \meta{miter limit factor}. See again
Section~\ref{section-cap-joins}.
\end{command}

Expand Down Expand Up @@ -432,7 +432,7 @@ \subsection{Filling a Path}
\label{section-fill}

Filling a path means coloring every interior point of the path with the current
fill color. It is not always obvious whether a point is ``inside'' a path when
fill color. It is not always obvious whether a point is ``inside'' a path when
the path is self-intersecting and/or consists or multiple parts. In this case
either the nonzero winding number rule or the even-odd crossing number rule is
used to decide which points lie ``inside''. These rules are explained in
Expand Down
2 changes: 1 addition & 1 deletion doc/generic/pgf/text-en/pgfmanual-en-base-animations.tex
Original file line number Diff line number Diff line change
Expand Up @@ -504,7 +504,7 @@ \subsubsection{``Anti-Animations'': Snapshots}


\medskip\textbf{Timing and Events.}
The timeline of an animation normally starts at a ```moment |0s|'' and the
The timeline of an animation normally starts at a ``moment |0s|'' and the
\meta{time} is considered relative to this time. For instance, if a
timeline contains, say, the settings |entry={2s}{0}| and |entry={3s}{10}|
and \marg{time} is set to |2.5s|, then the value the attribute will get is
Expand Down
12 changes: 6 additions & 6 deletions doc/generic/pgf/text-en/pgfmanual-en-base-arrows.tex
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ \subsection{Caching and Rendering of Arrows}
|foo[length=5pt,open]| once more later anywhere in the document, the
setup code will not be executed again.
\item The next thing that happens is that we have a look at the
\emph{drawin code} stored in the |code| field of the arrow. In our
\emph{drawing code} stored in the |code| field of the arrow. In our
example, the drawing code would consist of creating a filled path with
four straight segments.

Expand Down Expand Up @@ -432,9 +432,9 @@ \subsection{Declaring an Arrow Tip Kind}
well as to the line width.

The \meta{code} should draw the arrow tip ``going right along the
$x$-axis''. \pgfname\ will take care of setting up a canvas
$x$-axis''. \pgfname\ will take care of setting up a canvas
transformation beforehand to a rotation such that when the drawing
is rendered, the arrow tip that is actually drawn points in the
is rendered, the arrow tip that is actually drawn points in the
direction of the line. Alternatively, when bending is switched on,
even more complicated low-level transformations will be done
automatically.
Expand Down Expand Up @@ -647,7 +647,7 @@ \subsection{Declaring an Arrow Tip Kind}
This sets up things so that whenever \meta{name} is now used in an
arrow specification, it will be replaced by the \meta{end arrow
specification} (the problems resulting form the \meta{name} begin
used in a start arrow specification are taken care of
used in a start arrow specification are taken care of
automatically). See also Section~\ref{section-arrow-tip-macro} for
details on the order in which options get executed in such cases.

Expand Down Expand Up @@ -719,9 +719,9 @@ \subsubsection{True--False Options}
\item |\ifpgfarrowharpoon| is setup by |harpoon| and also |left| and
|right|.
\item |\ifpgfarrowroundcap| is set to true by |line cap=round| and set to
false by |line cap=butt|. It also gets (re)set by |round| and |sharp|.
false by |line cap=butt|. It also gets (re)set by |round| and |sharp|.
\item |\ifpgfarrowroundjoin| is set to true by |line join=round| and set to
false by |line join=miter|. It also gets (re)set by |round| and
false by |line join=miter|. It also gets (re)set by |round| and
|sharp|.
\item |\ifpgfarrowopen| is set to true by |fill=none| and by |open| (which
is a shorthand for |fill=none|) and set to false by |color| and all
Expand Down
20 changes: 10 additions & 10 deletions doc/generic/pgf/text-en/pgfmanual-en-base-decorations.tex
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@ \subsection{Declaring Decorations}
certain position on the input path. This current point will ``travel along
the path'', each time being moved along by a certain distance. This will
also work if the path is not a straight line. That is, it is permissible
that the path curves are veers at a sharp angle. It is also permissible
that the path curves are veers at a sharp angle. It is also permissible
that while traveling along the input path, the current input segment ends
and a new input segment starts. In this case, the remaining distance on the
first input segment is subtracted from the \meta{dimension} and then we
Expand Down Expand Up @@ -334,8 +334,8 @@ \subsection{Declaring Decorations}
First, this option causes an immediate switch to the state |final|
if the remaining distance on the input path is less than
\meta{dimension}. The effect is the same as if you had said
|switch if less than=|\meta{dimension}| to final| just before the |width|
option.
|switch if less than=|\meta{dimension}| to final| just before the
|width| option.

If no switch occurs, this option tells \pgfname\ the width of the
segment. The current point will travel along the input path (as
Expand Down Expand Up @@ -431,7 +431,7 @@ \subsection{Declaring Decorations}

\begin{command}{\pgfdecoratedinputsegmentlength}
The length of the current input segment of the input path.
``Current input segment'' refers to the input segment on which the
``Current input segment'' refers to the input segment on which the
current point lies.
\end{command}

Expand Down Expand Up @@ -553,7 +553,7 @@ \subsection{Using Decorations}
The \meta{before code} and the \meta{after code} are optional. The
input path is divided into input paths as follows: The first input
path consists of the first lines of the path specified in the
\meta{environment contents} until the \meta{length} of the first
\meta{environment contents} until the \meta{length} of the first
element of the \meta{decoration list} is reached. If this length is
reached in the middle of a line, the line is broken up at this
exact position. Then the second input path has the \meta{length} of
Expand All @@ -563,12 +563,12 @@ \subsection{Using Decorations}

If the lengths in the \meta{decoration list} do not add up to the
total length of the path in the \meta{environment contents}, either
some decorations are dropped (if their lengths add up to more than
some decorations are dropped (if their lengths add up to more than
the length of the \meta{environment contents}) or the input path is
not fully used (if their lengths add up to less).
not fully used (if their lengths add up to less).
\item The preexisting path is reinstalled.
\item The decoration automata move along the input paths, thus creating
(and possibly using) the output paths. These output paths extend
(and possibly using) the output paths. These output paths extend
the current path (unless they are used).
\end{enumerate}

Expand Down Expand Up @@ -599,7 +599,7 @@ \subsection{Using Decorations}
point.
\end{itemize}

Before the automata start to "work on" their respective inputs paths,
Before the automata start to ``work on'' their respective inputs paths,
\meta{before code} is executed. After the decoration automaton has
finished, \meta{after code} is executed.
%
Expand Down Expand Up @@ -835,7 +835,7 @@ \subsubsection{Declaring Meta-Decorations}

Otherwise, this option tells \pgfname\ the width of the
``meta-segment'', that is, the length of the sub-input-path which
the decoration automaton specified in \meta{code} will decorate.
the decoration automaton specified in \meta{code} will decorate.
\end{key}

\begin{key}{/pgf/meta-decoration automaton/next state=\meta{new state}}
Expand Down
4 changes: 2 additions & 2 deletions doc/generic/pgf/text-en/pgfmanual-en-base-external.tex
Original file line number Diff line number Diff line change
Expand Up @@ -110,13 +110,13 @@ \subsection{Workflow Step 1: Naming Graphics}
%
\begin{enumerate}
\item The easiest situation arises if there does not yet exist a
graphic file called \meta{file name prefix}|.|\meta{suffix}, where
graphic file called \meta{file name prefix}|.|\meta{suffix}, where
the \meta{suffix} is one of the suffixes understood by your current
backend driver (so |pdf| or |jpg| if you use |pdftex|, |eps| if you
use |dvips|, and so on). In this case, both this command and the
|\endpgfgraphicnamed| command simply have no effect.
\item A more complex situation arises when a graphic file named
\meta{file name prefix}|.|\meta{suffix} \emph{does} exist. In this
\meta{file name prefix}|.|\meta{suffix} \emph{does} exist. In this
case, this graphic file is included using the |\includegraphics|
command%
%
Expand Down
2 changes: 1 addition & 1 deletion doc/generic/pgf/text-en/pgfmanual-en-base-images.tex
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ \subsection{Declaring an Image}
\begin{command}{\pgfdeclareimage\oarg{options}\marg{image name}\marg{filename}}
Declares an image, but does not paint anything. To draw the image, use
|\pgfuseimage{|\meta{image name}|}|. The \meta{filename} may not have an
extension. For \textsc{pdf}, the extensions |.pdf|, |.jpg|, and |.png|
extension. For \textsc{pdf}, the extensions |.pdf|, |.jpg|, and |.png|
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
extension. For \textsc{pdf}, the extensions |.pdf|, |.jpg|, and |.png|
extension. For \textsc{pdf}, the extensions |.pdf|, |.jpg|, and |.png|

This is the correct way to space sentences, see e.g. Wikipedia. Also good text editors like Emacs or Vim have shortcuts to navigate sentences and therefore need two spaces to distinguish the end of a sentence from the space after “e.g.“ or “i.e.”.

Please revert this and all other similar changes.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the stated Wikipedia article there isn't stated that this is the correct way to space sentences. Rather there seems to be opposing opinions and for the newer age it seems to tend to using on space. But that is not the point here because in LaTeX we can decide what we want to see in the output and has nothing to do with the spaces in the input. (I think we agree on that.)

But of course that editors use them is a very relevant point, especially when the main contributor to this project uses one of them ;)

I know that you stated that point in the past already and we agreed that I will not touch any of the "two spaces" you have written (for the above reason). And I am pretty sure that I haven't.

So just for clarity: If you insist to revert that changes I will do it. But I just want to mention my point again which is consistency. In the given example above there are two more sentences before the one that is diffed and there is only given 1 space after the end-of-sentence-dot.

So could you live with the current pull request or shall I change it as you wish? (Please note that this was a one-time-search for the two spaces and thus will not happen again.)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any news here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was waiting for your answer which is still lacking. But I'll take it as "you still wish that I revert the end-of-sentence-dots".
Below I asked another question which is also not answered yet. Could you please let me know your opinion, too, so I don't do unnecessary/double work. Thank you very much in advance.

will automatically tried. For PostScript, the extensions |.eps|, |.epsi|,
and |.ps| will be tried.

Expand Down
2 changes: 1 addition & 1 deletion doc/generic/pgf/text-en/pgfmanual-en-base-matrices.tex
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ \subsection{The Matrix Command}
\begin{itemize}
\item It is not necessary to actually mention |\pgfmatrixnextcell| or
|\pgfmatrixendrow| inside the \meta{matrix cells}. It suffices that
the macros inside \meta{matrix cells} expand to these macros
the macros inside \meta{matrix cells} expand to these macros
sooner or later.
\item In particular, you can define clever macros that insert columns
and rows as needed for special effects.
Expand Down
18 changes: 9 additions & 9 deletions doc/generic/pgf/text-en/pgfmanual-en-base-nodes.tex
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ \section{Nodes and Shapes}
\begin{pgfmodule}{shapes}
This module defines commands both for creating nodes and for creating
shapes. The package is loaded automatically by |pgf|, but you can load it
manually if you have only included |pgfcore|.
manually if you have only included |pgfcore|.
\end{pgfmodule}


Expand Down Expand Up @@ -379,7 +379,7 @@ \subsubsection{Deferred Node Positioning}
\begin{command}{\pgfpositionnodelater\marg{macro name}}
This command is not a replacement for |\pgfnode|. Rather, when this command
is used in a scope, all subsequent node creations in this scope will be
affected in the following way: When a node is created, it is not inserted
affected in the following way: When a node is created, it is not inserted
into the current picture. Instead, it is stored in the box
|\pgfpositionnodelaterbox|. Furthermore, the node is not relevant for the
picture's bounding box, but a bounding box for the node is computed and
Expand Down Expand Up @@ -421,7 +421,7 @@ \subsubsection{Deferred Node Positioning}

Once a late node has been created, you can add arbitrary code in the same
picture. Then, at some later point, you call |\pgfpositionnodenow| to
finally position the node at a given position. At this point, the above
finally position the node at a given position. At this point, the above
macros must have the exact same values they had when \meta{macro name} was
called. Note that the above macros are local to a scope that ends right
after the call to \meta{macro name}, so it is your job to copy the values
Expand Down Expand Up @@ -759,7 +759,7 @@ \subsubsection{What Must Be Defined For a Shape?}
%
\begin{itemize}
\item a \emph{shape name},
\item code for computing the \emph{saved anchors} and \emph{saved
\item code for computing the \emph{saved anchors} and \emph{saved
dimensions},
\item code for computing \emph{anchor} positions in terms of the saved
anchors,
Expand All @@ -773,7 +773,7 @@ \subsubsection{What Must Be Defined For a Shape?}

\subsubsection{Normal Anchors Versus Saved Anchors}

Anchors are special places in a shape. For example, the |north east| anchor,
Anchors are special places in a shape. For example, the |north east| anchor,
which is a normal anchor, lies at the upper right corner of the |rectangle|
shape, as does |\northeast|, which is a saved anchor. The difference is the
following: \emph{saved anchors are computed and stored for each node, anchors
Expand All @@ -798,9 +798,9 @@ \subsubsection{Normal Anchors Versus Saved Anchors}
As an example, consider the |rectangle| shape. For this shape two anchors are
saved: The |\northeast| corner and the |\southwest| corner. A normal anchor
like |north west| can now easily be expressed in terms of these coordinates:
Take the $x$-position of the |\southwest| point and the $y$-position of the
Take the $x$-position of the |\southwest| point and the $y$-position of the
|\northeast| point. The |rectangle| shape currently defines 13 normal anchors,
but needs only two saved anchors. Adding new anchors like a |south south east|
but needs only two saved anchors. Adding new anchors like a |south south east|
anchor would not increase the memory and computation requirements of pictures.

All anchors (both saved and normal) are specified in a local \emph{shape
Expand Down Expand Up @@ -873,7 +873,7 @@ \subsubsection{Command for Declaring New Shapes}
should be a \TeX\ macro name like |\centerpoint|.

The \meta{code} will be executed each time |\pgfnode| (or
|\pgfmultipartnode|) is called to create a node of the shape
|\pgfmultipartnode|) is called to create a node of the shape
\meta{shape name}. When the \meta{code} is executed, the \TeX-boxes of
the node parts will contain the text labels of the node. Possibly,
these box are void. For example, if there is just a |text| part, the
Expand Down Expand Up @@ -1098,7 +1098,7 @@ \subsubsection{Command for Declaring New Shapes}

When the user requests a point on the border of the shape using the
|\pgfpointshapeborder| command, the \meta{code} will be executed to
discern this point. When the execution of the \meta{code} starts, the
discern this point. When the execution of the \meta{code} starts, the
dimensions |\pgf@x| and |\pgf@y| will have been set to a location $p$
in the shape's coordinate system, and relative to the anchor |center|.
Note that |\pgfpointshapeborder| will produce an error if the shape does
Expand Down
4 changes: 2 additions & 2 deletions doc/generic/pgf/text-en/pgfmanual-en-base-paths.tex
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ \subsection{The Curve-To Path Operations}

\begin{command}{\pgfpathcurveto\marg{support 1}\marg{support 2}\marg{coordinate}}
This command extends the current path with a Bézier curve from the last
point of the path to \meta{coordinate}. The \meta{support 1} and
point of the path to \meta{coordinate}. The \meta{support 1} and
\meta{support 2} are the first and second support point of the Bézier
curve. For more information on Bézier curves, please consult a standard
textbook on computer graphics.
Expand Down Expand Up @@ -601,7 +601,7 @@ \subsection{The Grid Path Operation}
\subsection{The Parabola Path Operation}

\begin{command}{\pgfpathparabola\marg{bend vector}\marg{end vector}}
This command appends two half-parabolas to the current path. The first
This command appends two half-parabolas to the current path. The first
starts at the current point and ends at the current point plus \meta{bend
vector}. At this point, it has its bend. The second half parabola starts at
that bend point and ends at point that is given by the bend plus \meta{end
Expand Down
2 changes: 1 addition & 1 deletion doc/generic/pgf/text-en/pgfmanual-en-base-patterns.tex
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ \subsection{Declaring a Pattern}
complete tile.

The size of a tile is given by \meta{tile size}, that is, a tile is a
rectangle whose lower left corner is the origin and whose upper right
rectangle whose lower left corner is the origin and whose upper right
corner is given by \meta{tile size}. This might make you wonder why the
second and third parameters are needed. First, the bounding box might be
smaller than the tile size if the tile is larger than the picture on the
Expand Down
6 changes: 3 additions & 3 deletions doc/generic/pgf/text-en/pgfmanual-en-base-plots.tex
Original file line number Diff line number Diff line change
Expand Up @@ -313,7 +313,7 @@ \subsubsection{Commands That Generate Plot Streams}
the coordinates of the \meta{function}. In detail, the following happens:

This command works with two files: \meta{prefix}|.gnuplot| and
\meta{prefix}|.table|. If the optional argument \meta{prefix} is not
\meta{prefix}|.table|. If the optional argument \meta{prefix} is not
given, it is set to |\jobname|.

Let us start with the situation where none of these files exists. Then
Expand Down Expand Up @@ -378,7 +378,7 @@ \subsubsection{Commands That Generate Plot Streams}
\subsection{Plot Handlers}
\label{section-plot-handlers}

A \emph{plot handler} determines what ``should be done'' with a plot stream.
A \emph{plot handler} determines what ``should be done'' with a plot stream.
You must set the plot handler before the stream starts. The following commands
install the most basic plot handlers; more plot handlers are defined in the
file |pgflibraryplothandlers|, which is documented in
Expand Down Expand Up @@ -416,7 +416,7 @@ \subsection{Plot Handlers}
\end{command}

\begin{command}{\pgfsetlinetofirstplotpoint}
Specifies that plot handlers should issue a line-to command for the first
Specifies that plot handlers should issue a line-to command for the first
point of the plot.
%
\begin{codeexample}[]
Expand Down
10 changes: 5 additions & 5 deletions doc/generic/pgf/text-en/pgfmanual-en-base-points.tex
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ \subsection{Overview}

\subsection{Basic Coordinate Commands}

The following commands are the most basic for specifying a coordinate.
The following commands are the most basic for specifying a coordinate.

\begin{command}{\pgfpoint\marg{x coordinate}\marg{y coordinate}}
Yields a point location. The coordinates are given as \TeX\ dimensions.
Expand Down Expand Up @@ -128,7 +128,7 @@ \subsection{Coordinates in the XY-Coordinate System}
This command is similar to the |\pgfpointpolar| command, but the
\meta{radius} is now a factor to be interpreted in the $xy$-coordinate
system. This means that a degree of |0| is the same as the $x$-vector of
the $xy$-coordinate system times \meta{radius} and a degree of |90| is the
the $xy$-coordinate system times \meta{radius} and a degree of |90| is the
$y$-vector times \meta{radius}. As for |\pgfpointpolar|, a \meta{radius}
can also be a pair separated by a slash. In this case, the $x$- and
$y$-vectors are multiplied by different factors.
Expand Down Expand Up @@ -156,7 +156,7 @@ \subsection{Three Dimensional Coordinates}

\begin{command}{\pgfpointxyz\marg{$s_x$}\marg{$s_y$}\marg{$s_z$}}
Yields a point that is situated at $s_x$ times the $x$-vector plus $s_y$
times the $y$-vector plus $s_z$ times the $z$-vector.
times the $y$-vector plus $s_z$ times the $z$-vector.
%
\begin{codeexample}[]
\begin{pgfpicture}
Expand Down Expand Up @@ -517,7 +517,7 @@ \subsubsection{Points on the Intersection of Two Paths}

\begin{pgflibrary}{intersections}
This library defines the below command and allows you to calculate the
intersections of two arbitrary paths. However, due to the low accuracy of
intersections of two arbitrary paths. However, due to the low accuracy of
\TeX, the paths should not be ``too complicated''. In particular, you
should not try to intersect paths consisting of lots of very small segments
such as plots or decorated paths.
Expand All @@ -531,7 +531,7 @@ \subsubsection{Points on the Intersection of Two Paths}
so can contain transformations (which will be in addition to any existing
transformations). The code should not use the path in any way, unless the
path is saved first and restored afterward. \pgfname{} will regard
solutions as ``a bit special'', in that the points returned will be
solutions as ``a bit special'', in that the points returned will be
``absolute'' and unaffected by any further transformations.
%
\begin{codeexample}[preamble={\usetikzlibrary{intersections}}]
Expand Down
Loading