Module CGI::HtmlExtension
In: lib/cgi.rb

Mixin module providing HTML generation methods.

For example,

  cgi.a("http://www.example.com") { "Example" }
    # => "<A HREF=\"http://www.example.com\">Example</A>"

Modules Http3, Http4, etc., contain more basic HTML-generation methods (:title, :center, etc.).

See class CGI for a detailed example.

Methods

Public Instance methods

Generate an Anchor element as a string.

href can either be a string, giving the URL for the HREF attribute, or it can be a hash of the element’s attributes.

The body of the element is the string returned by the no-argument block passed in.

  a("http://www.example.com") { "Example" }
    # => "<A HREF=\"http://www.example.com\">Example</A>"

  a("HREF" => "http://www.example.com", "TARGET" => "_top") { "Example" }
    # => "<A HREF=\"http://www.example.com\" TARGET=\"_top\">Example</A>"

[Source]

      # File lib/cgi.rb, line 1312
1312:     def a(href = "") # :yield:
1313:       attributes = if href.kind_of?(String)
1314:                      { "HREF" => href }
1315:                    else
1316:                      href
1317:                    end
1318:       if block_given?
1319:         super(attributes){ yield }
1320:       else
1321:         super(attributes)
1322:       end
1323:     end

Generate a Document Base URI element as a String.

href can either by a string, giving the base URL for the HREF attribute, or it can be a has of the element’s attributes.

The passed-in no-argument block is ignored.

  base("http://www.example.com/cgi")
    # => "<BASE HREF=\"http://www.example.com/cgi\">"

[Source]

      # File lib/cgi.rb, line 1334
1334:     def base(href = "") # :yield:
1335:       attributes = if href.kind_of?(String)
1336:                      { "HREF" => href }
1337:                    else
1338:                      href
1339:                    end
1340:       if block_given?
1341:         super(attributes){ yield }
1342:       else
1343:         super(attributes)
1344:       end
1345:     end

Generate a BlockQuote element as a string.

cite can either be a string, give the URI for the source of the quoted text, or a hash, giving all attributes of the element, or it can be omitted, in which case the element has no attributes.

The body is provided by the passed-in no-argument block

  blockquote("http://www.example.com/quotes/foo.html") { "Foo!" }
    #=> "<BLOCKQUOTE CITE=\"http://www.example.com/quotes/foo.html\">Foo!</BLOCKQUOTE>

[Source]

      # File lib/cgi.rb, line 1357
1357:     def blockquote(cite = nil)  # :yield:
1358:       attributes = if cite.kind_of?(String)
1359:                      { "CITE" => cite }
1360:                    else
1361:                      cite or ""
1362:                    end
1363:       if block_given?
1364:         super(attributes){ yield }
1365:       else
1366:         super(attributes)
1367:       end
1368:     end

Generate a Table Caption element as a string.

align can be a string, giving the alignment of the caption (one of top, bottom, left, or right). It can be a hash of all the attributes of the element. Or it can be omitted.

The body of the element is provided by the passed-in no-argument block.

  caption("left") { "Capital Cities" }
    # => <CAPTION ALIGN=\"left\">Capital Cities</CAPTION>

[Source]

      # File lib/cgi.rb, line 1381
1381:     def caption(align = nil) # :yield:
1382:       attributes = if align.kind_of?(String)
1383:                      { "ALIGN" => align }
1384:                    else
1385:                      align or ""
1386:                    end
1387:       if block_given?
1388:         super(attributes){ yield }
1389:       else
1390:         super(attributes)
1391:       end
1392:     end

Generate a Checkbox Input element as a string.

The attributes of the element can be specified as three arguments, name, value, and checked. checked is a boolean value; if true, the CHECKED attribute will be included in the element.

Alternatively, the attributes can be specified as a hash.

  checkbox("name")
    # = checkbox("NAME" => "name")

  checkbox("name", "value")
    # = checkbox("NAME" => "name", "VALUE" => "value")

  checkbox("name", "value", true)
    # = checkbox("NAME" => "name", "VALUE" => "value", "CHECKED" => true)

