Markdown 機能の使用

このトピックでは、Aspose.Words を使用して Markdown 機能を実装する方法について説明します。 Markdown は、HTML に簡単に変換できるプレーン テキストをフォーマットする簡単な方法です。 Aspose.Words は次の Markdown 機能をサポートしています。

• 見出し
• ブロック引用符
• 横罫線
• 太字で強調
• イタリック体の強調

Markdown 機能の実装は、Aspose.Words API の CommonMark 仕様にほとんど準拠しており、すべての機能は対応するスタイルまたは直接書式設定として表されます。つまり、

• 太字と斜体は Font.bold と Font.Italic として表されます。
• 見出しは、見出し 1 ～ 見出し 6 のスタイルを持つ段落です。
• 引用は、スタイル名に「引用」が含まれる段落です。
• 水平ルールは、水平ルール形状の段落です。

Markdown から Document Object Model (DOM) への変換 の記事で説明されているように、Markdown から Aspose.Words Document Object Model (DOM) への変換には微妙な違いがあります。

強調を含む Markdown ドキュメント

このセクションでは、以下のような強調を使用して markdown ドキュメントを作成する方法を説明します。

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

次のコード スニペットを使用して、上記の markdown ドキュメントを作成できます。

# 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 ドキュメント

このセクションでは、以下のような見出しを持つ markdown ドキュメントを作成する方法を説明します。

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

次のコード スニペットを使用して、上記の markdown ドキュメントを作成できます。

# 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 ドキュメント

このセクションでは、以下に示すようにブロック引用符を含む markdown ドキュメントを作成する方法を説明します。

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
>

次のコード スニペットを使用して、上記の markdown ドキュメントを作成できます。

# 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ドキュメント

このセクションでは、以下に示す水平罫線を使用して markdown ドキュメントを作成する方法を説明します。

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

次のコード スニペットを使用して、上記の markdown ドキュメントを作成できます。

# 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")

Markdown ドキュメントを読む

次のコード スニペットは、markdown ドキュメントを読み取る方法を示しています。

# 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")

Markdown 保存オプションの指定

Aspose.Words API は、ドキュメントを Markdown 形式で保存する際に追加のオプションを指定するための MarkdownSaveOptions クラスを提供します。

次のコード例は、さまざまな Markdown 保存オプションを指定する方法を示しています。

# 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")

Markdown へのエクスポート中にテーブル内のコンテンツを整列する方法

Aspose.Words API は、Markdown ドキュメントにエクスポートする際にテーブル内のコンテンツを整列させるための整列方向を定義する TableContentAlignment 列挙を提供します。次のコード例は、テーブル内のコンテンツを整列する方法を示しています。

# 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)