simpleFormat()

Signature

simpleFormat() — returns string

Available in: controller Category: Miscellaneous Functions

Description

Returns formatted text using HTML break tags (
) and HTML paragraph elements (

) based on the newline characters and carriage returns in the text that is passed in.

Parameters

Name	Type	Required	Default	Description
text	string	yes	—	The text to format.
wrap	boolean	no	true	Set to true to wrap the result in a paragraph HTML element.
encode	boolean	no	true	When set to true, encodes tag content, attribute values, and URLs so that Cross Site Scripting (XSS) attacks can be prevented. Set to attributes to only encode attribute values and not tag content.

Examples

<!--- How most of your calls will look. --->
#simpleFormat(post.bodyText)#

<!--- Demonstrates what output looks like with specific data. --->
<cfsavecontent variable="comment">
	I love this post!

	Here's why:
	* Short
	* Succinct
	* Awesome
</cfsavecontent>
#simpleFormat(comment)#

<!---
	<p>I love this post!</p>

	<p>Here's why:<br>
	* Short<br>
	* Succinct<br>
	* Awesome</p>
--->