livMatS / dtool-lookup-gui

Graphical user interface for dtool
Other
8 stars 2 forks source link

Wish list of functions #212

Open chwenzel opened 1 year ago

chwenzel commented 1 year ago

-Basic text editing functions, e.g. font size, writing bolt/italic/underlined -the functions to add a second(, third...) page -the option to have the second page in a table format

jotelha commented 1 year ago

@chwenzel thanks for the wishlist.

The editor window in the GUI is just a simple text editor for the content of the README.yml, and we want to keep that as simple and lean as possible.

So there won't be no pagination on the displayed README.yml content in this GUI. What I want at some point though is quick text search on the displayed content.

What we had in the GUI earlier and what would also be straight forward to reinsert is this kind of collapsible tree view for the README.yml content, image

What we can do easily and fast as well is inserting a button to launch some configurable external default editor on the README.yml and update the GUI view with the modified content after editing. You can use any external editor to modify the content of the README.yml as well. There are many tools to read and write yaml format, like Notepad++ (for example, see https://listoffreeware.com/free-yaml-editor-software-windows/ if you are on Windows) and some to display yaml format in table form. With a quick online search, I found this, https://tableconvert.com/yaml-generator, to convert forth and back between table view and yaml. If we wanted something like this in the GUI, that would likely look like the editable raw yaml as it is now + a rendered table view next to it (or replacing it on activating a switch), in a similar manner as many editors do for markdown, like Joplin in this screenshot, image, but that would need some time to implement, and to a certain extent constitute another "reinvention of the wheel".

Using external editors, you could also explore what they are able to do in terms of font formatting and YAML. It's possible to embed HTML into YAML without much acrobatics, https://en.wikipedia.org/wiki/YAML#Indented_delimiting, and it is also possible to combine YAML and markdown, see the last entry on https://learntheweb.courses/topics/markdown-yaml-cheat-sheet/#yaml. I actually like the latter idea to combine structured metadata and free (but formattable) text documentation.