aboutsummaryrefslogtreecommitdiff
path: root/docs/manual.adoc
diff options
context:
space:
mode:
authorArseny Kapoulkine <arseny.kapoulkine@gmail.com>2024-01-26 09:23:26 -0800
committerArseny Kapoulkine <arseny.kapoulkine@gmail.com>2024-01-26 09:23:26 -0800
commitb2b466403084667c90a0f0cc4e960405cfc8117a (patch)
treead81b9fe39915c1ae0780d2ba1760b0845dd117b /docs/manual.adoc
parent3cc2daf449f0f96594a1f4238303275786d61fbb (diff)
downloadpugixml-b2b466403084667c90a0f0cc4e960405cfc8117a.zip
pugixml-b2b466403084667c90a0f0cc4e960405cfc8117a.tar.gz
pugixml-b2b466403084667c90a0f0cc4e960405cfc8117a.tar.bz2
docs: Adjust docs wrt parse_merge_pcdata x parse_embed_pcdata
parse_merge_pcdata expects to find node_pcdata nodes which aren't present when parse_embed_pcdata is active. For now we mention this in the documentation; changing this is possible in the future, but carries a small performance penalty so it requires a specific use case. Fixes #600
Diffstat (limited to 'docs/manual.adoc')
-rw-r--r--docs/manual.adoc2
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/manual.adoc b/docs/manual.adoc
index a65884d..45b2f3c 100644
--- a/docs/manual.adoc
+++ b/docs/manual.adoc
@@ -749,7 +749,7 @@ These flags control the resulting tree contents:
* [[parse_embed_pcdata]]`parse_embed_pcdata` determines if PCDATA contents is to be saved as element values. Normally element nodes have names but not values; this flag forces the parser to store the contents as a value if PCDATA is the first child of the element node (otherwise PCDATA node is created as usual). This can significantly reduce the memory required for documents with many PCDATA nodes. To retrieve the data you can use `xml_node::value()` on the element nodes or any of the higher-level functions like `child_value` or `text`. This flag is *off* by default.
Since this flag significantly changes the DOM structure it is only recommended for parsing documents with many PCDATA nodes in memory-constrained environments. This flag is *off* by default.
-* [[parse_merge_pcdata]]`parse_merge_pcdata` determines if PCDATA contents is to be merged with the previous PCDATA node when no intermediary nodes are present between them. If the PCDATA contains CDATA sections, PI nodes, or comments in between, and either of the flags <<parse_cdata,parse_cdata>> ,<<parse_pi,parse_pi>> ,<<parse_comments,parse_comments>> is not set, the contents of the PCDATA node will be merged with the previous one. This flag is *off* by default.
+* [[parse_merge_pcdata]]`parse_merge_pcdata` determines if PCDATA contents is to be merged with the previous PCDATA node when no intermediary nodes are present between them. If the PCDATA contains CDATA sections, PI nodes, or comments in between, and either of the flags <<parse_cdata,parse_cdata>> ,<<parse_pi,parse_pi>> ,<<parse_comments,parse_comments>> is not set, the contents of the PCDATA node will be merged with the previous one. This flag is *off* by default. Note that this flag is not compatible with `parse_embed_pcdata`.
* [[parse_fragment]]`parse_fragment` determines if document should be treated as a fragment of a valid XML. Parsing document as a fragment leads to top-level PCDATA content (i.e. text that is not located inside a node) to be added to a tree, and additionally treats documents without element nodes as valid and permits multiple top-level element nodes (currently multiple top-level element nodes are also permitted when the flag is off, but that behavior should not be relied on). This flag is *off* by default.