05f7823b4102ed977618e73aa0da35ec9db85694
[freeside.git] / htdocs / docs / man / FS / CGI.html
1 <HTML>
2 <HEAD>
3 <TITLE>FS::CGI - Subroutines for the web interface</TITLE>
4 <LINK REV="made" HREF="mailto:perl@packages.debian.org">
5 </HEAD>
6
7 <BODY>
8
9 <A NAME="__index__"></A>
10 <!-- INDEX BEGIN -->
11
12 <UL>
13
14         <LI><A HREF="#name">NAME</A></LI>
15         <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
16         <LI><A HREF="#description">DESCRIPTION</A></LI>
17         <LI><A HREF="#subroutines">SUBROUTINES</A></LI>
18         <LI><A HREF="#bugs">BUGS</A></LI>
19         <LI><A HREF="#see also">SEE ALSO</A></LI>
20 </UL>
21 <!-- INDEX END -->
22
23 <HR>
24 <P>
25 <H1><A NAME="name">NAME</A></H1>
26 <P>FS::CGI - Subroutines for the web interface</P>
27 <P>
28 <HR>
29 <H1><A NAME="synopsis">SYNOPSIS</A></H1>
30 <PRE>
31   use FS::CGI qw(header menubar idiot eidiot popurl);</PRE>
32 <PRE>
33   print header( 'Title', '' );
34   print header( 'Title', menubar('item', 'URL', ... ) );</PRE>
35 <PRE>
36   idiot &quot;error message&quot;; 
37   eidiot &quot;error message&quot;;</PRE>
38 <PRE>
39   $url = popurl; #returns current url
40   $url = popurl(3); #three levels up</PRE>
41 <P>
42 <HR>
43 <H1><A NAME="description">DESCRIPTION</A></H1>
44 <P>Provides a few common subroutines for the web interface.</P>
45 <P>
46 <HR>
47 <H1><A NAME="subroutines">SUBROUTINES</A></H1>
48 <DL>
49 <DT><STRONG><A NAME="item_header">header TITLE, MENUBAR</A></STRONG><BR>
50 <DD>
51 Returns an HTML header.
52 <P></P>
53 <DT><STRONG><A NAME="item_menubar_ITEM%2C_URL%2C_%2E%2E%2E">menubar ITEM, URL, ...</A></STRONG><BR>
54 <DD>
55 Returns an HTML menubar.
56 <P></P>
57 <DT><STRONG><A NAME="item_idiot">idiot ERROR</A></STRONG><BR>
58 <DD>
59 This is depriciated.  Don't use it.
60 <P>Sends headers and an HTML error message.</P>
61 <P></P>
62 <DT><STRONG><A NAME="item_eidiot">eidiot ERROR</A></STRONG><BR>
63 <DD>
64 This is depriciated.  Don't use it.
65 <P>Sends headers and an HTML error message, then exits.</P>
66 <P></P>
67 <DT><STRONG><A NAME="item_popurl">popurl LEVEL</A></STRONG><BR>
68 <DD>
69 Returns current URL with LEVEL levels of path removed from the end (default 0).
70 <P></P>
71 <DT><STRONG><A NAME="item_table">table</A></STRONG><BR>
72 <DD>
73 Returns HTML tag for beginning a table.
74 <P></P>
75 <DT><STRONG><A NAME="item_itable">itable</A></STRONG><BR>
76 <DD>
77 Returns HTML tag for beginning an (invisible) table.
78 <P></P>
79 <DT><STRONG><A NAME="item_ntable">ntable</A></STRONG><BR>
80 <DD>
81 This is getting silly.
82 <P></P></DL>
83 <P>
84 <HR>
85 <H1><A NAME="bugs">BUGS</A></H1>
86 <P>Not OO.</P>
87 <P>Not complete.</P>
88 <P>
89 <HR>
90 <H1><A NAME="see also">SEE ALSO</A></H1>
91 <P><A HREF=".././FS/CGI.html">the CGI manpage</A>, <A HREF="../CGI/Base.html">the CGI::Base manpage</A></P>
92
93 </BODY>
94
95 </HTML>