[Source]

      # File lib/cgi.rb, line 1411
1411:     def checkbox(name = "", value = nil, checked = nil)
1412:       attributes = if name.kind_of?(String)
1413:                      { "TYPE" => "checkbox", "NAME" => name,
1414:                        "VALUE" => value, "CHECKED" => checked }
1415:                    else
1416:                      name["TYPE"] = "checkbox"
1417:                      name
1418:                    end
1419:       input(attributes)
1420:     end

Generate a sequence of checkbox elements, as a String.

The checkboxes will all have the same name attribute. Each checkbox is followed by a label. There will be one checkbox for each value. Each value can be specified as a String, which will be used both as the value of the VALUE attribute and as the label for that checkbox. A single-element array has the same effect.

Each value can also be specified as a three-element array. The first element is the VALUE attribute; the second is the label; and the third is a boolean specifying whether this checkbox is CHECKED.

Each value can also be specified as a two-element array, by omitting either the value element (defaults to the same as the label), or the boolean checked element (defaults to false).

  checkbox_group("name", "foo", "bar", "baz")
    # <INPUT TYPE="checkbox" NAME="name" VALUE="foo">foo
    # <INPUT TYPE="checkbox" NAME="name" VALUE="bar">bar
    # <INPUT TYPE="checkbox" NAME="name" VALUE="baz">baz

  checkbox_group("name", ["foo"], ["bar", true], "baz")
    # <INPUT TYPE="checkbox" NAME="name" VALUE="foo">foo
    # <INPUT TYPE="checkbox" CHECKED NAME="name" VALUE="bar">bar
    # <INPUT TYPE="checkbox" NAME="name" VALUE="baz">baz

  checkbox_group("name", ["1", "Foo"], ["2", "Bar", true], "Baz")
    # <INPUT TYPE="checkbox" NAME="name" VALUE="1">Foo
    # <INPUT TYPE="checkbox" CHECKED NAME="name" VALUE="2">Bar
    # <INPUT TYPE="checkbox" NAME="name" VALUE="Baz">Baz

  checkbox_group("NAME" => "name",
                   "VALUES" => ["foo", "bar", "baz"])

  checkbox_group("NAME" => "name",
                   "VALUES" => [["foo"], ["bar", true], "baz"])

  checkbox_group("NAME" => "name",
                   "VALUES" => [["1", "Foo"], ["2", "Bar", true], "Baz"])

[Source]

      # File lib/cgi.rb, line 1465
1465:     def checkbox_group(name = "", *values)
1466:       if name.kind_of?(Hash)
1467:         values = name["VALUES"]
1468:         name = name["NAME"]
1469:       end
1470:       values.collect{|value|
1471:         if value.kind_of?(String)
1472:           checkbox(name, value) + value
1473:         else
1474:           if value[value.size - 1] == true
1475:             checkbox(name, value[0], true) +
1476:             value[value.size - 2]
1477:           else
1478:             checkbox(name, value[0]) +
1479:             value[value.size - 1]
1480:           end
1481:         end
1482:       }.to_s
1483:     end

Generate an File Upload Input element as a string.

The attributes of the element can be specified as three arguments, name, size, and maxlength. maxlength is the maximum length of the file’s name, not of the file’s contents.

Alternatively, the attributes can be specified as a hash.

See multipart_form() for forms that include file uploads.

  file_field("name")
    # <INPUT TYPE="file" NAME="name" SIZE="20">

  file_field("name", 40)
    # <INPUT TYPE="file" NAME="name" SIZE="40">

  file_field("name", 40, 100)
    # <INPUT TYPE="file" NAME="name" SIZE="40" MAXLENGTH="100">

  file_field("NAME" => "name", "SIZE" => 40)
    # <INPUT TYPE="file" NAME="name" SIZE="40">

[Source]

      # File lib/cgi.rb, line 1507
