The neoschool Class (v1.3.0)

Examples

demo1.tex

demo2.tex

demo3.tex

demo4.tex

demo5.tex

Table of Contents

Preconfigured Profiles New

The profile=name option automatically configures a coherent set of options for different document types. Each profile defines a theme, an accent style, box styles, and visual parameters suited to a specific use case.

• course: ideal for lectures and teaching materials. Theme midnight, accent gradient, theorem style tile, exercise style capsule.
• memo: for summary sheets and compact notes. Theme sage, accent flat, theorem style sticker, exercise style card.
• tech: for technical and computer science documents. Theme oceanic, accent duotone, theorem style block, exercise style shell.
• exam: for assessments and proctored tests. Theme charcoal, accent minimal, theorem style plain, exercise style line.
• creative: for engaging and colorful materials. Theme amethyst, accent rainbow, theorem style bubble, exercise style badge.
• swiss: minimalist style inspired by Swiss design. Theme klein, accent strong, theorem style frame, exercise style digit-outline.
• elegant: for formal and polished documents. Theme burgundy, accent flat, theorem style fold, exercise style counter.
• print: optimized for black-and-white printing. Theme heritage, accent print, theorem style frame, exercise style counter-outline.

% Using a profile
\documentclass[profile=course]{neoschool}

% Customizing a profile
\documentclass[profile=exam, theme=midnight]{neoschool}

Loaded Packages

The following packages are automatically loaded by the neoschool class:

adforn, adjustbox, algpseudocode, amsmath, babel, bookmark, calc, changepage, colortbl, environ, fontawesome5, forest, iftex, kvoptions, lastpage, listings, marginnote, microtype, multicol, nccmath, needspace, pdftexcmds, pgffor, pgfplots, pifont, qrcode, scrlayer-scrpage, setspace, silence, siunitx, tabularray, tasks, tcolorbox, textcase, tikz, tikzpagenodes, tikzsymbols, todonotes, ulem, wrapfig, xcolor, xhfill, xkeyval, xsim, xstring.

Compilation with pdflatex loads the fontenc (T1), inputenc (utf8), newpxtext, and newpxmath packages. Compilation with lualatex makes fontspec, luacas, lua-ul, and luacolor available, and applies the TeX Gyre Pagella and TeX Gyre Heros fonts in addition to newpxmath.

Optional Packages

• faketext: loads blindtext and lipsum.
• mathastext: loads mathastext.
• math: loads annotate-equations, bm, cancel, esvect, mathrsfs, ncccomma, numprint, tdsfrmath (with suite and taupe options), tkz-euclide, witharrows, and xlop.
• notes / leftnotes / rightnotes: enables margin notes (left, right, or alternating).
• apmep: loads esvect, fourier-orns, numprint, pstricks and its ecosystem, tabularx, textcomp, tkz-tab, and variations.
• mathics: loads asymptote and latexalpha2 for symbolic computation via Mathics.

Configuration Options

Language

• english, french, german: enables translations and conventions for each language.
• nofrenchlist: disables French list style (uses bullets instead of dashes).
• frenchlistaspar: treats lists as paragraphs in French.
• frenchmath: applies French mathematical conventions (upright capitals and Greek letters).

Global Appearance

Predefined Themes Updated

The theme=name option sets the document's color palette. About forty themes are available, organized by category:

• Blue themes: azure, klein, midnight (default), oceanic, oxford, slate, twilight.
• Green themes: forest, moss, sage.
• Warm themes: burgundy, crimson, rosewood, terra.
• Purple themes: amethyst, plum.
• Neutral themes: charcoal, coffee, heritage, oxblood, oxbridge, sepia.
• Light themes: arctic, nordic, woodland.
• IDE themes: cyprus, frost, hop, kassio, operandi, operandi-cool, operandi-warm, quiet.
• Dark themes: dracula, gruvbox, mocha, night, nord, tokyonight, vivendi.

Accent Styles Updated

The accent=style option defines how theme colors are applied:

