You can convert MadCap HTML articles to Koji’s FAQ format. This page describes how to get the required tools and how to carry out the converting.

Key points

To make you MadCap HTML articles available in Koji’s FAQ, use the MadCap_To_Koji_Converter.py tool. Konverso sends an archive with this tool and credentials, required for converting: a username and password.

Prerequisites

Installing Python interpreter

A Python interpreter, a program that understands the Python programming language, must be installed on your PC. If you do not have it, download it from its official website. Run the downloaded installer and follow its instructions.

When installing the interpreter, select the Add Python Version to PATH checkbox. This will automatically deal with environment variables. If you miss this step, you will need to set these variables manually. This process is described below.

...

Setting environment variables

Once Python is installed, set two environment variables: for Python and for its scripts. If it is not done, errors such as 'python' is not recognized as an internal or external command might occur.

...

6. Specify the path to Python scripts (for example, C:\Programs\Python\Python39\Scripts).

...

7. Click OK.

Installing Requests and Beautifulsoup4

• Requests is an HTTP library. This package is used in the script to communicate with Koji.

• When installing Requests, the beautifulsoup4 Beautifulsoup4 library is installed as well. It is used to parse HTML.

To install Requests (and beautifulsoup4): 1. In and Beautifulsoup4, open the command prompt , and run the following:

python -m pip install requests
python -m pip install beautifulsoup4

Running the tool

1. Download the archive with the converting tool.

...

3. Open the command prompt and navigate to the directory with that contains MadCap_To_Koji_Converter.py.

...

6. Enter your tenant name and press Enter.

Checking results

1. Open your Koji backoffice and go to Content > FAQ.

...