1507:     def file_field(name = "", size = 20, maxlength = nil)
1508:       attributes = if name.kind_of?(String)
1509:                      { "TYPE" => "file", "NAME" => name,
1510:                        "SIZE" => size.to_s }
1511:                    else
1512:                      name["TYPE"] = "file"
1513:                      name
1514:                    end
1515:       attributes["MAXLENGTH"] = maxlength.to_s if maxlength
1516:       input(attributes)
1517:     end

Generate a Form element as a string.

method should be either "get" or "post", and defaults to the latter. action defaults to the current CGI script name. enctype defaults to "application/x-www-form-urlencoded".

Alternatively, the attributes can be specified as a hash.

See also multipart_form() for forms that include file uploads.

  form{ "string" }
    # <FORM METHOD="post" ENCTYPE="application/x-www-form-urlencoded">string</FORM>

  form("get") { "string" }
    # <FORM METHOD="get" ENCTYPE="application/x-www-form-urlencoded">string</FORM>

  form("get", "url") { "string" }
    # <FORM METHOD="get" ACTION="url" ENCTYPE="application/x-www-form-urlencoded">string</FORM>

  form("METHOD" => "post", "ENCTYPE" => "enctype") { "string" }
    # <FORM METHOD="post" ENCTYPE="enctype">string</FORM>

[Source]

      # File lib/cgi.rb, line 1541
1541:     def form(method = "post", action = script_name, enctype = "application/x-www-form-urlencoded")
1542:       attributes = if method.kind_of?(String)
1543:                      { "METHOD" => method, "ACTION" => action,
1544:                        "ENCTYPE" => enctype } 
1545:                    else
1546:                      unless method.has_key?("METHOD")
1547:                        method["METHOD"] = "post"
1548:                      end
1549:                      unless method.has_key?("ENCTYPE")
1550:                        method["ENCTYPE"] = enctype
1551:                      end
1552:                      method
1553:                    end
1554:       if block_given?
1555:         body = yield
1556:       else
1557:         body = ""
1558:       end
1559:       if @output_hidden
1560:         body += @output_hidden.collect{|k,v|
1561:           "<INPUT TYPE=\"HIDDEN\" NAME=\"#{k}\" VALUE=\"#{v}\">"
1562:         }.to_s
1563:       end
1564:       super(attributes){body}
1565:     end

Generate a Hidden Input element as a string.

The attributes of the element can be specified as two arguments, name and value.

Alternatively, the attributes can be specified as a hash.

  hidden("name")
    # <INPUT TYPE="hidden" NAME="name">

  hidden("name", "value")
    # <INPUT TYPE="hidden" NAME="name" VALUE="value">

  hidden("NAME" => "name", "VALUE" => "reset", "ID" => "foo")
    # <INPUT TYPE="hidden" NAME="name" VALUE="value" ID="foo">

[Source]

      # File lib/cgi.rb, line 1582
1582:     def hidden(name = "", value = nil)
1583:       attributes = if name.kind_of?(String)
1584:                      { "TYPE" => "hidden", "NAME" => name, "VALUE" => value }
1585:                    else
1586:                      name["TYPE"] = "hidden"
1587:                      name
1588:                    end
1589:       input(attributes)
1590:     end

Generate a top-level HTML element as a string.

The attributes of the element are specified as a hash. The pseudo-attribute "PRETTY" can be used to specify that the generated HTML string should be indented. "PRETTY" can also be specified as a string as the sole argument to this method. The pseudo-attribute "DOCTYPE", if given, is used as the leading DOCTYPE SGML tag; it should include the entire text of this tag, including angle brackets.

The body of the html element is supplied as a block.

  html{ "string" }
    # <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"><HTML>string</HTML>

  html("LANG" => "ja") { "string" }
    # <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"><HTML LANG="ja">string</HTML>

  html("DOCTYPE" => false) { "string" }
    # <HTML>string</HTML>

  html("DOCTYPE" => '<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">') { "string" }
    # <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN"><HTML>string</HTML>

  html("PRETTY" => "  ") { "<BODY></BODY>" }
    # <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
    # <HTML>
    #   <BODY>
    #   </BODY>
    # </HTML>

  html("PRETTY" => "\t") { "<BODY></BODY>" }
    # <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
    # <HTML>
    #         <BODY>
    #         </BODY>
    # </HTML>

  html("PRETTY") { "<BODY></BODY>" }
    # = html("PRETTY" => "  ") { "<BODY></BODY>" }

  html(if $VERBOSE then "PRETTY" end) { "HTML string" }

