diff --git a/docs/create.sql b/docs/create.sql index b95c7c2c2..921a083e5 100644 --- a/docs/create.sql +++ b/docs/create.sql @@ -108,6 +108,22 @@ CREATE TABLE FAQ_question ( # +# +# Table structure for table 'Item' +# + +CREATE TABLE Item ( + widgetId int(11) default NULL, + description text, + linkURL text, + attachment varchar(255) default NULL +) TYPE=MyISAM; + +# +# Dumping data for table 'Item' +# + + # # Table structure for table 'LinkList' # @@ -431,8 +447,8 @@ INSERT INTO help VALUES (15,'WebGUI','English','Delete','Group','As the function INSERT INTO help VALUES (16,'WebGUI','English','Add/Edit','Style','Styles are WebGUI macro enabled. See Using Macros for more information.\r\n\r\nStyle Name\r\nA unique name to describe what this style looks like at a glance. The name has no effect on the actual look of the style.\r\n\r\nHeader\r\nThe header is the start of the look of your site. It is helpful to look at your design and cut it into three pieces. The top and left of your design is the header. The center part is the content, and the right and bottom is the footer. Cut the HTML from your header and paste it in the space provided.\r\n\r\nIf you are in need of assistance for creating a look for your site, or if you need help cutting apart your design, Plain Black Software provides support services for a small fee.\r\n\r\nMany people will add WebGUI macros to their header for automated navigation, and other features.\r\n\r\nFooter\r\nThe footer is the end of the look for your site. It is the right and bottom portion of your design. You may also place WebGUI macros in your footer.\r\n\r\nStyle Sheet\r\nPlace your style sheet entries here. Style sheets are used to control colors, sizes, and other properties of the elements on your site. See Using Style Sheets for more information.\r\n\r\nAdvanced Users: for greater performance create your stylesheet on the file system (call it something like webgui.css) and add an entry like this to this area: \r\n<link href=\"/webgui.css\" rel=\"stylesheet\" rev=\"stylesheet\" type=\"text/css\">','4,5'); INSERT INTO help VALUES (17,'WebGUI','English','Add/Edit','Group','See Manage Group for a description of grouping functions and the default groups.\r\n\r\nGroup Name\r\nA name for the group. It is best if the name is descriptive so you know what it is at a glance.\r\n\r\nDescription\r\nA longer description of the group so that other admins and content managers (or you if you forget) will know what the purpose of this group is.','0'); INSERT INTO help VALUES (24,'WebGUI','English','Edit','Miscellaneous Settings','Not Found Page\r\nIf a page that a user requests is not found in the system, the user can be redirected to the home page or to an error page where they can attempt to find what they were looking for. You decide which is better for your users.\r\n\r\nSession Timeout\r\nThe time (in seconds) that a user session remains active (before needing to log in again). This timeout is reset each time a visitor hits a page. Therefore if you set the timeout for 8 hours, a user would have to log in again if s/he hadn\'t visited the site for 8 hours.\r\n\r\n1800 = half hour\r\n3600 = 1 hour\r\n28000 = 8 hours\r\n86400 = 1 day\r\n604800 = 1 week\r\n1209600 = 2 weeks\r\n','6'); -INSERT INTO help VALUES (18,'WebGUI','English','Using','Style Sheets','Cascading Style Sheets (CSS) are a great way to manage the look and feel of any web site. They are used extensively in WebGUI.\r\n\r\nIf you are unfamiliar with how to use CSS, Plain Black Software provides training classes on XHTML and CSS. Alternatively, Bradsoft makes an excellent CSS editor called Top Style.\r\n\r\nThe following is a list of classes used to control the look of WebGUI:\r\n\r\nA\r\nThe links throughout the style.\r\n\r\nBODY\r\nThe default setup of all pages within a style.\r\n\r\nH1\r\nThe headers on every page.\r\n\r\n.accountOptions\r\nThe links that appear under the login and account update forms.\r\n\r\n.adminBar \r\nThe bar that appears at the top of the page when you\'re in admin mode.\r\n\r\n.content\r\nThe main content area on all pages of the style.\r\n\r\n.crumbTrail \r\nThe crumb trail (if you\'re using that macro).\r\n\r\n.formDescription \r\nThe tags on all forms next to the form elements. \r\n\r\n.formSubtext \r\nThe tags below some form elements.\r\n\r\n.highlight \r\nDenotes a highlighted item, such as which message you are viewing within a list.\r\n\r\n.homeLink\r\nUsed by the my home (^H;) macro.\r\n\r\n.horizontalMenu \r\nThe horizontal menu (if you use a horizontal menu macro).\r\n\r\n.loginBox\r\nThe login box (^L;) macro.\r\n\r\n.makePrintableLink\r\nUsed by the make printable (^r;) macro.\r\n\r\n.myAccountLink\r\nUsed by the my account (^a;) macro.\r\n\r\n.pagination \r\nThe Previous and Next links on pages with pagination.\r\n\r\n.searchBox\r\nUsed by the search (^?;) macro.\r\n\r\n.tableData \r\nThe data rows on things like message boards and user contributions.\r\n\r\n.tableHeader \r\nThe headings of columns on things like message boards and user contributions.\r\n\r\n.tableMenu \r\nThe menu on things like message boards and user submissions.\r\n\r\n.verticalMenu \r\nThe vertical menu (if you use a verticall menu macro).\r\n\r\nNote: Some widgets have their own unique styles.\r\n\r\n','0'); -INSERT INTO help VALUES (19,'WebGUI','English','Using','Macros','WebGUI macros are used to create dynamic content within otherwise static content. For instance, you may wish to show which user is logged in on every page, or you may wish to have a dynamically built menu or crumb trail. \r\n\r\nMacros always begin with a carat (^) and follow with at least one other character and ended with w semicolon (;). Some macros can be extended/configured by taking the format of ^x(\"config text\");. The following is a description of all the macros in the WebGUI system.\r\n\r\n^a; or ^a(\"new link title\"); - My Account Link\r\nA link to your account information. In addition you can change the link text by creating a macro like this ^a(\"Account Info\");.\r\n\r\n^C; - Crumb Trail\r\nA dynamically generated crumb trail to the current page.\r\n\r\n^c; - Company Name\r\nThe name of your company specified in the settings by your Administrator.\r\n\r\n^D; or ^D(\"%c %D, %y\"); - Date\r\nThe current date and time.\r\n\r\nYou can configure the date by using date formatting symbols. For instance, if you created a macro like this ^D(\"%c %D, %y\"); it would output September 26, 2001. The following are the available date formatting symbols:\r\n\r\n %% = %\r\n %y = 4 digit year\r\n %Y = 2 digit year\r\n %m = 2 digit month\r\n %M = variable digit month\r\n %c = month name\r\n %d = 2 digit day of month\r\n %D = variable digit day of month\r\n %w = day of week name\r\n %h = 2 digit base 12 hour\r\n %H = variable digit base 12 hour\r\n %j = 2 digit base 24 hour\r\n %J = variable digit base 24 hour\r\n %p = lower case am/pm\r\n %P = upper case AM/PM\r\n\r\n^e; - Company Email Address\r\nThe email address for your company specified in the settings by your Administrator.\r\n\r\n^H; or ^H(\"Go Home\"); - Home Link\r\nA link to the home page of this site. In addition you can change the link text by creating a macro like this ^H(\"Go Home\");.\r\n\r\n^L; - Login\r\nA small login form.\r\n\r\n^M; or ^M(3); - Current Menu (Vertical)\r\nA vertical menu containing the sub-pages at the current level. In addition, you may configure this macro by specifying how many levels deep the menu should go. By default it will show only the first level. To go three levels deep create a macro like this ^M(3);. If you set the macro to \"0\" it will track the entire site tree.\r\n\r\n^m; - Current Menu (Horizontal)\r\nA horizontal menu containing the sub-pages at the current level.\r\n\r\n^P; or ^P(3); - Previous Menu (Vertical)\r\nA vertical menu containing the sub-pages at the previous level. In addition, you may configure this macro by specifying how many levels deep the menu should go. By default it will show only the first level. To go three levels deep create a macro like this ^P(3);. If you set the macro to \"0\" it will track the entire site tree.\r\n\r\n^p; - Previous Menu (Horizontal)\r\nA horizontal menu containing the sub-pages at the previous level.\r\n\r\n^r; or ^r(\"Print Me!\"); - Make Page Printable\r\nCreates a link to remove the style from a page to make it printable. In addition, you can change the link text by creating a macro like this ^r(\"Print Me!\");.\r\n\r\n^S(\"home\",0); - Specific SubMenu (Vertical)\r\nThis macro allows you to get the submenu of any page, starting with the page you specified. For instance, you could get the home page submenu by creating a macro that looks like this ^S(\"home\",0);. The first value is the urlized title of the page and the second value is the depth you\'d like the menu to go. By default it will show only the first level. To go three levels deep create a macro like this ^S(\"home\",3);.\r\n\r\n^s(\"home\"); - Specific SubMenu (Horizontal)\r\nThis macro allows you to get the submenu of any page, starting with the page you specified. For instance, you could get the home page submenu by creating a macro that looks like this ^s(\"home\");. The value is the urlized title of the page.\r\n\r\n^T; or ^T(3); - Top Level Menu (Vertical)\r\nA vertical menu containing the main pages of the site (aka the sub-pages from the home page). In addition, you may configure this macro by specifying how many levels deep the menu should go. By default it will show only the first level. To go three levels deep create a macro like this ^T(3);. If you set the macro to \"0\" it will track the entire site tree.\r\n\r\n^t; - Top Level Menu (Horizontal)\r\nA vertical menu containing the main pages of the site (aka the sub-pages from the home page).\r\n\r\n^u; - Company URL\r\nThe URL for your company specified in the settings by your Administrator.\r\n\r\n^/; - System URL\r\nThe URL to the gateway script (including the domain for this site). This is often used within pages so that if your development server is on a domain different than your production server that your URLs will still worked when moved.\r\n\r\n^\\; - Page URL\r\nThe URL to the current page (including the domain for this site). This is often used within pages so that if your development server is on a domain different than your production server that your URLs will still worked when moved.\r\n\r\n^@; - Username\r\nThe username of the currently logged in user.\r\n\r\n^?; - Search\r\nAdd a search box.\r\n\r\n^#; - User ID\r\nThe user id of the currently logged in user.\r\n\r\n^*; or ^*(100); - Random Number\r\nA randomly generated number. This is often used on images (such as banner ads) that you want to ensure do not cache. In addition, you may configure this macro like this ^*(100); to create a random number between 0 and 100.\r\n\r\n^0;,^1;,^2;,^3;,^4;,^5;,^6;,^7;,^8;,^9;, ^-;\r\nThese macros are reserved for widget-specific functions as in the SQL Report widget.\r\n','0'); +INSERT INTO help VALUES (18,'WebGUI','English','Using','Style Sheets','Cascading Style Sheets (CSS) are a great way to manage the look and feel of any web site. They are used extensively in WebGUI.\r\n\r\nIf you are unfamiliar with how to use CSS, Plain Black Software provides training classes on XHTML and CSS. Alternatively, Bradsoft makes an excellent CSS editor called Top Style.\r\n\r\nThe following is a list of classes used to control the look of WebGUI:\r\n\r\nA\r\nThe links throughout the style.\r\n\r\nBODY\r\nThe default setup of all pages within a style.\r\n\r\nH1\r\nThe headers on every page.\r\n\r\n.accountOptions\r\nThe links that appear under the login and account update forms.\r\n\r\n.adminBar \r\nThe bar that appears at the top of the page when you\'re in admin mode.\r\n\r\n.content\r\nThe main content area on all pages of the style.\r\n\r\n.crumbTrail \r\nThe crumb trail (if you\'re using that macro).\r\n\r\n.formDescription \r\nThe tags on all forms next to the form elements. \r\n\r\n.formSubtext \r\nThe tags below some form elements.\r\n\r\n.highlight \r\nDenotes a highlighted item, such as which message you are viewing within a list.\r\n\r\n.homeLink\r\nUsed by the my home (^H;) macro.\r\n\r\n.horizontalMenu \r\nThe horizontal menu (if you use a horizontal menu macro).\r\n\r\n.loginBox\r\nThe login box (^L;) macro.\r\n\r\n.makePrintableLink\r\nUsed by the make printable (^r;) macro.\r\n\r\n.myAccountLink\r\nUsed by the my account (^a;) macro.\r\n\r\n.pagination \r\nThe Previous and Next links on pages with pagination.\r\n\r\n.searchBox\r\nUsed by the search (^?;) macro.\r\n\r\n.selectedMenuItem\r\nUsed by the FlexMenu (^FlexMenu;) macro.\r\n\r\n.tableData \r\nThe data rows on things like message boards and user contributions.\r\n\r\n.tableHeader \r\nThe headings of columns on things like message boards and user contributions.\r\n\r\n.tableMenu \r\nThe menu on things like message boards and user submissions.\r\n\r\n.verticalMenu \r\nThe vertical menu (if you use a verticall menu macro).\r\n\r\nNote: Some widgets have their own unique styles.\r\n\r\n','0'); +INSERT INTO help VALUES (19,'WebGUI','English','Using','Macros','WebGUI macros are used to create dynamic content within otherwise static content. For instance, you may wish to show which user is logged in on every page, or you may wish to have a dynamically built menu or crumb trail. \r\n\r\nMacros always begin with a carat (^) and follow with at least one other character and ended with w semicolon (;). Some macros can be extended/configured by taking the format of ^x(\"config text\");. The following is a description of all the macros in the WebGUI system.\r\n\r\n^a; or ^a(\"new link title\"); - My Account Link\r\nA link to your account information. In addition you can change the link text by creating a macro like this ^a(\"Account Info\");.\r\n\r\n^C; - Crumb Trail\r\nA dynamically generated crumb trail to the current page.\r\n\r\n^c; - Company Name\r\nThe name of your company specified in the settings by your Administrator.\r\n\r\n^D; or ^D(\"%c %D, %y\"); - Date\r\nThe current date and time.\r\n\r\nYou can configure the date by using date formatting symbols. For instance, if you created a macro like this ^D(\"%c %D, %y\"); it would output September 26, 2001. The following are the available date formatting symbols:\r\n\r\n %% = %\r\n %y = 4 digit year\r\n %Y = 2 digit year\r\n %m = 2 digit month\r\n %M = variable digit month\r\n %c = month name\r\n %d = 2 digit day of month\r\n %D = variable digit day of month\r\n %w = day of week name\r\n %h = 2 digit base 12 hour\r\n %H = variable digit base 12 hour\r\n %j = 2 digit base 24 hour\r\n %J = variable digit base 24 hour\r\n %p = lower case am/pm\r\n %P = upper case AM/PM\r\n\r\n^e; - Company Email Address\r\nThe email address for your company specified in the settings by your Administrator.\r\n\r\n^FlexMenu;\r\nThis menu macro creates a top-level menu that expands as the user selects each menu item.\r\n\r\n^H; or ^H(\"Go Home\"); - Home Link\r\nA link to the home page of this site. In addition you can change the link text by creating a macro like this ^H(\"Go Home\");.\r\n\r\n^L; - Login\r\nA small login form.\r\n\r\n^M; or ^M(3); - Current Menu (Vertical)\r\nA vertical menu containing the sub-pages at the current level. In addition, you may configure this macro by specifying how many levels deep the menu should go. By default it will show only the first level. To go three levels deep create a macro like this ^M(3);. If you set the macro to \"0\" it will track the entire site tree.\r\n\r\n^m; - Current Menu (Horizontal)\r\nA horizontal menu containing the sub-pages at the current level.\r\n\r\n^P; or ^P(3); - Previous Menu (Vertical)\r\nA vertical menu containing the sub-pages at the previous level. In addition, you may configure this macro by specifying how many levels deep the menu should go. By default it will show only the first level. To go three levels deep create a macro like this ^P(3);. If you set the macro to \"0\" it will track the entire site tree.\r\n\r\n^p; - Previous Menu (Horizontal)\r\nA horizontal menu containing the sub-pages at the previous level.\r\n\r\n^r; or ^r(\"Print Me!\"); - Make Page Printable\r\nCreates a link to remove the style from a page to make it printable. In addition, you can change the link text by creating a macro like this ^r(\"Print Me!\");.\r\n\r\n^S(\"home\",0); - Specific SubMenu (Vertical)\r\nThis macro allows you to get the submenu of any page, starting with the page you specified. For instance, you could get the home page submenu by creating a macro that looks like this ^S(\"home\",0);. The first value is the urlized title of the page and the second value is the depth you\'d like the menu to go. By default it will show only the first level. To go three levels deep create a macro like this ^S(\"home\",3);.\r\n\r\n^s(\"home\"); - Specific SubMenu (Horizontal)\r\nThis macro allows you to get the submenu of any page, starting with the page you specified. For instance, you could get the home page submenu by creating a macro that looks like this ^s(\"home\");. The value is the urlized title of the page.\r\n\r\n^T; or ^T(3); - Top Level Menu (Vertical)\r\nA vertical menu containing the main pages of the site (aka the sub-pages from the home page). In addition, you may configure this macro by specifying how many levels deep the menu should go. By default it will show only the first level. To go three levels deep create a macro like this ^T(3);. If you set the macro to \"0\" it will track the entire site tree.\r\n\r\n^t; - Top Level Menu (Horizontal)\r\nA vertical menu containing the main pages of the site (aka the sub-pages from the home page).\r\n\r\n^u; - Company URL\r\nThe URL for your company specified in the settings by your Administrator.\r\n\r\n^/; - System URL\r\nThe URL to the gateway script (including the domain for this site). This is often used within pages so that if your development server is on a domain different than your production server that your URLs will still worked when moved.\r\n\r\n^\\; - Page URL\r\nThe URL to the current page (including the domain for this site). This is often used within pages so that if your development server is on a domain different than your production server that your URLs will still worked when moved.\r\n\r\n^@; - Username\r\nThe username of the currently logged in user.\r\n\r\n^?; - Search\r\nAdd a search box.\r\n\r\n^#; - User ID\r\nThe user id of the currently logged in user.\r\n\r\n^*; or ^*(100); - Random Number\r\nA randomly generated number. This is often used on images (such as banner ads) that you want to ensure do not cache. In addition, you may configure this macro like this ^*(100); to create a random number between 0 and 100.\r\n\r\n^0;,^1;,^2;,^3;,^4;,^5;,^6;,^7;,^8;,^9;, ^-;\r\nThese macros are reserved for widget-specific functions as in the SQL Report widget.\r\n','0'); INSERT INTO help VALUES (1,'SQLReport','English','Add/Edit','SQL Report','SQL Reports are perhaps the most powerful widget in the WebGUI arsenal. They allow a user to query data from any database that they have access to. This is great for getting sales figures from your Accounting database or even summarizing all the message boards on your web site.\r\n\r\nTitle\r\nThe title of this report.\r\n\r\nDisplay the title?\r\nDo you wish to disply the title?\r\n\r\nProcess macros?\r\nDo you wish to process WebGUI macros? Unchecking this box will not process macros and will speed up page execution.\r\n\r\nPosition\r\nSelect the position in the current page template where this widget should be placed.\r\n\r\nDescription\r\nDescribe the content of this report so your users will better understand what the report is all about.\r\n\r\nTemplate\r\nLayout a template of how this report should look. Usually you\'ll use HTML tables to generate a report. An example is included below.\r\n\r\nThere are 11 special macro characters used in generating SQL Reports. They are ^-;, ^0;, ^1;, ^2;, ^3;, ^4;, ^5;, ^6;, ^7;, ^8;, and ^9;. These macros will be processed regardless of whether you checked the process macros box above. The ^- macro represents split points in the document where the report will begin and end looping. The numeric macros represent the data fields that will be returned from your query. Note that you may only have 10 fields returned per row in your query.\r\n\r\nSample Template:\r\n<table>\r\n<tr><th>Employee Name</th><th>Employee #</th><th>Vacation Days Remaining</th><th>Monthly Salary</th></tr>\r\n^-;\r\n<tr><td>^0;</td><td>^1;</td><td>^2;</td><td>^3;</td></tr>\r\n^-;\r\n</table>\r\n\r\nQuery\r\nThis is a standard SQL query. If you are unfamiliar with SQL, Plain Black Software provides training courses in SQL and database management.\r\n\r\nDSN\r\nData Source Name is the unique identifier that Perl uses to describe the location of your database. It takes the format of DBI:[driver]:[database name]:[host]. \r\n\r\nExample: DBI:mysql:WebGUI:localhost\r\n\r\nDatabase User\r\nThe username you use to connect to the DSN.\r\n\r\nDatabase Password\r\nThe password you use to connect to the DSN.\r\n\r\nConvert carriage returns?\r\nDo you wish to convert the carriage returns in the resultant data to HTML breaks (<br>).\r\n','1,2,3,4,5'); INSERT INTO help VALUES (21,'WebGUI','English','Using','Widget','Widgets are the true power of WebGUI. Widgets are tiny pluggable applications built to run under WebGUI. Message boards and polls are examples of widgets.\r\n\r\nTo add a widget to a page, first go to that page, then select Add Content... from the upper left corner of your screen. Each widget has it\'s own help so be sure to read the help if you\'re not sure how to use a widget.\r\n','0'); INSERT INTO help VALUES (1,'Article','English','Add/Edit','Article','Articles are the Swiss Army knife of WebGUI. Most pieces of static content can be added via the Article widget.\r\n\r\nTitle\r\nWhat\'s the title for this content? Even if you don\'t wish the title to appear, it\'s a good idea to title your content so that if it is ever copied to the clipboard it will have a name.\r\n\r\nDisplay the title?\r\nDo you wish to display the title listed above?\r\n\r\nProcess macros?\r\nDo you wish to process WebGUI macros on this article? Unchecking this box will not process macros and will speed up page execution.\r\n\r\nPosition\r\nSelect the position in the current page template where this widget should be placed.\r\n\r\nStart Date\r\nWhat date do you want this article to appear on the site? Dates are in the format of MM/DD/YYYY. You can use the JavaScript wizard to choose your date from a calendar by clicking on the set date button. By default the date is set to 01/01/2000.\r\n\r\nEnd Date\r\nWhat date do you want this article to be removed from the site? By default the date is set to 100 years in the future, 01/01/2100.\r\n\r\nBody\r\nThe body of the article is where all the content goes. You may feel free to add HTML tags as necessary to format your content. Be sure to put a <p> between paragraphs to add white space to your content.\r\n\r\nImage\r\nChoose an image (.jpg, .gif, .png) file from your hard drive. This file will be uploaded to the server and displayed in the upper-right corner of your article.\r\n\r\nLink Title\r\nIf you wish to add a link to your article, enter the title of the link in this field. \r\n\r\nExample: Google\r\n\r\nLink URL\r\nIf you added a link title, now add the URL (uniform resource locator) here. \r\n\r\nExample: http://www.google.com\r\n\r\nAttachment\r\nIf you wish to attach a word processor file, a zip file, or any other file for download by your users, then choose it from your hard drive.\r\n\r\nConvert carriage returns?\r\nIf you\'re publishin HTML there\'s generally no need to check this option, but if you aren\'t using HTML and you want a carriage return every place you hit your \"Enter\" key, then check this option.\r\n','1,2,3,4,5'); @@ -441,7 +457,7 @@ INSERT INTO help VALUES (27,'WebGUI','English','Add/Edit','Widget','You can add INSERT INTO help VALUES (1,'Poll','English','Add/Edit','Poll','Polls can be used to get the impressions of your users on various topics.\r\n\r\nTitle\r\nThe title of the poll. Even if you don\'t wish to display the title you should fill out this field so this poll will have a name if it is ever placed in the clipboard.\r\n\r\nDisplay the title?\r\nDo you wish to disply the title?\r\n\r\nProcess macros?\r\nDo you wish to process WebGUI macros? Unchecking this box will not process macros and will speed up page execution.\r\n\r\nPosition\r\nSelect the position in the current page template where this widget should be placed.\r\n\r\nDescription\r\nYou may provide a description for this poll, or give the user some background information.\r\n\r\nActive\r\nIf this box is checked, then users will be able to vote. Otherwise they\'ll only be able to see the results of the poll.\r\n\r\nWho can vote?\r\nChoose a group that can vote on this poll.\r\n\r\nGraph Width\r\nThe width of the poll results graph. The width is measured in pixels.\r\n\r\nQuestion\r\nWhat is the question you\'d like to ask your users?\r\n\r\nAnswers\r\nEnter the possible answers to your question. Enter only one answer per line. Polls are only capable of 20 possible answers.\r\n\r\nReset votes.\r\nReset the votes on this poll.\r\n\r\n
| ^C | ^D |
| \r\nvertical top level menu: ^T \r\n \r\nvertical current level menu: ^M \r\n\r\n\r\n | \r\n\r\n',' | \r\n^@ \r\n^# \r\n^* \r\n^? \r\n |