Applies to publican_creators 1.2.2

1 Round about

publican_creators is a graphical tool for creating new DocBook projects. It is mainly directed at DocBook users, who are confronted daily with new DocBook projects. Publican has proven to be a popular tool to create and manage projects. For example, large Linux distributions such as Redhat, Fedora and Debian are already using publican for their documentation.

I created publican_creators as a tool from DocBook authors for DocBook authors. publican_creators now offers the possibility to start new projects, add new revisions and build the project.

1.1 Documentation Conventions

The following notices and typographical conventions are used in this documentation:

  • /etc/passwd: directory names and file names

  • PLACEHOLDER: replace PLACEHOLDER with the actual value

  • PATH: the environment variable PATH

  • ls, --help: commands, options, and parameters

  • user: users or groups

  • package name : name of a package

  • Alt, AltF1: a key to press or a key combination; keys are shown in uppercase as on a keyboard

  • File, File › Save As: menu items, buttons

  • Dancing Penguins (Chapter Penguins, ↑Another Manual): This is a reference to a chapter in another manual.

  • Commands that must be run with root privileges. Often you can also prefix these commands with the sudo command to run them as non-privileged user.

    root # command
    tux > sudo command
  • Commands that can be run by non-privileged users.

    tux > command
  • Notices

    Warning
    Warning: Warning Notice

    Vital information you must be aware of before proceeding. Warns you about security issues, potential loss of data, damage to hardware, or physical hazards.

    Important
    Important: Important Notice

    Important information you should be aware of before proceeding.

    Note
    Note: Note Notice

    Additional information, for example about differences in software versions.

    Tip
    Tip: Tip Notice

    Helpful information, like a guideline or a piece of practical advice.

1.2 Feedback

Several feedback channels are available:

Bug Reports & Feature Requests

You are welcome to file a Bug Report or a Feature Request.

File a bug or a Feature request: https://github.com/saigkill/publican_creators/issues (https://github.com/saigkill/publican_creators/issues).

Mailing list

It is also possible to subscribe to projects mailing list on: https://groups.google.com/forum/#!forum/publican_creators (https://groups.google.com/forum/#!forum/publican_creators)

Mail

For feedback on the documentation or this product, you can also send a mail to Sascha.Manns@outlook.de (mailto:Sascha.Manns@outlook.de). Make sure to include the document title, the product version and the publication date of the documentation. To report errors or suggest enhancements, provide a concise description of the problem and refer to the respective section number and page (or URL).

1.3 About the Making of This Documentation

This documentation is written in DocBook 5 (http://www.docbook.org). The XML source files were validated by jing (see https://code.google.com/p/jing-trang/), processed by xsltproc, and converted into XSL-FO using a customized version of Norman Walsh's stylesheets. The final PDF is formatted through FOP from Apache Software Foundation (https://xmlgraphics.apache.org/fop). The open source tools and the environment used to build this documentation are provided by the DocBook Authoring and Publishing Suite (DAPS). The project's home page can be found at https://github.com/openSUSE/daps (https://github.com/openSUSE/daps).

You can find the docbook sources of this documentation on https://github.com/saigkill/publican_creator/tree/master/docs (https://github.com/saigkill/publican_creator/tree/master/docs).

1.4 Source Code

The source code of publican_creators is publicly available on https://github.com/saigkill/publican_creator (https://github.com/saigkill/publican_creator) for download links and more information.

Print this page