• strong: vivid, high-contrast colors for all elements.
• gradient (default): color gradient across heading levels.
• flat: primary color dominant throughout.
• minimal: minimal colors, focus on content.
• print: black and white for printing.
• gray: grayscale.
• duotone: two dominant colors alternating.
• rainbow: vibrant rainbow colors for a playful look.

Color Profiles

The colorprofile=profile option defines how colors are distributed among environment types:

• mathbook (default): primary for foundations (definitions), secondary for theory (theorems), tertiary for exercises and examples.
• exam: primary for exercises, secondary for foundations and theory.
• core: primary for foundations and theory, secondary for exercises.
• school: primary for exercises and examples, secondary for theory, tertiary for foundations.

Color Modes

• unicolor: uses a single color for all environments.
• bicolor: uses two complementary colors.

Custom Colors

• globalcolor=color: main text color (default: black).
• titlecolor=color: main title color.
• titlehexcolor=RRGGBB: title color in hexadecimal.
• headcolor=color: color of \section headings.
• subcolor=color: color of \subsection headings.
• subsubcolor=color: color of \subsubsection headings.
• headfootcolor=color: color of headers and footers.

Box Appearance

Frames and backgrounds:

• thmnoframe / thmframe: dis/enables theorem frames.
• thmnoback / thmback: dis/enables theorem backgrounds.
• codenoframe / codeframe: dis/enables code frames.
• codenoback / codeback: dis/enables code backgrounds.
• codenonum / codenum: dis/enables line numbering.
• exnoback / exback: dis/enables exercise backgrounds.
• noback / back: dis/enables all backgrounds.
• noframe / frame: dis/enables all frames.
• clean: disables all frames and backgrounds.
• styled: enables all frames and backgrounds.

Background opacity (0-100): boxopacity (global, default: 0), thmboxopacity, exboxopacity, codeboxopacity (default: 7), mathboxopacity (default: 15).

Corner rounding: boxarc, thmboxarc, exboxarc, codeboxarc, sideboxarc, pseudoboxarc (default: 0pt).

Box shapes (boxshape): New

The boxshape=shape option defines the global corner shape. Specific options: thmboxshape, exboxshape, codeboxshape, neoboxshape, sideboxshape.

• sharp (default), sharpish, curve, bevel.
• northeast, northwest, southeast, southwest: rounded on a single corner.
• north, south, east, west: rounded on one side.
• downhill, uphill: diagonally rounded corners.

Title terminators: thmterminator (default: .\!), thmseparator, adterminator (default: .\!), exterminator (default: .), boxtitle.

Other Display Options

• scale: harmonizes font sizes in lualatex/xelatex.
• inlinecodebox: displays inline code (\texttt) in a framed, colored box.
• inlineadmonition (default): admonition title and content on the same line.
• blockadmonition: forces admonition content below the title.

Typography

Fonts

• mainface, sansface, monoface, mathface: font selection.
• ...options: options for each font (e.g., mainfaceoptions).
• ...scale: scale factors (e.g., mathfacescale).
• facefamily: complete font family.
• sfbody: uses sans-serif font for body text.
• sfall: uses sans-serif font for the entire document.
• mathastext: uses text font for mathematics.

Heading Styles

• headstyle, headweight, headshape: global heading style.
• titlestyle, titleweight, titleshape, titlesize, titlealign: main title style.
• titledecor: decoration below title (none, ornament, rule, midrule, fullrule).
• sectionnumstyle: number appearance (circle, box, dash, plain).
• sectiontextstyle: text case (sc, upper, lower).
• sectionstyle: visual style (normal, ornaments, underline, highlighted, shadedline).
• sectionalign: alignment (default: center).
• headfootstyle: inherits from titlestyle.

Layout

Margins and Spacing

• margin=dim: horizontal margin width (default: 1.5cm).
• indent=dim: paragraph indentation size (default: 1em).
• noindent: removes paragraph indentation.
• vspacing=factor: vertical stretch/shrink factor (default: 1.0, values between 0.25 and 2.0).

