Using the plugin
Last updated
Last updated
The plugin button is located in the MainMenu -> Window -> Documentation Project
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).
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.
Enter text in the search box and it will be searched by:
displayed names in the tree
file name
description
Each action immediately saves changes to the file.
This action creates a new root category and creates a json file with the same name to store the data.
Creates a subcategory (can call it a document), the root directory must be highlighted for this action, otherwise the action is will not available.
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.
This action allows you to rename a category or subcategory. Categories cannot have the same name, subcategories can.
This action allows you to delete a category or subcategory and a window appears to confirm the deletion.
