User's Manual - version: 0.3

3. Configuring and building

Locate the file config/config.mak-example in KeyValue's home directory. Make a copy named config.mak and edit it with a text editor. This file contains detailed explanations on how to set up KeyValue.

We emphasize one particular instruction presented in the file. If you are not yet familiar with KeyValue, then leave the variables FELIBS_debug and FELIBS_release as they are. This allows for the building of the add-in needed to follow the tutorial given in Section 4.

In a bash shell console, go to KeyValue's home directory. For instance, in GNU/Linux, assuming KeyValue was unpacked in /home/cassio/keyvalue-0.3, type

$ cd /home/cassio/keyvalue-0.3

Under Cygwin (i.e. Windows) one has to prefix the directory name by the drive letter. Supposing that KeyValue was unpacked in C:\Users\cassio\Documents\keyvalue-0.3, type

$ cd C:/Users/cassio/Documents/keyvalue-0.3

To build the debug version (the default):

$ make

To build the release version:

$ make release

Additionally, make accepts other targets. To get a list of them:

$ make help

This also shows the list of projects to be compiled (as set by config.mak).

3.1. Using Microsoft Visual Studio 2008 IDE

Microsoft Visual Studio 2008 users will find target sln very helpful. The command

$ make sln

creates a Microsoft Visual Studio 2008 solution (keyvalue.sln) and project files which allows for using Microsoft Visual Studio IDE, liberating users from direct calling make on Cygwin. Two configurations, debug and release, are set in keyvalue.sln.

Open keyvalue.sln. On the solution explorer (Ctrl+Alt+L), we see the projects. Initially, the start up project will be the first on alphabetic order. Change it to either excel-addin or openoffice-addin: Right click on the project name and then on Set as StartUp Project.

To configure excel-addin and openoffice-addin projects to call the appropriate applications under the debugger follow these steps:

  • Right click on excel-addin project, select Properties and then Debugging. Edit the fields following the example shown in Table 1.

    Table 1. Configuring MSVC debugger for excel-addin.
    Field Content
    Command Full path of EXCEL.EXE (e.g. C:\Program Files\Microsoft Office\Office12\EXCEL.EXE)
    Command Arguments out\windows-msvc-debug\keyvalue.xll
  • Right click on openoffice-addin project, select Properties and then Debugging. Edit the fields following the example shown in Table 2.

    Table 2. Configuring MSVC debugger for openoffice-addin.
    Field Content
    Command Full path of soffice.bin (e.g. C:\Program Files\LibreOffice 3.4\program\soffice.bin)
    Command Arguments -nologo -calc
    Environment PATH=C:\Program Files\LibreOffice 3.4\program;C:\Program Files\LibreOffice 3.4\URE\bin;C:\Program Files\LibreOffice 3.4\Basis\program
Valid HTML 4.01 TransitionalValid CSS!