HTML Reference

Index

fieldpine:bucket
fieldpine:chart
fieldpine:if
fieldpine:loop
fieldpine:map
fieldpine:pinboard
fieldpine:symbol
fieldpine:variable
Variable substitution

<fieldpine:bucket>

Attributes

Name="Value"

source="Value"

order="Value"

want="Value"

select="Value"

limit="Value"

Result

<fieldpine:chart>

Attributes

type="Value"

size="Value"

percent="Value"

value="Value"

Result

Insert a generated graphic, such as a chart or progress bar into the HTML stream.

The type attribute defines the style of graphic to be inserted. Possible values are:

progress	Insert a progress bar that illustrates a percent from 0 to 100%
temp	Insert a thermometer device illustrating a single value or percentage
bar	Display a simple bar chart
line	Display a simple line chart

The size of the graphic can be set with the size attribute. This contains an X and Y size separated by a comma.

Example: <fieldpine:chart type="progress" percent="36" size="300,40">

<fieldpine:if>

Attributes

test="Value"

then="Value"

else="Value"

Result

The boolean expression given in the test attribute is evaluated. If the result of this test is true, the then attribute string is inserted into the output HTML, otherwise the else attribute string is used.

Boolean expressions are formed using Expr1 OP Expr2.

Valid Operators
>	True if Expr1 greater than Expr2	>=	True if Expr1 greater than or equal to Expr2
<	True if Expr1 less than Expr2	<=	True if Expr1 less than or equal to Expr2
= or ==	True if Expr1 equal to Expr2	<> or !=	True if Expr1 not equal to Expr2

<fieldpine:loop>

Attributes

maximum="Value"

index="Value"

position="Value"

Result

Start a repeating sequence. The HTML generator repeats each of the lines between the LOOP and closing LOOP from POSITION to MAXIMUM. On each pass, the variable name given by the index attribute contains the number of the repetition.

Example
     
     <fieldpine:variable name="maxrows" replace=0 value="30">
     . . .
     <table>
     <fieldpine:loop index=john maximum=%maxrows%>
     <tr> ...Insert each row of table

     </fieldpine:loop>
     </table>

<fieldpine:map>

Placeholder. Do not use.

<fieldpine:pinboard>

Lookup Attributes

Name="Value" Specifies the name of the pinboard to be retrieved.

mask="Value" Defines an optional formatting mask to be used to prepare the value before output.

variable="Value" Supplies and optional variable name to receive the pinboard value rather than displaying the result at this time.

Defining Attributes

sql="Value"

direct="Value"

result="Value"

server="Value"

limit="Value"

rc="Value"

meta="Value"

Result

Performs a pinboard retrieval and displays the output value.

<fieldpine:symbol>

Places a value or token which is processed in some way into the output HTML stream.

Attributes

Name="Value"

mask="Value"

Result

When the name attribute is date, datetime or time the generator inserts the current system date and/or time into the output stream. A mask can be specified to control how the value is formatted, but a default mask is provided for each of the values date, datetime and time. The only difference between these 3 values is the default mask, using name="date" allows you to reference any of the date or time fields. Equally, using name="time" still allows you to output parts of the date.

If the optional mask parameter is supplied, the current date/time value is processed through a routine that behaves like the C function, strftime(). The following table shows the fields that can be used to create masks.

%a	Abbreviated weekday name	%A	Full weekday name
%b	Abbreviated month name	%B	Full month name
%d	Day of month as a number	%H	Hour in 24 hour clock (00 - 23)
%I	Hour in 12 hour clock (00 - 12)	%j	Day of year as a number (1+)
%m	Month as a number (01 - 12)	%M	Minute as a number (00 - 59)
%p	Current AM/PM indicator for this system locale	%S	Seconds as a number (00 - 59)
%U	Week of year as a number (00 - 51), using Sunday as first day of week	%W	Week of year as a number (00 - 51), using Monday as first day of week
%w	Weekday as a number. 0= Sunday, 1=Monday, etc	%y	2 digit year
%Y	4 digit year	%Z	Timezone information

Example: <fieldpine:symbol name="date" mask="%d-%B-%Y">

When the name attribute is sitelogo the HTML generator inserts an HTML IMG tag referencing the current logo for this Server. A default Fieldpine logo is provided, however administrators are free to replace this logo with their own.

Example: <fieldpine:symbol name="sitelogo">

When the name attribute is default-theme the HTML generator inserts the appropriate HTTP LINK headers for the users preferred style sheet, called a theme. The GDS server has a default system wide theme, however users can choose their own personal theme to suit their own requirements and tastes.

If a user has chosen to have a personal theme, a cookie is stored into their browser, as this tag reads that cookie value are inserts the correct HTML.

This tag should only be placed in the HEAD section of the HTML document. The server does not attempt to place the output in the head section if you incorrectly place the tag in the main BODY section.

Example: <fieldpine:symbol name="default-theme">

<fieldpine:variable>

Attributes

Name="Value" Defines the name of the variable to be processed. Variable names must only contain the letters A to Z or the number 0 to 9. The first character in a variable name must be a letter in the range A..Z.

replace="Value" If the variable named has already been defined, this parameter controls whether this definition is to replace the existing variable definition. The default value of this parameter is "1", meaning to replace any existing value.

This option is especially useful to define pre selected defaults on reports that can be overriden by the user as they work with the report. By defining the parameters with replace="0", the user is able to change parameters, but you can also be certain that a variable is always defined.

display="Value" When set to "1", this parameter instructs the report generator to insert the variable into the output HTML as text. The default operation is to manipulate variables and not display them on the output HTML stream.

formula="Value" Causes the variable value to be calculated using the formula given. Formulas are processed strictly left to right (and as such are not mathematically sound). We recommend only performing one operation per step in order to reduce later confusion.

value="Value"

if="Value"

mask="Value"

Result

Variable Substitution

As the HTML generator processes each line, the first step is to replace any variables present. Variables are enclosed inside percent signs to have them replaced.

Example: The value of tloc is %tloc%

Server Defined Variables

A number of predefined variables exist which can be read like ordinary variables.

%remote-ipaddr%

This variable holds the remote IP address of the caller in dotted numeric format, where available.

Example:
<fieldpine:variable name="tloc" replace=0 value="0">
<fieldpine:variable name="tloc" replace=1 value="101" if="%remote-ipaddr%=127.0.0.1">

Set the variable tloc to Zero, unless the caller is coming from IP address 127.0.0.1 (the localhost), in which case the variable tloc is set to a value of 101.