This glossary provides example terms and definitions relevant to collective.html2blocks. Technical documentation for the collective.html2blocks package

Note

This is an example glossary demonstrating MyST Markdown’s {glossary} directive. You can adapt it for your project’s appendix by editing or replacing these entries with your own terms and definitions.

Glossary

add-on

An add-on in Plone extends its functionality. It is code that is released as a package to make it easier to install.

In Volto, an add-on is a JavaScript package.

In Plone core, an add-on is a Python package.

• Plone core add-ons

• Volto add-ons

• Add-ons tagged with the trove classifier Framework :: Plone on PyPI

blocks

Blocks are the fundamental components of a page layout in Volto.

blocks_layout

The structure that defines the order and arrangement of blocks within a Volto page or content item. It is usually represented as a JSON object.

CLI

Command-Line Interface. A program that is operated by typing commands into a terminal or shell, rather than using a graphical user interface (GUI).

CMS

Content Management System

collective.exportimport

collective.exportimport is a package to export and import content, members, relations, translations, localroles and much more.

collective.transmute

collective.transmute is a package to convert data from collective.exportimport to plone.exportimport

Converter

In collective.html2blocks, a converter is a component or function that transforms HTML content into Volto blocks or other structured formats.

Markedly Structured Text

MyST

Markedly Structured Text (MyST) is a rich and extensible flavor of Markdown, for authoring Plone Documentation. The sample documentation in this scaffold is written in MyST.

OpenAPI

OpenAPI is a specification for describing RESTful APIs, enabling automatic documentation, client generation, and validation.

PEP 621

PEP 621 is a Python Enhancement Proposal that standardizes how project metadata is specified in pyproject.toml files for Python packages.

Plone

Plone is an open-source content management system that is used to create, edit, and manage digital content, like websites, intranets and custom solutions. It comes with over 20 years of growth, optimisations, and refinements. The result is a system trusted by governments, universities, businesses, and other organisations all over the world.

Plone Sphinx Theme

plone-sphinx-theme

Plone Sphinx Theme is a Sphinx theme for Plone 6 Documentation, Plone Conference Training, and documentation of various Plone packages. This scaffold uses Plone Sphinx Theme.

pyproject.toml

pyproject.toml is a configuration file for Python projects that defines build system requirements, dependencies, and project metadata. It is used by modern Python packaging tools and specified by PEP 518 and PEP 621.

pytest

pytest is a Python test framework that makes it easy to write small, readable tests, and can scale to support complex functional testing for applications and libraries.

Registration

The process of making a converter, block, or other component available to the system, typically by adding it to a registry or configuration.

REST

REST stands for Representational State Transfer. It is a software architectural principle to create loosely coupled web APIs.

setuptools

setuptools is a Python package development and distribution library. It is commonly used to build, package, and install Python projects, especially those using a setup.py file.

Slate

Slate.js is a highly customizable platform for creating rich-text editors, also known as WYSIWYG editors. It enables you to create powerful, intuitive editors similar to those you've probably used in Medium, Dropbox Paper, or Google Docs.

Sphinx

Sphinx is a tool that makes it easy to create intelligent and beautiful documentation. It was originally created for Python documentation, and it has excellent facilities for the documentation of software projects in a range of languages. It can generate multiple output formats, including HTML and PDF, from a single source. This scaffold uses Sphinx to generate documentation in HTML format.

Transmogrifier

Transmogrifier provides support for building pipelines that turn one thing into another. Specifically, transmogrifier pipelines are used to convert and import legacy content into a Plone site. It provides the tools to construct pipelines from multiple sections, where each section processes the data flowing through the pipe.

Typer

Typer is a Python library for building command-line interfaces (CLIs) using type hints, automatic help generation, and minimal code.

uv

uv is a fast Python package manager and build tool that supports modern workflows, including dependency management via pyproject.toml.

Uvicorn

Uvicorn is a lightning-fast ASGI server implementation for Python, commonly used to run FastAPI applications.

Volto

Volto is a React-based frontend for Plone.

volto-slate

volto-slate is an interactive default text editor for Volto, developed on top of Slate, offering enhanced WYSIWYG functionality and behavior.