50 Glossary
This glossary explains some of the important terms used throughout The Textsmith Primer. The definitions are intentionally concise. Readers seeking greater detail should consult the relevant chapters and the Further Reading section.
- Abstract Syntax Tree
- A structured internal representation of a document or program. Pandoc uses an Abstract Syntax Tree, commonly abbreviated as AST, to represent elements such as headings, paragraphs, lists, and quotations independently of their original file format.
- Accessibility
- The practice of designing information, software, and publications so that they can be used by people with different abilities and assistive technologies.
- Alias
- A short name assigned to a longer command, often within a shell configuration file. Aliases reduce repetitive typing and can make frequently used workflows easier to remember.
- Archive
- A collection of information preserved for long-term storage rather than immediate use. Archives may contain completed projects, correspondence, previous editions, research, or historical records.
- AsciiDoc
- A lightweight markup language designed for technical documentation, books, manuals, and professional publishing.
- Automation
- The practice of assigning repeatable tasks to software so that they can be performed consistently with minimal manual intervention.
- Backup
- A separate copy of data maintained so that work can be recovered after loss, damage, deletion, or hardware failure.
- Bibliography
- An organized list of sources used or recommended in a publication.
- BibTeX
- A plain-text bibliography database format and processing system commonly associated with TeX and LaTeX.
- Branch
- An independent line of development within a version-control repository. Branches allow experiments and revisions to occur without immediately changing the main version of a project.
- Build
- The automated process through which source files are transformed into finished outputs such as websites, books, PDFs, or presentations.
- Citation
- A reference within a document that identifies the source of an idea, quotation, fact, or argument.
- Command Line
- A text-based interface through which users communicate with a computer by entering commands.
- CommonMark
- A precise specification intended to provide consistent and predictable interpretation of Markdown syntax.
- Compilation
- The process of transforming source material into another form. In publishing, this may involve converting markup into HTML, PDF, EPUB, or another output format.
- Configuration File
- A file containing settings that control how a program or system behaves. Configuration files are often stored as plain text.
- Content Management System
- Software used to create, organize, and publish digital content, often through a browser-based interface. The abbreviation CMS is commonly used.
- Cross-Reference
- A link or reference from one part of a document to another, such as a reference to a chapter, figure, table, or section.
- CSV
- Comma-Separated Values. A simple plain-text format for tabular data in which fields are usually separated by commas.
- Dashboard
- An interactive publication that presents data, summaries, charts, and controls within a unified visual interface.
- Data
- Recorded information that can be stored, processed, analysed, or exchanged.
- DITA
- Darwin Information Typing Architecture. An XML-based system for structured and reusable technical documentation.
- DocBook
- An SGML- and XML-based vocabulary designed for books, manuals, and technical documentation.
- Document Class
- In LaTeX, a definition that determines the general structure and design of a document, such as an article, report, or book.
- Document Type Definition
- A formal description of the structure and permitted elements of an SGML or XML document. It is commonly abbreviated as DTD.
- EPUB
- An open digital-book format based largely upon web technologies such as HTML and CSS.
- Encoding
- A system that maps characters to numerical representations so that computers can store and process text.
- Field
-
A meaningful unit within a structured record. In
awk, fields are commonly separated by spaces, tabs, or another chosen delimiter. - Filter
- A program that receives input, transforms or selects part of it, and produces output. Many Unix text-processing tools operate as filters.
- Format
- A defined way of representing information. Examples include Markdown, HTML, EPUB, PDF, CSV, and JSON.
- Front Matter
- Material appearing before the main body of a book, such as the dedication, preface, introduction, and title information.
- Git
- A distributed version-control system used to record changes, preserve history, support collaboration, and manage evolving projects.
- GitHub Flavored Markdown
- A Markdown dialect developed around GitHub that includes features such as tables, task lists, fenced code blocks, and strikethrough text. It is commonly abbreviated as GFM.
- Graph
- A collection of nodes and relationships. Graphs can represent networks, dependencies, links, or conceptual connections.
- Graphviz
- A collection of tools and languages for describing and generating diagrams from plain text.
- HTML
- HyperText Markup Language. The standard markup language used to describe the structure of pages on the World Wide Web.
- Hyperlink
- A reference that connects one digital document or location to another.
- Hypertext
- Text containing links that allow readers to move between related documents or sections non-linearly.
- Index
- An organized aid for locating information. In books, an index maps terms to pages or sections. In search systems, an index accelerates the discovery of documents and content.
- Inline Code
- A short piece of source code or command written within a paragraph rather than in a separate code block.
- Interoperability
- The ability of different systems, tools, or formats to exchange and use information successfully.
- JSON
- JavaScript Object Notation. A text-based format commonly used to represent structured and hierarchical data.
- Jupyter Notebook
- An interactive document format combining narrative text, executable code, outputs, equations, and visualizations.
- LaTeX
- A high-level document preparation system built upon TeX. It provides structural commands and reusable macros for books, articles, reports, and academic documents.
- Lightweight Markup Language
- A markup language designed to remain readable and easy to write in its plain-text source form. Markdown, AsciiDoc, and reStructuredText are examples.
- Literate Programming
- A method of writing programs in which explanation and source code are developed together as a readable document.
- Markdown
- A lightweight markup language designed to make structured writing readable in its source form and easy to transform into HTML and other publication formats.
- Markup
- Symbols or annotations added to text to describe its structure, meaning, or presentation.
- Markup Language
- A formal system for describing the structure or meaning of information using plain text.
- Mermaid
- A text-based diagramming language commonly used for flowcharts, sequence diagrams, timelines, state diagrams, and other visual structures.
- Metadata
- Information that describes a document or dataset, such as its title, author, date, language, keywords, or publication format.
- Notebook
- A personal or collaborative environment used to capture, organize, connect, and develop ideas.
- Org Mode
- An Emacs mode for outlining, note-taking, task management, literate programming, and publishing using structured plain text.
- Pandoc
- A document converter and publishing engine capable of translating between many markup and document formats.
- Parser
- Software that reads a language or document format and converts it into a structured representation that other programs can process.
- Portable Document Format. A fixed-layout format intended to preserve the appearance of a document across devices and systems.
- Pipeline
- A workflow in which the output of one process becomes the input of another.
- Plain Text
- Text represented as characters without embedding application-specific formatting or layout instructions.
- Project
- A collection of related source files, configuration, assets, and metadata organized to produce one or more finished works.
- Quarto
- An open-source publishing system built upon Pandoc that supports books, websites, articles, blogs, presentations, dashboards, and computational documents.
- Record
-
A complete unit of structured information. In
awk, each line is treated as a record by default. - Redirection
- A shell mechanism that changes where a program receives input or sends output and error messages.
- Regular Expression
- A compact language for describing patterns in text. Regular expressions are commonly called regex.
- Rendering
- The process of turning structured source material into a visible or publishable form.
- Repository
- A version-controlled collection of files and their recorded history.
- Reproducibility
- The ability to repeat a process and obtain the same or appropriately consistent result.
- reStructuredText
- A lightweight markup language designed primarily for technical documentation and closely associated with Python and Sphinx.
- Screen Reader
- Assistive software that presents text, controls, and document structure through synthesized speech or Braille output.
- Script
- A text file containing commands or instructions that automate a sequence of tasks.
- Semantic Structure
- Structure that describes the meaning or role of content, such as identifying text as a heading, quotation, warning, citation, or chapter.
- SGML
- Standard Generalized Markup Language. A standard for defining descriptive markup languages and an important predecessor of HTML and XML.
- Shell
- A command interpreter and scripting environment used to execute and combine programs.
- Single-Source Publishing
- A publishing approach in which one authoritative source is used to generate multiple output formats.
- Sphinx
- A documentation publishing system originally developed for Python and commonly used with reStructuredText.
- Standard Error
- A separate output stream used by programs to report errors and diagnostic information.
- Standard Input
- The default stream through which a program receives data.
- Standard Output
- The default stream through which a program sends its normal results.
- Static Site Generator
- A publishing tool that transforms source files and templates into prebuilt HTML pages.
- Structured Data
- Information organized according to a predictable system of records, fields, objects, lists, or relationships.
- Stylesheet
- A collection of rules that controls the appearance of a document. CSS stylesheets commonly control the appearance of HTML.
- Syntax
- The formal rules governing how expressions are written in a language.
- Table of Contents
- An organized list of a document’s major sections, chapters, or headings.
- Template
- A reusable structure that controls the organization or presentation of a document while leaving its content variable.
- TeX
- A digital typesetting system created by Donald Knuth, especially renowned for mathematical and scientific typography.
- Text Processing
- The searching, filtering, transforming, organizing, analysing, and combining of textual information.
- Textsmith
- A person who works thoughtfully with plain text, markup, text-processing tools, publishing systems, and the habits of clear digital craftsmanship.
- Theme
- A collection of visual rules that controls the appearance of a website, book, presentation, or other publication.
- TSV
- Tab-Separated Values. A plain-text tabular data format in which fields are separated by tab characters.
- Typst
- A modern markup and typesetting system combining readable syntax, mathematical typesetting, scripting, and fast document compilation.
- Unicode
- A universal character standard that assigns numerical identifiers to characters from many languages and writing systems.
- Unix Philosophy
- A software-design tradition emphasizing small programs, plain-text interfaces, composability, and tools that do one thing well.
- Version Control
- A system for recording changes to files and projects over time.
- Website
- A collection of linked pages and resources published on the World Wide Web.
- Workflow
- A repeatable sequence of actions through which information or work moves from one stage to another.
- XML
- Extensible Markup Language. A framework for creating custom markup vocabularies for structured information.
- YAML
- A human-readable structured-data format commonly used for configuration and document metadata.