Glossary

Docutils

Docutils is an open-source text processing system for processing plain text documentation into useful formats, such as HTML, LaTeX, man-pages, OpenDocument, or XML. It includes reStructuredText, the easy to read, easy to use, what-you-see-is-what-you-get plain text markup language.

fence

A method to extend basic MyST syntax. You can define a directive with backticks (`) followed by a reStructuredText directive in curly brackets ({}), and a matching number of closing backticks. You can also nest fences by increasing the number of backticks.

````{warning}
There be dragons!
```{important}
Dragons have feelings, too!
```
````

Warning

There be dragons!

Important

Dragons have feelings, too!

Make

make

GNU make

GNU Make is a tool which controls the generation of executables and other non-source files of a program from the program's source files.

Make gets its knowledge of how to build your program from a file called the makefile, which lists each of the non-source files and how to compute it from other files. When you write a program, you should write a makefile for it, so that it is possible to use Make to build and install the program.

Markdown

Markdown is a text-to-HTML conversion tool for web writers.

MyST

Markedly Structured Text (MyST) is a rich and extensible flavor of Markdown, for authoring Plone Documentation.

Open Graph

The Open Graph protocol enables any web page to become a rich object in a social graph. For instance, this is used on Facebook to allow any web page to have the same functionality as any other object on Facebook.

reStructuredText

reStructuredText (rST) is an easy-to-read, what-you-see-is-what-you-get plain text markup syntax and parser system. The Plone 6 Documentation was written in reStructuredText originally, then converted to MyST in 2022.

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. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, Docutils.