[Source]

      # File lib/cgi.rb, line 1634
1634:     def html(attributes = {}) # :yield:
1635:       if nil == attributes
1636:         attributes = {}
1637:       elsif "PRETTY" == attributes
1638:         attributes = { "PRETTY" => true }
1639:       end
1640:       pretty = attributes.delete("PRETTY")
1641:       pretty = "  " if true == pretty
1642:       buf = ""
1643: 
1644:       if attributes.has_key?("DOCTYPE")
1645:         if attributes["DOCTYPE"]
1646:           buf += attributes.delete("DOCTYPE")
1647:         else
1648:           attributes.delete("DOCTYPE")
1649:         end
1650:       else
1651:         buf += doctype
1652:       end
1653: 
1654:       if block_given?
1655:         buf += super(attributes){ yield }
1656:       else
1657:         buf += super(attributes)
1658:       end
1659: 
1660:       if pretty
1661:         CGI::pretty(buf, pretty)
1662:       else
1663:         buf
1664:       end
1665: 
1666:     end

Generate an Image Button Input element as a string.

src is the URL of the image to use for the button. name is the input name. alt is the alternative text for the image.

Alternatively, the attributes can be specified as a hash.

  image_button("url")
    # <INPUT TYPE="image" SRC="url">

  image_button("url", "name", "string")
    # <INPUT TYPE="image" SRC="url" NAME="name" ALT="string">

  image_button("SRC" => "url", "ATL" => "strng")
    # <INPUT TYPE="image" SRC="url" ALT="string">

[Source]

      # File lib/cgi.rb, line 1683
1683:     def image_button(src = "", name = nil, alt = nil)
1684:       attributes = if src.kind_of?(String)
1685:                      { "TYPE" => "image", "SRC" => src, "NAME" => name,
1686:                        "ALT" => alt }
1687:                    else
1688:                      src["TYPE"] = "image"
1689:                      src["SRC"] ||= ""
1690:                      src
1691:                    end
1692:       input(attributes)
1693:     end

Generate an Image element as a string.

src is the URL of the image. alt is the alternative text for the image. width is the width of the image, and height is its height.

Alternatively, the attributes can be specified as a hash.

  img("src", "alt", 100, 50)
    # <IMG SRC="src" ALT="alt" WIDTH="100" HEIGHT="50">

  img("SRC" => "src", "ALT" => "alt", "WIDTH" => 100, "HEIGHT" => 50)
    # <IMG SRC="src" ALT="alt" WIDTH="100" HEIGHT="50">

[Source]

      # File lib/cgi.rb, line 1709
1709:     def img(src = "", alt = "", width = nil, height = nil)
1710:       attributes = if src.kind_of?(String)
1711:                      { "SRC" => src, "ALT" => alt }
1712:                    else
1713:                      src
1714:                    end
1715:       attributes["WIDTH"] = width.to_s if width
1716:       attributes["HEIGHT"] = height.to_s if height
1717:       super(attributes)
1718:     end

Generate a Form element with multipart encoding as a String.

Multipart encoding is used for forms that include file uploads.

action is the action to perform. enctype is the encoding type, which defaults to "multipart/form-data".

Alternatively, the attributes can be specified as a hash.

  multipart_form{ "string" }
    # <FORM METHOD="post" ENCTYPE="multipart/form-data">string</FORM>

  multipart_form("url") { "string" }
    # <FORM METHOD="post" ACTION="url" ENCTYPE="multipart/form-data">string</FORM>

[Source]

      # File lib/cgi.rb, line 1735
