The outer layer of IPML syntax follows the rules set by Markdown
a document markup language which is very popular, stable, and well-supported.
See the Markdown Dingus
for a quick introduction and interactive playground.
(Any IPML input file, including the examples on this page,
can be pasted into the playground to see how it looks when formatted.)
Each IPML file contains a sequence of code blocks and supporting text.
Code blocks are indented by (at least) four spaces; supporting text is not:
IPML Example 1a - Markdown
Markdown use can be very simple and unobtrusive.
percent = 0.4
Markdown supports unobtrusive markup (e.g., headings, font control),
in the text sections.
This lets it generate formatted web pages and/or printed documentation,
while leaving the code sections undisturbed.
So, a file can use any desired amount of text formatting,
from none at all to quite a bit.
In this version of the example,
we specify that the first line is a top-level header
and italicize the word "fancier":
# IPML Example 1b - Markdown
Markdown use can be much _fancier_, if desired.
Here is a screenshot of Markdown Dingus output for the sample above:
Spacing within each line of a code block (after the initial indentation)
can be arranged to enhance readability. This is entirely optional.
Markdown is commonly translated into HTML, for online publication.
For example, GitHub
as its default format for project documentation, wikis,
, and more.
Markdown can also be mechanically translated into other formats (e.g., LaTeX).