publish

Сгенерируйте представление файла MATLAB в заданном формате

Свернуть все на странице

Синтаксис

publish(file)
publish(file,format)
publish(file,Name,Value)
publish(file,options)
my_doc = publish(file,___)

Описание

пример

publish(file) генерирует представление указанного MATLAB® файл кода и выход в формате HTML, который можно использовать для совместного использования. publish сохраняет HTML и файл для каждого графика, созданный кодом, в подпапке с именем html. Расположение html подпапка относится к расположению file.

Для примера, publish('C:\myMATLABfiles\myfile.m') запускает код в myfile.m использование базового рабочего пространства, а затем сохранение форматированного кода и результаты в C:\myMATLABfiles\html\myfile.html.

пример

publish(file,format) генерирует представление указанного файла MATLAB в указанном формате файла. Все форматы файлов сохраняются в html подпапка.

пример

publish(file,Name,Value) генерирует представление указанного файла MATLAB с опциями, заданными одним или несколькими name,value аргументы в виде пар.

пример

publish(file,options) использует options структура для генерации представления указанного файла MATLAB. Использование структуры для задания опций полезно, когда необходимо предварительно сконфигурировать и сохранить опции для повторного использования. Поля и значения options структура соответствует именам и значениям аргументов пары "имя-значение".

пример

my_doc = publish(file,___) генерирует представление указанного файла 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')

Сгенерируйте 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')

Используйте аргументы пары "имя-значение", чтобы изменить внешний вид опубликованных окон рисунка в 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')

Используйте структуру для создания представления 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, которая требует входных параметров.

Создайте и сохраните функцию 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

Входные параметры

свернуть все

Имя файла MATLAB в виде вектора символов или строки. file может включать полный или частичный путь.

Примечание

Когда MATLAB публикует файл, он может перезаписать существующие файлы из выходов папки, которые начинаются с того же имени, что и file.

Пример: publish('myfile.m')

Пример: publish('C:\myMATLABfiles\myfile.m')

Выход опубликованного файла, заданный как одно из значений, перечисленных в таблице.

ЗначениеВыход
'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 структура вместо аргументов пары "имя-значение", если необходимо повторно использовать то же строение для публикации нескольких файлов 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 и исключает код из выхода.
Опции выхода

свернуть все

Выход опубликованного файла, заданный как одно из значений, перечисленных в таблице.

ЗначениеВыход
'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')

Выходная папка, в которой сохранен опубликованный документ, заданная как вектор символов. Укажите полный путь к папке.

Пример: publish('myfile.m','outputDir','C:\myPublishedOutput')

Расширяемый файл языка таблиц стилей (XSL), используемый при публикации файла MATLAB в формате HTML, XML или LaTeX в виде вектора символов. Укажите полный путь к XSL- файла.

Пример: publish('myfile.m','stylesheet','C:\myStylesheet\stylesheet.xsl')

Опции фигуры

свернуть все

Создание ли миниатюрного изображения для опубликованного документа, заданное как true или false. Можно использовать сгенерированную миниатюру для отображения небольшого представления файла на HTML.

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

Эта опция недоступна в Online™ MATLAB.

ЗначениеОконные украшенияЦвет фона
 Графические интерфейсы пользователяФигурыГрафические интерфейсы пользователяФигуры

'entireGUIWindow' (по умолчанию)

Включенный

Исключенный

Соответствие экрану

Белый

'print'

Исключенный

Исключенный

Белый

Белый

'getframe'

Исключенный

Исключенный

Соответствие экрану

Соответствие экрану

'entireFigureWindow'

Включенный

Включенный

Соответствие экрану

Соответствие экрану

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

ВыходДопустимые форматы изображенийФормат изображения по умолчанию
Microsoft Word

Любой формат изображения, который может импортировать установленная версия Microsoft Office, включая 'png' , 'jpg', 'bmp', и 'tiff'. Если на 'figureSnapMethod' для опции задано значение 'print', тогда вы также можете задать 'eps', 'epsc', 'eps2', 'ill', 'meta', и 'pdf'.

'png'
Язык разметки гипертекста (HTML)

Все форматы изображений.

