Pular para o conteúdo principal
Receita número 179

Receitas · Capítulo 10 · Saída e integração

Um módulo de curso com prova respondida na tela

Dois estilos de exercício num só Markdown: prática sem limite e prova com uma só verificação; respondidos em HTML e no EPUB e avaliados num curso SCORM.

Nesta página
Saída
Canvas · HTML · EPUB · SCORM
Nível
Avançado
Postext
Testada com o Postext 1.65.0
Requer ≥ 1.65.0
Licença
Atualizada em 1 de nov. de 2026
Código MIT · Texto CC BY 4.0
  • Amostra em inglês: ainda sem edição em português
  • Refile 176 × 250 mm
  • 1 coluna
  • Source Serif 4 10,8/15,5
  • Archivo
  • 4 páginas
  • Nível
  • Postext 1.65.0
  • Diagramado em 120 ms
  • 239 linhas de código

Em poucas palavras

Uma lição sobre terremotos: você lê, pratica quanto quiser e faz uma prova curta em que cada resposta só pode ser verificada uma vez. Ela é impressa como apostila e funciona na tela, num livro digital e numa plataforma de ensino.

O que você vai compor

O módulo 4 de The Restless Planet, um curso introdutório de ciências da Terra: quatro páginas sobre terremotos, no formato 176 × 250 mm, que abrem sob a pintura de uma falha cruzando uma planície seca. A leitura leva a uma prática e a uma prova, escritas no Markdown como blocos :::exercise com suas respostas. O módulo impresso traz o gabarito da prática e deixa de fora o da prova. Na tela, as mesmas páginas são respondidas: a prática pode ser verificada e recomeçada à vontade, e cada questão da prova aceita uma só verificação, não recomeça e só mostra a resposta quando essa verificação acaba. Um painel ao lado das páginas soma o que uma plataforma de ensino registraria: a nota, se a prova está completa e aprovado ou reprovado com 70 %. As mesmas páginas são gravadas como EPUB de layout fixo e como pacote SCORM 2004: um curso em que a lição e a prova são duas partes que a plataforma avalia separadamente.

Esta receita responde a

  • Como deixo o leitor responder e conferir os exercícios na edição HTML ou EPUB?
  • Como transformo os exercícios de um livro num curso SCORM que envia as notas a um ambiente virtual de aprendizagem, com uma prova que só permite uma verificação?

A resposta curta

script.js · linhas 35–60no código completo
// Practice: check, start again and see the solution as often as the learner likes.
const practice = {
  id: 'practice',
  number: { shape: 'disc', background: col('rust'), fontFamily: SANS, fontWeight: 700 },
  instruction: { fontFamily: SANS, bold: true, fontSize: pt(10) },
  options: { marker: 'circle' },
  blank: { look: 'line', color: col('ink'), weight: pt(0.6) },
  match: { look: 'dots', gap: em(3), color: col('rust') },
  bank: { box: 'bank' },
  marginTop: mm(5), marginBottom: mm(1), itemSpacing: em(0.15),
};
// The test: one check, no fresh start, the solution only once the check is spent. On paper
// the same questions print without their key.
const test = {
  id: 'test', extends: 'practice', box: 'test',
  number: { shape: 'square', background: col('slate') },
  match: { color: col('slate') },
  solutions: { placement: 'none' },
  digital: { maxChecks: 1, reset: false, showSolution: 'noChecksLeft' },
};
const exercises = {
  solutions: { placement: 'directive', layout: 'key' }, // the practice key where :::solutions is
  // The pass mark the course's results are judged against (a SCORM package reports passed or
  // failed with it); the HTML and EPUB editions carry it with the exercise data.
  digital: { passingScore: 70 },
};

Ingredientes

