Object Info:

pageList

Introduction

pageList is a macro that builds an unordered list links to web pages that lie at a particular level of your site. It can be very useful for showing links to other pages on default or index pages. In its simplest form, pageList returns a list of links to pages on the same level as the current page.

Example 1
pageList():

• renderFat
• datedLink
• Border
• structuredNP
• siteContents
• navBar
• pageList
• pageTable

You can use pageList to show the creation date or modification date of the pages next to the links.

Example 2 (creation dates)
pageList(useDate:"CD"):

• renderFat (3/27/97)
• datedLink (3/27/97)
• Border (3/27/97)
• structuredNP (3/27/97)
• siteContents (9/3/97)
• navBar (8/27/97)
• pageList (3/27/97)
• pageTable (3/27/97)

Example 3 (modification dates)
pageList(useDate:"MD"):

• renderFat (9/2/97)
• datedLink (12/11/97)
• Border (9/2/97)
• structuredNP (12/10/97)
• siteContents (12/10/97)
• navBar (12/11/97)
• pageList (12/11/97)
• pageTable (12/11/97)

You can also use pagelist to generate links to there parts of you site as well.

Example 4
pageList(@user.websites.esd.download.addresslist):

• webExtras v 1.5
• addressList
• listCommands
• POPtoCS
• webTools for Frontier
• webScheduler
• formObjects
• autoSave

This version of pageList supercedes previous versions of pageList and pageListCD released here.

Details

pageList v1.5b3. See script comments for version history.

The pageList macro uses three parameters to build an unordered list of links. The syntax is:

pageList(objectAddress,useDate, glossTitles)

objectAddress is the address of the page that you wish to build the list around. objectAddress can point to other parts of your site (see Example 4 above). It defaults to the address of the current page being rendered.

useDate is a string value, that controls whether a date is shown next to a link. A string values of "CD" will cause the macro to place the page's creation date after the link. A string value of "MD" will cause the macro to place the page's modification date after the link. All other string values will cause no date to be appended to the link. The default value is "".

glossTitles is a boolean that controls whether the navigation bar is build from glossary entries as titles or as object names. Since the nextPrevs outline lists object names, you need to resolve these to page titles to work with glossary entries generated by the stock Frontier pageFilter. useTitles allows for this resolution. The default is true.

The pageList macro builds a list of links to other siblings based on a structured nextPrevs outline. The order which the siblings appear in the nextPrevs outline determines the order that links are shown. Your links do not have to be in alphabetic order.

The pageList macro also supports the #exclude directive. Pages that contain a directive #exclude npAdr (where npAdr is the ODB address of the nextPrevs oultine) will not be included in the page list.

You may take a nextPrevs outline generated by Frontier's "Build nextPrev List..." and add structure to it, or you may use the webExtras v 1.5 suite's "Build Structured NP..." command (which will do most of the work for you). You can also use the structuredNP script, to generate a structured outline of your site. The outline structure does not have to mimic the site structure (though it is a little hard to imagine a why you would build an outline structure that wasn't at least a little similar to the site structure).