summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/generic/pst-knot/pst-knot-doc.tex
blob: ac0d7b37d06856e35baa0dca174d2569e622a7f4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
%% $Id: pst-knot-doc.tex 137 2009-10-08 18:15:14Z herbert $
\documentclass[11pt,english,BCOR10mm,DIV12,bibliography=totoc,parskip=false,
   smallheadings, headexclude,footexclude,oneside]{pst-doc}
\usepackage[utf8]{inputenc}
\usepackage{pst-knot}
\let\pstKnotFV\fileversion
\renewcommand\bgImage{%
\begin{pspicture}(-2,-2)(2,2) 
  \psKnot[knotscale=2,linewidth=5pt,linecolor=blue](0,0){5-1}
\end{pspicture}
}
\lstset{pos=t,wide=false,language=PSTricks,
    morekeywords={psKnot},basicstyle=\footnotesize\ttfamily}
%
\begin{document}

\title{\texttt{pst-knot}}
\subtitle{Plotting special knots; v.\pstKnotFV}
\author{Herbert Vo\ss}
\docauthor{}
\date{\today}
\maketitle

\tableofcontents

\section{introduction}
This is the very first try of drawing knots. The package uses the \PS\ 
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}
\Lcs{psKnot}\OptArgs\Largr{\CAny}\Largb{knot type}
\end{BDef}


\begin{LTXexample}
\begin{pspicture}[showgrid=true](-2,-2)(2,2) 
  \psKnot[linewidth=3pt,linecolor=red](0,0){0-1}
\end{pspicture}
\end{LTXexample}

\begin{LTXexample}[pos=t]
\begin{pspicture}[showgrid=true](-2,-2)(8,2) 
  \psKnot[linewidth=3pt,linecolor=red](0,0){3-1}
  \psKnot[linewidth=3pt,linecolor=blue](4,0){4-1}
\end{pspicture}
\end{LTXexample}

\begin{LTXexample}[pos=t]
\begin{pspicture}(-2,-2)(8,2) 
  \psKnot[linewidth=3pt,linecolor=blue](0,0){5-1}
  \psKnot[linewidth=3pt,linecolor=blue](4,0){5-2}
\end{pspicture}
\end{LTXexample}

\begin{LTXexample}[pos=t]
\begin{pspicture}(-2,-2)(10,2) 
  \psKnot[linewidth=3pt,linecolor=blue](0,0){6-1}
  \psKnot[linewidth=3pt,linecolor=blue](4,0){6-2}
  \psKnot[linewidth=3pt,linecolor=blue](8,0){6-3}
\end{pspicture}
\end{LTXexample}

\begin{LTXexample}
\begin{pspicture}(-2,-2)(10,2) 
  \psKnot[linewidth=3pt,linecolor=red](0,0){7-1}
  \psKnot[linewidth=3pt,linecolor=blue](4,0){7-2}
  \psKnot[linewidth=3pt,linecolor=green](8,0){7-3}
\end{pspicture}
\end{LTXexample}

\begin{LTXexample}
\begin{pspicture}(-2,-2)(10,2) 
  \psKnot[linewidth=3pt,linecolor=red](0,0){7-4}
  \psKnot[linewidth=3pt,linecolor=green](4,0){7-5}
  \psKnot[linewidth=3pt,linecolor=blue](8,0){7-6}
\end{pspicture}
\end{LTXexample}

\begin{LTXexample}
\begin{pspicture}[showgrid=true](-2,-2)(2,2) 
  \psKnot[linewidth=3pt,linecolor=blue](0,0){7-7}
\end{pspicture}
\end{LTXexample}

\section{Special settings}
There exists three special optional arguments for the macro \Lcs{psKnot}.

\subsection{Scaling}
The image can be scaled with \Lkeyword{scale}, which can take one or two
values for x and y scaling. For only one value it is scaled for x and y
with the same value. The default is 1 1.

\begin{LTXexample}[pos=t]
\begin{pspicture}(-4,-4)(4,4) 
  \psKnot[linewidth=5pt,linecolor=blue,knotscale=2](0,0){6-1}
\end{pspicture}
\end{LTXexample}

\subsection{Border color}
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]
\begin{pspicture}(-2,-2)(6,2) 
  \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=black!20](4,0){7-4}
\end{pspicture}
\end{LTXexample}

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 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\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}}

\xkvview{family=pst-knot,columns={key,type,default}}


\bgroup
\raggedright
\nocite{*}
\bibliographystyle{plain}
\bibliography{\jobname}
\egroup

\printindex

\end{document}