This is the XML Schema for XML FiForm definitions. Please use this namespace for fiform elements: http://xml.fiforms.org/FiForms/ This Schema is distributed with FiForms, a collection of PHP classes designed to facilitate rapid development of web-database software Copyright (C) 2003-2007 Daniel McFeeters This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA The original author of this library can be contacted at the following address: Daniel McFeeters 182 Baker Rd. Faubush, KY 42544-6526 email:databases at alltel dot net You can find out more about FiForms Solutions and download the open-source (LGPL) collection of FiForms PHP Classes from www.fiforms.org Included so that metadata described in the FiForms Application schema can be included in FiForms. This imports the XHTML namespace, so that XHTML elements can be embedded in FiForms. This is the root element of a FiForm Report definition. Attributes of this element affect the behaviour of the report and define permissions. File name of an XSLT stylesheet that should be used to transform the resulting XML. Description of stylesheet displayed in selection box. Mark this as the default selected stylesheet. Security descriptor. Only the mentioned user or group will be allowed to view the report. URI of server where FiForm generate.php script resides. Used only for user-defined reports where the report definition is submitted to the server from the parameter page. (This configuration is not recommended for production servers where security is a concern.) This is the root element of a FiForm definition. Attributes of this element affect the behaviour and appearance of the form and define permissions. Specifies where the navigation links appear on the form in form view Specifies where the navigation links appear on the form in sheet view Specifies which view modes are allowed for this form. A value of "none" disables the form. Suggests the preferred view mode for the form when it is opened from a menu. If this is "no", viewing existing data in any mode is not allowed. If this is "no", inserting new records is not allowed. If this is "no", updating records is not allowed. Action after a record is inserted. "new" moves to a new record. "current" saves the record and returns to editing the same record. "sheet" returns to sheet mode after insert. If this is "none", inserting records is not allowed. Specifies which navigation links are shown. The maximum number of records per page in sheet view. The title above the form. A description of the form, often displayed in verbose menu screens. Possible combinations of controls allowed in whichControls attribute of fiform element PHP code executed when the form is viewed. The code does not need to be enclosed in XML processing instructions (i.e. ?php tags) File name of XML query (report) definition to load row data from Javascript expression which evaluates to calculate a single value on a form, instead of loading an external datasource. The field names of controls on form that trigger this control to refresh from the loaddata query. iText (data-bound text box) FiForm object. Name of XML report definition to use to load data. Size of the input box (characters) Regular Expression defining a custom format restriction. Transform text to uppercase or lowercase. iNumber FiForm object for input of numerical data Name of XML report definition to use to load data. Size of the input box (characters) Number of decimal places for fixed-decimal values. The total number of digits allowed in the field (including decimals) Character prefix appearing before the numeric field (i.e. $) Thousands seperator. Default is comma (,) Decimal Point character. Default is period (.) iUUID data bound globally unique ID FiForm object. iHidden (hidden data-bound text box) FiForm object. iTextArea (data-bound text area) FiForm object. Equivalant to iText, but uses textarea instead of input Number of rows (height) of text area Number of columns (width) of text area iROText (read-only database field) FiForm object. Note that this does not actually create a form object that will be submitted, it simply prints the value of the field in text on the HTML page. This should be combined with iHidden if you want the value submitted on the form, or use iText disabled="disabled" to display the field in a disabled text box. iCheck (data-bound check box) FiForm object. iFile FiForm object, to enable upload of pictures and files stored in a database BLOB field. The way in which the data is displayed. iDBSelect (data bound selection, drop-down box, or radio button group) FiForm object. Options can be queried from the database by specifing a query in the rowQuery attribute or they can be specified here manually with option elements inside the iDBSelect element. Name of XML report definition to use to load data. SQL query for row options. This query should return either 1 or 2 columns. If 1 column is returned, the values are used for the values and text in the select box. If 2 columns are returned, the first is used as the values stored in the field and the second is used as the display text. Foreign table linked to by this field Foreign Key field name in foreign table (ftable) Field name or SQL expression to obtain display value from. If (fkey) is specified but not fvalue, then fvalue defaults to fkey. Name of XML form to edit records in linked table (ftable) Presentation of select box (select, radio, or dynamic) Option listing under iDBSelect. Although similar in syntax and function, this is not to be confused with the option element in the XHTML namespace. Type definition for option under iDBSelect. "Key" value. If not specified, the value of the option is used. iDateText (data-bound date input box) FiForm object. Link to a page (iLink FiForm object) URI of page Text of the link (contents of anchor element in HTML) Column heading or text beside the link. Possible viewmode values for ifile Possible types for iLink Construct for conditional definitions. Elements inside this element will be present only if the condition is true. Note: This schema technically allows elements under "if" that belong in the "connection", "fiforms", or "wrapper" elements. Although this may be technically allowed by the schema, no element is allowed under "if" that would not be allowed if it were outside the "if" element. Name of any GET variable passed to the form. (i.e. sheetView) Any one of the comparison operators allowed in testValues The value to compare "param" to, if necessary (depending of test) Possible comparison operators for "if" Possible views for a subform. Group of controls and elements that can be found under "fiform" or "if" elements Name of the window to open in. Display the menu bar? Display the tool bar? Display scroll bars? Window is resizable? Display the location bar? Width of the window (in pixels) Height of the window (in pixels) iSubform FiForm object. This displays a separate form in an iframe to show/edit related records. Caption text displayed for this field. File name of linked form. The default view of the subform. Normal is data entry view, starting on first record. Sheet is sheet view. New is data entry view starting with a new record. Parameters passed to subform. Name=value pairs delimited with ampersand (&) signs. Variable substitutions will be made for all field names enclosed in percent (%) signs. eg. params="fk1=%pk%&fk2=%pk2%" Width of the iframe, in pixels. Height of the iframe, in pixels. Foreign Key in the table linked in the subform. FiForm iCustomInput Object. A fully customizable control. The contents of this control will simply be copied into the form, with variable substitutions made in between percent (%) signs. Caption text displayed for this field. Expression evaluated to create the control. Field names enclosed in %% signs will be expanded to field values. Deprecated input element. If possible, specific elements such as iText, iTextArea, iDateText, etc. should be used as they are more expressive. Type of input. (i.e. "iText", "iTextArea") First Parameter passed to constructor (after field name) Second Parameter Third Parameter, etc. The name of the database field to which this input is bound, and also the name of the field in the HTML form. If this name does not match any field in the database, the input will simply not be bound to any field, but the value will be submitted with this name. Second Parameter Default value for this field in new records. If this is an iDateText value, the special default value of "today" will always default to today's date. MySQL database datatype to use for field (not including length of field). If not specified, this will default to a sensible values based on the type of input. Default datatypes are as follows: iHidden: VARCHAR; iText: VARCHAR; iTextArea: TEXT; iDateText: DATE; iDBSelect: VARCHAR; iCheck: TINYINT; iUUID: VARCHAR; Maximum number of characters in field. For iText and iHidden elements, this defaults to 100 if size is not specified, or to size * 2 if size is specified. Display element on sheet, form, both, or none Javascript executed when the field is changed. Javascript executed when the field has lost the focus. Javascript executed when the field gains the focus. Javascript executed on key press Javascript executed on key down Set to "no" to disable this iInput If set, this element will be read only on the form. Database types for which support may be added. Currently, only MySQL is supported. Information needed to connect with the database. Primary Key(s) of table, used to update. Type of database to connect to. Currently only MySQL is supported. Numerical ID of connection. Usually 1. Hostname or IP address of server. Leave blank for default (localhost) Database to select after connecting. Information about the table that will be updated by this form. Optional. Username to use in connecting to database. Optional. Password to use in connecting to database. Name of the primary table this form updates. Although a query can be specified to retreive rows from any table, only this will be updated. Optional specification of an SQL query to retreive data for the form. Note that only the table specified in "update" will be updated. Also, column names from the query must match the names of the fields in the underlying table on all fields that are to be updated. The dataQuery should not contain a GROUP BY or HAVING clause. If grouped results are desired, you can use a sub-query in MySQL 4.1 or later. eg. "SELECT * FROM (SELECT a, SUM(b) FROM table1 GROUP BY a) as t". Note, however, that such an arrangement may yield unpredictable results if updates are allowed, as aggregate queries do not necessarily have a 1 to 1 relationship with underlying data. Field Listing and Formating Information. If this element is present, only the listed fields will be present. The content of this element should match the name of the field returned by the SQL query. A column header alias (a element) should be supplied for each field, and optionally summary and formatting information. Currently this element is only implemented in FiReports. Including it in a query in a FiForm has no effect at this time. Field Alias or Column Heading. Should be a short description of the field. Summary options for totalling the field. Field Format. Decimal format for numbers. This is a string passed to the xslt format-number function. For example, a currency field could have a format of "$#,##0.00" SQL query with "var" substitutions mixed in. Note for forms that Text content with param elements mixed in. Parameter substitution element Name of parameter to substitute Parameter retreived either from GET or from a parent query. Pieces of HTML code substituted at various places in the resulting HTML document to create a custom page header, page footer, and/or javascript tags or links in the HTML header.