apws.pl Script : Documentation

border

shadow

Default value for the border parameter.

cache.dir

cache

Cache directory. Relative to the directory where apws.pl is located.

cache.compress

yes

yes = Compress the cache to save disk space.
no = Do not compress the cache.

cache.stale

3days

Cache stale time (in hours). For units other than hours, add a units suffix: days, months, years.

cache.size

1MB

Cache size (in bytes). For units other than bytes, add a units suffix: KB or MB.

cat.none.redirect

yes

yes = Redirect to category at AllPosters.com if no results.
no = Show "no results" message if no results.

Note: "No results" message is defined by format.noresults configuration variable.

catdel.NUMBER

(none)

Causes category NUMBER to be deleted; it will not appear in the list of sub-categories. Any access to category NUMBER, or any of its sub-categories, will redirect to that category at the AllPosters.com website. See also: catdelkids and catkeep. For example, to delete "Movies" (category 101) use:

catdel.101 yes

Note: The yes is required. If you leave it out, an error will be reported when you run apws.pl

catdelkids.NUMBER

(none)

Causes sub-categories of category NUMBER to be deleted; it will appear that category NUMBER has no sub-categories. Any access to sub-categories of category NUMBER will redirect to that category at the AllPosters.com website. See also: catdel and catkeep.

catkeep.NUMBER

(none)

Causes category NUMBER, and sub-categories of it, to be visible. This configuration variable enables you to make accessible specific sub-categories that have been deleted by catdel and catdelkids. Thus, for example, you could delete all Animals posters and then make Cats and Dogs posters (which are sub-categories of Animals) visible. See also: catdel and catdelkids.

For example, to delete all sub-categories of Domestic Animals (41641) except for Cats (976) and Dogs (977) categories, use the following three configuration variable settings:

catdelkids.41641 # delete all kids of Domestic Animals
catkeep.976 # keep Cats
catkeep.977 # keep Dogs

catlocal.NUMBER

(none)

Causes category NUMBER, and sub-categories of it, to be local. This configuration variable enables you to make local specific sub-categories that have been made remote by catremote and catremotekids. Thus, for example, you could make all Animals posters remote and then make Cats and Dogs posters local. See also: catremote and catremotekids.

catname.0

Posters

Name of root category.

catname.none

Posters

Name of nameless results.

catnoitems

no

Leave this configuration variable undefined unless required.

Specifies the category to display if nothing to display. Defaults to catroot value if non-zero, or to 18979 (Posters > Featured Categories > Best Sellers).

catremote.NUMBER

(none)

Causes category NUMBER to be remote. Any access to category NUMBER, or any of its sub-categories, will redirect to that category at the AllPosters.com website. See also: catremotekids and catlocal.

catremotekids.NUMBER

(none)

Causes sub-categories of category NUMBER to be remote; category NUMBER is displayed locally. Any access to sub-categories of category NUMBER (but not to category NUMBER itself) will redirect to that category at the AllPosters.com website. See also: catremotekids and catlocal.

categories

(none)

Category to display as root category. The root category is accessed by using parameter cat=0 or by not specifying the cat parameter.

If set to 0 (zero) then the top-level root category of AllPosters.com is displayed as the root category. Thus all poster categories and sub-categories are available to be displayed.

If set to a NUMBER then that category is displayed as the root category. For example, setting categories to 622 would cause the Animals category (category 622) to be displayed as the root category.

If set to a comma-separated list of numbers would cause those categories to be displayed as the root category. For example, setting categories to 622,101,290 would cause the Animals, Movies, and Sports categories to be displayed as the root category.

currency

(none)

Default value for the currency parameter.

currency.prefix

$

Currency prefix.

If you use the language parameter or the language configuration variable, apws.pl will use currency.prefix.LANGUAGEID if it is defined, otherwise currency.prefix will be used.

currency.suffix

(none)

Currency suffix.

If you use the language parameter or the language configuration variable, apws.pl will use currency.suffix.LANGUAGEID if it is defined, otherwise currency.suffix will be used.

format.link.framed

Framed

Text for "Framed" link.

