Arbeiten mit Markdown-Funktionen

In diesem Thema wird erläutert, wie Markdown-Funktionen mithilfe von Aspose.Words implementiert werden. Markdown ist eine einfache Möglichkeit, einfachen Text zu formatieren, der leicht in HTML konvertiert werden kann. Aspose.Words unterstützt die folgenden Markdown-Funktionen:

• Überschriften
• Block Zitate
• Horizontale Regeln
• Fette Betonung
• Kursive Hervorhebung

Die Markdown-Funktionsimplementierung folgt größtenteils der CommonMark-Spezifikation in Aspose.Words API und alle Funktionen werden als entsprechende Stile oder direkte Formatierung dargestellt. Was bedeutet, dass

• Fett und Kursiv werden als Font.bold und Font.Italic dargestellt
• Überschriften sind Absätze mit den Stilen Überschrift 1 - Überschrift 6
• Zitate sind Absätze mit “Zitat” im Stilnamen
• HorizontalRule ist ein Absatz mit der Form “HorizontalRule”.

Es gibt Nuancen bei der Übersetzung von Markdown in Aspose.Words Document Object Model (DOM), die im Artikel Übersetzen Sie Markdown in Document Object Model (DOM) beschrieben werden.

Markdown-Dokument mit Schwerpunkten

In diesem Abschnitt erfahren Sie, wie Sie ein markdown-Dokument mit den folgenden Schwerpunkten erstellen:

Markdown treats asterisks (*) and underscores (_) as indicators of emphasis.
You can write **bold** or *italic* text. 
You can also write ***BoldItalic*** text.

Mit dem folgenden Codeausschnitt kann das oben angegebene markdown-Dokument erstellt werden.

# For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Python-via-.NET
doc = aw.Document()
builder = aw.DocumentBuilder(doc)

builder.writeln("Markdown treats asterisks (*) and underscores (_) as indicators of emphasis.")
builder.write("You can write ")

builder.font.bold = True
builder.write("bold")

builder.font.bold = False
builder.write(" or ")

builder.font.italic = True
builder.write("italic")

builder.font.italic = False
builder.writeln(" text. ")

builder.write("You can also write ")
builder.font.bold = True

builder.font.italic = True
builder.write("BoldItalic")

builder.font.bold = False
builder.font.italic = False
builder.write("text.")

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

Markdown-Dokument mit Überschriften

In diesem Abschnitt erfahren Sie, wie Sie ein markdown-Dokument mit den folgenden Überschriften erstellen:

The following produces headings:
# Heading1
## Heading2
### Heading3
#### Heading4
##### Heading5
###### Heading6
# **Bold Heading1**

Mit dem folgenden Codeausschnitt kann das oben angegebene markdown-Dokument erstellt werden.

# For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Python-via-.NET
doc = aw.Document()
builder = aw.DocumentBuilder(doc)

# By default Heading styles in Word may have bold and italic formatting.
# If we do not want the text to be emphasized, set these properties explicitly to false.
builder.font.bold = False
builder.font.italic = False

builder.writeln("The following produces headings:")
builder.paragraph_format.style = doc.styles.get_by_name("Heading 1")
builder.writeln("Heading1")
builder.paragraph_format.style = doc.styles.get_by_name("Heading 2")
builder.writeln("Heading2")
builder.paragraph_format.style = doc.styles.get_by_name("Heading 3")
builder.writeln("Heading3")
builder.paragraph_format.style = doc.styles.get_by_name("Heading 4")
builder.writeln("Heading4")
builder.paragraph_format.style = doc.styles.get_by_name("Heading 5")
builder.writeln("Heading5")
builder.paragraph_format.style = doc.styles.get_by_name("Heading 6")
builder.writeln("Heading6")

# Note that the emphases are also allowed inside Headings.
builder.font.bold = True
builder.paragraph_format.style = doc.styles.get_by_name("Heading 1")
builder.writeln("Bold Heading1")

doc.save(docs_base.artifacts_dir + "WorkingWithMarkdown.headings.md")

Markdown-Dokument mit Blockzitaten

In diesem Abschnitt erfahren Sie, wie Sie ein markdown-Dokument mit Anführungszeichen wie unten angegeben erstellen:

We support blockquotes in Markdown:
>*Lorem*
>*ipsum*
>The quotes can be of any level and can be nested:
>>>Quote level 3
>>>
>>>>Nested quote level 4
>
>*Back to first level*
>### Headings are allowed inside Quotes
>

Mit dem folgenden Codeausschnitt kann das oben angegebene markdown-Dokument erstellt werden.

# For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Python-via-.NET
doc = aw.Document()
builder = aw.DocumentBuilder(doc)

builder.writeln("We support blockquotes in Markdown:")
    
