Html(3)                                                                Html(3)



NNAAMMEE
       Html -

SSYYNNOOPPSSIISS
       Inherited by LLooggiinnWWWWWW.


   PPuubblliicc MMeetthhooddss
       varargs string hhttmmllddoocc (string body, string title, string bodytags)
       string ffooootteerr ()
       string ccoolloorr (string rgb, string text)
       string hhlliinnee ()
       string bboolldd (string text)
       string iittaalliiccss (string text)
       string uunnddeerrlliinnee (string text)
       string ssttrriikkeeoouutt (string text)
       string ffiixxeeddwwiiddtthh (string text)
       string iinnddeenntt (string text)
       string bbrr ()
       string pp ()
       string jjlleefftt (string text)
       string jjrriigghhtt (string text)
       string jjcceenntteerr (string text)
       string tteexxttssiizzee (string dsize, string text)
       string iimmaaggee (string href, string width, string height, string tags)
       string ffoorrmm (string method, string action, string body, string target)
       varargs string tteexxtt (string varname, string value, int size)
       varargs string tteexxttaarreeaa (string varname, string body, int width, int
           height, string tags)
       string hhiiddddeenn__tteexxtt (string varname, string value)
       varargs string ppaasssstteexxtt (string varname, string value, int size)
       varargs string ffoorrmmssuubbmmiitt (string caption, string type)
       varargs string iimmaaggeessuubbmmiitt (string src, string alt, string name, string
           tags)
       varargs string ffrraammeeddoocc (string frames, string non_frames, string
           bodytags)
       string ffrraammeesseett (string style, string layout, string framesrc)
       string ffrraammee (string src, string tags)
       mapping eexxttrraacctt__aarrgguummeennttss (string *inputs)
       string hhaasshh__uurrll (string in)
       string mmaakkee__vvaarrss (mapping vals)
       string wwiizzmmeennuu ()

   PPuubblliicc AAttttrriibbuutteess
       int hhiitt__ccoouunntt

DDEETTAAIILLEEDD DDEESSCCRRIIPPTTIIOONN
       This file contains functions that make it easier to generate HTML code.
       Generally the functions follow the tag layout pretty closely.

       Definition at line 7 of file inherit/html.c.

