ERP5 Formulator has been designed to display simple types such as strings, numbers, dates, etc. It was never designed to display HTML content.

ERP5 extends formulator with new fields which can display images (ImageField), lists of documents (ListBox), matrices (MatrixBox) and HTML (EditorField).

Table of Contents

• HTML: always use EditorField
• Text Content: EditorField or TextArea?
• Related Articles

HTML: always use EditorField¶

The only way to embed HTML in an ERP5 form is to use an EditorField. Some people have tried to use LabelField and other fields for that: it is wrong. Use EditorField instead.

Editor Field has two modes: editable and non editable. It can use for now 2 different editors: TextArea (useful for browsers such as Safari) and FCKEditor (useful for Firefox for example). More editors might be supported in the future. Community is welcome to contribute.

In editable mode, EditorField displays an editor to change HTML source code. In non editable mode, the HTML content is stripped and displayed as is into the Web Page.

Note: EditorField is not yet well integrated with ODF styles of ERP5.

Text Content: EditorField or TextArea?¶

Some people prefer to use plain text documents or structured text to define styled documents which would normally be defined using HTML. EditorField can also be used in such a case, a eventually extended (look for example how moin moin Wiki does with FCKEditor).

However, not all styled text documents are supported by EditorField with FCKEditor. This is why EditorField must be able to switch to TextArea mode each time a document format is not supported with FCKEditor. In such a case EditorField looks like a TextAreaField.

Although EditorField looks like a TextAreaField in editable mode, it is capable unlike TextAreaField of producing embeddable HTML in non editable mode. This feature is useful each one wants to display style text content which can be rendered in HTML.

In conclusion, use TextAreaField if you need to display text content in read only mode as it was entered in editable mode. Use EditorField if you need to display style text in read only mode.

Related Articles¶

• Guidelines | A Document Form Uses The form_view Page Template
• Guidelines | Add Column Portal Type If Listbox Contains Multiple Types
• Guidelines | Add Date In Listbox As Editable Date-Time Field
• Guidelines | Add Viewable Listbox Fields To More Columns
• Guidelines | Define Count Method As countFolder On Module Listbox
• Guidelines | Dialog Form Name Is Postfixed With Dialog
• Guidelines | Do Not Mix Description And Comment
• Guidelines | Do Not Test Required In Field View Form
• Guidelines | Document Content Is Written In British English
• Guidelines | Field Title Must Be Singular, Capitalized And Uses Space Separator
• Guidelines | Form Name Uses Lowercase View After Portal Type
• Form Proxification
• Guidelines | Form Report Dialog Is Postfixed With Report
• Guidelines | Forms Must Use Left, Right, Center, Bottom And Hidden Groups
• Guidelines | Hide Listbox Editable Fields On The Form
• Guidelines | ListField Or MultListField For Categories Must Use Item List Method
• Guidelines | Listbox Must Only Be Put In Form Bottom Group
• Guidelines | Listbox Only Tabs Should Have A Read Only Title In Center Group
• Guidelines | Listbox Selection Name Must Follow module_name_selection Pattern
• Guidelines | Never Allow Relation String Fields To Set Relations To Categories
• Guidelines | Never Set Search Row And Select Column On Listbox Inside Document View
• Guidelines | Never Show Or Make User Work With Document Id
• Guidelines | Place Simulation And Validation Fields At Bottom Of Right Group
• Guidelines | Report Name Uses Portal Type Followed By View Report Name And Report
• Guidelines | Set Description On Form Fields
• Guidelines | Set Document Form Ids To PortalType_view
• Guidelines | Set Document Form Titles To What Is Displayed
• Guidelines | Set Form Action Base_doSelect On Forms
• Guidelines | Set Form Action To Base_edit
• Guidelines | Set Form Encytype to multipart/form-data When Using File Upload
• Guidelines | Set Form Id To ModulePortalType_viewPortalTypeList
• Guidelines | Set Form Title To What Is Displayed
• Guidelines | Set List Method To contentValues On Document Form Listbox
• Guidelines | Set Listbox Action To List Action On Document Form Listboxes
• Guidelines | Set Listbox Selection Name To form_name_selection_name
• Guidelines | Set Listbox Title To Plural Of Portal Type Title If Applicable
• Guidelines | Set Post Method And Utf-8 Encoding On Document Forms
• Guidelines | Split Large Forms On Multiple Tabs
• Guidelines | The Listbox Method Should Be Defined As SearchFolder To View Modules
• Guidelines | Use Correct Names For Simulation And Validation Titles
• Guidelines | Use form_list Page Template On Forms
• Guidelines | Use getTranslatedId To Display Document Ids In Listbox Or Form
• Guidelines | Use Method Post And UTF-8 Encoding On Forms
• Guidelines | Use Proxy Fields Of Proxy Fields In Form
• Guidelines | Use Translated Portal Type To Display Portal Type
• HowTo | Add Report
• HowTo | Configure Relationstring Field
• HowTo | Configure Parallellist Field
• HowTo | Configure Proxy Field
• HowTo | Create New Forms
• HowTo | Create OOO (Open Office) Report
• HowTo | Display or Edit HTML
• HowTo | Display Souce Code
• HowTo | Edit Listbox Data Source
• HowTo | Update PDF Form
• Technical Note | Web Forms