Function Reference Format

From Bluefish Wiki
Jump to navigation Jump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

<verbatim> <ref name\"My S QL Functions\" description\"My S QL functions for PHP \" case=\"1\">

<function name=\"mysqldbquery\">

  <description>
    Function description
  </description>
  <tip>Text shown in a tooltip or hints</tip>
  <param name\"database\" title\"Database name\" required\"1\" vallist\"0\" default\"\" type\"string\" >
    <vallist>Values if vallist1</vallist>
    Parameter description
  </param>
  <return type=\"resource\">
    Return value description
  </return>
  <dialog title=\"Dialog title\">
     Text inserted after executing dialog, use params as %0,%1,%2 etc.
     %_ means \"insert only these attributes which are not empty and not
               default values\"
  </dialog>
  <insert>
     Text inserted after activating this action
  </insert>
  <info title=\"Title of the info window\">
    Text shown in the info
  </info>
</function>
<tag name=\"Table Element\">
  <description>
      The TABLE element contains all other elements that specify caption, rows, content, and formatting.
  </description>
  <tip>Tag tooltip</tip>
  <attribute name\"Border\" title\"Table border\" required\"0\" vallist\"0\" default=\"0\">
     <vallist></vallist>
         This attribute specifies the width (in pixels only) of the frame around a table (see the Note below for more information about this attribute).
  </attribute>
  <dialog title=\"Dialog title\">
     Text inserted after executing dialog, use params as %0,%1,%2 etc.
  </dialog>
  <insert>
     Text inserted after activating this action
  </insert>
  <info title=\"Title of the info window\">
    Text shown in the info
  </info>
</tag>


</ref> </verbatim>