Appendix: iScripts Used to Assemble and Present Web Magazines

This appendix provides an overview of Web Magazine iScripts and discusses the iScripts within the Web Magazine hierarchy of:

• Publication

• Section

• Category

• Article

• Image

Understanding Web Magazine iScripts

Before you design a publication, you must understand how the portal assembles the Web Magazine for presentation in the portal. PeopleSoft Enterprise Portal delivers a set of page layouts in the form of HTML objects, including built-in functions that use those HTML objects. Configuring or creating new HTML objects requires that you revise the built-in functions.

In the sections that follow, these typographical conventions distinguish the various elements of the PeopleCode:

Publication

This section discusses:

• IScript_BuildPubHeader

• IScript_BuildPubNavBar

• IScript_BuildPubFooter

• IScript_WebPublishing

IScript_BuildPubHeader

Syntax

IScript_BuildPubHeader()

Description

IScript_BuildPubHeader displays the web magazine header for a publication. It uses the publication ID and the issue ID that are passed through the query string. This function then retrieves the current issue name using these parameters and displays it in the header. It's displayed by passing the issue name as a bind variable to the HTML Header Template. Different publications must change the code to call their specific HTML templates for the header.

The declaration is:

Declare Function ​IScript_BuildPubHeader PeopleCode WEBLIB_WEBPUB.EO_PE_PUB Fiel
dFormula;

Parameters

Function Call Parameters: None.

This table lists the Query String Parameters:

This table lists Other Parameters:

Returns

Returns the HTML markup for the entire publication or issue header.

Example

&HTMLHeader = IScript_BuildPubHeader();

IScript_BuildPubNavBar

Syntax

IScript_BuildPubNavBar()

Description

IScript_BuildPubNavBar displays the Web magazine navigation bar for a publication. This function retrieves the HTML template for the navigation bar for the publication. The inputs are publication, issue name, and full URL from the %Request parameter. Different publications must change the code to call their specific HTML templates for the navigation bar.

The declaration is:

Declare Function ​IScript_BuildPubNavBar PeopleCode WEBLIB_WEBPUB.EO_PE_PUB Fiel
dFormula;

Parameters

Function Call Parameters: None.

This table lists the Query String Parameters:

This table lists Other Parameter:

Returns

Returns the HTML markup for the entire publication navigation bar.

Example

&HTMLNav1 = IScript_BuildPubNavBar();

IScript_BuildPubFooter

Syntax

IScript_BuildPubFooter()

Description

IScript_BuildPubFooter displays the Web magazine footer for publication. It retrieves the HTML template of the footer for that publication. This is a static HTML template that does not have any bind variables. For different publications, the code must be changed to call the specific HTML template for the footer.

The declaration is:

Declare Function ​IScript_BuildPubFooter PeopleCode WEBLIB_WEBPUB.EO_PE_PUB Fiel
dFormula;

Parameters

Function Call Parameters: None.

Query String Parameters: None.

This table lists the Other Parameters:

Returns

Returns the HTML markup for the entire publication footer.

Example

&HTMLFooter = IScript_BuildPubFooter();

IScript_WebPublishing

Syntax

GenerateScriptPortalURL(%Portal, %Node
, 
Record.WEBLIB_WEBPUB, Field.EO_PE_TEMPLATES, "FieldFormula", "IScript_WebPublishing");

GenerateScriptPortalURL can be used with this function as part of the syntax, but generally the syntax for this iScript is the following:

IScript_WebPublishing()

Description

IScript_WebPublishing assembles the Web magazine for a publication issue. It uses the publication built-in functions iScripts described previously to produce each value that is required by the cover page template. It is assembled by passing all required parameters as bind variables to the HTML Front Page template.

Customized cover page layouts require changes to the code. For example, if the HTML template has six bind variables; IScript_WebPublishing must pass six values, including HTML markup returned by other publication built-in functions, to match. Using examples from previous sections, we have:

&HTMLText = GenerateHTMLText(HTML.EO_PE_FRONTPAGETEMPLATE, &HTMLHeader, &HTMLNav1,
 &CompanyNews, &Indu
stryFocus, &HMLFooter, &ArticleURL, &SectionURL,
IScript_GetImage("PWSH507PO8C"), IScript_GetImage("PWSEP6SXO8C")
IScript_GetImage("PWSPS3TQO8C"), IScript_GetImage("PWS4MT7QO8C"),
IScript_GetImage("PWSTRUTPO8C"), IScript_GetImage("PWSPB7CPO8C"),
IScript_GetImage("PWSYBONQO8C"), IScript_GetImage("PWS5JA6S59C"),
IScript_GetImage("PWS24J8F44C"));

where:

• EO_PE_FRONTPAGETEMPLATE is the cover page layout.

