Documentation

How RingMaster stores and works with a website project

In RingMaster a website is a collection of objects.

The most common and familiar type of object is an HTML page.

Sometimes objects are also refered to as items.

other types of objects include:

For each object in a website project, RM keeps track of the content and a set of properties.

The content is usually a source file (ie an HTML file, or JPEG file on disk), or it may be data in Frontier's object database.

The properties stored in the RM framework are used when the source files are compiled into a finished website.

some example properties include

The properties available for each object depend on the type of object, and the level of access you have to that object.

Properties are inherited

A website project is hierarchical like a file system. This hierarchy represents the structure of files that the rendered website will take. But this hierarchy also represents an inheritence hierarchy for objects in the framework.

Lets take the example of a HTML specific property, the background color of the page.

if you wan't all the pages in your site to be white, you could set the background color property of each HTML object in the project, or you could set the background color property for the top level folder. Even though a folder rendered to the website does not have a BODY tag with a BGCOLOR attribute, any HTML object contained within that folder in the RM website project will inherit that HTML property.
Individual objects or subfolders can always override an inherited property, if a value is assigned directly.

There is also a facility for burning in properties, when you want to force all contained objects to to inherit a particular folder's property value. This behavior is true not only for properties that affect the way objects are rendered into website files but also for properties used by the project management features of RM such as the owner of a particular folder.

Resources

Resources are tools or information that are shared among objects in a website. They include such things as templates and macros. Objects use resources by refering to them in their content (in the case of macros) or through a property (ie templates).

For example, say you have three templates defined in a site:

Products Company News

If defined for the site, these resources are available to every page in the site. Which template a given page uses depends on the template property of that object.

Other resources such as macros are used directly in the content of the page. If you have a macro named "insertPageURL" that inserts the current page's URL, you embed that resource directly in the page content as {insertPageURL}.

Table of Contents -- Prev -- Next