1735:     def multipart_form(action = nil, enctype = "multipart/form-data")
1736:       attributes = if action == nil
1737:                      { "METHOD" => "post", "ENCTYPE" => enctype } 
1738:                    elsif action.kind_of?(String)
1739:                      { "METHOD" => "post", "ACTION" => action,
1740:                        "ENCTYPE" => enctype } 
1741:                    else
1742:                      unless action.has_key?("METHOD")
1743:                        action["METHOD"] = "post"
1744:                      end
1745:                      unless action.has_key?("ENCTYPE")
1746:                        action["ENCTYPE"] = enctype
1747:                      end
1748:                      action
1749:                    end
1750:       if block_given?
1751:         form(attributes){ yield }
1752:       else
1753:         form(attributes)
1754:       end
1755:     end

Generate a Password Input element as a string.

name is the name of the input field. value is its default value. size is the size of the input field display. maxlength is the maximum length of the inputted password.

Alternatively, attributes can be specified as a hash.

  password_field("name")
    # <INPUT TYPE="password" NAME="name" SIZE="40">

  password_field("name", "value")
    # <INPUT TYPE="password" NAME="name" VALUE="value" SIZE="40">

  password_field("password", "value", 80, 200)
    # <INPUT TYPE="password" NAME="name" VALUE="value" SIZE="80" MAXLENGTH="200">

  password_field("NAME" => "name", "VALUE" => "value")
    # <INPUT TYPE="password" NAME="name" VALUE="value">

[Source]

      # File lib/cgi.rb, line 1777
1777:     def password_field(name = "", value = nil, size = 40, maxlength = nil)
1778:       attributes = if name.kind_of?(String)
1779:                      { "TYPE" => "password", "NAME" => name,
1780:                        "VALUE" => value, "SIZE" => size.to_s }
1781:                    else
1782:                      name["TYPE"] = "password"
1783:                      name
1784:                    end
1785:       attributes["MAXLENGTH"] = maxlength.to_s if maxlength
1786:       input(attributes)
1787:     end

Generate a Select element as a string.

name is the name of the element. The values are the options that can be selected from the Select menu. Each value can be a String or a one, two, or three-element Array. If a String or a one-element Array, this is both the value of that option and the text displayed for it. If a three-element Array, the elements are the option value, displayed text, and a boolean value specifying whether this option starts as selected. The two-element version omits either the option value (defaults to the same as the display text) or the boolean selected specifier (defaults to false).

The attributes and options can also be specified as a hash. In this case, options are specified as an array of values as described above, with the hash key of "VALUES".

  popup_menu("name", "foo", "bar", "baz")
    # <SELECT NAME="name">
    #   <OPTION VALUE="foo">foo</OPTION>
    #   <OPTION VALUE="bar">bar</OPTION>
    #   <OPTION VALUE="baz">baz</OPTION>
    # </SELECT>

  popup_menu("name", ["foo"], ["bar", true], "baz")
    # <SELECT NAME="name">
    #   <OPTION VALUE="foo">foo</OPTION>
    #   <OPTION VALUE="bar" SELECTED>bar</OPTION>
    #   <OPTION VALUE="baz">baz</OPTION>
    # </SELECT>

  popup_menu("name", ["1", "Foo"], ["2", "Bar", true], "Baz")
    # <SELECT NAME="name">
    #   <OPTION VALUE="1">Foo</OPTION>
    #   <OPTION SELECTED VALUE="2">Bar</OPTION>
    #   <OPTION VALUE="Baz">Baz</OPTION>
    # </SELECT>

  popup_menu("NAME" => "name", "SIZE" => 2, "MULTIPLE" => true,
              "VALUES" => [["1", "Foo"], ["2", "Bar", true], "Baz"])
    # <SELECT NAME="name" MULTIPLE SIZE="2">
    #   <OPTION VALUE="1">Foo</OPTION>
    #   <OPTION SELECTED VALUE="2">Bar</OPTION>
    #   <OPTION VALUE="Baz">Baz</OPTION>
    # </SELECT>

[Source]

      # File lib/cgi.rb, line 1832
