Branch: Tag:


2001-02-20 09:48:13 by Kenneth Johansson <>

Documentation updates

Rev: server/base_server/rxml.pike:1.268
Rev: server/modules/graphics/business_graphics/business.pike:1.138
Rev: server/modules/graphics/gbutton.pike:1.69
Rev: server/modules/graphics/graphic_text.pike:1.260
Rev: server/modules/tags/html_wash.pike:1.18
Rev: server/modules/tags/obox.pike:1.34
Rev: server/modules/tags/rxmltags.pike:1.197
Rev: server/modules/tags/tablify.pike:1.62
Rev: server/modules/tags/vform.pike:1.18

1:   // This is a roxen module. Copyright © 1996 - 2000, Roxen IS.   //    - constant cvs_version="$Id: graphic_text.pike,v 1.259 2001/01/30 23:48:46 nilsson Exp $"; + constant cvs_version="$Id: graphic_text.pike,v 1.260 2001/02/20 09:48:09 kuntri Exp $";      #include <module.h>   inherit "module";
116: Inside #if defined(manual)
   negative values for distance is possible, but you might have to add    'spacing'.</p>    <ex type=vert> - <gtext scale=\"0.8\" fgcolor=\"#FF6600\" bshadow=\"1\">&lt;gtext bshadow=1&gt;</gtext><br /> - <gtext scale=\"0.8\" fgcolor=\"#FF6600\" bshadow=\"2\">&lt;gtext bshadow=2&gt;</gtext> + <gtext scale=\"0.8\" fgcolor=\"#FF6600\" bshadow=\"1\">&lt;gtext + bshadow=1&gt;</gtext><br /> +  + <gtext scale=\"0.8\" fgcolor=\"#FF6600\" bshadow=\"2\">&lt;gtext + bshadow=2&gt;</gtext>    </ex>   </attr>   
125: Inside #if defined(manual)
   Make the text look like it has been cut into the background.</p>    <ex type=vert>   <gtext font=\"lucida\" bold=\"\" chisel=\"\" talign=\"center\" tile=\"\" - opaque=\"70\" fgcolor=\"gold\" bevel=\"2\" background=\"/internal-roxen-squares\"> Chisel - opaque=70</gtext> + opaque=\"70\" fgcolor=\"gold\" bevel=\"2\" + background=\"/internal-roxen-squares\"> Chisel opaque=\"70\"</gtext>    </ex>   </attr>   
173: Inside #if defined(manual)
  <attr name='ghost' value='dist,blur,color'><p>    Apply a ghost effect. Cannot be used together with shadow or magic    coloring.</p> -  <ex type=vert> +  <ex type='vert'>   <gtext spacing=\"2\" crop=\"\" ghost=\"1,1,red\">ghost=1,1,red</gtext>   <gtext spacing=\"2\" crop=\"\" ghost=\"1,3,blue\">ghost=1,3,blue</gtext> - <gtext spacing=\"2\" crop=\"\" bshadow=\"1\" opaque=\"90\" ghost=\"-1,1,yellow\">ghost=-1,1,yellow opaque=90 bshadow=1</gtext> + <gtext spacing=\"2\" crop=\"\" bshadow=\"1\" opaque=\"90\" ghost=\"-1,1,yellow\"> + ghost=-1,1,yellow opaque=90 bshadow=1</gtext>    </ex>   </attr>   
199: Inside #if defined(manual)
   image. This will not change the size of the image.</p>   </attr>    - <attr name='narrow><p> + <attr name='narrow'><p>    Use a narroe version of the font, if available.</p>   </attr>   
207: Inside #if defined(manual)
   Do not make the background transparent. Useful when making 'boxes' of    color around the text.</p>    <ex type=vert> - <gtext bgcolor=\"red\">&lt;gtext bgcolor=red&gt;</gtext> - <gtext bgcolor=\"red\" notrans=\"\">&lt;gtext bgcolor=red notrans&gt;</gtext> + <gtext bgcolor=\"red\">&lt;gtext bgcolor=red&gt;</gtext><br /> + <gtext bgcolor=\"red\" notrans=\"\">&lt;gtext + bgcolor=red notrans&gt;</gtext>    </ex>   </attr>   
