Using the plugin

How to open the plugin?

The plugin button is located in the MainMenu -> Window -> Documentation Project

Automatic scanning of project files

In the plugin is a button to scan the project files MainMenu -> Rescan project. If files are found that have not yet been added to the documentation, they will be added to the final folders specified in the plugin settings (Screenshot 1).

Screenshot 1

plugin source code scan result

Drag&Drop

The plugin implements drag-and-drop tree elements.

Only the main root element (it is marked with a red frame in the picture below) cannot be dragged.

Search

Enter text in the search box and it will be searched by:

• displayed names in the tree

• file name

• description

Context menu actions

Each action immediately saves changes to the file.

Creating a root category

This action creates a new root category and creates a json file with the same name to store the data.

Creating a subcategory (document)

Creates a subcategory (can call it a document), the root directory must be highlighted for this action, otherwise the action is will not available.

Edit

This action opens a window for editing category/subcategory data.

After editing, you must confirm the changes to save or cancel to discard. The category file name cannot be changed, it automatically changes when you rename the root category.

Renaming

This action allows you to rename a category or subcategory. Categories cannot have the same name, subcategories can.

Deleting

This action allows you to delete a category or subcategory and a window appears to confirm the deletion.