Kahibaro
Discord Login Register

13.5 Sharing and Exporting Live Scripts

Why Share and Export Live Scripts

Live scripts are designed to be shared. They combine code, text, equations, and output in one file, so they are ideal for teaching, reports, and collaboration. However, not everyone you work with will have MATLAB, or the same version, so you often need to export your live script into other formats.

This chapter focuses on what is specific to sharing and exporting live scripts: how to turn a .mlx file into other documents, how to control what gets exported, and how to distribute your work to others both inside and outside MATLAB.

The `.mlx` File and Compatibility

A live script is stored as a .mlx file. This is the native format for MATLAB live scripts and is the best way to preserve everything, including:

text formatting, headings, and lists
equations written in the editor
interactive controls such as sliders
embedded images and rich outputs

If you share a .mlx file with someone who has MATLAB, they can open it directly in the Live Editor, run and edit it, and see all features.

If they have an older version of MATLAB, some newer Live Editor features might not appear exactly the same. When working with collaborators, it is often helpful to check that you are using compatible MATLAB releases, or to keep the live script simple if the recipient uses an older version.

Exporting Live Scripts to PDF, HTML, and Word

Often you want to share the results, not the code environment. Live scripts can be exported to common document formats from within MATLAB.

To export using the graphical interface, open your live script, then use the Live Editor export options. Depending on the version, this is usually found through the Live Editor tab or the Save or Export controls. You choose a target format such as PDF, HTML, or Microsoft Word.

Export to PDF is useful when you want a fixed, print-ready document. The layout is preserved, including headings, code, output, figures, and equations. Readers do not need MATLAB or any special software beyond a PDF viewer. PDF is not easily editable, which is sometimes desirable for finalized reports.

Export to HTML is suited for web based viewing. The result is an HTML file that can be opened in any web browser. Code, formatted text, and figures are visible, and the document can be scrolled like a web page. HTML output can be shared by email or placed on a website or internal documentation portal. It is also convenient when you want a lightweight, cross platform format.

Export to Word creates a .docx file that can be opened and edited in Microsoft Word or other compatible word processors. The main structure of your live script appears as a document with code blocks, outputs, text, and images. This is useful when collaborators want to add comments, track changes, or integrate your analysis into a larger written report.

In all of these exports, interactive elements such as sliders or buttons are turned into static content. They appear in the exported document, but they cannot be adjusted or executed outside MATLAB.

Exporting to MATLAB Code Files

Sometimes you want to share the logic and structure of your live script as a plain code file, for example to use in automated scripts or with colleagues who prefer the classic editor.

You can convert a live script to a standard .m file. When you do this, MATLAB keeps the code sections and comments, but removes the rich formatting. Text paragraphs become commented lines, formatted as % comments. Equations become commented text, not live mathematical objects. Plots and generated outputs are not stored, since the .m file only keeps code.

This conversion is useful when you want to:

run the code on older MATLAB versions that do not support live scripts
use the script in batch processing or another environment that expects .m files
share a simple, code only version for review or integration into a larger code base

Because the .m file does not contain outputs, readers must run it to reproduce results. For reviews, you might want to send both a .m file and an exported PDF or HTML file.

Controlling What Gets Exported

Before exporting, you can control what appears in the final document. Typically, the Live Editor gives you options such as whether to include code, output, or both. You may also be able to export only selected sections.

Including both code and output is useful for teaching, tutorials, and reproducible reports. Readers see exactly which commands produced which results. This is the default choice for many workflows.

Including only output hides the code and focuses on results, figures, and explanations. This is helpful when the audience is not interested in MATLAB programming, such as managers, clients, or non technical colleagues.

Including only code is rare for document oriented formats like PDF, but it can be helpful if you are preparing a handout for code review or if you want to distribute a version that students or colleagues must run themselves.

If you have long running sections or heavy computations, it is often a good idea to run the live script once, verify the results, and then export with the outputs already present. That way, the exported document includes the final state without needing to execute anything during export.

Sharing Live Scripts with Colleagues

When your collaborators have MATLAB, the simplest way to share is to send the .mlx file directly, for example by email or through a shared folder or project. Recipients can open the file, explore the contents, and re run sections as needed.

For group work, organizing live scripts in a shared folder structure helps keep projects clear. Each live script can serve as a narrative and executable description of part of the project. Using consistent section headers inside the live scripts also makes navigation easier.

When live scripts are part of a larger project with multiple .m functions and data files, remember that sharing just the .mlx file is often not enough. You also need to include any custom functions, data, or helper files that the live script uses, and ensure the paths are set appropriately when others open the project.

Sharing Live Scripts Without MATLAB

If the recipient does not have MATLAB, the .mlx file alone is not sufficient. In that case you rely on exported formats.

For sharing with non technical stakeholders, PDF is often the best choice. It is readable on almost any device and keeps the layout very close to what you see in the Live Editor.

For sharing on websites, learning platforms, or internal documentation portals, HTML export is often more convenient. The HTML file can be embedded or linked, and users only need a browser.

If the recipient needs to modify the text or integrate it into another document, Word export is appropriate. They can edit the .docx file, add commentary, or reformat sections.

In some environments, you might also compress your project folder, including the exported documents and any data, into a single archive file for easy distribution.

Exporting Figures from Live Scripts

Live scripts often contain plots and other visual output. These figures can be used separately in slides, papers, or reports.

When you export a live script to PDF, HTML, or Word, the figures are included automatically in the resulting document. However, you may sometimes need individual image files, such as .png or .jpg, for use in presentation software.

To do this, you typically use standard figure export tools. You can open a figure generated in the live script and then use MATLAB graphics export features, either interactively from the figure window or programmatically using functions that save figures to disk. The live script itself remains the place where the figures are created and configured, while the exported images are used externally.

Reproducibility and Sharing Data Alongside Live Scripts

When you share a live script, think about whether someone else can reproduce the results. If the live script depends on local data files, external paths, or specific toolbox functions, others may not get the same outcome when they run it.

To improve reproducibility when sharing, keep your data files in known locations relative to the live script, avoid hard coded absolute paths, and document any toolbox requirements in the introductory text section of the live script. If possible, include small sample data sets with the script, or clearly state where the data can be obtained.

When exporting to PDF or HTML, you preserve the results as they existed at the time of export, even if others cannot rerun the analysis. When sharing the .mlx file itself, also sharing the data and describing any prerequisites helps others run and extend your work.

Summary of Key Points

Views: 47

Comments

Please login to add a comment.

Don't have an account? Register now!