builder.paragraph_format.style = doc.styles.get_by_name("Quote")
builder.writeln("Lorem")
builder.writeln("ipsum")
    
builder.paragraph_format.style = doc.styles.get_by_name("Normal")
builder.writeln("The quotes can be of any level and can be nested:")
    
quoteLevel3 = doc.styles.add(aw.StyleType.PARAGRAPH, "Quote2")
builder.paragraph_format.style = quoteLevel3
builder.writeln("Quote level 3")
    
quoteLevel4 = doc.styles.add(aw.StyleType.PARAGRAPH, "Quote3")
builder.paragraph_format.style = quoteLevel4
builder.writeln("Nested quote level 4")
    
builder.paragraph_format.style = doc.styles.get_by_name("Quote")
builder.writeln()
builder.writeln("Back to first level")
    
quoteLevel1WithHeading = doc.styles.add(aw.StyleType.PARAGRAPH, "Quote Heading 3")
builder.paragraph_format.style = quoteLevel1WithHeading
builder.write("Headings are allowed inside Quotes")

doc.save(docs_base.artifacts_dir + "WorkingWithMarkdown.block_quotes.md")

Markdown-Dokument mit horizontaler Regel

In diesem Abschnitt erfahren Sie, wie Sie ein markdown-Dokument mit der horizontalen Regel wie folgt erstellen:

We support Horizontal rules (Thematic breaks) in Markdown:
-----

Mit dem folgenden Codeausschnitt kann das oben angegebene markdown-Dokument erstellt werden.

# For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Python-via-.NET
builder = aw.DocumentBuilder()

builder.writeln("We support Horizontal rules (Thematic breaks) in Markdown:")
builder.insert_horizontal_rule()

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

Ein Markdown-Dokument lesen

Der folgende Codeausschnitt zeigt Ihnen, wie Sie ein markdown-Dokument lesen.

# For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Python-via-.NET
doc = aw.Document(docs_base.my_dir + "Quotes.md")

# Let's remove Heading formatting from a Quote in the very last paragraph.
paragraph = doc.first_section.body.last_paragraph
paragraph.paragraph_format.style = doc.styles.get_by_name("Quote")

doc.save(docs_base.artifacts_dir + "WorkingWithMarkdown.read_markdown_document.md")

Geben Sie Markdown-Speicheroptionen an

Aspose.Words API bietet eine MarkdownSaveOptions-Klasse zur Angabe zusätzlicher Optionen beim Speichern eines Dokuments im Markdown-Format.

Im folgenden Codebeispiel wurde gezeigt, wie verschiedene Markdown-Speicheroptionen angegeben werden.

# For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Python-via-.NET
doc = aw.Document()
builder = aw.DocumentBuilder(doc)

builder.writeln("Some text!")

doc.save(docs_base.artifacts_dir + "BaseConversions.docx_to_markdown.md")

So richten Sie Inhalte innerhalb der Tabelle beim Exportieren in Markdown aus

Aspose.Words API bietet eine TableContentAlignment-Aufzählung, die Ausrichtungsrichtungen definiert, um Inhalte in Tabellen beim Exportieren in das Markdown-Dokument auszurichten. Das folgende Codebeispiel zeigt, wie Inhalte innerhalb der Tabelle ausgerichtet werden.

# For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Python-via-.NET
doc = aw.Document()
builder = aw.DocumentBuilder(doc)

builder.insert_cell()
builder.paragraph_format.alignment = aw.ParagraphAlignment.RIGHT
builder.write("Cell1")
builder.insert_cell()
builder.paragraph_format.alignment = aw.ParagraphAlignment.CENTER
builder.write("Cell2")

# Makes all paragraphs inside the table to be aligned.
saveOptions = aw.saving.MarkdownSaveOptions()
    
saveOptions.table_content_alignment = aw.saving.TableContentAlignment.LEFT
    
doc.save(docs_base.artifacts_dir + "WorkingWithMarkdownSaveOptions.left_table_content_alignment.md", saveOptions)

saveOptions.table_content_alignment = aw.saving.TableContentAlignment.RIGHT
doc.save(docs_base.artifacts_dir + "WorkingWithMarkdownSaveOptions.right_table_content_alignment.md", saveOptions)

saveOptions.table_content_alignment = aw.saving.TableContentAlignment.CENTER
doc.save(docs_base.artifacts_dir + "WorkingWithMarkdownSaveOptions.center_table_content_alignment.md", saveOptions)

# The alignment in this case will be taken from the first paragraph in corresponding table column.
saveOptions.table_content_alignment = aw.saving.TableContentAlignment.AUTO
doc.save(docs_base.artifacts_dir + "WorkingWithMarkdownSaveOptions.auto_table_content_alignment.md", saveOptions)