This glossary defines the terms that the collective.html2blocks documentation uses.
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.
- BeautifulSoup#
Beautiful Soup is a Python library for parsing HTML. The package uses it to find the block-level elements in the source.
- 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
- CommonMark#
CommonMark is a specification of the Markdown syntax. The package renders Markdown with the CommonMark rules, with tables and strikethrough enabled.
- Converter#
In
collective.html2blocks, a converter is a component or function that transforms HTML content into Volto blocks or other structured formats.- Diátaxis#
Diátaxis is a framework that organizes documentation into four kinds of content: tutorials, how-to guides, reference and explanation.
- FastAPI#
FastAPI is a Python web framework for building APIs. The HTTP service of this package is a FastAPI application.
- HTML#
HyperText Markup Language, the markup language of web pages. HTML is the main input format of the package.
- Markdown#
Markdown is a lightweight markup language for formatting plain text. The package converts Markdown to HTML before it converts the content to blocks.
- 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.tomlfiles 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 documentation uses Plone Sphinx Theme.
- pyproject.toml#
pyproject.tomlis 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.pyfile.- 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 documentation uses Sphinx to generate HTML pages.
- 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-slateis an interactive default text editor for Volto, developed on top of Slate, offering enhanced WYSIWYG functionality and behavior.