Tipografia
Source Serif 4, Archivo (SIL OFL 1.1)
Materiais
  • fault-1500.jpg
  • A fault across a dry plain in late afternoon light (the module's opener) (Generated With Diffusion Models, original)

Preparo

#1 · Dois estilos, duas regras

O código está na resposta curta. Os exercícios só dizem o que perguntam; o style do bloco decide como se comportam. practice mantém os padrões do livro, então sua barra oferece Verificar, Ver a resposta e Recomeçar sem limite. test o estende com um bloco digital: maxChecks: 1, reset: false e showSolution: 'noChecksLeft', e a barra conta até "Sem mais verificações" e só então oferece a resposta. No papel, o mesmo estilo não imprime suas soluções (placement: 'none'), enquanto o gabarito da prática sai onde está a linha :::solutions.

#2 · Uma tentativa salva volta do armazenamento

script.js · linhas 276–292no código completo
// The platform keeps each exercise's answers under its key; this learner checked three
// questions of the test, with two mistakes, and left the ordering one to do.
const tests = doc.exercises.filter((ex) => ex.style === 'test');
const mistakes = { 'test-statements': 2, 'test-distance': 1 }; // a wrong slot in each
const attempt = (ex) => ({ checked: true, n: 1, v: Object.fromEntries(ex.slots.map((slot, i) => {
  const right = exerciseSolutionValue(slot, ex);
  const wrong = slot.kind === 'truefalse' ? 3 - right : '180'; // 25 s × 8 km, slipped
  return [slot.key, mistakes[ex.anchor] === i ? wrong : right];
})) });
const kept = new Map(tests.filter((ex) => ex.anchor !== 'test-sequence')
  .map((ex) => [ex.anchor, JSON.stringify(attempt(ex))]));
const saved = new Map();
const platform = { // the three calls of localStorage, over the platform's record
  getItem: (key) => saved.get(key) ?? kept.get(key.split(':').pop()) ?? null,
  setItem: (key, value) => saved.set(key, value),
  removeItem: (key) => saved.delete(key),
};

attachExercises lê as respostas de cada exercício com getItem e as grava com setItem, sob a storageKey e a âncora do exercício. Qualquer objeto com essas três chamadas pode ocupar o lugar de localStorage; uma plataforma de ensino guarda esse mesmo JSON nos dados do aluno. Este devolve três questões da prova já verificadas, com dois erros (verdadeiro na afirmação 3 e 180 km na distância), e a página abre como um aluno que volta a encontraria: essas questões bloqueadas, suas respostas disponíveis e a de ordenar ainda por fazer.

#3 · Responder nas páginas e ouvir cada verificação

script.js · linhas 296–333no código completo
const el = (tag, css, text) => Object.assign(document.createElement(tag),
  { textContent: text ?? '' }, { style: css });
const course = el('section', 'display: flex; flex-wrap: wrap; gap: 16px; justify-content: center;'
  + 'padding: 24px 16px 0; font: 13px/1.5 system-ui, sans-serif; color: #d9d5cc');
course.id = 'course';
const frame = el('div', 'width: min(700px, 94vw); height: 720px; overflow: auto;'
  + 'border-radius: 6px; background: #2a2e35');
frame.innerHTML = renderToHtml(doc, { mode: 'single', background: palette.paper, padding: 16,
  resourceImageUrl: imageUrl });
const card = el('aside', 'width: min(300px, 94vw); padding: 14px 16px; border-radius: 6px;'
  + 'border: 1px solid #2c3038; background: #15181d');
const results = new Map();
function report(result) { // every check, fresh start and solution shown
  if (result.style !== 'test') return;
  results.set(result.key, result);
  const all = [...results.values()];
  const [right, total] = all.reduce(([r, n], x) => [r + x.right, n + x.total], [0, 0]);
  const score = Math.round((100 * right) / total);
  const done = all.length === tests.length && all.every((x) => x.checked || x.locked);
  const verdict = !done ? t({ en: 'incomplete', es: 'sin terminar' })
    : score >= exercises.digital.passingScore ? t({ en: 'passed', es: 'aprobado' })
      : t({ en: 'failed', es: 'suspenso' });
  card.replaceChildren(el('h2', 'margin: 0; font-size: 15px; color: #f4f1ea',
    t({ en: 'What the platform hears', es: 'Lo que recibe la plataforma' })),
  el('p', 'margin: 6px 0; font-size: 22px; color: #f4f1ea', `${score} % · ${verdict}`),
  el('p', 'margin: 0 0 8px', t({ en: `${right} of ${total} answers right in the test, pass `
    + `mark ${exercises.digital.passingScore} %`, es: `${right} de ${total} respuestas bien en el `
    + `examen, aprueba con el ${exercises.digital.passingScore} %` })),
  ...all.map((x) => el('p', 'margin: 0; font-variant-numeric: tabular-nums',
    `${t({ en: 'Exercise', es: 'Ejercicio' })} ${x.number} · `
    + `${x.right}/${x.total} · ${x.checked || x.locked ? t({ en: 'checked', es: 'comprobado' })
      : t({ en: 'to do', es: 'por hacer' })}`)));
}
attachExercises(frame, { storageKey: 'restless-planet:4', store: platform, onResult: report });
course.append(frame, card);
document.getElementById('pages').before(course);
const first = frame.querySelector(`[data-pt-ex="${tests[0].id}"]`);
frame.scrollTop = first.getBoundingClientRect().top - frame.getBoundingClientRect().top - 120;

renderToHtml escreve as páginas e os dados dos exercícios; attachExercises põe por cima os campos, as caixas e a barra. onResult recebe cada exercício quando é preparado e depois de cada verificação, cada recomeço e cada resposta mostrada, com as respostas avaliadas certas (right) e totais (total), as verificações usadas e se a tentativa está bloqueada (locked). O painel soma as respostas da prova como faz um player SCORM: acertos sobre respostas avaliadas em toda a prova, completa quando cada questão está verificada ou bloqueada, aprovada a partir de passingScore. A página usa dpi: 96, então um milímetro da página impressa é um milímetro CSS na tela.

#4 · Os mesmos exercícios num EPUB

script.js · linhas 337–357no código completo
const epubFonts = (faces) => Promise.all(Object.entries(faces).flatMap(([family, specs]) =>
  specs.map(async (spec) => {
    const [weight, style, id] = [parseInt(spec, 10), spec.endsWith('i') ? 'italic' : 'normal',
      fontsourceId(family)];
    const res = await fetch(`${await fontsourceAt(id)}files/${id}-latin-${weight}-${style}.woff2`);
    if (!res.ok) throw new Error(`Fontsource has no ${family} ${weight} ${style}`);
    const bytes = new Uint8Array(await res.arrayBuffer());
    return { family, weight, style, format: 'woff2', bytes };
  })));
const metadata = { title: doc.metadata.title, subtitle: doc.metadata.subtitle, language: LANG,
  modified: new Date('2026-10-31T00:00:00Z') }; // fixed: the same bytes on every run
const fonts = await epubFonts(FONTS);
const resourceBytes = (fileId) => ({ bytes: imageBytes(fileId), mediaType: 'image/jpeg' });
const epub = await renderToEpub([doc], { layout: 'fixed', metadata, fonts, resourceBytes });
const offer = (bytes, name, type) => {
  const link = el('a', 'color: #d8a21a', `${name} · ${Math.round(bytes.length / 1024)} KB`);
  link.href = URL.createObjectURL(new Blob([bytes], { type }));
  link.download = name;
  document.getElementById('pt-actions').append(link);
};
offer(epub, `${RECIPE}.epub`, 'application/epub+zip');

O EPUB de layout fixo leva os dados dos exercícios e o script que os torna respondíveis: um sistema de leitura que executa scripts oferece os mesmos campos e os mesmos limites, e um que não executa mantém o gabarito que o gerador acrescenta. As fontes vão como bytes, os mesmos arquivos da Fontsource que a página carregou.

#5 · Um curso SCORM com a prova à parte

script.js · linhas 360–370no código completo
// The module's headings as postext-scorm reads them; the last one, the test, runs to the end.
const sections = treeLeaves(scormTree([{ markdown }], config)[0]);
const exam = sections.at(-1);
const items = [
  { title: t({ en: 'Lesson and practice', es: 'Lección y práctica' }), doc: 0,
    range: { start: sections[0].range.start, end: exam.range.start } },
  { title: exam.title, doc: 0, range: exam.range }, // its score is the test's alone
];
const scorm = await renderToScorm([doc], { version: '2004', layout: 'fixed', items, metadata,
  fonts, resourceBytes }); // the pass mark comes from exercises.digital.passingScore
offer(scorm, `${RECIPE}-scorm.zip`, 'application/zip');

renderToScorm recebe os documentos e as opções de renderToEpub, mais a version do SCORM e os items do curso. Cada item é um SCO, a parte de um curso que a plataforma abre e avalia sozinha, e um SCO conta todos os exercícios que contém. scormTree lê os títulos do módulo com o trecho de Markdown que cada um cobre, então o primeiro SCO vai do título até a prova (ali se avalia a prática) e o segundo traz só a prova, até o fim. Cada um informa aprovado ou reprovado com exercises.digital.passingScore. Dentro do pacote, um player ocupa o lugar que platform ocupa nesta página: guarda as respostas no registro da plataforma e envia cada verificação, e quem volta encontra a prova como a deixou.

A receita completa

Sandbox
// ═══ Postext Cookbook · Nº 179 · A course module with a test answered on screen ═══
// https://postext.dev/en/cookbook/self-checking-course-module
// Code: MIT · Text: original (CC BY 4.0) · Painting: generated with diffusion models
// Fonts: Source Serif 4, Archivo (SIL OFL 1.1) · Needs postext ≥ 1.65.0
import {
  buildDocumentWithFonts, renderPageToCanvas, registerResourceImage, renderToHtml,
  attachExercises, exerciseSolutionValue,
} from 'https://esm.sh/postext';
import { renderToEpub } from 'https://esm.sh/postext-epub';
import { renderToScorm, scormTree, treeLeaves } from 'https://esm.sh/postext-scorm';

const LANG = 'en'; // @lang: the language of the sample document ('en' | 'es')
const RECIPE = 'self-checking-course-module';

// ─── 1 · Design ─────────────────────────────────────────────────────────────
const palette = {
  ink: '#1f2523', // text: a green-tinted near-black
  rust: '#9c4420', // the course's accent: kicker, practice numbers, rules
  slate: '#2f5266', // the test: its numbers and its frame
  tint: '#f5efe4', // the safety box, the word bank
  rule: '#d6cdbf', // hairlines
  muted: '#646d69', // running heads, colophon
  paper: '#ffffff',
};
const col = (id) => ({ hex: palette[id], model: 'hex', paletteId: id });
const colorPalette = [
  ...Object.entries(palette).map(([id, hex]) => ({ id, name: id, value: { hex, model: 'hex' } })),
  { id: 'main-color', name: 'rust (defaults)', value: { hex: palette.rust, model: 'hex' } },
];
const [TEXT, SANS] = ['Source Serif 4', 'Archivo'];
const [TOP, OUTER, LEAD] = [22, 21, 15.5]; // mm, mm, pt
const BAND = 100; // mm: the painting's depth from the trim, over 3 mm of bleed

// #region answer: practice and test from one Markdown: the test style limits each attempt
// Practice: check, start again and see the solution as often as the learner likes.
const practice = {
  id: 'practice',
  number: { shape: 'disc', background: col('rust'), fontFamily: SANS, fontWeight: 700 },
  instruction: { fontFamily: SANS, bold: true, fontSize: pt(10) },
  options: { marker: 'circle' },
  blank: { look: 'line', color: col('ink'), weight: pt(0.6) },
  match: { look: 'dots', gap: em(3), color: col('rust') },
  bank: { box: 'bank' },
  marginTop: mm(5), marginBottom: mm(1), itemSpacing: em(0.15),
};
// The test: one check, no fresh start, the solution only once the check is spent. On paper
// the same questions print without their key.
const test = {

O script.js montado funciona como está: cole-o como script de módulo em qualquer página ou abra a receita no CodePen. Pasta da receita no GitHub ↗ (abre em uma nova aba)

Variações

#SCORM 1.2, ou o texto refluído

Muitas plataformas mais antigas só importam SCORM 1.2, em que a nota de aprovação vira a nota de domínio de cada SCO. layout: 'reflowable' envia o texto no lugar das páginas impressas, para quem estuda no celular.

-const scorm = await renderToScorm([doc], { version: '2004', layout: 'fixed', items, metadata,
+const scorm = await renderToScorm([doc], { version: '1.2', layout: 'reflowable', items, metadata,

#Corrigir cada resposta ao ser dada

Para um quiz sem botão Verificar, use check: 'instant' em exercises.digital. A correção imediata tira o limite de verificações; o estilo da prova mantém showSolution.

-  digital: { passingScore: 70 },
+  digital: { passingScore: 70, check: 'instant' },

Erros comuns

Dê uma âncora a cada exercício avaliado (:::exercise{#test-scales}). Suas respostas ficam guardadas sob a âncora; sem ela, a chave vem da posição do exercício no documento, e uma questão acrescentada antes devolve ao aluno que volta as respostas salvas de outra.

Créditos

Texto
Texto original, CC BY 4.0
Imagens
  • A fault across a dry plain in late afternoon light (the module's opener) · Generated With Diffusion Models · original
Fontes
Source Serif 4 (SIL OFL 1.1) · Archivo (SIL OFL 1.1)
Sandbox