Product SiteDocumentation Site

Chapter 1. Installing Publican

1.1. Linux operating systems
1.1.1. Fedora
1.1.2. Red Hat Enterprise Linux 5
1.1.3. Ubuntu
1.1.4. Debian
1.2. Windows operating systems

1.1. Linux operating systems

Important — Availability in repositories

The procedures documented in this section assume that Publican and its various dependencies are available in repositories to which your system has access.

1.1.1. Fedora

  1. Open a terminal.
  2. Change to the root user: su -
  3. Run the following command to install the publican package and the publican-doc documentation package:
     yum install publican publican-doc
Several brand packages are available for use with Publican. Run the following command as the root user to install packages for building branded books:
 yum install publican-brand
Replace brand with, for example, redhat, fedora, jboss, ovirt, or gimp. Refer to Chapter 4, Branding for more information on branding.

1.1.2. Red Hat Enterprise Linux 5

Important — Unsupported software

Publican is not part of the Red Hat Enterprise Linux distribution. Therefore, Red Hat does not offer support for Publican.

Important — Dependencies available only internally to Red Hat

Installing Publican on Red Hat Enterprise Linux 5 requires a number of dependencies that are presently available only in yum repositories that are internal to Red Hat.
  1. Open a terminal.
  2. Change to the root user: su -
  3. Run the following command to install the publican package and the publican-doc documentation package:
     yum install publican publican-doc
Several brand packages are available for use with Publican. Run the following command as the root user to install packages for building branded books:
 yum install publican-brand
Replace brand with, for example, redhat, fedora, jboss, ovirt, or gimp. Refer to Chapter 4, Branding for more information on branding.

1.1.3. Ubuntu

Important — New in 10.4 "Lucid Lynx"

Publican is new in Ubuntu 10.4 "Lucid Lynx".
  1. Open a terminal.
  2. Run the following command to install the publican package:
    sudo apt-get install publican

1.1.4. Debian

Warning — Complete this procedure

Complete every step of this procedure. If you do not undo the changes that you make to the /etc/apt/sources.list file as described, your system might become unstable.
Publican is not available in the current stable version of Debian (version 5.0, "Lenny"), but is available in the current testing version ("Squeeze"). To install Publican on a computer that runs Debian, temporarily enable access to the squeeze repository. When you enable access to this repository, you allow your computer to install newer software and newer versions of existing software than what is available in the current stable version of Debian. However, not all of the software available in the testing repository has completed quality assurance testing yet. If you do not disable access to this repository after you install Publican, the next time that your system updates, it will replace software packages on your system with newer but possibly untested versions of those packages that it downloads from the testing repository.
  1. Open a terminal.
  2. Open your /etc/apt/sources.list file in a text editor. For example, to edit the file in gedit run:
    sudo gedit /etc/apt/sources.list
  3. Add the following line to the end of the file:
    deb http://ftp.debian.org/debian/ squeeze main
    
    
  4. Save the file and close the text editor.
  5. Run the following command to update the list of packages available to your computer:
    sudo apt-get update
  6. Run the following command to install the publican package:
    sudo apt-get install publican
  7. Open your /etc/apt/sources.list file again, and delete the extra line that you added in this procedure.
Note that until the release of "Squeeze" as the stable version of Debian, you must manually enable and disable access to the testing repository as described in this procedure whenever a new version of Publican becomes available in the testing repository. You can find up-to-date information about the status of Publican for Debian at http://packages.debian.org/squeeze/publican, including the version number of Publican available in the repository (1.0 at the time of writing).
When "Squeeze" becomes the stable version of Debian, you will not need to enable or disable access to extra repositories to install Publican on systems that run that version of the operating system.

1.2. Windows operating systems

  1. Download the Publican installer from https://fedorahosted.org/releases/p/u/publican/.
  2. Browse to the folder to which you downloaded Publican-Installer-version.exe.
  3. Double-click the Publican-Installer-version.exe file.
  4. The installer presents you with a series of license agreements. All of the files that constitute a Publican installation are available under a free license. However, because different licenses are more suitable for certain parts of Publican than others, the Publican files are not all available under the same free license. Each license grants you a different set of rights and responsibilities when you copy or modify the files in your Publican installation. We chose this combination of licenses to allow you to use Publican as freely as possible and to allow you to choose whatever license you prefer for the documents that you publish with Publican.
    Read the terms of the various license agreements. If you agree to their terms, click I Agree on each of them, otherwise, click Cancel.
  5. The installer offers to install several components: Publican itself (labeled Main in the installer window), a number of brands (including RedHat, JBoss, and fedora), and two DocBook components (the DocBook Data Type Definition (DTD) and DocBook Extensible Stylesheet Language (XSL) stylesheets). The three brands are grouped under the collapsible heading Brands and the DocBook components are grouped under the collapsible heading DocBook in the installer window. Refer to Chapter 4, Branding for an explanation of brands in Publican. Publican uses the DTD and the XSL stylesheets to render XML documents in other presentation formats (such as HTML and PDF). If you do not install these components, Publican must download this data from the Internet every time it processes a document, which creates lengthy delays.
    All components are selected by default. Click the checkboxes to deselect any components that you do not require and click Next to continue.
  6. By default, the installer software creates a folder named Publican within the %ProgramFiles% folder of your computer — typically C:\Program Files\Publican. You can manually edit the path displayed in the Destination Folder box to select a different folder.
  7. When you are satisfied with the destination folder, click Install.
    The installer displays a progress bar as it installs Publican. To see more detailed information about the progress of the installation, click Show details.
  8. When the process finishes, the installer notifies you with the message Completed.
    Click Close to close the installer.