cogAllows to import DITA OT contents from an HTML export
TypeXAR
CategoryOther
Developed by

Clément Aubin

Active Installs4
Rating
0 Votes
LicenseGNU Lesser General Public License 2.1

Installable with the Extension Manager

Description

This application allows to import wiki pages based on one or multiple DITA OT HTML exports.

Creating a new configuration

Once the application is installed, a new template page template is made available for page administrators in DITAOTHTMLImporter.WebHome, allowing to configure a new import source. This page helps control every parameters of an import, and actually trigger the import.

1618843976434-939.png

Configuration options

For each import configuration, the following options are available :

Option nameDescriptionMandatoryDefault value
NameThe name of the configuration.NoThe name of the page
Index URLThe URL to the index page of the DITA OT export.YesN/A
Import spaceThe home page of the space in which the import should be performed.YesN/A
Authentication tokenAn optional token to authenticate to the web server providing the DITA HTML pages. If filled in, the token will be included every HTTP header made to the server in the form Authorization: token ${token}.NoN/A
Tag metadataA comma-separated list of metadata to use for XWiki tags.NoDC.coverage, DC.audience.name, Keywords
Creator metadataThe metadata to be used for setting the creator of the page. If the metadata cannot be found in a document, the user that launches the import is used.NoDC.creator
Author metadataThe metadata to be used for setting the last author of the page. If the metadata cannot be found in a document, the user that launches the import is used.NoDC.creator
Creation date metadataThe name of the meta tag used for setting the creation date of the documents. If the metadata cannot be found in a document, the XWiki defaults are used.NoDC.date.created
Creation date metadata formatThe format to use when parsing the creation date metadata .NoYYYY-MM-DD
Update date metadataThe name of the meta tag used for setting the update date of the documents. If the metadata cannot be found in a document, the XWiki defaults are used.NoDC.date.modified
Update date metadata formatThe format to use when parsing the update date metadata .NoYYYY-MM-DD

Starting imports

The application provides three ways to start an import :

  • Either through a direct link to be clicked in the configuration
  • Through the bulk start of imports on the home page of the application
  • Or through a URL to be called externally to start the import. Note that in this case, you will have to authenticate to XWiki using HTTP Basic authentication, as only an administrator of the wiki is allowed to start the import.

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.dita:application-dita-ot-importer-html 1.1):

Tags:
    

Get Connected