1832:     def popup_menu(name = "", *values)
1833: 
1834:       if name.kind_of?(Hash)
1835:         values   = name["VALUES"]
1836:         size     = name["SIZE"].to_s if name["SIZE"]
1837:         multiple = name["MULTIPLE"]
1838:         name     = name["NAME"]
1839:       else
1840:         size = nil
1841:         multiple = nil
1842:       end
1843: 
1844:       select({ "NAME" => name, "SIZE" => size,
1845:                "MULTIPLE" => multiple }){
1846:         values.collect{|value|
1847:           if value.kind_of?(String)
1848:             option({ "VALUE" => value }){ value }
1849:           else
1850:             if value[value.size - 1] == true
1851:               option({ "VALUE" => value[0], "SELECTED" => true }){
1852:                 value[value.size - 2]
1853:               }
1854:             else
1855:               option({ "VALUE" => value[0] }){
1856:                 value[value.size - 1]
1857:               }
1858:             end
1859:           end
1860:         }.to_s
1861:       }
1862: 
1863:     end

Generates a radio-button Input element.

name is the name of the input field. value is the value of the field if checked. checked specifies whether the field starts off checked.

Alternatively, the attributes can be specified as a hash.

  radio_button("name", "value")
    # <INPUT TYPE="radio" NAME="name" VALUE="value">

  radio_button("name", "value", true)
    # <INPUT TYPE="radio" NAME="name" VALUE="value" CHECKED>

  radio_button("NAME" => "name", "VALUE" => "value", "ID" => "foo")
    # <INPUT TYPE="radio" NAME="name" VALUE="value" ID="foo">

[Source]

      # File lib/cgi.rb, line 1881
1881:     def radio_button(name = "", value = nil, checked = nil)
1882:       attributes = if name.kind_of?(String)
1883:                      { "TYPE" => "radio", "NAME" => name,
1884:                        "VALUE" => value, "CHECKED" => checked }
1885:                    else
1886:                      name["TYPE"] = "radio"
1887:                      name
1888:                    end
1889:       input(attributes)
1890:     end

Generate a sequence of radio button Input elements, as a String.

This works the same as checkbox_group(). However, it is not valid to have more than one radiobutton in a group checked.

  radio_group("name", "foo", "bar", "baz")
    # <INPUT TYPE="radio" NAME="name" VALUE="foo">foo
    # <INPUT TYPE="radio" NAME="name" VALUE="bar">bar
    # <INPUT TYPE="radio" NAME="name" VALUE="baz">baz

  radio_group("name", ["foo"], ["bar", true], "baz")
    # <INPUT TYPE="radio" NAME="name" VALUE="foo">foo
    # <INPUT TYPE="radio" CHECKED NAME="name" VALUE="bar">bar
    # <INPUT TYPE="radio" NAME="name" VALUE="baz">baz

  radio_group("name", ["1", "Foo"], ["2", "Bar", true], "Baz")
    # <INPUT TYPE="radio" NAME="name" VALUE="1">Foo
    # <INPUT TYPE="radio" CHECKED NAME="name" VALUE="2">Bar
    # <INPUT TYPE="radio" NAME="name" VALUE="Baz">Baz

  radio_group("NAME" => "name",
                "VALUES" => ["foo", "bar", "baz"])

  radio_group("NAME" => "name",
                "VALUES" => [["foo"], ["bar", true], "baz"])

  radio_group("NAME" => "name",
                "VALUES" => [["1", "Foo"], ["2", "Bar", true], "Baz"])

[Source]

      # File lib/cgi.rb, line 1920
1920:     def radio_group(name = "", *values)
1921:       if name.kind_of?(Hash)
1922:         values = name["VALUES"]
1923:         name = name["NAME"]
1924:       end
1925:       values.collect{|value|
1926:         if value.kind_of?(String)
1927:           radio_button(name, value) + value
1928:         else
1929:           if value[value.size - 1] == true
1930:             radio_button(name, value[0], true) +
1931:             value[value.size - 2]
1932:           else
1933:             radio_button(name, value[0]) +
1934:             value[value.size - 1]
1935:           end
1936:         end
1937:       }.to_s
1938:     end

Generate a reset button Input element, as a String.

This resets the values on a form to their initial values. value is the text displayed on the button. name is the name of this button.

