Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > ed05dc5f357c49fdded780f52b150dce > files > 111

ploticus-2.41-2mdv2010.0.i586.rpm

<html>
<head>
<!-- This file has been generated by unroff 1.0, 03/11/09 12:56:22. -->
<!-- Do not edit! -->
<STYLE TYPE="text/css">
<!--
        A:link{text-decoration:none}
        A:visited{text-decoration:none}
        A:active{text-decoration:none}
        OL,UL,P,BODY,TD,TR,TH,FORM { font-family: arial,helvetica,sans-serif;; font-size:small; color: #333333; }

        H1 { font-size: x-large; font-family: arial,helvetica,sans-serif; }
        H2 { font-size: large; font-family: arial,helvetica,sans-serif; }
        H3 { font-size: medium; font-family: arial,helvetica,sans-serif; }
        H4 { font-size: small; font-family: arial,helvetica,sans-serif; }
-->
</STYLE>
<title>ploticus: proc settings</title>
<body bgcolor=D0D0EE vlink=0000FF>
<br>
<br>
<center>
<table cellpadding=2 bgcolor=FFFFFF width=550><tr>
<td>
  <table cellpadding=2 width=550><tr>
  <td><br><h2>proc settings</h2></td>
  <td align=right>
  <small>
  <a href="../doc/welcome.html"><img src="../doc/ploticus.gif" border=0></a><br>
  Version 2.41 Mar2009
     </small><br><a href="../doc/scripthome.html">Scripts</a>
  <td></tr></table>
</td></tr>
<td>
<br>
<br>

<title>Manual page for proc_settings(PL)</title>
</head>
<body>

This proc allows the script programmer to make certain overall settings.<tt> </tt>
Many scripts will not need to use it.<tt> </tt>
However, it can be used to set default display notations for dates or numbers,
to set overall date processing behavior attributes, to set certain
system resource attributes, or to set attributes related to the generation of SVG files.<tt> </tt>
<p>
<b>proc settings</b> may be used more than once per script if desired.<tt> </tt>
The settings take effect immediately.<tt> </tt>
Most of these settings can be also made using a
<a href="config.html">
 config file
</a>
, and several can be made on the
<a href="pl.1.html">
 pl command line.<tt> </tt>
</a>
<p>
Processing is done in this order: first the config file is read, then command line args are processed (left to right),
then proc settings executes.  Later settings override earlier ones.<tt> </tt>

<p>
Note: this proc was previously called <b>proc datesettings</b>.<tt> </tt>
It has been renamed because its functionality has been expanded.<tt> </tt>
For backward compatibility, the <b>dateformat</b> attribute
may be accessed using its old name <b>format</b>.<tt> </tt>

<br><br><br>

<h2>Example</h2>
See the gallery example
<a href="../gallery/settingsdemo.htm">
 settingsdemo
</a>

<br><br><br>

<h2>General settings</h2>

<br><br>



<p>
<b>units</b> 
&nbsp; &nbsp;
<tt>in | cm</tt>
<dl>
<dt> <dd>
The measurement unit to be used for ploticus absolute units.  
Either <tt>in</tt> (inches) or <tt>cm</tt> (centimeters).<tt> </tt>
Default is <tt>in</tt>.<tt> </tt>
If this is set in the config file, it will be in effect when command line
arguments are evaluated.  If set in <b>proc settings</b>, it will not have any
effect on command line argument evaluation.<tt> </tt>
<br>
Example: <tt>units: cm</tt>

<br><br>
<a name=encodenames></a>

</dl>
<p>
<b>encodenames</b>
&nbsp; &nbsp;
<tt>yes | no</tt>
<dl>
<dt> <dd>
If <tt>yes</tt>, spaces and commas can be represented in field names using an encoding scheme where
a space is represented using an underscore (_) and a comma is represented using a vertical bar (|).<tt> </tt>
Useful in situations where field names will be visible directly as legend labels or axis stubs.<tt> </tt>
For scripts, the default is <tt>no</tt> for backward compatibility.  For prefabs the default is <tt>yes</tt>.<tt> </tt>
(2.30+)
Example: 
<a href="../gallery/students.htm">
 students
</a>



<br><br>
</dl>
<p>
<b>enable_suscripts</b>
&nbsp; &nbsp;
<tt>yes | no</tt>
<dl>
<dt> <dd>
If <tt>yes</tt>, 
<a href="fonts.html">
 inline superscripts and subscripts
</a>
capability is turned on.  (2.30+).  For scripts, the default is <tt>no</tt> for backward compatibility.  
For prefabs the default is <tt>yes</tt>.<tt> </tt>
<a href="../gallery/supsub.htm">
 Here's an example.<tt> </tt>
</a>

<br><br>
</dl>
<p>
<b>errmsgpre</b>
&nbsp; &nbsp;
<tt>tag</tt>
<dl>
<dt> <dd>
Allows developer to set the first portion of all ploticus error messages to <tt>tag</tt>
(it will stay in effect until explicitly set again).<tt> </tt>
For example, where a web page generates multiple plots it may be useful in identifying
which plot had the error.<tt> </tt>

<br><br>

</dl>
<p>
<b>font</b>
&nbsp; &nbsp;
<i>fontname</i>
<dl>
<dt> <dd>
Make <i>fontname</i> the default font.  
Font names having embedded spaces will be parsed correctly (but may still be problematic).<tt> </tt>
For more information see
<a href="fonts.html">
 fonts.<tt> </tt>
</a>

<br><br>

</dl>
<p>
<b>numbernotation</b> 
&nbsp; &nbsp;
<tt>standard | us | euro</tt>
<dl>
<dt> <dd>
Specifies how decimal point and thousands separators will be displayed.  
Default is <tt>standard</tt>.<tt> </tt>
The following table illustrates:
<p>
<pre>
 standard           us             euro
----------    ------------    -------------
     79              79               79
     79.5            79.5             79,5  
   4321.79         4321.79          4321,79 
  54321          54,321           54.321
 654321.07      654,321.07       654.321,07
1987654321    1,987,654,321    1.987.654.321


</pre>
</dl>
<p>
<b>numberspacerthreshold</b>  
&nbsp; &nbsp;
<i>n</i>
<dl>
<dt> <dd>
Specifies at what numeric magnitude thousands separators will begin to be inserted.<tt> </tt>
Default is 4, and this is used in the above table.  If it were set to <tt>3</tt>, the third entry
in the above table would appear like this:
<pre>
   4321.79         4,321.79          4.321,79 
</pre>


<br><br><br>
</dl>
<h2>PostScript / EPS settings</h2>

<b>ps_latin1_encoding</b>
&nbsp; &nbsp;
<tt>yes | no</tt>
<dl>
<dt> <dd>
A latin1 encoding scheme has been added to the postscript driver to make
extended ascii characters consistent with other graphical formats, and this
encoding is in effect by default.  To disenable feature set this to <tt>no</tt>.<tt> </tt>
You may want to try this if other applications are having trouble with your EPS files.<tt> </tt>
(2.30+)



<a name=svg></a>

<br><br><br>
</dl>
<h2>SVG / XML settings</h2>
<p>
Overall settings affecting 
<a href="svg.html">
 SVG graphics.<tt> </tt>
</a>

<p>
<b>xml_declaration</b>  
&nbsp; &nbsp;
<tt>yes | no</tt>
<dl>
<dt> <dd>
The default (<tt>yes</tt>) causes the first line of the SVG result to contain the XML declaration <tt>&lt;?xml .. &gt;</tt> .<tt> </tt>
Use <tt>no</tt> to suppress the XML declaration line if the SVG result is to be embedded into 
a larger XML document.  This may also be done using the <tt>-omit_xml_declaration</tt>
<a href="pl.1.html">
 command line argument.<tt> </tt>
</a>

&nbsp; &nbsp;

</dl>
<p>
<b>xml_encoding</b>  
&nbsp; &nbsp;
<i>method</i>
<dl>
<dt> <dd>
This may be used to set the XML character encoding method.  
It has no effect when <tt>xml_declaration</tt> is <tt>no</tt>.<tt> </tt>
The default is <tt>iso-8859-1</tt> which provides Latin and Western European character sets.<tt> </tt>
For Unicode fonts this should be set to <tt>utf-8</tt> (for more discussion see the Unicode section in 
<a href="fonts.html">
 fonts
</a>
).  
Equivalent to the <tt>-xml_encoding</tt>
<a href="pl.1.html">
 command line argument.<tt> </tt>
</a>

<br><br>

</dl>
<p>
<b>svg_tagparms</b>  
&nbsp; &nbsp;
<tt>text</tt>
<dl>
<dt> <dd>
Allows allows arbitrary <tt>text</tt> to be inserted into the opening <tt>&lt;svg&gt;</tt> tag.<tt> </tt>
<br>
Example: <tt>svg_tagparms:  height="5cm" width="8cm"</tt>

<br><br>

</dl>
<p>
<b>svg_mouseover_js</b>
&nbsp; &nbsp;
<tt>method1 | generic</tt>
<dl>
<dt> <dd>
Specifies the method to use for SVG mouseover.  The default is <tt>method1</tt>, which provides
standalone SVG mouseover support (the SVG result will contain embedded references to javascript files
<tt>GraphPopups.js</tt> and <tt>ViewBox.js</tt>).<tt> </tt>
Specify <tt>generic</tt> here if you're using some other javascript strategy such as overlibmws ("method #2").<tt> </tt>
For more discussion, see the
<a href="svg.html#mouseover">
 ploticus SVG manual page, mouseover section.<tt> </tt>
</a>

<br><br>

</dl>
<p>
<b>svg_linkparms</b>
&nbsp; &nbsp;
<tt>text</tt>
<dl>
<dt> <dd>
DISCONTINUED in 2.33+ .... use the new <tt>clickmapurl: [target=new]http://www.abc.com/...</tt> 
&nbsp; &nbsp;
syntax described
<a href="clickmap.html">
 here.<tt> </tt>
</a>
<br>
<strike>
When generating SVG 
<a href="clickmap.html">
 clickmap-enabled
</a>
results, this
allows additional attributes to be supplied to 
<a href="http://www.w3.org/TR/SVG11/linking.html">
 SVG's &lt;a .. &gt; construct.<tt> </tt>
</a>
</strike>


<br><br><br>

</dl>
<h2>System environment</h2>

<p>
<b>cpulimit</b>
&nbsp; &nbsp;
<i>s</i>
<dl>
<dt> <dd>
Sets a unix resource limit on cpu time to <i>s</i> seconds.  Default is 30 seconds.<tt> </tt>
See also the -cpulimit command line option.<tt> </tt>

&nbsp; &nbsp;


<br><br><br>
<a name=dates></a>

</dl>
<h2>Date-related</h2>

<p>
<b>dateformat</b> 
&nbsp; &nbsp;
<i>format</i>
<dl>
<dt> <dd>
Set the current date format.<tt> </tt>
<i>format</i> must be a
date format from the
<a href="dates.html">
 dates manual page
</a>
that includes month, day, and year, for which arithmetic is supported.<tt> </tt>
To use other arithmetic date formats (such as quarter notation)
specify the format in the 
<a href="areadef.html">
 proc areadef
</a>
xscaletype or yscaletype attribute.<tt> </tt>
<br>
Example: <tt>dateformat: dd-mmm-yyyy</tt>


&nbsp; &nbsp;

</dl>
<p>
<b>omitweekends</b>  
&nbsp; &nbsp;
<tt>omit | adjust | yes | no</tt>
<dl>
<dt> <dd>
Allows date plotting as if
Saturdays and Sundays did not exist.<tt> </tt>
Mondays will follow Fridays directly.  
Useful in certain business and work-related plots.<tt> </tt>
<br>
If <tt>omit</tt>, any Saturday or Sunday dates encountered will be considered invalid and omitted;
however they will not be reported unless the -showbad command line option is used.<tt> </tt>
If <tt>omit</tt> is set then Saturday or Sunday dates can generate a bad date error in some circumstances,
such as when given in an axis range.<tt> </tt>
<br>
If <tt>adjust</tt> or <tt>yes</tt>, any Saturday or Sunday dates encountered will be silently adjusted 
to the nearest weekday.  This is more lenient than <tt>omit</tt>, and avoids the possibility of 
a bad date error.<tt> </tt>


&nbsp; &nbsp;

</dl>
<p>
<b>pivotyear</b> 
&nbsp; &nbsp;
<i>yy</i>
<dl>
<dt> <dd>
Set the two digit year that should be used to convert
two-digit years to four-digit years.  If two-digit years are 
used, year values that are less than the pivot year are assumed
to be 21st century years.  Default is 77.<tt> </tt>
<br>
Example: <tt>pivotyear: 50</tt>

&nbsp; &nbsp;

</dl>
<p>
<b>months</b> 
&nbsp; &nbsp;
<i>list</i>
<dl>
<dt> <dd>
Specify the three-character month abbreviations to be used, all in lower case,
beginning with the first month.<tt> </tt>
Default is the English (<tt>jan feb mar apr may jun jul aug sep oct nov dec</tt>).<tt> </tt>
<br>
Example (Spanish) (must all be on one line): 
<br>
<tt>months: ene feb mar abr pue jun jul ago sep oct nov dic</tt>

&nbsp; &nbsp;

</dl>
<p>
<b>months.abbrev</b> 
&nbsp; &nbsp;
<i>list</i>
<dl>
<dt> <dd>
short month names, capitalized for presentation, begining with the first month.<tt> </tt>
Default is English (<tt>Jan Feb Mar Apr May June July Aug Sept Oct Nov Dec</tt>).<tt> </tt>
<br>
Example (Spanish) (must all be on one line): 
<br>
<tt>months.abbrev: Ene Feb Mar Abr Pue Jun Jul Ago Sep Oct Nov Dic</tt>

&nbsp; &nbsp;

</dl>
<p>
<b>months.full</b> 
&nbsp; &nbsp;
<i>list</i>
<dl>
<dt> <dd>
full month names, capitalized for presentation.<tt> </tt>
<br>
Example (Spanish) (must all be on one line): 
<br>
<tt>months.full: Enero Febrero Marzo Abril Mayo Junio Julio Agosto Septiembre Octubre Noviembre Diciembre</tt>

&nbsp; &nbsp;

</dl>
<p>
<b>weekdays</b>  
&nbsp; &nbsp;
<i>list</i>
<dl>
<dt> <dd>
three-character weekday abbreviations, capitalized for presentation,
beginning with Sunday.<tt> </tt>
<br>
Example (French): <tt>weekdays: Dim Lun Mar Mer Jeu Ven Sam</tt>
<br>
Example (Spanish): <tt>weekdays: Dom Lun Mar Mie Jue Vie Sab</tt>

&nbsp; &nbsp;

</dl>
<p>
<b>lazydates</b>  
&nbsp; &nbsp;
<tt>month | day | both</tt>
<dl>
<dt> <dd>
Allow handling of dates where the day component
or the month component is not known.  See
<a href="dates.html">
 dates
</a>
for further discussion of lazy dates.<tt> </tt>

&nbsp; &nbsp;

</dl>
<p>
<b>strictdatelengths</b>  
&nbsp; &nbsp;
<tt>yes | no</tt>
<dl>
<dt> <dd>
Default is <tt>no</tt>.<tt> </tt>
Use <tt>yes</tt> to ensure that malformed date values will be detected--
for example, if the date format is <tt>mm/dd/yyyy</tt> a date value such as <tt>03/04/2001</tt>
would be ok but <tt>3/4/2001</tt> would result in an error.<tt> </tt>
If this attribute is <tt>no</tt>, format checking is relaxed, and the latter case above would be ok.<tt> </tt>

&nbsp; &nbsp;

</dl>
<p>
<b>dtsep</b>  
&nbsp; &nbsp;
<i>character</i>
<dl>
<dt><dd><p>
Date / time separator character for datetime data items.<tt> </tt>
By default this is dot <tt>.</tt>.  However ISO8601 uses <tt>T</tt>, eg. 29Mar03T03:16:00 ..<tt> </tt>
This character should be one that never appears in the dates or times themselves.<tt> </tt>
<br>
Example: <tt>dtsep: T</tt>





<br>
<br>
</td></tr>
<td align=right>
<a href="../doc/welcome.html">
<img src="../doc/ploticus.gif" border=0></a><br><small>data display engine &nbsp; <br>
<a href="../doc/Copyright.html">Copyright Steve Grubb</a>
<br>
<br>
<center>
<img src="../gallery/all.gif"> 
</center>
</td></tr>
</table>
<br>
<center>
<table><tr><td>
Ploticus is hosted at http://ploticus.sourceforge.net</td><td> &nbsp; </td><td>
<a href="http://sourceforge.net/projects/ploticus"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=38453&type=12" 
width="120" height="30" border="0" 
alt="Get ploticus data display engine at SourceForge.net. Fast, secure and Free Open Source software downloads" /></a>
</td></tr></table>


</center>
</dl>
<p><hr>
Markup created by <em>unroff</em> 1.0,&#160;<tt> </tt>&#160;<tt> </tt>March 11, 2009.
</body>
</html>