blueprint

KO | EN

gitlite — search

#javascript #ai #typescript #llm #machine-learning #rust #deep-learning #linux #nodejs #windows #awesome #cli #kubernetes #security

(★ 12)

Simple templating based on XML ropes

blueprint Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# blueprint

**blueprint** is a [polyglot HTML](http://www.w3.org/TR/html-polyglot/)
(or XML) template system. It's a command and a MirageOS-compatible OCaml
library.

To use **blueprint** from the command line, just

```
$ blue [templates]
```

and the templates will be composed with the result sent to stdout.

## Template language

The blueprint template language is an XML vocabulary that lets you place
'holes' in [polyglot HTML](http://www.w3.org/TR/html-polyglot/) (or XML)
documents. The `blue` command line tool automatically binds the
blueprint namespace to the `t:` prefix. Blueprint has 4 tags: *seq*,
*let*, *insert*, and *attr*.

### `t:seq`

`t:seq` is used to group elements together. It is most useful at the
root of a document in order to describe a sequence of elements or to
declare document-level bindings.

### `t:let`

`t:let` has a single required attribute, `name`, which gives a name to
the binding that it creates. Bindings are scoped from the point of
declaration until the end of the parent element. If the parent element
is `t:seq`, the binding will be exported as well. Whitespace before a
`t:let` is elided up to one or two consecutive new lines.

### `t:insert`

`t:insert` has a single required attribute, `name`, which gives a name
to the 'hole' that it creates. Bindings against this name will fill this
hole. When holes are filled, the template which fills the hole will be
recursively populated with any bindings in scope. If an expansion step
would use a binding previously used in the expansion, the expansion
stops before the previous hole is filled.

If content is supplied to a `t:insert` element, it will be used as the
default value of the hole in the case that no binding matching `@name`
exists in scope.

Names may only contain alphanumeric characters, '-', and '_'.

### `t:attr`

`t:attr` has a single required attribute, `name`, which is the name of
the attribute to populate. `t:attr` may only immediately follow a start
tag or another `t:attr` excluding whitespace. If the attribute `@name`
already exists, it is replaced with the content of `t:attr`. `t:attr`
may contain any content including `t:let`, `t:insert`, and `t:seq` but,
after recursive binding, all tags in the attribute value will be
dropped.

## `blue`

The `blue` tool is a simple command line wrapper around the `Blueprint`
library. `blue` accepts a sequence of files and composes them into a
single output document. The last file listed is used as the template and
all preceding files are used only for their bindings. Any unbound content
in the preceding files is discarded. The result must not contain any
template elements and will be sent to `stdout`. To read from `stdin`,
use `-` as a file name. The `-p` option will disable incomplete template
errors and allow output of partially fulfilled templates.

blueprint

blueprint Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

blueprint

blueprint Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README