Exponenta Banner
exponenta event banner

публикация

Сгенерируйте представление файла 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')

Сгенерируйте представление 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')

Используйте аргументы пары "имя-значение", чтобы изменить внешний вид опубликованных окон рисунка в режиме просмотра HTML скрипта MATLAB.

Скопируйте файл в качестве примера fourier_demo2.m в вашу текущую папку.

filename = fullfile(matlabroot,'help','techdoc','matlab_env','examples','fourier_demo2.m');
copyfile(filename,'.','f')

Используйте функцию publish, чтобы сгенерировать режим просмотра HTML примера. SpecifyfigureSnapMethod как 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_doc_nocode, который задает опции showcode и format.

options_doc_nocode.format = 'doc';
options_doc_nocode.showCode = false;

Используйте функцию publish, чтобы сгенерировать представление Microsoft Word примера с помощью опций, заданных в options_doc_nocode. Затем используйте функцию winopen, чтобы просмотреть получившийся файл.

publish('fourier_demo2.m',options_doc_nocode);
winopen('html/fourier_demo2.doc')

Сгенерируйте режим просмотра 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.

Пример: 'myfile.m'

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

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

Значение'OutputFormat'
'html' (значение по умолчанию)Язык разметки гипертекста
'doc' Microsoft Word
'latex'LATEX
'ppt' Microsoft PowerPoint®
'xml'Расширяемый язык разметки
'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 должен появиться в кавычках. Вы можете задать несколько аргументов в виде пар имен и значений в любом порядке, например: Name1, Value1, ..., NameN, ValueN.

Пример: 'format','pdf','showCode',false задает формат выходного файла PDF и исключает код из вывода.

Вывод опций

свернуть все

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

Значение'OutputFormat'
'html' (значение по умолчанию)Язык разметки гипертекста (HTML)
'doc' Microsoft Word
'latex'LATEX
'ppt' Microsoft PowerPoint
'xml'Расширяемый язык разметки
'pdf'Формат переносимых документов (PDF

Microsoft Word и форматы Microsoft PowerPoint только доступны на платформах Windows.

MATLAB не сохраняет подсветку синтаксиса, когда вы задаете выходной формат как Microsoft PowerPoint или LATEX.

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

Пример: 'C:\myPublishedOutput'

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

Пример: 'C:\myStylesheet\stylesheet.xsl'

Изображение опций

свернуть все

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

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

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

ЗначениеХудожественные оформления окнаBackgroundColor
 Графический интерфейсы пользователяФигурыГрафический интерфейсы пользователяФигуры

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

Включенный

Исключенный

Экран Matches

Белый

'print'

Исключенный

Исключенный

Белый

Белый

'getframe'

Исключенный

Исключенный

Экран Matches

Экран Matches

'entireFigureWindow'

Включенный

Включенный

Экран Matches

Экран Matches

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

'OutputFormat' Допустимые форматы изображенияФормат изображения по умолчанию
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', и сфотографированное окно является окном GUI.

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

'bmp' и 'jpg'.

'bmp'
Microsoft PowerPoint

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

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

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

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

'png'

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

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

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

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

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

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

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

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

Опции кода

свернуть все

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

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

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

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

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

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

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

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

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

Ограничения

  • В MATLAB Online вы не можете использовать функцию publish на файле в вашей папке Shared. Чтобы опубликовать совместно используемый файл, откройте файл в Редакторе, и затем нажмите Publish на панели инструментов. Когда вы используете кнопку Publish в MATLAB Online вместо функции publish, MATLAB хранит результаты в подпапке Published вашей корневой папки вместо подпапки html.

Советы

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

Смотрите также

| | |

Темы

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

Документация MATLAB
Поддержка