format.link.unframed

Unframed

Text for "Unframed" link.

format.link.mounted

Mounted

Text for "Mounted" link.

format.navbar

Formatting string for navbar. Default is:

<p class='apwsNavbar'>{navbar}</p>

The formatting string can contain any HTML. The navbar will be substituted in where {navbar} appears in the formatting string.

Note: The default formatting string uses class='apwsNavbar' thus allowing you to style the navbar by simply defining class apwsNavbar in CSS.

format.pagebar

Formatting string for pagebar. Default is:

<p class='apwsPagebar'><b>pages:</b> {pages}</p>

The formatting string can contain any HTML. The pagebar will be substituted in where {pages} appears in the formatting string.

Note: The default formatting string uses class='apwsPagebar' thus allowing you to style the pagebar by simply defining class apwsPagebar in CSS.

format.pagebar.remote

Formatting string for pagebar when the pagebar.remote configuration variable is set to yes. Default is:

<p class='apwsPagebar'><a href='{link}'>Click here for more {form.keywords} in {name} ...</a></p>

The formatting string can contain any HTML. The URL to the category/search results page at AllPosters.com will be substituted in where {link} appears in the formatting string.

Note: The default formatting string uses class='apwsPagebar' thus allowing you to style the pagebar by simply defining class apwsPagebar in CSS.

format.noresults

Formatting string for message when no results. Default is:

<p class='apwsNone'>Nothing found</p>

The formatting string can contain any HTML.

Note: The default formatting string uses class='apwsNone' thus allowing you to style the message by simply defining class apwsNone in CSS.

format.template.script

Template formatting string to use when script parameter is specified. Default is:

{results}

The formatting string can contain any HTML.

format.template.ssi

Template formatting string to use when ssi parameter is specified. Default is:

{results}

The formatting string can contain any HTML.

format.template.iframe

Template formatting string to use when iframe parameter is specified. Default is:

<html><body bgcolor="white" leftmargin="0" topmargin="0" marginwidth="0" marginheight="0">{results}</body></html>

The formatting string can contain any HTML.

format.template.default

Template formatting string to use when no other formatting template selected. Default is:

<html><head><title>{name}</title></head><body bgcolor="white">{results}</body></html>

The formatting string can contain any HTML.

grid

(none)

Default value for the grid parameter.

height

(none)

Default value for the height parameter.

img.absurl

no

Specifies whether to make image URL's absolute (start with the server's domain name instead of just relative "/"). Useful if you are calling apws.pl remotely from another server.

Note: Images URL are automatically made absolute if parameters absurl, script, or iframe are specified.

img.dir

apws/img

Images directory (relative to directory where your home page file is located). The images directory contains graphic files to generate the border/frame/shadow effect around images.

The apws.pl .zip file contains the img directory that you should have uploaded during the installation procedure.

img.large

no

Default value for the large parameter.

Note: If you always display large images, it is advisable to set the number of grid rows to a small number (e.g.: 1 through 5) otherwise the page may take some time to load, particularly on slow internet connection.

kids

yes

yes = Show category kids (sub-categories).
no = Do not show category kids.

kids.cols

0

Number of columns in category kids list (0, 1, 2, or 3). The special value 0 causes apws.pl to automatically choose the number of columns based on the number of kids.

language

(none)

Default value for the language parameter.

links.newwindow

no

yes = Links open new windows.
no = Links stay in the current window.

links.newwindow.target

_blank

Target of links when they open a new window. Applies only when links.newwindow is set to yes.

links.relurl

yes

yes = Use relative links when referring to self.
no = Use absolute links when referring to self.

navbar

yes

yes = Show navbar.
no = Do not show navbar.

navbar.linked

yes

yes = Link the navbar to self.
no = Do not link the navbar.

navbar.prefix

(none)

Prefix to navbar. This string is appended before the navbar. It can contain any HTML. Typically would be used to add a "Home" link at the start of the navbar, such as:

navbar.prefix "<a href='/'>Home</a>"

navbar.separator

" > "

Navbar link separator. Appears between each link in the navbar.

pagebar

yes

