System Overview

Created: Sep 24, 2020 | Updated: May 30, 2021

The Baltic Content Framework is extremely flexible in how you can arrange your content. Broadly speaking, it uses the following components:

Domains

A domain is the top level entity for generating content. Most components (folders, articles, assets, etc.) are associated with a single domain. Certain domain properties that you configure affect the associated web site as a whole. Other properties (such as the main content template) affect all content pages unless you override the property in a folder or an article. Baltic Content Framework supports multiple domains.

Folders

Folders are containers which hold articles. Folders define the site structure and its url scheme. For instance if you have a folder hierarchy defined as:

/Documentation/Api/Version3

the default url path to the articles is:

https://example.com/documentation/api/version3

You can change the url mapping of folders and articles to suit your needs. For instance, with the same folder hierarchy, you can define the url mapping to be:

https://example.com/docs/api/v3

Articles

Articles reside inside of named folders (except articles defined at the root). The full url mapping is determined by the article and the folder structure it resides within. For instance, if the full path to the article inside the folder structure is:

/Documentation/Api/Version3/Mail Queue Operations

the default url path to the article is:

https://example.com/documentation/api/version3/mail-queue-operations

Again, you can change all portions of the url mapping to suit your needs. For instance:

https://example.com/docs/api/v3/mail-queue

Assets

Assets are pieces of content such as images, mp3 files, videos, and urls. You define assets separate from their use. An asset is not used until you associate it with an article.

Sections

Sections are blocks of text and html. As with assets, you define sections separate from their use. A section is not used until you associate it with an article.

Plugins

Plugins are pieces of code that execute to produce content. A plugin can produce a single line of content, or many pages. A plugin is used when you need various types of processing to produce the desired results. A plugin receives contextual parameters when it runs and can therefore produce dynamic content depending on the article from which it's used and other configurable factors. For instance, the author attribution at the end of this article is generated by a plugin. As with assets and sections, a plugin is not used until you associate it with an article.

Content

Assets, sections, and plugins are collectively referred to as content. You assign one or more pieces of content to an article and order them as you need. You can remove content from an article, or simply disable it (leaving in its place within the article, but no longer rendered.) You can assign the same content to multiple articles, each instance with its own content parameters (assets and plugins only; sections don't have parms.)

Victor Sandiego is the man behind Baltic Content Framework. He's an ex-pat who loves writing, dogs, and most of the internet.

Comments