Applies to publican_creators 1.2.2

4 Using publican_creators

4.1 Launching publican_creators

For launching publican_creators you have to click on your PublicanCreators from your Program Launcher.

You see a graphical interface (the look and feel depends on your chosen theme):

Now you can choose one of that options:

  • Environment: Work or Private

  • Type: Article or Book

  • Optional: Normal, Report, Homework

  • Title:Your Title. You can use a normal entry with blanks, or you can use underscores instead of blanks (Version: 0.4.2.0). But don't use umlauts like "Ä", "Ö", "Ü" or "ß" because Publican just understands ASCII chars.

    Tip
    Tip

    You can use the publican.cfg to fix this. If your document is named "Sören und die Ägäis" you can type as title "Soren und die Agais". After the documentation creation is finished, you can add to the publican.cfg

    docname: Soren_und_die_Agais

    The chosen name should be the same as your root document. The root document of the example would be named: Soren_und_die_Agais.xml. Then you can change the title in the Article_Info.xml or Book_Info.xml to your needs like “Sören und die Ägäis”. Also, it's possible to use “AE” instead of “'Ä”and so on.

After clicking on Go! the documentation will be created by publican.

4.2 What it does

  1. The PublicanCreatorsGet.title will be launched. This method returns a array which will be splitted into the variables “environment”, “type”, “opt” and “title”. The “environment” reflects the situation private or work. “type” will be article or book. “opt” can be report, homework or just normal.

  2. The PublicanCreatorsPrepare.prepare will be launched. It will find out what target directory to be used. This depends on your configuration file and your given input from the previous method.

  3. Now PublicanCreatorsChange.check_environment checks the environment and runs PublicanCreatorsChange.init_docu_work or PublicanCreatorsChange.init_docu_private for running publican create with all chosen flags.

  4. PublicanCreatorsChange.add_entity will work with your TITLE.ent file. If the environment Work is chosen, and the variable global_entities is filled, it will copy the whole content of the entity file to your new local entity file. The variable global_entities can set in your users configuration file.

  5. Next the method PublicanCreatorsChange.change_holder works with your entity file too. In case of private environment, it will use your name as HOLDER. Otherwise, it uses your companies name.

  6. Sometimes its useful to do not use the given legal notice (In case of small documents or reports). If you are in environment “Work” and has chosen “Article” and has set legal = true in your configuration file it (PublicanCreatorsChange.remove_legal) will remove the legal notice.

  7. Per default, Publican adds some Docbook lines for including a title logo. If you are already defined a Title Logo in your XSL-Stylesheets then you can set title_logo = false”. Then the method PublicanCreatorsChange.remove_orgname removes the predefined title logo from the Article_Info.xml or Book_Info.xml from your project.

  8. Next step is PublicanCreatorsChange.fix_revhist. In all environments it will use the firstname and surname of the user and replaces them with the default entries in Revision_History.xml. In case of using in environment “Work” it will use your work email address for replacing the default. Otherwise, it uses your private address.

  9. Now the method PublicanCreatorsChange.fix_authorgroup does similar the previous method just for the Author_Group.xml file. In addition, it can set the company_name and company_division if chosen.

  10. The last method PublicanCreatorsExport.export_buildscript generates a build script for your project.

Print this page