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 1327
1327:     def a(href = "") # :yield:
1328:       attributes = if href.kind_of?(String)
1329:                      { "HREF" => href }
1330:                    else
1331:                      href
1332:                    end
1333:       if block_given?
1334:         super(attributes){ yield }
1335:       else
1336:         super(attributes)
1337:       end
1338:     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 1349
1349:     def base(href = "") # :yield:
1350:       attributes = if href.kind_of?(String)
1351:                      { "HREF" => href }
1352:                    else
1353:                      href
1354:                    end
1355:       if block_given?
1356:         super(attributes){ yield }
1357:       else
1358:         super(attributes)
1359:       end
1360:     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 1372
1372:     def blockquote(cite = nil)  # :yield:
1373:       attributes = if cite.kind_of?(String)
1374:                      { "CITE" => cite }
1375:                    else
1376:                      cite or ""
1377:                    end
1378:       if block_given?
1379:         super(attributes){ yield }
1380:       else
1381:         super(attributes)
1382:       end
1383:     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 1396
1396:     def caption(align = nil) # :yield:
1397:       attributes = if align.kind_of?(String)
1398:                      { "ALIGN" => align }
1399:                    else
1400:                      align or ""
1401:                    end
1402:       if block_given?
1403:         super(attributes){ yield }
1404:       else
1405:         super(attributes)
1406:       end
1407:     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 1426
1426:     def checkbox(name = "", value = nil, checked = nil)
1427:       attributes = if name.kind_of?(String)
1428:                      { "TYPE" => "checkbox", "NAME" => name,
1429:                        "VALUE" => value, "CHECKED" => checked }
1430:                    else
1431:                      name["TYPE"] = "checkbox"
1432:                      name
1433:                    end
1434:       input(attributes)
1435:     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 1480
1480:     def checkbox_group(name = "", *values)
1481:       if name.kind_of?(Hash)
1482:         values = name["VALUES"]
1483:         name = name["NAME"]
1484:       end
1485:       values.collect{|value|
1486:         if value.kind_of?(String)
1487:           checkbox(name, value) + value
1488:         else
1489:           if value[value.size - 1] == true
1490:             checkbox(name, value[0], true) +
1491:             value[value.size - 2]
1492:           else
1493:             checkbox(name, value[0]) +
1494:             value[value.size - 1]
1495:           end
1496:         end
1497:       }.to_s
1498:     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 1522
1522:     def file_field(name = "", size = 20, maxlength = nil)
1523:       attributes = if name.kind_of?(String)
1524:                      { "TYPE" => "file", "NAME" => name,
1525:                        "SIZE" => size.to_s }
1526:                    else
1527:                      name["TYPE"] = "file"
1528:                      name
1529:                    end
1530:       attributes["MAXLENGTH"] = maxlength.to_s if maxlength
1531:       input(attributes)
1532:     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 1556
1556:     def form(method = "post", action = script_name, enctype = "application/x-www-form-urlencoded")
1557:       attributes = if method.kind_of?(String)
1558:                      { "METHOD" => method, "ACTION" => action,
1559:                        "ENCTYPE" => enctype } 
1560:                    else
1561:                      unless method.has_key?("METHOD")
1562:                        method["METHOD"] = "post"
1563:                      end
1564:                      unless method.has_key?("ENCTYPE")
1565:                        method["ENCTYPE"] = enctype
1566:                      end
1567:                      method
1568:                    end
1569:       if block_given?
1570:         body = yield
1571:       else
1572:         body = ""
1573:       end
1574:       if @output_hidden
1575:         body += @output_hidden.collect{|k,v|
1576:           "<INPUT TYPE=\"HIDDEN\" NAME=\"#{k}\" VALUE=\"#{v}\">"
1577:         }.to_s
1578:       end
1579:       super(attributes){body}
1580:     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 1597
1597:     def hidden(name = "", value = nil)
1598:       attributes = if name.kind_of?(String)
1599:                      { "TYPE" => "hidden", "NAME" => name, "VALUE" => value }
1600:                    else
1601:                      name["TYPE"] = "hidden"
1602:                      name
1603:                    end
1604:       input(attributes)
1605:     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 1649
1649:     def html(attributes = {}) # :yield:
1650:       if nil == attributes
1651:         attributes = {}
1652:       elsif "PRETTY" == attributes
1653:         attributes = { "PRETTY" => true }
1654:       end
1655:       pretty = attributes.delete("PRETTY")
1656:       pretty = "  " if true == pretty
1657:       buf = ""
1658: 
1659:       if attributes.has_key?("DOCTYPE")
1660:         if attributes["DOCTYPE"]
1661:           buf += attributes.delete("DOCTYPE")
1662:         else
1663:           attributes.delete("DOCTYPE")
1664:         end
1665:       else
1666:         buf += doctype
1667:       end
1668: 
1669:       if block_given?
1670:         buf += super(attributes){ yield }
1671:       else
1672:         buf += super(attributes)
1673:       end
1674: 
1675:       if pretty
1676:         CGI::pretty(buf, pretty)
1677:       else
1678:         buf
1679:       end
1680: 
1681:     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 1698
1698:     def image_button(src = "", name = nil, alt = nil)
1699:       attributes = if src.kind_of?(String)
1700:                      { "TYPE" => "image", "SRC" => src, "NAME" => name,
1701:                        "ALT" => alt }
1702:                    else
1703:                      src["TYPE"] = "image"
1704:                      src["SRC"] ||= ""
1705:                      src
1706:                    end
1707:       input(attributes)
1708:     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 1724
1724:     def img(src = "", alt = "", width = nil, height = nil)
1725:       attributes = if src.kind_of?(String)
1726:                      { "SRC" => src, "ALT" => alt }
1727:                    else
1728:                      src
1729:                    end
1730:       attributes["WIDTH"] = width.to_s if width
1731:       attributes["HEIGHT"] = height.to_s if height
1732:       super(attributes)
1733:     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 1750
1750:     def multipart_form(action = nil, enctype = "multipart/form-data")
1751:       attributes = if action == nil
1752:                      { "METHOD" => "post", "ENCTYPE" => enctype } 
1753:                    elsif action.kind_of?(String)
1754:                      { "METHOD" => "post", "ACTION" => action,
1755:                        "ENCTYPE" => enctype } 
1756:                    else
1757:                      unless action.has_key?("METHOD")
1758:                        action["METHOD"] = "post"
1759:                      end
1760:                      unless action.has_key?("ENCTYPE")
1761:                        action["ENCTYPE"] = enctype
1762:                      end
1763:                      action
1764:                    end
1765:       if block_given?
1766:         form(attributes){ yield }
1767:       else
1768:         form(attributes)
1769:       end
1770:     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 1792
1792:     def password_field(name = "", value = nil, size = 40, maxlength = nil)
1793:       attributes = if name.kind_of?(String)
1794:                      { "TYPE" => "password", "NAME" => name,
1795:                        "VALUE" => value, "SIZE" => size.to_s }
1796:                    else
1797:                      name["TYPE"] = "password"
1798:                      name
1799:                    end
1800:       attributes["MAXLENGTH"] = maxlength.to_s if maxlength
1801:       input(attributes)
1802:     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 1847
1847:     def popup_menu(name = "", *values)
1848: 
1849:       if name.kind_of?(Hash)
1850:         values   = name["VALUES"]
1851:         size     = name["SIZE"].to_s if name["SIZE"]
1852:         multiple = name["MULTIPLE"]
1853:         name     = name["NAME"]
1854:       else
1855:         size = nil
1856:         multiple = nil
1857:       end
1858: 
1859:       select({ "NAME" => name, "SIZE" => size,
1860:                "MULTIPLE" => multiple }){
1861:         values.collect{|value|
1862:           if value.kind_of?(String)
1863:             option({ "VALUE" => value }){ value }
1864:           else
1865:             if value[value.size - 1] == true
1866:               option({ "VALUE" => value[0], "SELECTED" => true }){
1867:                 value[value.size - 2]
1868:               }
1869:             else
1870:               option({ "VALUE" => value[0] }){
1871:                 value[value.size - 1]
1872:               }
1873:             end
1874:           end
1875:         }.to_s
1876:       }
1877: 
1878:     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 1896
1896:     def radio_button(name = "", value = nil, checked = nil)
1897:       attributes = if name.kind_of?(String)
1898:                      { "TYPE" => "radio", "NAME" => name,
1899:                        "VALUE" => value, "CHECKED" => checked }
1900:                    else
1901:                      name["TYPE"] = "radio"
1902:                      name
1903:                    end
1904:       input(attributes)
1905:     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 1935
1935:     def radio_group(name = "", *values)
1936:       if name.kind_of?(Hash)
1937:         values = name["VALUES"]
1938:         name = name["NAME"]
1939:       end
1940:       values.collect{|value|
1941:         if value.kind_of?(String)
1942:           radio_button(name, value) + value
1943:         else
1944:           if value[value.size - 1] == true
1945:             radio_button(name, value[0], true) +
1946:             value[value.size - 2]
1947:           else
1948:             radio_button(name, value[0]) +
1949:             value[value.size - 1]
1950:           end
1951:         end
1952:       }.to_s
1953:     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 1970
1970:     def reset(value = nil, name = nil)
1971:       attributes = if (not value) or value.kind_of?(String)
1972:                      { "TYPE" => "reset", "VALUE" => value, "NAME" => name }
1973:                    else
1974:                      value["TYPE"] = "reset"
1975:                      value
1976:                    end
1977:       input(attributes)
1978:     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 2000
2000:     def submit(value = nil, name = nil)
2001:       attributes = if (not value) or value.kind_of?(String)
2002:                      { "TYPE" => "submit", "VALUE" => value, "NAME" => name }
2003:                    else
2004:                      value["TYPE"] = "submit"
2005:                      value
2006:                    end
2007:       input(attributes)
2008:     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 2032
2032:     def text_field(name = "", value = nil, size = 40, maxlength = nil)
2033:       attributes = if name.kind_of?(String)
2034:                      { "TYPE" => "text", "NAME" => name, "VALUE" => value,
2035:                        "SIZE" => size.to_s }
2036:                    else
2037:                      name["TYPE"] = "text"
2038:                      name
2039:                    end
2040:       attributes["MAXLENGTH"] = maxlength.to_s if maxlength
2041:       input(attributes)
2042:     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 2058
2058:     def textarea(name = "", cols = 70, rows = 10)  # :yield:
2059:       attributes = if name.kind_of?(String)
2060:                      { "NAME" => name, "COLS" => cols.to_s,
2061:                        "ROWS" => rows.to_s }
2062:                    else
2063:                      name
2064:                    end
2065:       if block_given?
2066:         super(attributes){ yield }
2067:       else
2068:         super(attributes)
2069:       end
2070:     end

[Validate]