Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

To convert your MadCap html articles to Koji’s FAQ format, you can use MadCap_To_Koji_Converter.py tool, which is provided to you in an ZIP archive along with username/password pair which you should enter when running the script.

...

Prerequisites

...

  • Python, a programming language, must be installed on your PC

...

  • . If you do not have Python yet, download it from its official website.

  • Once Python is installed, set two new 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.

  • The HTTP library called Requests must be installed.

Setting environment variables

1. Find a directory with the installed Python version and copy its path. It should be something like C:\Programs\Python\Python39.

2. Add the Python environment variables: right-click This PC and go to Properties > Advanced system settings > Environment variables.

...

3. In the Edit environment variable dialog, click New.

4. Specify the path to your installed Python (for example, C:\Programs\Python\Python39).

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

...

6. Click OK.

Installing Requests

1. In the command line, run the following:

Code Block
python -m pip install requests

Setup and run

  1. Extract the content of the archive to the folder with your html articles, so that MadCap_To_Koji_Converter.py and client.py would be on the same level as html files

  2. Open Command Prompt and go inside the folder with MadCap_To_Koji_Converter.py

  3. Run the following command

    Code Block
    python MadCap_To_Koji_Converter.py
  4. Enter username and password that were provided to you, then enter your tenant name

  5. Hit Enter and see your articles in Koji’s FAQ!

...