diff options
| author | Hossein <hossein.ir@gmail.com> | 2021-03-29 21:55:26 +0430 |
|---|---|---|
| committer | Adolfo Jayme Barrientos <fitojb@ubuntu.com> | 2021-04-07 17:47:16 +0200 |
| commit | ea5641baeef73af60d025d185901a303844e2d85 (patch) | |
| tree | 94b343b35e7b8805beb9a1745fe1de2f382574fb /scripting | |
| parent | 33da78c21f4243a3e469fb7df79ed1745df70078 (diff) | |
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>
Diffstat (limited to 'scripting')
| -rw-r--r-- | scripting/README.md | 52 |
1 files changed, 27 insertions, 25 deletions
diff --git a/scripting/README.md b/scripting/README.md index 3a019e27d254..0560a73b9786 100644 --- a/scripting/README.md +++ b/scripting/README.md @@ -1,68 +1,70 @@ +# 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/] +<https://framework.openoffice.org/scripting/> This module uses astyle to keep consistent java coding style. Please run -./Format_java_code.sh + ./Format_java_code.sh before committing. -== Source Code Structure == +## Source Code Structure The following directories contain the source code currently used by the Scripting Framework: -- source/provider +- `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 +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 +- `source/protocolhandler` -C++ for a ProtocolHandler implementation that handles vnd.sun.star.script +C++ for a `ProtocolHandler` implementation that handles `vnd.sun.star.script` URIs and dispatches them for execution to the Scripting Framework. -- source/basprov +- `source/basprov` -C++ implementation of the LanguageScriptProvider UNO service for Basic +C++ implementation of the `LanguageScriptProvider` UNO service for Basic -- source/dlgprov +- `source/dlgprov` -C++ implementation of the DialogProvider UNO service used for loading +C++ implementation of the `DialogProvider` UNO service used for loading UNO dialogs from various languages -- source/pyprov +- `source/pyprov` -LanguageScriptProvider for Python +`LanguageScriptProvider` for Python -- java/com/sun/star/script/framework/provider +- `java/com/sun/star/script/framework/provider` Implementation of an abstract base class ScriptProvider which provides -core methods for implementing Java based LanguageScriptProvider implementations +core methods for implementing Java based `LanguageScriptProvider` implementations -- java/com/sun/star/script/framework/provider/* +- `java/com/sun/star/script/framework/provider/*` -BeanShell, JavaScript and Java LanguageScriptProvider implementations +`BeanShell`, JavaScript and Java `LanguageScriptProvider` implementations -- java/com/sun/star/script/framework/browse/* +- `java/com/sun/star/script/framework/browse/*` -BrowseNode implementations for the Java based LanguageScriptProviders +`BrowseNode` implementations for the Java based `LanguageScriptProviders` -- java/com/sun/star/script/framework/io -- java/com/sun/star/script/framework/container +- `java/com/sun/star/script/framework/io` +- `java/com/sun/star/script/framework/container` Classes for performing script IO -- examples +- `examples` Example scripts in BeanShell, JavaScript, Java and Python -== Deprecated Code == +## Deprecated Code -- java/org/openoffice/* +- `java/org/openoffice/*` Support for developing scripts in IDEs such as NetBeans. |