[Idrs-commit] CVS: Idrs/docs RML.htm,1.3,1.4
Brought to you by:
bigman921
Menu
▾
▴
[Idrs-commit] CVS: Idrs/docs RML.htm,1.3,1.4
|
From: Marc B. <big...@us...> - 2002-04-13 16:06:41
|
Update of /cvsroot/idrs/Idrs/docs In directory usw-pr-cvs1:/tmp/cvs-serv29359/docs Modified Files: RML.htm Log Message: added YesNo and formInput tags Index: RML.htm =================================================================== RCS file: /cvsroot/idrs/Idrs/docs/RML.htm,v retrieving revision 1.3 retrieving revision 1.4 diff -C2 -d -r1.3 -r1.4 *** RML.htm 30 Sep 2001 13:44:51 -0000 1.3 --- RML.htm 13 Apr 2002 16:06:35 -0000 1.4 *************** *** 1,426 **** ! <!DOCTYPE html PUBLIC "-//w3c//dtd html 4.0 transitional//en"> <html> <head> ! ! <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> ! <meta name="GENERATOR" content="Mozilla/4.72 [en] (X11; U; Linux 2.2.14-5.0smp i686) [Netscape]"> ! <title>Reporting Markup Language Specification</title> ! <!-- saved from url=(0040)http://idrs.sourceforge.net/docs/RML.htm --> </head> ! <body bgcolor="#ffffff"> ! ! <h1>Reporting Markup Language Specification</h1> ! The Reporting Markup Language (RML) has been designed for web developers ! who are not programmers. All tags go between <rml></rml>tags. ! The specification is broken up into <HEAD></HEAD>and <BODY></BODY>tags. ! The header information defines what data is to be retrieved; the body places ! the data in the appropriate places within the body of the HTML document. ! A completely processed RML template contains NO RML tags. As this markup ! is not currently TRUE XML, it does not use an XML parser. Certain tags need ! to be on the same line, and some need to be on separate lines. All attribute ! vaules are cases-sensitive, but rml tags are not. All atribute values ! need to have quotes: attribute_name = "value" ! <h2 style="margin-left: 0.5in; text-indent: -0.25in; ">RML Tags</h2> ! ! <h2> RML (Between <rml></rml>and ! preceding <head>)</h2> ! ! <blockquote> ! <ul> ! ! <li><isHTML>{true | false}</isHTML></li> ! ! </ul> ! ! <blockquote>This tag tells the IDRS wether or not the <head>and <body>tags ! should be printed. while this tag is optional it is recomended/<br> ! </blockquote> ! ! <ul> ! ! <li><scriptClass>{name of class to ve used for embedded scripts}</scriptClass></li> ! ! </ul> ! ! <blockquote>This tag tells the IDRS what scripting class to use for the ! embedded scripts in a particuler page. <br> ! </blockquote> ! </blockquote> ! ! <blockquote></blockquote> ! ! <blockquote> ! <h2 style="margin-left: 0.5in; text-indent: -0.25in; ">Header (Between ! <HEAD></HEAD>Tags)</h2> ! </blockquote> ! ! <ul> ! ! <ul> ! ! <li><Object ID = "{Refrence to object within template}"></li> ! ! <li></Object></li> ! <br> ! The <object>tag allows for an IDRS report to access external java objects. ! <li><class>{Full classname of class to be used}</class></li> ! <br> ! Used between <object>tags, tells the IDRS what class to use load this ! object. The clasname should be the full classname including all package ! names. I.e., to load the object as part of the string class, one would ! put "java.lang.String", without the quotes. ! <li><constructor></li> ! ! <li></constructor></li> ! <br> ! Used between <object>tags, tells the IDRS what variables are ! needed for the constructor of this object. If no variables are needed ! for the constructor, then there still must be <constructor>tags present ! on seperate lines. Contained bettween constructor tags are <varType>tags ! that work identicly to <varType>tags used between <SQL>tags ! and <StoredProc>tags. ! <li><method></li> ! ! <ul> ! ! <li><name></name></li> ! <br> ! Used to tell the IDRS the name of the method being used. ! <li><varType></varType></li> ! <br> ! Identicle to <varType>tags for <constructor>, <sql>, and ! <storedproc>tags, with these added options: ! <ul> ! ! <li>Connection : Used when passing a database connection ! (Class : java.sql.Connection) to a method.</li> ! ! <li>DataSet : Used when passing a the results of a <db>tag ! (Class : IdrsDb) to a method.</li> ! ! </ul> ! ! </ul> ! ! <li></method></li> ! <br> ! Contained between <object>tags, used to describe a method to be used ! from withtin the IDRS report. ! <li><DB ID = "{Reference to data set within template}"></li> ! ! <li></DB></li> ! <br> ! These tags mark the beginning and end of a particular dataset. The ID attribute ! is used to identify the dataset by the parser. Tags must be on separate ! lines. ! <li><useDB>{name already defined DB}</useDB></li> ! <br> ! Used when using two or more connections to the same database. Used ! instead of <UserName>, <Password>, ! <DBDriver>and <DBName>tags. ! </ul> ! ! <ul> ! Example : <br> ! <DB ID = "main"><br> ! <DBDriver>db.Driver</DBName><br> ! <UserName>asd</UserName><br> ! <Password>fdsa</Password><br> ! <DBName>jdbc:db:someDB</DBName><br> ! <SQL><br> ! <SRC><br> ! SELECT * FROM stuff wher somthing = ! ?; <br> ! </SRC><br> ! <varType>String</varType><br> ! </DB><br> ! <DB ID = "sec"><br> ! <b><useDB>main</useDB></b><br> ! <SQL>... <br> ! </DB><br> ! ! <li><direction>{INPUT | OUTPUT}</direction></li> ! ! </ul> ! ! </ul> ! ! <blockquote> ! <blockquote>This tells the IDRS wether or not the <db>will ! be used for input or output. If the tag is ommited then the IDRS will ! assume that the <db>will be used for output.<br> ! </blockquote> ! </blockquote> ! ! <ul> ! ! <ul> ! ! <li><PageSize>{# of records per page | <extenernal>}</PageSize></li> ! <br> ! Contained between <DB></DB>tags BEFORE the ! <DBDriver>, <DBName>or <UseDB>tags, this tag tells the ! IDRS that a dataset is going to be cached and the report is ginog to be ! broken up into pieces. If a number is given in the <PageSize>tag, ! then there will be that number of records per page. If <external>is ! given then it will take the number from the calling page. If <PageSize>is ! used the following criteria MUST be passed to the IDRS : ! <ol> ! ! <li>{DB ID}_PageSize : This tells the IDRS how many records ! will be placed on a report</li> ! ! <li>{DB ID}_FirstRecord : This tells the IDRS what the ! first record to display is. If you wish to begin at the first record, ! this should be 0.</li> ! ! <li>{DB ID}_Reset : This tells the IDRS wether or not ! to eliminate the cached data set. On the inital call this should be ! set to true</li> ! ! </ol> ! ! <li><DatabaseDriver>{JDBC Driver Class}</DatabaseDriver></li> ! <br> ! Contained between <DB></DB>tags, is used to ! identify the driver to be used when connecting to the database. For the ! IDRS this would be the JDBC driver class being ! used. ! <li><UserName>{User_Name}</UserName></li> ! <br> ! Defines the user name to be passed to the database upon ! connection ! <li><Password>{Password}</Password></li> ! <br> ! Defines the password to be passed during database connection ! <li><DatabaseName></DatabaseName></li> ! <br> ! Defines the name of the database to be connected to. ! For the IDRS this would be the JDBC connection string. NOTE: the username ! and password must be defined before the <DatabaseName></DatabaseName>tags ! <li><useMethod objID = "{ID of object being used}">{methodname}</methodName></li> ! <br> ! The <usemethod>tag is used to call an external object when retrieving ! a Resultset for use by the IDRS instead of calling a SQL statement or a Stored ! Procedure. No <varType>or <src>tags are used, as all of ! the information needed is suplied by the method declaration in the above ! object-method declaration. If the requested has a connection as one ! of the specified arguments to the method, then whatever connection is specified ! by the <DBName>tag is used. Any method used MUST return an object ! of java.sql.Resultset or an exception will be thrown. ! <li><SQL>----<StoredProc></li> ! <br> ! These tags define either an SQL statement or a stored ! procedure to be used for retrieving data. Must be on separate lines ! <li><SRC></li> ! <br> ! {SQL or Stored Procedure} <br> ! Either the SQL statement to be used or the name of the ! stored procedure to be used. For SQL statements parameters are indicated ! by using a "?". There are no literals included in the definition. ! <p>Example: SELECT * FROM tblNames WHERE Name = ?; Or searchByName(?); ! </p> ! ! <li></SRC></li> ! ! <li><varType>{Valid_Variable_Type}</varType></li> ! <br> ! These tags indicate the data type of parameters in numerical order. The ! first pair is for the first parameter, the second pair is for the second ! parameter... These are the data types currently supported by the IDRS: ! ! <ul> ! ! <li>String</li> ! ! <li>Int</li> ! ! <li>Float</li> ! ! <li>Date</li> ! ! <li>Time</li> ! ! <li>Boolean</li> ! ! <li>UserID*</li> ! ! <li>*The UserID identification is used for user centric ! documents(invoices, account statements...). The parsing application will ! know what the current UserID is. <varType></varType>tags should ! be on the same line. Separate tags must be on separate lines.</li> ! ! </ul> ! ! <li></SQL>---</StoredProc></li> ! ! <li><VarList ID = "{Refrence to varlist within template}"></li> ! <br> ! Used to suply a method with input from either IDRS datasets and/or from ! user input ! <ul> ! ! <li><varType></varType></li> ! <br> ! Used to tell the list what datatype to use. Identicle to <varType>tag ! of <sql>and <storedproc>tags. The features of the ! <method>tag are not useable though. ! <li><dbresult>{ID of desired <db>set}</dbreult></li> ! <br> ! Used to pass a method the results of a query preformed by the given data ! set. Passed to the method as a refrence to a IdrsDb class. ! </ul> ! ! <li></VarList></li> ! ! </ul> ! ! </ul> ! ! <h2><br> ! Body (Between <BODY></BODY>Tags)</h2> ! ! <ul> ! ! <li><ifresults db="{<DB> to be checked}"><br clear="All"> ! <yes><br clear="All"> ! {Any RML to be executed ! if there are results from the db}<br clear="All"> ! </yes><br clear="All"> ! <no><br clear="All"> ! {Any RML to be executed ! when there are no results from the db }<br clear="All"> ! </no><br clear="All"> ! </ifresults></li> ! </ul> ! <blockquote>This tag allow for diferent sets of RML to be used ! based on wether there are results returned from a <DB> tag. <br> ! </blockquote> ! <ul> ! <li><$ $></li> ! ! </ul> ! ! <blockquote>This tag encases an embeded script. This ! tag can only be used if a <scriptClass>tag is specified. <br> ! </blockquote> ! ! <ul> ! ! <li><$= $></li> ! ! </ul> ! ! <blockquote>This tag prints the contents of the results ! of the tag. NOTE: <$= "this is a test" $>and <$ out.println*"this ! is a test"); $>preform the exact same function.<br> ! </blockquote> ! ! <ul> ! ! <li><Field [Format = "{specified format}"]>{Database_ID}.{Field_Name}</Field></li> ! <br> ! <Field>tags may appear anywhere in the <BODY>of ! an RML document. The text between the <Field>tags should be the ID ! of a data set that was defined as a <DB>set in the header and the name ! of a field in that data set separated by a period. The Format must fallow ! the fallowing form: <br> ! [number|date|time],[format] <br> ! where format is different for eather number, date or time : ! <ul> ! ! <li>number : currency, percent, integer, custom</li> ! ! <li>date : short, medium, long, full, custom</li> ! ! <li>time : short, medium, long, full, custom</li> ! ! </ul> ! ! <li><useMethod varList = "{ID of varlist to be used ! when executing this method}" ObjID = "{ID of object this method is a part ! of}">{methodname}</usemethod></li> ! <br> ! This tag allows an external method to be called and it's returning java.lang.String ! to be included in the final output of the rml document. The varlists' ! <vartype>and <dbresult>tags mus line match the class types given ! in the method's declaration or an exception will be thrown. ! <li><Repeat ID = "{DB ID}" [color1 = "{color name ! or number}" color2 = "{color name or number}"]></li> ! ! <ul> ! ! <li>Color1 and Color2 may be used to have color alternation ! in tables to make tables easier to read. On the first line of a table, color1 ! is the foreground and color2 is the background, on the second line it reverses. ! This procees continue until the end of a result set.</li> ! ! <li>{Lines to be iterated through for a particular ! data set}</li> ! ! <li><IfChange field = "{DB.Field}"></li> ! ! <li>{lines to be pased if DB.Field has changed}</li> ! ! <li></IFChange></li> ! <br> ! This tag may be used when a block of lines are to be parsed only when a ! field in a DB changes ! <li>Special <field></field>values</li> ! <br> ! .The following tags may be placed between <field>tags within a <repeat>block ! to retrieve IDRS generated information ! <ul> ! ! <li><LineNum></li> ! <br> ! The <LineNum>tag is used to give the line number of the current position ! in a resultset from the IDRS. It used by placing it between <field>tags ! like so: <field><linenum></field>. ! <li><ForeColor></li> ! <br> ! When placed between <field>tags as the <linenum>tag, it returns ! the current foreground color for color alternation. This color will be one ! of the colors specified in the <Repeat>tag. ! <li><BackColor></li> ! <br> ! When placed between <field>tags as the <linenum>tag, it returns ! the current background color for color alternation. This color will be one ! the other color specified in the <Repeat>tag. ! </ul> ! ! </ul> ! ! <li></Repeat></li> ! <br> ! Repeats the lines between the tags for every record in the ! identified data set ! <li><inputresults>{name of <db>}</inputresults></li> ! ! </ul> ! ! <blockquote>Returns the number of rows effected when ! the <db>that is specified was executed. This tag only works ! if the <db>'s <direction>tag specifies input.<br> ! </blockquote> ! ! <ul> ! ! <li><NavPrev>{What ever you would like to use ! to display for a link}</NavPrev>or <NavNext>{What ever you would ! like to use to display for a link}</NavNext></li> ! ! </ul> ! ! <ul> ! These tags will create the nessasary links to walk thourgh the datasets ! that are paged. If the current page is on the first record, then <NavPrev>will ! not generate anything, if on the last record <NavNext>will do the ! same.<br> ! <br> ! <br> ! ! </ul> ! ! </body> ! </html> --- 1,499 ---- ! <!doctype html public "-//w3c//dtd html 4.0 transitional//en"> <html> <head> ! <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> ! <meta name="GENERATOR" content="Mozilla/4.77 [en] (X11; U; Linux 2.4.13 i686) [Netscape]"> ! <title>Reporting Markup Language Specification</title> ! <!-- saved from url=(0040)http://idrs.sourceforge.net/docs/RML.htm --> </head> ! <body bgcolor="#FFFFFF"> ! ! <h1> ! Reporting Markup Language Specification</h1> ! The Reporting Markup Language (RML) has been designed for web developers ! who are not programmers. All tags go between <rml></rml>tags. ! The specification is broken up into <HEAD></HEAD>and <BODY></BODY>tags. ! The header information defines what data is to be retrieved; the body places ! the data in the appropriate places within the body of the HTML document. ! A completely processed RML template contains NO RML tags. As this markup ! is not currently TRUE XML, it does not use an XML parser. Certain tags ! need to be on the same line, and some need to be on separate lines. All ! attribute vaules are cases-sensitive, but rml tags are not. All atribute ! values need to have quotes: attribute_name = "value" ! <h2 style="margin-left: 0.5in; text-indent: -0.25in; "> ! RML Tags</h2> ! ! <h2> ! RML (Between <rml></rml>and ! preceding <head>)</h2> ! ! <blockquote> ! <ul> ! <li> ! <isHTML>{true | false}</isHTML></li> ! </ul> ! ! <blockquote>This tag tells the IDRS wether or not the <head>and <body>tags ! should be printed. while this tag is optional it is recomended/</blockquote> ! ! <ul> ! <li> ! <scriptClass>{name of class to ve used for embedded scripts}</scriptClass></li> ! </ul> ! ! <blockquote>This tag tells the IDRS what scripting class to use for the ! embedded scripts in a particuler page.</blockquote> ! </blockquote> ! ! <blockquote> ! <h2 style="margin-left: 0.5in; text-indent: -0.25in; "> ! Header (Between <HEAD></HEAD>Tags)</h2> ! </blockquote> ! ! <ul> ! <ul> ! <li> ! <Object ID = "{Refrence to object within template}"></li> ! ! <li> ! </Object></li> ! ! <br>The <object>tag allows for an IDRS report to access external java ! objects. ! <li> ! <class>{Full classname of class to be used}</class></li> ! ! <br>Used between <object>tags, tells the IDRS what class to use load ! this object. The clasname should be the full classname including ! all package names. I.e., to load the object as part of the string ! class, one would put "java.lang.String", without the quotes. ! <li> ! <constructor></li> ! ! <li> ! </constructor></li> ! ! <br>Used between <object>tags, tells the IDRS what variables are ! needed for the constructor of this object. If no variables are needed ! for the constructor, then there still must be <constructor>tags present ! on seperate lines. Contained bettween constructor tags are <varType>tags ! that work identicly to <varType>tags used between <SQL>tags and <StoredProc>tags. ! <li> ! <setProps>{true|false}</setProps></li> ! ! <br>Tells the IDRS to set all properties of the current object directly ! from paramaters in the request. A Property is defined by a setXXX ! method with a single String argument. The parameter must be named ! in the form {objID-prop_XXX} where objID is the ID of the object the property ! is accociated with and XXX is the name of the property minus the "set". ! <li> ! <method></li> ! ! <ul> ! <li> ! <name></name></li> ! ! <br>Used to tell the IDRS the name of the method being used. ! <li> ! <varType></varType></li> ! ! <br>Identicle to <varType>tags for <constructor>, <sql>, and <storedproc>tags, ! with these added options: ! <ul> ! <li> ! Connection : Used when passing a database connection (Class : java.sql.Connection) ! to a method.</li> ! ! <li> ! DataSet : Used when passing a the results of a <db>tag (Class ! : IdrsDb) to a method.</li> ! </ul> ! </ul> ! ! <li> ! </method></li> ! ! <br>Contained between <object>tags, used to describe a method to be ! used from withtin the IDRS report. ! <li> ! <DB ID = "{Reference to data set within template}"></li> ! ! <li> ! </DB></li> ! ! <br>These tags mark the beginning and end of a particular dataset. The ! ID attribute is used to identify the dataset by the parser. Tags must be ! on separate lines. ! <li> ! <useDB>{name already defined DB}</useDB></li> ! ! <br>Used when using two or more connections to the same database. ! Used instead of <UserName>, <Password>, ! <DBDriver>and <DBName>tags.</ul> ! ! <ul>Example : ! <br><DB ID = "main"> ! <br> <DBDriver>db.Driver</DBName> ! <br> <UserName>asd</UserName> ! <br> <Password>fdsa</Password> ! <br> <DBName>jdbc:db:someDB</DBName> ! <br> <SQL> ! <br> <SRC> ! <br> SELECT * FROM stuff wher somthing ! = ?; ! <br> </SRC> ! <br> <varType>String</varType> ! <br> </DB> ! <br> <DB ID = "sec"> ! <br> <b><useDB>main</useDB></b> ! <br> <SQL>... ! <br> </DB> ! <br> ! <li> ! <direction>{INPUT | OUTPUT}</direction></li> ! </ul> ! </ul> ! ! <blockquote> ! <blockquote>This tells the IDRS wether or not the <db>will be used for ! input or output. If the tag is ommited then the IDRS will assume ! that the <db>will be used for output.</blockquote> ! </blockquote> ! ! <ul> ! <ul> ! <li> ! <PageSize>{# of records per page | <extenernal>}</PageSize></li> ! ! <br> Contained between <DB></DB>tags BEFORE the ! <DBDriver>, <DBName>or <UseDB>tags, this tag tells the IDRS that ! a dataset is going to be cached and the report is ginog to be broken up ! into pieces. If a number is given in the <PageSize>tag, then there ! will be that number of records per page. If <external>is given ! then it will take the number from the calling page. If <PageSize>is ! used the following criteria MUST be passed to the IDRS : ! <ol> ! <li> ! {DB ID}_PageSize : This tells the IDRS how many records will be placed ! on a report</li> ! ! <li> ! {DB ID}_FirstRecord : This tells the IDRS what the first record to display ! is. If you wish to begin at the first record, this should be 0.</li> ! ! <li> ! {DB ID}_Reset : This tells the IDRS wether or not to eliminate the cached ! data set. On the inital call this should be set to true</li> ! </ol> ! ! <li> ! <DatabaseDriver>{JDBC Driver Class}</DatabaseDriver></li> ! ! <br> Contained between <DB></DB>tags, is used to ! identify the driver to be used when connecting to the database. For the ! IDRS this would be the JDBC driver class ! being used. ! <li> ! <UserName>{User_Name}</UserName></li> ! ! <br> Defines the user name to be passed to the database ! upon connection ! <li> ! <Password>{Password}</Password></li> ! ! <br> Defines the password to be passed during database ! connection ! <li> ! <DatabaseName></DatabaseName></li> ! ! <br> Defines the name of the database to be connected ! to. For the IDRS this would be the JDBC connection string. NOTE: the username ! and password must be defined before the <DatabaseName></DatabaseName>tags ! <li> ! <useMethod objID = "{ID of object being used}">{methodname}</methodName></li> ! ! <br>The <usemethod>tag is used to call an external object when retrieving ! a Resultset for use by the IDRS instead of calling a SQL statement or a ! Stored Procedure. No <varType>or <src>tags are used, as all ! of the information needed is suplied by the method declaration in the above ! object-method declaration. If the requested has a connection as one ! of the specified arguments to the method, then whatever connection is specified ! by the <DBName>tag is used. Any method used MUST return an object ! of java.sql.Resultset or an exception will be thrown. ! <li> ! <SQL>----<StoredProc></li> ! ! <br> These tags define either an SQL statement or a stored ! procedure to be used for retrieving data. Must be on separate lines ! <li> ! <SRC></li> ! ! <br> {SQL or Stored Procedure} ! <br> Either the SQL statement to be used or the name ! of the stored procedure to be used. For SQL statements parameters are indicated ! by using a "?". There are no literals included in the definition. ! <p>Example: SELECT * FROM tblNames WHERE Name = ?; Or searchByName(?); ! <li> ! </SRC></li> ! ! <li> ! <varType>{Valid_Variable_Type}</varType></li> ! ! <br>These tags indicate the data type of parameters in numerical order. ! The first pair is for the first parameter, the second pair is for the second ! parameter... These are the data types currently supported by the ! IDRS: ! <ul> ! <li> ! String</li> ! ! <li> ! Int</li> ! ! <li> ! Float</li> ! ! <li> ! Date</li> ! ! <li> ! Time</li> ! ! <li> ! Boolean</li> ! ! <li> ! UserID*</li> ! ! <li> ! *The UserID identification is used for user centric documents(invoices, ! account statements...). The parsing application will know what the current ! UserID is. <varType></varType>tags should be on the same line. Separate ! tags must be on separate lines.</li> ! </ul> ! ! <li> ! </SQL>---</StoredProc></li> ! ! <li> ! <VarList ID = "{Refrence to varlist within template}"></li> ! ! <br>Used to suply a method with input from either IDRS datasets and/or ! from user input ! <ul> ! <li> ! <varType></varType></li> ! ! <br>Used to tell the list what datatype to use. Identicle to <varType>tag ! of <sql>and <storedproc>tags. The features of the <method>tag ! are not useable though. ! <li> ! <dbresult>{ID of desired <db>set}</dbreult></li> ! ! <br>Used to pass a method the results of a query preformed by the given ! data set. Passed to the method as a refrence to a IdrsDb class.</ul> ! ! <li> ! </VarList></li> ! </ul> ! </ul> ! ! <h2> ! <br> ! Body (Between <BODY></BODY>Tags)</h2> ! ! <ul> ! <li> ! <ifresults db="{<DB> to be checked}"></li> ! ! <br> <yes> ! <br> ! {Any RML to be executed if there are results from the db} ! <br> </yes> ! <br> <no> ! <br> ! {Any RML to be executed when there are no results from the db } ! <br> </no> ! <br></ifresults></ul> ! ! <blockquote>This tag allow for diferent sets of RML to be used based on ! wether there are results returned from a <DB> tag.</blockquote> ! ! <ul> ! <li> ! <$ $></li> ! </ul> ! ! <blockquote>This tag encases an embeded script. This tag can only ! be used if a <scriptClass>tag is specified.</blockquote> ! ! <ul> ! <li> ! <$= $></li> ! </ul> ! ! <blockquote>This tag prints the contents of the results of the tag. ! NOTE: <$= "this is a test" $>and <$ out.println*"this is a test"); ! $>preform the exact same function.</blockquote> ! ! <ul> ! <li> ! <Field [Format = "{specified format}"]>{Database_ID}.{Field_Name}</Field></li> ! ! <br> <Field>tags may appear anywhere in the <BODY>of ! an RML document. The text between the <Field>tags should be the ID of ! a data set that was defined as a <DB>set in the header and the name ! of a field in that data set separated by a period. The Format must fallow ! the fallowing form: ! <br>[number|date|time],[format] ! <br>where format is different for eather number, date or time : ! <ul> ! <li> ! number : currency, percent, integer, custom</li> ! ! <li> ! date : short, medium, long, full, custom</li> ! ! <li> ! time : short, medium, long, full, custom</li> ! </ul> ! ! <li> ! <useMethod varList = "{ID of varlist to be used when executing this ! method}" ObjID = "{ID of object this method is a part of}">{methodname}</usemethod></li> ! ! <br>This tag allows an external method to be called and it's returning ! java.lang.String to be included in the final output of the rml document. ! The varlists' <vartype>and <dbresult>tags mus line match the class ! types given in the method's declaration or an exception will be thrown. ! <li> ! <Repeat ID = "{DB ID}" [color1 = "{color name or number}" color2 = "{color ! name or number}"]></li> ! ! <ul> ! <li> ! Color1 and Color2 may be used to have color alternation in tables to make ! tables easier to read. On the first line of a table, color1 is the foreground ! and color2 is the background, on the second line it reverses. This procees ! continue until the end of a result set.</li> ! ! <li> ! {Lines to be iterated through for a particular data set}</li> ! ! <li> ! <IfChange field = "{DB.Field}"></li> ! ! <li> ! {lines to be pased if DB.Field has changed}</li> ! ! <li> ! </IFChange></li> ! ! <br>This tag may be used when a block of lines are to be parsed only when ! a field in a DB changes ! <li> ! Special <field></field>values</li> ! ! <br>.The following tags may be placed between <field>tags within a <repeat>block ! to retrieve IDRS generated information ! <ul> ! <li> ! <LineNum></li> ! ! <br>The <LineNum>tag is used to give the line number of the current ! position in a resultset from the IDRS. It used by placing it between <field>tags ! like so: <field><linenum></field>. ! <li> ! <ForeColor></li> ! ! <br>When placed between <field>tags as the <linenum>tag, it returns ! the current foreground color for color alternation. This color will be ! one of the colors specified in the <Repeat>tag. ! <li> ! <BackColor></li> ! ! <br>When placed between <field>tags as the <linenum>tag, it returns ! the current background color for color alternation. This color will be ! one the other color specified in the <Repeat>tag.</ul> ! </ul> ! ! <li> ! </Repeat></li> ! ! <br> Repeats the lines between the tags for every record in ! the identified data set ! <li> ! <inputresults>{name of <db>}</inputresults></li> ! </ul> ! ! <blockquote>Returns the number of rows effected when the <db>that is ! specified was executed. This tag only works if the <db>'s <direction>tag ! specifies input.</blockquote> ! ! <ul> ! <li> ! <NavPrev>{What ever you would like to use to display for a link}</NavPrev>or ! <NavNext>{What ever you would like to use to display for a link}</NavNext></li> ! </ul> ! ! <ul>These tags will create the nessasary links to walk thourgh the datasets ! that are paged. If the current page is on the first record, then ! <NavPrev>will not generate anything, if on the last record <NavNext>will ! do the same. ! <li> ! <YesNo name="{name of resulting set of <input> tags | = script ! to determine name}" [single="{Yes|No}"] srcType="{param | prop ! | db}" [atts="{any input attributes}"] [paranFirst="true | false">{srcName}</YesNo></li> ! ! <br>This tag will generate a set of HTML <input> tags to represent a ! yes/no input with the current value comming from either a parameter, a ! property or a db value. The name attribute may contain either a hard-coded ! name, or if the first character of the name is '=' then the attribute is ! executed as a script of the predefined <scriptclass> tag. All ! quotes (") must be escaped by a backslash (\) inside of the script. ! The optional single attribute allows for only a single <input> tag to ! be generated, wether it be the yes or the no. The srcType attribute ! defines where the current value is coming from. If the value is param ! then the value of the tag must be a request parameter with a value of "true" ! or "false".. If this is a db the value of the tag must be {db.field} ! and must contain either the value "true"or "false". Finally, if the ! srcType is prop, then the value of the tag must be {objID.XXX} where XXX ! is the name of a boolean getXXX property minus the "get". The optional ! atts attribute allows for extra <input> tag attributes to be specified, ! all quotes must be escaped by a backslash. The optional paramFirst ! attribute allows for a request parameter to over ride either a value from ! a db or a property. ! <br> ! <li> ! <formInput name="{name of resulting set of <input> tags | = ! script to determine name}" type="[any valid <input> type | textarea}" ! srcType="{param | prop | db}" [atts="{any input attributes}"] [paranFirst="true ! | false"] [value="{value of tag}"] >{srcName}</formInput></li> ! ! <br>This tag will generate an HTML <input> tags the current value ! comming from either a parameter, a property or a db value. The name ! attribute may contain either a hard-coded name, or if the first character ! of the name is '=' then the attribute is executed as a script of the predefined ! <scriptclass> tag. All quotes (") must be escaped by a backslash ! (\) inside of the script. The type attribute is used to determine ! the type of the final <input> tag. The srcType attribute defines ! where the current value is coming from. If the value is param then ! the value of the tag must be a request parameter with a value of "true" ! or "false".. If this is a db the value of the tag must be {db.field} ! and must contain either the value "true"or "false". Finally, if the ! srcType is prop, then the value of the tag must be {objID.XXX} where XXX ! is the name of a boolean getXXX property minus the "get". The optional ! atts attribute allows for extra <input> tag attributes to be specified, ! all quotes must be escaped by a backslash. The optional paramFirst ! attribute allows for a request parameter to over ride either a value from ! a db or a property. The optional value attribute defines what the ! value of the <input> tag is. This needs to be used when working ! with checkboxes and radio buttons to determine which onces should be checked. ! This is ignored for textboxes. ! <br> ! <br> ! <br> ! <br> </ul> ! ! </body> ! </html> |
