Cy Think Survey

Programmer's Guide to CMS Internals #1  

To lookup the internal code for an Action Menu function, see JshGUI.pm. You can search JshGUI.pm for the text on the face of the Action Menu button. The CMS script name and function appear in the call with the button text. For example, the "Re-publish HTML" button links to the select_pages function in genpage.pl.

Careful examination of the select_pages function reveals that the "Publish HTML" button on the page selection form links to the update_HTML function in genpage.pl, a.k.a. "$this_page". ***>>

***>> The update_HTML function filters the buildable pages to those selected by the user and calls

• body_file2array in JshBODY.pm - puts the list of buildable pages in an array
• body_build_group in JshBODY.pm ***>>

***>> The body_build_group function calls

• build_site_array in JshBODY.pm - build the array of environment variables
• gui_debug_array in JshGUI.pm - build debug info for display
• build_HTML_page in JshBODY.pm ***>>

***>> The build_HTML_page function calls

• set_control_parms in JshBODY.pm - such as menu_number, subhead, subpages and desc
• body_get_content in JshBODY.pm ***>>
• html_body in JshBODY.pm - get the body from the array and return a string
• body_build_htm_file in JshBODY.pm - writes the buffer to the htm file
• file_file2str in JshFILE.pm - get content from a file

***>> The body_get_content function calls

• first_body_array in JshBODY.pm - creates an array to hold the content, table tags, etc. ***>>
• file_file2str in JshFILE.pm - get content from a file and put it in a string
• parm_get_parms in JshPARMS.pm - get parms from the content string
• get_body_content in JshBODY.pm - gets contents from a file stripped on all control parameters.
• set_p_class in JshBODY.pm - modify paragraph tags entered by the user
• start_c_td in JshBODY.pm - create a table detail tag as specified
• number_of_subpages in JshBODY.pm - get the number and type of sub-pages
• new_body_array in JshBODY.pm - create the framework of a table
• collapse_content_array in JshBODY.pm - converts content container from an array to a string.

***>> The first_body_array function calls

• body_get_banner in JshBODY.pm - returns a banner, as specified
• gui_jshheader in JshGUI.pm - returns the header, as specified
• build_the_menu in JshBODY.pm - returns the menu, minus the current page
• ring_ringheader in JshRINGS.pm - returns the ring control
• left_content_section in JshBODY.pm - returns the content, as specified
• center_content_section ***>>
• gui_jshfooter in JshGUI.pm - returns the footer, as specified
• gui_debug_array in JshGUI.pm - returns the debug area, as specified

***>> The center_content_section function calls

• gui_subheader in JshGUI.pm - returns the sub-head, as specified
• ppf_filename in JshBODY.pm - inserts "_ppf" in the filename
• gui_ppf_subheader in JshGUI.pm -
• body_add_body_parts ***>>
• start_c_td in JshBODY.pm - returns a <td> tag, as specified
• sub_filename in JshBODY.pm - builds the subpage filename, e.g. page_1_1.txt

***>> The body_add_body_parts function calls

• file_file2array in JshFILES.pm - reads bodypart.txt
• file_file2str in JshFILES.pm - process type 0
• datafile_of_links in JshBODY.pm - process type 1
• convert_text_to_html in JshBODY.pm - process type 2
• database_to_file in JshBODY.pm - process type 3

This procedure is abbreviated and high level. It is documented to prompt the programmer as to the needed steps and is not intended to be a detailed step-by-step procedures.