Це команда pandoc, яку можна запустити в постачальнику безкоштовного хостингу OnWorks за допомогою однієї з наших численних безкоштовних робочих станцій, таких як Ubuntu Online, Fedora Online, онлайн емулятор Windows або онлайн емулятор MAC OS
ПРОГРАМА:
ІМ'Я
pandoc - загальний конвертер розмітки
СИНТАКСИС
пандок [опції] [вхідний файл]...
ОПИС
Pandoc — це бібліотека Haskell для перетворення з одного формату розмітки в інший, а
інструмент командного рядка, який використовує цю бібліотеку. Він може читати Markdown, CommonMark, PHP Markdown
Extra, GitHub-Flavored Markdown і (підмножини) Textile, reStructuredText, HTML, LaTeX,
Розмітка MediaWiki, розмітка TWiki, розмітка Haddock, OPML, режим організації Emacs, DocBook, txt2tags,
EPUB, ODT і Word docx; і він може писати звичайний текст, Markdown, CommonMark, PHP Markdown
Extra, GitHub-Flavored Markdown, reStructuredText, XHTML, HTML5, LaTeX (включаючи передачу
слайд-шоу), ConTeXt, RTF, OPML, DocBook, OpenDocument, ODT, Word docx, GNU Texinfo,
Розмітка MediaWiki, розмітка DokuWiki, розмітка Haddock, EPUB (v2 або v3), FictionBook2, Textile,
сторінки керівництва groff, режим організації Emacs, AsciiDoc, InDesign ICML і Slidy, Slideous, DZSlides,
HTML-шоу S5 або SXNUMX. Він також може виводити PDF у системах, де LaTeX,
Встановлено ConTeXt або wkhtmltopdf.
Розширена версія Markdown від Pandoc включає синтаксис для виносок, таблиць, гнучкий
впорядковані списки, списки визначень, блоковані кодові блоки, верхні і нижні індекси,
закреслення, блоки метаданих, автоматичний зміст, вбудована математика LaTeX, цитати,
і Markdown всередині блокових елементів HTML. (Ці покращення, описані нижче в розділі
Markdown Pandoc можна вимкнути за допомогою формату введення або виведення markdown_strict.)
На відміну від більшості існуючих інструментів для перетворення Markdown в HTML, які використовують регулярні вирази
заміни, pandoc має модульну конструкцію: складається з набору зчитувачів, які аналізують
тексту в заданому форматі і створюють власне представлення документа, а також набір
письменників, які перетворюють це рідне уявлення в цільовий формат. Таким чином, додавши an
Формат введення або виведення вимагає лише додавання пристрою для зчитування або запису.
Оскільки проміжне представлення документа pandoc менш виразне, ніж багато інших
формати, між якими він конвертує, не слід очікувати ідеального перетворення між кожним
формат і всі інші. Пандок намагається зберегти структурні елементи а
документ, але не деталі форматування, наприклад розмір полів. І деякі елементи документа,
такі як складні таблиці, можуть не вписуватися в просту модель документів pandoc. Хоча
конверсії з Markdown від pandoc у всі формати прагнуть бути ідеальними, конверсії з
можна очікувати, що формати, більш виразні, ніж Markdown pandoc, будуть з втратами.
використання пандок
Якщо ні вхідний файл вказано, вхід зчитується з stdin. В іншому випадку вхідні файли він має
об’єднані (з порожнім рядком між кожним) і використовуються як вхідні дані. Вихід переходить до stdout by
за замовчуванням (хоча вивести до stdout вимкнено для виводу odt, docx, epub та epub3
формати). Для виведення у файл використовуйте параметр -o:
pandoc -o output.html input.txt
За замовчуванням pandoc створює фрагмент документа, а не окремий документ із належним
верхній і нижній колонтитул. Щоб створити окремий документ, використовуйте прапор -s або --standalone:
pandoc -s -o output.html input.txt
Додаткову інформацію про те, як створюються окремі документи, див. у розділі Шаблони нижче.
Замість файлу може бути надано абсолютний URI. У цьому випадку pandoc отримає файл
вміст за допомогою HTTP:
pandoc -f html -t уцінка http://www.fsf.org
Якщо вказано кілька вхідних файлів, pandoc об’єднає їх усі (з пустими рядками
між ними) перед розбором. Ця функція вимкнена для форматів двійкового введення, наприклад
EPUB, odt і docx.
Формат введення та виводу можна вказати явно за допомогою параметрів командного рядка.
Формат введення можна вказати за допомогою параметрів -r/--read або -f/--from, вихід
форматування за допомогою параметрів -w/--write або -t/--to. Таким чином, конвертувати hello.txt з Markdown
до LaTeX, ви можете ввести:
pandoc -f markdown -t латекс hello.txt
Щоб перетворити hello.html з HTML у Markdown:
pandoc -f html -t уцінка hello.html
Підтримувані вихідні формати наведено нижче під параметром -t/--to. Підтримуваний вхід
формати наведені нижче під параметром -f/--from. Зверніть увагу, що по-перше, текстиль, латекс,
і HTML-читачі не повні; є деякі конструкції, які вони не аналізують.
Якщо формат введення або виведення не вказано явно, pandoc спробує його вгадати
з розширень імен вхідних і вихідних файлів. Таким чином, наприклад,
pandoc -o hello.tex hello.txt
перетворить hello.txt з Markdown в LaTeX. Якщо вихідний файл не вказано (так що
вихід йде до stdout), або якщо розширення вихідного файлу невідоме, вихідний формат
за замовчуванням буде HTML. Якщо вхідний файл не вказано (так що вхідні дані надходять з stdin), або
якщо розширення вхідних файлів невідомі, буде вважатися, що формат введення є таким
Уцінка, якщо не вказано явно.
Pandoc використовує кодування символів UTF-8 як для введення, так і для виведення. Якщо ваш місцевий
кодування символів не UTF-8, вам слід вводити та виводити через iconv:
iconv -t utf-8 input.txt | пандок | iconv -f utf-8
Зауважте, що в деяких вихідних форматах (наприклад, HTML, LaTeX, ConTeXt, RTF, OPML, DocBook та
Texinfo), інформація про кодування символів включена в заголовок документа,
який буде включено, лише якщо ви використовуєте параметр -s/--standalone.
створення a PDF
Щоб створити PDF-файл, укажіть вихідний файл із розширенням .pdf. За замовчуванням pandoc буде
використовуйте LaTeX, щоб конвертувати його в PDF:
pandoc test.txt -o test.pdf
Для виготовлення PDF-файлу потрібно встановити механізм LaTeX (див. --latex-engine, нижче),
і передбачає, що доступні наступні пакети LaTeX: amsfonts, amsmath, lm,
ifxetex, ifluatex, eurosym, listings (якщо використовується параметр --listings), fancyvrb,
longtable, booktabs, graphicx та grffile (якщо документ містить зображення), hyperref,
ulem, geometry (з набором змінних geometry), setspace (з linestretch) і babel
(з мовою). Використання xelatex або lualatex як двигуна LaTeX вимагає fontspec;
xelatex використовує mathspec, polyglossia (з lang), xecjk та bidi (зі змінною dir
набір). Використовуються пакети upquote та microtype, якщо вони доступні, а також csquotes
для розумної пунктуації, якщо додано до шаблону або включено в будь-який файл заголовка. The
Пакунки natbib, biblatex, bibtex і biber можна додатково використовувати для цитування
надання. Вони включені в усі останні версії TeX Live.
Крім того, pandoc може використовувати ConTeXt або wkhtmltopdf для створення PDF-файлу. Для цього вкажіть
вихідний файл із розширенням .pdf, як і раніше, але додайте -t контекст або -t html5 до
command line.
Виводом PDF можна керувати за допомогою змінних для LaTeX (якщо використовується LaTeX) і змінних
для ConTeXt (якщо використовується ConTeXt). Якщо використовується wkhtmltopdf, то змінні margin-left,
margin-right, margin-top, margin-bottom і papersize також впливатимуть на вихід
--css.
ВАРІАНТИ
Загальне опції
-f ФОРМАТ, -r ФОРМАТ, --з=ФОРМАТ, --читати=ФОРМАТ
Вкажіть формат введення. ФОРМАТ може бути нативним (нативний Haskell), json (версія JSON
нативний AST), markdown (розширений Markdown Pandoc), markdown_strict (оригінал
нерозширений Markdown), markdown_phpextra (PHP Markdown Extra), markdown_github
(GitHub-Flavored Markdown), commonmark (CommonMark Markdown), текстиль (Textile),
rst (reStructuredText), html (HTML), docbook (DocBook), t2t (txt2tags), docx
(docx), odt (ODT), epub (EPUB), opml (OPML), org (режим Emacs Org), mediawiki
(розмітка MediaWiki), twiki (розмітка TWiki), пікша (розмітка пікша) або латекс
(LaTeX). Якщо +lhs додається до markdown, rst, latex або html, вхід буде
розглядається як грамотне джерело Haskell: див. Підтримка грамотного Haskell нижче. Уцінка
Розширення синтаксису можна окремо ввімкнути або вимкнути, додавши +EXTENSION
або -EXTENSION до назви формату. Так, наприклад,
markdown_strict+footnotes+definition_lists — це сувора розмітка з виносками та
списки визначень увімкнено, а markdown-pipe_tables+hard_line_breaks — це pandoc
Уцінка без конвейерних таблиць і з жорсткими розривами рядків. Дивіться уцінку Pandoc,
нижче наведено список розширень та їх назви.
-t ФОРМАТ, -w ФОРМАТ, --до=ФОРМАТ, --write=ФОРМАТ
Вкажіть вихідний формат. ФОРМАТ може бути native (нативний Haskell), json (версія JSON
нативного AST), звичайний (звичайний текст), уцінка (розширена розмітка Pandoc),
markdown_strict (оригінальний нерозширений Markdown), markdown_phpextra (PHP Markdown
Extra), markdown_github (GitHub-Flavored Markdown), commonmark (CommonMark)
Markdown), rst (reStructuredText), html (XHTML), html5 (HTML5), latex (LaTeX),
beamer (LaTeX beamer слайд-шоу), контекст (ConTeXt), людина (groff man), mediawiki
(розмітка MediaWiki), dokuwiki (розмітка DokuWiki), текстиль (Textile), org (Emacs Org
режим), texinfo (GNU Texinfo), opml (OPML), docbook (DocBook), opendocument
(OpenDocument), odt (текстовий документ OpenOffice), docx (Word docx), пікша (Haddock
розмітка), rtf (формат форматованого тексту), epub (книга EPUB v2), epub3 (EPUB v3), fb2
(електронна книга FictionBook2), asciidoc (AsciiDoc), icml (InDesign ICML), slidy (Slidy HTML
та javascript слайд-шоу), slideous (слайд-шоу HTML і javascript),
dzslides (DZSlides HTML5 + javascript слайд-шоу), discoverjs (reveal.js HTML5 +
javascript слайд-шоу), s5 (S5 HTML та javascript слайд-шоу) або шлях a
користувацький редактор lua (див. Користувацькі записи нижче). Зверніть увагу, що odt, epub і epub3
вихід не буде спрямований на stdout; ім'я вихідного файлу необхідно вказати за допомогою
параметр -o/--output. Якщо +lhs додається до markdown, rst, latex, beamer, html,
або html5, вихідні дані будуть представлені як грамотне джерело Haskell: див
Підтримка Haskell, нижче. Розширення синтаксису Markdown можна ввімкнути окремо або
вимкнено, додавши +EXTENSION або -EXTENSION до назви формату, як описано
вище під -f.
-o Фото, --вихід=Фото
Записати вихід до Фото замість stdout. Якщо Фото є -, вихід піде до stdout.
(Виняток: якщо вихідним форматом є odt, docx, epub або epub3, вихід у stdout буде
вимкнено.)
--data-dir=ДОВІДНИК
Вкажіть каталог даних користувача для пошуку файлів даних pandoc. Якщо цей варіант є
не вказано, буде використано каталог даних користувача за замовчуванням. Це в Unix:
$HOME/.pandoc
в Windows XP:
C:\Documents And Settings\USERNAME\Application Data\pandoc
і в Windows Vista або новішої версії:
C:\Users\ІМ'Я КОРИСТУВАЧА\AppData\Roaming\pandoc
Ви можете знайти каталог даних користувача за замовчуванням у вашій системі, подивившись на
вихід pandoc --version. reference.odt, reference.docx, epub.css, шаблони,
каталог slidy, slideous або s5, розміщений у цьому каталозі, замінить каталог pandoc
нормальні значення за замовчуванням.
--bash-завершення
Створіть сценарій завершення bash. Щоб увімкнути завершення bash за допомогою pandoc, додайте це
до вашого .bashrc:
eval "$(pandoc --bash-completion)"
-багатослівний
Надайте докладний результат налагодження. Наразі це впливає лише на вихід PDF.
-v, -- версія
Версія для друку.
-h, --допомога
Показати повідомлення про використання.
читач опції
-Р, --parse-raw
Розбирати неперекладні HTML-коди та середовища LaTeX як необроблений HTML або LaTeX,
замість того, щоб ігнорувати їх. Впливає лише на введення HTML і LaTeX. Необроблений HTML може бути
надруковано в Markdown, reStructuredText, HTML, Slidy, Slideous, DZSlides, discover.js,
і вихід S5; необроблений LaTeX можна друкувати в Markdown, reStructuredText, LaTeX і
Контекстний висновок. За замовчуванням читачі пропускають неперекладні HTML-коди
і середовища LaTeX. (Зчитувач LaTeX дійсно проходить через неперекладний LaTeX
Команди, навіть якщо -R не вказано.)
-S, -- розумний
Створюйте друкарський правильний вихід, перетворюючи прямі лапки в фігурні,
--- до кращих тире, -- до тире та ... до крапок. Нерозривні пробіли є
вставляється після певних скорочень, наприклад "пан". (Примітка: цей параметр вибрано
автоматично, коли вихідний формат є латексним або контекстним, якщо --no-tex-ligatures
використовується. Це не впливає на введення латексу.)
--старі тире
Вибирає поведінку pandoc <= 1.8.2.1 для аналізу розумних тире: - перед цифрою
є тире, а -- це тире. Цей параметр вибирається автоматично для
текстильний вхід.
--base-header-level=НОМЕР
Вкажіть базовий рівень для заголовків (за замовчуванням 1).
--indented-code-class=КЛАСИ
Вкажіть класи для використання для блоків коду з відступом, наприклад, perl,numberLines або
haskell. Кілька класів можуть бути розділені пробілами або комами.
--default-image-extension=ПОШИРЕННЯ
Вкажіть розширення за замовчуванням, яке використовуватиметься, коли шляхи до зображень/URL-адреси не мають розширення. Це
дозволяє використовувати те саме джерело для форматів, які вимагають різних типів
зображення. Наразі ця опція стосується лише читачів Markdown та LaTeX.
--фільтр=ВИКОНАННЯ
Вкажіть виконуваний файл, який буде використовуватися як фільтр, який перетворює pandoc AST після
вхідні дані аналізуються і перед записом виводу. Виконуваний файл повинен читати JSON
з stdin і запишіть JSON у stdout. JSON має бути відформатований як власний pandoc
Вхід і вихід JSON. Ім'я вихідного формату буде передано фільтру
як перший аргумент. отже,
pandoc --filter ./caps.py -t латекс
еквівалентна
pandoc -t json | ./caps.py латекс | pandoc -f json -t латекс
Остання форма може бути корисною для налагодження фільтрів.
Фільтри можуть бути написані будь-якою мовою. Text.Pandoc.JSON експортує до JSONFilter
полегшити написання фільтрів у Haskell. Ті, хто воліє писати фільтри
python може використовувати модуль pandocfilters, який можна встановити з PyPI. Тут є також
бібліотеки фільтрів pandoc у PHP, perl і javascript/node.js.
Зауважте, що ВИКОНАННЯ буде шукатися в PATH користувача, а не в робочому
каталог, якщо каталог не надано. Якщо ви хочете запустити скрипт в робочому
каталогу, перед назві файлу поставте ./.
-M KEY[=VAL], --метадані=KEY[:VAL]
Встановіть поле метаданих KEY до вартості VAL. Значення, зазначене в командному рядку
замінює значення, зазначене в документі. Значення будуть аналізуватися як логічні значення YAML
або рядкові значення. Якщо значення не вказано, воно розглядатиметься як логічне значення
правда. Як і --variable, --metadata викликає встановлення змінних шаблону. Але на відміну від
--змінна, --metadata впливає на метадані основного документа (який є
доступний за допомогою фільтрів і може бути надрукований у деяких вихідних форматах).
-- нормалізувати
Нормалізуйте документ після читання: об’єднайте сусідні елементи Str або Emph, for
наприклад, і видаліть повторювані пробіли.
-p, --консервувати вкладки
Зберігати табуляції замість того, щоб перетворювати їх у пробіли (за замовчуванням). Зауважте, що це
впливатиме лише на вкладки в інтервалі буквального коду та в блоках коду; вкладки в звичайному тексті
будуть розглядатися як пробіли.
--tab-stop=НОМЕР
Вкажіть кількість пробілів на вкладці (за замовчуванням 4).
--track-changes=прийняти|відхилити|всі
Визначає, що робити з вставками та видаленнями, створеними програмою MS Word «Track
Зміни". приймає (за замовчуванням), вставляє всі вставки та ігнорує всі
видалення. відхилити вставляє всі видалення та ігнорує вставки. все вкладає в обидва
вставки та видалення, загорнуті в проміжки з класами вставки та видалення,
відповідно. Автор і час зміни вказано. все корисно для
сценарії: прийняття змін лише від певного рецензента, скажімо, або перед певним
дата. Цей параметр впливає лише на зчитувач docx.
--extract-media=DIR
Витягніть зображення та інші носії, що містяться в контейнері docx або epub, до шляху
DIR, створивши його, якщо необхідно, і налаштуйте посилання на зображення в документі таким чином
вони вказують на вилучені файли. Цей параметр стосується лише файлів docx та epub
читачі
Загальне письменник опції
-так, -- автономний
Створіть вихідні дані з відповідним верхнім і нижнім колонтитулами (наприклад, окремий HTML,
LaTeX або RTF файл, а не фрагмент). Цей параметр встановлюється автоматично для pdf,
epub, epub3, fb2, docx та odt.
--шаблон=Фото
Скористайтесь Фото як спеціальний шаблон для створеного документа. Має на увазі -- автономний.
Опис синтаксису шаблонів див. нижче. Якщо розширення немає
зазначено, буде додано розширення, відповідне записувачу, так що
--template=special шукає special.html для виведення HTML. Якщо шаблону немає
знайдено, pandoc шукатиме його у підкаталозі шаблонів даних користувача
каталог (див. --data-dir). Якщо цей параметр не використовується, шаблон за замовчуванням
буде використано відповідний для вихідного формату (див. -D/--print-default-template).
-V KEY[=VAL], --змінна=KEY[:VAL]
Встановіть змінну шаблону KEY до вартості VAL під час оформлення документа в
автономний режим. Зазвичай це корисно лише тоді, коли використовується параметр --template
щоб вказати спеціальний шаблон, оскільки pandoc автоматично встановлює змінні, які використовуються в
шаблони за замовчуванням. Якщо ні VAL вказано, ключу буде надано значення
правда.
-D ФОРМАТ, --print-default-template=ФОРМАТ
Роздрукуйте системний шаблон за замовчуванням для виводу ФОРМАТ. (Див. -t для списку
це можливо ФОРМАТs.) Шаблони в каталозі даних користувача ігноруються.
--print-default-data-file=Фото
Роздрукуйте файл даних системи за замовчуванням. Файли в каталозі даних користувача ігноруються.
--dpi=НОМЕР
Вкажіть значення dpi (точки на дюйм) для перетворення з пікселів у
дюйм/сантиметр і навпаки. За замовчуванням встановлено 96 dpi. Технічно правильно
термін буде ppi (пікселів на дюйм).
--wrap=[авто|немає|зберегти]
Визначте, як текст загорнутий у вихідні дані (вихідний код, а не відтворений
версія). З авто (за замовчуванням), pandoc намагатиметься перенести рядки в стовпець
ширина, визначена --columns (за замовчуванням 80). Якщо немає, pandoc не перенесе рядки
зовсім. За допомогою консервації pandoc спробує зберегти обгортку від
вихідний документ (тобто там, де є несемантичні нові рядки у вихідному коді, там
у виводі також будуть несемантичні нові рядки).
--не обгортання
Застарілий синонім для --wrap=none.
--стовпці=НОМЕР
Вкажіть довжину рядків у символах (для перенесення тексту). Це впливає лише на
згенерований вихідний код, а не макет на відтвореній сторінці.
--toc, --зміст
Включіть автоматично згенерований зміст (або, у випадку з латексом,
контекст, і, по-перше, інструкція для його створення) у вихідному документі. Це
параметр не впливає на вихідні дані man, docbook, slidy, slideous, s5, docx або odt.
--toc-depth=НОМЕР
Вкажіть кількість рівнів розділу, які потрібно включити в зміст. The
за замовчуванням дорівнює 3 (це означає, що заголовки рівня 1, 2 і 3 будуть перераховані в
зміст).
--без виділення
Вимикає підсвічування синтаксису для блоків коду та вбудованих, навіть якщо мова
надається атрибут.
--highlight-style=СТИЛЬ
Визначає стиль забарвлення, який буде використовуватися у виділеному вихідному коді. Варіанти є
pygments (за замовчуванням), kate, монохромний, еспресо, zenburn, пікша і танго.
Для отримання додаткової інформації про підсвічування синтаксису в pandoc див. Підсвічування синтаксису,
нижче.
-H Фото, --include-in-header=Фото
Включити вміст Фото, дослівно, в кінці заголовка. Це можна використовувати,
наприклад, щоб включити спеціальні CSS або javascript в документи HTML. Цей варіант
можна використовувати багаторазово для включення кількох файлів у заголовок. Вони будуть
включені в зазначений порядок. Має на увазі -- автономний.
-B Фото, --include-before-body=Фото
Включити вміст Фото, дослівно, на початку основної частини документа (напр
після тег у HTML або команда \begin{document} у LaTeX). Це може
використовуватися для включення панелей навігації або банерів у документи HTML. Цей варіант може
використовуватися багаторазово для включення кількох файлів. Вони будуть включені в замовлення
вказано. Має на увазі -- автономний.
-A Фото, --include-after-body=Фото
Включити вміст Фото, дослівно, в кінці основної частини документа (перед
тег у HTML або команда \end{document} у LaTeX). Цей варіант може бути
використовуватися багаторазово для включення кількох файлів. Вони будуть включені в замовлення
вказано. Має на увазі -- автономний.
Опції зачіпає конкретний письменники
-- автономний
Створіть окремий файл HTML без зовнішніх залежностей, використовуючи дані: URI для
включати вміст пов’язаних сценаріїв, таблиць стилів, зображень і відео. The
отриманий файл повинен бути «самодостатнім» у тому сенсі, що він не потребує зовнішнього
файли та відсутність доступу до мережі для належного відображення браузером. Цей варіант працює
тільки з вихідними форматами HTML, включаючи html, html5, html+lhs, html5+lhs, s5,
slidy, slideous, dzslides і discoverjs. Сценарії, зображення та таблиці стилів на
будуть завантажені абсолютні URL-адреси; ті за відносними URL-адресами будуть шукатися відносно
робочий каталог (якщо перший вихідний файл локальний) або відносно базового
URL (якщо перший вихідний файл віддалений). Обмеження: ресурси, які завантажуються
динамічно через JavaScript не можна включити; як результат,
--self-contained не працює з --mathjax, а деякі додаткові функції (наприклад
масштабування або нотатки доповідача) можуть не працювати в автономному «автономному» слайді discover.js
шоу.
--html-q-теги
Використовуйте теги для лапок у HTML.
--ascii
Використовуйте лише символи ascii у виводі. Наразі підтримується лише вихід HTML
(який використовує числові сутності замість UTF-8, коли вибрано цей параметр).
--довідкові посилання
Використовуйте посилання в стилі посилань, а не вбудовані посилання, у написанні Markdown або
reStructuredText. За замовчуванням використовуються вбудовані посилання.
--atx-заголовки
Використовуйте заголовки в стилі ATX у виводі Markdown та asciidoc. За замовчуванням використовується
заголовки в стилі setext для рівнів 1-2, а потім заголовки ATX.
--розділи
Розглядайте заголовки верхнього рівня як глави у вихідних даних LaTeX, ConTeXt і DocBook. Коли
клас документів LaTeX налаштований на звіт, книгу або мемуар, ця опція мається на увазі.
Якщо вихідний формат є beamer, заголовки верхнього рівня стануть \part{..}.
-N, --кількість розділів
Заголовки розділів чисел у вихідних даних LaTeX, ConTeXt, HTML або EPUB. За замовчуванням,
розділи не нумеруються. Розділи з ненумерованим класом ніколи не будуть пронумеровані,
навіть якщо вказано --number-sections.
--число-зміщення=НОМЕР[,НОМЕР,...]
Зміщення для заголовків розділів у виводі HTML (ігнорується в інших вихідних форматах). The
перший номер додається до номера розділу для заголовків верхнього рівня, другий для
заголовки другого рівня тощо. Так, наприклад, якщо ви хочете отримати перший верхній рівень
заголовок у вашому документі має бути пронумерований "6", вкажіть --number-offset=5. Якщо ти
документ починається із заголовка рівня 2, який потрібно пронумерувати «1.5», вкажіть
--число-зміщення=1,4. Зміщення за замовчуванням дорівнює 0. Має на увазі --number-sections.
--лігатури без тексу
Не використовуйте лігатури TeX для лапок, апострофів і тире (`...',
``..'', --, ---) під час написання чи читання LaTeX чи ConTeXt. Читаючи LaTeX, розберіть
символи `, ' і - буквально, а не розбір лігатур для цитат
позначки та тире. При написанні LaTeX або ConTeXt друкуйте лапки Unicode і
символи тире буквально, а не конвертувати їх у стандартний ASCII TeX
лігатури. Примітка: зазвичай --smart вибирається автоматично для LaTeX і ConTeXt
вихід, але його потрібно вказати явно, якщо вибрано --no-tex-ligatures. Якщо
ви використовуєте буквальні фігурні лапки, тире та три крапки у своєму джерелі, тоді ви можете
хочете використовувати --no-tex-лігатури без --smart.
--списки
Використовуйте пакет списків для блоків коду LaTeX
-я, --інкрементальний
Зробіть показ елементів списку в слайд-шоу поступово (один за одним). За замовчуванням є
щоб списки відображалися одночасно.
--slide-level=НОМЕР
Вказує, що заголовки із зазначеним рівнем створюють слайди (для beamer, s5,
slidy, slideous, dzslides). Заголовки вище цього рівня в ієрархії звикли
розділити слайд-шоу на частини; заголовки нижче цього рівня створюють підзаголовки
в межах слайда. За замовчуванням встановлюється рівень слайда на основі вмісту
документ; див. Структурування слайд-шоу.
--section-div
Загорніть секції теги (або теги в HTML5) та додавати ідентифікатори до
огородження (або ), а не сам заголовок. Див. Заголовок
ідентифікатори, нижче.
--email-obfuscation=none|javascript|посилання
Вкажіть метод обфускації посилань mailto: у HTML-документах. жоден не йде
mailto: посилання як вони є. javascript обфускує їх за допомогою javascript.
посилання обфускує їх, друкуючи їхні літери як десяткові чи шістнадцяткові
посилання на символи. За замовчуванням є javascript.
--ідентифікатор-префікс=STRING
Вкажіть префікс, який буде додано до всіх автоматично створених ідентифікаторів у HTML і
Виведення DocBook та номери виносок у виводі Markdown. Це корисно для
запобігання дублювання ідентифікаторів при генерації фрагментів для включення в інші
сторінок.
-T STRING, --title-prefix=STRING
Вказувати STRING як префікс на початку заголовка, який з’являється в HTML
заголовок (але не в заголовку, як він з’являється на початку тіла HTML).
Має на увазі -- автономний.
-c URL, --css=URL
Посилання на таблицю стилів CSS. Цю опцію можна використовувати багаторазово для включення
кілька файлів. Вони будуть включені в зазначеному порядку.
--reference-odt=Фото
Використовуйте вказаний файл як посилання на стиль під час створення ODT. Для найкращих результатів,
еталонний ODT має бути модифікованою версією ODT, створеної за допомогою pandoc.
Вміст довідкового ODT ігнорується, але його таблиці стилів використовуються в
новий ODT. Якщо в командному рядку не вказано посилання на ODT, відобразиться pandoc
для файлу reference.odt у каталозі даних користувача (див. --data-dir). Якщо це так
також не знайдено, будуть використані розумні значення за замовчуванням.
--reference-docx=Фото
Використовуйте вказаний файл як посилання на стиль під час створення файлу docx. На краще
У результаті довідковий файл docx має бути модифікованою версією створеного файлу docx
за допомогою pandoc. Вміст довідкового docx ігнорується, але його таблиці стилів
і використовуються властивості документа (включаючи поля, розмір сторінки, верхній і нижній колонтитул).
в новому документі docx. Якщо в командному рядку не вказано посилання docx, pandoc
шукатиме файл reference.docx у каталозі даних користувача (див. --data-dir).
Якщо це також не знайдено, будуть використані розумні значення за замовчуванням. Наступні стилі
використовуються pandoc: [параграф] Звичайний, Основний текст, Перший абзац, Компактний, Заголовок,
Підзаголовок, Автор, Дата, Анотація, Бібліографія, Заголовок 1, Заголовок 2, Заголовок 3,
Заголовок 4, Заголовок 5, Заголовок 6, Текст блоку, Текст виноски, Термін визначення,
Визначення, підпис, підпис таблиці, підпис зображення, малюнок, малюнок із підписом, TOC
Заголовок; [символ] Шрифт абзацу за замовчуванням, символ основного тексту, дослівний символ,
Посилання на виноски, гіперпосилання; [таблиця] Звичайна таблиця.
--epub-stylesheet=Фото
Використовуйте вказаний файл CSS для стилізації EPUB. Якщо таблиця стилів не вказана,
pandoc шукатиме файл epub.css у каталозі даних користувача (див. --data-dir).
Якщо його там не знайдено, будуть використані розумні значення за замовчуванням.
--epub-cover-image=Фото
Використовуйте вказане зображення як обкладинку EPUB. Рекомендується, щоб зображення було
менше 1000 пікселів у ширину та висоту. Зауважте, що у вихідному документі Markdown ви
також можна вказати зображення обкладинки в блоці метаданих YAML (див. Метадані EPUB нижче).
--epub-metadata=Фото
Знайдіть у зазначеному файлі XML метадані для EPUB. Файл повинен містити
серія елементів Dublin Core. Наприклад:
Творчі спільноти
es-AR
За замовчуванням pandoc включатиме такі елементи метаданих: (з
назва документа), (від авторів документа), (від
дата документа, яка має бути у форматі ISO 8601), (з яз
змінна, або, якщо не встановлено, локаль), і (а
випадково згенерований UUID). Будь-який з них може бути замінений елементами в
файл метаданих.
Примітка: якщо вихідним документом є Markdown, блок метаданих YAML у документі може
використовувати замість цього. Дивіться нижче в розділі Метадані EPUB.
--epub-embed-font=Фото
Вставте вказаний шрифт у EPUB. Цей параметр можна повторити для вставки
кілька шрифтів. Також можна використовувати символи підстановки: наприклад, DejaVuSans-*.ttf.
Однак, якщо ви використовуєте символи підстановки в командному рядку, не забудьте їх екранувати або поставити
ціле ім’я файлу в одинарних лапках, щоб запобігти їх інтерпретації
оболонка. Щоб використовувати вбудовані шрифти, вам потрібно буде додати такі оголошення, як
до вашого CSS (див. --epub-stylesheet):
@font-face {
сімейство шрифтів: DejaVuSans;
стиль шрифту: нормальний;
шрифт-шрифт: нормальний;
src:url("DejaVuSans-Regular.ttf");
}
@font-face {
сімейство шрифтів: DejaVuSans;
стиль шрифту: нормальний;
font-weight: bold;
src:url("DejaVuSans-Bold.ttf");
}
@font-face {
сімейство шрифтів: DejaVuSans;
стиль шрифту: курсив;
шрифт-шрифт: нормальний;
src:url("DejaVuSans-Oblique.ttf");
}
@font-face {
сімейство шрифтів: DejaVuSans;
стиль шрифту: курсив;
font-weight: bold;
src:url("DejaVuSans-BoldOblique.ttf");
}
body { font-family: "DejaVuSans"; }
--epub-chapter-level=НОМЕР
Укажіть рівень заголовка, на якому розділити EPUB на окремі файли «глави».
За замовчуванням розбивається на глави в заголовках рівня 1. Ця опція впливає лише на
внутрішній склад EPUB, а не розділи та розділи
відображаються користувачам. Деякі читачі можуть працювати повільно, якщо файли розділів завеликі,
тому для великих документів з кількома заголовками рівня 1 можна використовувати розділ
рівень 2 або 3.
--latex-engine=pdflatex|lualatex|xelatex
Використовуйте вказаний механізм LaTeX під час створення PDF-файлу. За замовчуванням є pdflatex.
Якщо двигун не знаходиться у вашому PATH, можна вказати повний шлях двигуна
тут.
--latex-engine-opt=STRING
Використовуйте вказаний рядок як аргумент командного рядка для latex-engine. Якщо використовується
кілька разів аргументи забезпечуються пробілами між ними. Зауважте, що ні
перевірка на наявність повторюваних параметрів виконана.
Цитата надання
--бібліографія=Фото
Установіть для поля бібліографії в метаданих документа значення Фото, переважаючи будь-яке значення
встановлюється в метаданих і обробляє цитування за допомогою pandoc-citeproc. (Це
еквівалент --metadata bibliography=FILE --filter pandoc-citeproc.) Якщо --natbib
або --biblatex також постачається, pandoc-citeproc не використовується, що робить це еквівалентним
до --metadata бібліографія=ФАЙЛ. Якщо ви наведете цей аргумент кілька разів, кожен
Фото буде додано до бібліографії.
--csl=Фото
Встановіть для поля csl в метаданих документа значення Фото, замінюючи будь-яке встановлене значення
метадані. (Це еквівалентно --metadata csl=FILE.) Цей параметр є лише
актуально з pandoc-citeproc.
--citation-abbreviations=Фото
Встановіть для поля скорочень цитат у метаданих документа значення Фото, переважна
будь-яке значення, встановлене в метаданих. (Це еквівалентно
--metadata citation-abbreviations=FILE.) Цей параметр актуальний лише для
pandoc-citeproc.
--натбіб
Використовуйте natbib для цитат у виводі LaTeX. Цей параметр не можна використовувати з
фільтр pandoc-citeproc або з виведенням PDF. Він призначений для використання у виробництві а
Файл LaTeX, який можна обробляти за допомогою bibtex.
--біблатекс
Використовуйте biblatex для цитат у вихідних даних LaTeX. Цей параметр не можна використовувати з
фільтр pandoc-citeproc або з виведенням PDF. Він призначений для використання у виробництві а
Файл LaTeX, який можна обробляти за допомогою bibtex або biber.
Математика надання in HTML
-m [URL], --latexmathml[=URL]
Використовуйте LaTeXMathML для відображення вбудованої математики TeX у виводі HTML. The URL слід вказати
до сценарію завантаження LaTeXMathML.js. Якщо URL не надано, посилання на
Буде вставлено LaTeXMathML.js на домашній сторінці LaTeXMathML.
--mathml[=URL]
Перетворіть TeX math на MathML (у docbook, а також html і html5). В автономному режимі
html, невеликий javascript (або посилання на такий скрипт, якщо a URL поставляється)
буде вставлено, що дозволяє переглядати MathML у деяких браузерах.
--jsmath[=URL]
Використовуйте jsMath для відображення вбудованої математики TeX у виводі HTML. The URL слід вказувати на
сценарій завантаження jsMath (наприклад, jsMath/easy/load.js); якщо надано, він буде пов’язаний
до в заголовку окремих документів HTML. Якщо URL не надається, немає посилання
до сценарію завантаження jsMath буде вставлено; потім надати автору
таке посилання в шаблоні HTML.
--mathjax[=URL]
Використовуйте MathJax для відображення вбудованої математики TeX у виводі HTML. The URL слід вказувати на
сценарій завантаження MathJax.js. Якщо URL не надано, посилання на CDN MathJax
буде вставлено.
--gladtex
Додайте математику TeX теги у виводі HTML. Потім їх можна обробити
gladTeX для створення посилань на зображення набірних формул.
--mimetex[=URL]
Відтворіть математику TeX за допомогою CGI-скрипту mimeTeX. Якщо URL не вказано, є
припускається, що сценарій знаходиться в /cgi-bin/mimetex.cgi.
--webtex[=URL]
Відтворюйте формули TeX за допомогою зовнішнього сценарію, який перетворює формули TeX на зображення.
Формула буде об’єднана з наданою URL-адресою. Якщо URL не зазначено,
буде використовуватися Google Chart API.
--katex[=URL]
Використовуйте KaTeX для відображення вбудованої математики TeX у виводі HTML. The URL слід вказати на
Скрипт завантаження katex.js. Якщо URL не надано, буде посилання на CDN KaTeX
вставлено.
--katex-stylesheet=URL
Команда URL має вказувати на таблицю стилів katex.css. Якщо цей параметр не вказано,
буде вставлено посилання на KaTeX CDN. Зауважте, що ця опція не означає
--катекс.
Опції та цінності обгортка scripts
--dump-args
Надрукувати інформацію про аргументи командного рядка до stdout, потім вийдіть. Цей варіант
призначений в основному для використання в сценаріях обгортки. Перший рядок виводу
містить ім'я вихідного файлу, зазначеного за допомогою параметра -o, або - (for
stdout), якщо вихідний файл не вказано. Решта рядків містять
аргументи командного рядка, по одному на рядок, у порядку їх появи. Ці не роблять
включати звичайні параметри pandoc та їх аргументи, але включати будь-які параметри
з'являється після роздільника -- у кінці рядка.
--ignore-args
Ігнорувати аргументи командного рядка (для використання в сценаріях обгортки). Звичайні варіанти pandoc
не ігноруються. Таким чином, наприклад,
pandoc --ignore-args -o foo.html -s foo.txt -- -e latin1
еквівалентна
pandoc -o foo.html -s
TEMPLATES
Коли використовується параметр -s/--standalone, pandoc використовує шаблон для додавання верхнього та нижнього колонтитулів
матеріал, необхідний для самостійного документа. Щоб побачити шаблон за замовчуванням, який є
використовується, просто введіть
pandoc -D *ФОРМАТ*
де ФОРМАТ це назва вихідного формату. Спеціальний шаблон можна вказати за допомогою
параметр --template. Ви також можете замінити шаблони системи за замовчуванням для певного
формат виводу ФОРМАТ шляхом розміщення файлу templates/default.*FORMAT* в даних користувача
каталог (див. --data-dir, вище). винятки: Для виведення odt налаштуйте параметр
шаблон default.opedocument. Для виведення pdf налаштуйте шаблон default.latex.
Шаблони містять змінні, які дозволяють включати довільну інформацію на будь-який
точку у файлі. Змінні можуть бути встановлені в документі за допомогою блоків метаданих YAML.
Їх також можна встановити в командному рядку за допомогою параметра -V/--variable: змінні, встановлені в
таким чином замінити поля метаданих з однаковою назвою.
Змінні комплект by пандок
Деякі змінні встановлюються автоматично за допомогою pandoc. Вони дещо відрізняються в залежності від
вихідний формат, але включають поля метаданих, а також наступне:
титул автор, дата
дозволяють ідентифікувати основні аспекти документа. Включено в метадані PDF
через LaTeX і ConTeXt. Їх можна встановити за допомогою заголовка pandoc, який
дозволяє використовувати кількох авторів або через блок метаданих YAML:
---
автор:
- Аристотель
- Пітер Абеляр
...
субтитр
субтитри документа, включені в HTML, EPUB, LaTeX, ConTeXt і Word docx; надає
в LaTeX лише при використанні класу документа, який підтримує \subtitle, наприклад beamer
або серії KOMA-Script (scrartcl, scrreprt, scrbook).
абстрактний
резюме документа, включене в LaTeX, ConTeXt, AsciiDoc і Word docx
ключові слова
список ключових слів для включення в метадані HTML, PDF та AsciiDoc; можливо
повторене як для автора, вище
заголовок включає
вміст, визначений -H/--include-in-header (може мати кілька значень)
ток ненульове значення, якщо вказано --toc/--contents
toc-title
назва змісту (працює тільки з EPUB і docx)
включити-перед
вміст, визначений -B/--include-before-body (може мати кілька значень)
включити-після
вміст, визначений -A/--include-after-body (може мати кілька значень)
тіло тіло документа
мета-json
JSON-подання всіх метаданих документа
Language змінні
яз визначає основну мову документа, використовуючи код згідно BCP 47
(наприклад, en або en-GB). Для деяких вихідних форматів pandoc перетворить його на файл
відповідний формат зберігається в додаткових змінних babel-lang, polyglossia-lang
(LaTeX) і контекстна мова (ConTeXt).
Можна використовувати власні pandoc spans і divs з атрибутом lang (значення в BCP 47)
щоб змінити мову в цьому діапазоні.
інші мови
список інших мов, які використовуються в документі в метаданих YAML, згідно з
BCP 47. Наприклад: otherlangs: [en-GB, fr]. Це генерується автоматично
з атрибутів lang у всіх діапазонах і div, але їх можна замінити. Наразі
використовується тільки LaTeX через згенеровані babel-otherlangs і
змінні polyglossia-otherlangs. Записувач LaTeX виводить команди поліглосії
текст, але змінна babel-newcommands містить зіставлення для них з
відповідний вавилон.
реж базовий напрямок документа, або rtl (справа наліво) або ltr
(зліва направо).
Для двонаправлених документів нативні pandoc spans і divs з атрибутом dir
(значення rtl або ltr) можна використовувати, щоб змінити основний напрямок у деяких виводах
формати. Це може бути не завжди необхідним, якщо кінцевий засіб візуалізації (наприклад, файл
браузер під час генерації HTML) підтримує двонаправлений алгоритм Unicode.
При використанні LaTeX для двонаправлених документів повністю працює лише механізм xelatex
підтримується (використовуйте --latex-engine=xelatex).
Змінні та цінності слайдах
Доступні змінні для створення слайд-шоу за допомогою pandoc, включаючи весь discover.js
параметри конфігурації.
slidy-url
базова URL-адреса для документів Slidy (за замовчуванням http://www.w3.org/Talks/Tools/Slidy2)
slideous-url
базова URL-адреса для документів Slideous (за замовчуванням – slideous)
s5-url базова URL-адреса для документів S5 (за замовчуванням – s5/за замовчуванням)
discoverjs-url
базова URL-адреса для документів discover.js (за замовчуванням – discover.js)
тема, колірна тема, тема шрифту, внутрішня тема, зовнішня тема
теми для документів LaTeX beamer
навігація
керує навігаційними символами в документах променів (за замовчуванням порожній для без навігації
символи; інші допустимі значення: рамка, вертикаль та горизонталь).
назви розділів
вмикає на «титульних сторінках» для нових розділів у документах променів (за замовчуванням = true).
Змінні та цінності LaTeX
Під час створення PDF-файлу використовуються змінні LaTeX.
розмір паперу
розмір паперу, наприклад Letter, A4
розмір шрифту
розмір шрифту основного тексту (наприклад, 10pt, 12pt)
клас документа
клас документа, наприклад, стаття, звіт, книга, спогади
класовий варіант
опція для класу документа, наприклад, одна сторона; може повторюватися для кількох варіантів
геометрія
параметр для пакета геометрії, наприклад margin=1in; може повторюватися для кількох варіантів
поле зліва, поле справа, margin-top, маржа-дно
встановлює поля, якщо геометрія не використовується (інакше геометрія замінює їх)
linestretch
налаштовує міжрядковий інтервал за допомогою пакета setspace, наприклад 1.25, 1.5
сімейство шрифтів
Пакет шрифтів для використання з pdflatex: TeX Live включає багато параметрів, задокументованих у
Каталог шрифтів LaTeX. За замовчуванням – латинська сучасна.
параметри сімейства шрифтів
параметри для пакета, що використовується як сімейство шрифтів: наприклад, osf,sc з fontfamily встановлено на
mathpazo забезпечує Палатіно старовинними фігурками та справжніми кепками; можливо
повторюється для кількох варіантів
основний шрифт, sansfont, моношрифт, математичний шрифт, Основний шрифт CJK
сімейства шрифтів для використання з xelatex або lualatex: візьміть назву будь-якого системного шрифту,
за допомогою пакета fontspec. Зауважте, що якщо використовується CJKmainfont, пакет xecjk
має бути доступним.
mainfontoptions, sansfontoptions, монофонтні параметри, математичні параметри, CJKoptions
варіанти використання з mainfont, sansfont, monofont, mathfont, CJKmainfont в xelatex
і луалатекс. Дозволити будь-який вибір, доступний через fontspec, наприклад
Функції OpenType Numbers=OldStyle,Numbers=Пропорційні. Може повторюватися для
кілька варіантів.
fontenc
дозволяє вказувати кодування шрифтів через пакет fontenc (з pdflatex);
за замовчуванням T1 (див. посібник із кодування шрифтів LaTeX)
кольорові посилання
додати колір до тексту посилання; автоматично вмикається, якщо будь-який з linkcolor, citecolor,
urlcolor або toccolor встановлені
колір посилання, citecolor, urlcolor, toccolor
колір для внутрішніх посилань, посилань на цитування, зовнішніх посилань та посилань у таблиці
вміст: використовує будь-який із попередньо визначених кольорів LaTeX
посилання-як-нотатки
призводить до друку посилань у вигляді виносок
відступ використовує налаштування класу документа для відступу (в іншому випадку шаблон LaTeX за замовчуванням
видаляє відступи та додає пробіл між абзацами)
підпункт
вимикає типову поведінку шаблону LaTeX, який перевизначає (під)абзаци як
розділів, змінюючи вигляд вкладених заголовків у деяких класах
Дякую вказує зміст виноски про подяку після назви документа.
ток включити зміст (також можна встановити за допомогою --toc/--table-of-contents)
заглиб
рівень розділу для включення до змісту
лоф, багато
включати список рисунків, список таблиць
бібліографія
бібліографію для використання для розв’язання посилань
бібліо-стилі
стиль бібліографії, якщо використовується з --natbib і --biblatex.
біблатексопції
список опцій для biblatex.
Змінні та цінності КОНТЕКСТ
розмір паперу
розмір паперу, наприклад Letter, A4, альбомна (див. ConTeXt Paper Setup); може повторюватися
для кількох варіантів
розташування параметри полів сторінки та розташування тексту (див. ConTeXt Layout); може повторюватися
для кількох варіантів
поле зліва, поле справа, margin-top, маржа-дно
встановлює поля, якщо макет не використовується (інакше макет замінює їх)
розмір шрифту
розмір шрифту основного тексту (наприклад, 10pt, 12pt)
основний шрифт, sansfont, моношрифт, математичний шрифт
сімейства шрифтів: візьміть назву будь-якого системного шрифту (див. Перемикання шрифтів ConTeXt)
колір посилання, контрастний колір
колір для посилань за межами та всередині сторінки, наприклад червоний, синій (див. колір ConTeXt)
стиль посилання
стиль шрифту для посилань, наприклад, звичайний, жирний, похилий, жирний нахилений, тип, шапка,
невеликий
відступ
керує відступами абзаців, наприклад, yes,small,next (див. Відступи ConTeXt);
може повторюватися для кількох варіантів
пробіл
інтервал між абзацами, наприклад, немає, малий (використовуючи setupwhitespace)
міжрядковий простір
налаштовує міжрядковий інтервал, наприклад 4ex (за допомогою setupinterlinespace); може бути повторений для
кілька варіантів
заголовний текст, нижній колонтитул
текст, який буде розміщено в поточному верхньому або нижньому колонтитулі (див. колонтитули ConTeXt);
можна повторювати до чотирьох разів для різного розміщення
нумерація сторінок
стиль номера сторінки та розташування (за допомогою нумерації сторінки налаштування); може бути повторений для
кілька варіантів
ток включити зміст (також можна встановити за допомогою --toc/--table-of-contents)
лоф, багато
включати список рисунків, список таблиць
Змінні та цінності людина сторінок
розділ
номер розділу на сторінках керівництва
заголовок заголовок на сторінках керівництва
нижній колонтитул нижній колонтитул на сторінках керівництва
коригування
коригує текст до лівого (l), правого (r), центру (c) або обох (b) полів
дефіс
якщо значення true (за замовчуванням), буде використовуватися перенос переносів
використання змінні in Шаблони
Назви змінних – це послідовності буквено-цифрових символів - і _, які починаються з літери. А
Ім'я змінної в оточенні знаків $ буде замінено її значенням. Наприклад,
рядок $title$ в
$title$
буде замінено на назву документа.
Щоб написати литерал $ у шаблоні, використовуйте $$.
Шаблони можуть містити умови. Синтаксис такий:
$if(змінна)$
X
$інакше$
Y
$endif$
Це включатиме X у шаблон, якщо змінна має ненульове значення; інакше буде
включають Y. X і Y є заповнювачами для будь-якого дійсного тексту шаблону і можуть включати
інтерпольовані змінні або інші умови. Розділ $else$ можна опустити.
Коли змінні можуть мати кілька значень (наприклад, автор у документі з кількома авторами),
ви можете використовувати ключове слово $for$:
$для(автора)$
$endfor$
За бажанням можна вказати роздільник, який буде використовуватися між послідовними елементами:
$for(author)$$author$$sep$, $endfor$
Крапкою можна вибрати поле змінної, яке приймає об’єкт як значення. Так,
Наприклад:
$author.name$ ($author.affiliation$)
Якщо ви використовуєте користувацькі шаблони, вам може знадобитися переглянути їх як pandoc зміни. Ми рекомендуємо
відстеження змін у шаблонах за замовчуванням та змінення власних шаблонів
відповідно. Простий спосіб зробити це – роздвоїти репозиторій pandoc-templates та об’єднати
у змінах після кожного випуску pandoc.
PANDOC'S УЦІНКА
Pandoc розуміє розширену та дещо перероблену версію Markdown Джона Грубера
синтаксису. Цей документ пояснює синтаксис, відзначаючи відмінності від стандартного Markdown.
Якщо не зазначено, ці відмінності можна придушити за допомогою markdown_strict
формат замість уцінки. Розширення можна ввімкнути, додавши +EXTENSION до
назву формату та вимкнено, додавши -EXTENSION. Наприклад, markdown_strict+foonotes є
суворий Markdown з увімкненими виноски, тоді як markdown-footnotes-pipe_tables є pandoc
Розцінка без приміток або таблиць.
філософія
Markdown розроблено так, щоб його було легко писати і, що ще важливіше, легко читати:
Відформатований у Markdown документ слід публікувати як є, як звичайний текст, без нього
виглядає так, ніби він позначений тегами або інструкціями з форматування. -- Джон
Грубер
Цей принцип керувався рішеннями pandoc щодо пошуку синтаксису для таблиць, виносок і
інші розширення.
Однак є одне значення, в якому цілі pandoc відрізняються від початкових цілей
від Markdown. Оскільки Markdown спочатку був розроблений з урахуванням генерації HTML,
pandoc розроблено для кількох вихідних форматів. Таким чином, у той час як pandoc дозволяє вбудовування
необробленого HTML, він відлякує його та надає інші, не HTML способи представлення
важливі елементи документа, такі як списки визначень, таблиці, математика та виноски.
Пункти
Абзац — це один або кілька рядків тексту, за якими слідують один або кілька порожніх рядків. Новий рядок
обробляються як пробіли, тож ви можете перекомпонувати абзаци за своїм бажанням. Якщо вам потрібен жорсткий
розрив рядка, поставте два або більше пробілів у кінці рядка.
Розширення: escaped_line_breaks
Зворотна коса риса, за якою слідує новий рядок, також є жорстким розривом рядка. Примітка: у багаторядковій та сітці
клітинки таблиці, це єдиний спосіб створити жорсткий розрив рядка, оскільки кінцеві пробіли в
клітинки ігноруються.
штирові роз'єми
Існує два види заголовків: Setext і ATX.
Settext-стиль Заголовки
Заголовок у стилі setext — це рядок тексту, «підкреслений» з рядком знаків = (для рівня
один заголовок) або знаки - (для заголовка другого рівня):
Заголовок першого рівня
==================
Заголовок другого рівня
------------------
Текст заголовка може містити вбудоване форматування, наприклад наголос (див. Вбудоване форматування,
нижче).
У стилі ATX Заголовки
Заголовок у стилі ATX складається з від одного до шести знаків # і рядка тексту, за бажанням якого слід
за будь-якою кількістю # знаків. Кількість # знаків на початку рядка дорівнює
рівень заголовка:
## Заголовок другого рівня
### Заголовок третього рівня ###
Як і заголовки в стилі setext, текст заголовка може містити форматування:
# Заголовок першого рівня із [link](/url) та *наголос*
Розширення: blank_before_header
Стандартний синтаксис Markdown не вимагає пустого рядка перед заголовком. Пандок робить
вимагати цього (крім, звичайно, на початку документа). Причина в
вимога полягає в тому, що дуже легко # опинитися на початку рядка
нещасний випадок (можливо, через перенесення рядків). Розглянемо, наприклад:
Мені подобаються кілька їхніх смаків морозива:
Наприклад, № 22 і № 5.
Header ідентифікатори
Розширення: атрибути_заголовка
Заголовкам можна призначати атрибути за допомогою цього синтаксису в кінці рядка, що містить
текст заголовка:
{#identifier .class .class ключ=значення ключ=значення}
Таким чином, наприклад, наступним заголовкам буде призначено ідентифікатор foo:
# Мій заголовок {#foo}
## Мій заголовок ## {#foo}
Мій інший заголовок {#foo}
---------------
(Цей синтаксис сумісний з PHP Markdown Extra.)
Зауважте, що хоча цей синтаксис дозволяє призначати класи та атрибути ключ/значення,
письменники зазвичай не використовують всю цю інформацію. Ідентифікатори, класи та ключ/значення
атрибути використовуються в форматах HTML і HTML, таких як EPUB і slidy. Ідентифікатори
використовуються для міток і прив'язок посилань у редакторах LaTeX, ConTeXt, Textile та AsciiDoc.
Заголовки з ненумерованим класом не будуть пронумеровані, навіть якщо --number-sections є
вказано. Один дефіс (-) в контексті атрибута еквівалентний .unnumbered і
бажано в неангломовних документах. Так,
# Мій заголовок {-}
точно так само, як
# Мій заголовок {.unnumbered}
Розширення: auto_identifiers
Заголовку без явно зазначеного ідентифікатора буде автоматично призначено a
унікальний ідентифікатор на основі тексту заголовка. Щоб отримати ідентифікатор із заголовка
Текст,
· Видалити все форматування, посилання тощо.
· Видалити всі виноски.
· Видаліть усі розділові знаки, окрім символів підкреслення, дефісів і крапок.
· Замініть всі пробіли та нові рядки дефісами.
· Перетворіть всі символи алфавіту в нижній регістр.
· Видаліть все до першої літери (ідентифікатори можуть не починатися з цифри або
розділовий знак).
· Якщо після цього нічого не залишилося, скористайтеся розділом ідентифікатора.
Таким чином, наприклад,
Ідентифікатор заголовка
─────────────────────────────────────────────────── ───────
Ідентифікатори заголовків у HTML Ідентифікатори заголовка в html
*Собаки*?--у *мому* будинку? собаки в моєму домі
[HTML], [S5] чи [RTF]? html-s5-або-rtf
3. Додатки додатки
Розділ 33
Ці правила в більшості випадків повинні дозволяти визначити ідентифікатор із заголовка
текст. Виняток становить, коли кілька заголовків мають однаковий текст; в даному випадку перший
отримає ідентифікатор, як описано вище; другий отримає той самий ідентифікатор з -1
доданий; третій з -2; і так далі.
Ці ідентифікатори використовуються для надання цільових посилань у змісті, створеному
параметр --toc|--зміст. Вони також дозволяють легко надавати посилання з одного
розділу документа в інший. Наприклад, посилання на цей розділ може виглядати так
це:
Дивіться розділ про
[ідентифікатори заголовка](#header-identifiers-in-html-latex-and-context).
Однак зауважте, що цей метод надання посилань на розділи працює лише в HTML, LaTeX,
і формати ConTeXt.
Якщо вказано параметр --section-divs, то кожен розділ буде загорнутий у div (або
розділ, якщо вказано --html5), і ідентифікатор буде додано до вкладення
(або ), а не сам заголовок. Це дозволяє створювати цілі розділи
маніпулюється за допомогою JavaScript або обробляється інакше в CSS.
Розширення: implicit_header_references
Pandoc поводиться так, ніби для кожного заголовка визначено посилання на посилання. Отже, замість
[ідентифікатори заголовка](#header-identifiers-in-html)
можна просто написати
[ідентифікатори заголовка]
or
[ідентифікатори заголовка][]
or
[розділ про ідентифікатори заголовків][ідентифікатори заголовків]
Якщо є кілька заголовків з ідентичним текстом, відповідне посилання буде посиланням
лише до першого, і вам потрібно буде використовувати явні посилання, щоб посилатися на інші, як
описано вище.
Як і звичайні посилання на посилання, ці посилання не чутливі до регістру.
Визначення явних посилань завжди мають пріоритет над неявними посиланнями на заголовки.
Отже, у наступному прикладі посилання вказуватиме на панель, а не на #foo:
#Фу
[foo]: бар
Дивіться [foo]
Блокувати цитати
Markdown використовує правила електронної пошти для цитування блоків тексту. Блокова цитата - це один або
більше абзаців або інших блокових елементів (наприклад, списків або заголовків) у кожному рядку
передує символ > і необов'язковий пробіл. (> не обов’язково починатися зліва
поле, але не повинно бути відступу більше ніж на три пробіли.)
> Це блокова цитата. Це
> абзац має два рядки.
>
> 1. Це список всередині блокової цитати.
> 2. Другий пункт.
Це «ледача» форма, яка вимагає символ > лише в першому рядку кожного блоку
також дозволено:
> Це блокова цитата. Це
абзац має два рядки.
> 1. Це список всередині блокової цитати.
2. Другий пункт.
Серед блочних елементів, які можуть міститися в блочній цитаті, є й інші блокові лапки.
Тобто блокові лапки можуть бути вкладені:
> Це блокова цитата.
>
> > Блокова цитата всередині блокової цитати.
Якщо після символу > стоїть необов’язковий пробіл, цей пробіл вважатиметься частиною
маркер блокових лапок, а не частина відступу вмісту. Таким чином, щоб поставити an
блок коду з відступом у блоковій цитатці, вам потрібно п’ять пробілів після >:
> код
Розширення: blank_before_blockquote
Стандартний синтаксис Markdown не вимагає порожнього рядка перед блоковою цитатою. Пандок робить
вимагати цього (крім, звичайно, на початку документа). Причина в
вимога полягає в тому, що для a > дуже легко опинитися на початку рядка
нещасний випадок (можливо, через перенесення рядків). Отже, якщо не використовується формат markdown_strict,
наступне не створює вкладених блокових цитат у pandoc:
> Це блокова цитата.
>> Вкладений.
дослівний (код) Блоки
З відступом код Блоки
Блок тексту з відступом на чотири пробіли (або одну табуляцію) розглядається як дослівний текст: тобто
спеціальні символи не викликають спеціальне форматування, а всі пробіли та розриви рядків є
збережено. Наприклад,
якщо (a > 3) {
moveShip(5 * гравітація, ВНИЗ);
}
Початковий відступ (чотири пробіли або одна табуляція) не вважається частиною дослівного тексту
текст і видаляється у виводі.
Примітка: порожні рядки в дослівному тексті не обов’язково починаються з чотирьох пробілів.
Огороджений код Блоки
Розширення: огороджені_кодові_блоки
На додаток до стандартних блоків коду з відступом, pandoc підтримує огороджений кодові блоки. Ці
починайте з рядка з трьох або більше тильд (~) і закінчуйте рядком тильд, які повинні бути в
принаймні так само, як і початковий ряд. Все між цими рядками розглядається як код. Немає
відступ необхідний:
~~~~~~~
якщо (a > 3) {
moveShip(5 * гравітація, ВНИЗ);
}
~~~~~~~
Як і звичайні блоки коду, блоковані блоки коду повинні бути відокремлені від навколишнього тексту за допомогою
пусті рядки.
Якщо сам код містить рядок тильд або тильд, просто використовуйте довший ряд тильд
або зворотні галочки на початку та в кінці:
~~~~~~~~~~~~~~~~
~~~~~~~~~~
код, включаючи тильди
~~~~~~~~~~
~~~~~~~~~~~~~~~~
Розширення: backtick_code_blocks
Те саме, що fenced_code_blocks, але використовує зворотні галочки (`) замість тильди (~).
Розширення: fenced_code_attributes
За бажанням, ви можете приєднати атрибути до блокованого коду або блоку зворотного коду, використовуючи такий синтаксис:
~~~~ {#mycode .haskell .numberLines startFrom="100"}
qsort [] = []
qsort (x:xs) = qsort (фільтр (< x) xs) ++ [x] ++
qsort (фільтр (>= x) xs)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Тут mycode - це ідентифікатор, haskell і numberLines - це класи, а startFrom - це
атрибут зі значенням 100. Деякі вихідні формати можуть використовувати цю інформацію для виконання синтаксису
виділення. Наразі єдиними вихідними форматами, які використовують цю інформацію, є HTML і
LaTeX. Якщо підсвічування підтримується для вашого вихідного формату та мови, то код
блок вище буде виділено з пронумерованими рядками. (Щоб побачити, які є мови
підтримується, зробіть pandoc --version.) В іншому випадку блок коду вище буде виглядати так:
...
Форму швидкого доступу також можна використовувати для визначення мови блоку коду:
```haskell
qsort [] = []
`` `
Це еквівалентно:
``` {.haskell}
qsort [] = []
`` `
Якщо розширення fenced_code_attributes вимкнено, але вхідні дані містять атрибути класу
для кодового блоку атрибут першого класу буде надрукований після огорожі відкриття як a
голе слово.
Щоб запобігти будь-якому виділенню, використовуйте прапорець --no-highlight. Щоб встановити стиль виділення,
використовуйте --highlight-style. Для отримання додаткової інформації про виділення див. Підсвічування синтаксису,
нижче.
Лінія Блоки
Розширення: line_blocks
Блок рядків — це послідовність рядків, що починаються з вертикальної смуги (|), за якою слідує пробіл.
Поділ на рядки буде збережено у виводі, як і будь-які провідні пробіли;
інакше рядки будуть відформатовані як Markdown. Це корисно для віршів і
адреси:
| Пачки лімерика сміються анатомічно
| У космосі це досить економно.
| Але хороші я бачив
| Тому рідко бувають чистими
| А чисті так рідко бувають комічними
| 200 Головна вул.
| Берклі, Каліфорнія 94718
За потреби рядки можна жорстко обгорнути, але продовження рядка має починатися з a
просторі.
| Преосвященний Високоповажний і Праведний Самуїл Л.
Констебль-молодший
| 200 Головна вул.
| Берклі, Каліфорнія 94718
Цей синтаксис запозичений з reStructuredText.
списки
куля списки
Маркірований список — це список елементів маркованого списку. Маркірований елемент списку починається з маркера
(*, + або -). Ось простий приклад:
* один
* два
* три
Це створить «компактний» список. Якщо ви хочете «вільний» список, в якому кожен пункт
відформатований у вигляді абзацу, поставте пробіли між елементами:
* один
* два
* три
Кулі не повинні бути на одному рівні з лівим краєм; вони можуть мати один, два або
три місця. Після маркера має стояти пробіл.
Елементи списку виглядають найкраще, якщо наступні рядки розташовані на одному рівні з першим рядком (після маркера):
* ось мій перший
пункт списку.
* і мій другий.
Але Markdown також допускає «ледачий» формат:
* ось мій перший
пункт списку.
* і мій другий.
Команда чотирипробіл правити
Елемент списку може містити кілька абзаців та інший вміст на рівні блоків. однак,
наступним абзацам має передувати порожній рядок з відступом на чотири пробіли або табуляція.
Список буде виглядати краще, якщо перший абзац буде узгоджено з іншими:
* Перший абзац.
Продовження.
* Другий абзац. З блоком коду, який має бути з відступом
вісім пробілів:
{код}
Елементи списку можуть включати інші списки. У цьому випадку попередній порожній рядок є необов’язковим.
У вкладеному списку має бути відступ на чотири пробіли або одну вкладку:
* фрукти
+ яблука
- Macintosh
- червоний смачний
+ груші
+ персики
* овочі
+ брокколі
+ мангольд
Як зазначалося вище, Markdown дозволяє писати елементи списку «ліниво», замість того, щоб робити відступи
лінії продовження. Однак, якщо в списку є кілька абзаців або інших блоків
елемента, перший рядок кожного має бути з відступом.
+ Ленивий, ледачий, список
пункт.
+ Ще один; це виглядає
погано, але законно.
Другий абзац другого
пункт списку.
Примітка: Хоча правило чотирьох пробілів для продовження абзаців походить від посадової особи
Посібник із синтаксису Markdown, довідкова реалізація Markdown.pl не відповідає йому. Так
pandoc дасть інші результати, ніж Markdown.pl, коли автори зробили відступ
продовження абзаців менше чотирьох пробілів.
У посібнику з синтаксису Markdown не вказано, чи застосовується правило чотирьох пробілів всі
вміст на рівні блоку в елементі списку; тут згадуються лише абзаци та блоки коду. Але це
означає, що правило застосовується до всього вмісту на рівні блоків (включаючи вкладені списки), і
pandoc інтерпретує це так.
Упорядкований списки
Упорядковані списки працюють так само, як і марковані списки, за винятком того, що елементи починаються з переписувачів
а не кулі.
У стандартному Markdown перераховувачі — це десяткові числа, за якими слідує крапка та пробіл.
Самі числа ігноруються, тому між цим списком немає різниці:
1. один
2. два
3. три
а цей:
5. один
7. два
1. три
Розширення: fancy_lists
На відміну від стандартного Markdown, pandoc дозволяє позначати впорядковані елементи списку великими літерами та
малі літери та римські цифри, а також арабські цифри. Маркери списку можуть бути
закриті в дужки або за якими йде одна права дужка або крапка. Вони повинні бути
відокремлюється від тексту, який слідує, принаймні одним пробілом, і, якщо маркер списку дорівнює a
велика літера з крапкою, щонайменше через два пробіли.
Розширення fancy_lists також дозволяє використовувати '#' як маркер упорядкованого списку замість
цифра:
#. один
#. два
Розширення: початковий номер
Pandoc також звертає увагу на тип використовуваного маркера списку та на початковий номер,
і обидва вони зберігаються, де це можливо, у вихідному форматі. Таким чином, наступне
дає список з числами, за якими слідує одна дужка, починаючи з 9, і a
підсписок із малими римськими цифрами:
9) Дев'ятий
10) Десяте
11) Одинадцяте
я subone
ii. піддва
iii. підтри
Pandoc створюватиме новий список щоразу, коли використовується інший тип маркера списку. Отже,
наступне створить три списки:
(2) Два
(5) Три
1. Четверо
* П'ять
Якщо потрібні маркери списку за замовчуванням, використовуйте #.:
#. один
#. два
#. три
Визначення списки
Розширення: визначення_списків
Pandoc підтримує списки визначень, використовуючи для деяких синтаксис PHP Markdown Extra
розширення.
Термін 1
: Визначення 1
Термін 2 з *вбудованою розміткою*
: Визначення 2
{ деякий код, частина визначення 2 }
Третій абзац визначення 2.
Кожен термін повинен міститися в одному рядку, за яким за бажанням може бути порожній рядок, і він повинен
супроводжується одним або кількома визначеннями. Визначення починається двокрапкою або тильдою, яка
може бути з відступом на один або два пробіли.
Термін може мати кілька визначень, і кожне визначення може складатися з одного або кількох блоків
елементи (абзац, блок коду, список тощо), кожен із чотирма відступами або однією табуляцією.
Основна частина визначення (включаючи перший рядок, крім двокрапки або тильди)
має бути з відступом на чотири пробіли. Однак, як і з іншими списками Markdown, ви можете "ліниво"
пропустити відступ, крім початку абзацу або іншого блокового елемента:
Термін 1
: Визначення
з лінивим продовженням.
Другий абзац визначення.
Якщо залишити пробіл перед визначенням (як у прикладі вище), текст
визначення буде розглядатися як параграф. У деяких вихідних форматах це означатиме більше
відстань між парами термін/визначення. Для більш компактного списку визначень опустіть пробіл
перед визначенням:
Термін 1
~ Визначення 1
Термін 2
~ Визначення 2а
~ Визначення 2б
Зауважте, що пробіл між елементами в списку визначень потрібен. (Варіант, який послаблює
ця вимога, але забороняє "ліниве" жорстке загортання, можна активувати за допомогою
compact_definition_lists: див. Розширення, які не є pandoc, нижче.)
нумерований приклад списки
Розширення: example_lists
Спеціальний маркер списку @ можна використовувати для послідовно нумерованих прикладів. Перший список
елемент з маркером @ буде пронумеровано '1', наступний '2', і так далі, протягом
документ. Нумеровані приклади не обов'язково повинні міститися в одному списку; кожен новий список за допомогою @
підніме там, де зупинився останній. Так, наприклад:
(@) Мій перший приклад буде пронумерований (1).
(@) Мій другий приклад буде пронумерований (2).
Пояснення прикладів.
(@) Мій третій приклад буде пронумерований (3).
Пронумеровані приклади можна позначити та посилатися в іншому місці документа:
(@good) Це хороший приклад.
Як ілюструє (@good), ...
Мітка може бути будь-яким рядком буквено-цифрових символів, символів підкреслення або дефісів.
компактний та вільний списки
Pandoc поводиться інакше, ніж Markdown.pl, у деяких «крайніх випадках», що стосуються списків.
Розглянемо це джерело:
+ Перший
+ Другий:
- Плата
- Тьфу
- Ворог
+ Третє
Pandoc перетворює це на «компактний список» (без номеру теги навколо "Перший", "Другий",
або "Третій"), а Markdown ставить теги навколо "Другий" і "Третій" (але не "Перший"),
через пусте місце навколо «Третій». Pandoc дотримується простого правила: якщо текст є
після якого йде порожній рядок, він розглядається як абзац. Оскільки за «другим» слід а
список, а не порожній рядок, він не розглядається як абзац. Справа в тому, що список є
після якого йде порожній рядок, не має значення. (Примітка: Pandoc працює таким чином, навіть якщо
вказано формат markdown_strict. Така поведінка відповідає чиновнику
Опис синтаксису Markdown, навіть якщо він відрізняється від Markdown.pl.)
Закінчення a список
Що робити, якщо ви хочете помістити блок коду з відступом після списку?
- пункт перший
- пункт другий
{ мій блок коду }
Біда! Тут pandoc (як і інші реалізації Markdown) розглядатиме { мій блок коду } як
другий абзац пункту два, а не як блок коду.
Щоб «відрізати» список після другого пункту, ви можете вставити деякий вміст без відступів, наприклад,
HTML-коментар, який не дає видимого результату в жодному форматі:
- пункт перший
- пункт другий
{ мій блок коду }
Ви можете використовувати той самий трюк, якщо хочете мати два послідовних списки замість одного великого:
1. один
2. два
3. три
1. уно
2. дос
3. tres
Горизонтальний Правила
Рядок, що містить рядок із трьох або більше символів *, - або _ (за бажанням, розділених символом
пробіли) створює горизонтальне правило:
* * * *
---------------
таблиці
Можна використовувати чотири види таблиць. Перші три види передбачають використання a
шрифт фіксованої ширини, наприклад Courier. Четвертий вид можна використовувати з пропорційно розташованими
шрифти, оскільки для цього не потрібно вибудовувати стовпці.
Розширення: підписи до таблиць
Підпис може бути наданий за бажанням з усіма 4 видами таблиць (як показано на малюнку
приклади нижче). Підпис - це абзац, що починається з рядка Table: (або просто :),
який буде знятий. Він може з’являтися до або після таблиці.
Розширення: прості_таблиці
Прості таблиці виглядають так:
Праворуч Ліво Центр За замовчуванням
------- ------ ---------- -------
12 12 12 12
123 123 123 123
1 1 1 1
Таблиця: Демонстрація простого синтаксису таблиці.
Заголовки та рядки таблиці повинні розміщуватися в одному рядку. Вирівнювання стовпців визначаються за допомогою
положення тексту заголовка відносно пунктирної лінії під ним:
· Якщо пунктирна лінія знаходиться на одному рівні з текстом заголовка праворуч, але виходить за його межі
ліворуч стовпець вирівнюється по правому краю.
· Якщо пунктирна лінія знаходиться на одному рівні з текстом заголовка з лівого боку, але виходить за його межі
праворуч стовпець вирівнюється за лівим краєм.
· Якщо пунктирна лінія виходить за межі тексту заголовка з обох боків, стовпець відцентрується.
· Якщо пунктирна лінія знаходиться на одному рівні з текстом заголовка з обох боків, вирівнювання за замовчуванням є
використаний (у більшості випадків це буде залишено).
Таблиця має закінчуватися порожнім рядком або рядком тире, за яким слід порожній рядок.
Заголовки стовпців можна опускати, якщо в кінці таблиці використовується пунктир. Для
приклад:
------- ------ ---------- -------
12 12 12 12
123 123 123 123
1 1 1 1
------- ------ ---------- -------
Якщо заголовки пропущені, вирівнювання стовпців визначається на основі першого рядка
корпусу столу. Отже, у наведених вище таблицях стовпці будуть правими, лівими, центральними та
вирівняні по правому краю, відповідно.
Розширення: багаторядкові_таблиці
Багаторядкові таблиці дозволяють заголовкам і рядкам таблиці охоплювати кілька рядків тексту (але клітинки
які охоплюють декілька стовпців або рядків таблиці, не підтримуються). Ось приклад:
-------------------------------------------------- -----------
По центру За замовчуванням Праворуч Ліворуч
Заголовок Вирівняно Вирівняно Вирівняно
----------- ------- --------------- ----------------- --------
Перший рядок 12.0 Приклад рядка, що
охоплює декілька рядків.
Другий ряд 5.0 Ось ще один. Примітка
порожній рядок між
рядків.
-------------------------------------------------- -----------
Таблиця: Ось підпис. Це теж може охопити
кілька рядків.
Вони працюють як прості таблиці, але з такими відмінностями:
· Вони повинні починатися з рядка тире перед текстом заголовка (якщо заголовки не є
пропущено).
· Вони повинні закінчуватися рядком тире, потім порожнім рядком.
· Рядки повинні бути розділені порожніми рядками.
У багаторядкових таблицях синтаксичний аналізатор таблиць звертає увагу на ширину стовпців і на
письменники намагаються відтворити ці відносні ширини у вихідних даних. Отже, якщо ви знайдете це одне з
стовпці надто вузькі у вихідних даних, спробуйте розширити їх у джерелі Markdown.
Заголовки можуть бути опущені в багаторядкових таблицях, а також у простих таблицях:
----------- ------- --------------- ----------------- --------
Перший рядок 12.0 Приклад рядка, що
охоплює декілька рядків.
Другий ряд 5.0 Ось ще один. Примітка
порожній рядок між
рядків.
----------- ------- --------------- ----------------- --------
: Ось багаторядкова таблиця без заголовків.
Багаторядкова таблиця може мати лише один рядок, але слід дотримуватися рядка
порожнім рядком (а потім рядком тире, що закінчує таблицю), або таблиця може бути
трактується як проста таблиця.
Розширення: grid_tables
Таблиці сітки виглядають так:
: Зразок таблиці сітки.
+--------------+--------------+-------------- ---+
| Фрукти | Ціна | Переваги |
+===============+===============+================== ===+
| Банани | $1.34 | - вбудована обгортка |
| | | - яскравий колір |
+--------------+--------------+-------------- ---+
| Апельсини | $2.10 | - лікує цингу |
| | | - смачно |
+--------------+--------------+-------------- ---+
Рядок =s відокремлює заголовок від тіла таблиці і може бути опущений для a
таблиця без заголовка. Комірки таблиць сітки можуть містити довільні блокові елементи (кілька
абзаци, блоки коду, списки тощо). Вирівнювання не підтримуються, як і клітинки
охоплювати кілька стовпців або рядків. Таблиці сітки можна легко створювати за допомогою режиму таблиці Emacs.
Розширення: pipe_tables
Трубні таблиці виглядають так:
| Праворуч | Ліворуч | За замовчуванням | Центр |
|------:|:-----|---------|:-----:|
| 12 | 12 | 12 | 12 |
| 123 | 123 | 123 | 123 |
| 1 | 1 | 1 | 1 |
: Демонстрація синтаксису таблиці pipe.
Синтаксис ідентичний таблицям PHP Markdown Extra. Початок і кінець труби
символи необов'язкові, але між усіма стовпцями обов'язкові символи. Двокрапки вказують
вирівнювання стовпців, як показано. Заголовок не можна опускати. Щоб імітувати таблицю без заголовків,
включити заголовок із порожніми клітинками.
Оскільки труби вказують межі стовпців, стовпці не потрібно вирівнювати по вертикалі, т.к
вони є у наведеному вище прикладі. Отже, це цілком законна (хоча й потворна) таблиця труб:
фрукти| ціна
-----|-----:
яблуко|2.05
груша|1.37
помаранчевий|3.09
Комірки таблиць конвейера не можуть містити блокові елементи, такі як абзаци та списки та
не може охоплювати декілька рядків. Якщо таблиця конвейера містить рядок, вміст для друку якого є
ширше, ніж ширина стовпця (див. --columns), то вміст комірки буде обгорнуто з
відносні ширини осередків визначаються шириною роздільних ліній.
Примітка: pandoc також розпізнає конвеєрні таблиці наступної форми, які можуть бути створені
orgtbl-режим Emacs:
| Один | Два |
|-----+-------|
| мій | таблиця |
| є | гарно |
Різниця полягає в тому, що замість | Інші функції orgtbl не підтримуються.
Зокрема, щоб отримати вирівнювання стовпців за замовчуванням, вам потрібно буде додати двокрапки, як описано вище.
метадані Блоки
Розширення: pandoc_title_block
Якщо файл починається з заголовка
% заголовок
% автор(ів) (розділені крапкою з комою)
% дата
він буде аналізуватися як бібліографічна інформація, а не звичайний текст. (Він буде використовуватися для
наприклад, у заголовку окремого виводу LaTeX або HTML.) Блок може містити лише a
заголовок, заголовок і автор, або всі три елементи. Якщо ви хочете включити автора, але
без назви або заголовка і дати, але без автора, вам потрібен порожній рядок:
%
% Автор
% Моя назва
%
% 15 червня 2006 року
Заголовок може займати кілька рядків, але рядки-продовження повинні починатися з пробілу,
таким чином:
% Моя назва
на кількох рядках
Якщо у документа кілька авторів, автори можуть бути розміщені в окремих рядках із заголовком
пробіл, або розділені крапкою з комою, або обидва. Отже, всі перераховані нижче є еквівалентними:
% Автор перший
Автор другий
% Автор перший; Автор другий
% Автор перший;
Автор другий
Дата має поміститися в один рядок.
Усі три поля метаданих можуть містити стандартне вбудоване форматування (курсив, посилання,
виноски тощо).
Блоки заголовків завжди будуть аналізуватися, але вони впливатимуть на вихід, лише коли
--окремий варіант (-s). У виводі HTML заголовки з’являться двічі: один раз у файлі
заголовок документа – це заголовок, який з’явиться у верхній частині вікна браузера
-- і один раз на початку тіла документа. Заголовок у заголовку документа може
мати додатковий префікс (--title-prefix або -T). Заголовок у тілі
відображається як елемент H1 з класом "title", тому його можна придушити або переформатувати
CSS. Якщо префікс заголовка вказано за допомогою -T і в документі не з’являється заголовка,
префікс заголовка буде використовуватися сам по собі як заголовок HTML.
Записувач сторінки керівництва витягує заголовок, номер розділу сторінки керівництва та інший верхній і нижній колонтитул
інформація з рядка заголовка. Заголовок вважається першим словом у заголовку
рядок, який за бажанням може закінчуватися (однозначним) номером розділу в дужках.
(Між заголовком і дужками не повинно бути пробілу.) Усе, що після цього є
передбачається додатковим текстом нижнього колонтитула та заголовка. Повинен бути один символ вертикальної лінії (|).
використовується для відокремлення тексту нижнього колонтитула від тексту заголовка. таким чином,
% PANDOC(1)
відобразить сторінку керівництва з заголовком PANDOC і розділом 1.
% PANDOC(1) Посібники користувача Pandoc
у нижньому колонтитулі також буде «Посібники користувача Pandoc».
% PANDOC(1) Посібники користувача Pandoc | Версія 4.0
також матиме "Версія 4.0" у заголовку.
Розширення: yaml_metadata_block
Блок метаданих YAML – це дійсний об’єкт YAML, розділений рядком із трьох дефісів (---)
угорі та рядок із трьох дефісів (---) або трьох крапок (...) унизу. ЯМЛ
Блок метаданих може зустрічатися в будь-якому місці документа, але якщо він не на початку, він
має передувати порожній рядок. (Зауважте, що через спосіб об’єднання pandoc
вхідні файли, якщо їх надано кілька, ви також можете зберігати метадані в окремому YAML
файл і передайте його в pandoc як аргумент разом з файлами Markdown:
pandoc chap1.md chap2.md chap3.md metadata.yaml -s -o book.html
Просто переконайтеся, що файл YAML починається з --- і закінчується на --- або ....)
Метадані будуть взяті з полів об’єкта YAML і додані до будь-яких існуючих
метадані документа. Метадані можуть містити списки та об’єкти (вкладені довільно), але все
рядкові скаляри будуть інтерпретуватися як Markdown. Поля, імена яких закінчуються на символ підкреслення
буде проігноровано pandoc. (Їм можуть надати роль зовнішні процесори.)
Документ може містити кілька блоків метаданих. Поля метаданих буде об’єднано
через лівосторонній союз: якщо два блоки метаданих намагаються встановити одне й те саме поле,
буде прийнято значення з першого блоку.
Коли pandoc використовується з -t markdown для створення документа Markdown, блок метаданих YAML
буде створено, лише якщо використовується параметр -s/--standalone. Усі метадані будуть
відображаються в одному блоці на початку документа.
Зауважте, що потрібно дотримуватися правил екранування YAML. Таким чином, наприклад, якщо заголовок містить a
двокрапку, її потрібно вводити в лапки. Символ вертикальної лінії (|) можна використовувати для початку блоку з відступом
що буде інтерпретовано буквально, без необхідності втекти. Ця форма необхідна
коли поле містить порожні рядки:
---
title: "Це заголовок: він містить двокрапку"
автор:
- ім'я: Автор перший
приналежність: University of Somewhere
- ім'я: Автор другий
приналежність: University of Nowhere
теги: [ніщо, ніщо]
реферат: |
Це реферат.
Він складається з двох параграфів.
...
Змінні шаблону будуть встановлені автоматично з метаданих. Так, наприклад, в
записуючи HTML, змінна abstract буде встановлена на HTML-еквівалент Markdown in
абстрактне поле:
Це реферат.
Він складається з двох параграфів.
Примітка. Змінна автора в шаблонах за замовчуванням очікує простого списку або рядка. До
Використовуйте структурованих авторів у прикладі, вам знадобиться спеціальний шаблон. Наприклад:
$для(автора)$
$if(author.name)$
$author.name$$if(author.affiliation)$ ($author.affiliation$)$endif$
$інакше$
$автор$
$endif$
$endfor$
Зворотний слеш втечі
Розширення: all_symbols_escapable
За винятком блоку коду або вбудованого коду, будь-який розділовий символ або пробіл, перед яким стоїть
зворотний скіс буде розглядатися буквально, навіть якщо він зазвичай вказує на форматування.
Так, наприклад, якщо хтось пише
*\*Здрастуйте\**
один отримає
*Здрастуйте*
замість
Здрастуйте
Це правило легше запам’ятати, ніж стандартне правило Markdown, яке допускає лише те
наступні символи для екранування зворотної косої риски:
\`*_{}[]()>#+-.!
(Однак, якщо використовується формат markdown_strict, буде використовуватися стандартне правило Markdown.)
Пробіл із зворотним слешем аналізується як нерозривний пробіл. Він з’явиться у виводі TeX
як ~, а в HTML і XML як \ або \ .
Розбір нового рядка з відображенням зворотної скісної риски (тобто зворотної косої риски в кінці рядка)
як жорсткий розрив лінії. У виводі TeX він відображатиметься як \\, а в HTML як . Це
хороша альтернатива «невидимому» способу Markdown позначати жорсткі розриви рядків за допомогою двох
кінцеві пробіли на рядку.
Зворотні слеші не працюють у дослівних контекстах.
Smart пунктуація
Розширення
Якщо вказано параметр --smart, pandoc виведе друкарсько правильний вихід,
перетворення прямих лапок у фігурні лапки, --- у прямі тире, -- у кінцеві тире та ... у
еліпси. Нерозривні пробіли вставляють після певних абревіатур, наприклад «пан».
Примітка: якщо ваш шаблон LaTeX або будь-який включений файл заголовка викликає пакет csquotes,
pandoc автоматично визначить це та використає \enquote{...} для цитованого тексту.
В лінію форматування
Акцент
До підкреслити деякий текст, оточіть його символами *s або _, наприклад:
Цей текст _підкреслено символами підкреслення_, а це
*підкреслено зірочками*.
Подвійне * або _ виробляє сильний акцент:
Це **сильний акцент** і __з підкресленням__.
Символ * або _, оточений пробілами, або з зворотною косою рискою, не ініціює наголос:
Це * не підкреслено *, і \* також не це\*.
Розширення: внутрішньослова_підкреслення
Оскільки _ іноді використовується всередині слів та ідентифікаторів, pandoc не інтерпретує _
оточені буквено-цифровими символами як маркер наголосу. Якщо хочеш підкреслити
лише частина слова, використовуйте *:
здійсненно*можливе*, не здійсненне*можливе*.
Викреслити
Розширення: викреслити
Щоб викреслити розділ тексту горизонтальною лінією, починайте і закінчуйте його символом ~~. таким чином,
наприклад,
Це ~~видалений текст.~~
Верхні індекси та індекси
Розширення: верхній індекс, індекс
Верхні індекси можна писати, оточуючи верхній індекс символами ^;
підіндекси можуть бути записані, оточуючи підрядковий текст символами ~. Таким чином, для
наприклад,
H~2~O - рідина. 2^10^ дорівнює 1024.
Якщо в надрядковому або підрядковому тексті містяться пробіли, ці пробіли необхідно екранувати
із зворотною косою рискою. (Це робиться, щоб запобігти випадковому верхньому індексу та передплаті через
звичайне використання ~ і ^.) Таким чином, якщо ви хочете, щоб літера P з «кіт» у індексах,
використовуйте P~a\ cat~, а не P~a cat~.
дослівний
Щоб зробити короткий проміжок тексту дослівно, поставте його всередину зворотними галочками:
Яка різниця між `>>=` та `>>`?
Якщо дослівний текст містить зворотну галочку, використовуйте подвійні галочки:
Ось буквальна галочка `` ` ``.
(Пробіли після початкових і перед закриваючими будуть ігноруватися.)
Загальне правило полягає в тому, що дослівний проміжок починається з рядка послідовних крапок
(за бажанням слід пробіл) і закінчується рядком з такою ж кількістю крапок
(за бажанням передує пробіл).
Зауважте, що зворотні косі риски (та інші конструкції Markdown) не працюють дослівно
контексти:
Це зворотна коса риска, за якою слідує зірочка: `\*`.
Розширення: inline_code_attributes
Атрибути можуть бути приєднані до дослівного тексту, як і до блокованих кодових блоків:
`<$>`{.haskell}
невеликий шапки
Щоб писати маленькі великі літери, ви можете використовувати тег HTML span:
Маленькі шапки
(Крапка з комою необов'язкова, і після двокрапки може бути пробіл.) Це буде працювати у всіх
вихідні формати, які підтримують малі літери.
Математика
Розширення: tex_math_dollars
Все між двома символами $ буде розглядатися як математика TeX. Початковий $ повинен мати a
символ без пробілу безпосередньо праворуч, тоді як закриваючий $ повинен мати непробіл
символ безпосередньо ліворуч, і за ним не повинна йти цифра. таким чином,
20,000 30,000 і XNUMX XNUMX доларів не будуть розібрані як математика. Якщо з якоїсь причини вам потрібно вкласти текст
літерні символи $, уникнення їх, і вони не будуть розглядатися як математичні роздільники.
Математика TeX буде надрукована у всіх вихідних форматах. Спосіб його відтворення залежить від результату
формат:
Націнка, LaTeX, Emacs орган режим, КОНТЕКСТ
Він з’явиться дослівно між символами $.
reStructuredText
Він буде відтворений за допомогою ролі інтерпретованого тексту :math:.
AsciiDoc
Він буде представлений як latexmath:[...].
Texinfo
Він буде відтворений всередині команди @math.
groff людина
Він буде представлений дослівно без символів $.
MediaWiki, DokuWiki
Він буде представлений всередині теги.
Текстильний
Він буде відображатися всередині тегів.
RTF, OpenDocument, ODT
Він буде відображатися, якщо це можливо, з використанням символів Unicode, а в іншому випадку
з'являтися дослівно.
DocBook
Якщо використовується прапор --mathml, він буде відтворений за допомогою MathML у вбудованому рівнянні
або тег інформаційного рівняння. В іншому випадку він буде відтворений, якщо можливо, з використанням Unicode
символів.
Docx Він буде відтворений за допомогою математичної розмітки OMML.
Художня книга 2
Якщо використовується параметр --webtex, формули відображаються як зображення за допомогою Google Charts
або інший сумісний веб-сервіс, завантажений та вбудований в електронну книгу. інакше
вони з'являться дослівно.
HTML, ковзкий, DZSlides, S5, EPUB
Спосіб відображення математики в HTML залежатиме від вибраних параметрів командного рядка:
1. За замовчуванням потрібно відображати математику TeX, наскільки це можливо, використовуючи символи Unicode,
як з виводом RTF, DocBook і OpenDocument. Формули поміщаються в проміжок
з class="math", щоб вони могли бути оформлені інакше, ніж навколишні
текст, якщо потрібно.
2. Якщо використовується параметр --latexmathml, математика TeX буде відображатися між $ або $$
символів і додайте теги з класом LaTeX. Сценарій LaTeXMathML буде
використовуватися для відтворення у вигляді формул. (Цей трюк працює не у всіх браузерах,
але це працює у Firefox. У браузерах, які не підтримують LaTeXMathML, TeX math
відображатиметься дослівно між символами $.)
3. Якщо використовується параметр --jsmath, математика TeX буде поміщена в теги (for
вбудована математика) або теги (для відображення математики) з математикою класу. jsMath
для його відтворення буде використаний сценарій.
4. Якщо використовується параметр --mimetex, буде викликано CGI-скрипт mimeTeX
створювати зображення для кожної формули TeX. Це має працювати у всіх браузерах. The
Опція --mimetex приймає необов'язкову URL-адресу як аргумент. Якщо URL не вказано, це
буде вважатися, що CGI-скрипт mimeTeX знаходиться в /cgi-bin/mimetex.cgi.
5. Якщо використовується параметр --gladtex, формули TeX будуть вкладені теги в
вихідний HTML. Отриманий файл htex потім може бути оброблений gladTeX,
який створить файли зображень для кожної формули та HTML-файл із посиланнями на
ці зображення. Отже, процедура така:
pandoc -s --gladtex myfile.txt -o myfile.htex
gladtex -d myfile-images myfile.htex
# створює myfile.html та зображення в myfile-images
6. Якщо використовується параметр --webtex, формули TeX будуть перетворені в теги
це посилання на зовнішній сценарій, який перетворює формули на зображення. Формула
буде закодовано за URL-адресою та з’єднано з наданою URL-адресою. Якщо немає URL-адреси
буде використано Google Chart API
(http://chart.apis.google.com/chart?cht=tx&chl=).
7. Якщо використовується параметр --mathjax, математика TeX буде відображатися між \(...\) (для
inline math) або \[...\] (для відображення математики) і додайте теги з class
математика. Сценарій MathJax буде використовуватися для відтворення його у вигляді формул.
Сировина HTML
Розширення: raw_html
Markdown дозволяє вставляти необроблений HTML (або DocBook) будь-де в документі (крім
дослівні контексти, де <, > і & інтерпретуються буквально). (Технічно це не так
розширення, оскільки стандартний Markdown це дозволяє, але було зроблено розширення таким чином
його можна вимкнути за бажанням.)
Необроблений HTML передається без змін у HTML, S5, Slidy, Slideous, DZSlides, EPUB,
Markdown і текстильний вихід, а також придушені в інших форматах.
Розширення: markdown_in_html_blocks
Стандартний Markdown дозволяє включати HTML «блоки»: блоки HTML між збалансованими
теги, які відокремлені від навколишнього тексту порожніми рядками та починаються та закінчуються на
ліве поле. У цих блоках все інтерпретується як HTML, а не Markdown; тому
(наприклад), * не означає наголос.
Pandoc поводиться так, коли використовується формат markdown_strict; але за замовчуванням pandoc
інтерпретує матеріал між тегами блоків HTML як Markdown. Таким чином, наприклад, pandoc буде
поворот
*один*
[посилання](http://google.com)
в
один
<a href="/http://google.com">посилання
тоді як Markdown.pl збереже його як є.
З цього правила є один виняток: текст між and tags is not
інтерпретується як Markdown.
Цей відхід від стандартного Markdown має полегшити змішування Markdown з HTML
блокові елементи. Наприклад, можна оточити блок тексту Markdown теги
не запобігаючи інтерпретації його як Markdown.
Розширення: native_div
Використовуйте власні блоки pandoc Div для вмісту всередині теги. Здебільшого це повинно бути
дає той самий вихід, що і markdown_in_html_blocks, але це полегшує написання pandoc
фільтри для керування групами блоків.
Розширення: native_spans
Використовуйте власні блоки pandoc Span для вмісту всередині тегів. Здебільшого це
має давати той самий вихід, що й raw_html, але це полегшує запис фільтрів pandoc
маніпулювати групами вбудованих рядків.
Сировина TeX
Розширення: raw_tex
На додаток до необробленого HTML, pandoc дозволяє включати необроблені LaTeX, TeX і ConTeXt до
документ. Вбудовані команди TeX будуть збережені та передані без змін до LaTeX і
Автори контексту. Таким чином, наприклад, ви можете використовувати LaTeX для включення цитат BibTeX:
Цей результат був доведений у \cite{jones.1967}.
Зауважте, що в середовищах LaTeX, наприклад
\begin{tabular}{|l|l|}\hline
Вік і частота \\ \hline
18--25 і 15 \\
26--35 і 33 \\
36--45 і 22 \\ \hline
\end{tabular}
матеріал між початковим і кінцевим тегами буде інтерпретуватися як необроблений LaTeX, а не як
Уцінка.
Вбудований LaTeX ігнорується у вихідних форматах, відмінних від Markdown, LaTeX і ConTeXt.
LaTeX макроси
Розширення: latex_macros
Для вихідних форматів, відмінних від LaTeX, pandoc аналізуватиме LaTeX \newcommand та \renewcommand
визначення та застосувати отримані макроси до всіх математичних даних LaTeX. Так, наприклад,
наступне буде працювати у всіх вихідних форматах, а не тільки в LaTeX:
\нова команда{\tuple}[1]{\langle #1 \rangle}
$\tuple{a, b, c}$
У виводі LaTeX визначення \newcommand буде просто передано без змін у вихідні дані.
зв'язку
Markdown дозволяє вказувати посилання кількома способами.
автоматичний зв'язку
Якщо ви укладете URL-адресу або адресу електронної пошти в гострих дужках, це стане посиланням:
<http://google.com>
<[захищено електронною поштою]>
В лінію зв'язку
Вбудоване посилання складається з тексту посилання в квадратних дужках, за яким слідує URL-адреса
круглі дужки. (За бажанням, за URL-адресою може слідувати заголовок посилання в лапках.)
Це [внутрішнє посилання](/url), а ось [одне з
заголовок](http://fsf.org "клацніть тут, щоб добре провести час!").
Між частиною в дужках і в дужках не може бути пробілу. Посилання
текст може містити форматування (наприклад, наголос), але заголовок не може.
Адреси електронної пошти у вбудованих посиланнях не визначаються автоматично, тому вони повинні мати префікс
MAILTO:
[Написати мені!](MAILTO:[захищено електронною поштою])
Посилання зв'язку
An явний посилання на посилання складається з двох частин, самого посилання і визначення посилання, яке
може зустрічатися в іншому місці документа (до або після посилання).
Посилання складається з тексту посилання в квадратних дужках, за яким слідує мітка у квадратних дужках.
(Між ними може бути пробіл.) Визначення посилання складається з мітки в дужках,
після двокрапки та пробілу, за яким слідує URL-адреса, і за бажанням (після пробілу) a
заголовок посилання в лапках або в дужках. Мітку не можна розбирати як a
цитування (якщо розширення цитат увімкнено): цитати мають пріоритет перед
мітки посилань.
Ось декілька прикладів:
[моя мітка 1]: /foo/bar.html "Моя назва, необов'язково"
[моя етикетка 2]: /foo
[моя етикетка 3]: http://fsf.org (Основа вільного програмного забезпечення)
[моя мітка 4]: /bar#special "Назва в одинарних лапках"
За бажанням URL-адресу можна помістити в кутові дужки:
[моя етикетка 5]:http://foo.bar.baz>
Назва може йти в наступному рядку:
[моя етикетка 3]: http://fsf.org
«Основа вільного програмного забезпечення»
Зауважте, що мітки посилань не чутливі до регістру. Отже, це спрацює:
Ось [моє посилання][FOO]
[Foo]: /bar/baz
У неявний посилання на посилання, друга пара дужок порожня:
Дивіться [мій веб-сайт][].
[мій веб-сайт]: http://foo.bar.baz
Примітка. У Markdown.pl та більшості інших реалізацій Markdown посилання на визначення посилань
не може зустрічатися у вкладених конструкціях, таких як елементи списку або блокові лапки. Підйомники Pandoc
це довільне, здавалося б, обмеження. Отже, наступне добре в pandoc, але не в
більшість інших реалізацій:
> Мій блок [цитата].
>
> [цитата]: /foo
Розширення: shortcut_reference_links
В контекстного посилання на посилання, другу пару дужок можна повністю опустити:
Дивіться [мій веб-сайт].
[мій веб-сайт]: http://foo.bar.baz
Внутрішній зв'язку
Щоб посилатися на інший розділ того самого документа, скористайтеся автоматично згенерованим
ідентифікатор (див. Ідентифікатори заголовка). Наприклад:
Див. [Вступ](#introduction).
or
Див. [Вступ].
[Вступ]: #вступ
Внутрішні посилання наразі підтримуються для форматів HTML (включаючи слайд-шоу HTML і
EPUB), LaTeX і ConTeXt.
зображень
Посилання, якому безпосередньо передує символ ! буде розглядатися як зображення. Текст посилання буде
використовується як альтернативний текст зображення:
![la lune](lalune.jpg "Подорож на місяць")
![катушка фільму]
[ролик фільму]: movie.gif
Розширення: неявні_фігури
Зображення, що зустрічається в абзаці, відображатиметься як фігура з підписом.
(У LaTeX буде використовуватися середовище малюнків; у HTML зображення буде розміщено в div
з малюнком класу разом із підписом у ap із підписом класу.) Альтернатива зображення
текст буде використовуватися як підпис.
![Це підпис](/url/of/image.png)
Якщо ви просто хочете звичайне вбудоване зображення, просто переконайтеся, що це не єдина річ у
параграф. Один із способів зробити це – вставити нерозривний пробіл після зображення:
![Це зображення не буде фігурою](/url/of/image.png)\
Розширення: link_attributes
Атрибути можна встановити на посиланнях і зображеннях:
Вбудований ![image](foo.jpg){#id .class width=30 height=20px}
і посилання ![image][ref] з атрибутами.
[ref]: foo.jpg "необов'язковий заголовок" {#id .class key=val key2="val 2"}
(Цей синтаксис сумісний з PHP Markdown Extra, якщо використовуються лише #id і .class.)
Для HTML і EPUB всі атрибути, крім ширини і висоти (але включаючи srcset і розміри)
пропускаються як є. Інші автори ігнорують атрибути, які не підтримуються
їх вихідний формат.
Атрибути ширини та висоти на зображеннях обробляються спеціально. При використанні без a
одиницю, одиницею вважаються пікселі. Однак будь-який з наведених нижче ідентифікаторів одиниць
можна використовувати: px, cm, mm, in, inch і %. Між цифрами не повинно бути пробілів
і одиниця. Наприклад:
![](файл.jpg){ ширина=50% }
· Розміри конвертуються в дюйми для виведення у форматі на основі сторінок, як-от LaTeX.
Розміри перетворюються в пікселі для виведення у формати, подібні до HTML. Використовуйте --dpi
можливість вказати кількість пікселів на дюйм. За замовчуванням встановлено 96 dpi.
· Одиниця виміру %, як правило, відноситься до деякої доступної площі. Наприклад, наведений вище приклад
буде надавати до (HTML),
\includegraphics[width=0.5\textwidth]{file.jpg} (LaTeX), або
\externalfigure[file.jpg][width=0.5\textwidth] (ConTeXt).
· Деякі вихідні формати мають поняття класу (ConTeXt) або унікального ідентифікатора (LaTeX
\caption), або обидва (HTML).
· Якщо атрибути ширини або висоти не вказані, запасним варіантом є перегляд зображення
роздільна здатність і метадані dpi, вбудовані у файл зображення.
Виноски
Розширення: виноски
Pandoc's Markdown дозволяє робити виноски, використовуючи такий синтаксис:
Ось посилання на виноску,[^1] та інше.[^longnote]
[^1]: Ось виноска.
[^longnote]: ось один із кількома блоками.
Наступні абзаци мають відступи, щоб показати, що вони
належать до попередньої виноски.
{ some.code }
Абзац може мати відступ або лише перший
лінія. Таким чином, багатоабзацні виноски працюють як
багатоабзацні елементи списку.
Цей абзац не буде частиною примітки, оскільки він
не має відступу.
Ідентифікатори в посиланнях на виноски не можуть містити пробіли, табуляції чи нові рядки. Ці
ідентифікатори використовуються лише для співвіднесення посилання на виноску з самою приміткою; в
виноски будуть пронумеровані послідовно.
Самі виноски не обов’язково розміщувати в кінці документа. Вони можуть з'явитися
де завгодно, окрім інших блокових елементів (списків, блокових лапок, таблиць тощо).
Розширення: inline_notes
Вбудовані виноски також дозволені (хоча, на відміну від звичайних приміток, вони не можуть містити
кілька абзаців). Синтаксис такий:
Ось вбудована примітка.^[Вставлені нотатки легше писати, оскільки
вам не потрібно вибирати ідентифікатор і рухатися вниз, щоб ввести
Примітка.]
Вбудовані та звичайні виноски можна вільно змішувати.
Цитати
Розширення: цитати
Використовуючи зовнішній фільтр, pandoc-citeproc, pandoc може автоматично генерувати цитати та
бібліографія в кількох стилях. Основне використання є
pandoc --фільтр pandoc-citeproc myinput.txt
Щоб скористатися цією функцією, вам потрібно буде вказати файл бібліографії за допомогою
поле метаданих бібліографії в розділі метаданих YAML або командний рядок --bibliography
аргумент. Ви можете вказати декілька аргументів --bibliography або встановити метадані бібліографії
поле до масиву YAML, якщо ви хочете використовувати декілька файлів бібліографії. Бібліографія може
мати будь-який із цих форматів:
Формат розширення файлу
──────────────────────────────
BibLaTeX .bib
BibTeX .bibtex
Копак .копак
CSL JSON .json
CSL YAML .yaml
EndNote .enl
EndNote XML .xml
ISI .wos
МЕДЛАЙН .medline
МОДИ .моди
РІС .рис
Зауважте, що .bib можна використовувати як з файлами BibTeX, так і з BibLaTeX; використовувати .bibtex для примусу
BibTeX.
Зверніть увагу, що pandoc-citeproc --bib2json і pandoc-citeproc --bib2yaml можуть створювати .json і
файли .yaml з будь-якого з підтримуваних форматів.
Розмітка в полі: у базах даних BibTeX і BibLaTeX pandoc-citeproc аналізує підмножину
розмітка LaTeX; в базах даних CSL YAML, pandoc Markdown; і в базах даних CSL JSON, an
HTML-подібна розмітка:
курсив
...
жирним шрифтом
<Span style="font-variant:small-caps;">... or ...
маленькі столиці
...
індекс
...
верхній індекс
<Span class="nocase">...
запобігти написанню фрази з великої літери як заголовку
pandoc-citeproc -j і -y взаємоперетворять формати CSL JSON і CSL YAML, наскільки
можливо.
Як альтернативу вказуванню файлу бібліографії за допомогою --bibliography або YAML
бібліографія поля метаданих, ви можете включити дані цитування безпосередньо в посилання
поле метаданих YAML документа. Поле має містити масив із кодуванням YAML
посилання, наприклад:
---
посилання:
- тип: стаття-журн
ID: WatsonCrick1953
автор:
- родина: Ватсон
дано: JD
- родина: Крик
дано: FHC
виданий:
частини дати:
- - 1953 рік
- 4
- 25
заголовок: «Молекулярна структура нуклеїнових кислот: структура для дезоксирибози
нуклеїнова кислота
коротка назва: Молекулярна структура нуклеїнових кислот
container-title: Природа
обсяг: 171
випуск: 4356
сторінка: 737-738
DOI: 10.1038/171737a0
URL: http://www.nature.com/nature/journal/v171/n4356/abs/171737a0.html
мова: en-GB
...
(pandoc-citeproc --bib2yaml може створити їх із файлу бібліографії в одному з
підтримувані формати.)
Цитати та посилання можна відформатувати за допомогою будь-якого стилю, який підтримується стилем цитування
Мова, перерахована в репозиторії стилів Zotero. Ці файли вказуються за допомогою
--csl параметр або поле метаданих csl. За замовчуванням pandoc-citeproc використовуватиме Chicago
Посібник зі стилю формату автор-дата. Проект CSL надає додаткову інформацію про
пошук і редагування стилів.
Щоб зробити цитати гіперпосиланнями на відповідні бібліографічні записи, додайте
посилання-цитати: вірні вашим метаданим YAML.
Цитати входять у квадратні дужки і розділяються крапкою з комою. Кожна цитата повинна
мати ключ, що складається з '@' + ідентифікатор цитати з бази даних, і може
за бажанням мати префікс, локатор і суфікс. Ключ цитати повинен починатися з a
літера, цифра або _ і може містити букви, цифри, _ та внутрішні знаки пунктуації
(:.#$%&-+?<>~/). Ось кілька прикладів:
Бла-бла [див. @doe99, стор. 33-35; також @smith04, розд. 1].
Бла-бла [@doe99, стор. 33-35, 38-39 і *passim*].
Бла-бла [@smith04; @doe99].
pandoc-citeproc виявляє терміни локатора у файлах локалі CSL. Або скорочено, або
приймаються нескорочені форми. У мові en-US можна записати терміни локатора
форми однини або множини, як книга, бк./бкс.; глава, розд./розд.; колонка,
кол./зб.; малюнок, рис./рис.; фоліант, фол./фол.; номер, №/№; лінія, л./л.; Примітка,
п./нн.; опус, ор./опп.; сторінка, с./стор.; абзац, абз./п.; частина, ч./б.; розділ,
сек./сек.; sub verbo, св/с.вв.; вірш, т./в.; том, т./т.; ¶/¶¶; §/§§. Якщо ні
використовується термін локатора, передбачається «сторінка».
Знак мінус (-) перед @ призведе до придушення згадки автора в цитаті. Це
може бути корисним, коли автор уже згадується в тексті:
Сміт каже бла [-@smith04].
Ви також можете написати цитату в тексті, як показано нижче:
@smith04 каже бла.
@smith04 [с. 33] каже бла.
Якщо стиль вимагає списку цитованих робіт, він буде розміщено в кінці
документ. Як правило, ви хочете завершити свій документ відповідним заголовком:
останній абзац...
# Посилання
Бібліографія буде вставлена після цього заголовка. Зауважте, що ненумерований клас буде
бути додано до цього заголовка, щоб розділ не нумерувався.
Якщо ви хочете включити елементи в бібліографію, насправді не цитуючи їх у тексті
тексту, ви можете визначити фіктивне поле метаданих nocite і помістити туди цитати:
---
зауважте: |
@item1, @item2
...
@item3
У цьому прикладі документ міститиме цитату лише для пункту 3, але бібліографію
міститиме записи для елемента1, елемента2 та елемента3.
Для виведення LaTeX або PDF ви також можете використовувати natbib або biblatex для відтворення бібліографії. в
щоб це зробити, вкажіть файли бібліографії, як описано вище, і додайте --natbib або
--biblatex аргумент для виклику pandoc. Майте на увазі, що файли бібліографії мають бути
у відповідному форматі (або BibTeX, або BibLaTeX).
Для отримання додаткової інформації див. сторінку керівництва pandoc-citeproc.
Не пандок Розширення
Наступні розширення синтаксису Markdown не ввімкнені за замовчуванням у pandoc, але можуть бути
увімкнено, додавши +EXTENSION до назви формату, де EXTENSION – це ім’я файлу
розширення. Таким чином, наприклад, markdown+hard_line_breaks — це Markdown з жорсткою лінією
перерви.
Розширення: списки_без_попереднього_порожнього рядка
Дозволити розміщення списку відразу після абзацу, без пробілів.
Розширення: hard_line_breaks
Спричиняє інтерпретацію всіх нових рядків у абзаці як жорсткі розриви рядків, а не як
простори.
Розширення: ignore_line_breaks
Ігнорує нові рядки в абзаці, а не розглядає їх як пробіли або
як жорсткі розриви лінії. Цей параметр призначений для використання зі східноазіатськими мовами, де
пробіли між словами не використовуються, але текст поділено на рядки для читабельності.
Розширення: east_asian_line_breaks
Ігнорує нові рядки в абзаці, а не розглядає їх як пробіли або
як розриви жорсткої лінії, коли вони відбуваються між двома східноазіатськими широкими символами. Це
кращий вибір, ніж ignore_line_breaks для текстів, які містять поєднання східноазіатських
персонажів та інших персонажів.
Розширення: смайликів
Розбирає текстові смайли, як-от :smile:, як смайли Unicode.
Розширення: tex_math_single_backslash
Спричиняє інтерпретацію будь-чого між \( і \) як вбудовану математику TeX і будь-що
між \[ та \] інтерпретуватись як відображення математики TeX. Примітка: недолік цього
розширення полягає в тому, що воно виключає вихід ( і [.
Розширення: tex_math_double_backslash
Спричиняє інтерпретацію будь-чого між \\( і \\) як вбудовану математику TeX і будь-що
між \\[ та \\] інтерпретуватись як відображення математики TeX.
Розширення: атрибут_markdown
За замовчуванням pandoc інтерпретує матеріал всередині тегів на рівні блоків як Markdown. Це
розширення змінює поведінку так, що Markdown аналізується лише всередині тегів на рівні блоку if
теги мають атрибут markdown=1.
Розширення: mmd_title_block
Вмикає заголовок стилю MultiMarkdown у верхній частині документа, наприклад:
Назва: Моя назва
Автор: Джон Доу
Дата: вересень 1, 2008
Коментар: Це зразок заголовка mmd із
поле, що охоплює декілька рядків.
Додаткову інформацію дивіться в документації MultiMarkdown. Якщо pandoc_title_block або
yaml_metadata_block увімкнено, він матиме пріоритет над mmd_title_block.
Розширення: абревіатури
Розбирає PHP Markdown Додаткові клавіші скорочень, наприклад
*[HTML]: мова гіпертекстової розмітки
Зауважте, що модель документа pandoc не підтримує скорочення, тому якщо це розширення
увімкнено, клавіші скорочень просто пропускаються (на відміну від аналізу як
параграфи).
Розширення: autolink_bare_uris
Перетворює всі абсолютні URI на посилання, навіть якщо вони не оточені гострими дужками <...>.
Розширення: ascii_identifiers
Приводить до того, що ідентифікатори, створені auto_identifiers, будуть чистими ASCII. Акценти є
вилучено латинські літери з наголосом, а нелатинські літери опущено.
Розширення: mmd_link_attributes
Розбирає атрибути ключ-значення стилю multimarkdown у посиланнях та посиланнях на зображення. Це
розширення не слід плутати з розширенням link_attributes.
Це посилання ![image][ref] з атрибутами multimarkdown.
[посилання]: http://path.to/image "Назва зображення" ширина=20 пікселів висота=30 пікселів
id=myId class="myClass1 myClass2"
Розширення: mmd_header_identifiers
Розбирає ідентифікатори заголовка стилю multimarkdown (у квадратних дужках, після заголовка але
перед будь-якими кінцевими #s в заголовку ATX).
Розширення: compact_definition_lists
Активує синтаксис списку визначень pandoc 1.12.x та попередніх версій. Цей синтаксис відрізняється
від описаного вище в списках визначень у кількох аспектах:
· Між послідовними елементами списку визначень не потрібен порожній рядок.
· Щоб отримати «тугий» або «компактний» список, опустіть пробіл між послідовними пунктами; простір
між терміном і його визначенням ні на що не впливає.
· Ліниве перенесення абзаців не допускається: усе визначення має бути з чотирьох відступом
простори.
Markdown варіанти
На додаток до розширеного Markdown від pandoc підтримуються такі варіанти Markdown:
markdown_phpextra (PHP Markdown Додатково)
виноски, pipe_tables, raw_html, markdown_attribute, fenced_code_blocks,
definition_lists, intraword_underscores, header_attributes, link_attributes,
скорочення, shortcut_reference_links.
markdown_github (З ароматом GitHub уцінка)
pipe_tables, raw_html, tex_math_single_backslash, fenced_code_blocks,
auto_identifiers, ascii_identifiers, backtick_code_blocks, autolink_bare_uris,
intraword_underscores, strikeout, hard_line_breaks, emoji,
shortcut_reference_links.
markdown_mmd (MultiMarkdown)
pipe_tables raw_html, markdown_attribute, mmd_link_attributes, raw_tex,
tex_math_double_backslash, intraword_underscores, mmd_title_block, виноски,
definition_lists, all_symbols_escapable, implicit_header_references,
auto_identifiers, mmd_header_identifiers, shortcut_reference_links.
markdown_strict (Markdown.pl)
raw_html
розширення з Формати інший ніж Markdown
Деякі з розширень, розглянутих вище, можна використовувати з форматами, відмінними від Markdown:
· auto_identifiers можна використовувати з введенням latex, rst, mediawiki та textile (і використовується
за замовчуванням).
· можна використовувати tex_math_dollars, tex_math_single_backslash і tex_math_double_backslash
з введенням html. (Це зручно для читання веб-сторінок, відформатованих за допомогою MathJax, for
приклад.)
ВИРОБНИЦТВО СЛАЙД ШОУ З PANDOC
Ви можете використовувати pandoc для створення слайд-презентації HTML + javascript, яку можна переглядати
через веб-браузер. Є п’ять способів зробити це за допомогою S5, DZSlides, Slidy, Slideous,
або discover.js. Ви також можете створити слайд-шоу у форматі PDF за допомогою LaTeX beamer.
Ось джерело Markdown для простого слайд-шоу, habits.txt:
% Звички
% Джон Доу
% 22 березня 2005 року
# Вранці
## Підніматися
- Вимкніть будильник
- Встати з постелі
## Сніданок
- Їжте яйця
- Пити каву
# Ввечері
## Вечеря
- Їжте спагетті
- Пийте вино
------------------
![зображення спагетті](images/spaghetti.jpg)
## Іду спати
- Лягай у ліжко
- Порахуйте овець
Щоб створити слайд-шоу HTML/javascript, просто введіть
pandoc -t ФОРМАТ -s habits.txt -o habits.html
де ФОРМАТ – це s5, slidy, slideous, dzslides або discoverjs.
Для Slidy, Slideous, discover.js та S5 файл, створений pandoc із
Опція -s/--standalone вбудовує посилання на файли JavaScript і CSS, які вважаються
доступний у відносному шляху s5/за замовчуванням (для S5), slideous (для Slideous), discover.js
(для discover.js) або на веб-сайті Slidy за адресою w3.org (для Slidy). (Ці шляхи можуть бути
змінено шляхом встановлення змінних slidy-url, slideous-url, discoverjs-url або s5-url; подивитися
Змінні для слайдів, наведені вище.) Для DZSlides (відносно короткі) javascript і css є
включено у файл за замовчуванням.
З усіма форматами слайдів HTML для створення одного слайда можна використовувати параметр --self-contained
файл, який містить усі дані, необхідні для відображення слайд-шоу, у тому числі пов’язані
сценарії, таблиці стилів, зображення та відео.
Щоб створити слайд-шоу PDF за допомогою програвача, введіть
pandoc -t beamer habits.txt -o habits.pdf
Зауважте, що слайд-шоу discover.js також можна перетворити на PDF, роздрукувавши його у файл
з браузера.
Структурування ковзати Показувати
За замовчуванням, ковзати рівень — це найвищий рівень заголовка в ієрархії, за якою слід
відразу за вмістом, а не за іншим заголовком, десь у документі. У прикладі
вище за заголовками рівня 1 завжди слідують заголовки рівня 2, за якими слідують
вміст, тому 2 – це рівень слайда. Цей параметр за замовчуванням можна змінити за допомогою --slide-level
варіант.
Документ розбивається на слайди за такими правилами:
· Горизонтальне правило завжди починає новий слайд.
· Заголовок на рівні слайда завжди починає новий слайд.
· Заголовки нижче рівень слайда в ієрархії створює заголовки в слайд.
· Заголовки вище рівень слайдів в ієрархії створюють "титульні слайди", які просто містять
заголовок розділу та допоможе розбити слайд-шоу на розділи.
· Титульна сторінка створюється автоматично з титульного блоку документа, якщо є.
(У випадку з променем це можна вимкнути, прокоментувавши деякі рядки за замовчуванням
шаблон.)
Ці правила розроблені для підтримки багатьох різних стилів показу слайдів. Якщо ви цього не зробите
турбуючись про структурування слайдів на розділи та підрозділи, ви можете просто використовувати рівень 1
заголовки для всіх слайдів. (У цьому випадку рівень 1 буде рівнем слайда.) Але ви можете
також структуруйте слайд-шоу на розділи, як у прикладі вище.
Примітка: у показі слайдів у discover.js, якщо рівень слайда дорівнює 2, двовимірний макет буде
виробляється, з горизонтальною побудовою заголовків рівня 1 і заголовками рівня 2
вертикально. Не рекомендується використовувати глибше вкладення рівнів розділів
discover.js.
Інкрементний списки
За замовчуванням ці автори створюють списки, які відображають «все відразу». Якщо ви хочете, щоб ваші списки
для поетапного відображення (по одному елементу) використовуйте параметр -i. Якщо ви хочете а
певний список, щоб відступити від стандартного (тобто відображати поступово без
-i параметр і все відразу з опцією -i), помістити його в блокову цитату:
> - Їжте спагетті
> - Пийте вино
Таким чином інкрементні та неінкрементні списки можна змішувати в одному документі.
Вставлення паузи
Ви можете додати «паузи» на слайді, включивши абзац, що містить три крапки,
розділені пробілами:
# Слайд з паузою
вміст перед паузою
. . .
вміст після паузи
стайлінг слайдах
Ви можете змінити стиль слайдів HTML, додавши налаштовані файли CSS
$DATADIR/s5/за замовчуванням (для S5), $DATADIR/slidy (для Slidy) або $DATADIR/slideous (для
Slideous), де $DATADIR — це каталог даних користувача (див. --data-dir, вище). The
оригінали можна знайти в каталозі системних даних pandoc (зазвичай
$CABALDIR/pandoc-VERSION/s5/за замовчуванням). Pandoc шукатиме там будь-які файли
знайти в каталозі даних користувача.
Для dzslides CSS включено в сам файл HTML і може бути змінений там.
Усі параметри конфігурації discover.js можна встановити за допомогою змінних. Наприклад, теми можуть
використовувати, встановивши змінну теми:
-V тема = місяць
Або ви можете вказати спеціальну таблицю стилів за допомогою параметра --css.
Щоб стилізувати слайди променів, можна вказати тему, колірну тему, тему шрифту, внутрішню тему та
outertheme, використовуючи параметр -V:
pandoc -t beamer habits.txt -V тема:Варшава -o habits.pdf
Зауважте, що атрибути заголовка перетворюються на атрибути слайда (на a або ) в
Формати слайдів HTML, що дозволяють стилізувати окремі слайди. У beamer, єдиний заголовок
Атрибут, який впливає на слайди, є класом allowframebreaks, який встановлює параметр
параметр allowframebreaks, що спричиняє створення кількох слайдів, якщо вміст переповнює
рамка. Це рекомендується особливо для бібліографій:
# Посилання {.allowframebreaks}
Гучномовець ноти
discover.js має хорошу підтримку для нотаток доповідача. Ви можете додавати примітки до свого документа Markdown
таким чином:
Це моя замітка.
- Він може містити Markdown
- подобається цей список
Щоб відкрити вікно нотаток, натисніть s під час перегляду презентації. Приміток поки немає
підтримується для інших форматів слайдів, але примітки не відображатимуться на самих слайдах.
Кадр Атрибути in відеопроектор
Іноді необхідно додати опцію LaTeX [fragile] до кадру в beamer (для
наприклад, при використанні карбованого середовища). Це можна змусити, додавши ламкі
клас до заголовка, що представляє слайд:
# Крихкий слайд {.fragile}
Усі інші атрибути кадру, описані в Розділі 8.1 Посібника користувача Beamer, можуть
також використовуватися: allowdisplaybreaks, allowframebreaks, b, c, t, environment, label, plain,
зменшуватися.
СТВОРЕННЯ EPUBS З PANDOC
EPUB метадані
Метадані EPUB можна вказати за допомогою параметра --epub-metadata, але якщо джерело
документ Markdown, краще використовувати блок метаданих YAML. Ось приклад:
---
Назва:
- тип: основний
текст: Моя книга
- тип: субтитри
текст: Дослідження метаданих
творець:
- роль: автор
текст: Джон Сміт
- роль: редактор
текст: Сара Джонс
ідентифікатор:
- схема: DOI
текст: doi:10.234234.234/33
видавець: My Press
права: © 2007 Джон Сміт, CC BY-NC
...
Розпізнаються такі поля:
ідентифікатор
Або рядкове значення, або об’єкт із текстовими полями та схемою. Допустимі значення для
схеми ISBN-10, GTIN-13, UPC, ISMN-10, DOI, LCCN, GTIN-14, ISBN-13,
Номер обов’язкового депозиту, URN, OCLC, ISMN-13, ISBN-A, JP, OLCC.
назву Або рядкове значення, або об'єкт з полями file-as і type, або список таких
об'єкти. Допустимі значення для типу: main, subtitle, short, collection, edition,
розширений.
творець
Або рядкове значення, або об’єкт з полями роль, файл-як і текст, або список
таких об'єктів. Допустимі значення для ролі є реляторами MARC, але pandoc спробує
щоб перекласти читані людиною версії (наприклад, "автор" і "редактор") на
відповідні родичі марків.
вкладник
Той самий формат, що й творець.
дата Рядкове значення у форматі РРРР-ММ-ДД. (Тільки рік потрібен.) Пандок буде
спробуйте конвертувати інші поширені формати дати.
яз (Або спадщина: мова)
Рядкове значення у форматі BCP 47. Pandoc за замовчуванням використовуватиме локальну мову, якщо
нічого не вказано.
тема
Рядкове значення або список таких значень.
description
Рядкове значення.
тип Рядкове значення.
формат Рядкове значення.
зв'язок
Рядкове значення.
охоплення
Рядкове значення.
праві Рядкове значення.
обкладинка-зображення
Рядкове значення (шлях до зображення обкладинки).
таблиця стилів
Рядкове значення (шлях до таблиці стилів CSS).
page-progression-direction
Або ltr або rtl. Визначає атрибут page-progression-direction для
елемент хребта.
Зв'язаний media
За замовчуванням pandoc завантажуватиме зв’язані медіа (включаючи аудіо та відео) та включатиме їх
в контейнері EPUB, що дає повністю автономний EPUB. Якщо ви хочете посилання на
натомість зовнішні медіа-ресурси, використовуйте необроблений HTML у своєму джерелі та додайте data-external="1".
тег з атрибутом src. Наприклад:
<джерело src="/http://example.com/music/toccata.mp3"
data-external="1" type="audio/mpeg">
ГРАМОТНИЙ HASKELL ПІДТРИМКА
Якщо ви додаєте +lhs (або +literate_haskell) до відповідного формату введення або виведення
(markdown, markdown_strict, rst або latex для введення або виведення; beamer, html або html5 для
лише вихід), pandoc розглядатиме документ як грамотне джерело Haskell. Це означає що
· При введенні Markdown розділи «треку птахів» будуть аналізуватися як код Haskell, а не
блок цитат. Текст між \begin{code} і \end{code} також розглядатиметься як
Код Haskell. Для заголовків у стилі ATX замість «#» використовуватиметься символ «=».
· У виводі Markdown блоки коду з класами haskell і literate будуть відтворені з використанням
сліди птахів і блокові цитати будуть з відступом на один пробіл, тому їх не буде
розглядається як код Haskell. Крім того, заголовки відображатимуться у стилі setext (with
підкреслення), а не в стилі ATX (зі символами «#»). (Це тому, що ghc лікує
Символи "#" у стовпці 1 для введення номерів рядків.)
· При введеній структурі тексту розділи "пташиної доріжки" будуть аналізуватися як код Haskell.
· У реструктуризованому текстовому виводі блоки коду з класом haskell відображатимуться за допомогою bird
треків.
· При введенні LaTeX текст у середовищі коду буде аналізуватися як код Haskell.
· У виводі LaTeX блоки коду з класом haskell відображатимуться всередині коду
Середовища.
· У виводі HTML блоки коду з класом haskell відображатимуться разом із класом
грамотні сліди черепа та птахів.
Приклади:
pandoc -f уцінка+lhs -t html
читає грамотне джерело Haskell, відформатований за умовами Markdown, і пише звичайний HTML
(без пташиних слідів).
pandoc -f уцінка+lhs -t html+lhs
записує HTML із кодом Haskell у слідах птахів, тому його можна скопіювати та вставити як
грамотне джерело Haskell.
СИНТАКС ВИДІЛЮВАННЯ
Pandoc автоматично виділить синтаксис у закритих блоках коду, позначених символом a
назва мови. Для виділення використовується бібліотека Haskell highlighting-kate, яка
працює з виведенням HTML, Docx і LaTeX/PDF. Колірну схему можна вибрати за допомогою
--опція стилю виділення. Колірна схема за замовчуванням — пігменти, яка імітує
колірна схема за замовчуванням, що використовується бібліотекою Python pygments, але pygments насправді не є
використовувався для мелірування.
Щоб побачити список назв мов, які pandoc розпізнає, введіть pandoc --version.
Щоб вимкнути виділення, використовуйте параметр --no-highlight.
ПОСЛУГИ ПИСЬМЕННИКИ
Pandoc можна розширити за допомогою спеціальних програм для написання, написаних на lua. (Pandoc включає в себе lua
інтерпретатор, тому lua не потрібно встановлювати окремо.)
Щоб використовувати спеціальний записувач, просто вкажіть шлях до сценарію lua замість виводу
формату. Наприклад:
pandoc -t data/sample.lua
Створення спеціального запису вимагає написання функції lua для кожного можливого елемента в a
документ pandoc. Щоб отримати документований приклад, який ви можете змінити відповідно до ваших
потребує, роби
pandoc --print-default-data-file sample.lua
AUTHORS
© 2006-2015 Джон Макфарлейн ([захищено електронною поштою]). Випущено під ліцензією GPL, версія 2 або
більший. Це програмне забезпечення не дає жодних гарантій. (Див. АВТОРСЬКЕ ПРАВО для повної інформації
повідомлення про авторські права та гарантію.)
Серед учасників — Аарон Волен, Альберт Кревінкель, Олександр Кондрацький, Олександр
Сульфріан, Олександр V Вершилов, Альфред Вехсельбергер, Андреас Льов, Ендрю Даннінг,
Антуан Латтер, Арата Мізукі, Арло О'Кіф, Артем Казак, Бен Гамарі, Бені
Чернявський-Паскін, Бьорн Бакволтер, Бредлі Кун, Брент Йоргі, Браян О'Салліван, Б.
Скотт Мішель, Калеб МакДеніел, Келвін Бек, Крістоффер Аккельман, Крістоффер Савікі,
Клер Макрей, Клінт Адамс, Конал Елліотт, Крейг С. Босма, Деніел Берджі, Деніел Т.
Стал, Девід Лазар, Девід Ротлісбергер, Деніс Лаксальде, Дуглас Калверт, Дуглас Ф.
Калверт, Ерік Коу, Ерік Зайдель, Флоріан Ейтель, Франсуа Ганназ, Фрейрік Баррал, Федір
Шереметьєв, Габор Палі, Гевін Бітті, Грег Маслов, Грегорі Батай, Грег Рандлетт,
gwern, Gwern Branwen, Hans-Peter Deifel, Henry de Valence, Ilya V. Portnov, infinity0x,
Хайме Маркінес Феррандіс, Джеймс Аспнес, Джеймі Ф. Олсон, Ян Ларрес, Джейсон Роналло, Джефф
Арнольд, Джефф Раннінген, Йенс Петерсен, Джеремі Боббіо, Джессі Розенталь, Дж. Льюїс Мюір, Джо
Хілленбранд, Джон МакФарлейн, Йонас Смеґеґард, Джонатан Догерті, Йозеф Свеннінгссон,
Хосе Луїс Дюран, Жюльєн Кретель, Джастін Богнер, Келсі Хайтауер, Костянтин Зудов,
Ларс-Домінік Браун, Люк Плант, Марк Шепієнец, Марк Райт, Масайоші Такахаші, Матей
Коллар, Матіас Шеннер, Метью Пікерінг, Маттіас CM Троффаес, Мауро Біг, Макс
Болінгброк, Макс Рідал Андерсен, Мерійн Верстраатен, Майкл Снойман, Майкл Томпсон,
МінРК, Натан Гасс, Ніл Мейхью, Нік Барт, Ніколас Кайзер, Микола Якимов, Нкалві, Пауло
Танімото, Поль Рів'є, Пітер Ван, Філіп Омбредан, Філіп Алдей, Пунет Чаганті,
qerub, Ralf Stephan, Recai Oktaş, rodja.trappe, RyanGlScott, Scott Morrison, Sergei
Трофимович, Сергій Астанін, Шахбаз Юсефі, Шон Атфілд, shreevatsa.public, Саймон
Хенгель, Суміт Сахрават, Такахашим, Тсаттон, Тім Лін, Тімоті Хамфріс, Тодд Сіфліт,
Том Ліз, Улі Келер, Вацлав Земан, Віктор Кронвалл, Вінсент, Wikiwide та Ксав’єр Олів.
Вихідний код Pandoc і всю документацію можна завантажитиhttp://pandoc.org>.
Використовуйте pandoc онлайн за допомогою служб onworks.net