Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 

readme.md

Overview

The ASCII Tree Factory plugin for QOwnNotes allows users to generate an ASCII tree representation from a given path structure. This can be particularly useful for visualizing directory structures or any hierarchical data within your notes.

Manual Installation

  1. Download the Plugin: Save the ascii-tree-factory.qml file to your local machine.
  2. Add to QOwnNotes:
    • Open QOwnNotes.
    • Navigate to Settings > Scripting.
    • Click on Add script... > Add local script.
    • Select the ascii-tree-factory.qml file in the script folder.
  3. Activate the Plugin:
    • Go back to QOwnNotes.
    • In the Scripting settings, ensure that ascii-tree-factory.qml is listed and checked.

Settings

Two settings are available in the Script configuration:

  • Path separator: lets the user select one of the available separators;
  • Tree style: lets the user choose from 4 ASCII tree styles;

Usage

  1. Select Text: Highlight the text in your note that represents the path structure you want to convert into an ASCII tree.
  2. Run the Plugin:
    • Right-click on the selected text.
    • Choose Custom Actions > Generate ASCII tree from path.

The plugin will replace the selected text (single or multi-line) with an ASCII tree representation.

Example

Input

root/folder1/file1.txt
root/folder2/file2.txt
root/folder2/subfolder1/file3.txt

Output

─── root
   ├── folder1
   │  └── file1.txt
   └── folder2
      ├── file2.txt
      └── subfolder1
         └── file3.txt

Contributing

If you have suggestions or improvements, feel free to fork the repository and submit a pull request.

ToDo

  • Generalize settings such as item separator (default is /)
  • Provide aesthetic options to the tree generation
  • Look for libraries that can render good looking and customizable tree structures (any idea???)

License

This project is licensed under the MIT License. See the LICENSE file for details.


Enjoy using the ASCII Tree Factory plugin to enhance your note-taking experience with QOwnNotes!