Преобразовать Markdown в объектную модель документа (DOM)

Чтобы программно считывать содержимое и форматирование документа, манипулировать им и изменять их, вам необходимо преобразовать его в объектную модель документа Aspose.Words (DOM).

В отличие от документов Word, Markdown не соответствует DOM, описанному в объектной модели документа Aspose.Words (DOM). статья. Однако Aspose.Words предоставляет свой собственный механизм для перевода документов Markdown в документы DOM и обратно, так что мы можем успешно работать с их элементами, такими как форматирование текста, таблицы, заголовки и другие.

В этой статье объясняется, как различные функции markdown могут быть переведены в формат Aspose.Words DOM и обратно в формат Markdown.

Сложность перевода Markdown – DOM – Markdown

Основная сложность этого механизма заключается не только в преобразовании Markdown в DOM, но и в выполнении обратного преобразования – сохранении документа обратно в формат Markdown с минимальными потерями. Существуют элементы, такие как многоуровневые кавычки, для которых обратное преобразование нетривиально.

Наш механизм перевода позволяет пользователям не только работать со сложными элементами в существующем документе Markdown, но и создавать свой собственный документ в формате Markdown с оригинальной структурой с нуля. Для создания различных элементов вам необходимо использовать стили с определенными названиями в соответствии с определенными правилами, описанными далее в этой статье. Такие стили могут быть созданы программно.

Общие принципы перевода

Мы используем форматирование Font для встроенных блоков. Когда нет прямого соответствия для элемента Markdown в Aspose.Words DOM, мы используем стиль символов с названием, которое начинается с некоторых специальных слов.

Для контейнерных блоков мы используем наследование стилей для обозначения вложенных объектов Markdown. В этом случае, даже если вложенных объектов нет, мы также используем стили абзацев с именами, которые начинаются с некоторых специальных слов.

Маркированные и упорядоченные списки также являются контейнерными блоками в Markdown. Их вложенность в DOM представлена таким же образом, как и для всех других контейнерных блоков, с использованием наследования стиля. Однако, кроме того, списки в DOM имеют соответствующее числовое оформление либо в виде списка, либо в виде абзаца.

Встроенные блоки

Мы используем форматирование Font при переводе Bold, Italic или Strikethrough встроенных функций markdown.

Markdown особенность	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");

Мы используем стиль символов с именем, начинающимся со слова InlineCode, за которым следует необязательная точка (.) и несколько обратных меток (`) для элемента InlineCode. Если пропущено несколько обратных меток, то по умолчанию будет использоваться одна обратная метка.

Markdown особенность	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> <[e-mail]>	Класс FieldHyperlink.
// 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 hyperlink. builder.insertHyperlink("https://www.aspose.com", "https://www.aspose.com", false); builder.insertHyperlink("[e-mail]", "mailto:[e-mail]", false);
Link [текст ссылки](url) [текст ссылки](<url>"title") [текст ссылки](url 'title') [текст ссылки](url (title))	Класс FieldHyperlink.
// 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 hyperlink. builder.insertHyperlink("Aspose", "https://www.aspose.com", false);
Image  ![альтернативный текст](/words/java/translate-markdown-to-document-object-model/<url>"title")  )	Класс 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);

Контейнерные блоки

Документ представляет собой последовательность блоков-контейнеров, таких как заголовки, абзацы, списки, цитаты и другие. Блоки-контейнеры можно разделить на 2 класса: конечные блоки и сложные контейнеры. Конечные блоки могут содержать только встроенное содержимое. Сложные контейнеры, в свою очередь, могут содержать другие блоки контейнеров, включая конечные блоки.

Листовые блоки

В таблице ниже приведены примеры использования конечных блоков Markdown в Aspose.Words:

Markdown особенность	Aspose.Words
HorizontalRule -----	Это простой абзац с соответствующей формой HorizontalRule: 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", где (1<= N <= 9). Это переводится во встроенный стиль и должно точно соответствовать указанному шаблону (суффиксы и префиксы не допускаются). В противном случае это будет просто обычный абзац с соответствующим стилем.
// 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]", основанный на стиле “Заголовок N”. Если (N >= 2), то будет использоваться “Heading 2”, в противном случае “Heading 1”. Допускается использование любого суффикса, но Aspose.Words импортер использует цифры “1” и “2” соответственно.
// 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");

Сложные контейнеры

В таблице ниже приведены примеры использования Markdown сложных контейнеров в Aspose.Words:

Markdown особенность	Aspose.Words
Quote > quote, >> nested quote	ParagraphFormat.StyleName = "Quote[some suffix]" Суффикс в названии стиля необязателен, но Aspose.Words импортер использует упорядоченные номера 1, 2, 3, …. в случае вложенных кавычек. Вложенность определяется с помощью унаследованных стилей.
// 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	Маркированные списки представлены с использованием нумерации абзацев: ListFormat.ApplyBulletDefault() Маркированные списки могут быть трех типов. Они различаются только в формате нумерации самого первого уровня. Это: ‘-’, ‘+’ или ‘*’ соответственно.
// 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	Упорядоченные списки представлены с использованием нумерации абзацев: ListFormat.ApplyNumberDefault() Может быть 2 маркера числового формата: ‘.’ и ‘)’. По умолчанию используется маркер ‘.’.
// 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");

Таблицы

Aspose.Words также позволяет преобразовать таблицы в DOM, как показано ниже:

Markdown особенность	Aspose.Words
Table a|b -|- c|d	классы Table, Row и Cell.
// 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");

Смотрите также

• Работа с Markdown функциями