Perlshop 4 - PSTAG Documentation
Overview
The Perlshop <pstag> has existed since the original versions of Perlshop 3.
Perlshop 4 has added new optional attributes to this tag, and has extended the capabilities of the original attributes.
Tag Placement
Due to limitations in the Perlshop 3/4 catalog page file parser, the following limitations exist for the <pstag> text:
- The <pstag> must be the very first line of the catalog page file.
- There is no limit to the length of the text used by this tag, but the tag itself must all be on one line.
Example Use
The <pstag> may be expressed as either an html tag, or as an html comment. The pstag and attribute names may be either upper or lower case. Attribute values are case sensitive.
Example of use as an html tag:
<pstag prev="prevpage.html" next="nextpage.html" header="on" footer="on">
Example of use as an html comment:
<!--pstag prev="prevpage.html" next="nextpage.html" header="on" footer="on" -->
The prev attribute
The prev attribute of the pstag is used to generate the Prev Page link at the top of a catalog page, and the Prev Page button at the bottom of a catalog page. The following rules apply:
- If this attribute is not used, no link or button will be produced.
- If the file named by this attribute is the same as the name of the catalog page file containing the pstag, no link
or button will be produced.
The next attribute
The next attribute of the pstag is used to generate the Next Page link at the top of a catalog page, and the Next Page button at the bottom of a catalog page. The following rules apply:
- If this attribute is not used, no link or button will be produced.
- If the file named by this attribute is the same as the name of the catalog page file containing the pstag, no link
or button will be produced.
The header attribute
The header attribute works in combination with the $generate_page_header setting from the ps.cfg file. The ps.cfg file setting assigns the default operation for all catalog pages. The header attribute allows the default value to be
overridden for a given page. The rules are:
- If the pstag header attribute is set to "on", the page header will be generated, regardless of the ps.cfg setting.
- If the pstag header attribute is set to "off", the page header will not be generated, regardless of the ps.cfg setting.
The footer attribute
The footer attribute works in combination with the $generate_page_footer setting from the ps.cfg file. The ps.cfg file setting assigns the default operation for all catalog pages. The footer attribute allows the default value to be
overridden for a given page. The rules are:
- If the pstag footer attribute is set to "on", the page footer will be generated, regardless of the ps.cfg setting.
- If the pstag footer attribute is set to "off", the page footer will not be generated, regardless of the ps.cfg setting.