MMEEMMBBEERR FFUUNNCCTTIIOONN DDOOCCUUMMEENNTTAATTIIOONN
   ssttrriinngg bboolldd ((ssttrriinngg tteexxtt))
       RReettuurrnnss::
           _t_e_x_t bolded

       Definition at line 73 of file inherit/html.c.

       References text().

   ssttrriinngg bbrr (())
       RReettuurrnnss::
           A line break

       Definition at line 103 of file inherit/html.c.

   ssttrriinngg ccoolloorr ((ssttrriinngg rrggbb,, ssttrriinngg tteexxtt))
       RReettuurrnnss::
           _t_e_x_t wrapped in color codes. RGB is usually in hex.

       Definition at line 63 of file inherit/html.c.

       References text().

   mmaappppiinngg eexxttrraacctt__aarrgguummeennttss ((ssttrriinngg ** iinnppuuttss))
       Converts an array of CGI arguments of the form 'name=val' to a mapping
       of the form ([ 'name':'val', 'name2':val2, ... ]). Note: This function
       isn't really used any more, and may be deleted if we ever get all the
       code changed over.

       Definition at line 321 of file inherit/html.c.

   ssttrriinngg ffiixxeeddwwiiddtthh ((ssttrriinngg tteexxtt))
       RReettuurrnnss::
           _t_e_x_t in a fixed width font (typewriter style)

       Definition at line 93 of file inherit/html.c.

       References text().

   ssttrriinngg ffooootteerr (())
       Automatically generates a footer for this page. This allows me to
       quickly throw in random details for a page. It isn't appropriate to do
       this on every page, so I've made it an optional function call; however,
       most pages should include a footer.

       Definition at line 47 of file inherit/html.c.

       References hit_count.

   ssttrriinngg ffoorrmm ((ssttrriinngg mmeetthhoodd,, ssttrriinngg aaccttiioonn,, ssttrriinngg bbooddyy,, ssttrriinngg ttaarrggeett))
       RReettuurrnnss::
           An entire form. Forms are used to allow web page users to enter in
           values. Some tags will only work properly when they occur in the
           body of a form. You should also include at least one 'submit' tag
           somewhere in the form.

       PPaarraammeetteerrss::

       _m_e_t_h_o_d Either 'get' or 'post'. Use 'post' if your form will contain a
              lot of data (more than hundreds of bytes), or 'get' otherwise.
              The MUD web-server can handle either style, and receiving
              programs cannot tell the difference, so this is not critical. If
              you pass in 0, then 'get' is assumed.

       _a_c_t_i_o_n The URL of the program to whom this data should be submitted.
              This may be anything on the web. If you pass it into a MUD-
              server program, the form values will be passed as a parameter
              into the www_main.

       _b_o_d_y   This is the text that occurs within the form tags. You should
              add relevant input fields in here.

       _t_a_r_g_e_t (Optional) If you don't want the form results showing up in the
              same frame as the form itself, you may specify a target. This is
              associated with frames.

       Definition at line 167 of file inherit/html.c.

   vvaarraarrggss ssttrriinngg ffoorrmmssuubbmmiitt ((ssttrriinngg ccaappttiioonn,, ssttrriinngg ttyyppee))
       RReettuurrnnss::
           A form submission button. Must be used within a ffoorrmm(()). When the
           user clicks this button, the browser is obligated to send the
           information to the URL given in the ffoorrmm(()) tag itself (the values
           are passed to www_main if the destination is on the MUD server).

       PPaarraammeetteerrss::

       _c_a_p_t_i_o_n
              (Optional) The caption on the submission button. If you leave
              this off, most browsers will use 'Submit'.

       _t_y_p_e   (Optional) The submission type. If this is specified, then the
              value _t_y_p_e_=_c_a_p_t_i_o_n will be added to this list of submitted
              values. This allows you to have multiple submit buttons that
              perform different actions.

       Definition at line 241 of file inherit/html.c.

   ssttrriinngg ffrraammee ((ssttrriinngg ssrrcc,, ssttrriinngg ttaaggss))
       RReettuurrnnss::
           The codes for a single frame. _s_r_c The source document for the
           frame. _t_a_g_s (Optional) Any additional tags to be tucked inside of
           the frames tag. The name tag is particularly useful here.

       Definition at line 311 of file inherit/html.c.

   vvaarraarrggss ssttrriinngg ffrraammeeddoocc ((ssttrriinngg ffrraammeess,, ssttrriinngg nnoonn__ffrraammeess,, ssttrriinngg bbooddyyttaaggss))
       RReettuurrnnss::
           A frames based document. This tag should be used as a standalone
           tag, not inside of an htmldoc tag.

       PPaarraammeetteerrss::

       _f_r_a_m_e_s Define your frames here using the ffrraammeesseett(()) and ffrraammee(()) tags.

       _n_o_n___f_r_a_m_e_s
              (Optional) An alternative version of the framed document for
              those who can't use frames. This is similar to the body tag of
              an hhttmmllddoocc(()). If you don't specify a non_frames document, then
              an error message is placed here.

       _b_o_d_y_t_a_g_s
              (Optional) Additional HTML tags for the body. Gray text on a
              black background is used if you don't specify anything.

       Definition at line 282 of file inherit/html.c.

   ssttrriinngg ffrraammeesseett ((ssttrriinngg ssttyyllee,, ssttrriinngg llaayyoouutt,, ssttrriinngg ffrraammeessrrcc))
       RReettuurrnnss::
           A frameset. A frameset consists of a style, layout and a sequence
           of frames.

       PPaarraammeetteerrss::

       _s_t_y_l_e  Specifies whether the frames are on top of each other ('rows')
              or next to each other ('cols'). These are the only two valid
              values.

       _l_a_y_o_u_t A comma-seperated list giving the relative sizes of each of the
              frames. The number of items in the list should match the number
              of frames specified in the framesrc. Example lists are
              '30%,70%', which would allocate 30% to the top/left frame and
              70% to the bottom/right frame. You can also give absolute
              numbers in pixels, and a number followed by an asterisk for
              relative allocation (relative allocation is done after all of
              the specific allocation is taken care of; the numbers are used
              as ratios).

       _f_r_a_m_e_s_r_c
              A sequence of ffrraammee(()) and/or ffrraammeesseett(()) tags.

       Definition at line 302 of file inherit/html.c.

   ssttrriinngg hhaasshh__uurrll ((ssttrriinngg iinn))
       Quick and dirty -- hashes a normal string to URL format and returns it.

       Definition at line 335 of file inherit/html.c.

       Referenced by make_vars().

   ssttrriinngg hhiiddddeenn__tteexxtt ((ssttrriinngg vvaarrnnaammee,, ssttrriinngg vvaalluuee))
       A hidden text entry field for a form. This is used to pass hidden data
       in the form along with the normal values. It is only really useful on
       dynamic web pages.

       PPaarraammeetteerrss::

       _v_a_r_n_a_m_e
              The name of the hidden field.

       _v_a_l_u_e  The value of the hidden field. The pair varname=value will be
              returned when the form is submitted.

       Definition at line 214 of file inherit/html.c.

   ssttrriinngg hhlliinnee (())
       RReettuurrnnss::
           the code for a horizontal line.

       Definition at line 68 of file inherit/html.c.

   vvaarraarrggss ssttrriinngg hhttmmllddoocc ((ssttrriinngg bbooddyy,, ssttrriinngg ttiittllee,, ssttrriinngg bbooddyyttaaggss))
       RReettuurrnnss::
           a complete HTML document with _t_i_t_l_e as its title.

       PPaarraammeetteerrss::

       _b_o_d_y   The actual HTML to be contained in the document.

       _t_i_t_l_e  The title of the document (optional)

       _b_o_d_y_t_a_g_s
              Additional tags to be added to the body (optional)

       Definition at line 22 of file inherit/html.c.

   ssttrriinngg iimmaaggee ((ssttrriinngg hhrreeff,, ssttrriinngg wwiiddtthh,, ssttrriinngg hheeiigghhtt,, ssttrriinngg ttaaggss))
       RReettuurrnnss::
           The image given by _h_r_e_f. At present, images will need to be served
           by some other server; I haven't gotten the SIMud server handling
           them yet.

       PPaarraammeetteerrss::

       _h_r_e_f   The full URL of the image itself

       _w_i_d_t_h  (Optional but recommended) The width, in pixels, of the image

       _h_e_i_g_h_t (Optional but recommended) The height, in pixels, of the image

       _t_a_g_s   (Optional) Any additional tags you wish to add

       Definition at line 140 of file inherit/html.c.

   vvaarraarrggss ssttrriinngg iimmaaggeessuubbmmiitt ((ssttrriinngg ssrrcc,, ssttrriinngg aalltt,, ssttrriinngg nnaammee,, ssttrriinngg
       ttaaggss))
       RReettuurrnnss::
           A linked image that does a form submission. Must be used within a
           ffoorrmm(()). It functions the same way as a ffoorrmmssuubbmmiitt(()) button, except
           that it is an image.

       PPaarraammeetteerrss::

       _s_r_c    The full URL of the image to be displayed.

       _a_l_t    (Optional) The alternative text for this submit button. This is
              usually what is displayed in non-graphical browsers. Defaults to
              'Submit'.

       _n_a_m_e   (Optional) If specified, then the name and tag is set, and the
              pixel coordinates on which the user clicked will be returned as
              name.x and name.y in the form data. As far as I can tell, the
              best way to check which image-map was clicked is to search for
              the matching name.x/name.y.

       _t_a_g_s   (Optional) Additional HTML tags should be given in this
              parameter.

       Definition at line 264 of file inherit/html.c.

   ssttrriinngg iinnddeenntt ((ssttrriinngg tteexxtt))
       RReettuurrnnss::
           _t_e_x_t indented (as a 'block quote')

       Definition at line 98 of file inherit/html.c.

       References text().

   ssttrriinngg iittaalliiccss ((ssttrriinngg tteexxtt))
       RReettuurrnnss::
           _t_e_x_t italicized

       Definition at line 78 of file inherit/html.c.

       References text().

   ssttrriinngg jjcceenntteerr ((ssttrriinngg tteexxtt))
       RReettuurrnnss::
           _t_e_x_t centered

       Definition at line 123 of file inherit/html.c.

       References text().

   ssttrriinngg jjlleefftt ((ssttrriinngg tteexxtt))
       RReettuurrnnss::
           _t_e_x_t left-justified

       Definition at line 113 of file inherit/html.c.

       References text().

   ssttrriinngg jjrriigghhtt ((ssttrriinngg tteexxtt))
       RReettuurrnnss::
           _t_e_x_t right-justified

       Definition at line 118 of file inherit/html.c.

       References text().

   ssttrriinngg mmaakkee__vvaarrss ((mmaappppiinngg vvaallss))
       Quick and dirty -- Converts a mapping of variables into something
       appropriate to send a CGI.

       Definition at line 355 of file inherit/html.c.

       References hash_url().

   ssttrriinngg pp (())
       RReettuurrnnss::
           A paragraph break


       Definition at line 108 of file inherit/html.c.

   vvaarraarrggss ssttrriinngg ppaasssstteexxtt ((ssttrriinngg vvaarrnnaammee,, ssttrriinngg vvaalluuee,, iinntt ssiizzee))
       This field is _i_d_e_n_t_i_c_a_l to the tteexxtt(()) field above, the only difference
       is that text typed is invisible. This is usually done by displaying
       only asterisks for typed-in characters, and is intended for passwords.

       Definition at line 223 of file inherit/html.c.

   ssttrriinngg ssttrriikkeeoouutt ((ssttrriinngg tteexxtt))
       RReettuurrnnss::
           _t_e_x_t with a horizontal line through it

       Definition at line 88 of file inherit/html.c.

       References text().

   vvaarraarrggss ssttrriinngg tteexxtt ((ssttrriinngg vvaarrnnaammee,, ssttrriinngg vvaalluuee,, iinntt ssiizzee))
       RReettuurrnnss::
           A single-line text entry field. Must be used within a ffoorrmm(()). The
           values will then be submitted to the receiving object in the format
           _v_a_r_n_a_m_e_=_t_e_x_t.

       PPaarraammeetteerrss::

       _v_a_r_n_a_m_e
              The name of the variable associated with the text in the entry
              field.

       _v_a_l_u_e  (Optional) The initial, default value for the text. If you don't
              specify, this will be blank.

       _s_i_z_e   (Optional) The maximum number of characters for the text entry
              field. If left unspecified then it is up to the browser to
              decide.

       Definition at line 185 of file inherit/html.c.

       Referenced by bold(), color(), fixedwidth(), indent(), italics(),
       jcenter(), jleft(), jright(), strikeout(), textsize(), and underline().

   vvaarraarrggss ssttrriinngg tteexxttaarreeaa ((ssttrriinngg vvaarrnnaammee,, ssttrriinngg bbooddyy,, iinntt wwiiddtthh,, iinntt
       hheeiigghhtt,, ssttrriinngg ttaaggss))
       RReettuurrnnss::
           A multi-line text entry area.

       PPaarraammeetteerrss::

       _v_a_r_n_a_m_e
              The of the variable associated with the text entered into this
              text area. This is so you can find it when the form gets
              submitted.

       _b_o_d_y   (Optional) The initial text in the text area. Usually the empty
              string ''

       _w_i_d_t_h  (Optional) The width, in characters, of the text area.

       _h_e_i_g_h_t (Optional) The height, in rows, of the text area.

       _t_a_g_s   (Optional) Any additional tags you wish to add (such as
              linewrap, etc.).

       Definition at line 199 of file inherit/html.c.

   ssttrriinngg tteexxttssiizzee ((ssttrriinngg ddssiizzee,, ssttrriinngg tteexxtt))
       RReettuurrnnss::
           _t_e_x_t with font size adjusted by _d_s_i_z_e (one of -2, -1, +1, +2, +3)

       Definition at line 128 of file inherit/html.c.

       References text().

   ssttrriinngg uunnddeerrlliinnee ((ssttrriinngg tteexxtt))
       RReettuurrnnss::
           _t_e_x_t underlined

       Definition at line 83 of file inherit/html.c.

       References text().

   ssttrriinngg wwiizzmmeennuu (())
       RReettuurrnnss::
           The standard wizard menu.

       Definition at line 368 of file inherit/html.c.

MMEEMMBBEERR DDAATTAA DDOOCCUUMMEENNTTAATTIIOONN
   iinntt hhiitt__ccoouunntt
       Used to generate a page hit-count for page footers. Incremented every
       time the function ffooootteerr(()) is called for each page.

       Definition at line 15 of file inherit/html.c.

       Referenced by footer().


AAUUTTHHOORR
       Generated automatically by Doxygen for Walraven from the source code.



Walraven                          8 Jan 2004                           Html(3)
