3B2 Scripting

Introduction

One of 3B2's most flexible and powerful features is its scripting ability. It can be used to create scripts to handle specific applications or perform specific tasks. As well as its own internal scripts, 3B2 also includes full support for Perl scripts and Perl mini scripts.

Fully customisable through scripting, 3B2 enables the creation of powerful blackbox publishing applications for printing or electronic distribution.

Scripts can be programmed onto function keys, started with a macro, or even started automatically when a document is opened or closed. For more information about automation in 3B2 see the Automation topic.

Advent also offer advanced scripting and publishing solutions using 3B2. For more information on custom solutions and consultancy see the Solutions topic.

What is 3B2 Scripting?

3B2 is controlled by its macros. They can be used as fast access codes to any of 3B2's functions. Executing a sequence of macros leads on, logically, to including these macros in a script or macro file which can be run with a single command. A script is made up of a sequence of macros. Creating a script is easy, making full use of 3B2's normal editing features.

The full power of 3B2 scripts is limited only by the imagination of the user, for this reason, we recommend that anything more than simple projects should be undertaken by a competent programmer.

However, there is no such limitation on the use of pre-written scripts. As mentioned previously, they can easily be started, and can be made to look like extensions to 3B2, for example, adding to or changing existing menus.

When writing a script you will need to know the macros to use. Every action in 3B2 will have a macro to match it, so provided that you know how to manually do something, then automation is possible. As you become familiar with 3B2's scripting language you will build up a library of useful routines which can be re-used in other projects.

Types of Scripts

Below is a list and description of the different types of script available within 3B2:

Autoexec (start-up scripts) - The name of this script can only be autoexec, as this is a special type of script, that 3B2 looks for and will automatically execute when a document is opened. There is also an option which enables you to turn this off. An example of an autoexec script is when a document is opened for the first time, a dialogue box will appear. This will then allow the user to define options such as which text stream to load, as well as any other options that a file may need, before pagination can begin.
Autoexit (exit scripts) - In the same way that an autoexec is launched when a file is opened, the autoexit script will be run when a file is closed. This allows various actions to take place before a file is truly closed. For example, one such action could be to preserve the values of any variables within the file.
Normal scripts - This would probably be the most common type of script that you will use. These user scripts are sometimes launched in the first place by the autoexec. Scripts can be nested up to 1,000 levels deep.
Mini scripts - These are generally small scripts to conditionally process inline information or values, used within showstrings and tags. They are not usually run directly by the user, but are instead called each time the tag is formatted in the page or used as part of an expression. For further information see the Showstrings topic.
String files - It is possible to create an external string file script. This means that the 3B2 document does not have to contain the script; instead the script is stored in the 3B2 system directory and can be run from any document.
Perl scripts and Perl mini scripts - These are executed in the same way as regular internal 3B2 scripts, except they are able to make full use of Perl's functionality & libraries. For more information see the Perl topic.

Overall Benefits

3B2's macros provide a programming language which can be used to create very sophisticated and flexible publishing solutions, particularly for large scale, high volume projects.

To the novice user, the macros are invisible, but in 3B2 every menu selection, keystroke, and even mouse movement generates internal macros. The more experienced user can issue these macros, plus many others, directly to 3B2's macro processor, significantly improving productivity and functionality. This in turn provides savings in time and cost.

References and Further Information

Technical information on scripts is available to users in the technical documentation available from documentation.3b2.com