Presswork User Manual (EN)

A detailed user manual for Presswork, including a short app description, a complete list of functions, and concise instructions for how to use every function.

1. App Description (Short)

Presswork is a professional Markdown publishing suite with a focused editor and export pipelines for print and digital formats, including certified PDF/X.

2. Complete List of Functions

2.1 Documents Menu

• New
• Save MD
• Open project
• Save as...
• Structure Mode
• Manage Project
• Print
• Versions

2.2 Tools Menu

• Goals
• User Guide
• Export Check
• Command Palette
• Style Analysis
• AI Assistant
• Vim Mode
• Collab
• Tour

2.3 Export Menu

• Import/Export
• PDF
• PDF/X (certified)
• Word (DOCX)
• ODT
• EPUB
• HTML
• ICML
• PDF/X options (ICC, validation, embedded fonts)
• Preflight
• Export history
• Multi‑Export
• Convert Folder

2.4 View Menu

• Writing Mode
• Code Mode
• Preview Mode
• Page Mode
• Split Mode
• Language (English)
• Language (Italian)
• Interface Mode (Base)
• Interface Mode (Pro)
• Theme (Light)
• Theme (Dark)
• Typewriter Mode
• Focus Mode
• Presentation
• Accessibility (Text size)
• Accessibility (High contrast)
• Accessibility (Dyslexia‑friendly font)

2.5 Editor Toolbar

• Bold
• Italic
• Underline
• H1
• H2
• H3
• Link
• Image
• Code
• List
• Quote
• Table
• CriticMarkup Add
• CriticMarkup Delete
• CriticMarkup Comment
• Templates
• Metadata (YAML)
• Snapshots

2.6 Sidebar Panels

• Outline
• Snapshot Panel
• Backlinks
• Scrivener Sidebar

2.7 Writing Features

• Live Preview
• Page View
• Focus Mode
• Typewriter Mode
• Outline Navigation
• Corkboard Synopsis
• Writing Goals
• Snapshots

2.8 Export & Publishing Features

