Compendium Documentation

This document describes settings that can be specified on a per-network basis.

Access Restrictions Ip Address

Specify IP address based access restrictions for the network

Application Appearance

Modify the appearance of the application

Email to Post

Enable/Disable email to post functionality

Email to Post Default Publication Status

Specify the default publication status of posts submitted via email

Notification Policy

Specify the notification policy for a network

Ping List

Specify a list of web services to ping when new content is approved

Remote Key Authentication

Enable or Disable remote key (API) authentication for a network

Start Page URL

Specify a new default start page URL when people go to the blog listing page

AccessRestrictions.IpAddress

Purpose

Specify IP based access restrictions for a network.

Value Syntax

A JSON encoded string containing an access restriction policy.

Acceptable Values

The syntax for the Policy for an IpAddress restriction is as follows:

([!])?(\d{1,3}\.){3}(\/\d{1,2})?

The above regex describes the IpAddress syntax. This specifies a rule type, which is one of deny (!) or allow (default). The rule type is followed by an IP address and an optional netmask. Note that in order to allow from only one IP address, a second rule (!0.0.0.0) is required. Rules are processed in order until one matching the current IP address is found. If no netmask is specified we use a value of 32. The required netmask for 0.0.0.0 is 0 but that will be forced. We ignore any user supplied value for the netmask for the IP 0.0.0.0. Rules must be separated by a semi-colon (;).

Examples

The following example specifies a policy that allows for a single IP address, 10.0.0.2, to access a network:

    "10.0.0.2;!0.0.0.0"

The following example specifies a policy that denies the IP address 10.0.0.2 but allows all others:

    "!10.0.0.2;0.0.0.0"

ApplicationAppearance

Purpose

Specifies the appearance of pages seen when a user is interacting with the application.

Value Syntax

A JSON encoded object storing appearance preference names and values.

Acceptable Values

The following keys names may be used in the object:

title_color
link_color
logo_url
footer_text
headerfooter_background_color
headerfooter_highlight_color
headerfooter_border_color
headerfooter_text_color
headerfooter_link_color
headerfooter_secondary_text_color
color1_background_color
color1_highlight_color
color1_border_color
color1_text_color
color1_link_color
color1_secondary_text_color
color2_background_color
color2_highlight_color
color2_border_color
color2_text_color
color2_link_color
color2_secondary_text_color

Color values should be expressed in a syntax recognized by CSS. Images should be URLs suitable for insertion in a url( ) expression.

Examples

{
    'link_text_color' : '#595959',
    'page_title_color' : '#ececed',
    'logo' : 'http://cdn.content.compendiumblog.com/images/FluidLayout1/logo-web.png',
    'background_color' : '#fff9b2',
    'border_color' : '#4d4e4d'
}

EmailToPost

Purpose

Enables or disables email to post functionality for a network. Email to post allows a user to to submit their post content via email.

Value Syntax

A boolean value either true or false, specified using JSON.

Acceptable Values

Either true or false.

Examples

true

EmailToPost.DefaultPublicationStatus

Purpose

Specifies what the post publication status should be by default for a post created via email to post.

Value Syntax

A JSON encoded string value.

Acceptable Values

A string value being either "new_pending" or "draft". If the value is "new_pending" the post will display in the administrators inbox. If the value is "draft" the post will show up as a draft for the user.

Examples

"new_pending"

NotificationPolicy

Purpose

Specifies when a Network Administrator user is to be notified of pending content.

Value Syntax

A JSON encoded object of the form:

{
    'Type' : string
}

Acceptable Values

The 'Type' value may either 'instant' or 'deferred'.

Examples

{
    "Type": "instant"
}

Note that this setting will always return a value. You can not clear this value.

PingList

Purpose

Specified a list of remote services that the system should ping when a new post is approved. See http://en.wikipedia.org/wiki/Ping_(blogging)

Value Syntax

A JSON encoded object where keys are URLs and values specify the service protocol.

Acceptable Values

The keys can be any valid hostname. Note that an IP address may not be used. To suppress this check, include the parameter Force=true with the setting save operation.

For values, the following 3 values are acceptable:

weblogs-xml-rpc

A service that implements the weblogUpdates.ping XML-RPC method.

weblogs-ext-xml-rpc

A service that implements the weblogUpdates.extendedPing XML-RPC method.

weblogs-reset

A service that implements the weblogs.com REST API.

All of these are documented here: http://www.weblogs.com/api.html
Examples

{
    "http://rpc.weblogs.com/RPC2": "weblogs-ext-xml-rpc",
    "http://blogsearch.google.com/ping/RPC2":"weblogs-ext-xml-rpc"
}

Note that this setting will always return a value. You can not clear this value.

RemoteKeyAuth

Purpose

Specifies whether or not users should be allowed to use API key authentication or not. If this setting is enabled, all users on the network, including any administrators, can use their remote API key for API authentication.

Value Syntax

A boolean value either true or false.

Acceptable Values

Either true or false.

Examples

true

StartPageUrl

Purpose

Specifies the page that visitors will be directed to when they request the root location of the blog's URL.

Value Syntax

A string containing the redirection target URL.

Acceptable Values

Any valid URL. The hostname for the URL is checked for validity via a DNS lookup. To suppress this check, include the parameter Force=true with the setting save operation.

Examples

http://blogging.compendiumblog.com/blog/compendium-blogware