tracker issue : CF-4120000

select a category, or use search below
(searches all categories and all time range)
Title:

Details on WriteOutput

| View in Tracker

Status/Resolution/Reason: Closed/Fixed/

Reporter/Name(from Bugbase): James Mohler / James Mohler (James Mohler)

Created: 02/19/2016

Components: Documentation

Versions: 2016

Failure Type: Unspecified

Found In Build/Fixed In Build: CF2016_Final /

Priority/Frequency: Minor / All users will encounter

Locale/System: ALL / Mac 10.11

Vote Count: 2

Listed in the version 2016.0.02.299200 Issues Fixed doc
Verification notes: verified_partially_fixed on July 07, 2020 using build 2016.0.02.299200 
Problem Description:

https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-t-z/writeoutput.html#main-pars_text_0

Mentions "EncodeFor"

It is unclear if these are the same as the EncodeFor functions. Should the results be the same?


Any Workarounds:

The documentation should be clearer

----------------------------- Additional Watson Details -----------------------------

Watson Bug ID:	4120000

External Customer Info:
External Company:  
External Customer Name: James Mohler
External Customer Email:  
External Test Config: My Hardware and Environment details:

Attachments:

Comments:

Agreed. The code example is also *awful*. What the hell is all the 1998-era structInserts? What have structs got to do with encoding output?! Just demonstrate the function in action, and the variations it offers.
Comment by External U.
4554 | February 20, 2016 03:44:01 AM GMT
Hi James, Yes, the behavior of 'EncodeFor' arguement in the writeOutput() function is similar to the 'EncodeFor' functions.
Comment by S P.
4555 | February 26, 2016 01:02:57 AM GMT
Oh for goodness sake. The "question" was a rhetorical one, aimed at pointing out *the docs* need to be improved. This isn't "fixed" because the docs haven't been updated. Pls reopen until it's been fixed and we can *see it* and tell you if they actually have been satisfactorily fixed or not.
Comment by External U.
4556 | March 14, 2016 03:52:47 AM GMT
The updated WriteOutput doc is now live: https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-t-z/writeoutput.html
Comment by Saurav G.
4557 | March 14, 2016 05:36:39 AM GMT
Much better. Observations: * there is no "History" section * WriteOutput(string, [encodefor]) should be WriteOutput(string [,encodefor]). The comma is as optional as the second arg * you should link to each encoding function from the list "html, htmlattribute, url, javascript, css, xml, xmlattribute, xpath, ldap, and dn", or have a "see also" section with those functions listed. * the initial comment for each example are outside the <cfscript> tags should be within them. It's syntactically invalid otherwis e(make sure you RUN the examples before committing to them... if you had... you would have noticed this ;-)
Comment by External U.
4558 | March 14, 2016 06:02:39 AM GMT
Thanks for the suggestions Adam. We've updated the topic at: https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-t-z/writeoutput.html In addition, we've also documented EncodeForDN and EncodeForLDAP functions. These were not documented before.
Comment by External U.
4559 | March 15, 2016 06:45:41 AM GMT
test note
Comment by CFwatson U.
4560 | June 07, 2016 04:19:12 AM GMT
The fix for this bug is available as part of the early-access build for ColdFusion 2016 Update 2.
Comment by CFwatson U.
4561 | June 07, 2016 04:26:03 AM GMT