little_helpers/tikz/sketch-0.2.161/Doc/sketch/Specials.html

   1 <html lang="en">
   2 <head>
   3 <title>Specials - Sketch</title>
   4 <meta http-equiv="Content-Type" content="text/html">
   5 <meta name="description" content="Sketch">
   6 <meta name="generator" content="makeinfo 4.7">
   7 <link title="Top" rel="start" href="index.html#Top">
   8 <link rel="up" href="Drawables.html#Drawables" title="Drawables">
   9 <link rel="prev" href="Polygons.html#Polygons" title="Polygons">
  10 <link rel="next" href="Sweeps.html#Sweeps" title="Sweeps">
  11 <link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
  12 <!--
  13 Copyright (C) 2005, 2006, 2007, 2008 Eugene K. Ressler.
  14
  15 This manual is for `sketch', version 0.2 (build 161),
  16 Tuesday, September 08, 2009, a program that converts descriptions of simple
  17 three-dimensional scenes into static drawings. This version generates
  18 `PSTricks' or `PGF/TikZ' code suitable for use with the
  19 TeX document processing system.
  20
  21 `Sketch' is free software; you can redistribute it and/or modify
  22 it under the terms of the GNU General Public License as published by
  23 the Free Software Foundation; either version 3, or (at your option)
  24 any later version.
  25
  26 Sketch is distributed in the hope that it will be useful,
  27 but WITHOUT ANY WARRANTY; without even the implied warranty of
  28 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  29 GNU General Public License for more details.
  30
  31 You should have received a copy of the GNU General Public License
  32 along with `sketch'; see the file COPYING.txt.  If not, see
  33 http://www.gnu.org/copyleft.-->
  34 <meta http-equiv="Content-Style-Type" content="text/css">
  35 <style type="text/css"><!--
  36   pre.display { font-family:inherit }
  37   pre.format  { font-family:inherit }
  38   pre.smalldisplay { font-family:inherit; font-size:smaller }
  39   pre.smallformat  { font-family:inherit; font-size:smaller }
  40   pre.smallexample { font-size:smaller }
  41   pre.smalllisp    { font-size:smaller }
  42   span.sc { font-variant:small-caps }
  43   span.roman { font-family: serif; font-weight: normal; }
  44 --></style>
  45 </head>
  46 <body>
  47 <div class="node">
  48 <p>
  49 <a name="Specials"></a>Next:&nbsp;<a rel="next" accesskey="n" href="Sweeps.html#Sweeps">Sweeps</a>,
  50 Previous:&nbsp;<a rel="previous" accesskey="p" href="Polygons.html#Polygons">Polygons</a>,
  51 Up:&nbsp;<a rel="up" accesskey="u" href="Drawables.html#Drawables">Drawables</a>
  52 <hr><br>
  53 </div>
  54
  55 <!-- node-name,  next,  previous,  up -->
  56 <h4 class="subsection">3.2.5 Specials</h4>
  57
  58 <p><a name="index-special-273"></a><strong>Syntax:</strong>
  59 <pre class="example">     special $<var>raw_text</var>$[lay=<var>lay_value</var>] <var>point_list</var>
  60 </pre>
  61    <p class="noindent">Here <code>$</code>
  62 <a name="index-quoting_002c-special-274"></a>can be any character and is used to delimit the start
  63 and end of <var>raw_text</var>.  The command embeds <var>raw_text</var> in the
  64 <code>sketch</code> output after performing substitutions as follows.
  65 <a name="index-special-argument-substitution-275"></a><a name="index-argument_002c-special-276"></a>
  66      <ul>
  67 <li><code>#</code><var>i</var> where <var>i</var> is a positive integer is replaced by
  68 the <var>i</var>'th point in <var>point_list</var>.
  69 <li><code>#{</code><var>i</var><code>}</code> is also replaced as above.
  70 <li><code>#</code><var>i</var><code>-</code><var>j</var> where <var>i</var> and <var>j</var> are positive
  71 integers is replaced by a string <code>{</code><var>angle</var><code>}</code> where
  72 <var>angle</var> is the polar angle of a vector from the <var>i</var>'th point
  73 in <var>point_list</var> to the <var>j</var>'th.
  74 <li><code>#{</code><var>i</var><code>-</code><var>j</var><code>}</code> is also replaced as above.
  75 <li><code>##</code> is replaced with <code>#</code>.
  76 </ul>
  77    The forms with braces <span class="samp">{ }</span> are useful when the argument is
  78 immediately followed by a digit that is part of the TeX code.
  79
  80    <p>The only useful option of <code>special</code> is <code>lay</code>.
  81 <a name="index-lay-277"></a>See <a href="Internal-options.html#Internal-options">Internal options</a>.
  82
  83    </body></html>
  84