Tutorials

The pages in the tutorials section show step-by-step instructions on how to get Imprint up and running. They cover virtually every aspect of the program from the point of view of various types of users. For a quick reference, consult the Reference documents.

For the basic user, there is the Getting Started page. It is the recommended next step for all first-time users. Once you have mastered that, Basic Tutorial will show you a more complete picture.

For the more advanced customization techniques, start with Additional Topics, Part 1, Additional Topics, Part 2, and Styles and Formatting. More advanced subjects, with coding involved, are explored in the Writing Plugins and Writing Custom Tags tutorials.

Developers can probably jump right into the Reference section with the Plugin API and the Tag API.

If you are unsure where to go next, the Main Page is always a good place to start browsing through all of the available topics.

Contents:

• Getting Started
  • Creating a New Project
  • Running Imprint
• Basic Tutorial
  • Project Setup
  • Using Plugins
  • Adding Custom Styles
  • Customizing the XML Template
  • Using Keywords
• Additional Topics, Part 1
  • Project
  • Overriding Keywords
  • Making Lists
  • Adding References
• Additional Topics, Part 2
  • Project
  • Image Logging
  • Inserting Sections
  • Line and Page Breaks
  • Modifying Headers and Footers
• Styles and Formatting
  • Defining Styles
  • Applying Styles
  • Defaults
• Writing Plugins
  • Figures
  • Tables
  • Strings
  • Error Handling
  • Using Your Plugin
  • Registering Your Plugin
  • Referencing Your Plugin
• Writing Custom Tags
  • Writing a TagDescriptor
  • Registering the Descriptor
  • Putting it all Together
  • Making Your Tag Built-In

Demos

The tutorials in this documentation rely on a number of small demo projects to illustrate the features of Imprint. The projects are available for download as zip files so that the reader can follow along in the tutorial and experiment on their own. The following is a list of the available demo projects:

• HelloWorld for Getting Started
• CandleFlame for Basic Tutorial
• Games for Additional Topics, Part 1
• Invoice for Additional Topics, Part 2
• Snippets for Styles and Formatting
• … for Writing Plugins
• … for Writing Custom Tags
• PathologicalCases for testing purposes