# How to configure instructions in node document tab (subflow)

**URL:** <https://discourse.nodered.org/t/how-to-configure-instructions-in-node-document-tab-subflow/54803>\
**Category:** General\
**Created:** [7 December 2021 01:54 UTC](https://discourse.nodered.org/t/how-to-configure-instructions-in-node-document-tab-subflow/54803 "2021-12-07T01:54:00Z")\
**Posts on this page:** 15\
**Page:** 1

<div class="post-metadata">

**Author:** ![Trying\_to\_learn](https://sea2.discourse-cdn.com/flex026/user_avatar/discourse.nodered.org/trying_to_learn/32/28400_2.png) [@Trying\_to\_learn](https://discourse.nodered.org/u/Trying_to_learn)\
**Post date:** [7 December 2021 01:54 UTC](https://discourse.nodered.org/t/how-to-configure-instructions-in-node-document-tab-subflow/54803/1 "2021-12-07T01:54:00Z")

</div>

My hand's up.

I don't know all the tricks.

I know that you have to start the text with `**` but then it is all blank.  
I want to write _instructions_ to explain how to configure a subflow I am writing.

---

<div class="post-metadata">

**Author:** ![shrickus](https://sea2.discourse-cdn.com/flex026/user_avatar/discourse.nodered.org/shrickus/32/517_2.png) [@shrickus](https://discourse.nodered.org/u/shrickus)\
**Post date:** [7 December 2021 03:22 UTC](https://discourse.nodered.org/t/how-to-configure-instructions-in-node-document-tab-subflow/54803/2 "2021-12-07T03:22:27Z")

</div>

If you are using the newer version, there should be a Description editor available for this purpose:

 ![image](https://us1.discourse-cdn.com/flex026/uploads/nodered/original/3X/8/d/8d94cd55efff15f4f99d071ed9e9979e97b3d15f.png)

You can get there by double-clicking the Subflow node in the Palette, then select the Edit Properties button and look for the `Description` icon shown above.

You'll notice that the description text is saved in [Github-flavored Markdown](https://www.markdownguide.org/cheat-sheet/) format (iirc) -- here is a cheat sheet page that gives a quick overview of the syntax (or just use the toolbar at the top).

---

<div class="post-metadata">

**Author:** ![Trying\_to\_learn](https://sea2.discourse-cdn.com/flex026/user_avatar/discourse.nodered.org/trying_to_learn/32/28400_2.png) [@Trying\_to\_learn](https://discourse.nodered.org/u/Trying_to_learn)\
**Post date:** [7 December 2021 03:31 UTC](https://discourse.nodered.org/t/how-to-configure-instructions-in-node-document-tab-subflow/54803/3 "2021-12-07T03:31:00Z")

</div>

Thanks.

I am trying/have tried that, but I am seeing _conflicts_ with how that works.

(Check my recent subflow post/share of `toggle`)

I write the stuff for the _documents_ page, but there is this _conflict_ with what is shown when I move the mouse over the node on the left side of the screen.

 ![Screenshot from 2021-12-07 14-25-13](https://us1.discourse-cdn.com/flex026/uploads/nodered/original/3X/f/f/ffa708ff20f58cef9084e31ceda62e10f0de6da2.png)

I' confused why this happens.

---

<div class="post-metadata">

**Author:** ![Paul-Reed](https://sea2.discourse-cdn.com/flex026/user_avatar/discourse.nodered.org/paul-reed/32/66906_2.png) [@Paul-Reed](https://discourse.nodered.org/u/Paul-Reed)\
**Post date:** [7 December 2021 09:17 UTC](https://discourse.nodered.org/t/how-to-configure-instructions-in-node-document-tab-subflow/54803/4 "2021-12-07T09:17:34Z")

</div>

I found that by writing a short, unformatted paragraph at the top of the description, which is then followed by a blank line (ie 2 carriage returns), then that displays fine as the node hover info.  
See screenshot below.

 ![screen](https://us1.discourse-cdn.com/flex026/uploads/nodered/original/3X/d/c/dc647ff4c485eb2d0918951d2e40e965afbb9646.jpeg)

---

<div class="post-metadata">

**Author:** ![Trying\_to\_learn](https://sea2.discourse-cdn.com/flex026/user_avatar/discourse.nodered.org/trying_to_learn/32/28400_2.png) [@Trying\_to\_learn](https://discourse.nodered.org/u/Trying_to_learn)\
**Post date:** [7 December 2021 09:23 UTC](https://discourse.nodered.org/t/how-to-configure-instructions-in-node-document-tab-subflow/54803/5 "2021-12-07T09:23:57Z")

</div>

I'm guessing I can't have multiple lines (C/R) to force a new line in the first bit?

---

<div class="post-metadata">

**Author:** ![knolleary](https://sea2.discourse-cdn.com/flex026/user_avatar/discourse.nodered.org/knolleary/32/3_2.png) [@knolleary](https://discourse.nodered.org/u/knolleary)\
**Post date:** [7 December 2021 09:27 UTC](https://discourse.nodered.org/t/how-to-configure-instructions-in-node-document-tab-subflow/54803/6 "2021-12-07T09:27:50Z")

</div>

If you add a paragraph break in the middle of the "first bit" then it will become the first and second bits.

The tooltip in the palette takes the first paragraph from the node info.

---

<div class="post-metadata">

**Author:** ![Paul-Reed](https://sea2.discourse-cdn.com/flex026/user_avatar/discourse.nodered.org/paul-reed/32/66906_2.png) [@Paul-Reed](https://discourse.nodered.org/u/Paul-Reed)\
**Post date:** [7 December 2021 09:28 UTC](https://discourse.nodered.org/t/how-to-configure-instructions-in-node-document-tab-subflow/54803/7 "2021-12-07T09:28:50Z")

</div>

Try adding 2 spaces followed by a carriage return (Markdown!)

![screen2](https://us1.discourse-cdn.com/flex026/uploads/nodered/original/3X/6/7/67af8a51d732df25e9e98448fc48c34107521db0.jpeg)

---

<div class="post-metadata">

**Author:** ![Trying\_to\_learn](https://sea2.discourse-cdn.com/flex026/user_avatar/discourse.nodered.org/trying_to_learn/32/28400_2.png) [@Trying\_to\_learn](https://discourse.nodered.org/u/Trying_to_learn)\
**Post date:** [7 December 2021 09:31 UTC](https://discourse.nodered.org/t/how-to-configure-instructions-in-node-document-tab-subflow/54803/8 "2021-12-07T09:31:17Z")

</div>

I also notice that I can't have _headings_ and _bold_. `#` and `**`  
Because when I do, I see the `**` as text.

---

<div class="post-metadata">

**Author:** ![Paul-Reed](https://sea2.discourse-cdn.com/flex026/user_avatar/discourse.nodered.org/paul-reed/32/66906_2.png) [@Paul-Reed](https://discourse.nodered.org/u/Paul-Reed)\
**Post date:** [7 December 2021 09:32 UTC](https://discourse.nodered.org/t/how-to-configure-instructions-in-node-document-tab-subflow/54803/9 "2021-12-07T09:32:57Z")

</div>

Yes that why I said

> [@Paul-Reed](#):
>
> a short, **unformatted** paragraph at the top of the description

---

<div class="post-metadata">

**Author:** ![knolleary](https://sea2.discourse-cdn.com/flex026/user_avatar/discourse.nodered.org/knolleary/32/3_2.png) [@knolleary](https://discourse.nodered.org/u/knolleary)\
**Post date:** [7 December 2021 09:33 UTC](https://discourse.nodered.org/t/how-to-configure-instructions-in-node-document-tab-subflow/54803/10 "2021-12-07T09:33:28Z")

</div>

The first paragraph should be a brief summary of the node's purpose that is suitable to show in the tooltip. It should not need to have any further formatting applied. That is how it is.

---

<div class="post-metadata">

**Author:** ![Paul-Reed](https://sea2.discourse-cdn.com/flex026/user_avatar/discourse.nodered.org/paul-reed/32/66906_2.png) [@Paul-Reed](https://discourse.nodered.org/u/Paul-Reed)\
**Post date:** [7 December 2021 09:37 UTC](https://discourse.nodered.org/t/how-to-configure-instructions-in-node-document-tab-subflow/54803/11 "2021-12-07T09:37:41Z")

</div>

@Trying_to_learn - The only reason that I know this is through my own trial & error, and it's surprising what you learn just by spending a few minutes and working it out yourself. 😉

---

<div class="post-metadata">

**Author:** ![Trying\_to\_learn](https://sea2.discourse-cdn.com/flex026/user_avatar/discourse.nodered.org/trying_to_learn/32/28400_2.png) [@Trying\_to\_learn](https://discourse.nodered.org/u/Trying_to_learn)\
**Post date:** [7 December 2021 09:42 UTC](https://discourse.nodered.org/t/how-to-configure-instructions-in-node-document-tab-subflow/54803/12 "2021-12-07T09:42:21Z")

</div>

Yeah, I had kind of got things working - see picture above - but the _double_ embedding of a _heading_ and _bold_ seems to give weird results.

I don't know if it is that it isn't supported, or I stuffed something up.

@knolleary  
Thanks.  
I have got it looking a bit better.  
Though I still don't know the other _rules_ about what to put where.

---

<div class="post-metadata">

**Author:** ![knolleary](https://sea2.discourse-cdn.com/flex026/user_avatar/discourse.nodered.org/knolleary/32/3_2.png) [@knolleary](https://discourse.nodered.org/u/knolleary)\
**Post date:** [7 December 2021 09:51 UTC](https://discourse.nodered.org/t/how-to-configure-instructions-in-node-document-tab-subflow/54803/13 "2021-12-07T09:51:34Z")

</div>

You could check the help style guide: [Node help style guide : Node-RED](https://nodered.org/docs/creating-nodes/help-style-guide)

Make sure you switch the examples to Markdown on that page, rather than the default HTML.

---

<div class="post-metadata">

**Author:** ![Trying\_to\_learn](https://sea2.discourse-cdn.com/flex026/user_avatar/discourse.nodered.org/trying_to_learn/32/28400_2.png) [@Trying\_to\_learn](https://discourse.nodered.org/u/Trying_to_learn)\
**Post date:** [7 December 2021 09:56 UTC](https://discourse.nodered.org/t/how-to-configure-instructions-in-node-document-tab-subflow/54803/14 "2021-12-07T09:56:10Z")

</div>

I've looked there and tried. I seem to have missed something.

But! (Good news)  
The part @Paul-Reed mentioned with the two spaces at the end of a line has helped big time with formatting.

I'm a bit confused with the _numbering_ option as it also makes/shows leading `*` on the line.  
But I tidied that up.

I'll maybe post it again but I may wait as the one I posted works and I have already done an update. May be a good idea to see if there are any other requests or things I missed before _flooding_ the thread with updates.

I don't think that is exactly professional. Though yes: if there are bugs they would need to be fixed.

---

<div class="post-metadata">

**Author:** ![system](https://us1.discourse-cdn.com/flex026/uploads/nodered/original/1X/d073cd938eafa2e558d7c2cd59003b3ef4963033.png) [@system](https://discourse.nodered.org/u/system)\
**Post date:** [21 December 2021 09:57 UTC](https://discourse.nodered.org/t/how-to-configure-instructions-in-node-document-tab-subflow/54803/15 "2021-12-21T09:57:10Z")

</div>

This topic was automatically closed 14 days after the last reply. New replies are no longer allowed.