222: Inside #if defined(manual)
   the two background colors.</p>    <ex type=vert>   <gtext scale=\"0.6\" textbox=\"100,pink,-11\" bgcolor=\"lightblue\" -  notrans=\"\" opaque=\"40\" fgcolor=\"black\">&lt;Demonstration of opaque text&gt;</gtext> + notrans=\"\" opaque=\"40\" fgcolor=\"black\" + >&lt;Demonstration of opaque text&gt;</gtext>    </ex>   </attr>   
230: Inside #if defined(manual)
   Draw an outline around the text. Quite useful when combined with    textscale.</p>    <ex type=vert> - <gtext xspacing=\"4\" quant=\"128\" textscale=\"red,red,yellow,yellow\" outline=\"black,1\">black, 2 pixels</gtext> + <gtext xspacing=\"4\" quant=\"128\" textscale=\"red,red,yellow,yellow\" + outline=\"black,1\" + >black, 2 pixels</gtext>    </ex>   </attr>   
284: Inside #if defined(manual)
   does not currently place the shadow directly below the text. Using negative    values for distance is possible,</p>    <ex type=vert> - <gtext scale=\"0.8\" fgcolor=\"blue\" shadow=\"40,0\">&lt;gtext shadow=40,0&gt;</gtext><br /> - <gtext scale=\"0.8\" fgcolor=\"blue\" shadow=\"40,2\">&lt;gtext shadow=40,2&gt;</gtext><br /> + <gtext scale=\"0.8\" fgcolor=\"blue\" shadow=\"40,0\">&lt;gtext + shadow=40,0&gt;</gtext><br /> +  + <gtext scale=\"0.8\" fgcolor=\"blue\" shadow=\"40,2\">&lt;gtext + shadow=40,2&gt;</gtext><br />    </ex>   </attr>   
306: Inside #if defined(manual)
   area. Useful together with background to make captions for images.</p>    <ex type=vert>   <img src=\"/internal-roxen-roxen\" /> &nbsp; - <gtext scale=\"0.5\" background=\"/internal-roxen-roxen\" textbelow=\"#c0c0c0\">Roxen</gtext> + <gtext scale=\"0.5\" background=\"/internal-roxen-roxen\" + textbelow=\"#c0c0c0\">Roxen</gtext>    </ex>   </attr>   
320: Inside #if defined(manual)
   It is probably a good idea to increase the 'quant' value when    using this argument.</p>    <ex type=vert> - <gtext quant=\"128\" textscale=\"blue,red,black,darkgreen\">Blue, red, black, darkgreen</gtext> + <gtext quant=\"128\" textscale=\"blue,red,black,darkgreen\" + >Blue, red, black, darkgreen</gtext>    </ex>   </attr>      <attr name='texture' value='path'><p>    Uses the specified images as a field texture.</p>   <ex type=hor> - <gtext font=\"yikes\" fontsize=\"100\" texture=\"/internal-roxen-squares\">A</gtext> + <gtext font=\"yikes\" fontsize=\"100\" + texture=\"/internal-roxen-squares\">A</gtext>   </ex>   </attr>   
467:   <attr name='split'>    <p>Make each word into a separate gif image. Useful if you are    writing a large text, and word wrap at the edges of the display is -  desired. This text is an example (try resisizing your browser window, -  the images should move just like normal text would).</p> +  desired.</p>      <ex type='vert'>    <gtext scale='0.4' split='split'>    Useful if you are writing a large text, and word wrap at the edges -  of the display is desired. This text is an example (try resisizing -  your browser window, the images should move just like normal text -  would). +  of the display is desired.    </gtext>   </ex>       <p>This will allow the browser to word-wrap the text, but will -  disable certain attributes like <att>magic</att>.</p> +  disable certain attributes like <att>magic</att>. Note that the word +  wraping functionality of this example cannot be shown as the size of +  the browser window is determined by the largest example box. </p>       <ex type='vert'>   <gtext scale=\"0.4\" split=\"\">Make each word..</gtext>