> For the complete documentation index, see [llms.txt](https://community-test.logicnets.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://community-test.logicnets.com/release-9/platform-documentation/form-node-parts/html-editor.md).

# HTML Editor

## Description

The *html\_editor\_tinymce* part allows you to display a rich text editor on the screen.

## Use

You can use this part in a form node to display a rich text editor with default buttons and settings. You can configure the settings in the part editor as described below.

## Editor Fields

| Field Name             | Description/Use                                                                                                                                                                                                                                                                                                                                                                                                                                               | Type/Options | Optional/Mandatory |
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ------------------ |
| Path                   | This is the path in the application context in which to save the text.                                                                                                                                                                                                                                                                                                                                                                                        | Data Object  | Mandatory          |
| Caption                | This is the caption of the HTML editor.                                                                                                                                                                                                                                                                                                                                                                                                                       | Text         | Optional           |
| Standard functionality | <p><strong>Unchecked</strong>: If this is not checked the system disables the standard read functionality.<br><strong>Checked</strong>: If this is checked the system enables the standard read functionality.</p>                                                                                                                                                                                                                                            | Checkbox     | Mandatory          |
| Custom buttons         | <p>It is possible to add custom/extra buttons to the toolbar. The data object should have the following structure.<br>- buttons\[1].name (mandatory)<br>- buttons\[1].row (optional)<br>- buttons\[1].settings (optional)<br>The system converts the Lua table to JSON before calling the <em>addButton</em> function. For more information see <a href="http://archive.tinymce.com/wiki.php/API3:method.tinymce.Editor.addButton">Tinymce addButton</a>.</p> | Data Object  | Optional           |
| Interpolate            | <p><strong>Unchecked</strong>: If this is not checked the system does not interpolate the text in the editor.<br><strong>Checked</strong>: If this is checked this the system interpolates the text in the editor.</p>                                                                                                                                                                                                                                        | Checkbox     | Optional           |
| Disable                | <p><strong>Unchecked</strong>: If this is not checked the editor is enabled and editable.<br><strong>Checked</strong>: If this is checked the editor is disabled and not editable.</p>                                                                                                                                                                                                                                                                        | Checkbox     | Optional           |
| Token                  | This is the token in which the system should show the HTML editor.                                                                                                                                                                                                                                                                                                                                                                                            | Number       | Optional           |

**The following fields are only required when using a database to store/retrieve the documents.**

| Field Name              | Description/Use                                                                                                                                                                                                                                                                                                                                                                                   | Type/Options | Optional/Mandatory |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ------------------ |
| User id                 | You can save a user id when saving documents in a database. This is the id of the user who added/edited a document.                                                                                                                                                                                                                                                                               | Number       | Optional           |
| Document id             | You can save a document id when saving a document in database. This is the id of the document that is saved.                                                                                                                                                                                                                                                                                      | Number       | Optional           |
| Document database table | This is the name of the database table in which to save the documents.                                                                                                                                                                                                                                                                                                                            | Text         | Optional           |
| Training document       | <p><strong>Unchecked</strong>: If this is not checked the text will be retrieved from the column 'fulltext'.<br><strong>Checked</strong>: If you are storing documents in a data table and this is checked, the system will retrieve a training document. The training document is the data in the column 'training\_fulltext' in the database table instead of the normal 'fulltext' column.</p> | Checkbox     | Optional           |
| Review mode             | <p><strong>Unchecked</strong>: If this is not checked the editor will display the default buttons.<br><strong>Checked</strong>: If this is checked and the <em>open</em> or <em>edit</em> logicnets are set, the buttons bar will only display "highlight/insert text/mark text as deleted" buttons to the reviewer.</p>                                                                          | Checkbox     | Optional           |
| Final review mode       | <p><strong>Unchecked</strong>: If this is not checked the editor will show the default text.<br><strong>Checked</strong>: If this is checked the final reviewer will see all the edits that were made and the final version.</p>                                                                                                                                                                  | Checkbox     | Optional           |
| Admin mode              | <p><strong>Unchecked</strong>: If this is not checked the editor will show the default text.<br><strong>Checked</strong>: If this is checked the user will be able to see the text in admin mode but will not see any special options.</p>                                                                                                                                                        | Checkbox     | Optional           |
| Open logicnet           | <p>This is the logicnet that should open when one of the reviewer buttons is clicked. The data object should have the following structure:<br>- logicnet.name(mandatory)<br>- logicnet.title (optional)<br>- logicnet.width (optional)<br>- logicnet.height (optional)</p>                                                                                                                        | Data Object  | Optional           |
| Edit logicnet           | <p>This is the logicnet that should open when editing. The data object should have the following structure:<br>- logicnet.name(mandatory)<br>- logicnet.title (optional)<br>- logicnet.width (optional)<br>- logicnet.height (optional)</p>                                                                                                                                                       | Data Object  | Optional           |
| Edit query              | This is the query that retrieves the edits when the final review mode is active.                                                                                                                                                                                                                                                                                                                  | Text         | Optional           |

## Example

Download and import the [example project](/release-9/example-gallery/example-projects-for-parts/html-editor-example-project.md) into your Designer.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://community-test.logicnets.com/release-9/platform-documentation/form-node-parts/html-editor.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