• Base PDF (Typst)
• Certified PDF/X (LaTeX)
• Ghostscript Validation
• ICC Profiles
• Bleed/Crop Marks
• Font Embedding
• DOCX/ODT Export
• EPUB Export
• Excel Export (breakdown + templates, multi-sheet import with sheet selection, chart preview)
• ePub Validator (Kindle preview + report)
• HTML Export
• ICML Export (smart style mapping for headings, lists, quotes, and screenplay elements)
• Print
• Batch/Multi‑Export
• Export with Assets
• Presentation Mode
• Chapter Numbering on Export
• EPUB/ICML Metadata Wizard
• EPUB/ICML Cover Wizard
• PDF Digital Signing (PKCS#7)
• RFC 3161 Timestamping

2.9 Design & Accessibility

• Light/Dark Themes
• YAML Brand Themes
• Presentation Presets
• Typography‑aware Preview
• Text Alignment Mirroring
• Adjustable Reading Size
• High‑Contrast Mode
• Dyslexia‑friendly Font

2.10 Writing Stats & Benchmarks

• Global Stats
• Document Stats
• Project Stats
• Writing Speed
• Flow Hours
• Lexical Density
• Repeated Bigrams
• Adaptive Difficulty Scoring
• Genre Benchmarks
• TTR (Type‑Token Ratio)

2.11 AI & Power Tools

• AI Endpoint Configuration
• Command Palette
• Vim Mode
• Regex Search
• Backlinks
• Autocomplete
• MathJax
• Math Toolbar (LaTeX)
• Real‑time Calculation (\calc{})
• Style Analyzer (Repetition)
• Style Analyzer (Grammar/Concordance)
• Style Analyzer (Inclusive Language)
• Style Analyzer (Readability)
• Style Analyzer (Contextual Rewrites)
• Style Analyzer (Glossary Consistency)
• Style Analyzer (Tone/Register)
• Style Analyzer (Structure/Rhythm)
• Style Analyzer (Editorial Profiles)
• Style Analyzer (Multilingual Context)
• Inline Quick Fixes

2.12 Projects & Structure

• Chapter Status (Draft/Review/Final)
• Structure Sidebar Filters
• Template Library (Shared)

2.13 Collaboration

• Pair Editing (PeerJS)
• Live Sync
• Colored Remote Cursors
• Inline Comments

3. How Statistics Are Calculated

Presswork builds stats from two sources: daily history (words per day) and writing sessions (timestamped word deltas while you write). Below is how each metric is computed.

3.1 Productivity & Words per Day

• Daily productivity (avg): average words over the last 7 days in the selected scope.
• Weekly productivity (avg): daily average × 7.
• Words/day benchmarks: the min–max range comes from the selected genre defaults (or your overrides).

3.2 Flow (Ore di flusso / Flow hours)

• Best hour: the hour of day with the highest total words across sessions.
• Best day: the weekday with the highest total words across sessions.
• Flow hours chart: histogram of total words per hour (0–23).

3.2b Realtime Flow State

• Average keystroke interval: mean time between keystrokes in milliseconds.
• Current phase: derived from recent deletion ratio (burst vs editing vs mixed).
• Peak window: best 30‑minute window over recent days.

3.3 Writing Speed

• Words/hour & words/minute: total words in recent sessions divided by the time span between the first and last session (last 7 days).
• Morning/Evening: average words per session in 06:00–12:00 and 18:00–24:00 windows.

3.4 Lexical Analysis

• TTR: unique words ÷ total words.
• MSTTR: average TTR over 50‑word windows.
• Top repetitions: most frequent non‑stopwords longer than 2 characters.
• Repeated bigrams: most frequent two‑word sequences (non‑stopwords) with count > 1.
• Lexical density: content words ÷ total words.

3.5 Cognitive Load

• Sentence complexity: based on average sentence length.
• Conceptual density: share of content words.
• Jargon ratio: share of long words (>=12 characters).
• Cognitive score: composite score (0–100) derived from the above.

3.6 Readability

• Italian: Gulpease score (0–100, higher = easier).
• English: Flesch Reading Ease (0–100, higher = easier). These are scores, not percentages.

3.7 Completion Forecasts

• Estimated time: based on current words, target goal, and daily average (last 7 days).
• Optimistic: uses the higher of 7‑day vs 30‑day daily averages.
• Pessimistic: uses the lower of 7‑day vs 30‑day daily averages.
• Estimated range: the optimistic and pessimistic dates combined.

4. How to Use Every Function (Concise)

4.1 Documents Menu

• New → Documents > New.
• Save MD → Documents > Save MD.
• Import document → Documents > Import document (PDFs open in read‑only viewer).
• Open project → Documents > Open project.
• Save as... → Documents > Save as...
• Structure Mode → Documents > Structure Mode.
• Manage Project → Documents > Manage Project.
• Print → Documents > Print.
• Versions → Documents > Versions.

4.2 Tools Menu

• Goals → Tools > Goals.
• License → Settings > App.
• User Guide → Tools > User Guide.
• Export Check → Tools > Export Check.
• Command Palette → Tools > Command Palette or Ctrl/Cmd + P.
• Style Analysis → Tools > Style Analysis.
• AI Assistant → Tools > AI Assistant.
• Vim Mode → Tools > Vim Mode or Ctrl + Alt + V.
• Collab → Tools > Collab.
• Tour → Tools > Tour.

4.3 Export Menu

• Import/Export → Export > Import/Export.
• PDF → Export > PDF.
• PDF/X (certified) → Export > PDF/X.
• Word (DOCX) → Export > Word.
• ODT → Export > ODT.
• EPUB → Export > EPUB.
• Excel → Export > Excel.
• HTML → Export > HTML.
• ICML → Export > ICML.
• PDF/X options → Export > PDF/X options.
• Preflight → Export > Preflight.
• Export history → Export > Export history.
• Multi‑Export → Export > Multi‑Export.
• Convert Folder → Export > Convert Folder.

4.4 View Menu

• Writing Mode → View > Writing.
• Code Mode → View > Code.
• Preview Mode → View > Preview.
• Page Mode → View > Page.
• Split Mode → View > Split.
• Language (English) → View > Language > English.
• Language (Italian) → View > Language > Italian.
• Interface Mode (Base/Pro) → Base/Pro switch in the header; the full plan and the License are managed from Settings > App > Workspace view.
• Theme (Light) → View > Theme > Light.
• Theme (Dark) → View > Theme > Dark.
• Typewriter Mode → View > Typewriter Mode.
• Focus Mode → View > Focus Mode or F11.
• Presentation → View > Presentation.
• Accessibility (Text size) → View > Accessibility > Text size.
• Accessibility (High contrast) → View > Accessibility > High contrast.
• Accessibility (Dyslexia‑friendly font) → View > Accessibility > Dyslexia‑friendly font.

4.5 Editor Toolbar

• Bold → Toolbar > Bold or Ctrl/Cmd + B.
• Italic → Toolbar > Italic or Ctrl/Cmd + I.
• Underline → Toolbar > Underline or Ctrl/Cmd + U.
• H1 → Toolbar > H1.
• H2 → Toolbar > H2.
• H3 → Toolbar > H3.
• Link → Toolbar > Link.
• Image → Toolbar > Image.
• Code → Toolbar > Code.
• List → Toolbar > List.
• Quote → Toolbar > Quote.
• Table → Toolbar > Table.
• CriticMarkup Add → Toolbar > CriticMarkup Add.
• CriticMarkup Delete → Toolbar > CriticMarkup Delete.
• CriticMarkup Comment → Toolbar > CriticMarkup Comment.
• Templates → Toolbar > Templates.
• Metadata (YAML) → Toolbar > Metadata.
• Snapshots → Toolbar > Snapshots.

4.5b Templates (updated)

• Built-in + imported templates are visible in category tabs (Business / Documents / UI Kit).
• Imported templates support file + folder import and show a localized Custom badge.
• Type-aware behavior: MD (editor), TEX/PDFX/PDFT (PDF export style), CSS (UI theme), XLSX-like (data/report flows).
• CSS themes can auto-pair with matching PDF export styles (toggle + Unpair).
• Full template feature brief: docs/template-functions-overview-en.md.

4.6 Sidebar Panels

• Outline → Sidebar > Outline.
• Snapshot Panel → Sidebar > Snapshot Panel.
• Backlinks → Sidebar > Backlinks.
• Scrivener Sidebar → Sidebar > Scrivener.

4.7 Writing Features

• Live Preview → View > Preview.
• Page View → View > Page.
• Focus Mode → View > Focus Mode or F11.
• Typewriter Mode → View > Typewriter Mode.
• Outline Navigation → Sidebar > Outline.
• Corkboard Synopsis → Sidebar > Synopsis.
• Writing Goals → Tools > Goals.
• Snapshots → Toolbar > Snapshots.

4.8 Export & Publishing Features

• Base PDF (Typst) → Base mode > Export > PDF.
• Certified PDF/X (LaTeX) → Pro mode > Export > PDF/X.
• Ghostscript Validation → Export > PDF/X options > Validation.
• ICC Profiles → Export > PDF/X options > ICC profile.
• Bleed/Crop Marks → Export > PDF/X options.
• Font Embedding → Export > PDF/X options.
• DOCX/ODT Export → Export > Word or ODT.
• EPUB Export → Export > EPUB.
• Excel Export → Export > Excel.
• ePub Validator → Editorial Area > ePub Validator.
• HTML Export → Export > HTML.
• ICML Export → Export > ICML.
• ICML Templates → choose a preset or import a custom .icml.
• Print → Documents > Print.
• Batch/Multi‑Export → Export > Multi‑Export.
• Export with Assets → Export > Export with assets.
• Presentation Mode → View > Presentation.
• Chapter Numbering on Export → Export > Chapter numbering.
• EPUB/ICML Metadata Wizard → Export > EPUB/ICML Metadata.
• EPUB/ICML Cover Wizard → Export > EPUB/ICML Cover.
• PDF Digital Signing (PKCS#7) → Export > PDF > Sign.
• RFC 3161 Timestamping → Export > PDF > Timestamp.

4.9 Design & Accessibility

• Light/Dark Themes → View > Theme.
• YAML Brand Themes → View > Theme > Brand (YAML).
• Presentation Presets → View > Presentation > Presets.
• Typography‑aware Preview → View > Page.
• Text Alignment Mirroring → View > Preview alignment.
• Adjustable Reading Size → View > Accessibility > Text size.
• High‑Contrast Mode → View > Accessibility > High contrast.
• Dyslexia‑friendly Font → View > Accessibility > Dyslexia‑friendly font.

4.10 Writing Stats & Benchmarks

• Global Stats → Tools > Writing Stats > Global.
• Document Stats → Tools > Writing Stats > Document.
• Project Stats → Tools > Writing Stats > Project.
• Writing Speed → Tools > Writing Stats > Speed.
• Flow Hours → Tools > Writing Stats > Flow.
• Lexical Density → Tools > Writing Stats > Lexical density.
• Repeated Bigrams → Tools > Writing Stats > Repeated bigrams.
• Adaptive Difficulty Scoring → Tools > Writing Stats > Adaptive difficulty.
• Genre Benchmarks → Tools > Writing Stats > Benchmarks.
• TTR (Type‑Token Ratio) → Tools > Writing Stats > TTR.

4.11 AI & Power Tools

• AI Endpoint Configuration → Set PRESSWORK_AI_* env vars.
• Command Palette → Ctrl/Cmd + P.
• Vim Mode → Ctrl + Alt + V.
• Regex Search → Search > Regex.
• Backlinks → Sidebar > Backlinks.
• Autocomplete → Preferences > Autocomplete.
• MathJax → View > MathJax.
• Math Toolbar (LaTeX) → Toolbar > Math.
• Real‑time Calculation (\calc{}) → Insert \calc{} in editor.
• Style Analyzer (Repetition) → Tools > Style Analysis.
• Style Analyzer (Grammar/Concordance) → Tools > Style Analysis.
• Style Analyzer (Inclusive Language) → Tools > Style Analysis.
• Style Analyzer (Readability) → Tools > Style Analysis.
• Style Analyzer (Contextual Rewrites) → Tools > Style Analysis.
• Style Analyzer (Glossary Consistency) → Tools > Style Analysis.
• Style Analyzer (Tone/Register) → Tools > Style Analysis.
• Style Analyzer (Structure/Rhythm) → Tools > Style Analysis.
• Style Analyzer (Editorial Profiles) → Tools > Style Analysis.
• Style Analyzer (Multilingual Context) → Tools > Style Analysis.
• Inline Quick Fixes → Tools > Style Analysis > Fixes.

4.12 Projects & Structure

• Chapter Status (Draft/Review/Final) → Structure > Chapter status.
• Structure Sidebar Filters → Sidebar > Structure filters.
• Template Library (Shared) → Templates > Library.

4.13 Collaboration

• Pair Editing (PeerJS) → Tools > Collab > Start session.
• Live Sync → Tools > Collab > Sync.
• Colored Remote Cursors → Tools > Collab.
• Inline Comments → Tools > Collab > Comments.

Recent updates (Data Hub / Charts)

• Inserting a chart from the Excel Data Hub now immediately shows an image preview inside the editor, not only in the document preview pane.
• The inline chart preview has been reduced (about 50%) to be less intrusive while writing.
• Two-way toggle: 📝 Show code opens the chart-data block, 🖼️ Back to chart restores the image preview.
• The chart-data block is still preserved in Markdown for full preview/render/export compatibility.
• Inserting a table or chart as an image now saves the file into the document assets (docname.assets/images/) and only the Markdown reference goes into the editor: works with very large sheets too.
• If the document isn't saved yet, the app offers to save it on the fly (same flow as image drag&drop); if you decline, the table is inserted as Markdown text and the chart stays in the sheet.
• The text/image prompt now understands answers like "png", "jpg", "image", "photo"; unrecognized input asks again.
• The data grid follows the active light/dark theme.
• Save as Template: dialog redesigned in the app style and translated. It needs grid data and a template in the editor using {{ColumnName}} placeholders; "Generate Markdown" repeats the template for every row.
• Excel export (breakdown): reads the editor text (INT./EXT. scenes or # chapters); if no scenes are found it now warns instead of silently generating an empty file.
• Tables menu simplified: removed the duplicate "Import as template" entry (identical to "Open Tables sheet").
• Import/Export panel: new Batch tab (next to Base / Pro print / Screenplay / Editorial) with the batch actions: Convert Folder, Multi Export, Multi-format, With Assets. Advanced options only show what applies to the chosen format.
• 🧪 Verify ICML: in the export panel (ICML format) it checks the generated document — hierarchy, front matter, escaping, empty paragraphs — without writing anything; details appear in an in-app dialog. The same check also runs on every ICML export.
• Safer FDX export: generic Markdown (lists, tables, notes) always becomes Action — never Character/Dialogue by accident; real screenplays are still interpreted (scenes, characters, dialogue, transitions). \newpage becomes a real page break (in ICML too, via a remappable "Interruzione Pagina" style).
• Print via PDF: the Print button generates a temporary PDF (Typst, same typography as the exports) and opens it in the system viewer — print from the native dialog with a faithful preview.
• Settings reorganized: Installations section (one-click LaTeX, Ghostscript status), compact language view, Dark/Light theme chips. The AI panel's quick prompts are collapsible.

5. Deep function analysis (newly documented gaps)

This section fills advanced capabilities that were present in the app but under-documented in quick guides.

5.1 AI operations and diagnostics

• Cloud/local AI endpoints (OpenAI-compatible, Ollama, LM Studio) via PRESSWORK_AI_ENDPOINT, PRESSWORK_AI_MODEL, PRESSWORK_AI_API_KEY.
• Connection diagnostics with exportable JSON report for IT/support triage.
• Response style controls (concise/balanced/detailed), technical prompt preview/copy, and retry-last-prompt flow.
• Per-project endpoint/model pinning for editorial consistency.

5.2 Metrics methodology (how stats are computed)

• Productivity averages use daily history windows (7-day and 30-day).
• Writing speed is computed from word deltas over session time span (WPH/WPM).
• TTR = unique words / total words; MSTTR = average TTR over 50-word windows.
• Realtime flow state uses average keystroke interval plus recent deletion ratio.
• Completion forecast exposes optimistic/pessimistic estimates from 7d vs 30d baselines.

5.3 Advanced export flows now documented

• Final Draft (.fdx): chapter-like headings map to Scene Headings; optional notes/page breaks/scene numbering; .breakdown.json sidecar generation.
• ICML export: dedicated style mapping for headings/lists/quotes/screenplay + preset/custom .icml templates.
• EPUB/ICML metadata-cover wizard blocks export until minimum metadata and cover are set.
• PDF signing pipeline: PKCS#7 detached signature + RFC 3161 timestamp.

5.4 Living Document bundle mode (.pwk)

• Primary action becomes Export with destination picker.
• Automatic output targets reduce path mistakes.
• Header toggle temporarily restores classic quick-export controls.

5.5 Collaboration in restrictive networks

• Shareable session IDs (pw-...), colored remote cursors, inline comments, live sync.
• In-session voice/video controls.
• WebSocket relay fallback when WebRTC fails (via presswork-collab-relay-url).

5.6 Template system for production reuse

• File/folder import with automatic category routing (Business / Documents / UI Kit).
• Spreadsheet and binary templates in operational reporting flows.
• UI↔PDF auto-pairing and manual unpairing for controlled visual consistency.

5.7 Recommended delivery checklist

1. Choose Base/Pro according to deliverable and compliance needs.
2. Run Export Check before certified outputs.
3. Run Preflight before client/printer delivery.
4. Complete EPUB/ICML metadata + cover wizard.
5. Enable PKCS#7 + RFC 3161 for signed PDFs.
6. Store Collab session/relay policy for team continuity.