mdoc-assembly - онлайн в облаке

ПРОГРАММА:

ИМЯ

mdoc Assembly - Компиляция документации для использования в монодок(1)

СИНТАКСИС

mdoc собираться [ОПЦИИ] + ПУТИ +

ОПИСАНИЕ

mdoc собираться создает .дерево и .zip файлы из ПУТИ для использования в монодок(1)
браузер документации.

Входные файлы должны иметь поддерживаемый формат, указанный с --формат опцию.

Команда .дерево и .zip файлы копируются в монодок's источники каталог вместе с .источник
файл, который используется монодок(1), чтобы указать, где должна отображаться документация.

Команда .источник файл имеет следующий формат:

<? XML-версия = "1.0">






elements -->


Команда / монодок / узел узел - это необязательный узел, который указывает, где в дереве монодока
документация должна быть отображена, и //узел элементы могут быть вложены на любую глубину, чтобы
создавать деревья. // узел / @ метка - это метка, которая будет отображаться в дереве монодока.

// узел / @ имя является именем узла дерева монодока и может использоваться как значение
/ monodoc / source / @ путь значения.

// узел / @ родитель - это имя узла, которое будет использоваться в качестве родительского узла.
$ MONO_INSTALL_PREFIX / lib / monodoc / monodoc.xml содержит список таких имен, и это может
быть любым // узел / @ имя значение. Если // узел / @ родитель значение не найдено, затем оно вставлено
под узлом дерева "Разное".

Команда / монодок / источник / @ поставщик атрибут указывает, какой поставщик формата следует использовать
при чтении .дерево и .zip файлы; это должен соответствуют одному из --формат значения.

Команда / монодок / источник / @ базовый файл атрибут определяет префикс имени файла для
файлы документации. Это должен быть тот же префикс, который используется с --из Параметр.
Там должен быть нет расширение имени файла для этого значения.

Команда / monodoc / source / @ путь атрибут определяет родительский узел в монодок(1) представление в виде дерева
куда будет вставлена ​​документация. Увидеть
$ MONO_INSTALL_PREFIX / lib / monodoc / monodoc.xml файл для списка PATH ценности (
// узел / @ имя значения), или это может быть // узел / @ имя ценность в том же .источник .

Как только появится строка БАЗОВЫЙ ФАЙЛ.source был написан, документацию можно установить так, чтобы
монодок(1) отобразит документацию с помощью команды:

cp БАЗОВЫЙ ФАЙЛ.источник БАЗОВЫЙ ФАЙЛ.дерево БАЗОВЫЙ ФАЙЛ.zip \
`pkg-config monodoc --variable = sourcesdir`

ДОПОЛНИТЕЛЬНЫЕ ОПЦИИ

-f, --формат=ФОРМАТ
Задает формат документации, используемый в ПУТИ, действительный ФОРМАТ значения включают:
экма, экмаспек, ошибка, hb, человек, декриминализованои xhtml.

Смотрите пост в ФОРМАТЫ раздел ниже для получения дополнительной информации об этих форматах.

Формат по умолчанию (если не указан): экма.

Команда --формат опция может чередоваться с ПУТИ изменить формат, используемый для
оставшиеся параметры (до следующего --формат вариант), например:

mdoc Assembly -o ПРЕФИКС AB --format = man CD --format = xhtml E

соберет каталоги A и B с экма формат, файлы C и D с человек
formt и каталог E с xhtml формат.

-o, --из=ПРЕФИКС
Укажите префикс выходного файла. mdoc собираться создает файлы ПРЕФИКС.zip и
ПРЕФИКС.дерево.

-h, -?, --Помогите
Отобразите справочное сообщение и выйдите.

ФОРМАТЫ

Поддерживаются следующие форматы документации:

экма
Команда Моно ECMA Документация Формат, формат документации XML с одним файлом каждого типа.

Смотрите пост в mdoc(5) справочная страница для получения дополнительной информации.

экмаспек
Команда Моно ECMA Спецификация Документация Формат. Это не тот формат, который вы ищете
для; это формат, используемый для представления стандарта ECMA-334 (C #) в монодок(1). Это
не используется для отображения документации библиотеки классов; для документации библиотеки классов используйте
экма формат.

ошибка
Команда Ошибка Документация Формат используется для представления подробных сообщений об ошибках и используется в
монодок(1) дерево «Справочник по ошибкам компилятора C #».

В этом формате ПУТИ это файл конфигурации, содержащий XML:


../../mcs/errors
cs ???? *. cs
2
4
CS {0: 0 ###}


Элементы означают:

/ ErrorProviderConfig / FilesPath
Указывает, где искать файлы.

/ ErrorProviderConfig / Match
Задает шаблон имени файла для поиска в
/ ErrorProviderConfig / FilesPath каталог.

/ ErrorProviderConfig / ErrorNumSubstringStart
Указывает, где в имени файла начинается номер ошибки.

/ ErrorProviderConfig / ErrorNumSubstringLength
Указывает, сколько символов после / ErrorProviderConfig / ErrorNumSubstringStart в
используйте для номера ошибки.

/ ErrorProviderConfig / FriendlyFormatString
Задает форматирование / отображение узла в монодок(1) дерево.

Для каждого найденного файла он конвертируется в HTML с применением раскраски синтаксиса C #.

декриминализовано
Команда просто Документация Формат формат файла рекурсивно добавляет все файлы и каталоги
под ПУТИ. При отображении файлы HTML отображаются как есть. Текстовые файлы
преобразован в HTML путем перевода каждой новой строки в HTML элемент. Нет другого файла
Тип поддерживается.

человек
Команда Мужчина страница Документация Формат отображает страницы руководства groff. (Это полный грофф
parser и обрабатывает только конструкции страниц руководства, используемые в моно страницах руководства.)

ПУТИ представляет собой набор файлов XML, содержащих:

<? XML-версия = "1.0">




Может быть несколько // страница руководства элементы в корне / manpage элемент.

Команда / manpages / manpage / @ имя атрибут содержит отображаемое имя для узла представления в виде дерева,
который также является URL-адресом страницы руководства при использовании монодок(1) Поиск URL команда (до
с префиксом мужчина: приставка). Таким образом, если / manpages / manpage / @ имя содержит моно(1), то
мужчина:моно(1) может быть использован в Поиск URL команда для просмотра моно(1) справочная страница.

Команда / manpages / manpage / @ страница Атрибут - это имя файла, содержащего справочную страницу. Если это
файл не существует, тогда / manpages / manpage / @ имя не будет отображаться в дереве
Посмотреть.

xhtml
Провайдер XHTML интерпретирует ПУТИ как файл XHTML TOC файла справки Windows и ищет
ссылочные документы для создания источника справки.

Используйте mdoc-assembly онлайн с помощью сервисов onworks.net