Traduzir Markdown para Document Object Model (DOM)

Para ler, manipular e modificar programaticamente o conteúdo e a formatação de um documento, é necessário traduzi-lo para o modelo de objeto de documento Aspose.Words (DOM).

Em contraste com os documentos do Word, Markdown não está em conformidade com o DOM descrito no Aspose.Words Modelo De Objecto Do Documento (DOM) artigo. No entanto, Aspose.Words fornece seu próprio mecanismo para traduzir Markdown documentos para DOM e vice-versa, para que possamos trabalhar com sucesso com seus elementos, como formatação de texto, tabelas, cabeçalhos e outros.

Este artigo explica como as várias características markdown podem ser traduzidas para o formato Aspose.Words DOM e de volta para o formato Markdown.

Complexidade da tradução Markdown – DOM – Markdown

A principal dificuldade deste mecanismo não é apenas traduzir Markdown para DOM, mas também fazer a transformação inversa – salvar o documento de volta ao formato Markdown com perda mínima. Existem elementos, como aspas multiníveis, para os quais a transformação inversa não é trivial.

Nosso mecanismo de Tradução permite que os usuários não apenas trabalhem com elementos complexos em um documento Markdown existente, mas também criem seu próprio documento no formato Markdown com a estrutura original do zero. Para criar vários elementos, você precisa usar estilos com nomes específicos de acordo com certas regras descritas posteriormente neste artigo. Esses estilos podem ser criados programaticamente.

Princípios Comuns De Tradução

Usamos formatação Font para blocos embutidos. Quando não há correspondência direta para um recurso Markdown em Aspose.Words DOM, usamos um estilo de caractere com um nome que começa com algumas palavras especiais.

Para blocos de contêiner, usamos herança de estilo para denotar recursos Markdown aninhados. Nesse caso, mesmo quando não há recursos aninhados, também usamos estilos de parágrafo com um nome que começa com algumas palavras especiais.

As listas com marcadores e ordenadas também são blocos de contentores em Markdown. Seu aninhamento é representado em DOM da mesma forma que para todos os outros blocos de contêiner usando herança de estilo. No entanto, além disso, as listas em DOM têm formatação numérica correspondente no estilo de lista ou formatação de parágrafo.

Blocos Em Linha

Usamos a formatação Font ao traduzir os recursos Bold, Italic ou Strikethrough inline markdown.

Markdown recurso Aspose.Words
Bold
**bold text**
Font.Bold = true
// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Java
// Use a document builder to add content to the document.
DocumentBuilder builder = new DocumentBuilder();
// Make the text Bold.
builder.getFont().setBold(true);
builder.writeln("This text will be Bold");
Italic
*italic text*
Font.Italic = true
// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Java
// Use a document builder to add content to the document.
DocumentBuilder builder = new DocumentBuilder();
// Make the text Italic.
builder.getFont().setItalic(true);
builder.writeln("This text will be Italic");
Strikethrough
~Strikethrough text~
Font.StrikeThrough = true
// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Java
// Use a document builder to add content to the document.
DocumentBuilder builder = new DocumentBuilder();
// Make the text Strikethrough.
builder.getFont().setStrikeThrough(true);
builder.writeln("This text will be Strikethrough");