Убедитесь, что инструменты, используемые для просмотра и обработки файлов выхода, могут отображать заданный формат выхода.

'png'
LaTeX

Все форматы изображений.

Убедитесь, что инструменты, используемые для просмотра и обработки файлов выхода, могут отображать заданный формат выхода.

'epsc2'

Значение по умолчанию изменяется на 'png' в этих случаях:

  • figureSnapMethod является 'getframe'.

  • figureSnapMethod является 'entireFigureWindow'.

  • figureSnapMethod является 'entireGUIWindow' и привязанное окно является графическим интерфейсом пользователя.

Формат переносимых документов (PDF)

'bmp' и 'jpg'.

'bmp'
Microsoft PowerPoint

Любой формат, который может импортировать установленная версия Microsoft Office, включая 'png', 'jpg', 'bmp', и 'tiff'.

'png'
Расширяемый язык разметки (XML)

Все форматы изображений.

Убедитесь, что инструменты, используемые для просмотра и обработки файлов выхода, могут отображать заданный формат изображения.

'png'

Максимальная высота изображения опубликованных изображений, заданная как одно из следующих значений:

  • [] (по умолчанию) - неограниченная высота. Это значение всегда используется, когда выход PDF.

  • Положительное целое число - Высота в пикселях.

Максимальная ширина изображения опубликованных изображений, заданная как одно из следующих значений:

  • [] (по умолчанию) - неограниченная ширина. Это значение всегда используется, когда выход PDF.

  • Положительное целое число - ширина в пикселях.

Создание ли нового рисунка, задается как true или false. Если true и код генерирует рисунок, затем MATLAB создает новое окно рисунка размера по умолчанию с белым фоном перед публикацией. Если falseMATLAB не создает окно рисунка.

Задание значения false полезно, если необходимо использовать для публикации рисунок с другими свойствами. Например, можно открыть окно рисунка, изменить размер и цвет фона, а затем опубликовать код. Рисунки в опубликованном документе используют характеристики фигуры, открытой перед публикацией.

Опции кода

свернуть все

Запуск кода и включение выхода MATLAB в опубликованное представление, заданное как true или false.

Выявлять ли ошибки во время публикации, задается как true или false. Если true и возникает ошибка, MATLAB продолжает публикацию и включает ошибку в опубликованный файл. Если false и происходит ошибка, MATLAB отображает ошибку в командной строке и не создает опубликованный файл.

Дополнительный код для выполнения во время публикации, заданный как вектор символов. Используйте эту опцию, чтобы запустить код, который не включен в файл MATLAB. Для примера при публикации функции можно задать значение входных параметров.

Если эта опция не задана, MATLAB запускает код только в файле MATLAB, который вы публикуете.

Пример: publish('myfunction.m','codeToEvaluate','myfunction(1,10)')

Максимальное количество линий выхода для включения в опубликованный документ, заданное в качестве одного из следующих значений:

  • Inf (по умолчанию) - MATLAB включает все выходы в опубликованном документе.

  • Неотрицательное целое число - MATLAB включает только указанное количество линий в опубликованном документе. Установка этой опции полезна, если достаточно меньшей, репрезентативной выборки выхода.

Включать ли код в опубликованный файл, задается как true или false.

Если формат выхода HTML, MATLAB включает код в конец опубликованного HTML- файл в качестве комментариев, даже когда вы устанавливаете 'showCode' опция для false. Включение кода в качестве комментариев включает grabcode функция для извлечения кода MATLAB из HTML, даже когда файл не отображает код. Код не отображается в веб-браузере, поскольку MATLAB включает код в качестве комментариев.

Совет

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

  • publish функция не включает форматированный текст при генерации представления live скрипта или live функции (.mlx). Чтобы сгенерировать представление всего live скрипта или live функции, экспортируйте файл вместо этого. На вкладке Live Editor, в разделе File, нажмите Export и выберите из доступных опций экспорта. Для получения дополнительной информации см. раздел «Совместное использование Live скриптов и функций».

См. также

| | |

Темы

Представлено до R2006a

Документация MATLAB

Поддержка

Для просмотра документации необходимо авторизоваться на сайте