Alternatively, the attributes can be specified as a hash.

  reset
    # <INPUT TYPE="reset">

  reset("reset")
    # <INPUT TYPE="reset" VALUE="reset">

  reset("VALUE" => "reset", "ID" => "foo")
    # <INPUT TYPE="reset" VALUE="reset" ID="foo">

[Source]

      # File lib/cgi.rb, line 1955
1955:     def reset(value = nil, name = nil)
1956:       attributes = if (not value) or value.kind_of?(String)
1957:                      { "TYPE" => "reset", "VALUE" => value, "NAME" => name }
1958:                    else
1959:                      value["TYPE"] = "reset"
1960:                      value
1961:                    end
1962:       input(attributes)
1963:     end
scrolling_list(name = "", *values)

Alias for popup_menu

Generate a submit button Input element, as a String.

value is the text to display on the button. name is the name of the input.

Alternatively, the attributes can be specified as a hash.

  submit
    # <INPUT TYPE="submit">

  submit("ok")
    # <INPUT TYPE="submit" VALUE="ok">

  submit("ok", "button1")
    # <INPUT TYPE="submit" VALUE="ok" NAME="button1">

  submit("VALUE" => "ok", "NAME" => "button1", "ID" => "foo")
    # <INPUT TYPE="submit" VALUE="ok" NAME="button1" ID="foo">

[Source]

      # File lib/cgi.rb, line 1985
1985:     def submit(value = nil, name = nil)
1986:       attributes = if (not value) or value.kind_of?(String)
1987:                      { "TYPE" => "submit", "VALUE" => value, "NAME" => name }
1988:                    else
1989:                      value["TYPE"] = "submit"
1990:                      value
1991:                    end
1992:       input(attributes)
1993:     end

Generate a text field Input element, as a String.

name is the name of the input field. value is its initial value. size is the size of the input area. maxlength is the maximum length of input accepted.

Alternatively, the attributes can be specified as a hash.

  text_field("name")
    # <INPUT TYPE="text" NAME="name" SIZE="40">

  text_field("name", "value")
    # <INPUT TYPE="text" NAME="name" VALUE="value" SIZE="40">

  text_field("name", "value", 80)
    # <INPUT TYPE="text" NAME="name" VALUE="value" SIZE="80">

  text_field("name", "value", 80, 200)
    # <INPUT TYPE="text" NAME="name" VALUE="value" SIZE="80" MAXLENGTH="200">

  text_field("NAME" => "name", "VALUE" => "value")
    # <INPUT TYPE="text" NAME="name" VALUE="value">

[Source]

      # File lib/cgi.rb, line 2017
2017:     def text_field(name = "", value = nil, size = 40, maxlength = nil)
2018:       attributes = if name.kind_of?(String)
2019:                      { "TYPE" => "text", "NAME" => name, "VALUE" => value,
2020:                        "SIZE" => size.to_s }
2021:                    else
2022:                      name["TYPE"] = "text"
2023:                      name
2024:                    end
2025:       attributes["MAXLENGTH"] = maxlength.to_s if maxlength
2026:       input(attributes)
2027:     end

Generate a TextArea element, as a String.

name is the name of the textarea. cols is the number of columns and rows is the number of rows in the display.

Alternatively, the attributes can be specified as a hash.

The body is provided by the passed-in no-argument block

  textarea("name")
     # = textarea("NAME" => "name", "COLS" => 70, "ROWS" => 10)

  textarea("name", 40, 5)
     # = textarea("NAME" => "name", "COLS" => 40, "ROWS" => 5)

[Source]

      # File lib/cgi.rb, line 2043
2043:     def textarea(name = "", cols = 70, rows = 10)  # :yield:
2044:       attributes = if name.kind_of?(String)
2045:                      { "NAME" => name, "COLS" => cols.to_s,
2046:                        "ROWS" => rows.to_s }
2047:                    else
2048:                      name
2049:                    end
2050:       if block_given?
2051:         super(attributes){ yield }
2052:       else
2053:         super(attributes)
2054:       end
2055:     end

[Validate]