Usamos um estilo de caractere com um nome que começa a partir da palavra InlineCode, seguido por um ponto opcional (.) e um número de crases (`) para o recurso InlineCode. Se um número de crases for perdido, um crase será usado por padrão.

Markdown recurso Aspose.Words
InlineCode
**inline code**
Font.StyleName = "InlineCode[.][N]"
// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Java
// Use a document builder to add content to the document.
DocumentBuilder builder = new DocumentBuilder();
// Number of backticks is missed, one backtick will be used by default.
Style inlineCode1BackTicks = builder.getDocument().getStyles().add(StyleType.CHARACTER, "InlineCode");
builder.getFont().setStyle(inlineCode1BackTicks);
builder.writeln("Text with InlineCode style with 1 backtick");
// There will be 3 backticks.
Style inlineCode3BackTicks = builder.getDocument().getStyles().add(StyleType.CHARACTER, "InlineCode.3");
builder.getFont().setStyle(inlineCode3BackTicks);
builder.writeln("Text with InlineCode style with 3 backtick");
Autolink
<scheme://domain.com>
<email@domain.com>
A classe FieldHyperlink.
Link
[texto da ligação](url)
[texto da ligação](<url>"title")
[texto da ligação](url 'title')
[texto da ligação](url (title))
A classe FieldHyperlink.
Image
![](/words/java/translate-markdown-to-document-object-model/url)
![texto alternativo](/words/java/translate-markdown-to-document-object-model/<url>"title")
![texto alternativo](/words/java/translate-markdown-to-document-object-model/url ‘title’)
![texto alternativo](/words/java/translate-markdown-to-document-object-model/url (title))
A classe Shape.
// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Java
// Use a document builder to add content to the document.
DocumentBuilder builder = new DocumentBuilder();
// Insert image.
Shape shape = new Shape(builder.getDocument(), ShapeType.IMAGE);
shape.setWrapType(WrapType.INLINE);
shape.getImageData().setSourceFullName("/attachment/1456/pic001.png");
shape.getImageData().setTitle("title");
builder.insertNode(shape);

Blocos De Contentores

Um documento é uma sequência de blocos de contentores, tais como títulos, parágrafos, listas, citações e outros. Os blocos de contentores podem ser divididos em 2 classes: Blocos de folhas e contentores complexos. Os blocos folha só podem conter conteúdo embutido. Os contentores complexos, por sua vez, podem conter outros blocos de contentores, incluindo blocos de folhas.

Blocos De Folhas

A tabela abaixo mostra exemplos de utilização de Markdown Blocos de folhas em Aspose.Words:

Markdown recurso Aspose.Words
HorizontalRule
-----
Este é um parágrafo simples com uma forma HorizontalRule correspondente:
DocumentBuilder.InsertHorizontalRule()
// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Java
// Use a document builder to add content to the document.
DocumentBuilder builder = new DocumentBuilder();
// Insert horizontal rule.
builder.insertHorizontalRule();
ATX Heading
# H1, ## H2, ### H3…
ParagraphFormat.StyleName = "Heading N", onde (1<= N <= 9).
Isso é traduzido em um estilo embutido e deve ser exatamente do padrão especificado (não são permitidos sufixos ou prefixos).
Caso contrário, será apenas um parágrafo regular com um estilo correspondente.
// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Java
// Use a document builder to add content to the document.
DocumentBuilder builder = new DocumentBuilder();
// By default Heading styles in Word may have Bold and Italic formatting.
//If we do not want to be emphasized, set these properties explicitly to false.
builder.getFont().setBold(false);
builder.getFont().setItalic(false);
builder.getParagraphFormat().setStyleName("Heading 1");
builder.writeln("This is an H1 tag");
Setext Heading
=== (if Heading level 1),
--- (if Heading level 2)
ParagraphFormat.StyleName = "SetextHeading[some suffix]", com base no estilo' título N'.
Se (N > = 2), então ‘Heading 2’ será usado, caso contrário ‘Heading 1’.
Qualquer sufixo é permitido, mas o importador Aspose.Words utiliza os números “1” e “2” respectivamente.
// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Java
// Use a document builder to add content to the document.
DocumentBuilder builder = new DocumentBuilder();
builder.getParagraphFormat().setStyleName("Heading 1");
builder.writeln("This is an H1 tag");
// Reset styles from the previous paragraph to not combine styles between paragraphs.
builder.getFont().setBold(false);
builder.getFont().setItalic(false);
Style setexHeading1 = builder.getDocument().getStyles().add(StyleType.PARAGRAPH, "SetexHeading1");
builder.getParagraphFormat().setStyle(setexHeading1);
builder.getDocument().getStyles().get("SetexHeading1").setBaseStyleName("Heading 1");
builder.writeln("Setex Heading level 1");
builder.getParagraphFormat().setStyle(builder.getDocument().getStyles().get("Heading 3"));
builder.writeln("This is an H3 tag");
// Reset styles from the previous paragraph to not combine styles between paragraphs.
builder.getFont().setBold(false);
builder.getFont().setItalic(false);
Style setexHeading2 = builder.getDocument().getStyles().add(StyleType.PARAGRAPH, "SetexHeading2");
builder.getParagraphFormat().setStyle(setexHeading2);
builder.getDocument().getStyles().get("SetexHeading2").setBaseStyleName("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");
Indented Code
<br/>if ()<br/>then<br/>else<br/>```
ParagraphFormat.StyleName = "IndentedCode[some suffix]"
// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Java
// Use a document builder to add content to the document.
DocumentBuilder builder = new DocumentBuilder();
Style fencedCode = builder.getDocument().getStyles().add(StyleType.PARAGRAPH, "FencedCode");
builder.getParagraphFormat().setStyle(fencedCode);
builder.writeln("This is an fenced code");
Style fencedCodeWithInfo = builder.getDocument().getStyles().add(StyleType.PARAGRAPH, "FencedCode.C#");
builder.getParagraphFormat().setStyle(fencedCodeWithInfo);
builder.writeln("This is a fenced code with info string");

Contentores Complexos

A tabela abaixo mostra exemplos de utilização de Markdown contentores complexos em Aspose.Words:

Markdown recurso Aspose.Words
Quote
> quote,
>> nested quote
ParagraphFormat.StyleName = "Quote[some suffix]"
o sufixo no nome do estilo é opcional, mas Aspose.Words importador usa os números ordenados 1, 2, 3, …. no caso de citações aninhadas.
O aninhamento é definido através dos estilos herdados.
// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Java
// Use a document builder to add content to the document.
DocumentBuilder builder = new DocumentBuilder();
// By default a document stores blockquote style for the first level.
builder.getParagraphFormat().setStyleName("Quote");
builder.writeln("Blockquote");
// Create styles for nested levels through style inheritance.
Style quoteLevel2 = builder.getDocument().getStyles().add(StyleType.PARAGRAPH, "Quote1");
builder.getParagraphFormat().setStyle(quoteLevel2);
builder.getDocument().getStyles().get("Quote1").setBaseStyleName("Quote");
builder.writeln("1. Nested blockquote");
BulletedList
- Item 1
- Item 2
- Item 2a
- Item 2b
As listas com marcadores são representadas através da numeração de parágrafos:
ListFormat.ApplyBulletDefault()
podem existir 3 tipos de listas com marcadores. Eles são apenas diff em um formato de numeração do primeiro nível. Estes são: ‘-’, ‘+’ ou ‘*’ respectivamente.
// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Java
// Use a document builder to add content to the document.
DocumentBuilder builder = new DocumentBuilder();
builder.getListFormat().applyBulletDefault();
builder.getListFormat().getList().getListLevels().get(0).setNumberFormat("-");
builder.writeln("Item 1");
builder.writeln("Item 2");
builder.getListFormat().listIndent();
builder.writeln("Item 2a");
builder.writeln("Item 2b");
OrderedList
1. Item 1
2. Item 2
1) Item 2a
2) Item 2b
As listas ordenadas são representadas através da numeração de parágrafos:
ListFormat.ApplyNumberDefault()
pode haver 2 marcadores de formato numérico: ‘.’ e ‘)’. O marcador predefinido é ‘.’.
// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Java
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.getListFormat().applyBulletDefault();
builder.getListFormat().getList().getListLevels().get(0).setNumberFormat(MessageFormat.format("{0}.", (char)0));
builder.getListFormat().getList().getListLevels().get(1).setNumberFormat(MessageFormat.format("{0}.", (char)1));
builder.writeln("Item 1");
builder.writeln("Item 2");
builder.getListFormat().listIndent();
builder.writeln("Item 2a");
builder.writeln("Item 2b");

Quadros

Aspose.Words também permite traduzir tabelas em DOM, Como mostrado abaixo:

Markdown recurso Aspose.Words
Table
a|b
-|-
c|d
Table, Row e Cell classes.
// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Java
// Use a document builder to add content to the document.
DocumentBuilder builder = new DocumentBuilder();
// Add the first row.
builder.insertCell();
builder.writeln("a");
builder.insertCell();
builder.writeln("b");
// Add the second row.
builder.insertCell();
builder.writeln("c");
builder.insertCell();
builder.writeln("d");

Ver Também