Move docs to docs/ folder

In preparation to have this stuff online
This commit is contained in:
Samuel Mehrbrodt
2018-10-27 13:45:02 +02:00
parent 92bde1d6cc
commit a2e2b277da
56 changed files with 8 additions and 55 deletions

2
.gitignore vendored
View File

@ -2,6 +2,6 @@
/*/bin
/site
/*.zip
/core/doc/help/html/api/
/docs/loeclipse-doc/help/html/api/
/java/jodconnector.jar
/site.tar.gz

View File

@ -80,7 +80,7 @@
<target name="purge" depends="init-env">
<property name="core.out.path" value="${core.basedir}/bin/ant" />
<delete dir="${core.out.path}" />
<delete dir="${core.basedir}/doc/help/html/api" />
<delete dir="${core.basedir}/../docs/loeclipse-doc/help/html/api" />
</target>
<target name="core.compile" depends="init-env">
@ -99,7 +99,7 @@
<zipfileset dir="${core.sources}" prefix="">
<exclude name="**/*.java"/>
</zipfileset>
<zipfileset dir="${core.basedir}/doc" prefix="doc"/>
<zipfileset dir="${core.basedir}/../docs/loeclipse-doc" prefix="doc"/>
<zipfileset dir="${core.basedir}/icons" prefix="icons"/>
<zipfileset dir="${core.basedir}/schema" prefix="schema"/>
<zipfileset dir="${core.basedir}" defaultexcludes="true" prefix="">
@ -137,7 +137,7 @@
useexternalfile="true"
packagenames="org.libreoffice.ide.eclipse.core.*"
classpathref="core.dependencies.path"
destdir="${core.basedir}/doc/help/html/api">
destdir="${core.basedir}/../docs/loeclipse-doc/help/html/api">
<packageset dir="${core.basedir}/source">
<include name="org/libreoffice/ide/eclipse/core/**"/>

View File

@ -1,4 +0,0 @@
HOWTO internationalize this plugin ?
Please report to the plugin on-line help, developer documentation.

View File

@ -1,45 +0,0 @@
<?xml version="1.0" encoding="UTF-8" ?>
<cheatsheet title="Starting to use LibreOffice plugin">
<intro>
<description>
This tutorial will guide you through the LibreOffice plugin. This
way, you will get used to the different features available.
<br/>
<b>This do not prevent you to read the developer's guide.</b>
</description>
</intro>
<item title="SDK Configuration">
<description>
First of all is to configure the available LibreOffice SDKs. You can
add, remove and edit the SDKs that can be used in the plugin in the
preferences. Open the <b>Window-&gt;Preferences</b> menu item to get the preferences.
Afterwards, select the <b>LibreOffice-&gt;SDK Configuration</b> node.
<br />
Then add, remove and/or edit your SDKs, but remember that you need at least one.
</description>
</item>
<item title="Creating a new component">
<description>
Now you can create your first component. Select the <b>File-&gt;New-&gt;Project</b>
menu item. Choose the <b>new UNO project wizard</b> and follow the dialogs.
<br />
<b>You need to select one of the available SDK.</b>
</description>
</item>
<item title="Creating a new UNO-IDL file">
<description>
In your newly created UNO Component basic tree, you could add a new idl file.
Select the <b>File-&gt;New-&gt;Others</b> menu item. From this point launch the
<b>new UNO-IDL file creation wizard</b>.
<br />
The only thing to now in this wizard is that you cannot create an idl file outside
an idl capable folder. You can distinguish them with their 'I'.
</description>
</item>
</cheatsheet>

View File

@ -38,6 +38,8 @@ After installing the plugin, you can create new extensions/components by using *
You can also have a look at the [LibreOffice Starter Extension](https://github.com/smehrbrodt/libreoffice-starter-extension). It contains a step-by-step guide to get started with Java extension development.
More instructions on how to use the LOEclipse plugin are provided via the Eclipse Help system. Go to Help->Help Contents and select "LOEclipse User Guide"
You find more resources for extension development on https://wiki.documentfoundation.org/Development/Extension_Development
## Features

View File

Before

Width:  |  Height:  |  Size: 15 KiB

After

Width:  |  Height:  |  Size: 15 KiB

View File

Before

Width:  |  Height:  |  Size: 42 KiB

After

Width:  |  Height:  |  Size: 42 KiB

View File

Before

Width:  |  Height:  |  Size: 23 KiB

After

Width:  |  Height:  |  Size: 23 KiB

View File

Before

Width:  |  Height:  |  Size: 32 KiB

After

Width:  |  Height:  |  Size: 32 KiB

View File

Before

Width:  |  Height:  |  Size: 42 KiB

After

Width:  |  Height:  |  Size: 42 KiB

View File

Before

Width:  |  Height:  |  Size: 35 KiB

After

Width:  |  Height:  |  Size: 35 KiB

View File

Before

Width:  |  Height:  |  Size: 23 KiB

After

Width:  |  Height:  |  Size: 23 KiB

View File

Before

Width:  |  Height:  |  Size: 3.2 KiB

After

Width:  |  Height:  |  Size: 3.2 KiB

View File

Before

Width:  |  Height:  |  Size: 553 B

After

Width:  |  Height:  |  Size: 553 B

View File

Before

Width:  |  Height:  |  Size: 32 KiB

After

Width:  |  Height:  |  Size: 32 KiB

View File

Before

Width:  |  Height:  |  Size: 27 KiB

After

Width:  |  Height:  |  Size: 27 KiB

View File

Before

Width:  |  Height:  |  Size: 26 KiB

After

Width:  |  Height:  |  Size: 26 KiB

View File

Before

Width:  |  Height:  |  Size: 39 KiB

After

Width:  |  Height:  |  Size: 39 KiB

View File

Before

Width:  |  Height:  |  Size: 29 KiB

After

Width:  |  Height:  |  Size: 29 KiB

View File

Before

Width:  |  Height:  |  Size: 29 KiB

After

Width:  |  Height:  |  Size: 29 KiB

View File

Before

Width:  |  Height:  |  Size: 21 KiB

After

Width:  |  Height:  |  Size: 21 KiB

View File

Before

Width:  |  Height:  |  Size: 40 KiB

After

Width:  |  Height:  |  Size: 40 KiB

View File

Before

Width:  |  Height:  |  Size: 524 KiB

After

Width:  |  Height:  |  Size: 524 KiB

View File

Before

Width:  |  Height:  |  Size: 18 KiB

After

Width:  |  Height:  |  Size: 18 KiB

View File

Before

Width:  |  Height:  |  Size: 56 KiB

After

Width:  |  Height:  |  Size: 56 KiB

View File

Before

Width:  |  Height:  |  Size: 84 KiB

After

Width:  |  Height:  |  Size: 84 KiB

View File

Before

Width:  |  Height:  |  Size: 184 KiB

After

Width:  |  Height:  |  Size: 184 KiB

View File

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8" ?>
<?NLS TYPE="org.eclipse.help.toc"?>
<toc label="LibreOffice plugin help">
<toc label="LOEclipse User Guide">
<topic label="User documentation" href="doc/help/html/userdoc/index.html">
<link toc="doc/help/html/userdoc/javatuto/toc.xml"/>

View File

@ -2,5 +2,5 @@
cd build
ant purge
ant -Dlibreoffice.home=/usr/lib/libreoffice -Declipse.home=~/Programme/eclipse/ -v
ant -Dlibreoffice.home=/usr/lib/libreoffice -Declipse.home=/home/samuel/Programme/eclipse/ -v