Praca z funkcjami Markdown

W tym temacie omówiono sposób implementowania funkcji Markdown przy użyciu formatu Aspose.Words. Markdown to prosty sposób formatowania zwykłego tekstu, który można łatwo przekonwertować na format HTML. Aspose.Words obsługuje następujące funkcje Markdown:

• Nagłówki
• Cytaty blokowe
• Zasady horyzontalne
• Odważne podkreślenie
• Podkreślenie kursywą

Implementacja funkcji Markdown jest w większości zgodna ze specyfikacją CommonMark w formacie Aspose.Words API, a wszystkie funkcje są reprezentowane jako odpowiadające im style lub formatowanie bezpośrednie. Co oznacza że

• Pogrubienie i kursywa są reprezentowane jako Font.bold i Font.Italic
• Nagłówki to akapity ze stylami Nagłówek 1 - Nagłówek 6
• Cytaty to akapity zawierające słowo “Cytat” w nazwie stylu
• HorizontalRule to akapit o kształcie HorizontalRule.

Istnieją niuanse tłumaczenia Markdown na Aspose.Words Document Object Model (DOM), opisane w artykule Przetłumacz Markdown na Document Object Model (DOM).

Dokument Markdown z wyróżnieniami

W tej sekcji pokazano, jak utworzyć dokument markdown z wyróżnieniami podanymi poniżej:

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

Poniższy fragment kodu można wykorzystać do utworzenia powyższego dokumentu 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")

Dokument Markdown z nagłówkami

W tej sekcji pokazano, jak utworzyć dokument markdown z nagłówkami podanymi poniżej:

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

Poniższy fragment kodu można wykorzystać do utworzenia powyższego dokumentu 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")

Dokument Markdown z cytatami blokowymi

W tej sekcji pokazano, jak utworzyć dokument markdown z cudzysłowami blokowymi, jak podano poniżej:

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
>

Poniższy fragment kodu można wykorzystać do utworzenia powyższego dokumentu 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")

Dokument Markdown z linią poziomą

W tej sekcji pokazano, jak utworzyć dokument markdown z linią poziomą, jak podano poniżej:

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

Poniższy fragment kodu można wykorzystać do utworzenia powyższego dokumentu 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")

Czytanie dokumentu Markdown

Poniższy fragment kodu pokazuje, jak czytać dokument 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")

Określ opcje zapisywania Markdown

Aspose.Words API udostępnia klasę MarkdownSaveOptions umożliwiającą określenie dodatkowych opcji podczas zapisywania dokumentu w formacie Markdown.

Poniższy przykład kodu zademonstrował, jak określić różne opcje zapisywania 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")

Jak wyrównać zawartość tabeli podczas eksportowania do formatu Markdown

Aspose.Words API udostępnia wyliczenie TableContentAlignment, które definiuje kierunki wyrównania w celu wyrównania zawartości tabel podczas eksportu do dokumentu Markdown. Poniższy przykład kodu demonstruje, jak wyrównać zawartość wewnątrz tabeli.

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