md_xml_subnode_ix: Determine CommonMark XML subnode indices

In salim-b/pal: Friendly Convenience/Utility Functions

Determine CommonMark XML subnode indices

Description

Determines the XML children node indices for every XML node at the highest level of xml by interpreting Markdown heading levels (1–6).

Usage

md_xml_subnode_ix(xml)

Arguments

xml	CommonMark parse tree. An xml_document, xml_nodeset or xml_node.

Details

commonmark::markdown_xml() (and so md_to_xml() which builds upon it) do parse (R) Markdown file content according to the CommonMark specification, but do not return any information about the document's heading hierarchy. md_xml_subnode_ix() fills this gap by giving the hierarchy structure in the form of the XML subnode indices for every node at the highest level of xml.

Value

A list of integer vectors of the same length as the number of XML nodes at the highest level of xml.

See Also

Other CommonMark parsing functions: md_to_xml(), xml_to_md()

Examples

"# A title

Some prose.

## A subtitle

More prose.

## Another subtitle

Out of prose here.

### A sub-subtitle

I'm dug in.

# Another title

A last word." |>
  pal::md_to_xml() |>
  pal::md_xml_subnode_ix()

salim-b/pal documentation built on Feb. 28, 2025, 6:51 p.m.