Skip to content

Commit

Permalink
[chore][pkg/ottl] Link to other XML Converters in `ParseSimplifiedXML…
Browse files Browse the repository at this point in the history
…` doc (#36686)
  • Loading branch information
evan-bradley authored Dec 10, 2024
1 parent a94aa2d commit 90dde68
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions pkg/ottl/ottlfuncs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1343,19 +1343,19 @@ Examples:

The `ParseSimplifiedXML` Converter returns a `pcommon.Map` struct that is the result of parsing the target string without preservation of attributes or extraneous text content.

The goal of this Converter is to produce a more user-friendly representation of XML data than the `ParseXML` Converter.
The goal of this Converter is to produce a more user-friendly representation of XML data than the [`ParseXML`](#parsexml) Converter.
This Converter should be preferred over `ParseXML` when minor semantic details (e.g. order of elements) are not critically important, when subsequent processing or querying of the result is expected, or when human-readability is a concern.

This Converter disregards certain aspects of XML, specifically attributes and extraneous text content, in order to produce
a direct representation of XML data. Users are encouraged to simplify their XML documents prior to using `ParseSimplifiedXML`.

See other functions which may be useful for preparing XML documents:

- `ConvertAttributesToElementsXML`
- `ConvertTextToElementsXML`
- `RemoveXML`
- `InsertXML`
- `GetXML`
- [`ConvertAttributesToElementsXML`](#convertattributestoelementsxml)
- [`ConvertTextToElementsXML`](#converttexttoelementsxml)
- [`RemoveXML`](#removexml)
- [`InsertXML`](#insertxml)
- [`GetXML`](#getxml)

#### Formal Definitions

Expand Down

0 comments on commit 90dde68

Please sign in to comment.