11.11.1 Публикация файлов скриптов Octave ¶

Функция publish предоставляет динамическую возможность документировать ваш файл скрипта. В отличие от статической документации, publish выполняет файл скрипта, сохраняет любые графики и вывод во время выполнения скрипта и отображает их вместе со статической документацией в желаемом формате вывода. Статическая документация может использовать разметку публикации для улучшения и настройки вывода.

: publish (file) ¶

: publish (file, output_format) ¶

: publish (file, option1, value1, …) ¶

: publish (file, options) ¶

: output_file = publish (file, …) ¶

Создает отчет из файла скрипта Octave file в одном из нескольких форматов вывода.

Сгенерированные отчеты интерпретируют разметку публикации в комментариях к секциям, что подробно объясняется в руководстве по GNU Octave. Комментарии к секциям — это блоки комментариев, начинающиеся с строки с двойным символом комментария.

Рассмотрим следующий пример с использованием разметки публикации, содержащийся в файле скрипта pub_example.m:

## Headline title
#
# Some *bold*, _italic_, or |monospaced| Text with
# a <https://www.octave.org link to *GNU Octave*>.
##

# "Real" Octave commands to be evaluated
sombrero ()

%% MATLAB comment style ('%') is supported as well
%
% * Bulleted list item 1
% * Bulleted list item 2
%
% # Numbered list item 1
% # Numbered list item 2

Чтобы опубликовать этот файл скрипта, введите publish ("pub_example.m").

При вызове с одним входным аргументом генерируется HTML-отчет в подкаталоге html относительно текущей рабочей директории. Любые команды Octave в pub_example.m вычисляются в отдельном контексте, и любые созданные графики во время выполнения файла скрипта включаются в отчет.

Использование publish (file, output_format) эквивалентно вызову функции со структурой

options.format = output_format;
publish (file, options)

которая описана ниже. То же самое относится к использованию пар «ключ/значение»

options.option1 = value1;
publish (file, options)

Структура options может иметь следующие имена полей. Если имя поля не указано, используется значение по умолчанию:

• ‘format’ — Формат вывода опубликованного файла скрипта, один из

  ‘html’ (по умолчанию), ‘doc’, ‘latex’, ‘ppt’, ‘pdf’ или ‘xml’.

  Форматы вывода ‘doc’, ‘ppt’ и ‘xml’ в настоящее время не поддерживаются. Чтобы сгенерировать отчет ‘doc’, откройте сгенерированный отчет ‘html’ в вашей программе обработки документов.

  В Octave пользовательские форматы поддерживаются путем реализации всех подфункций обратного вызова в файле функции с именем ‘__publish_<custom format>_output__.m’. Чтобы получить шаблон для формата HTML, введите:

  edit (fullfile (fileparts (which ("publish")), ...
        "private", "__publish_html_output__.m"))

• ‘outputDir’ — Полный путь к каталогу, где будет расположен сгенерированный отчет. Если каталог не указан, отчет генерируется в подкаталоге html относительно текущей рабочей директории.
• ‘stylesheet’ — Не поддерживается, только для совместимости с MATLAB.
• ‘createThumbnail’ — Не поддерживается, только для совместимости с MATLAB.
• ‘figureSnapMethod’ — Не поддерживается, только для совместимости с MATLAB.
• ‘imageFormat’ — Желаемый формат любых изображений, созданных во время вычисления кода. Допустимые форматы изображений зависят от формата вывода:
  • ‘html’, ‘xml’ — ‘png’ (по умолчанию), любой формат изображения, поддерживаемый Octave
  • ‘latex’ — ‘epsc2’ (по умолчанию), любой формат изображения, поддерживаемый Octave
  • ‘pdf’ — ‘jpg’ (по умолчанию) или ‘bmp’, обратите внимание, что MATLAB использует ‘bmp’ по умолчанию
  • ‘doc’ или ‘ppt’ — ‘png’ (по умолчанию), ‘jpg’, ‘bmp’ или ‘tiff’
• ‘maxWidth’ и ‘maxHeight’ — Максимальная ширина (высота) созданных изображений в пикселях. Пустое значение означает отсутствие ограничения. Оба значения должны быть установлены для правильной работы параметра.

  ‘[]’ (по умолчанию), целое число ≥ 0

• ‘useNewFigure’ — Использовать новое окно графиков для графиков, созданных оцениваемым кодом. Это предотвращает побочные эффекты с уже открытыми окнами графиков.

  ‘true’ (по умолчанию) или ‘false’

• ‘evalCode’ — Вычислять код файла исходного кода Octave

  ‘true’ (по умолчанию) или ‘false’

• ‘catchError’ — Перехватывать ошибки во время оценки кода и продолжать

  ‘true’ (по умолчанию) или ‘false’

• ‘codeToEvaluate’ — Команды Octave, которые должны быть вычислены до публикации файла скрипта. Эти команды Octave не отображаются в сгенерированном отчете.
• ‘maxOutputLines’ — Максимальное количество строк вывода из оценки кода, которые включаются в вывод.

  ‘Inf’ (по умолчанию) или целое число > 0

• ‘showCode’ — Показывать вычисленные команды Octave в сгенерированном отчете

  ‘true’ (по умолчанию) или ‘false’

Параметр output_file — строка с путем и именем файла сгенерированного отчета.

См. также: grabcode.

Аналогом publish является grabcode:

: grabcode filename ¶

: grabcode url ¶

: code_str = grabcode (…) ¶

Извлекает код из отчета, созданного функцией publish.

Извлеченный код внутри опубликованного отчета должен быть заключен в строки ‘##### SOURCE BEGIN #####’ и ‘##### SOURCE END #####’. Функция publish автоматически создает этот формат.

Если не запрашивается возвращаемое значение, код сохраняется во временном файле и открывается в стандартном редакторе. ПРИМЕЧАНИЕ: временный файл должен быть сохранен под новым именем, иначе код будет потерян.

Если запрашивается вывод, извлеченный код возвращается как строка code_str.

Пример:

publish ("my_script.m");
grabcode ("html/my_script.html");

В примере выше файл my_script.m публикуется по умолчанию в местоположении html/my_script.html. Затем опубликованный скрипт Octave извлекается для редактирования его содержимого в новом временном файле.

См. также: publish.