• &HTMLHeader, &HTMLNav1, and &HTMLFooter contain the HTML markup for the header, navigation, and footer portions of the layout.

• &CompanyNews contains the HTML markup for articles for the news section.

• &IndustryFocus contains the HTML markup for articles for the industry section.

• &articleURL is the portal content URL for article template pages.

• &sectionURL is the portal content URL for section template pages.

• IScript_GetImage() calls are used to build HTML IMG tags for graphics on the page.

Returns

Returns the HTML markup for the entire publication issue.

Example

<a href=http://host:port/psp/ps/EMPLOYEE/PSFT_PA/s/WEBLIB_WEBPUB.EO_PE_
TEMPLATES.FieldFormula.IScript_
WebPublishing?PUB=PEOPLETALK&ISSUE=JUNAUG2000>PeopleTalk</a>

Section

All articles for an issue are retrieved. All sections where the articles belong are sorted.

This section discusses:

• IScript_BuildSectionNavBar

• IScript_GetSectionArticles

• IScript_GetSectionImg

• IScript_SectionArticleTemplate

IScript_BuildSectionNavBar

Syntax

IScript_BuildSectionNavBar()

Description

IScript_BuildSectionNavBar builds the section navigation bar for a publication issue. The navigation bar displays all of the sections for a publication issue. It is created with the images that are defined in the section navigation (on and off) images of the application.

If the current section is referenced, the Section Navigation Bar On image is used. If the section referenced is not the current section, the Section Navigation Bar Off image is used.

The declaration is:

Declare Function ​IScript_BuildSectionNavBar PeopleCode WEBLIB_WEBPUB.EO_E_SECT
ION FieldFormula;

Parameters

Function Call Parameters: None.

This table lists Query String Parameters:

Returns

Returns the HML markup for the entire section navigation bar.

Example

&HTMLNav2 = IScript_BuildSectionNavBar();

IScript_GetSectionArticles

Syntax

IScript_GetSectionArticles(&NumberOfColumns, &Fontsize, &Se
ctionOn, &CategoriesOn, &ArticlesSummaryOn, &More, &Section)

Description

IScript_GetSectionArticles displays all articles for a section of a publication issue. All articles are displayed; they use the parameters that are listed in the following table. The output of the articles can be changed.

Features include the number of columns in which the articles are displayed in, font size, section titles (on or off), category titles (on or off), article summaries (on or off), more articles link (on or off), and a section ID override.

The declaration is:

Declare Function ​IScript_GetSectionArticles ​PeopleCode WEBLIB_WEBPUB.EO_PE_SEC
TION FieldFormula;

Parameters

This table lists the Function Call Parameters:

This table lists the Query Sting Parameters:

Returns

Returns the HTML markup for all articles in a section for a publication or an issue.

Example

rem Get the Articles for the news section;
rem Parameters Values for the Function Call;
rem Number of Columns - 1;
rem Font Size - 2;
rem Section Title On - 0 (False);
rem Category Title On - 0 (False);
rem Article Summary On - 1 (True);
rem More... link - 0 (False);
rem Section Name - "" (current section);
&HTMLText = IScript_GetSectionArticles(1, 2, 0, 0, 1, 0, " ");

IScript_GetSectionImg

Syntax

IScript_GetSectionImg()

Description

IScript_GetSectionImg retrieves the section image for a section of a publication. It accepts inputs from the query string for the publication ID and the section ID. IScript_GetSectionImg first retrieves the section image ID. Using this ID, it calls the IScript_GetImage function to retrieve the image information.

The declaration is:

Declare Function ​IScript_GetSectionImg PeopleCode WEBLIB_WEBPUB.EO_PE_SECTION F
ieldFormula;

Parameters

Function Call Parameters: None.

This table lists the Query String Parameters:

Returns

Returns the HTML image tag for the section image.

Example

&HTMLSectionImg = IScript_GetSectionImg();

IScript_SectionArticleTemplate

Syntax

GetScriptContentURL(%Portal, %Node, Record.WEBLIB_WEBPUB, Field.EO_PE_TEMPLATES, "FieldFormula", "IScript_SectionArticleTemplate");

GenerateScriptPortalURL can be used with this function as part of the syntax, but generally the syntax for this iScript is the following:

IScript_SectionArticleTemplate

Description

IScript_SectionArticleTemplate assembles the section page for a publication issue. It uses the section built-in functions iScripts described previously to come up with each value that is required by the section page template. Passing all required parameters as bind variables, to the HTML Section Page template, assembles it.

Changes to the code are required when customizing section page layouts. For example, if the HTML template has six bind variables, IScript_SectionArticleTemplate must pass six values, including HTML markup returned by other section built-in functions, to match. Using examples from previous sections, we have:

