3.6. Publication Creator

This chapter contains information about Publication Creator, which has been added as a part of Editor's Application.

3.6.1. Publication Creator's functions

Publication Creator generates WWW pages in HTML format basis on the files provided by the user. WWW pages contain references to these file or/and the content of these files (e.g. pictures). Publication Creator is useful when user wants to create a compact document containing files they have (for example picture gallery) in a simple, quick way. Creator fills document templates with files (in case of pictures it prepares also miniatures) and saves as a final publication on a local user's disk. After publication is generated dLibra system asks if the user wants to add this publication to the library. If yes, new publication wizard is started. In the first step user selects destination (either directory or group publication). The remaining steps are the same as for new publication wizard.

Before the publication is generated, all files must be properly prepared. They all must be placed in the same directory on a local user disk. Furthermore the files must have the precise format of name. Base segment of a name must be the same in all files, they must be differentiated only by the ordinal number placed just before the file extension (for example: test01.jpg, test02.jpg, test03.jpg etc.).

3.6.2. Using Publication Creator

Publication Creator is composed of three tabs: Data, Information about publication and Templates. If Generate pages button is pressed application generates publication files in the directory chosen by the user. Cancel button closes the window. "Data" tab

Figure 3.43. Publication Creator - Information about files tab

Publication Creator - Information about files tab

On the Data tab user may choose files to use when generating publication files. Choose file button allows user to select one of the files which will be used in generation process. When the file is selected fields in a File panel are filled with values:

  • Filename - base segment of files name,

  • File type - files' format,

  • Begin index - the number of the first file that will be used to generate a publication,

  • End index - the number of the last file that will be used to generate a publication.

These values may be edited by the user. Particularly changing the index values may be useful if publication is not meant to contain all images placed in a chosen directory.

Publication will be generated to directory where the selected files are located (this directory is pointed by Publication source directory field). Next, the application will ask the user if he/she wants to submit the publication to the system. If the answer is positive then appropriate wizard will be started. In the first step it is necessary to select the element where new publication will be placed, next steps are the same as in new publication wizard. "Information about publication" tab

Figure 3.44. Publication Creator - Information about publication tab

Publication Creator - Information about publication tab

Additional information concerning the publication may be provided on the Information about publication tab. The information will be placed in the HTML files and include:

  • Author - Information about publication's author

  • Title - A title of the publication

  • Additional information - Additional information about the publication (user may use here HTML tags). "Templates" tab

Figure 3.45. Publication Creator - Information about templates tab

Publication Creator - Information about templates tab

To use default configuration, simply check Use default templates.

The Templates tab allows user to select templates which are to be used to generate a publication. To choose templates, press Choose directory button and choose directory with templates. Index template file should have an index.vm name, and page template file should have a page.vm name. External files list contains all additional files that are used by the templates. If Copy external files is selected then after generation process external files will be copied to target publication directory. The user may also select template character encoding and size of thumbnails which will be generated (thumbnail are only generated when the publication is based on graphics).

Templates should use the Velocity standard to use to following variables:

  • $info.PublicationAuthor - information about publication author,

  • $info.PublicationTitle - publication title,

  • $info.PublicationInfo - additional information about publication,

  • $relPath - relative path to the publication sources,

  • $info.PictureName - file name (base segment),

  • $info.PictureType - file type (file name extension),

  • $pictureNumber - file number,

  • $info.BeginIndex - index of first file,

  • $info.EndIndex - index of last file,

  • $info.PageCount - the number of files in the publication,

  • $pageNumber - actual page number,

  • $info.PageName - name of the page file,

For more information about Velocity format visit Velocity homepage: http://jakarta.apache.org/velocity/user-guide.html.