Wikka Documentation : CheckLinksActionInfo

HomePage :: Index :: RecentChanges :: Search :: Login/Register
[2442] Latest edit on 2017-07-01 21:56:34 by BrianKoontz [Updated category]


Additions:
CategoryEN
Deletions:
CategoryActions


[2441] Edited on 2017-07-01 21:55:45 by BrianKoontz [Typo]


Additions:
DomBonj
Deletions:
DomBonj


[2440] Edited on 2017-07-01 21:55:15 by BrianKoontz [Typo]


Additions:

Checklinks Action Documentation


Deletions:

CheckLinks Action Documentation




[2439] Edited on 2017-07-01 21:54:33 by BrianKoontz [Typo]


Additions:
Development: ChecklinksAction.
This is the documentation page for the Checklinks action.
 

Deletions:
Development: http://wikkawiki.org/ChecklinksAction|ChecklinksAction.
This is the documentation page for the Checklinks action.
 



[2438] Edited on 2017-07-01 21:54:08 by BrianKoontz [New entry]


Additions:

CheckLinks Action Documentation

This is the documentation page for the checklinks action.
NOTE
This feature is available since:
WikkaWiki 1.4.0

This is the documentation page for the Checklinks action.
 

This administration tool checks the validity of hyperlinks on some or all of the wiki pages and displays a report of broken links.
Parameters
nametyperequired?defaultdescription
scopestringoptionaluserAllowed values are 'page' (check only this page), 'user' (check all pages owned by current user) and 'all' (check all pages for which current user has ACL-read-access)
sortstringoptionaltagAllowed values are 'tag' (sort on page tag), 'type' (sort on link type) and 'cnt' (sort on occurences count)
optsstringoptionalOptions: any combination of 'i' (internal=do not check external web pages), 't' (terse=show only summary report) and 'w' (check page tag format, i.e. that it is formatted as a valid WikiWord)

Link checkers are a standard administration tool for webmasters and can be run on a wiki site. However, a standard link checker has the following drawbacks when used with WikkaWiki:
  • as it is not a registered wiki user, it can be denied access to ACL-protected pages
  • it checks older versions of each page, adding significantly to execution time
  • it is not always able to check for 'file://' hyperlinks
  • it cannot point out non-existent (i.e. wanted) wiki pages, as the corresponding hyperlink points to an (existing) WikiWord/edit page tag
This action is a link checker adapted to the wiki context. It goes over the latest version of all wikka pages accessible in read mode to the current user and checks for the validity of various types of hyperlinks appearing on these pages.
Link categories checked are:
  • intra-wiki (page) links ;
  • inter-wiki links ;
  • other web pages hosted on the same or a different server ;
  • files on a local or shared directory ;
  • actions.
When run by a Wiki Admin with a scope="all" parameter value, it checks the integrality of the wiki content.
{{checklinks [scope="page"] [sort="type"] [opts="[i][t][w]"]}}

Example

Let's create on purpose on this page a NonExistentWikiPageLink, a non-existent external link and a non-existent file link.
The output of {{checklinks scope="page"}} would look like:

Link check summary

Link typeValid links #Broken links #
Action10
External11
Inter-wiki00
Wiki page31
File01
Total53

Detailed report

Link typePage nameLink valueError messageOccurences
FileChecklinksActionInfo./files/nonexistentfile.abcFile not found1
ExternalChecklinksActionInfohttp://www.nonexistentdomain.org/foo.htmNot Found1
Wiki pageChecklinksActionInfoNonExistentWikiPageLinkPage non-existent1

To-do, bugs and limitations

  • action does not check anchor-based links inside a page.
  • action does not handle relative HTTP redirections (e.g. Location: ../foo.php in the HTTP reply header).
  • execution time could be a limitation on a large wiki, especially when many external links are involved. Indeed, blocking socket calls are used, and neither multithreading nor parallelization speeds up the processing, so the performance of the external link checking engine is significantly lower than that of dedicated tools.

Other considerations

  • the 'non-existent Wiki page' feature is somehow redundant with the WantedPages action. In order to avoid a double counting of non-existent pages, the action ignores all | Wantedpages actions.
  • credit is given to steven (at) haryan.to and to carinridge (at) hotmail.com for part of the external link checking code.
DomBonj
CategoryActions

Deletions:

xxxxx Action Documentation

This is the documentation page for the xxxxx action.
NOTE
This feature is available since:
WikkaWiki 1.3.7

See also
  • Related links
  • Must be added here
This page is a template. It belongs to CategoryTemplate (which contains more handy documentation templates). To create an action documentation page, clone this page to a page called xxxxxActionInfo (where xxxxx is the (capitalized) name of the action), replace all occurrences of xxxxx with the name of the action and replace this paragraph with the actual content.
When the new page is ready to be published, remember to change the category link at the bottom of this page to Category<Lang>, replacing <Lang> with the appropriate two-letter language code (such as CategoryEN, CategoryDE, etc.).
Describe your action in one sentence.
{{action_name [optional_param="xxx"]}}
You can add a longer description here.
Parameters
nametyperequired?defaultdescription
param1intmandatoryvalueThis is one of the params, your action uses. Add as many rows as action parameters.
param2stringoptionalvalueIf your action uses no params, please remove this table

Examples
You can put one or more examples here.
The name(s) of the person(s) who wrote this action.
CategoryTemplate



[2437] The oldest known version of this page was created on 2017-07-01 21:28:44 by BrianKoontz [Cloned from ActionInfoTemplate]

History of recent changes for CheckLinksActionInfo

xxxxx Action Documentation

This is the documentation page for the xxxxx action.
NOTE
This feature is available since:
WikkaWiki 1.3.7

See also
  • Related links
  • Must be added here
This page is a template. It belongs to CategoryTemplate (which contains more handy documentation templates). To create an action documentation page, clone this page to a page called xxxxxActionInfo (where xxxxx is the (capitalized) name of the action), replace all occurrences of xxxxx with the name of the action and replace this paragraph with the actual content.

When the new page is ready to be published, remember to change the category link at the bottom of this page to Category<Lang>, replacing <Lang> with the appropriate two-letter language code (such as CategoryEN, CategoryDE, etc.).

Documentation


Short description
Describe your action in one sentence.

Usage
{{action_name [optional_param="xxx"]}}

Parameters
nametyperequired?defaultdescription
param1intmandatoryvalueThis is one of the params, your action uses. Add as many rows as action parameters.
param2stringoptionalvalueIf your action uses no params, please remove this table

Long description
You can add a longer description here.

Examples
You can put one or more examples here.

Author
The name(s) of the person(s) who wrote this action.


CategoryTemplate
Creative Common Attribution-ShareAlike License
Valid XHTML 1.0 Transitional :: Valid CSS :: Powered by WikkaWiki
Page was generated in 0.0163 seconds