cogSet of tools to analyze the contents of a wiki
TypeXAR
CategoryApplication
Developed by

Denis Gervalle

Active Installs15
Rating
Rate!
1 Votes
LicenseGNU Lesser General Public License 2.1
Compatibility

Requires XWiki 5.2.2 or higher

Installable with the Extension Manager

Description

Set of tools to analyze the contents of a wiki

Available tools

Currently the available tools are still very limited (but useful!), contributions are welcomed !
The application home page is in the WikiAnalyzer.WebHome (the application does not have an icon in the application bar for a more silent installation).

List of XAR extension installed

listinstalled.png

This very basic tool provide in a quickly filterable table the list of all installed XAR extensions with the following details:

  • Extension name
  • Extension ID
  • List of wikis where the extension is installed (namespaces)
  • List of pages installed by the extension
     

All Documents Status

alldocsstatus.png

Somehow similar to the page index, this livetable contains 3 additional columns:

  • State of the document in comparison to your SVN (works only if the SVNApp is installed with a working profile)
  • State of the document in comparison to the original one in an extension (if the document is from an extension)
  • Name of the extension having installed this document if any

By clicking on the state exclamation , you will display the difference found in the XML export of the page. (Room for improvement here, contribution welcomed).

Comparison are done based on the XML format. Some changes considered minor are ignored, like change of version, date, etc... in a similar way that the SVN application does.
To have a working SVN comparison, you need to have the SVN application installed, and at least a profile setup. There is no explicit way to choose the profile used, however, the application first try to find a profile having your username, and if none is found, takes the first available profile.

Statistics

statistics.png

This page currently provides some statistical data about the wiki.
Numbers in parentheses are absolute values. The numbers shown outside of parentheses are more significative since the following is filtered out:

  • hidden document (technical pages)
  • webpreferences
  • XWiki and WikiAnalyzer spaces

Here are some details about the numbers:

  • Document
    • Total : Total number of documents in the wiki
    • Visible: Total number of visible documents in the wiki (same as total for significant documents, since hidden are filtered out)
    • Translated: Total number of documents marked as translations
  • Parentship
    • With parent: Total number of documents having a non-empty parent field (please note that this is not really significative, since even ND has a parent field that is maintained)
    • Deeper than 2 levels: Parent field hierarchy that is deeper than 2 levels, a document that has a parent that itself has a parent. Note that it includes top-level space WebHome that usually has Main.WebHome has a parent.
    • Deeper than 3 levels: Same as above but one level deeper.
    • Deeper than 4 levels: Same as above but two levels deeper.
    • Not ND parent: A document that has a parent field that is not the WebHome of their own space. Note that the number outside parentheses also filter out the first space level WebHome page. Having a significant number here means that migration to NS without migrating could have a huge impact on usability for the users.
  • Syntaxes : list all syntaxes used, and the number of documents using it

Tested on

This extension has been tested with the following configurations.

Extension VersionXWiki FlavorNotes
1.0XWiki Enterprise 5.2.2
1.0XWiki Enterprise 8.0-milestone-2

Prerequisites & Installation Instructions

We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.

You can also use the following manual method, which is useful if this extension cannot be installed with the Extension Manager or if you're using an old version of XWiki that doesn't have the Extension Manager:

  1. Log in the wiki with a user having Administration rights
  2. Go to the Administration page and select the Import category
  3. Follow the on-screen instructions to upload the downloaded XAR
  4. Click on the uploaded XAR and follow the instructions
  5. You'll also need to install all dependent Extensions that are not already installed in your wiki

Dependencies

Dependencies for this extension (org.xwiki.contrib.wikianalyzer:application-wikianalyzer-ui 1.1):

Tags:
Created by Denis Gervalle on 2016/03/10 15:12
    

Get Connected