Write in TeX. Teach in your browser.

Saving TeX alone does not update an existing HTML file. Wait for a successful build, then open or reload the generated presentation.

1. First-time setup

1Extract the kit

Right-click the ZIP and choose Extract All. Keep scveamer.py, engine/, resources/, bundled/ and the documentation in their supplied relative locations. Run the kit from the extracted folder, not from inside the ZIP viewer.

If you already use another edition, extract this one into a separate folder. See Updates and migration for continuing an existing project.

2Check Python and TeX

Python and TeX themselves are not included. If needed, see the official Python downloads for Windows and TeX Live for Windows. In a Python installer that offers components, include pip and Tcl/Tk/IDLE. An existing compatible TeX installation can be reused.

To check Tkinter, run py -m tkinter. A small demonstration window should open. See Python's Tkinter documentation.

3Start the editor

On Windows, double-click START_WINDOWS.cmd. Alternatively, open a terminal in the folder containing scveamer.py and run:

py scveamer.py

One way to open PowerShell there is to enter powershell in File Explorer's address bar and press Enter. If your environment uses python rather than py, run python scveamer.py. A file association may also allow double-clicking scveamer.py; the terminal is useful if you need to read a startup error.

4Check the automatically opened project

Sample slides is selected on first launch. SCVeamer creates a working copy and displays its location in Working folder. Choose Check environment.

The project selector offers Sample slides, Template v2 and New talk starter. Each has its own working copy, and selecting it again resumes your edits.

Use Open folder to see the working files. Edit this copy; you do not need to edit the originals in bundled/.

5Install the PDF libraries

Choose First-time setup (install libraries) if the PDF libraries are not ready. This creates a kit-specific .venv and downloads pypdf 6.10.0, pypdfium2 5.14.0 and Pillow 12.3.0. This step needs an internet connection. It does not install Python or TeX.

The editor restarts in the prepared environment when setup finishes. Next time, use the same py scveamer.py command. The local environment is selected automatically. SETUP_WINDOWS.cmd or py scveamer.py --setup performs the same preparation.

There is no Activate.ps1 step: SCVeamer calls its environment's Python directly. When moving the kit to another computer, create the environment there instead of copying .venv. See Python's venv documentation.

6Locate TeX only if automatic detection fails

In TeX executable folder, choose the directory containing lualatex.exe. For example, a TeX Live installation might use:

C:\texlive\2026\bin\windows

Use your actual year, drive and installation path. Select the folder containing the executable, not the executable itself or your lecture folder. Then choose Check environment again.

7Try a build

Choose Build HTML from TeX. After the log reports success, choose Open HTML. Once Python dependencies, TeX packages and fonts are installed, ordinary builds and viewing of typeset slides and included interactive figures can run offline. Viewing an embedded website needs internet access.

Font names database not found, generating new one.
This can take several minutes; please be patient.

2. Try your first edit

Use the sample that opened automatically. Check that Working folder points to its editable copy, normally workspace/day1/.

1. Choose Edit source and open talk.tex, or open it directly in your usual TeX editor.
2. Find the subtitle and change it, for example:

   \subtitle{Complex Analysis in Several Variables — editing practice}

3. Save with Ctrl+S.
4. Return to SCVeamer and choose Build HTML from TeX.
5. After a successful build, choose Open HTML and check the title slide. Reload an already open tab.

For a short source, select New talk starter. Its six blue slides demonstrate ordinary Beamer pages, theorem environments, \pause and one fixed interactive example. Selecting it again resumes the same working copy.

To begin a separate talk with a fresh starter, choose Create a new project, then choose a new folder name and location. Existing nonempty folders are not replaced.

The starter includes a ready-made HTML presentation and PDFs, THEMES.html for color previews, and EXAMPLES.html for all fixed examples. Open them before editing if you want to see what is available.

Updates and migration

Extract a new edition into a separate folder. Keep previous working projects in their existing locations or make a complete backup before moving them.

1. Extract the new ZIP and start its editor.
2. On first launch, the English sample is copied into its new working folder. To continue an older project, choose Open my project folder and select the directory directly containing that project's talk.tex.
3. Check the actual Working folder, then run Check environment and first-time setup if required.
4. Build and inspect the output. The old HTML does not update automatically.