Margin Notes

• notes=dim: alternating margin notes with specified width.
• leftnotes=dim: left margin notes with specified width.
• rightnotes=dim: right margin notes with specified width.

Headers and Footers

• fullheader: enables full header/footer (requires \neoheader).
• nofooter: removes header and footer (empty style).
• pageonlyfooter: displays only centered page number.
• headerules=style: rules (default: none). Values: none, headrule, footrule, headfootrule.

Table of Contents

• compacttoc: reduces spacing in the table of contents.
• monotoc: table of contents in text color (globalcolor).
• twocolumntoc: displays the table of contents in two columns.

Output Modes

For multiple printing: 2a5toa4, 2a4toa3, 4a5toa3, 2toa3, bookleta5, bookleta4.

Miscellaneous Options

• abstracttitle=Title: title of the abstract environment (default: DEFAULT).
• boldlistlabels: makes list labels bold.
• totalpoints=n: total points for grading (default: 20).

Document Styles

Title Styles (titlelayout) Updated

• Exams: exam, shortexam, mockexam.
• Assessments: eval, evalicons, evalgrade, evaliconsgrade, shorteval.
• Design: bubbles, particles, confetti, geometric, circles, wave, stream, flow, brush, cloud, champagne, banner, band, bauhaus, memphis, tech, magazine, notion, simplenotion, bristol, grid, spine, bar, blocks, book.
• Classic: default, titlebox, tighttitle, onlytitle, shorttitle, shortlesson, minimal, frame.

Header Configuration (\neoheader)

Configures information for exam, eval, mockexam, shortlesson styles and the fullheader option.

\neoheader{
  type = {Pop Quiz},
  school = {Jefferson Middle School},
  academy = {Springfield},
  level = {8th Grade},
  duration = {20 minutes},
  calculator = {false}, % true / false / exam
  leftcontent = {\faFlask},
  rightcontent = {\faCalculator},
  leftcontentfill = {true},
  rightcontentfill = {true}
}

Mathematical Environments

Based on tcolorbox.

Theorem Styles (thmstyle) Updated

Values: bar (default), block, tile, fold, plain, frame, curve, sticker, pastel, tag, raw.

Available Environments

theorem (ref.: thm), lemma (ref.: lem), corollary (ref.: cor), conjecture (ref.: conj), proposition (ref.: propo), property (ref.: prop), properties (ref.: prop), definition (ref.: def), definitions (ref.: def), method (ref.: meth), activity (ref.: act), application (ref.: appl), remark/remarks (unnumbered), example/examples (ref.: ex), proof.

Environment Options

title=text, label=name, colback=color, colframe=color, coltitle=color, fonttitle=commands.

Numbering Options

• sectionthmcounter: counters relative to each section.
• sharedthmcounter: single counter shared among all environments.
• thmgroupcounter: shared counter for theorem, lemma, corollary, proposition, property.
• sharedexcounter: shares counter between exercises and theorems.

Exercises

Based on the xsim package.

exercise and solution Environments

Options: points, bonus-points, level (1-5, displayed as stars), subtitle, icon (requires exerciseicons), topic, grade, subject, ID, template.

Global options: exerciseicons, answers, answersonly, shuffle, blocksol.

Exercise Styles (exstyle) Updated

Box styles: block, bar, tile, fold, plain, frame, curve, sticker, pastel, card.

Badge styles: badge, badge-outline, digit, digit-outline, counter, counter-outline.

Special styles: inline, capsule (default), shell, line, section, hrule.

Multiple Choice Questions

• choices(n): single-answer MCQ in n columns. \choice for an answer, \choice[\correct] for the correct answer.
• checkboxes(n): multiple-answer MCQ. \checkbox for an answer, \checkbox[\correct*] for a correct answer.

Source Code

Class options: listings (default) or minted (requires Python, Pygments, and --shell-escape).

code Environment

