[Xmlbeans Wiki] Update of "CdataOptions" by fx

[Apache Wiki <wi...@apache.org>]

Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Xmlbeans Wiki" for change notification.

The following page has been changed by fx:
http://wiki.apache.org/xmlbeans/CdataOptions

The comment on the change is:
 CDATA options page

New page:
##language:en
= CDATA Options =

Since CDATA is just a syntactic notation in XML, and it's not part of XML info-set, by default XMLBeans is not saving additional state to remember which text is CDATA format. But numerous requests from users, convinced us that many do put semantics on CDATA, so we added two types of options to support CDATA format:

== Fast CDATA ==
!XmlOptions 
 * [http://xmlbeans.apache.org/docs/2.4.0/reference/org/apache/xmlbeans/XmlOptions.html#setSaveCDataLengthThreshold(int) setSaveCDataLengthThreshold] 
 * [http://xmlbeans.apache.org/docs/2.4.0/reference/org/apache/xmlbeans/XmlOptions.html#setSaveCDataEntityCountThreshold(int) setSaveCDataEntityCountThreshold] 

This options control when saving will use CDATA blocks. CDATA will be used if the folowing condition is true:
`textLength > cdataLengthThreshold && entityCount > cdataEntityCountThreshold`

Defaults:
 * cdataLengthThreshold is 32. 
 * cdataEntityCountThreshold is 5.


== Fidelity CDATA ==
!XmlOptions 
 * [http://xmlbeans.apache.org/docs/2.4.0/reference/org/apache/xmlbeans/XmlOptions.html#setUseCDataBookmarks() setUseCDataBookmarks] 

If this option is used when loading a document, the store will be annotated with [http://xmlbeans.apache.org/docs/2.4.0/reference/org/apache/xmlbeans/CDataBookmark.html#CDATA_BOOKMARK CDATA bookmarks].

If used for saving this option will save the text fields annotated with C!DataBookmark as CDATA XML text.

'''Note:''' Due to the store representation, a CDATA will not be recognized if it is immediately after non CDATA text and all text following it will be considered CDATA.



'''Note:''' The two types of controlling CDATA output work independently.

---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@xmlbeans.apache.org
For additional commands, e-mail: commits-help@xmlbeans.apache.org