This English edition uses separate settings and the fallback workspace name version-1.5-en. It does not automatically open a Japanese edition's previous working project. You can open an older source explicitly. Source text is not translated automatically; change its language yourself, including fixed-example language options if needed.

To add scheduled end times to a source older than version 1.2, first copy the project folder, then copy the new starter/theme/holotalk-games.sty into that copy's theme/ directory. Preserve any customized style and add the commands described in section 4. This English style defaults to lang=en; explicitly request lang=ja for a Japanese visualization.

Version 1.5 retains the existing deck format and pypdf/pypdfium2 PDF backend. The embedded scveamer_version value is 1.5, and renderer identifies pypdfium2 and PNG output. Video and website slides need the 1.5 player. English defaults, example IDs and mathematical behavior are preserved. holotalk_editor.py remains a compatibility entry point; normally use scveamer.py. To use the new commands in an older source, follow the theme-update instructions.

3. Writing and editing TeX

Choose a color theme

After loading the theme in the preamble, write one of blue, red or yellow:

\usepackage{theme/holomorphonautica}
\holocolors{blue}

Blue is the original Holomorphonautica palette. Red uses the website's magenta accent. Yellow uses the original Beamer/Metropolis-inspired yellow-orange palette. THEMES.html shows examples. Rebuild after a change. The visualization colors retain their mathematical meaning and are not recolored by this setting.

Ordinary slides and overlays

Write an ordinary Beamer frame. Text after \pause appears on the next advance in HTML too.

\begin{frame}{What should we observe?}
  \begin{itemize}
    \item Specify the object by a formula.
    \pause
    \item Move the slice and compare the views.
    \pause
    \item Relate the observation to a criterion.
  \end{itemize}
\end{frame}

Definitions, theorems and proofs

Available environments include definition, theorem, lemma, proposition, corollary, example, remark, question and proof.

\begin{frame}{A simple example}
  \begin{example}
    The function $u(z)=|z|^2$ is subharmonic on $\mathbb C$.
  \end{example}
  \pause
  \begin{proof}
    Write $z=x+iy$. Then $u_{xx}+u_{yy}=4>0$.
  \end{proof}
\end{frame}

The sample lecture follows its source notes and uses \Delta u=-(u_{xx}+u_{yy}); subharmonicity then means \Delta u\leq0. The independent starter and template state the positive-Laplacian convention explicitly. Keep the sign convention consistent when combining sources.

Insert a fixed interactive example

Write one command at the place where you want the interactive slide. You do not need to write JavaScript. Choose a registered viewer type and example ID from the complete table at the end.

\exploreframe{sh}{std-b03}{Explore a harmonic saddle}

The command creates a whole slide. Place it between ordinary frames, and do not enclose it in another frame:

\begin{frame}{Before the observation}
  What should we expect from the circular average?
\end{frame}

\exploreframe{sh}{std-b03}{Explore a harmonic saddle}

\begin{frame}{After the observation}
  The graph is saddle-shaped, but the function is harmonic.
\end{frame}

IDs are case-sensitive. For example, N01 and n01 are different. Keep the viewer type and ID together. Every row in the final table has a Copy TeX button; EXAMPLES.html in the starter and template provides another example picker.

Eight ready-to-use examples

These are the examples used in the sample lecture. Copy a line and change the slide title if desired.

% Re(z^2)=x^2-y^2: a harmonic saddle.
\exploreframe{sh}{std-b03}{Explore a saddle-shaped graph}

% -|z|^2: a cap that is not subharmonic.
\exploreframe{sh}{std-b02}{A cap and its circular averages}

% max(0,Re z): subharmonic with a crease.
\exploreframe{sh}{std-i02}{A crease can be subharmonic}

% |z|^2+|w|^2: a strictly plurisubharmonic example.
\exploreframe{psh}{N01}{Restrictions to complex lines}

% |z|^2+|w|^2-4Re(z w-bar): coordinate slices are insufficient.
\exploreframe{psh}{A03}{What coordinate slices miss}

% The unit ball in C^2.
\exploreframe{ryokuinzu}{lecture-ball}{Fibers of the unit ball}

% The unit bidisc in C^2.
\exploreframe{ryokuinzu}{lecture-polydisc}{Fibers of the bidisc}

% A Hartogs figure.
\exploreframe{ryokuinzu}{n18}{Slices of a Hartogs figure}

Hide the formula, or specify the language

