将 Markdown 翻译为 Document Object Model (DOM)

要以编程方式读取、操作和修改文档的内容和格式，您需要将其转换为 Aspose.Words Document Object Model (DOM)。

与Word文档相比，Markdown不符合Aspose.Words Document Object Model (DOM)文章中描述的DOM。然而，Aspose.Words 提供了自己的机制用于将 Markdown 文档转换为 DOM 并返回，以便我们可以成功地使用它们的元素，例如文本格式、表格、标题等。

本文介绍了如何将各种 markdown 功能转换为 Aspose.Words DOM 并转换回 Markdown 格式。

翻译 Markdown – DOM – Markdown 的复杂性

这种机制的主要难点不仅在于将Markdown转换为DOM，还在于进行反向转换–以最小的损失将文档保存回Markdown格式。有些元素（例如多级引号）的反向转换并非易事。

我们的翻译引擎不仅允许用户处理现有 Markdown 文档中的复杂元素，还允许用户从头开始使用原始结构创建自己的 Markdown 格式文档。要创建各种元素，您需要根据本文稍后描述的某些规则使用具有特定名称的样式。可以通过编程方式创建此类样式。

通用翻译原则

我们对内联块使用 Font 格式。当 Aspose.Words DOM 中的 Markdown 特征没有直接对应时，我们使用名称以某些特殊单词开头的字符样式。

对于容器块，我们使用样式继承来表示嵌套的 Markdown 功能。在这种情况下，即使没有嵌套功能，我们也会使用名称以某些特殊单词开头的段落样式。

项目符号列表和有序列表也是 Markdown 中的容器块。它们的嵌套在 DOM 中的表示方式与使用样式继承的所有其他容器块相同。然而，此外，DOM 中的列表在列表样式或段落格式中具有相应的数字格式。

内联块

我们在翻译 Bold、Italic 或 ~~删除线~~ 内联 markdown 功能时使用 Font 格式。

Markdown 功能	Aspose.Words
Bold `{1}`	`Font.bold = True`
`# Use a document builder to add content to the document. builder = aw.DocumentBuilder() # Make the text Bold. builder.font.bold = True builder.writeln("This text will be Bold") builder.document.save(docs_base.artifacts_dir + "WorkingWithMarkdown.bold_text_example.md")`
Italic `italic text`	`Font.italic = True`
`# Use a document builder to add content to the document. builder = aw.DocumentBuilder() # Make the text Italic. builder.font.italic = True builder.writeln("This text will be Italic") builder.document.save(docs_base.artifacts_dir + "WorkingWithMarkdown.italic_text_example.md")`
Strikethrough `~Strikethrough text~`	`Font.strike_through = True`
`# Use a document builder to add content to the document. builder = aw.DocumentBuilder() # Make the text Strikethrough. builder.font.strike_through = True builder.writeln("This text will be Strikethrough") builder.document.save(docs_base.artifacts_dir + "WorkingWithMarkdown.strikethrough_text_example.md")`

