litvinovg/metadata-editor
1
0
Fork 0
Code Issues Pull requests Projects Releases 5 Packages Wiki Activity Actions

Add Getting started guide to README

Browse source
This commit is contained in:
Samuel Mehrbrodt 2016-04-07 12:32:05 +02:00
parent b543b247b3
commit 2322c01058
1 changed files with 29 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
README.md
View file

@ -1,2 +1,29 @@
# libreoffice-starter-plugin # LibreOffice Starter Plugin
LibreOffice Extension boilerplate
This repository contains some boilerplate code and config you need to get started to build your own LibreOffice Extension.
You can use this project as a starting point to write your own extension for LibreOffice.
## Get started
# Install [LibreOffice](http://www.libreoffice.org/download) & [LibreOffice SDK](http://www.libreoffice.org/download) (5.0 or greater)
# Install [Eclipse](http://www.eclipse.org/) & the [LOEclipse plugin](https://github.com/LibreOffice/loeclipse/#installation)
# [Download](https://github.com/smehrbrodt/libreoffice-starter-plugin/archive/master.zip) this starter project & unzip it
# Import the project in Eclipse (File->Import->Existing Projects into Workspace)
# Let Eclipse know the paths to LibreOffice & the SDK (Project->Properties->UNO Properties)
# Setup Run Configuration
## Go to Run->Run Configurations
## Create a new run configuration of the type "LibreOffice Application"
## Select the project
## Run!
## *Hint: Show the error log to view the output of the run configuration (Window->Show View->Error Log)*
# The extension will be installed in LibreOffice and you will see a toolbar and a menu entry have been added to Writer.
## Development Hints
* The entry point is in [source/org/libreoffice/example/comp/StarterProjectImpl](https://github.com/smehrbrodt/libreoffice-starter-plugin/blob/master/source/org/libreoffice/example/comp/StarterProjectImpl.java).
* Toolbar items and menu entries are defined in [registry/org/openoffice/Office/Addons.xcu](https://github.com/smehrbrodt/libreoffice-starter-plugin/blob/master/registry/org/openoffice/Office/Addons.xcu).
* Shortcuts are defined in [registry/org/openoffice/Office/Accelerators.xcu](https://github.com/smehrbrodt/libreoffice-starter-plugin/blob/master/registry/org/openoffice/Office/Accelerators.xcu).
* The position of the toolbar is defined in [registry/org/openoffice/Office/UI/WriterWindowState.xcu](https://github.com/smehrbrodt/libreoffice-starter-plugin/blob/master/registry/org/openoffice/Office/UI/WriterWindowState.xcu).
* The dialog shown when clicking "Action One" is in [dialog/ActionOneDialog.xdl]. The dialog itself contains information how to edit it.
* The [DialogHelper](https://github.com/smehrbrodt/libreoffice-starter-plugin/blob/master/source/org/libreoffice/example/helper/DialogHelper.java) contains lots of helper methods to work with the dialog.
* Now go on customizing the extension to your needs. You'll find lots of information in the [OpenOffice Wiki](https://wiki.openoffice.org/wiki/Extensions_development).