Plugins

Plugins add dynamic content to pages. Type them like this:

 <?plugin BackLinks page='HomePage' ?>

The plugin will be replaced by some automatically generated information.

---

Available Plugins

• BackLinks plugin insert a bullet list of all pages that link to the current page
• QuickLinks plugin similar to BackLinks, but links are on one line separated by '/'
• IncludePage plugin insert the contents of another page (or a section of a page)

---

BackLinks Plugin

Invoke the BackLinks plugin as follows:

 <?plugin BackLinks page='HomePage' ?>

into a page. A list of all pages which link to the ??Home Page will then be inserted into the page. Like this:

These pages link to Home Page:

• Link Word
• Plugins
• Site Backups
• Test Page

Additional options

Insert one or more of these before the ?>

quiet=true

suppress the label altogether

exclude="SiteNavigation HelpPages"

don't list links from these pages

---

How to use BackLinks

A BackLinks link is available to the visitor at the bottom of every page on the site.

When you add one or more category links to the bottom of a page, eg:

 Category: Help Pages

your page will automatically be listed on that page (go there & see!). There are index pages for all subjects (see ??Subject Index), classes/year groups (see ??Primary/??Secondary) & staff members (see ??The Staff).

The similar 'Author' footer allows visitors to view other pages by the same author, simply by clicking on their name.

---

QuickLinks plugin

Similar to the BackLinks plugin, Quick Links displays the links in a single line, which takes up less room than a bullet list, but isn't as easy to read:

<?plugin QuickLinks page='HomePage' quiet=true ?>

Link Word  /  Plugins  /  Site Backups  /  Test Page

Additional options

Insert one or more of these before the ?>

label="Links to page %s"

change the text label that precedes the links list

quiet=true

suppress the label altogether

separator=' - '

use a different separator between links

exclude="SiteNavigation HelpPages"

don't list links from these pages

---

IncludePage Plugin

The IncludePage plugin allows you to include (sections from) other pages in a page, rather than replicating information eg:

<?plugin IncludePage page='TextFormattingRules' section='Synopsis' quiet=1 ?>

inserts the 'Synopsis' section from the Text Formatting Rules page:

<Synopsis: no such section>

---

Technical Information

(You can probably ignore this)

Plugins can take certain named arguments/parameters. The values of these arguments can be determined four different ways.

In order of precedence:

---

1. The plugin invocation can specify the value for an argument, like so

 <?plugin BackLinks page=SomePage ?>

---

2. The argument can be specified in the URL. This only works if the argument is mentioned in the plugin invocation on the requested page

 <?plugin BackLinks page ?>

---

3. Default values specified in the plugin invocation

 <?plugin BackLinks page||=OtherPage ?>

---

4. The plugin itself contains default values for each argument it uses, which will be used if no other means of specifying arguments are employed

---

Category: Help Pages