Terms and definitions used throughout the Cookieplone documentation.
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.
- Cookiecutter#
Cookiecutter is a command-line utility that creates projects from templates. Templates are directories containing a
cookiecutter.jsonfile that defines variables, and Jinja2-templated files and folder names that are rendered when the project is generated. Cookieplone is built on top of Cookiecutter.- Cookieplone#
Cookieplone is a wrapper around Cookiecutter designed to streamline the creation of Plone codebases. It provides built-in validators, Jinja2 filters, a sub-template mechanism, and a curated set of templates maintained by the Plone community. Run it with
uvx cookieplone.cookieplone-templates is the official repository of Cookieplone templates maintained by the Plone community. It contains templates for backend add-ons, frontend add-ons, and full Plone projects. Cookieplone uses this repository as its default template source.
- 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.
- 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.
- 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.
- uv#
- uvx#
uv is an extremely fast Python package and project manager written in Rust, developed by Astral.
uvxis the tool runner bundled withuv—it installs and runs Python tools in isolated environments without requiring a manual virtual environment setup. Runninguvx cookieploneis the recommended way to use Cookieplone.