Exponenta Banner
exponenta event banner

издать

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

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

Синтаксис

публикация (файл)
публикация (файл, формат)
публикация (файл, имя, значение)
публикация (файл, параметры)
my_doc = публикация (файл, ___)

Описание

пример

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 ® Word сценария 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'ЛАТЕКС
'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'ЛАТЕКС
'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-страницах.

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

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

СтоимостьУкрашения оконЦвет фона
 Графический интерфейсы пользователяИллюстрацииГрафический интерфейсы пользователяИллюстрации

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

Включенный

Исключенный

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

Белый

'print'

Исключенный

Исключенный

Белый

Белый

'getframe'

Исключенный

Исключенный

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

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

'entireFigureWindow'

Включенный

Включенный

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

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

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

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

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

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

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

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

'png'
ЛАТЕКС

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

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

'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 создает новое окно фигуры в размере по умолчанию с белым фоном перед публикацией. Если 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 функция не включает форматированный текст при создании представления сценария в реальном времени или функции в реальном времени (.mlx). Чтобы создать представление всего сценария или функции live, экспортируйте файл. На вкладке Интерактивный редактор (Live Editor) в разделе Файл (File) щелкните Экспорт (Export) и выберите один из доступных параметров экспорта. Дополнительные сведения см. в разделе Совместное использование сценариев и функций в реальном времени.

См. также

| | |

Темы

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

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

Поддержка