Skip to Content

Book Versions Application

Last modified by Mathieu Pace on 2026/08/05 18:28
cogApplication for managing and publishing documentation (a collection of pages) that is versioned (with inheritance of content or not), described by a status, that can be conditioned by variants, and using libraries of keywords/rich content dynamically filled in.
TypeXAR
CategoryApplication
Developed by

Anca Luca, Raluca Stavro, Mathieu Pace, Paul Pantiru, Josué Tille

Rating
0 Votes
LicenseGNU Lesser General Public License 2.1

Success

Installable with the Extension Manager

 Sources Issues  Download v1.30

Table of contents

Description

Information

This is the Administrator Documentation for the Book Versions application. Also check the Developer Documentation and the User Manual.

Application for managing and publishing documentation (a collection of pages) that is versioned (with inheritance of content or not), described by a status, that can be conditioned by variants, and using libraries of keywords/rich content dynamically filled in.

Installation

Information

This extension needs specific installation for displaying the published content, described here. For general purpose instructions, refer to Prerequisites & Installation Instructions.

  1. Install the extension on your main wiki (or on farm to skip step 2),
  2. Install the extension the wikis where Books and Libraries will be created (master wikis),
  3. Install the extension's publication elements on the wikis where Books and Libraries will be published,
    1. Go to the wiki's administration > Extensions,
    2. Click More, then Advanced search on the right,
    3. In the Extension ID field, enter org.xwiki.contrib:application-book-versions-publish-ui,
    4. In the Version field, enter the same version number as the installed extension,
    5. Click Search
    6. Select Install, then Continue.

installPublication.png

Configuration

The following configurations are for the master wikis.

Rights

No rights are set by default on any of the managing sections, or the book definition, or the book pages. This means that by default, all users having edit rights on the book will also have edit rights on its versions, variants and languages.

Read the documentation about how to set rights in XWiki.

Publication Rights

To be able to publish a Book or Library, custom publishing rights must be given.

  1. Go to the wiki's administration > Users & Rights > Extension Rights
  2. Check the box in the Publish Books column for each local/global user/group required

publishRights.png

Navigation Panel

The extension provides a navigation panel which makes navigating in a Book or Library easier. It is displayed only when the user displays pages part of one of these.

  1. Go to the wiki's administration > Look & Feel > Panels
  2. Add BookVersions.Code.BookNavigationPanel to the list of the panel side appropriate to your needs

configurationPanel.png

Objects to remove at publication

It is possible to configure which type of objects are removed from pages at publication. It prevents replacing existing metadata on the published space page, or publishing internal data from the master space.

  1. Go to the page BookVersions.Code.ConfigurationObjectsToRemove
  2. Edit the objects of the page (requires to be an Advanced User).
  3. Add an object of the type to be removed, no need to set any configuration to the object.
  4. Save the page.

Default configuration is:

  • XWiki.XWikiComments, to avoid publishing internal comments and replacing comments on the already published page
  • XWiki.XWikiGlobalRights, to avoid replacing rights in the publishing space
  • XWiki.XWikiRights, to avoid replacing rights in the publishing space

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

Versions

Failed to execute the [velocity] macro. Cause: [The execution of the [velocity] script macro is not allowed in [extensions:ExtensionCode.VersionsHome]. Check the rights of its last author or the parameters if it's rendered from another script.]. Click on this message for details.

Dependencies

Dependencies for this extension (org.xwiki.contrib:application-book-versions-ui 1.30):

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected