Forums Technical Discussion H22: HDA Help Line Break

H22: HDA Help Line Break

   420   4   1
User Avatar
alexeyvanzhula1984
Member
109 posts
Joined: 11月 2023
オフライン
 
Prior to version 22, you could insert `\n` in the HDA parameter help field to create a line break. This no longer works. How can I write nicely formatted parameter descriptions now?
Edited by alexeyvanzhula1984 - 2026年9月6日 07:18:27
User Avatar
Italimpex Productions
Member
27 posts
Joined: 8月 2021
オフライン
 
Hello. That's a v22 bug, it stopped working for me too. Now I'm only able to add one split \n and others are ignored. But it's still possible to trick UI parser in Type Properties window by manually escalating number of spaces that serve as prefix and suffix for each split \n. For example, first split: 
TEST  \n  TEST
Second split: 
TEST   \n   TEST
Third split: 
TEST    \n    TEST
Notice the increasing number of spaces for each split before and after "\n".

Obviously it gets annoying to manually format splits like this so I set up a Python script to automate it. Just create a regular shelf tool, fill in name and label and under Script paste this:

import tkinter as tk

def fix_hda_tooltips():
    root = tk.Tk()
    root.withdraw()
    
    try:
        raw_text = root.clipboard_get()
    except tk.TclError:
        return

    lines = [line.strip() for line in raw_text.splitlines() if line.strip()]
    if not lines:
        return

    out = []
    for idx, line in enumerate(lines):
        if idx == 0:
            out.append(line)
        else:
            pad = " " * idx
            out.append(f" {pad}\\n{pad} {line}")
    
    root.clipboard_clear()
    root.clipboard_append("".join(out))
    root.update()
    root.destroy()
    print("Formatted text copied back to clipboard!")

fix_hda_tooltips()

So now you're going to write help description for your parameter in random text editor like Notepad. Then you will format the text by clicking Enter to split sentences as you wish.
For example:
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec tempus fringilla dolor, ut faucibus erat tempus eu.
Duis pharetra iaculis lorem quis fringilla. Curabitur mollis hendrerit mauris, nec gravida tellus.
Mauris pharetra augue eros, ac luctus mauris viverra non. Curabitur mollis mollis ante, quis placerat diam laoreet ut.
Praesent finibus quam ut ante gravida, nec luctus risus feugiat.

Script will recognize where you pressed Enter and correctly format the paragraph. Also, console will print a message saying formatted text is copied back to clipboard:
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec tempus fringilla dolor, ut faucibus erat tempus eu.  \n  Duis pharetra iaculis lorem quis fringilla. Curabitur mollis hendrerit mauris, nec gravida tellus.   \n   Mauris pharetra augue eros, ac luctus mauris viverra non. Curabitur mollis mollis ante, quis placerat diam laoreet ut.    \n    Praesent finibus quam ut ante gravida, nec luctus risus feugiat.

Once it's automatically copied to your clipboard you will simply go to your node's Type Properties and paste the clipboard into Help field. Now you can do the same for all other help descriptions. Write the description in notepad, press Enter to format and organize the paragraph as you wish, copy it, then click on the shelf tool which properly adds \n in every place where you pressed "Enter" and copies it back to clipboard, then you can ctrl v that into your parameter's help field.

I hope that helps!
Edited by Italimpex Productions - 2026年9月6日 13:56:47
Italimpex Productions
CGI Studio specializing in directing and producing advertisements & films
User Avatar
alexeyvanzhula1984
Member
109 posts
Joined: 11月 2023
オフライン
 
Thank you! Have you already submitted the RFE?
User Avatar
elovikov
Member
163 posts
Joined: 6月 2019
オンライン
 
i think h22 switched to wiki markup for tooltips (sidefx flavour of markdown) for better formatting
use <br/> as it inline html by default

you can even use some stuff like *bold* or _italics_, prob not all the features of markdown is supported, but main ones are

this is obviously not backwards compatible though
User Avatar
Italimpex Productions
Member
27 posts
Joined: 8月 2021
オフライン
 
elovikov
i think h22 switched to wiki markup for tooltips (sidefx flavour of markdown) for better formatting
use <br/> as it inline html by default

you can even use some stuff like *bold* or _italics_, prob not all the features of markdown is supported, but main ones are

this is obviously not backwards compatible though
This works, thanks for pointing it out!
Italimpex Productions
CGI Studio specializing in directing and producing advertisements & films
  • Quick Links