\begin[options]{code}{language}[title][box-style] ... \end{code}

options: listings/minted options. language: python, latex, c++, etc.

Commands: \codeinline[lang]{code}, \codeinput[opt]{lang}{file}[title][style].

Code Box Styles (codestyle) Updated

Values: lines (default), plain, bar, frame, shadow.

Options: codewidth=factor (default: 1.0), centeredcode.

pseudocode Environment

Based on algpseudocode. Special commands: \Gets (assignment arrow ←), \To ("to" keyword for loops).

Admonitions Updated

Colored boxes with icons to draw attention.

Environments: note (✎), info (ⓘ), warning (⚠), important (!), tip (💡), reminder (🔖), summary (📋), toolbox (🔧), method (⚙) New, activity (🧩) New.

Admonition styles (adstyle): modern (default), material, soft, classic, professional, minimal.

Options: title=text, subtitle=text, icon=\faIcon, style=name (overrides global style).

Content Layout

Absolute Positioning

\positionobject{x}{y}{scale}{content}: places content at coordinates (x, y) from the top-left corner.

Two-Column Layout

\splitcontent[w1][gap]{col1}{col2}: divides horizontal space.

sidebyside Environment

Creates two tcolorbox boxes side by side separated by \tcblower. Options: title, righthand width.

Combining Text and Images

\textwithimage[*]{w_img}{s_img}{text}{path}: combines text and image. * places the image on the left.

QR Codes

\withqrcode[*][size]{url}{content}: QR code next to content. * places the QR code on the right.

Grids and Papers

• \grid[color]{width}{height}: 5mm × 5mm grid.
• \customgrid[color][dx][dy]{width}{height}: custom grid.
• \frenchgrid[col_p][col_g]{width}{height}: Seyès (French ruled) grid.
• \gridfill / \gridfill*: fills the page with a grid.
• \notebook, \nbminorgrid, \nbmajorgrid: page background styles.

Simple Boxes

• neobox: box with frame.
• neobox*: box without visible frame.
• \neocolorbox[color]{content}: simple colored box.
• \inlinebox[frame][background][text]{content}: customizable inline box.

Logos and Special Symbols

\AILogo[options]: AI logo (chip with neural network).
\NoAILogo[options]: "No AI" logo (crossed-out chip).
\documentcolor{color}: changes text color for the entire document.

Grading and Correction

Grading Tools

• \gradingstrip[total]: strip for grade and comments.
• \mrk[*][comm]{pts}: points in the margin.

Answer Areas

• \answerfield[width]{lines}: area with colored background.
• \answerframe[width]{lines}: framed area.
• \vardots[length]: dotted line.
• \lines[char][spacing]{n}: draws n horizontal lines.
• \emptybox{width}{height}: empty box for free response.

Symbols: \cmark (✓ green), \xmark (✗ red), \unchecked (☐), \done (☑), \wontfix (☒).

Competency-Based Assessment

\competencies{Comp1 \\ Comp2 \\ ...}: 4-level assessment table.

Math Commands and Special Tools

Highlighting

• \mhl[color]{expr}: highlights the expression.
• \mc[color]{expr}: colors the expression.
• \mathbox<background>[border]{content}: frames mathematical content.

APMEP Support

Commands available with the apmep option: \vectt{AB} (vectors), \Oij, \Oijk, \Ouv (reference frames), \euro, \cg, \cd, \pg, \pp, \barre{x} (symbols).

Trees and Graphs

• neotree: environment for trees (based on forest). The w=val option adds a weight to a branch.
• \neograph: command for graphs (lualatex required).

Math Grid (mathgrid)

Environment for aligning equation blocks in a grid.

• \begin{mathgrid}{n}: grid with n columns.
• \neoline: new line.
• \neocol[span]{content}: column with align*.

Margin Notes

Enabled by noteswidth=dim.

• \tdnote[options]{text}: note in the margin.
• \boxnote[label]{text} + \tdmark[label]: note anchored to a specific location.