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:
To install the brand:
If the brand was supplied to you in an archive of some kind, for example, a tarball or ZIP file, unpack the brand into a new directory on your system.
Change into the directory in which you created or unpacked the brand:
$
cd publican-brand
where brand is the name of the brand.
Build the brand:
$
publican build --formats xml --langs all --publish
Install the brand:
$
sudo publican install_brand --path path
where path is the path to the Publican Common Content files. For example, on a Linux system, run:
$
sudo publican install_brand --path /usr/share/publican/Common_Content
or on a Windows system, run
$
publican install_brand --path "C:/Program Files/Publican/Common_Content"
Table 5.1. Current Brands and their packages
Brand | License of Common Content files | Default license for documents | Package | Comment |
---|
common | CC0 1.0 | GFDL Version 1.2 | publican | GPL compatible license. No options. |
RedHat | CC-BY-SA 3.0 | CC-BY-SA 3.0 | publican-redhat | |
Fedora | CC-BY-SA 3.0 | CC-BY-SA 3.0 | publican-fedora | |
JBoss | CC-BY-SA 3.0 | CC-BY-SA 3.0 | publican-jboss | No Options. |
oVirt | OPL 1.0 | OPL 1.0 | publican-ovirt | No Options. |
GIMP | GFDL Version 1.2 | GFDL Version 1.2 | publican-gimp | Matches the license for existing GIMP documentation. |
Genome | OPL 1.0 | OPL 1.0 | publican-genome | No Options. |
Note the difference in licensing between the common content files provided in the common brand (CC0) and the default license set for books generated with the common brand (GFDL). The CC0 license allows you to redistribute and relicense the files that make up the common brand (including the CSS and image files) to suit your project. Publican suggests the GFDL for documentation by default because Publican is developed primarily to build documentation for software. The GFDL is compatible with the GPL, which is the most commonly used license for open-source software.