yes = Show pagebar.
no = Do not show pagebar.

The format of the pagebar is specified in the format.pagebar configuration variable.

pagebar.back

"&laquo;back"

Text of pagebar "back" link.

The default value appears as: «back

pagebar.next

"next&raquo;"

Text of pagebar "next" link.

The default value appears as: "next»"

pagebar.separator

"|"

Pagebar page separator.

pagebar.maxpages

50

Maximum pages on pagebar.

pagebar.remote

no

yes = Pagebar has links to AllPosters.com.
no = Pagebar has links to self.

See format.pagebar.remote configuration variable.

price

(none)

Default value for the price parameter.

price.show

yes

yes = Show prices.
no = Do not show prices.

search.NAME

(none)

Define search parameters. To access a pre-defined search in search.NAME, use parameter search=NAME

For example, to define a search named hanks that does a keyword search for "Tom Hanks" (he is an actor) and outputs as a grid of 2-columns by 3-rows, set the configuration variable search.hanks as:

search.hanks "keywords=tom+hanks&grid=c:2,r:3"

To use this pre-defined search, use parameter search=hanks

search.default

(none)

Default pre-defined search to be used if no parameters specified.

For example, to have Cats posters displays if no parameters are specified, then define:

search.default "cats=976"

Note: This does not change the root category. To do that, use the categories configuration variable.

search.random

(none)

Pre-defined search to be used when search=random is used. This pre-defined search is applied before a randomly selected search from search.random.* is applied. Thus you can apply a common set of parameters to all your random searches such as output parameters (e.g.: search.random "grid=c:3,r:4").

Note: You can leave the pre-defined search search.random undefined and still define search.random.*

search.random.*

(none)

Pre-defined random searches to be used when parameter search=random is used. One of the pre-defined searches from search.random.* is randomly choosen and applied. Note: If search.random is defined, it is applied first and then a randomly chosen pre-defined search is applied.

size

18

Items per page.

sort

(none)

Default value for the sort parameter.

style

1

Default value for the style parameter.

template

(none)

Default value for the template parameter.

template.dir

templates/1

Templates directory. Relative to the directory where apws.pl is located.

The apws.pl .zip file contains the templates directory that you should have uploaded during the installation procedure.

Four template sets are provided in the apws.pl .zip file. To see the other template sets, change template.dir to templates/2 or to templates/3 or to templates/4

virtual.dir

(empty)

Name of virtual directory. If empty, then Virtual Directory is disabled. See: Virtual Directory. Note: If you enable Virtual Directory, virutal.dir must match the directory name that you have specified in your .htaccess file.

virtual.ending

/

Specifies the ending that is used at the end of Virtual Directory URL's. Some possible values:

virtual.named

yes

Specified whether to include the named portion in the virtual directory URL. The named portion is based on the category path. Example URL's for category 19816 ("Subjects > Animals > Domestic Animals > Cats > Kittens"):

With virtual.named yes:
/posters/subjects/animals/domestic-animals/cats/kittens/-/cat-19816/

With virtual.named no:
/posters/cat-19816/

virtual.named.length

0

Maximum number of directories to include in the named/keyword portion of a virtual directory URL:

• Zero (0) means no limit.
• Positive number (1, 2, 3, ...) limits number of directories, counting from the start.
• Negative number (-1, -2, -3, ...) limits number of directories, counting from the end of named portion. Particularly useful is the value -1 which limits the named portion to just the last directory.

virtual.named.skip

1

Number of leading keywords to skip when generating the named/keyword portion of a virtual directory URL. The default is 1 since the first keyword the name of the root category (typically, "Posters").

virtual.named.empty

no

Specifies whether to include the directory /-/ if there are no keywords in the named portion of a virtual directory URL. (Note: Applies only if virtual.named is true).

width

(none)

Default value for the template parameter.

www.host

The domain name to use when processing SSI (server-side-include) back to your server. Defaults to your web server's domain name (from HTTP_HOST http header). In some situations, such as load balance servers, self requests must be to "http://local/" rather than "http://domain.com/". In that case, set www.host to "local".