Apache OpenOffice Wiki - User contributions [en]

Python

2008-06-13T04:55:59Z

JimTittsler: spelling/grammar

{{Extensions}}
[[image:Py-uno_128.png|PyUNO Logo]] [[image:Pyuno_logo_a.jpg]]
=== News ===
Efforts on moving PyUNO to '''Python 2.5''' continue. Liyuan is pushing this initiative and has [http://udk.openoffice.org/servlets/ReadMsg?listName=dev&msgNo=3704 commited the CWS] on the UDK mailing list the [[CWS]] however is not ready and was sent back on issue [http://www.openoffice.org/issues/show_bug.cgi?id=71327 71327].

=== Python and OpenOffice.org ===
OpenOffice.org ships with a python scripting language on it's versions 2.3.4. This Python distribution comes with the [[Uno]] module which connects the [[API|UNO API]] with the python scripting language. To run this version of Python on Linux you can go to the direct OpenOffice.org PATH. OOo-Python can be run from the command line as well as you might expect with any other distribution of Python.

==== Where is the IDE ? ====
OpenOffice.org's IDE doesn't support Python, so development has to be done from another editor that does. Any volunteer for a binding is welcomed

==== Tips & Tricks ====

Here are some useful information, helping to use python in OOo

===== Debug output =====

If you launch a python script, any error will silently break the execution and your extension will be hard to debug. To change this behaviour, one can change the '''LogLevel'''

Have a look in
''/path/to/ooo/program/'''pythonscript.py'''''
and replace
''LogLevel.use = LogLevel.'''NONE'''''
with
''LogLevel.use = LogLevel.'''DEBUG'''''

There are also currently undocumented environment variables, which tell the pyUno bridge to log every call, set therefor the environment variable
''export PYUNO_LOGLEVEL=ARGS''
, the output is a little hard to read, but helpful during development.

This holds for unix, for windows you need some more switches and the output gets written to files (no stdout on windows :-( ).

Some error messages still don't appear in these logs, this will improve
in near future (cws pyunofixes4). Once the cws is integrated, I will document these switches on the official pyuno site.

''Thanks to Joerg Budischewski''

=== Python specific information for Extension creation ===
To create extensions for python it is important that you have enough relation with the UNO components as well as packaging your code to be able to easily distribute your scripts through the ''OpenOffice.org package manager''. Please check up the tutorials on how to componentize your code as well as how to deploy remote scripting through a service implementation.

To learn to run Python on Windows you could visit [[Using Python on Windows| this link]] for more detail information.

=== Getting Started ===
*[[Using Python on Windows]] - New to Python? Learn how to use python on Windows
*[[Using Python on Linux]] - A must read for an overwiew on Python and OOo relations
* [[pyUNO bridge]] - Official page of the PyUNO bridge at the [http://udk.openoffice.org/ UDK site]
* [[Python as a macro language]] in OpenOffice.org 2.x - How to use the Python scripting framework
* Introduction on testing pyUNO programs with [[doctests]]
* Create a [http://codesnippets.services.openoffice.org/Office/Office.MessageBoxWithTheUNOBasedToolkit.snip dialog box] in PyUNO.
* [http://codesnippets.services.openoffice.org/Office/Office.ConnectViaPipe.snip Connect to openoffice.org] from PyUNO
* [[PyUNO samples]] currently shipping with OpenOffice.org and the explanation.
* Enhanced [http://www.oooforum.org/forum/viewtopic.phtml?p=257496#257496 Capitalized.py] script by ''The gray Cardinal'' at OOoforum.

=== PyUNO Modules ===
*[[Danny's Python Modules]] - Collection guide from DannyB's modules.
*[[PrinttoWriter.py]] - This makes it easy and convenient to print a bunch of text into a Writer document.
*[http://www.oooforum.org/forum/viewtopic.phtml?t=8456 Developing Calc Funcions in Python] - Learn how Python can be used to script your spreadsheets
*[http://www.oooforum.org/forum/viewtopic.phtml?p=56037#56037 Generating a Spreadsheet through Python] - Automatically generate new spreadsheets
*[http://www.oooforum.org/forum/viewtopic.phtml?t=9115 Python container components]
*[[PyUNOServer]] - The PyUNOServer is a script that works as an XML server for OpenOffice.org Calc
*[[calcParser]] - calcParser is a small parser using the native SAX utilities within the OpenOffice.org python
*[[OoConfig]] - OoConfig is a Python extension that seeks to provide a configuration editing facility similar to Mozilla's about:config
*[[Bibliographic/Hints and Tips/OOoRISExport.py|OOoRISExport.py]] - Exports the bibliographic database in RIS format. Also [http://bibliographic.openoffice.org/files/documents/124/3078/RISImport.py RISImport.py]
*[[Zotero_Plugin |Zotero Plugin]] - The Zotero plugin provides citation and bibliographic table insertion and editing functions for Writer documents.

=== Hacking Arround ===
*[[UNO component packaging]] - How to create UNO components as well as the basics of script componentizing
*[http://www.oooforum.org/forum/viewtopic.phtml?p=38234#38234 Python component to parse XML] - Python is great to parse XML, PyUNO is also excellent when working with XML
*[[Example of Service in Python]] - Learn how to run Python as a service, this is useful for remote scripting.
*[http://www.oooforum.org/forum/viewtopic.phtml?p=76972#76972 Modify spreadsheet] - Example of storing and retrieving a custom attribute on a spreadsheet cell.
*A simple [[daemon in Python]] - Learn how to run Python as a daemon
*[[Loook.py]] - a simple Python tool that searches for text strings in OpenOffice.org.
*[[odt2txt.py]] - convert ODF to plain text using python (and convert the txt to html).

=== Python rules OOo (by B. Bois) ===
[[image:python_power_for_OOo.png|Python rules OOo :-)]]

[[Category:Extensions]]
[[Category:Python]]
[[Category:Uno]]

Documentation/DevGuide/Extensions/Checklist for Writing Extensions

2008-06-13T04:51:57Z

JimTittsler: spelling there/their

{{Documentation/DevGuide/ExtensionsTOC
|ShowPrevNext=block
|PrevPage=Documentation/DevGuide/Extensions/Extension Layers
|NextPage=Documentation/DevGuide/Extensions/File Format
}}
{{DISPLAYTITLE:Checklist for Writing Extensions}}
This page gives a brief overview about what is important when developing an extension.

# Use the '''.oxt''' file extension and provide [[Documentation/DevGuide/Extensions/description.xml | description.xml]]. Look [http://extensions.openoffice.org/servlets/ReadMsg?list=dev&msgNo=142 here] why you should use <code>.oxt</code>.
# Provide an [[Documentation/DevGuide/Extensions/Extension_Identifiers|'''extension identifier''']] in the [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/identifier|description.xml]]
# Provide a [[Documentation/DevGuide/Extensions/Extension_Versions|'''version''']] in the [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/dependencies|description.xml]].
# Provide a [[Documentation/DevGuide/Extensions/Display_Name|'''display name''']] in the [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/display-name|description.xml]].
# Specify the [[Documentation/DevGuide/Extensions/Target Platform|'''target platforms''']] in the [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/platform|description.xml]].
# Specify the [[Documentation/DevGuide/Extensions/Dependencies|'''dependencies''']] in the [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/dependencies|description.xml]]. For example, if your extension requires a 'minimal version' of OOo then use the [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/dependencies/OpenOffice.org-minimal-version|OpenOffice.org-minimal-version]] dependency.
# You may add a [[Documentation/DevGuide/Extensions/Simple_License|'''license''']]. Text files containing a license need to be "registered" in the [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/registration|description.xml]].
# To allow an ''''online update'''' of the extension one does not need to prepare the extension when using the [http://extensions.services.openoffice.org OOo extension repository]. More information can be found [[Documentation/DevGuide/Extensions/Online Update of Extensions|here]].
# Provide an [[Documentation/DevGuide/Extensions/Options Dialog|'''options page''']] in case the extension needs to be configured. Do not create your own menu or menu entries if their sole purpose is to adjust settings for the extension.
#Provide '''[[Documentation/DevGuide/Extensions/Publisher Information|publisher information]]''' in the [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/publisher|description.xml]].
# Provide links to '''release notes''' (TODO: more documentation) in the description.xml. Currently only used within the 'update dialog'. When using the [http://extensions.services.openoffice.org OOo extension repository], then the link to the release notes is automatically generated from the information entered on the web site. That is, when using the repository one does not need to provide this information in the description.xml.
# Provide content for [[Documentation/DevGuide/Extensions/Help Content|'''help system''']] if necessary.

{{PDL1}}

[[Category:Documentation/Developer's Guide/Extensions]]

Python

2007-08-18T22:24:19Z

JimTittsler: /* Python specific information for Extension creation */ spelling

{{Extensions}}
[[image:Py-uno_128.png|PyUNO Logo]] [[image:Pyuno_logo_a.jpg]]
=== News ===
Efforts on moving PyUNO to '''Python 2.5''' continue. Liyuan is pushing this initiatie and has [http://udk.openoffice.org/servlets/ReadMsg?listName=dev&msgNo=3704 commited the CWS] on the UDK mailing list the [[CWS]] however is not ready and was sent back on issue [http://www.openoffice.org/issues/show_bug.cgi?id=71327 71327].

=== Python and OpenOffice.org ===
OpenOffice.org ships with a python scripting language on it's versions 2.3.4. This Python distribution comes with the [[Uno]] module which connects the [[API|UNO API]] with the python scripting language. To run this version of Python on Linux you can go to the direct OpenOffice.org PATH. OOo-Python can be run from the command line as well as you might expect with any other distribution of Python.

==== Where is the IDE ? ====
OpenOffice.org's IDE doesn't support Python, so development have to be done from other editor that does.

=== Python specific information for Extension creation ===
To create extensions for python is important that you have enough relation with the UNO components as well as packaging your code to be able to easily distribute your scripts through the ''OpenOffice.org package manager''. Please check up the tutorials on how to componentize your code as well as how to deploy remote scripting through a service implementation.

To learn to run Python on Windows you could visit [[Using Python on Windows| this link]] for more detail information.

=== Getting Started ===
*[[Using Python on Windows]] - New to Python? Learn how to use python on Windows
*[[Using Python on Linux]] - A must read for an overwiew on Python and OOo relations
* [[pyUNO bridge]] - Official page of the PyUNO bridge at the [http://udk.openoffice.org/ UDK site]
* [[Python as a macro language]] in OpenOffice.org 2.x - How to use the Python scripting framework
* Introduction on testing pyUNO programs with [[doctests]]
* [http://www.oooforum.org/forum/viewtopic.php?t=4368 Setting up Python-bridge on Debian] - How to install and activate the PyUNO in a Debian box.
* Create a [http://codesnippets.services.openoffice.org/Office/Office.MessageBoxWithTheUNOBasedToolkit.snip dialog box] in PyUNO.
* [http://codesnippets.services.openoffice.org/Office/Office.ConnectViaPipe.snip Connect to openoffice.org] from PyUNO
* [[PyUNO samples]] currently shipping with OpenOffice.org and the explanation.

=== PyUNO Modules ===
*[[Danny's Python Modules]] - Collection guide from DannyB's modules.
*[[PrinttoWriter.py]] - This makes it easy and convenient to print a bunch of text into a Writer document.
*[http://www.oooforum.org/forum/viewtopic.phtml?t=8456 Developing Calc Funcions in Python] - Learn how Python can be used to script your spreadsheets
*[http://www.oooforum.org/forum/viewtopic.phtml?p=56037#56037 Generating a Spreadsheet through Python] - Automatically generate new spreadsheets
*[http://www.oooforum.org/forum/viewtopic.phtml?t=9115 Python container components]
*[[PyUNOServer]] - The PyUNOServer is a script that works as an XML server for OpenOffice.org Calc
*[[calcParser]] - calcParser is a small parser using the native SAX utilities within the OpenOffice.org python

=== Hacking Arround ===
*[[UNO component packaging]] - How to create UNO components as well as the basics of script componentizing
*[http://www.oooforum.org/forum/viewtopic.phtml?p=38234#38234 Python component to parse XML] - Python is great to parse XML, PyUNO is also excellent when working with XML
*[[Example of Service in Python]] - Learn how to run Python as a service, this is useful for remote scripting.
*[http://www.oooforum.org/forum/viewtopic.phtml?p=76972#76972 Modify spreadsheet] - Example of storing and retrieving a custom attribute on a spreadsheet cell.
*A simple [[daemon in Python]] - Learn how to run Python as a daemon
*[[Loook.py]] - a simple Python tool that searches for text strings in OpenOffice.org.
*[[odt2txt.py]] - convert ODF to plain text using python (and convert the txt to html).

=== Python rules OOo (by B. Bois) ===
[[image:python_power_for_OOo.png|Python rules OOo :-)]]

[[Category:Extensions]]
[[Category:Python]]
[[Category:Uno]]

Python

2007-08-18T22:14:42Z

JimTittsler: /* Hacking Arround */ spelling

{{Extensions}}
[[image:Py-uno_128.png|PyUNO Logo]] [[image:Pyuno_logo_a.jpg]]
=== News ===
Efforts on moving PyUNO to '''Python 2.5''' continue. Liyuan is pushing this initiatie and has [http://udk.openoffice.org/servlets/ReadMsg?listName=dev&msgNo=3704 commited the CWS] on the UDK mailing list the [[CWS]] however is not ready and was sent back on issue [http://www.openoffice.org/issues/show_bug.cgi?id=71327 71327].

=== Python and OpenOffice.org ===
OpenOffice.org ships with a python scripting language on it's versions 2.3.4. This Python distribution comes with the [[Uno]] module which connects the [[API|UNO API]] with the python scripting language. To run this version of Python on Linux you can go to the direct OpenOffice.org PATH. OOo-Python can be run from the command line as well as you might expect with any other distribution of Python.

==== Where is the IDE ? ====
OpenOffice.org's IDE doesn't support Python, so development have to be done from other editor that does.

=== Python specific information for Extension creation ===
To create extensions for python is important that you have enough relation with the UNO components as well sa packaging your code to be able to easily distribute your scripts through the ''OpenOffice.org package manager''. Please check up the tutorials on how to componetize your code as well as how to deploy remote scripting through a service implementation.

To learn to run Python on Windows you could visit [[Using Python on Windows| this link]] for more detail information.

=== Getting Started ===
*[[Using Python on Windows]] - New to Python? Learn how to use python on Windows
*[[Using Python on Linux]] - A must read for an overwiew on Python and OOo relations
* [[pyUNO bridge]] - Official page of the PyUNO bridge at the [http://udk.openoffice.org/ UDK site]
* [[Python as a macro language]] in OpenOffice.org 2.x - How to use the Python scripting framework
* Introduction on testing pyUNO programs with [[doctests]]
* [http://www.oooforum.org/forum/viewtopic.php?t=4368 Setting up Python-bridge on Debian] - How to install and activate the PyUNO in a Debian box.
* Create a [http://codesnippets.services.openoffice.org/Office/Office.MessageBoxWithTheUNOBasedToolkit.snip dialog box] in PyUNO.
* [http://codesnippets.services.openoffice.org/Office/Office.ConnectViaPipe.snip Connect to openoffice.org] from PyUNO
* [[PyUNO samples]] currently shipping with OpenOffice.org and the explanation.

=== PyUNO Modules ===
*[[Danny's Python Modules]] - Collection guide from DannyB's modules.
*[[PrinttoWriter.py]] - This makes it easy and convenient to print a bunch of text into a Writer document.
*[http://www.oooforum.org/forum/viewtopic.phtml?t=8456 Developing Calc Funcions in Python] - Learn how Python can be used to script your spreadsheets
*[http://www.oooforum.org/forum/viewtopic.phtml?p=56037#56037 Generating a Spreadsheet through Python] - Automatically generate new spreadsheets
*[http://www.oooforum.org/forum/viewtopic.phtml?t=9115 Python container components]
*[[PyUNOServer]] - The PyUNOServer is a script that works as an XML server for OpenOffice.org Calc
*[[calcParser]] - calcParser is a small parser using the native SAX utilities within the OpenOffice.org python

=== Hacking Arround ===
*[[UNO component packaging]] - How to create UNO components as well as the basics of script componentizing
*[http://www.oooforum.org/forum/viewtopic.phtml?p=38234#38234 Python component to parse XML] - Python is great to parse XML, PyUNO is also excellent when working with XML
*[[Example of Service in Python]] - Learn how to run Python as a service, this is useful for remote scripting.
*[http://www.oooforum.org/forum/viewtopic.phtml?p=76972#76972 Modify spreadsheet] - Example of storing and retrieving a custom attribute on a spreadsheet cell.
*A simple [[daemon in Python]] - Learn how to run Python as a daemon
*[[Loook.py]] - a simple Python tool that searches for text strings in OpenOffice.org.
*[[odt2txt.py]] - convert ODF to plain text using python (and convert the txt to html).

=== Python rules OOo (by B. Bois) ===
[[image:python_power_for_OOo.png|Python rules OOo :-)]]

[[Category:Extensions]]
[[Category:Python]]
[[Category:Uno]]

Extensions best practices

2007-08-18T22:07:25Z

JimTittsler: /* Licenses */ spelling

== How to write OpenOffice.org GUI Extensions today ==
The [[Extensions development#Project: Enhancing_Extensions Infrastructure of OpenOffice.org 2.0.3|Extension Infrastructure Enhancement Project]] has the goal to introduce missing functionality in this area step-by-step with the next OO.o updates. The respective tasks have high priority for [http://www.sun.com Sun]'s OpenOffice.org Development Team. Anyhow, some important functionality is currently missing completely, but many things can be even implemented in a more or less clean way already. In most cases you should be able to implement a 'clean' extension even today.

So, what are your choices today?

=== Compatibility ===
# Use the OO.o SDK to develop and build your extension. This prevents you from using types that are not guaranteed to stay compatible.
# Avoid usage of unpublished UNO types.

=== GUI Design and Implementation ===
# Never use VCL, because VCL API is not guaranteed to stay compatible, not even over micro OO.o updates. Use UNO AWT instead. If something is missing/broken in UNO AWT, don't close your eyes! File a bug and insist that it gets implemented/fixed quickly. Improving UNO AWT has very high priority.
# The OO.o Dialog Editor can be used even today for dialog design. You can put the XML dialog descriptions into your extension's package. The Extension Manager is already able to deploy XML dialog descriptions. There is a UNO Service available that creates an UNO AWT dialog from an XML dialog description. For event binding you currently have basically two choices:
## '''Since OOo 2.0.4:''' Use the dialog editor to design the dialogs. Implement the event logic using a language supported by UNO. Assign UNO events to the controls. Put both the dialog XML and the event logics into your extension. ([http://specs.openoffice.org/ide/NonScriptDialogEvents.odt Feature Specification])
## Use the dialog editor to design the dialogs. Assign no events to the controls. At runtime, after creating the UNO AWT dialog, attach the needed event listeners to the controls.
## Use the dialog editor to design the dialogs. Write some BASIC code that implements event handlers for your dialog controls. Those handlers might be very small, in the most simple approach they would just call one of your UNO event handling objects. The BASIC library containing your glue code can easily put into the package for your extension. The OO.o Extension Manager already supports deployment of BASIC libraries.
## Use the dialog editor to design the dialogs. Write a macro in a language supported by OO.o Scripting Framework (Java, Beanshell, ...) that implements event handlers for your dialog controls. The Dialog Editor already supports binding events to Scripting Framework macros. The macro containing your code can easily put into the package for your extension. The OO.o Extension Manager already supports deployment of Scripting Framework macros.

=== GUI Localization ===
# '''Since OOo 2.2:''' The OO.o Dialog Editor supports creation and editing of multi language dialogs. [http://specs.openoffice.org/appwide/dialog_ide/GUI_Translation_in_Dialog_IDE.odt Feature Specification])
# Obtain the right locale-dependent strings at runtime and to set it at the respective UNO AWT controls.
# Recently the UNO service com.sun.star.resource.OfficeResourceLoader was introduced that is able to access arbitrary resource strings that are accessible by the OO.o ResMgr class. This service can be of help if you just want to use an already existing OO.o resource string.
# A good approach is to use the localization features of the UNO Configuration service. The UNO Configuration Service allows to define locale-dependend strings. The Configuration service returns values of those string configuration items according to the locale set upon initialization of the Configuration service.

=== Extension Features ===

==== Dependencies ====
# '''Since OO.o 2.0.4:''' It is possible to define dependencies for packages. ([http://specs.openoffice.org/appwide/packagemanager/extensiondependencies1.odt Feature Specification]) An extension can specify that it needs a minimal OO.o version. Formally, the dependency is an empty XML element whose name consists of the namespace name "http://openoffice.org/extensions/description/2006" and the local part "'''OpenOffice.org-minimal-version'''". It shall have two attributes, namely the "name" attribute required for every dependency and an attribute with unprefixed name "value" whose value is the string representation of an OOo version starting with OOo 2.1 (in which case the value is the string "2.1"). The dependency is fulfilled if and only if the value of the current OOo version is (element-by-element lexicographically) greater than or equal to the specified value. It is not possible to define that an extension requires an OO.o version 2.0.3 or older. However, if you want that yor extension can only be installed in OOo 2.0.4 or newer, use the OXT Extension Package format for your extension. OXT cannot be installed prior to OOo 2.0.4.
# Prior to OO.o 2.0.4, it is not possible to specify runtime dependencies for packages.

==== Versions ====
# '''Since OO.o 2.1:''' It is possible to specify version information for extensions. ([http://specs.openoffice.org/appwide/packagemanager/extensionversion.odt Feature Specification])
# Prior to OO.o 2.1 it is not possible to specify version information for packages. However this is not a big issue until you want to provide the first update for your component. Packages without explicit version information will be considered to be “version 1”. However, package versioning must be available latest when the first official package update needs to be released.

==== Licenses ====
# '''Since OO.o 2.0.4:''' It is possible to include a license text in the extension package. The text will be displayed while installing the extension. Installation will be aborted in case the user declines the license. ([http://specs.openoffice.org/appwide/packagemanager/simple_extension_license.odt Feature Specification])
# Prior to OO.o 2.0.4, no licensing features are available.

==== Product Registration ====
This feature is not yet available.

==== Digital Signatures ====
This feature is not yet available.

==== Common User Interface for Extension Preferences ====
This feature is not yet available.

==== Help Content ====
# Currently there is no known way to integrate own help content with the OO.o help system.
# You could put an HTML (or other format supported by Writer) file into your extension package. When the user requests help for your extension (for instance by pressing a help button you designed), you could load your help file into Writer. Not a very cool solution, though. Note: Currently it is very inconvenient to figure out the root directory of your package installation. How to do this is explained here: http://api.openoffice.org/docs/DevelopersGuide/Components/Components.xhtml#1_9_1_UNO_Package_Installation_Using_unopkg , in section Package Bundle Structure => Arbitrary Files. (To address this problem, we will design and implement an API that allows to directly obtain the package installation root.)
# A even more primitive approach is to use a simple message box for displaying the help text of your extension.

==== Package File Format ====
'''Since OO.o 2.0.4''', a new Package file format is available – '''OXT''' (OO.o eXTension). OXT files have basically the same structure as UNO packages. They are ZIP files containing the parts building the extension. OXT packages cannot be installed in OO.o version prior to 2.0.4. For detailed information see the [http://api.openoffice.org/docs/DevelopersGuide/Extensions/Extensions.xhtml Extensions] chapter of the Developers Guide. See also [[UNO component packaging]].

==== Online Update ====
'''Since OO.o 2.2''', online update of extensions is supported by the Extension Manager. ([http://specs.openoffice.org/appwide/packagemanager/online_update_for_extensions.odt Feature Specification])

[[Category:Extensions]]