office-gobmx/scripting/README.md
Hossein ea5641baee Updated README.md files to represent current code / use Markdown format
Previously, all of the README files have been renamed to README.md
and now, the contents of these files were changed to use Markdown
format. Other than format inconsistency, some README.md files lacked
information about modules, or were out of date. By using LibreOffice
/ OpenOffice wiki and other documentation websites, these files were
updated. Now every README.md file has a title, and some description.
The top-level README.md file is changed to add links to the modules.
The result of processing the Markdown format README.md files can be
seen at: https://docs.libreoffice.org/

Change-Id: Ic3b0c3c064a2498d6a435253b041df010cd7797a
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/113424
Tested-by: Jenkins
Reviewed-by: Michael Stahl <michael.stahl@allotropia.de>
Reviewed-by: Adolfo Jayme Barrientos <fitojb@ubuntu.com>
2021-04-07 17:47:16 +02:00

70 lines
1.8 KiB
Markdown

# Scripting Framework
This module provides the source code for the Scripting Framework.
For more information on the Scripting Framework, see the project web page:
<https://framework.openoffice.org/scripting/>
This module uses astyle to keep consistent java coding style. Please run
./Format_java_code.sh
before committing.
## Source Code Structure
The following directories contain the source code currently used
by the Scripting Framework:
- `source/provider`
C++ source for the implementations of the `com.sun.star.script.provider.*`
and `com.sun.star.script.browse.*` UNO types. These types are used for
browsing and executing scripts.
- `source/protocolhandler`
C++ for a `ProtocolHandler` implementation that handles `vnd.sun.star.script`
URIs and dispatches them for execution to the Scripting Framework.
- `source/basprov`
C++ implementation of the `LanguageScriptProvider` UNO service for Basic
- `source/dlgprov`
C++ implementation of the `DialogProvider` UNO service used for loading
UNO dialogs from various languages
- `source/pyprov`
`LanguageScriptProvider` for Python
- `java/com/sun/star/script/framework/provider`
Implementation of an abstract base class ScriptProvider which provides
core methods for implementing Java based `LanguageScriptProvider` implementations
- `java/com/sun/star/script/framework/provider/*`
`BeanShell`, JavaScript and Java `LanguageScriptProvider` implementations
- `java/com/sun/star/script/framework/browse/*`
`BrowseNode` implementations for the Java based `LanguageScriptProviders`
- `java/com/sun/star/script/framework/io`
- `java/com/sun/star/script/framework/container`
Classes for performing script IO
- `examples`
Example scripts in BeanShell, JavaScript, Java and Python
## Deprecated Code
- `java/org/openoffice/*`
Support for developing scripts in IDEs such as NetBeans.