Documentation

This section details concepts such as installation, user management, site structure, theming, apps, and contributions for the OpenPublic distribution.

Upgrading from the Beta to 1.0

 

In finishing and releasing the 1.0 there were some change that were used that effected the base structure of fields that were part of the beta.  The following instructions go through those changes and things that one should look at updating if they have sites built on the beta, as they upgrade to the 1.0.

Remember to make backups of your database and files.

  • Renamed/removed/merged features. Many features were moved to different features, which means they will not be enabled by default. An update operation to enable some of them has been added, but it is not thorough (set…

more…

Upgrading OpenPublic

 

Now that we have a 1.0 release, upgrading openpublic should be as simple as

  • Updating the code base
  • running the database updates (we use the drush updb command)

Please not that any upgrade, can introduce unseen issue, especially if you have extend OpenPublic with custom code.

We recommend that you never do your first upgrade in your production environment, and always have db backups.

How to Keep Your Content Accessible

 

Any site built off of OpenPublic will meet front-end 508 and accessibility standards out-of-the-box. However, there are a few guidelines to follow when entering content onto your site:

  1. h1 through h6 headings help provide a hierarchy for the page. h1 is always included by default as the page title. Therefore, all headings should follow a hierarchy of importance starting with the h2 tag.
  2. MP3s must include text transcripts. You can either provide an HTML page containing the transcript or you can link to a separate text file.
  3. Videos and podcasts with videos must…
more…

What Makes A Theme OpenPublic Compatible?

 

OpenPublic is a Drupal Distribution

Drupal Distributions or Installation Profiles are pre-packaged versions of Drupal that contain Drupal core, which you can download from drupal.org along with a slew of contributed modules. The Drupal core and modules are usually pre-configured in a certain way to better serve some specific purpose, such as for news publishing purposes in the case of OpenPublish.

Are all Drupal Themes OpenPublic Compatible?

OpenPublic-compatible is any Drupal theme that can be used with OpenPublic and can support the full functional spectrum of the…

more…

Creating a Sub-theme Using OpenPublic's Original Base Theme

 

Theme Configuration

We are going to create our first [OpenPublic|OpenPublic] sub-theme called "Ardi". In case you are wondering: Ardi is the name of the [first human ancestor|http://news.nationalgeographic.com/news/2009/10/091001-oldest-human-skel... ever uncovered by archeologists, so it sounded like an appropriate name for the first theme you will create in [OpenPublic|OpenPublic].

Let's get started by creating a folder called "…

more…

The Approach

In the previous chapter we touched upon the layout and structure of the base OpenPublic theme. To fully leverage the base theme for bootstrapping new theme development, custom themes should be created as a sub-theme of the theme called openpublic_theme, included in the OpenPublic distribution. Sub-themes automatically inherit everything from the base theme and then specific aspects can be overridden/further customized.

Some common examples:

Suppressing and Overriding CSS Files

Not all CSS files in the base theme are equally portable to the…

more…

Structure of OpenPublic's Original Base Theme

 

Now that we have mentioned, in passing, where some of the theme files are located, it is useful to explain the structure of the openpublic_theme folder in general. You will never be modifying any files in this base theme, directly (since you should always sub-theme it instead) but your sub-theme will most probably have similar structure and you may often find yourself looking in openpublic_theme for reference, so let's see how it is built. On the highest level, following is the structure of the folders in the theme: 

Accordingly, following is the structure of the files…

more…

Theming with OpenPublic's Original Base Theme

 

OpenPublic originally shipped with the base theme openpublic_theme.  Although the OpenOmega theme and Spartan theme are the new base themes for OpenPublic Beta 4, the previous theme is still available for those that created a sub-theme from it.  The documentation is still available for those who would like to sub-theme off of the openpublic_theme.

Creating a Sub-theme from Omega

 

We are going to create our first OpenPublic sub-theme called "Ardi". In case you are wondering: Ardi is the name of the first human ancestor ever uncovered by archeologists, so it sounds like an appropriate name for the first theme you will create in OpenPublic.

There are three ways to create a sub-theme from Omega:

more…

Structure of the Spartan Base Theme

 

We recommend that you use Spartan to sub-theme, since Spartan includes some default styles for our custom functionality that make it faster to subtheme. Because of this recommendation, it is useful to explain the structure of the spartan folder. You will never be modifying any files in this base theme directly since you should always create a sub-theme instead but your sub-theme will most probably have similar structure.  You may often find yourself looking in the spartan folder for reference. The following screenshot illustrates the structure of the files folders in the theme.

more…

Content Visibility

Public

Documentation

Loading widget...
No files to show
{{node.name}}
({{node.children.length}})
{{node.date}}
{{node.modified}}
{{node.filesize}}
{{node.filename}}