我们使用的字符样式的名称以 InlineCode 一词开头，后跟可选的点 (.) 和用于 InlineCode 功能的多个反引号 (`)。如果缺少多个反引号，则默认使用一个反引号。

Markdown 功能	Aspose.Words
InlineCode `{1}`	`Font.style_name = "InlineCode[.][N]"`
# Use a document builder to add content to the document. builder = aw.DocumentBuilder() # Number of backticks is missed, one backtick will be used by default. inlineCode1BackTicks = builder.document.styles.add(aw.StyleType.CHARACTER, "InlineCode") builder.font.style = inlineCode1BackTicks builder.writeln("Text with InlineCode style with 1 backtick") # There will be 3 backticks. inlineCode3BackTicks = builder.document.styles.add(aw.StyleType.CHARACTER, "InlineCode.3") builder.font.style = inlineCode3BackTicks builder.writeln("Text with InlineCode style with 3 backtick") builder.document.save(docs_base.artifacts_dir + "WorkingWithMarkdown.inline_code_example.md")
Autolink `<scheme://domain.com>` `<email@domain.com>`	FieldHyperlink 类。
`# Use a document builder to add content to the document. builder = aw.DocumentBuilder() # Insert hyperlink. builder.insert_hyperlink("https://www.aspose.com", "https://www.aspose.com", False); builder.insert_hyperlink("email@aspose.com", "mailto:email@aspose.com", False); builder.document.save(docs_base.artifacts_dir + "WorkingWithMarkdown.autolink_example.md")`
Link `{1}` `{2}` `{3}` `{4})`	FieldHyperlink
`# Use a document builder to add content to the document. builder = aw.DocumentBuilder() # Insert hyperlink. builder.insert_hyperlink("Aspose", "https://www.aspose.com", False) builder.document.save(docs_base.artifacts_dir + "WorkingWithMarkdown.link_example.md")`
Image `{1}` `{2}` `{3}` `{4})`	Shape 类。
`# Use a document builder to add content to the document. builder = aw.DocumentBuilder() # Insert image. shape = aw.drawing.Shape(builder.document, aw.drawing.ShapeType.IMAGE) shape.wrap_type = aw.drawing.WrapType.INLINE shape.image_data.source_full_name = "/attachment/1456/pic001.png" shape.image_data.title = "title" builder.insert_node(shape) builder.document.save(docs_base.artifacts_dir + "WorkingWithMarkdown.image_example.md")`

集装箱块

文档是一系列容器块，例如标题、段落、列表、引用等。容器块可以分为两类：叶子块和复杂容器。叶块只能包含内联内容。复杂容器又可以包含其他容器块，包括叶块。

叶子块

下表显示了在 Aspose.Words 中使用 Markdown Leaf 块的示例：

Markdown 功能	Aspose.Words
HorizontalRule `-----`	这是一个简单的段落，具有相应的 HorizontalRule 形状： DocumentBuilder.insert_horizontal_rule()

ATX Heading `# H1, ## H2, ### H3…`	`ParagraphFormat.style_name = "Heading N"`，其中 (1<=N<=9)。这将被转换为内置样式，并且应该完全符合指定的模式（不允许使用后缀或前缀）。否则，它只是一个具有相应样式的常规段落。

Setext Heading `===`（如果标题级别为 1）， `---`（如果标题级别为 2）	`ParagraphFormat.style_name = "SetextHeading[some suffix]"`，基于`"Heading N"`风格。如果 (N >= 2)，则将使用 `"Heading 2"`，否则使用 `"Heading 1"`。允许任何后缀，但 Aspose.Words 导入器分别使用数字"1"和"2"。
# Use a document builder to add content to the document. doc = aw.Document() builder = aw.DocumentBuilder(doc) builder.paragraph_format.style_name = "Heading 1" builder.writeln("This is an H1 tag") # Reset styles from the previous paragraph to not combine styles between paragraphs. builder.font.bold = False builder.font.italic = False setexHeading1 = doc.styles.add(aw.StyleType.PARAGRAPH, "SetexHeading1") builder.paragraph_format.style = setexHeading1 doc.styles.get_by_name("SetexHeading1").base_style_name = "Heading 1" builder.writeln("Setex Heading level 1") builder.paragraph_format.style = doc.styles.get_by_name("Heading 3") builder.writeln("This is an H3 tag") # Reset styles from the previous paragraph to not combine styles between paragraphs. builder.font.bold = False builder.font.italic = False setexHeading2 = doc.styles.add(aw.StyleType.PARAGRAPH, "SetexHeading2") builder.paragraph_format.style = setexHeading2 doc.styles.get_by_name("SetexHeading2").base_style_name = "Heading 3" # Setex heading level will be reset to 2 if the base paragraph has a Heading level greater than 2. builder.writeln("Setex Heading level 2") builder.document.save(docs_base.artifacts_dir + "WorkingWithMarkdown.setext_heading_example.md")
Indented Code	`ParagraphFormat.style_name = "IndentedCode[some suffix]"`
`# Use a document builder to add content to the document. builder = aw.DocumentBuilder() indentedCode = builder.document.styles.add(aw.StyleType.PARAGRAPH, "IndentedCode") builder.paragraph_format.style = indentedCode builder.writeln("This is an indented code") builder.document.save(docs_base.artifacts_dir + "WorkingWithMarkdown.indented_code_example.md")`
Fenced Code ``` c# if () then else ```	`ParagraphFormat.style_name = "FencedCode[.][info string]"` `[.]` 和 `[info string]` 是可选的。
# Use a document builder to add content to the document. builder = aw.DocumentBuilder() fencedCode = builder.document.styles.add(aw.StyleType.PARAGRAPH, "FencedCode") builder.paragraph_format.style = fencedCode builder.writeln("This is an fenced code") fencedCodeWithInfo = builder.document.styles.add(aw.StyleType.PARAGRAPH, "FencedCode.C#") builder.paragraph_format.style = fencedCodeWithInfo builder.writeln("This is a fenced code with info string") builder.document.save(docs_base.artifacts_dir + "WorkingWithMarkdown.fenced_code_example.md")

复杂容器

下表显示了在 Aspose.Words 中使用 Markdown 复杂容器的示例：

Markdown 功能	Aspose.Words
Quote `> quote,` `>> nested quote`	`ParagraphFormat.style_name = "Quote[some suffix]"` 样式名称中的后缀是可选的，但 Aspose.Words 导入器使用有序数字 1、2、3、…。如果是嵌套引号。嵌套是通过继承的样式定义的。
# Use a document builder to add content to the document. doc = aw.Document() builder = aw.DocumentBuilder(doc) # By default a document stores blockquote style for the first level. builder.paragraph_format.style_name = "Quote" builder.writeln("Blockquote") # Create styles for nested levels through style inheritance. quoteLevel2 = doc.styles.add(aw.StyleType.PARAGRAPH, "Quote1") builder.paragraph_format.style = quoteLevel2 doc.styles.get_by_name("Quote1").base_style_name = "Quote" builder.writeln("1. Nested blockquote") builder.document.save(docs_base.artifacts_dir + "WorkingWithMarkdown.quote_example.md")
BulletedList `- Item 1` `- Item 2` `- Item 2a` `- Item 2b`	项目符号列表使用段落编号表示： ListFormat.apply_bullet_default() 可以有 3 种类型的项目符号列表。它们仅在第一级编号格式上有所不同。它们分别是：`'-'`、`'+'` 或 `'*'`。
`# Use a document builder to add content to the document. builder = aw.DocumentBuilder() builder.list_format.apply_bullet_default() builder.list_format.list.list_levels[0].number_format = "-" builder.writeln("Item 1") builder.writeln("Item 2") builder.list_format.list_indent() builder.writeln("Item 2a") builder.writeln("Item 2b") builder.document.save(docs_base.artifacts_dir + "WorkingWithMarkdown.bulleted_list_example.md")`
OrderedList `1. Item 1` `2. Item 2` `1) Item 2a` `2) Item 2b`	有序列表使用段落编号表示： ListFormat.apply_number_default() 可以有 2 种数字格式标记：`'.'` 和 `')'`。默认标记为 `'.'`。
`doc = aw.Document() builder = aw.DocumentBuilder(doc) builder.list_format.apply_number_default() builder.writeln("Item 1") builder.writeln("Item 2") builder.list_format.list_indent() builder.writeln("Item 2a") builder.write("Item 2b") builder.document.save(docs_base.artifacts_dir + "WorkingWithMarkdown.ordered_list_example.md")`

表格

Aspose.Words还允许将表格翻译成DOM，如下所示：

Markdown 功能 Aspose.Words

Table
一个\ | b
-\ | -
c\ | d Table、Row 和 Cell 类。

Markdown 功能	Aspose.Words
`Table` `一个\ \| b` `-\ \| -` `c\ \| d`	Table、Row 和 Cell 类。
`# Use a document builder to add content to the document. builder = aw.DocumentBuilder() # Add the first row. builder.insert_cell() builder.writeln("a") builder.insert_cell() builder.writeln("b") builder.end_row() # Add the second row. builder.insert_cell() builder.writeln("c") builder.insert_cell() builder.writeln("d") builder.end_table() builder.document.save(docs_base.artifacts_dir + "WorkingWithMarkdown.ordered_list_table.md")`

# Use a document builder to add content to the document.
builder = aw.DocumentBuilder()

# Add the first row.
builder.insert_cell()
builder.writeln("a")
builder.insert_cell()
builder.writeln("b")
builder.end_row()

# Add the second row.
builder.insert_cell()
builder.writeln("c")
builder.insert_cell()
builder.writeln("d")
builder.end_table()

builder.document.save(docs_base.artifacts_dir + "WorkingWithMarkdown.ordered_list_table.md")

也可以看看

使用 Markdown 功能

Aspose.Words DOM Python 中的文档生成器概述