INTEGRAL Demos – Compound Documents

This repository contains two examples designed to showcase the advanced capabilities of the INTEGRAL Interpreter: compound document creation, automatic tables of contents, advanced layout, figures, tables, math formulas, custom functions and more.

Featured Demos

• Simple Job Letter (letter-job/doc.i): A simple but professional-looking 2-page job recommendation letter.
• Complex Publication (journal-neural/doc.i): A complex publication consisting of 20 pages and 4 articles that showcases INTEGRAL's incremental build system.

Prerequisites

• INTEGRAL Desktop (for Windows, macOS or Linux)

Quick Start

Download and Setup INTEGRAL Interpreter

1. Download INTEGRAL Desktop for your platform. Extract the downloaded ZIP to a directory of your choice. We'll refer to this directory as PATH_TO_INTEGRAL_EXTRACT_DIR.

2. Add INTEGRAL Interpreter to your system PATH using the commands below. When typing these commands, make sure you replace /PATH_TO_INTEGRAL_EXTRACT_DIR (or C:\PATH_TO_INTEGRAL_EXTRACT_DIR on Windows) with the path to your actual extraction folder.

Windows (Command Prompt)

setx PATH "%PATH%;C:\PATH_TO_INTEGRAL_EXTRACT_DIR\exec"

Windows (PowerShell)

[System.Environment]::SetEnvironmentVariable("PATH", $env:PATH + ";C:\PATH_TO_INTEGRAL_EXTRACT_DIR\exec", "User")

macOS

sudo ln -s /PATH_TO_INTEGRAL_EXTRACT_DIR/exec/integral-interp-osx /usr/local/bin/integral-interp-osx

Linux

sudo ln -s /PATH_TO_INTEGRAL_EXTRACT_DIR/exec/integral-interp-linux /usr/local/bin/integral-interp-linux

3. Important: Close and reopen your Terminal so the new PATH settings take effect. You can now run INTEGRAL Interpreter from any terminal window.

Download and Execute INTEGRAL Demos

1. Download or clone this repository (docs-compound).

git clone https://github.com/integral-system/docs-compound.git

2. Navigate to the repository's root directory (docs-compound) in a new terminal window.

cd docs-compound/

3. Execute the demos.

Windows

integral-interp-win letter-job\make.i
integral-interp-win journal-neural\make.i

macOS

integral-interp-osx letter-job/make.i
integral-interp-osx journal-neural/make.i

Linux

integral-interp-linux letter-job/make.i
integral-interp-linux journal-neural/make.i

View, Manipulate & Export

All these sample documents will open in INTEGRAL Document Editor, where they can be further manipulated or exported to PDF or SVG format.

INTEGRAL Source Files

INTEGRAL is an extension of the Squirrel programming language. INTEGRAL source files are standard UTF-8 text files with a .i extension. To modify them, simply use your favorite text editor. For the best experience, set your editor's syntax highlighting to Squirrel; if that isn't available, C++, C or Java are suitable alternatives.

Incremental Build System

The first time you run journal-neural/make.i, the INTEGRAL Interpreter may take a few seconds to compile and render the full 20-page document.

However, subsequent runs will be nearly instantaneous. If you modify specific articles within this compound document, only the changed sections will be rebuilt. This incremental build system ensures a fast and efficient workflow, even when working with complex, multi-part publications.

Pro Tip: To force a complete rebuild from scratch, simply delete the .tmp files located in the letter-job/cache/ or journal-neural/cache/ subdirectories.