By default, the formula is visible from the start, while the answer and explanation are revealed by a button. To hide the formula until the answer is shown, add formula=hide:

\exploreframe[formula=hide,lang=en]{sh}{std-b02}
  {Is this function subharmonic?}

The English edition's styles default to lang=en. An explicit language is useful when sharing source across editions. The existing Japanese UI remains available with lang=ja.

Provide a static PDF counterpart

An interactive HTML figure cannot move in a PDF. Use print={...} to typeset its static image and explanation:

\exploreframe[lang=en,print={%
  \includegraphics[width=.55\linewidth]{assets/my-figure.pdf}
  \par A short explanation of this same example.
}]{ryokuinzu}{lecture-ball}{Fibers of the unit ball}

The sample lecture defines its own shorter command:

\observeframe[3]{ryokuinzu}{lecture-ball}
  {The unit ball: shrinking disc fibers}{fibers-ball}

The optional [3] gives the duration in minutes. The first three required arguments select the viewer, ID and title. The final fibers-ball selects the sample's corresponding SCVprint@fibers-ball definition in talk.tex, which uses assets/fibers-ball.pdf. This helper is specific to the sample; use \exploreframe in a new source unless you also copy the helper definitions.

Save and rebuild

1. Save the TeX source.
2. Check that the editor's Working folder is the project you edited.
3. Choose Build HTML from TeX.
4. Wait for success, then open or reload index.html.

If you use lecture-plan.json, count each interactive page as one logical slide. When adding, deleting or reordering slides, update its slide numbers. If only the example changes, still update related prompts and notes. You can temporarily disable supplementary data while aligning the plan; TeX schedule settings continue to apply independently.

4. Planned end times and speaker notes

Write a start time and durations in TeX

The bottom-right Planned end display can show when the current slide is scheduled to finish without pressing a button. Set the start time in the preamble, after loading the theme:

\scvstarttime{14:55}

Set a duration at the start of every ordinary frame:

\begin{frame}{Subharmonic functions}
  \scvminutes{3}
  Write the definition here.
  \pause
  Then show an example.
\end{frame}

For a fixed example, use the minutes option:

\exploreframe[minutes=3,formula=show,lang=en]
  {sh}{std-b02}{A cap and its circular averages}

This command creates a whole frame. If you already use print={...}, add minutes=3 to the same option list.

Use 24-hour HH:MM for the start time and a nonnegative number of minutes, such as 3 or 2.5, for a duration. This is a planned schedule, not an automatic elapsed-time or countdown timer. If the start time changes, edit it and rebuild.

Use notes in another project

Write supplementary metadata in lecture-plan.json and enable Use supplementary data (titles, prompts and speaker notes) in the editor.

{
  "title": "My lecture",
  "slides": [
    {"slide": 1, "title": "Introduction", "duration_minutes": 2,
     "notes": "Introduce the main question."},
    {"slide": 2, "title": "Observe", "duration_minutes": 3,
     "notes": "Ask the audience to compare the two slices."}
  ]
}

A plan used by the builder must cover all logical slides, with matching numbers and content. Move the associated entries when changing slide order. A \scvminutes command moves with its frame, so that duration does not require a separate slide-number edit.

In presentation.json, set "speaker_notes": false to omit note text from the generated HTML and disable guide generation for that project. Planned times are independent. Omit the setting or set it to true when notes are wanted.

With notes enabled and a plan applied, SCVeamer generates CURRENT_TEACHING_GUIDE.html. It does not update an older TEACHING_GUIDE.html. If you disable notes later, any older guide left in the folder should not be treated as current.

Hide footer text for an individual project

Use \renewcommand{\holofooter}{} in the preamble to clear the TeX footer text. Retain page numbers or the supplied slide metadata so overlays can be grouped correctly. In version 1.5 the HTML toolbar has no permanent slide-title or system-name area. The show_brand option remains readable for compatibility but no longer affects its display. Previous/next controls and the page counter have fixed widths. The sample already clears its TeX footer text.

5. Editor buttons and outputs

The standard outputs are index.html for presenting and talk.pdf with all Beamer display states. Projects configured for handouts, including the sample and starter, also produce handout.pdf, using the final state of each slide. Template v2 does not enable a separate handout by default. A configured, enabled plan with speaker notes also produces CURRENT_TEACHING_GUIDE.html. Output filenames can be customized in presentation.json.

