Справочный центр

Правила разбора файлов
*.md

Правила синтаксического разбора файлов *.md для локализации приложения
Исходные файлы
Назначение файлов:
Markdown (.md) - облегчённый язык разметки, созданный с целью обозначения форматирования в простом тексте, с максимальным сохранением его читаемости человеком.
Файлы md часто используются для написания Справки к различным программам.

Локализация md-файла подразумевает его полный перевод. В локализуемых приложениях md-файлы чаще всего хранятся в составе директорий языковых версий: например, «\ru\readme.md» – для русскоязычной версии, «\en\readme.md» – для англоязычной и т.д.

Пример исходного .md файла:
Где то среди текста встречается [текст ссылки][example].

Также ссылка повторяется [пример адреса][example].

Ссылка на [второй][foo] также [Bar][] ресурсы.

[example]: http://example.com/ "Необязательный заголовок ссылки"
[foo]: http://example.net/ 'Необязательный заголовок ссылки'
[bar]: http://example.edu/ (Необязательный заголовок ссылки)
Анализ
Задача разбивки md-файла на строки для перевода в нашем сервисе решается следующим образом:

В качестве основного структурного элемента md-файла приняты параграфы, т.е. блоки текстовых строк, разделенные пустыми строками. Синтаксический анализ файла в сервисе заключается в выделении таких блоков, а также их дополнительном разбиении следующими элементами md-формата:
  1. комментариями вида «<!-- … -->»,
  2. метками цитирования «>».
Определенные сложности могут возникнуть при загрузке в сервис файла-перевода для ранее загруженного оригинала md-файла: если структура параграфов (число и/или порядок) в оригинальном и переведенном файлах различна, возможно некорректное сопоставление строк оригинала и перевода.

Перед загрузкой удостоверьтесь, что структура файла-перевода соответствует структуре оригинального файла, и, если требуется, отредактируйте загружаемый файл.
Процесс перевода:
  • загружаете в сервис файлы оригинала
  • переводите в сервисе на нужные языки
  • формируете из сервиса файлы с переводом на нужные языки
  • подключаете в своем приложении локализованные файлы