Difference between revisions of "Documentation/Administration Guide/Using Custom Macros and Libraries"

To Make a Custom Apache OpenOffice Basic Library Available to All Users on a Network

Use Apache OpenOffice to create a custom library as well as the macros in the library.

1. As root, copy the custom library from the user installation where you created the library to the Apache OpenOffice server installation.
   cp -r <Apache OpenOffice user installation directory>/user/basic/custom library <Apache OpenOffice installation directory>/share/basic/ Template:Documentation/Note
2. In a text editor, open the script.xlc configuration file for the user installation and add a link to the script.xlb configuration file for the library.
   Use the following syntax for the link:

   <library:library library:name="Library Name"
   xlink:href="$(USER)/basic/Library Name/script.xlb/"
   xlink:type="simple" library:link="true" library:readonly="false"/>
   

   • On Solaris and Linux, open the <Apache OpenOffice user installation directory>/user/basic/script.xlc configuration file.
   • On Windows, open the C:\Documents and Settings\user id\Application Data\Apache OpenOffice 2\user\basic\script.xlc configuration file
3. In a text editor, open the dialog.xlc configuration file for the user installation and add a link to the script.xlb configuration file for the library.
   Use the following syntax for the link:

   <library:library library:name="Library Name"
   xlink:href="$(USER)/basic/Library Name/dialog.xlb/"
   xlink:type="simple" library:link="false"/
   

   • On Solaris and Linux, open the <Apache OpenOffice user installation directory>/user/basic/dialog.xlc configuration file.
   • On Windows, open the C:\Documents and Settings\user id\Application Data\Apache OpenOffice 2\user\basic\dialog.xlc configuration file.
4. Restart Apache OpenOffice on the workstations.

To Make a Custom Apache OpenOffice Basic Library Available to a Single User

1. Copy the custom library from the user installation where you created the library to the user installation where you want to deploy the library.
   • On Solaris and Linux, become root, and copy the library.
     cp -r <Apache OpenOffice user installation directory>/user/basic/custom library <Apache OpenOffice user installation directory>/user/basic/
   • On Windows, become a user with administrator privileges, and copy the library.
     
   The file name path for the library is C:\Documents and Settings\user id\Application Data\Apache OpenOffice 2\user\basic\custom library
2. In a text editor, open the script.xlc configuration file for the user installation and add a link to the script.xlb configuration file for the library.
   Use the following syntax for the link: <div class="code" <library:library library:name="Library Name" xlink:href="$(USER)/basic/Library Name/script.xlb/" xlink:type="simple" library:link="true" library:readonly="false"/> </div>
   
   • On Solaris and Linux, open the <Apache OpenOffice user installation directory>/user/basic/script.xlc configuration file.
   • On Windows, open the C:\Documents and Settings\user id\Application Data\Apache OpenOffice 2\user\basic\script.xlc configuration file.
3. In a text editor, open the dialog.xlc configuration file for the user installation and add a link to the script.xlb configuration file for the library.
   Use the following syntax for the link:

   <library:library library:name="Library Name"
   xlink:href="$(USER)/basic/Library Name/dialog.xlb/"
   xlink:type="simple" library:link="false"/
   

   
   

   • On Solaris and Linux, open the <Apache OpenOffice user installation directory>/user/basic/dialog.xlc configuration file.
   • On Windows, open the C:\Documents and Settings\user id\Application Data\Apache OpenOffice 2\user\basic\dialog.xlc configuration file.
4. Restart Apache OpenOffice.

</ol>

To Install a Custom Apache OpenOffice Basic Library With a Macro

You can create a macros that installs a Apache OpenOffice Basic library from a Apache OpenOffice document.

1. In Writer, create a custom Apache OpenOffice Basic library in a new document.
2. Save the document.
3. Create an installation macro.
1. Choose Tools → Macros → Organize Macros → Apache OpenOffice Basic The Apache OpenOffice Basic Macros dialog box opens.
2. In the Macro from list, select your Writer document.
3. In the Macro name box, enter a name from the installation macro.
4. Click the New button The BASIC IDE window opens.
5. Enter the following code:

Sub AddBasicLibrary
 Dim SourceLibraryName As String, DestLibraryName As String
 Dim oSrcLib As Object, oDestLib As Object, iCounter As Integer
 Dim oLib As Object, oGlobalLib As Object
 
 ' set these 2 variables to your lib name
 SrcLibraryName = "TextLib" 
 ' The name of the library that contains the modules
 DestLibraryName = "NewLib" 
 ' This library will be created and is the 
 ' destination for the modules from the source document.
 
 oLib = BasicLibraries        ' For Basic libaries
 oGlobalLib = GlobalScope.BasicLibraries
 For iLib = 1 To 2 
   If oGlobalLib.hasByName( DestLibraryName ) = False Then
     oGlobalLib.createLibrary( DestLibraryName )
   End If
   If oLib.hasByName( SrcLibraryName ) Then
     oLib.loadLibrary( SrcLibraryName )
     oSrcLib = oLib.getByName( SrcLibraryName )
     sSrcModules = oSrcLib.getElementNames()
     iCounter = lBound( sSrcModules() )
 
     while( iCounter <= uBound( sSrcModules() ) )
       oDestLib = oGlobalLib.getByName(DestLibraryName)
       If oDestLib.hasByName( sSrcModules(iCounter) ) = False Then
         oDestLib.insertByName( sSrcModules(iCounter),_
         oSrcLib.getByName( sSrcModules(iCounter) ) )
       End If
       iCounter = iCounter + 1
     wend
   End If
 
   oLib = DialogLibraries   ' The same for the Dialog libraries
   oGlobalLib = GlobalScope.DialogLibraries
 Next iLib
End Sub

6. Replace the SrcLibraryName and DestLibraryName variables with the name of your library.
7. Close the BASIC IDE window.
4. Add a push button to the document.
1. On the Tools toolbar, open the Controls toolbar, and click the Push Button icon.
2. In your document, drag to draw the button.
5. Assign the installation macro to a button event.
1. Right-click the button, and choose Control.
2. Click the Events tab.
3. Click the ... next to a button event, for example, the Mouse button pressed event.
4. In the Assign Macro dialog box, click the Assign button. The Macro Selector dialog box opens.
5. In the Library list, select the library that contains the installation macro.
6. In the Macro name list, select the installation macro.
7. Click the OK button.
8. In the Assign Macro dialog box, click the OK button.
6. Save the document.