Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[chore][pkg/ottl] Link to other XML Converters in ParseSimplifiedXML doc #36686

Merged
merged 1 commit into from
Dec 10, 2024
Merged

[chore][pkg/ottl] Link to other XML Converters in ParseSimplifiedXML doc #36686

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions pkg/ottl/ottlfuncs/README.md
View file
Open in desktop
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
Loading