RubyFrontier Documentation

Directive Objects

I have already explained that a file or folder in your source folder whose name begins with # is a directive object. And I have explained that, as RubyFrontier starts to process a page object, it walks the hierarchy up from that page object, looking for directives.

But what directives is RubyFrontier looking for?

You can have directive objects by any names, which your scripts can use for your own purposes; but here we’re going to talk about the directive objects that “belong” to RubyFrontier — those that RubyFrontier expects and hopes to find in your source folder. I’m not going to explain yet the details of what precisely how and when each is used; that will come when I describe how a page object gets rendered. This is just a list, so you get a fuller sense of what’s in a source folder.

Figure 1: A typical source folder, containing some typical standard directive objects.

As a starting point, we’ll use Figure 1. Not all possible built-in directive objects are illustrated in Figure 1, but it gives you a sense of what a source folder might look like.

Next: Scalar Directives

This documentation prepared by Matt Neuburg, phd = matt at tidbits dot com (, using RubyFrontier.
Download RubyFrontier from GitHub.