Product SiteDocumentation Site

Chapter 4. Branding

4.1. Installing a brand
4.2. Creating a brand
4.3. Files in the brand directory
4.3.1. The publican.cfg file
4.3.2. The defaults.cfg file and overrides.cfg file
4.3.3. publican-brand.spec file
4.3.4. README
4.3.5. COPYING
4.3.6. Common Content for the brand
4.3.7. The css subdirectory
4.3.8. The images subdirectory
4.4. Packaging a brand
Brands are collections of files that Publican uses to apply a consistent look and style to HTML and PDF output. They provide boilerplate text that appears at the beginning of documents, images such as logos, and stylistic elements such as color schemes. Publican ships with one brand, common/. Documentation projects can produce and distribute brands to their contributors, either as a package (for example, an RPM package) or as an archive (for example, a tarball or ZIP file).

4.1. Installing a brand

Publican brands for Fedora, Genome, and oVirt documents are available as RPM packages in Fedora. Similarly, Red Hat internally distributes RPM packages containing Publican brands for GIMP, JBoss, and Red Hat documents. Providing that you have access to the relevant repositories, you can install these brands on a computer that runs Red Hat Enterprise Linux or Fedora — or an operating system derived from either — with the command yum install publican-brand or with a graphical package manager such as PackageKit.
If you use Publican on an operating system that does not use RPM packages, your documentation project might provide its brand in another format. Whatever the format in which the brand is supplied, you must place the brand files in a subdirectory of the Publican Common Content directory. By default, this directory is located at /usr/share/publican/Common_Content on Linux operating systems and at %SystemDrive%/%ProgramFiles%/Publican/Common_Content on Windows operating systems — typically, C:/Program Files/Publican/Common_Content
Each currently available brand is distributed under a brand-specific license as follows:
Brand License Package Comment
common GFDL Version 1.2 publican GPL compatible license. No options.
RedHat CC-BY-SA 3.0 publican-redhat
Fedora CC-BY-SA 3.0 publican-fedora
JBoss CC-BY-SA 3.0 publican-jboss No Options.
oVirt OPL 1.0 publican-ovirt No Options.
GIMP GFDL Version 1.2 publican-gimp GPL compatible license. No options.
Genome OPL 1.0 publican-genome No Options.
Table 4.1. Current Brands and their packages