PluginBacklinks | Documentation for Tiki Wiki CMS Groupware

plugin backlinks links

This page needs review, in particular to make sure the information in the parameter table is accurate.

Plugin Backlinks

This Wiki Plugin will list all pages that link to a specific page in the site. Information about the pages may also be displayed.

Here is an example of the syntax to use to display a list of backlinks for a page:

{BACKLINKS(page=>HomePage, info=>hits|user, exclude=>SomePage|SandBox, include_self=>1, noheader=>1)}{BACKLINKS}

Parameter	Accepted values	Effect
page	Page name. Default is the name of the page containing the plugin code.	The page that the pages being listed are linked to
info	Pipe-separated page field names (maximum of 4). For example: hits\|user. Fields available: hits, user (last author), version, lastModif (last modification), creator, flag (status).	Displays page information in the list of backlinks
exclude	Pipe-separated page names. For example: HomePage\|Sandbox	Excludes pages from the list
include_self	0 or 1 (default is 0)	Set to 1 to include in the list the page that the other pages link to
noheader	0 or 1 (default is 0)	Default or 0 setting will add this header to the list: "x pages link to {Page Name}". Set to 1 to eliminate the header.

If page information (such as hits or user) is specified, then a simple table will be produced. So this code,

{BACKLINKS(page=>Documentation, info=>hits|user, exclude=>SandBox)}{BACKLINKS}

Would produce:

10 pages link to Documentation