publish
Сгенерируйте представление файла MATLAB в заданном формате
Синтаксис
Описание
publish( генерирует представление заданного файла кода MATLAB® и выход в формате HTML, который может использоваться для совместного использования. file)publish сохранил файл HTML и файл для каждой диаграммы, которую код создает в подпапке под названием html. Местоположение html подпапка относительно местоположения file.
Например, publish('C:\myMATLABfiles\myfile.m') запускает код в myfile.m использование базового рабочего пространства, и затем сохраняет отформатированный код и приводит к C:\myMATLABfiles\html\myfile.html.
publish( генерирует представление заданного файла MATLAB с опциями, заданными одним или несколькими file,Name,Value)name,value парные аргументы.
publish( использует file,options)options структура, чтобы сгенерировать представление заданного файла MATLAB. Используя структуру, чтобы задать опции полезно, когда это необходимо, чтобы предварительно сконфигурировать и сохранить ваши опции для повторного использования. Поля и значения options структура соответствует именам и значениям аргументов пары "имя-значение".
Примеры
Генерация РЕЖИМА ПРОСМОТРА HTML СКРИПТА MATLAB
Сгенерируйте режим просмотра HTML скрипта MATLAB включая код, результаты и комментарии.
Скопируйте файл в качестве примера fourier_demo2.m к вашей текущей папке.
filename = fullfile(matlabroot,'help','techdoc','matlab_env','examples','fourier_demo2.m'); copyfile(filename,'.','f')
Используйте publish функционируйте, чтобы запустить пример и сгенерировать режим просмотра HTML примера. Затем используйте web функционируйте, чтобы просмотреть получившийся файл.
publish('fourier_demo2.m'); web('html/fourier_demo2.html')
Генерация представления СКРИПТА MATLAB в формате Microsoft Word
Сгенерируйте представление Word Microsoft® скрипта MATLAB включая код, результаты и комментарии.
Скопируйте файл в качестве примера fourier_demo2.m к вашей текущей папке.
filename = fullfile(matlabroot,'help','techdoc','matlab_env','examples','fourier_demo2.m'); copyfile(filename,'.','f')
Используйте publish функция, чтобы сгенерировать представление Microsoft Word примера. Затем используйте winopen функционируйте, чтобы просмотреть получившийся файл.
publish('fourier_demo2.m','doc'); winopen('html/fourier_demo2.doc')
Настройте представление СКРИПТА MATLAB Используя пары "имя-значение"
Используйте аргументы пары "имя-значение", чтобы изменить внешний вид опубликованных окон рисунка в режиме просмотра HTML скрипта MATLAB.
Скопируйте файл в качестве примера fourier_demo2.m к вашей текущей папке.
filename = fullfile(matlabroot,'help','techdoc','matlab_env','examples','fourier_demo2.m'); copyfile(filename,'.','f')
Используйте publish функция, чтобы сгенерировать режим просмотра HTML примера. Используйте 'figureSnapMethod' аргумент пары "имя-значение" со значением 'entireFigureWindow' включать художественные оформления окна и соответствовать цвету фона рисунка к цвету экрана для фигур. Затем используйте web функционируйте, чтобы просмотреть получившийся файл.
publish('fourier_demo2.m','figureSnapMethod','entireFigureWindow') web('html/fourier_demo2.html')
Настройте представление СКРИПТА MATLAB Используя структуру
Используйте структуру, чтобы создать представление Microsoft Word скрипта MATLAB, который не показывает код из скрипта. При определении опций, когда структура полезна, когда это необходимо, чтобы предварительно сконфигурировать и сохранить опции для повторного использования.
Скопируйте файл в качестве примера fourier_demo2.m к вашей текущей папке.
filename = fullfile(matlabroot,'help','techdoc','matlab_env','examples','fourier_demo2.m'); copyfile(filename,'.','f')
Создайте структуру options это задает format и showcode опции.
options.format = 'doc';
options.showCode = false;
Используйте publish функция, чтобы сгенерировать представление Microsoft Word примера с помощью опций, заданных в options. Затем используйте winopen функционируйте, чтобы просмотреть получившийся файл.
publish('fourier_demo2.m',options); winopen('html/fourier_demo2.doc')
Сгенерируйте РЕЖИМ ПРОСМОТРА HTML функции MATLAB с входными параметрами
Сгенерируйте режим просмотра HTML функции MATLAB, которая требует входных параметров.
Создайте и сохраните функциональный fact.m.
%% FACT compute the factorial of a number % FACT(N) computes the factorial of the number N and returns the results function f = fact(n) f = prod(1:n); end
Используйте publish функция, чтобы сгенерировать режим просмотра HTML функции. Установите значение входного параметра n при помощи 'codeToEvaluate' аргумент пары "имя-значение". Затем используйте web функционируйте, чтобы просмотреть получившийся файл.
publish('fact.m','codeToEvaluate','fact(5);') web('html/fact.html')
Сохранение пути к файлу опубликованного скрипта к переменной
Сгенерируйте режим просмотра HTML скрипта MATLAB и сохраните путь опубликованного файла HTML к переменной.
Скопируйте файл в качестве примера fourier_demo2.m к вашей текущей папке.
filename = fullfile(matlabroot,'help','techdoc','matlab_env','examples','fourier_demo2.m'); copyfile(filename,'.','f')
Используйте publish функция, чтобы сгенерировать режим просмотра HTML примера и сохранить путь опубликованного файла HTML к переменной mydoc.
mydoc = publish('fourier_demo2.m')
mydoc = C:\myMATLABfiles\html\fourier_demo2.html
Входные параметры
file — Имя файла MATLAB
вектор символов | строка
Имя файла MATLAB в виде вектора символов или строки. file может включать весь или частичный путь.
Примечание
Когда MATLAB публикует файл, он может перезаписать существующие файлы от выходной папки, которые запускаются с того же имени как file.
Пример: publish('myfile.m')
Пример: publish('C:\myMATLABfiles\myfile.m')
format 'OutputFormat'
'html' (значение по умолчанию) | 'doc' | 'latex' | 'ppt' | 'xml' | 'pdf'
Выходной формат опубликованного файла в виде одного из перечисленных в таблице значений.
| Значение | 'OutputFormat' |
|---|---|
'html' (значение по умолчанию) | Язык разметки гипертекста |
'doc' | Microsoft Word |
'latex' | LaTeX |
'ppt' | Microsoft PowerPoint® |
'xml' | Расширяемый язык разметки |
'pdf' | Формат переносимых документов (PDF) |
Microsoft Word и форматы Microsoft PowerPoint только доступны на платформах Windows®.
MATLAB не сохраняет подсветку синтаксиса, когда вы задаете выходной формат как Microsoft PowerPoint или LaTeX.
Пример: publish('myfile.m','ppt');
options — Опции для опубликованного выхода
структура
Опции для опубликованного выхода в виде структуры. Используйте options структура вместо аргументов пары "имя-значение", когда это необходимо, чтобы снова использовать ту же настройку для публикации нескольких файлов MATLAB.
Поля и значения options структура соответствует именам и значениям аргументов пары "имя-значение".
Например, эта команда создает структуру options, и задает выходной формат PDF и выходную папку C:\myPublishedOutput.
options = struct('format','pdf','outputDir','C:\myPublishedOutput')
Аргументы в виде пар имя-значение
Задайте дополнительные разделенные запятой пары Name,Value аргументы. Name имя аргумента и Value соответствующее значение. Name должен появиться в кавычках. Вы можете задать несколько аргументов в виде пар имен и значений в любом порядке, например: Name1, Value1, ..., NameN, ValueN.
'format','pdf','showCode',false задает формат выходного файла PDF и исключает код из выхода.'format' 'OutputFormat'
'html' (значение по умолчанию) | 'doc' | 'latex' | 'ppt' | 'xml' | 'pdf'
Выходной формат опубликованного файла в виде одного из перечисленных в таблице значений.
| Значение | 'OutputFormat' |
|---|---|
'html' (значение по умолчанию) | Язык разметки гипертекста (HTML) |
'doc' | Microsoft Word |
'latex' | LaTeX |
'ppt' | Microsoft PowerPoint |
'xml' | Расширяемый язык разметки |
'pdf' | Формат переносимых документов (PDF) |
Microsoft Word и форматы Microsoft PowerPoint только доступны на платформах Windows.
MATLAB не сохраняет подсветку синтаксиса, когда вы задаете выходной формат как Microsoft PowerPoint или LaTeX.
Пример: publish('myfile.m','format','pdf')
'outputDir' 'OutputFolder'
символьный вектор
Выведите папку, в которую опубликованный документ сохранен в виде вектора символов. Задайте полный путь папки.
Пример: publish('myfile.m','outputDir','C:\myPublishedOutput')
'stylesheet' — Расширяемый язык таблиц стилей (XSL) файл
символьный вектор
Расширяемый язык таблиц стилей (XSL) файл, чтобы использовать при публикации файла MATLAB в HTML, XML или формат LaTeX в виде вектора символов. Задайте полный путь файла XSL.
Пример: publish('myfile.m','stylesheet','C:\myStylesheet\stylesheet.xsl')
'createThumbnail' — Создать ли изображение миниатюр
true (значение по умолчанию) | false
Создать ли изображение миниатюр для опубликованного документа в виде true или false. Можно использовать сгенерированную миниатюру, чтобы отобразить маленькое представление файла на страницах HTML.
'figureSnapMethod' — Внешний вид окна рисунка
'entireGUIWindow' (значение по умолчанию) | 'print' | 'getframe' | 'entireFigureWindow'
Внешний вид окна рисунка для опубликованного документа в виде одного из перечисленных в таблице значений. Внешний вид окна рисунка включает цвет фона графика и включает ли это художественные оформления окна (строка заголовка, панель инструментов, панель меню и граница окна).
Эта опция не доступна в MATLAB Online™.
| Значение | Художественные оформления окна | BackgroundColor | ||
|---|---|---|---|---|
| Графический интерфейсы пользователя | Фигуры | Графический интерфейсы пользователя | Фигуры | |
| Включенный | Исключенный | Экран Matches | Белый |
| Исключенный | Исключенный | Белый | Белый |
| Исключенный | Исключенный | Экран Matches | Экран Matches |
| Включенный | Включенный | Экран Matches | Экран Matches |
'imageFormat' — Формат файла изображения
'png' | 'epsc2' | 'jpg' | ...
Формат файла изображения для изображений в опубликованном документе в виде одного из перечисленных в таблице значений. Список допустимых форматов изображения зависит от заданного выходного формата.
| 'OutputFormat' | Допустимые форматы изображения | Формат изображения по умолчанию |
|---|---|---|
| Microsoft Word | Любой формат изображения, который ваша установленная версия Microsoft Office может импортировать, включая | 'png' |
| Язык разметки гипертекста (HTML) | Все форматы изображения. Убедитесь, что инструменты вы используете для представления и обрабатываете выходные файлы, может отобразить выходной формат, который вы задаете. | 'png' |
| LaTeX | Все форматы изображения. Убедитесь, что инструменты вы используете для представления и обрабатываете выходные файлы, может отобразить выходной формат, который вы задаете. |
Значение по умолчанию превращается в
|
| Формат переносимых документов (PDF) |
| 'bmp' |
| Microsoft PowerPoint | Любой формат, который ваша установленная версия Microsoft Office может импортировать, включая | 'png' |
| Расширяемый язык разметки (XML) | Все форматы изображения. Убедитесь, что инструменты вы используете для представления и обрабатываете выходные файлы, может отобразить формат изображения, который вы задаете. | 'png' |
'maxHeight' — Максимальная высота изображения
[] (значение по умолчанию) | положительное целое число
Максимальная высота изображения опубликованных изображений в виде одного из этих значений:
[](значение по умолчанию) — Неограниченная высота. Это значение всегда используется, когда выходным форматом является PDF.Положительное целое число — Высота в пикселях.
'maxWidth' — Максимальная ширина изображения
[] (значение по умолчанию) | положительное целое число
Максимальная ширина изображения опубликованных изображений в виде одного из этих значений:
[](значение по умолчанию) — Неограниченная ширина. Это значение всегда используется, когда выходным форматом является PDF.Положительное целое число — Ширина в пикселях.
'useNewFigure' — Создать ли новую фигуру
true (значение по умолчанию) | false
Создать ли новую фигуру в виде true или false. Если true и код генерирует фигуру, затем MATLAB создает новое окно рисунка в размере по умолчанию с белым фоном перед публикацией. Если false, MATLAB не создает окно рисунка.
Определение значения false полезно, если вы хотите использовать фигуру с различными свойствами для публикации. Например, можно создать окно фигуры, изменить размер и цвет фона, и затем опубликовать код. Фигуры в вашем опубликованном документе используют характеристики фигуры, которую вы открыли перед публикацией.
'evalCode' — Запустить ли код
true (значение по умолчанию) | false
Запустить ли код и включать выход MATLAB в опубликованное представление в виде true или false.
'catchError' — Зафиксировать ли ошибки
true (значение по умолчанию) | false
Зафиксировать ли ошибки во время публикации в виде true или false. Если true и ошибка происходит, MATLAB продолжает публиковать и включает ошибку в опубликованный файл. Если false и ошибка происходит, MATLAB отображает ошибку в командной строке и не производит опубликованный файл.
'codeToEvaluate' — Дополнительный код, чтобы запуститься
символьный вектор
Дополнительный код, чтобы запуститься во время публикации в виде вектора символов. Используйте эту опцию, чтобы запустить код, который не включен в файл MATLAB. Например, при публикации функции, можно установить значение входных параметров.
Если эта опция не задана, MATLAB только запускает код в файле MATLAB, который вы публикуете.
Пример: publish('myfunction.m','codeToEvaluate','myfunction(1,10)')
'maxOutputLines' — Максимальное количество линий
Inf (значение по умолчанию) | неотрицательное целочисленное значение
Максимальное количество линий выхода, который будет включен в опубликованный документ в виде одного из этих значений:
Inf(значение по умолчанию) — MATLAB включает весь выход в опубликованный документ.Неотрицательное целое число — MATLAB только включает конкретное количество линий в опубликованном документе. Устанавливание этой опции полезно, если меньшая, репрезентативная проба выхода достаточна.
'showCode' — Включать ли код
true (значение по умолчанию) | false
Включать ли код в опубликованный файл в виде true или false.
Если выходной формат является HTML, MATLAB включает код в конце опубликованного файла HTML как комментарии, даже когда вы устанавливаете 'showCode' опция к false. Включая код как комментарии включает grabcode функционируйте, чтобы извлечь код MATLAB из файла HTML, даже когда файл не отображает код. Код не отображается в веб-браузере, потому что MATLAB включает код как комментарии.
Советы
Чтобы улучшить удобочитаемость опубликованного документа и включать дополнительные снимки изображения, внешнее содержимое файла и внешние изображения, видят Разметку Публикации.
publishфункция не включает форматированный текст при генерации представления live скрипта или live функции (.mlx). Чтобы сгенерировать представление целого live скрипта или live функции, экспортируйте файл вместо этого. На вкладке Live Editor, в разделе File, нажимают Export
и выбор из доступных опций экспорта. Для получения дополнительной информации смотрите Live скрипты Доли и Функции.