In this window the application of the plugin should be described.


Requirements

The following requirements must be met:

Supported Operating Systems

  1. Windows
  2. Linux

Supported User Interface Languages

  1. English
  2. German

Other languages can be implemented with 3rd party support.

Further Requirements

  1. Of course Calibre must be installed: Version 4.0 or later

Operating Steps

The following operating steps must be carried out:

  1. The requirements should be met
  2. A custom #content field should be set up for that library
  3. The plugin "Define Content" has to be installed from the ZIP file
  4. Then restart Calibre (I have not yet found a way to avoid that)
  5. In Linux you still have to include the GUI command in Calibre, in Windows a query for the type of integration is automatically displayed.
  6. The basic configuration has to be carried out
    1. Parameters required for the operation of the plugin
    2. Basic parameters (can be temporarily overwritten when called up)
  7. Call of the command

Configuration

Here again the configuration should be shown in detail. I assume that the user knows about the basic steps to invoke the configuration dialog.

Basically, the controls are provided with tool tips, so that the operator can gain clarity about their function.

Toc View Generator en conf01

Toc View Generator en conf02

The top 4 lines represent the basic configuration when the command is called. They can be temporarily overwritten each time a command is called.

The following parameters are required for the operation of the plugin. The log file should be preconfigured with a usable value.

 
Log File The Log File of the Plugin

 


The Invocation

The following steps are required to call the command:

  1. A book is selected in Calibre, it should be a book with EPUB and / or PDF format
  2. One should make sure that the book has bookmarks and possibly plan how to modify the default parameters
  3. The command "Define Content" is given, e.g. by pressing a button or context menu command
    1. There is another configuration window, the parameters can be temporarily overwritten
    2. After resuming the command will be executed and then the field "Content" should be filled with data

Toc View Generator en conf03