Difference between revisions of "Extensions Packager"
(→Install) |
(→Extension Compiler) |
||
| Line 44: | Line 44: | ||
= Extension Compiler = | = Extension Compiler = | ||
| − | + | There are many kinds of extensions : they may use languages other than Basic, or even set a configuration without any executable code. Usually an extension provides menus and toolbars for one or more applications (Writer, Calc...). | |
| − | + | For a professional look you will have to add copyright statements, create your own help pages, provide automatic update. All displayable texts will probably have to be translated in several languages. This means editing lots of files, testing and editing each time you have found a bug, or added a feature, or added a new language. | |
| − | + | The Extension Compiler can handle all kinds of extensions and reduce your work load. Its documentation guides you through most of the process. | |
| − | + | You don't need to know all the implementation details, you don't need a complex environment. You will edit a Writer document to write the tooltip text, license text, help pages for your extension. | |
| − | + | ||
| − | + | ||
| − | If you made an error, or if you are not satisfied with your extension, change some instructions and run again. | + | You will then write a linear succession of simple Basic instructions to describe your extension. |
| − | For complex extensions, incremental design is easy: start simple, test, add a feature, test it, add another feature, etc. | + | Run this Basic program: the Extension Compiler will create the files description.xml, addon.xml, manifest.xml, xxxWindowState.xml, and the license, tooltip, display name, help pages for different languages. All files will be encoded in UTF-8 to support national characters, stored in sub-folders. After a few seconds your oxt package is ready to be installed! |
| + | |||
| + | If you made an error, or if you are not satisfied with your extension, change some instructions and run again. For complex extensions, incremental design is easy: start simple, test, add a feature, test it, add another feature, etc. | ||
| + | |||
| + | The help pages for your extension may be specific to each application (Calc, Writer, Draw...). They are called by a help button in your dialogs, or by contextual help in the dialogs or menus, or from the index tab of the help window. These help pages will be seamlessly integrated into OpenOffice.org help system. If you have created your help in several languages OpenOffice.org will choose the language which fits the best with the User Interface language. | ||
== Requirements == | == Requirements == | ||
You must have OpenOffice.org 2.2 or above installed. | You must have OpenOffice.org 2.2 or above installed. | ||
| + | |||
The menu merging and toolbar merging features require OpenOffice.org 2.3 or above. | The menu merging and toolbar merging features require OpenOffice.org 2.3 or above. | ||
| + | |||
| + | The extensible help requires OpenOffice.org 2.4 and above. | ||
== Install == | == Install == | ||
| Line 66: | Line 71: | ||
Save it under the name of your extension in a dedicated folder where macro execution is allowed. You will store in this dedicated folder all the libraries, files, images, needed for your extension. You may use sub-folders. | Save it under the name of your extension in a dedicated folder where macro execution is allowed. You will store in this dedicated folder all the libraries, files, images, needed for your extension. You may use sub-folders. | ||
| − | Write in this document the text of the tooltip | + | Write in this document the text of the tooltip, license and help pages of your extension, in as many languages as you like (or can). |
| − | Open the Basic IDE to the Standard library of this document. Open the module Module1 in this library. It contains a prepared | + | Open the Basic IDE to the Standard library of this document. Open the module Module1 in this library. It contains a prepared macro : myExtension. |
Add your instructions where indicated. The instruction set is described in chapter 3 of the document, read it carefully. You will find typical examples in the modules named Template1 etc. | Add your instructions where indicated. The instruction set is described in chapter 3 of the document, read it carefully. You will find typical examples in the modules named Template1 etc. | ||
Run the macro. If you get an error message, correct your script and run again. Otherwise, your extension file is ready. | Run the macro. If you get an error message, correct your script and run again. Otherwise, your extension file is ready. | ||
| − | == | + | == Latest changes == |
| + | |||
| + | Version 1.1 handles the features introduced by OpenOffice.org 2.4 : extension Display name, Publisher name, Release Notes, help pages. | ||
| + | |||
| + | == Related Issues == | ||
| − | There are currently some limitations or bugs in the extension mechanism itself, see Issues 86079, 86437, 86528, 86534, 86535, 86536 | + | There are currently some limitations or bugs in the extension mechanism itself, see Issues 86079, 86437, 86528, 86534, 86535, 86536, 87230, 87330, 87386, 87412 |
== Download == | == Download == | ||
| − | Extension Compiler is currently | + | Extension Compiler is currently [http://marcelly.club.fr/ExtensionCompiler.ott downloadable at this location]. |
== Contacting author == | == Contacting author == | ||
Revision as of 17:45, 28 March 2008
Contents
BasicAddonBuilder
BasicAddonBuilder is an OpenOffice.org extension that allow you to export a StarBasic library in the OpenOffice.org extension format, ready for deployment. BasicAddonBuilder does not require special skills or a deep knowledge of extensions specifications. A wizard-style dialog will guide you through the process, allowing you to define in a graphical way all menu and toolbars that will be added to the OpenOffice.org user interface in order to launch macros from your StarBasic library.
The exported extension (AKA UNO package) will be ready to install in any PC running OpenOffice.org 2.0 or above, using the Package manager. (Menu Tools->Package manager...)
Requirements
In order to use BasicAddonBuilder, you must have OpenOffice.org 2.2 or above installed. BasicAddonBuilder will not work with OpenOffice.org 1.x
Install
BasicAddonBuilder can be installed through the Package manager dialog:
- Menu Tools->Package manager...
Further information in the OpenOffice.org Help
Known issues
- Missing documentation
The following features are not yet supported:
- Dependances management of the generated extension
- Import/export of BasicAddonBuilder projects
Homepage
Current versions of BasicAddonBuilder for OpenOffice.org are always available here:
Contacting author
Please send your suggestions and bug reports to: Paolo Mantovani Any feedback is welcome!
Extension Compiler
There are many kinds of extensions : they may use languages other than Basic, or even set a configuration without any executable code. Usually an extension provides menus and toolbars for one or more applications (Writer, Calc...).
For a professional look you will have to add copyright statements, create your own help pages, provide automatic update. All displayable texts will probably have to be translated in several languages. This means editing lots of files, testing and editing each time you have found a bug, or added a feature, or added a new language.
The Extension Compiler can handle all kinds of extensions and reduce your work load. Its documentation guides you through most of the process. You don't need to know all the implementation details, you don't need a complex environment. You will edit a Writer document to write the tooltip text, license text, help pages for your extension.
You will then write a linear succession of simple Basic instructions to describe your extension. Run this Basic program: the Extension Compiler will create the files description.xml, addon.xml, manifest.xml, xxxWindowState.xml, and the license, tooltip, display name, help pages for different languages. All files will be encoded in UTF-8 to support national characters, stored in sub-folders. After a few seconds your oxt package is ready to be installed!
If you made an error, or if you are not satisfied with your extension, change some instructions and run again. For complex extensions, incremental design is easy: start simple, test, add a feature, test it, add another feature, etc.
The help pages for your extension may be specific to each application (Calc, Writer, Draw...). They are called by a help button in your dialogs, or by contextual help in the dialogs or menus, or from the index tab of the help window. These help pages will be seamlessly integrated into OpenOffice.org help system. If you have created your help in several languages OpenOffice.org will choose the language which fits the best with the User Interface language.
Requirements
You must have OpenOffice.org 2.2 or above installed.
The menu merging and toolbar merging features require OpenOffice.org 2.3 or above.
The extensible help requires OpenOffice.org 2.4 and above.
Install
Extension Compiler is a Writer template document : opening it creates a new Writer document that you will have to personalize.
Save it under the name of your extension in a dedicated folder where macro execution is allowed. You will store in this dedicated folder all the libraries, files, images, needed for your extension. You may use sub-folders.
Write in this document the text of the tooltip, license and help pages of your extension, in as many languages as you like (or can).
Open the Basic IDE to the Standard library of this document. Open the module Module1 in this library. It contains a prepared macro : myExtension. Add your instructions where indicated. The instruction set is described in chapter 3 of the document, read it carefully. You will find typical examples in the modules named Template1 etc.
Run the macro. If you get an error message, correct your script and run again. Otherwise, your extension file is ready.
Latest changes
Version 1.1 handles the features introduced by OpenOffice.org 2.4 : extension Display name, Publisher name, Release Notes, help pages.
Related Issues
There are currently some limitations or bugs in the extension mechanism itself, see Issues 86079, 86437, 86528, 86534, 86535, 86536, 87230, 87330, 87386, 87412
Download
Extension Compiler is currently downloadable at this location.
Contacting author
Extension Compiler is written by Bernard Marcelly. Please send your suggestions and bug reports at the address indicated in the document. Feedbacks are welcome.
