summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/generic/pst-knot/pst-knot-doc.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/generic/pst-knot/pst-knot-doc.tex')
-rw-r--r--Master/texmf-dist/doc/generic/pst-knot/pst-knot-doc.tex40
1 files changed, 32 insertions, 8 deletions
diff --git a/Master/texmf-dist/doc/generic/pst-knot/pst-knot-doc.tex b/Master/texmf-dist/doc/generic/pst-knot/pst-knot-doc.tex
index 3a96773f79d..ac0d7b37d06 100644
--- a/Master/texmf-dist/doc/generic/pst-knot/pst-knot-doc.tex
+++ b/Master/texmf-dist/doc/generic/pst-knot/pst-knot-doc.tex
@@ -25,8 +25,12 @@
\section{introduction}
This is the very first try of drawing knots. The package uses the \PS\
-subroutines from the file \LFile{psMath.pro} from Matthias Buch-Kromann.)
-Currentlx there is only one macro with two mandatory arguments, the origin
+subroutines of the file \LFile{psMath.pro} from Matthias Buch-Kromann.)
+Currently there are only two macros for knots.
+
+\section{\nxLcs{psKnot}}
+
+The macro \Lcs{psKnot} has one optional and two mandatory arguments, the origin
of the image and the knot type. The following list shows all available knot types.
\begin{BDef}
@@ -99,8 +103,8 @@ with the same value. The default is 1 1.
\end{LTXexample}
\subsection{Border color}
-The background color of the border can be controlled by \Lkeyword{knotbgcolor}
-with only a numerical value of $[0..1]$ for a grayscale color. It makes
+The background color of the border can be controlled by \Lkeyword{knotbgcolor}.
+It can use any possible color value and it makes
only sense for a colored background to get the same color for the crossing.
\begin{LTXexample}[pos=t]
@@ -108,7 +112,7 @@ only sense for a colored background to get the same color for the crossing.
\psframe[fillcolor=black!20,fillstyle=solid](-2,-2)(6,2)
\psKnot[linewidth=5pt,linecolor=red!50](0,0){7-4}
\psKnot[linewidth=5pt,linecolor=red!50,
- knotbgcolor=0.8](4,0){7-4}
+ knotbgcolor=black!20](4,0){7-4}
\end{pspicture}
\end{LTXexample}
@@ -116,17 +120,37 @@ Pay attention that black!20 is the same as 0,8 of gray.
\subsection{Border width}
The width of the border is controlled by the keyword \Lkeyword{knotborder} and
-it is preset to 2 as a factor to the current linewidth.
-It must at least be the currentlinewidth (1.0).
+it is preset to 5\Ldim{pslinewidth}. The border width is added
+to the current linewidth.
\begin{LTXexample}[pos=t]
\begin{pspicture}(-2,-2)(6,2)
\psKnot[linewidth=3pt,linecolor=cyan!60](0,0){6-3}
\psKnot[linewidth=3pt,linecolor=red!50,
- knotborder=5](4,0){6-3}
+ knotborder=5\pslinewidth](4,0){6-3}
\end{pspicture}
\end{LTXexample}
+\section{\nxLcs{psBorromean}}
+
+The macro \Lcs{psBorromean} draws the so called Borromean rings.
+It has one optional and three mandatory arguments, the origin
+of the image, the inner and outer radius. The following list shows all available knot types.
+
+\begin{BDef}
+\Lcs{psBorromean}\OptArgs\Largr{\CAny}\Largb{circle radius}\Largb{inner radius}
+\end{BDef}
+
+
+\begin{LTXexample}
+\begin{pspicture}[showgrid=true](-2,-3)(10,4)
+ \psBorromean(0,0){1cm}{1cm}
+ \psBorromean[linewidth=8pt,knotborder=2\pslinewidth,
+ bmcolor={blue,yellow,magenta}](6,0){2cm}{1.5cm}
+\end{pspicture}
+\end{LTXexample}
+
+
\clearpage
\section{List of all optional arguments for \nxLPack{pst-knot}}