A failed generation preserves the previous completed output files. If you still see old content, check whether the latest build actually succeeded.

6. Convert a PDF built in your usual editor

In TeXworks, save the source as UTF-8 and typeset with LuaLaTeX. The supplied first line, % !TeX program = lualatex, selects this engine where supported. If it is not picked up, choose LuaLaTeX explicitly in the typesetting dropdown. The supplied fontspec sources do not compile with the ordinary LaTeX or pdfLaTeX choice.

1. Compile the working copy's talk.tex in your usual TeX editor, updating talk.pdf in the same folder.
2. Check that SCVeamer's Working folder is that project.
3. Choose Build HTML from existing PDF.
4. After success, inspect the HTML and any configured handout.

This action does not compile TeX. An old PDF produces old content. Interactive pages are recognized from the link markers written by \exploreframe or \gameframe; a figure in an arbitrary PDF does not automatically become interactive. If replacing a PDF with a different lecture, update or disable the old plan so that notes are not attached to the wrong slides.

PNG resolution

The converter uses a default image width of 1920 pixels unless the project's presentation.json or the command line specifies another width. For example, py scveamer.py --pdf-only --project "C:\work\my-lecture" --image-width 2560 uses 2560-pixel-wide images. A command-line value overrides the project setting. PNG images have a fixed resolution; large enlargement may soften fine text. The input PDF is unchanged, and the handout copies PDF pages without rasterizing them.

7. Optional: build a Windows executable

The kit includes an updated SCVeamer.spec recipe for PyInstaller. This kit is supplied as Python source. Executable build/run validation is not claimed for this release; see the current validation record. The earlier reported Windows 11 use for version 1.4 is described in the publication supplement; it does not record a systematic test of individual GUI functions. The following commands are a starting point for later packaging work; first verify the Python edition, then build on Windows for Windows and validate that exact distribution.

After first-time setup, run these commands in the kit folder on Windows:

.\.venv\Scripts\python.exe -m pip install -r requirements-build.txt
.\.venv\Scripts\python.exe -m PyInstaller --clean SCVeamer.spec

Run SCVeamer.exe inside dist\SCVeamer\. The supplied specification uses onedir: keep and distribute the entire directory, not just the executable. A desktop shortcut is useful without moving the executable. The first launch creates the bundled project's working copy. The executable contains its Python libraries, so its Python first-time setup is unnecessary.

Rebuild the executable after changing Python source files. PyInstaller also supports onefile packaging, but these instructions describe the supplied onedir setup. See how PyInstaller works and its usage documentation.

Executable packaging does not guarantee a particular antivirus result. If a download is blocked, identify the reported detection name and the affected file before investigating.

Command-line use

Replace the example folder with your own project. Quote paths that contain spaces:

py scveamer.py --check --project "C:\work\my-lecture"
py scveamer.py --build --project "C:\work\my-lecture"
py scveamer.py --pdf-only --project "C:\work\my-lecture"
py scveamer.py --setup

Use --builtin day1, --builtin template-v2 or --builtin starter to select a bundled project. --new-project "C:\work\new-talk" creates a starter. Add --tex-bin "C:\texlive\2026\bin\windows" when needed, or --engine lualatex to choose the engine explicitly. --no-plan ignores supplementary JSON data while retaining TeX schedule settings.

BUILD.cmd and PDF_TO_HTML.cmd call the same program. A double-click uses the last valid project and saved TeX settings; an explicit option overrides the saved value. For example: BUILD.cmd --project "C:\work\my-lecture".

8. Troubleshooting

Read and preserve the error log

For a failed TeX build, read the TeX error summary and the editor's log. The detailed log is .build/latest.log in the working folder. It is overwritten by another build, so save a copy before retrying if you need to report the problem. Include the action you performed.

9. Presenting and distributing materials

Use the arrow keys, Space or toolbar buttons to advance. Press F2 after interacting with a visualization to return to slide controls. Use the player's Fullscreen button or the browser's F11 shortcut. The HTML can also be placed on a web server and linked normally.

This manual describes SCVeamer 1.5, English edition. See the current validation record for checks and untested items. The version 1.4 publication supplement records the earlier Windows 11 report without identifying which language edition was tried. Earlier records are retained as history and do not establish validation of 1.5.