&HTMLText = GetHTMLText(HTML.EO_PE_SECTIONTEMPLATE, &HTMLHeader, &HTMLNav1,
 IScript_GetImageFileSpec("
PWSA19OE85C"), &HTMLNav2, &HTMLSectionImg, &HTMLBody, &HTMLFooter);

where:

• EO_PE_SECTIONTEMPLATE is the section page layout.

• &HTMLHeader, &HTMLNav1, &HTMLNav2, and &HTMLFooter contain the HTML markup for the header, publication navigation, section navigation, and footer portions of the layout.

• &HTMLSectionImg contains the HTML markup for the section image; &HTMLBody contains the HTML markup for all articles for the current section.

• IScript_GetImageFileSpec() calls are used to retrieve the image file path and file name from the database.

  Note. If you have a different page layout for every section in a publication, you must edit IScript_SectionArticleTemplate to use the appropriate HTML object (section layout), depending on the publication section.

Parameters

None.

Returns

Returns the HTML markup for a section in a publication issue.

Example

<a href="http://jwegrzyn070500/psc/ps/EMPLOYEE/PSFT_PA/s/WEBLIB_WEBPUB.EO_PE_
TEMPLATES.FieldFormula.IScript_SectionArticleTemplate?PUB=PEOPLETALK&ISSUE=
JUNAUG2000&SECTION=NEWS">News</a>

Category

This section discusses:

• IScript_GetCategoryLongName

• IScript_GetCategoryImg

IScript_GetCategoryLongName

Syntax

IScript_GetCategoryLongName()

Description

IScript_GetCategoryLongName retrieves the category long name for a category in a section of a publication. It accepts inputs from the query string for the publication ID, section ID, and category ID.

The declaration is:

Declare Function ​IScript_GetCategoryLongName PeopleCode WEBLIB_WEBPUB.EO_PE_
CATEGORY FieldFormula;

Parameters

Function Call Parameters: None.

This table lists the Query String Parameters:

Returns

Returns the category long name.

IScript_GetCategoryImg

Syntax

IScript_GetCategoryImg()

Description

IScript_GetCategoryImg retrieves the category image for a category in a section of a publication. It accepts inputs from the query string for the publication ID, section ID, and category ID. IScript_GetCategoryImg first retrieves the category image ID. Using this ID, it calls the IScript_GetImage function to retrieve the image information.

The declaration is:

Declare Function ​IScript_GetCategoryImg PeopleCode WEBLIB_WEBPUB.EO_PE_CATEGORY
 FieldFormula;

Parameters

Function Call Parameters: None.

This table lists the Query String Parameters:

Returns

Returns the HTML image tag for the category image.

Article

This section discusses:

• IScript_GetArticleTitle

• IScript_GetArticleTitleImage

• IScript_GetArticleSubTitle

• IScript_GetArticleBody

• IScript_GetArticleImage

• IScript_GetArticleAuthor

• IScript_ArticleTemplate

IScript_GetArticleTitle

Syntax

IScript_GetArticleTitle()

Description

IScript_GetArticleTitle retrieves the article title for an article in an issue of a publication. It accepts inputs from the query string for the publication ID, issue ID, and article ID.

The declaration is:

Declare Function IScript_GetArticleTitle PeopleCode 
WEBLIB_WEBPUB.EO_PE_ARTICLE FieldFormula;

Parameters

Function Call Parameters: None.

This table lists the Query String Parameters:

Returns

Returns the article title.

IScript_GetArticleTitleImage

Syntax

IScript_GetArticleTitleImage()

Description

IScriptGetArticleTitleImage retrieves the article title image for an article in an issue of a publication. It retrieves inputs from the query string for the publication ID, issue ID, and article ID. IScript_GetArticleTitleImage first retrieves the article title image ID. Using this ID, it calls the IScript_GetImage function to retrieve the image information.

The declaration is:

Declare Function ​IScript_GetArticleTitleImage PeopleCode WEBLIB_WEBPUB.EO_PE_
ARTICLE FieldFormula;

Parameters

Function Call Parameters: None.

This table lists the Query String Parameters:

Returns

Returns the HTML image tag for the article title image.

IScript_GetArticleSubTitle

Syntax

IScript_GetArticleSubTitle()

Description

IScript_GetArticleSubTitle retrieves the article subtitle for an article in an issue of a publication. It accepts inputs from the query string for the publication ID, issue ID, and article ID.

The declaration is:

Declare Function ​IScript_GetArticleSubTitle PeopleCode WEBLIB_WEBPUB.EO_PE_ART
ICLE FieldFormula;

Parameters

Function Call Parameters: None.

This table lists the Query String Parameters:

Returns

Returns the article subtitle.

IScript_GetArticleBody

Syntax

IScript_GetArticleBody()

Description

IScript_GetArticleBody retrieves the article body text for an article in an issue of a publication. It accepts inputs from the query string for the publication ID, issue ID, and article ID.

The declaration is:

Declare Function ​IScript_GetArticleBody PeopleCode WEBLIB_WEBPUB.EO_PE_ARTICLE
 FieldFormula;

Parameters

Function Call Parameters: None.

This table lists the Query String Parameters:

Returns

Returns the article body text.

IScript_GetArticleImage

Syntax

IScript_GetArticleImage()

Description

IScript_GetArticleImage retrieves the article image for an article in an issue of a publication. It accepts inputs from the query string for the publication ID, issue ID, and article ID. IScript_GetArticleImage retrieves the article image ID. Using this ID, it calls the IScript_GetImage function to retrieve the image information.

The declaration is:

Declare Function ​IScript_GetArticleImage PeopleCode WEBLIB_WEBPUB.EO_PE_ARTICLE
 FieldFormula;

Parameters

Function Call Parameters: None.

This table lists the Query String Parameters:

Returns

Returns the HTML image tag for the article image.

IScript_GetArticleAuthor

Syntax

IScript_GetArticleAuthor()

Description

IScript_GetArticleAuthor retrieves the article author for an article in an issue of a publication. It accepts inputs from the query string for the publication ID, issue ID, and article ID.

The declaration is:

Declare Function ​IScript_GetArticleAuthor PeopleCode WEBLIB_WEBPUB.EO_PE_ARTILE
 FieldFormula;

Parameters

Function Call Parameters: None.

This table lists the Query String Parameters:

Returns

Returns the article author.

IScript_ArticleTemplate

Syntax

GetScriptContentURL(%Portal, %Node, Record.WEBLIB_WEBPUB, Field.EO_PE_TEMPLATES,
 "FieldFormula", "IScript_ArticleTemplate");

Same comments as above.

Description

IScript_Article_Template assembles the article page for a section of a publication issue. It uses the article built-in functions described previously to produce each value that is required by the article page template. Passing all required parameters as bind variables to the HTML Article Page template assembles it.

Customized article page layouts require changes to the code. For example, if the HTML template has eight bind variables, IScript_GetArticleTemplate must pass eight values, including HTML markup returned by other page built-in functions, to match. Using examples from previous sections, we have:

&HTMLText = GetHTMLText(HTML.EO_PE_ARTICLETEMPLATE, &HTMLHeader, &HTMLNav1,
 IScript_GetImageFileSpec("
PWSA19OE85C"), &HTMLNav2, &HTMLCategoryImage, &HTMLTitle, &HTMLNav3, &HTMLBody,
 &HTMLFooter);

where:

• EO_PE_ARTICLETEMPLATE is the article page layout.

• &HTMLHeader, &HTMLNav1, &HTMLNav2, and HTMLFooter contain the HTML markup for the header, publication navigation, section navigation, and footer portions of the layout.

• &HTMLNav3 is the side navigation bar that lists articles for the current section.

• &HTMLCategoryImage contains the HTML markup for the category image.

• &HTMLTitle is the article title image.

• &HTMLBody contains the HTML markup of the article image, text, and author.

• IScript_GetImageFileSpec() calls are used to retrieve the image file path and file name from the database.

Returns

Returns the HTML markup for an article in a section of a publication issue.

Example

<a href="http://jwegrzyn070500/psc/ps/EMPLOYEE/PSFT_PA/s/WEBLIB_WEBPUB.EO_PE_
TEMPLATES.FieldFormula.IScript_ArticleTemplate?PUB=PEOPLETALK&ISSUE=
JUNAUG2000&SECTION=INDUSTRY&CATEGORY=COMMUNICATE&ARTICLE=COSPRINGS">Article
 Title</a>

Image

This section discusses:

• IScript_GetImage

• IScript_GetImageFileSpec

IScript_GetImage

Syntax

IScript_GetImage(&ImageID)

Description

IScript_GetImage retrieves the image tag for an image ID. The image ID is retrieved, and all of the parameters surrounding the image are placed in the image tag.

The declaration is:

Declare Function ​IScript_GetImage PeopleCode WEBLIB_WEBPUB.EO_PE_IMAGE Field
Formula;

Parameters

Function Call Parameters:

Query String Parameters: None.

Returns

Returns the HTML image tag.

IScript_GetImageFileSpec

Syntax

IScript_GetImageFileSpec(ImageID)

Description

IScript_GetImageFileSpec retrieves the file path and file name for an image ID. The image ID is retrieved, and the path and file name are concatenated.

The declaration is:

Declare Function ​IScript_GetImageFileSpec PeopleCode WEBLIB_WEBPUB.EO_PE_IMAGE
 FieldFormula;

Parameters

This table lists the Function Call Parameters:

Query String Parameters: None.

Returns

Returns the concatenated file path and file name.