From Fedora Project Wiki

DocsProject Header docTeam1.png

Getting the .desktop files, the .spec file, and the main index file right is a tedious business, and dependent on the particular collection of languages being processed. doc-publican-rpm automates this process.

The basic process is as follows:

  1. d-p-r first reads and remembers the config file. It uses the last part of the directory name as the name of the package. The name and email are only used if the user did not provide a .spec.old file.
  2. d-p-r then recurses through publican's tmp directory and makes a list of languages.
  3. For each language, it reads the Article_Info.xml file which contains information helpful to building the .desktop file
  4. It then makes a scratch directory (which will eventually be deleted) which will populate the tar file
  5. The html files and all child directories are copied from Publican's tmp/ directories into the scratch directory. It recurses through these directories so that a guide with many image subdirectories is still handled properly.
  6. Next, it makes three .desktop files; one for GNOME, one for KDE and one for XFCE and LXDE. (in doc-publican-rpm version 2.x and earlier, there are only two; XFCE and LXDE share GNOME's .desktop file).
  7. An index.html file is constructed which tests the user's selected language and uses it to launch the appropriate html. The .desktop file points to this file. If the user has Javascript enabled, this file is never seen, but if Javascript is disabled, the user is presented with a menu of languages.
  8. Icons are copied from /usr/share/doc-publican-rpm into the scratch directory
  9. The source tar is now made from the scratch directory and the scratch directory deleted
  10. A new .spec file is created using the description and changelog from the .spec.old if it exists. If not, a dummy description and changelog is provided. The rest of the spec file is created new for the current set of languages.
  11. rpmbuild is run to generate the RPM