Initialisation du projet pst-solides3d.git (SVN revision 142)
[pst-solides3d.git] / doc-en / .svn / text-base / pst-solides3d-doc.tex.svn-base
1 \listfiles % Writes out the package versions in the log file
2 \documentclass[%
3     11pt,           % normal font size  (default, alias for fontsize=11pt)
4     BCOR10mm,       % binding correction (deprecated, use: BCOR=10mm)
5     DIV12,          % divison factor for page layout contrution
6                     % (deprecated, use: DIV=12)
7     bibtotoc,       % add unnumbered entry for the bibliography to the table
8                     % of contents (deprecated, use: toc=bibliography or
9                     % bibliography=totoc)
10     parskip,        % use one base line vertical inter-paragraph space and
11                     % at least 1 em horizontal space at the end of paragraphs
12                     % instead of indenting first line of paragraphs
13     twoside,        % use twosided layout (default)
14     smallheadings,  % use smaller font sizes for headings (but at least
15                     % \normalsize) with less vertical above and below headings
16                     % (deprecated, use: headings=small)
17     1.1headlines,   % set head height to 1.1\baselineskip of \normalsize
18                     % (deprecated, use: headlines=1.1)
19     headexclude,    % page head is part of the margins not the type area
20                     % (default, deprecated, use: headinclude=false)
21     footexclude,    % page foot is part of the margins not the type area
22                     % (default, deprecated, use: footinclude=false)
23     mpexclude       % margin notes are part of the margins not the type area
24                     % (default, deprecated, use: mpinclude=false)
25     ]{scrbook}
26
27 \usepackage[latin1]{inputenc}
28 \usepackage[T1]{fontenc}
29 \usepackage{lmodern}
30 \usepackage{scrpage2}
31 \pagestyle{scrheadings}
32 \usepackage{makeidx}
33 \makeindex
34
35 %\usepackage{arev}
36 %\usepackage{manfnt}
37 %\usepackage[garamond]{mathdesign}
38 %\renewcommand{\ttdefault}{lmtt}
39
40 \usepackage{multicol}   % Intermix single and multiple columns
41 \usepackage{longtable}  % Allows tables to flow over page boundaries
42 \usepackage{array}      % Extending the array and tabular environments
43 \usepackage{arrayjob}   % Management of arrays
44 \usepackage{url}        % Verbatim with URL-sensitive line breaks
45 \usepackage[a4paper,dvips,hmargin=2cm,vmargin=3cm]{geometry}    % Flexible and complete interface to document dimensions
46 \usepackage{framed}            % Framed or shaded regions that can break across pages
47 \usepackage{amsmath,amssymb} % allows multiple maths-environments
48 \usepackage{ragged2e}
49 \usepackage{titlesec}        % Select alternative section titles
50 \usepackage{paralist}
51
52
53 %%%%%%%
54 %%%%%%% Loading the necessary graphic packages
55 \usepackage[dvipsnames,svgnames,table]{pstricks} % Loads the basic packages of 'PSTricks'
56                                            % with predefined color schemes from 'xcolor'
57 \usepackage[final]{showexpl}   % Typesetting LaTeX source code
58 \usepackage{pst-plot}  % Macros for plotting functions and data records
59 \usepackage{pst-eucl}  % The 'pst-eucl' package allow the drawing of Euclidean geometric
60                        % figures using LaTeX macros for specifying mathematical constraints.
61                        % It is thus possible to build point using common transformations or intersections.
62                        % The use of coordinates is  limited to points which controlled the figure.
63 \usepackage{pst-solides3d}   % The package is designed to draw solids in 3D perspective.
64 \let\PSTfileversion\fileversion
65 \let\PSTfiledate\filedate
66 \usepackage{pstricks-add}    % A collection of add-ons and bugfixes for PSTricks.
67                              % Allows 'algebraic notation' instead of the PostScript
68                              % native RPN (Revers Polish Notation).
69 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
70 % Note: 'pstricks-add' always needs to be loaded last. %
71 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
72
73 \DeclareFixedFont{\timesnormal}{T1}{ptm}{m}{n}{2cm}
74 \raggedbottom
75 \makeatletter
76 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
77 %% adapt\'{e} de \psRandom du package pstricks-add
78 %% pour rendre al\'{e}atoire la taille des \'{e}toiles
79 %% Manuel Luque
80 \newdimen\pssizeStar
81 \def\psset@sizeStar#1{\pssetlength\pssizeStar{#1}}
82 \psset@sizeStar{1pt}
83 \def\psRandomStar{\pst@object{psRandomStar}}%
84 \def\psRandomStar@i{\@ifnextchar({\psRandomStar@ii}{\psRandomStar@iii(0,0)(1,1)}}
85 \def\psRandomStar@ii(#1){\@ifnextchar({\psRandomStar@iii(#1)}{\psRandomStar@iii(0,0)(#1)}}
86 \def\psRandomStar@iii(#1)(#2)#3{%
87   \def\pst@tempA{#3}%
88   \ifx\pst@tempA\pst@empty\psclip{\psframe(#2)}\else\psclip{#3}\fi
89   \pst@getcoor{#1}\pst@tempA
90   \pst@getcoor{#2}\pst@tempB
91   \begin@SpecialObj
92   \addto@pscode{
93     \pst@tempA\space /yMin exch def
94     /xMin exch def
95     \pst@tempB\space /yMax exch def
96     /xMax exch def
97     /dy yMax yMin sub def
98     /dx xMax xMin sub def
99     rrand srand                 % initializes the random generator
100     /getRandReal { rand 2147483647 div } def
101      \psk@randomPoints {
102     /DS \pst@number\pssizeStar\space getRandReal mul def
103     \@nameuse{psds@\psk@dotstyle}
104      \ifPst@color getRandReal 1 1 sethsbcolor \fi
105      getRandReal dx mul xMin add
106      getRandReal dy mul yMin add
107      Dot
108      \ifx\psk@fillstyle\psfs@solid fill \fi stroke
109     } repeat
110   }%
111   \end@SpecialObj
112   \endpsclip
113   \ignorespaces
114 }
115
116
117 \renewcommand*\l@section{\bprot@dottedtocline{1}{1.5em}{2.5em}}   % hv
118 \renewcommand*\l@subsection{\bprot@dottedtocline{2}{3.8em}{3.5em}}% hv
119
120
121 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
122 %% macro H.Voss sur :
123 %%http://tug.org/mailman/htdig/pstricks/2007/004640.html
124
125 \def\GetCenter#1{ tx@NodeDict begin /N@#1 load GetCenter end
126   \pst@number\psyunit div /#1.y ED
127   \pst@number\psxunit div /#1.x ED }
128 \makeatother
129
130 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
131 %% Jean-Michel Sarlat et Guillaume Connan
132 \newenvironment{gbar}{%
133   \def\FrameCommand{{\color{red}\vrule width 2pt}\colorbox{yellow!30}}%
134   \MakeFramed {\advance\hsize-\width \FrameRestore}}%
135 {\endMakeFramed}
136
137 %%%%%%%
138 %%%%%%% Setting the Chapter layout
139 \titleformat{\chapter}[display] % {command}[shape]
140   {\usekomafont{chapter}\Large \color{OrangeReddy}} % format
141   {                       % label
142   \LARGE\MakeUppercase{\chaptertitlename} \Huge \thechapter \filright%
143   }%}
144   {1pt}                   % sep (from chapternumber)
145   {\titlerule \vspace{0.9pc} \filright \color{OrangeReddy}}   % {before}[after] (before chaptertitle and after)
146   [\color{OrangeReddy} \vspace{0.9pc} \filright {\titlerule}]
147
148
149 %%%%%%%
150 %%%%%%% Highlight some expressions
151 \newcommand\Cadre[1]{\psframebox[fillstyle=solid,fillcolor=gray!20,linecolor=gray!20]{\texttt{#1}}}
152
153 %%%%%%%
154 %%%%%%% Box and highlight some notes
155 \newcommand\encadre[1]{
156 \psframebox[fillstyle=solid,fillcolor=gray!20,linecolor=gray!20]{
157   \begin{minipage}{\textwidth}
158   {\textbf{\textcolor{OrangeReddy}{Note:}}\qquad #1}
159   \end{minipage}}
160 }
161
162
163 %%%%%%%
164 %%%%%%% Highlight the table of the predefined solids
165 \newcommand\toptableau{
166 \rowcolor{gray!20}
167   \textbf{Solid} & \begin{tabular}{c}
168                       \textbf{Default}\\
169                       \textbf{Parameters}
170                       \end{tabular} &
171                       \begin{minipage}{4cm}
172                       \centerline{\textbf{View}}
173                       \end{minipage}&
174                       \begin{minipage}{4cm}
175                       \centerline{\textbf{Code}}
176                       \end{minipage}}
177 %%%%%%%
178 %%%%%%% Color array
179 \newarray\colors
180 \readarray{colors}{%
181 Apricot&Aquamarine%
182 &Bittersweet&Black&Blue&BlueGreen&BlueViolet&BrickRed&Brown&BurntOrange%
183 &CadetBlue&CarnationPink&Cerulean&CornflowerBlue&Cyan&Dandelion&DarkOrchid%
184 &Emerald&ForestGreen&Fuchsia&Goldenrod&Gray&Green&GreenYellow&JungleGreen%
185 &Lavender&LimeGreen&Magenta&Mahogany&Maroon&Melon&MidnightBlue&Mulberry%
186 &NavyBlue&OliveGreen&Orange&OrangeRed&Orchid&Peach&Periwinkle&PineGreen%
187 &Plum&ProcessBlue&Purple&RawSienna&Red&RedOrange&RedViolet&Rhodamine&RoyalBlue%
188 &RoyalPurple&RubineRed&Salmon&SeaGreen&Sepia&SkyBlue&SpringGreen&Tan&TealBlue%
189 &Thistle&Turquoise&Violet&VioletRed&White&WildStrawberry&Yellow&YellowGreen&YellowOrange}
190
191 \edef\colorfaces{}%
192 \multido{\i=0+1}{67}{%
193  \checkcolors(\i)
194 \xdef\colorfaces{\colorfaces\i\space(\cachedata)\space}}
195
196 \definecolor{bleuciel}{rgb}{0.78,0.84,0.99}
197 \definecolor{OrangeReddy}{rgb}{0.73,0.00,0.00}
198
199 %%%%%%%
200 %%%%%%% Highlight some commands with backslashes (the three macros)
201 \newcommand{\bs}[1]{%
202   \psframebox[fillstyle=solid,fillcolor=gray!20,
203     linecolor=gray!20]{\texttt{\textbackslash#1}}}
204
205 %%%%%%%
206 %%%%%%% Positioning the viewpoint
207 \def\PointEcran(#1,#2,#3)#4{% position of the viewpoint on the screen
208 \pstVerb{/xM #1 def /yM #2 def /zM #3 def
209          /kC dE dup mul xM xE mul yM yE mul zM zE mul add add sub
210            xV xE mul xM xE mul sub
211            yV yE mul yM yE mul sub add
212            zV zE mul zM zE mul sub add
213            div def
214          /x_E kC xV xM sub mul xM add def
215          /y_E kC yV yM sub mul yM add def
216          /z_E kC zV zM sub mul zM add def}%
217 \psPoint(x_E,y_E,z_E){#4}}
218
219
220 \def\datapath{}% ../doc/}
221
222 \lstset{%
223     basicstyle=\ttfamily\footnotesize,
224     commentstyle=\color{PineGreen}\slshape\footnotesize,
225     showspaces=false,
226     showstringspaces=false,
227     breaklines=true,
228     backgroundcolor=\color{gray!20},
229     breakautoindent=true,
230     captionpos=t,
231     language=TeX,
232     emph={\begin,\codejps,\end},
233     emphstyle=\color{RoyalBlue},
234     emph={[2]pspicture},
235     emphstyle={[2]\color{OrangeReddy}},
236     numbersep=5pt,
237     preset=\centering,
238     rframe={}%
239 }
240
241 %%%%%%%
242 %%%%%%% Title Page
243 \title{\texttt{pst-solides3d}:\\
244        The Documentation -- The Basics
245         \\[0.5cm]
246 {\normalsize v. \PSTfileversion\ (\PSTfiledate)}\\[20pt]
247 \includegraphics[scale=0.6]{kepler}
248 }
249 \author{Jean-Paul \textsc{Vignault}, Manuel \textsc{Luque}, Arnaud
250 \textsc{Schmittbuhl}\\
251 {\small
252  \url{<jpv@melusine.eu.org>}, \url{<manuel.luque27@gmail.com>},
253  \url{<aschmittbuhl@libertysurf.fr>}}
254 \thanks{With the additional help of:\newline
255   J\"{u}rgen \textsc{Gilg} \url{<gilg@acrotex.net>},\newline
256   Jean-Michel \textsc{Sarlat} \url{<jm.sarlat@gmail.com>},\newline
257   Herbert \textsc{Voss} \url{<herbert.voss@fu-berlin.de>}.
258 }}
259 \date{\today}
260
261
262
263 \usepackage[
264 % colors for the links
265    colorlinks=true,         % color links
266    urlcolor=OrangeReddy,    % color of URL links
267    filecolor=black,         % color of file links
268    linkcolor=OrangeReddy,   % color of links
269 % Links
270    %raiselinks=true,    % raise up links (for HyperTeX backend)
271    %backref=page,           % do bibliographical back refenrernces
272    pagebackref=true,        % back reference by page numbers
273    verbose,                 % be chatty
274    hyperindex=true,         % set up hyperlink indices
275    linktocpage=true,        % make page number, not text, be linked on TOC, LOF, LOT
276    hyperfootnotes=false,    % do not set up hyperlink footnotes
277 % Bookmarks
278    bookmarks=true,          % Generating Bookmarks for the PDF-Viewer
279    bookmarksopenlevel=1,    % Level to which Bookmarks are opened
280    bookmarksopen=true,      % Open up Bookmarks tree
281    bookmarksnumbered=true,  % Put section numbers in Bookmarks
282    %bookmarkstype=toc,      % Specify which TOC file to mimic
283 % Anchors
284    plainpages=false,        % do not page number anchors as plain arabic
285    pageanchor=true          % put an anchor on every page
286    ]{hyperref}
287
288 %%%%%%%
289 %%%%%%% PDF Informations
290 \hypersetup{%
291    pdftitle={pst-solides3d - The Documentation},    % Text for the PDF title field
292    pdfauthor={Jean-Paul Vignault, Manuel Luque, Arnaud Schmittbuhl},    % Text for the PDF author field
293    pdfcreator={LaTeX, hyperref, KOMA-Script},       % Text for the PDF creator field
294    %pdfproducer={pdfeTeX 1.10b-2.1}                 % Text for the PDF producer field
295    pdfstartview=FitH,       % Fits the width of the page to the window.
296    pdfpagemode=UseOutlines, % Show Bookmarks in the Viewer
297    pdfpagelabels=true       % set PDF page labels
298    }
299 \usepackage{breakurl}   % Line-breakable \url-like links in hyperref when compiling via dvips/ps2pdf
300
301 %%%%%%%%%%%%%%%%%%%%%%%%%%%%% Herbert %%%%%%%%%%%%%%%%%%%%%%%%%%
302 \pagestyle{scrheadings}
303 \ofoot{\pagemark}
304 \newcommand\Input[2][\datapath]{\ifoot{{\footnotesize#2}}\input{#1#2}}
305 \def\Lcs#1{\texttt{\textbackslash#1}%
306   \index{#1@\texttt{\textbackslash#1}}%
307   \index{Macro!#1@\texttt{\textbackslash#1}}}
308 \def\Lenv#1{\texttt{#1}\index{#1@\texttt{#1}}\index{Environment!#1@\texttt{#1}}}
309 \def\Lkeyword#1{\texttt{#1}%
310   \index{#1@\texttt{#1}}\index{Keyword!#1@\texttt{#1}}}
311 \def\Lkeyval#1{\texttt{#1}%
312   \index{#1@\texttt{#1}}\index{Value!#1@\texttt{#1}}}
313 \def\Index#1{#1\index{#1}}
314
315 \begin{document}
316 \maketitle
317
318 \tableofcontents
319
320 \newpage
321
322 \chapter{Basics for the package}
323 \Input{chapter-1-en}
324
325 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
326 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
327
328 \chapter{Setting the layout of the scenery}
329 \Input{chapter-2-en}
330 \Input{par-eclairageponctuel-en}
331 \Input{par-axes3D-en}
332
333 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
334 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
335
336 \chapter{Predefined solids and their positioning}
337
338 \Input{par-solidespredefinis-en}
339 \Input{par-positionnersolide-en}
340
341 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
342 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
343
344 \chapter{More options of \textbackslash{}psSolid}
345 \Input{par-commandestrace-en}
346 \Input{par-solidescreux-en}
347 \Input{par-numeroterfacettes-en}
348 \Input{par-enleverfacettes-en}
349 \Input{par-pointagesommets-en}
350 \Input{par-couleurs-en}
351 \Input{par-colorierfacettes-en}
352 \Input{par-opacity-en}
353 \Input{par-definitionmaillage-en}
354
355 \Input{par-modes-en}
356
357 \Input{par-tronque-en}
358 \Input{par-affinage-en}
359 \Input{par-chanfrein-en}
360 \Input{par-transform-en}
361 \Input{par-lignedeniveau-en}
362 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
363
364 \chapter{Usage of external files}
365 \Input{par-datfile-en}
366
367 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
368
369 \chapter{Some special objects}
370 \Input{par-grille-en}
371 \Input{par-point-en}
372 \Input{par-vecteur-en}
373 \Input{par-plan-en}
374 \Input{par-geode-en}
375
376 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
377
378 \chapter{Generating some new solids}
379 \Input{par-codejps-en}
380 \Input{par-definirfonction-en}
381 \Input{par-courbeR3-en}
382 \Input{par-tube-en}
383 \Input{par-prisme-en}
384 \Input{par-new-en}
385 \Input{par-face-en}
386 \Input{par-ruban-en}
387 \Input{par-anneaux-en}
388 \Input{par-cylindres-cones-en}
389 \Input{par-surfacesparametrees-en}
390 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
391
392 \chapter{Surfaces defined by a function of the form $z=f(x,y)$}
393 \Input{par-surfaces-en}
394
395 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
396
397 \chapter{Advanced usage}
398 \Input{par-nommersolide-en}
399 \Input{par-section-en}
400 \Input{par-fusion-en}
401 \Input{par-fusionjps-en}
402
403 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
404 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
405
406 \chapter{Interaction with PSTricks}
407
408 \Input{par-positionnerpointconnu-en}
409 \Input{par-ligne3D-en}
410 \Input{par-tracerpolygone-en}
411 \Input{par-transformpointconnu-en}
412 \Input{par-annoterschema-en}
413
414 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
415 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
416
417 \chapter{Projections}
418 \Input{par-projpresentation-en}
419 \Input{par-projectionvisibility-en}
420 \Input{par-definirplanquelconque-en}
421 \Input{par-projectionpoint-en}
422 \Input{par-projectionvecteur-en}
423 \Input{par-projectiondroite-en}
424
425 %\newpage
426 \Input{par-projectioncercle-en}
427 \Input{par-projectionpolygone-en}
428 \Input{par-projectionligne-en}
429 %\newpage
430 \Input{par-projectionangledroit-en}
431 \Input{par-projectioncourbe-en}
432 \Input{par-projectiontexte-en}
433
434 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
435 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
436
437 \chapter{Possible extensions}
438 \Input{par-extensions-en}
439
440 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
441 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
442
443 \appendix
444 \chapter{Appendix}
445 \Input{par-parametres-en}
446 \Input{par-keywords-en}
447 \Input{par-acknowledgements-en}
448 \Input{par-poems-en}
449
450
451 \printindex
452
453 \nocite{*}
454 \bgroup
455 \RaggedRight
456 \bibliographystyle{plain}
457 \bibliography{pst-solides3d-doc}
458 \egroup
459
460 \end{document} 

Licence Creative Commons Les fichiers de Syracuse sont mis à disposition (sauf mention contraire) selon les termes de la
Licence Creative Commons Attribution - Pas d’Utilisation Commerciale - Partage dans les Mêmes Conditions 4.0 International.