Diff: Help/BackLinksPlugin

Differences between current version and predecessor to the previous major change of Help/BackLinksPlugin.

Other diffs: Previous Revision, Previous Author

Newer page: version 6 Last edited on 17 January 2022 3:00 by harold
Older page: version 5 Last edited on 9 September 2007 0:16 by harold Revert
@@ -1,27 +1,66 @@
-_short description_  
+The **~BackLinks** [[Help:WikiPlugin|plugin]] lists all pages which link to a given page.  
  
-! Usage  
-<verbatim>  
- < ?plugin BackLinks ?>  
-</verbatim>  
+The contents of all pages are searched to find links to the current  
+page. The ~BackLinks function also answers the question: “Which pages  
+contain the title of this page ?”.  
  
-! Arguments  
+To display the list of pages which all contain multiple links use a pagelist as page argument.  
+For example {{{<<BackLinks page=Milk,Honey>>}}} would display all pages which  
+contain links to Milk AND Honey.  
  
-page _(default: current pagename)_:  
- The page to execute upon.  
+== Usage ==  
  
-! Example  
+{{{  
+<<BackLinks arguments>>  
+}}}  
  
-<verbatim>  
-<?plugin BackLinks ?>  
-</verbatim>  
+== Arguments ==  
  
-<?plugin BackLinks ?>  
+All [[Help:PageList|PageList]] arguments, plus the following ones:  
  
-! Author  
-PhpWiki:ReiniUrban  
+{| class="bordered"  
+|-  
+ ! Argument  
+! Description  
+! Default value  
+|-  
+| **page**  
+| Page from which the back links are calculated.  
+| Current page  
+|-  
+| **include_self**  
+| Boolean. If true, include yourself in the results.  
+| false  
+|-  
+| **noheader**  
+| Boolean. If true, do not display header.  
+| false  
+|-  
+| **linkmore**  
+| If count > 0 and limit > 0 display a link with the number of all results, linked to the given pagename.  
+|  
+|}  
  
-! See Also  
+== Example ==  
  
+{{{  
+<<BackLinks page=HomePage>>  
+}}}  
+  
+<<BackLinks page=HomePage>>  
+  
+== Known Problems ==  
+  
+Back links should be found even if the link is inside a table, or in an  
+included template, but not in some complex cases (for example, the link  
+is in a template included inside a table).  
+  
+== Author ==  
+* [[Help:Reini Urban|Reini Urban]]  
+  
+== See Also ==  
+  
+<noinclude>  
 ---- 
-PhpWikiDocumentation Help:WikiPlugin  
+[[ PhpWikiDocumentation]] [[CategoryWikiPlugin]]  
+</noinclude>  

current version

The BackLinks plugin lists all pages which link to a given page.

The contents of all pages are searched to find links to the current page. The BackLinks function also answers the question: “Which pages contain the title of this page?”.

To display the list of pages which all contain multiple links use a pagelist as page argument. For example <<BackLinks page=Milk,Honey>> would display all pages which contain links to Milk AND Honey.

Usage

<<BackLinks arguments>>

Arguments

All PageList arguments, plus the following ones:

Argument

Description

Default value

page

Page from which the back links are calculated.

Current page

include_self

Boolean. If true, include yourself in the results.

false

noheader

Boolean. If true, do not display header.

false

linkmore

If count > 0 and limit > 0 display a link with the number of all results, linked to the given pagename.

Example

<<BackLinks page=HomePage>>

247 pages link to HomePage:

|<<   << - 1 / 5 - Next >>   >>|
|<<   << - 1 / 5 - Next >>   >>|

Known Problems

Back links should be found even if the link is inside a table, or in an included template, but not in some complex cases (for example, the link is in a template included inside a table).

Author

See Also