From 06c73497580c32f77f2848a6f57feb037516695e Mon Sep 17 00:00:00 2001 From: Stephan Bergmann Date: Wed, 5 Jun 2013 10:22:03 +0200 Subject: Some HTML clean up Change-Id: I5f1b5d5e5fc59bc1496a292a5f002d87584732a4 --- odk/docs/install.html | 88 +++++++++--------- odk/docs/tools.html | 240 +++++++++++++++++++++++--------------------------- 2 files changed, 151 insertions(+), 177 deletions(-) (limited to 'odk/docs') diff --git a/odk/docs/install.html b/odk/docs/install.html index 7f44cb183fb7..efc82d2a8aa7 100644 --- a/odk/docs/install.html +++ b/odk/docs/install.html @@ -19,10 +19,8 @@ LibreOffice %PRODUCT_RELEASE% SDK - Installation Guide - - - - + +
@@ -40,16 +38,16 @@

Installation Guide

- +
- + - + +

Note: The C++ compiler is optional! If you use the Express edition you have to ensure that the Microsoft Visual Studio 2008 Redistributable Package is also installed. You can download this package from Microsoft directly.

- + - + - + - + + work well. On Solaris gnu make can be found often under /usr/sfw/bin/gmake, but keep in mind that you have to use 'gmake' then. Or you can find gnu make also under http://www.sunfreeware.com/.

- + - + - + - - + + @@ -250,7 +247,7 @@ - + - - - + - + - + - +
- + - + - - + - + - + - +
@@ -65,26 +63,25 @@
LibreOffice %PRODUCT_RELEASE% installationLibreOffice %PRODUCT_RELEASE% installation The SDK works on top of an existing office installation and uses the same libraries as the office installation.
JDK (1.5 or higher)JDK (1.5 or higher)

A JDK is necessary for developing Java components or applications. An appropriate Java SDK can be found on http://java.sun.com/products.

Recommendation is to use Java 6 excepting for Mac OS because initially Mac OS supported a 64bit version of Java 6 only.

Note: The Java compiler is optional!
C++ compilerC++ compiler A C++ compiler is necessary for developing C++ components or applications. UNO depends on a compiler dependent language binding, so that we use the appropriate compiler where a language binding @@ -103,62 +100,62 @@ Microsoft C++ Compiler, Microsoft Visual Studio 2008 or the Express version (cl, version 15.00.21022)
-

Note: The C++ compiler is optional! If you use the Express edition you have to ensure that the Microsoft Visual Studio 2008 Redistributable Package is also installed. You can download this package from Microsoft directly.
Microsoft .NET Framework SDK version 1.0 or higherMicrosoft .NET Framework SDK version 1.0 or higher The SDK is required for building CLI applications. - That is, programs written in languages, such as C# or VB.NET.
+ That is, programs written in languages, such as C# or VB.NET.

Note: The .NET Framework is optional!
GNU make (3.79.1 or higher)GNU make (3.79.1 or higher)

GNU make is used to build the examples of the SDK. GNU make is available from http://www.gnu.org. It can be ftped via ftp://ftp.gnu.org/gnu/make

Note: Windows user can find an executable of gnu make under http://www.mingw.org/wiki/Getting_Started (see the mingw32-make link under "Manual Installation"). Do not use the Cygwin make, because it does not - work well. On Solaris gnu make can be found often under /usr/sfw/bin/gmake, but keep in mind that you have to use 'gmake' then. Or you can find gnu make also under http://www.sunfreeware.com/.
zip tool (2.3 or higher)zip tool (2.3 or higher) The zip tool is used to create UNO packages. zip is - a new requirement to make the SDK independent of a Java SDK.
+ a new requirement to make the SDK independent of a Java SDK.
If you do not have these already, you can download them from http://www.info-zip.org. Note: The cygwin zip.exe does not work for the build under the 4NT shell. You have to use the native w32 version.

The SDK provides an implicit configuration mechanism, which configures the SDK build environment to your personal needs the first time you use the SDK environment. This configuration step creates one - new setsdkenv_XXX script in the user's home directory:

+ new setsdkenv_XXX script in the user's home directory:

    -
  • $HOME/$OO_SDK_NAME/setsdkenv_unix.sh  -> for Unix -
  • C:\Documents and Settings\<username>\Application Data\%OO_SDK_NAME%\setsdkenv_windows.bat  -> for Windows2000/XP or later +
  • $HOME/$OO_SDK_NAME/setsdkenv_unix.sh  -> for Unix
    • +
  • C:\Documents and Settings\<username>\Application Data\%OO_SDK_NAME%\setsdkenv_windows.bat  -> for Windows2000/XP or later

The automatically started configure script (Unix and Windows2000/XP) requests relevant information and directories (SDK, LibreOffice, GNU make, Java, C++), in order to prepare a working SDK environment. After completing the configure script once, the newly created script is always used to set the necessary environment variables for using the SDK and the required - tools.

+ tools.

On UNIX operating systems, the configure script uses Perl. LINUX systems should have installed a working Perl version, and on Solaris you can find a working Perl version under http://www.sunfreeware.com/ if necessary. On Windows, the configure script uses Windows Script and a JScipt. If you have problems with Windows Script, you can download a - newer version of Windows Script. + newer version of Windows Script.

On other versions of Windows, use the batch file template <OO_SDK_HOME>\setsdkenv_windows.template, @@ -174,8 +171,8 @@ and OO_SDK_URE_HOME must be set. The other should be either unset or set to an empty value.
OO_SDK_NAME
OO_SDK_NAME The configuration uses the directory name of the SDK, but you can use another name as well. It is important that the name does not contain spaces, because of a limitation @@ -214,7 +211,7 @@ Path to the C# compiler and VB.NET compiler (on Windows, this directory can be found under the system directory (e.g. c:\WINXP\Microsoft.NET\Framework\v1.0.3705). The compilers are - optional and only necessary for building the CLI examples.
+ optional and only necessary for building the CLI examples.
Note: Windows only!
@@ -293,7 +290,7 @@ $OO_SDK_URE_JAVA_DIR/ridl.jar; $OO_SDK_URE_JAVA_DIR/unoloader.jar; [$OO_SDK_URE_JAVA_DIR/unoil.jar;] - $CLASSPATH
+ $CLASSPATH

The classpath will be set or extended to the necessary jar files of the specified office installation. (unoil.jar is only included when OFFICE_HOME is set.)

@@ -301,7 +298,7 @@
OFFICE_PROGRAM_PATH=$OFFICE_HOME/program
+ 		=$OFFICE_HOME/program

This variable is used to find, for example, the office type library and the UNO package deployment tool. This variable is only relevant when OFFICE_HOME is set.

@@ -309,7 +306,7 @@
UNO_PATH=$OFFICE_PROGRAM_PATH
+ 		=$OFFICE_PROGRAM_PATH

This variable is used to ensure that the new C++ UNO bootstrap mechanism uses the configured office installation of the SDK. Normally the bootstrap mechanism finds the default office installation for the @@ -325,7 +322,7 @@ - - - + - + - +
LD_LIBRARY_PATH=$OO_SDK_URE_LIB_DIR: $OO_SDK_HOME/(solsparc|solintel)/lib: $LD_LIBRARY_PATH
+ 		=$OO_SDK_URE_LIB_DIR: $OO_SDK_HOME/(solsparc|solintel)/lib: $LD_LIBRARY_PATH

The LD_LIBRARY_PATH will be set or will be extended by the office/URE library path, the platform dependent lib directory for several additional libraries.

@@ -333,7 +330,7 @@
PATH=$OO_SDK_HOME/(solsparc|solintel)/bin:$OO_SDK_MAKE_HOME: $OO_SDK_ZIP_HOME: [$OO_SDK_CPP_HOME:] [$OO_SDK_JAVA_HOME/bin:] $OO_SDK_URE_BIN_DIR: $PATH
+ 		=$OO_SDK_HOME/(solsparc|solintel)/bin:$OO_SDK_MAKE_HOME: $OO_SDK_ZIP_HOME: [$OO_SDK_CPP_HOME:] [$OO_SDK_JAVA_HOME/bin:] $OO_SDK_URE_BIN_DIR: $PATH

The PATH variable will be extended by the paths for the SDK development tools, the compiler, the JDK, GNU make, the zip tool and the OO_SDK_URE_BIN_DIR, where the compiler or the JDK are @@ -351,7 +348,7 @@ - - - + - + - +
LD_LIBRARY_PATH=$OO_SDK_URE_LIB_DIR: $SDK_HOME/linux/lib: $LD_LIBRARY_PATH
+ 		=$OO_SDK_URE_LIB_DIR: $SDK_HOME/linux/lib: $LD_LIBRARY_PATH

The LD_LIBRARY_PATH will be set or will be extended by the office/URE library path, the platform dependent lib directory for some additional libraries.

@@ -359,7 +356,7 @@
PATH=$OO_SDK_HOME/linux/bin:$OO_SDK_MAKE_HOME: $OO_SDK_ZIP_HOME: [$OO_SDK_CPP_HOME:] [$OO_SDK_JAVA_HOME/bin:] $OO_SDK_URE_BIN_DIR: $PATH
+ 		=$OO_SDK_HOME/linux/bin:$OO_SDK_MAKE_HOME: $OO_SDK_ZIP_HOME: [$OO_SDK_CPP_HOME:] [$OO_SDK_JAVA_HOME/bin:] $OO_SDK_URE_BIN_DIR: $PATH

The PATH variable will be extended by the paths for the SDK development tools, the compiler, the JDK, GNU make, the zip tool and the OO_SDK_URE_BIN_DIR, where the compiler and the JDK are @@ -377,7 +374,7 @@ - - @@ -411,11 +408,11 @@

Copyright © 2000, 2013 LibreOffice contributors and/or their affiliates. All rights reserved. -
+
LibreOffice was created by The Document Foundation, based on Apache OpenOffice, which is Copyright 2011 The Apache Software Foundation. -
+
The Document Foundation acknowledges all community members, please find more info at our website.

@@ -429,6 +426,7 @@

+ diff --git a/odk/docs/tools.html b/odk/docs/tools.html index 364cb090b25a..ffac2d8283e5 100644 --- a/odk/docs/tools.html +++ b/odk/docs/tools.html @@ -19,9 +19,8 @@ LibreOffice %PRODUCT_RELEASE% SDK - Development Tools - - - + + @@ -40,29 +39,29 @@

Development Tools

-
PATH=%OO_SDK_HOME%\windows\bin; %OO_SDK_MAKE_HOME%; %OO_SDK_ZIP_HOME%; [%OO_SDK_CLI_HOME%;] [%OO_SDK_CPP_HOME%;] [%OO_SDK_JAVA_HOME%\bin;] %OO_SDK_URE_BIN_DIR%; %PATH%
+ 		=%OO_SDK_HOME%\windows\bin; %OO_SDK_MAKE_HOME%; %OO_SDK_ZIP_HOME%; [%OO_SDK_CLI_HOME%;] [%OO_SDK_CPP_HOME%;] [%OO_SDK_JAVA_HOME%\bin;] %OO_SDK_URE_BIN_DIR%; %PATH%

The PATH variable will be extended by the paths for the SDK development tools, the compiler, the JDK, GNU make, the zip tool and the OO_SDK_URE_BIN_DIR.

@@ -385,7 +382,7 @@
LIB=%OO_SDK_HOME%\windows\lib; %LIB%
+ 		=%OO_SDK_HOME%\windows\lib; %LIB%

The LIB variable will be extended by the path to the import libraries that are necessary for Windows.
+
- + - + - + - + - + - + - + - + - + - + - + - + - + - +
- + - + - + - + - + - + - + - + - + - +
- + - + - + - + - + - + - + - + - + - + - + - +
unopkg The new UNO package deployment tool. It comes with the office installation and can be found in the program directory of the office installation.
uno Tool to provide a UNO runtime environment and provide configured (deployed) or single components. This tool @@ -70,59 +69,59 @@ directory of the office installation.
regmerge Tool to merge several registry (e.g. type libraries) files into one file. Note: Since OpenOffice.org 3 it is not longer part of the SDK but it comes directly with the office as part of the ure.
regview Tool to view the content of a registry file in a human readable manner. Special support for type library nodes. Note: Since OpenOffice.org 3 it is not longer part of the SDK but it comes directly with the office as part of the ure.
idlc The UNOIDL compiler, generates a common binary type library format as base for all codemaker tools and the UNO runtime type library.
cppumaker Tool for generating C++ code for the UNOIDL types stored in a type library.
javamaker Tool for generating Java class files for the UNOIDL types stored in a type library.
climaker Tool for generating CLI assemblies for the UNOIDL types stored in a type library (windows only).
uno-skeletonmaker Tool for dumping type definitions on stdout or generating complete code skeletons for Java/C++.
regmerge Tool to merge several registry (e.g. type libraries) files into one file.
regview Tool to view the content of a registry file in a human readable manner. Special support for type library @@ -133,20 +132,20 @@
+ +
unopkg - -
@@ -164,17 +163,16 @@

Usage:

- unopkg add <options> package-path...
- unopkg remove <options> package-name...
- unopkg list <options> package-name...
- unopkg reinstall <options>
- unopkg gui
- unopkg -V
- unopkg -h
+ unopkg add <options> package-path...
+ unopkg remove <options> package-name...
+ unopkg list <options> package-name...
+ unopkg reinstall <options>
+ unopkg gui
+ unopkg -V
+ unopkg -h

Sub-commands:

-

@@ -199,9 +197,7 @@ (GUI)
add
-

Options:

-

@@ -223,7 +219,7 @@ + <cache-dir>/log.txt. @@ -232,30 +228,29 @@ running! -
-h, --help
--log-file <file> custom log file; default: - <cache-dir>/log.txt.
--shared
--deployment-context <context> + --deployment-context <context> expert feature: explicit deployment context
-

@@ -271,14 +266,14 @@

The starter loads the component and instantiates it. The component must export the interface com.sun.star.lang.XMain:

- interface XMain : com::sun::star::uno::XInterface
- {
-     /** This method is called to run the component.
-        
-         @param aArguments command line arguments
-         @return process error code to be returned to system
-     */
-     long run( [in] sequence< string > arguments );
+ interface XMain : com::sun::star::uno::XInterface
+ {
+     /** This method is called to run the component.
+        
+         @param aArguments command line arguments
+         @return process error code to be returned to system
+     */
+     long run( [in] sequence< string > arguments );
};

@@ -289,14 +284,13 @@

Usage:

uno (-c<ComponentImplementationName> -l <LocationUrl> - | -s <ServiceName>)
- [-u uno:(socket[,host=<HostName>][,port=<nnn>]|pipe[,name=<PipeName>]);iiop|urp;<Name>
- [--singleaccept] [--singleinstance]]
+ | -s <ServiceName>)
+ [-u uno:(socket[,host=<HostName>][,port=<nnn>]|pipe[,name=<PipeName>]);iiop|urp;<Name>
+ [--singleaccept] [--singleinstance]]
[-- <Argument1 Argument2 ...>]

Options:

-

uno - - + +
@@ -329,25 +323,24 @@

You can easily connect to a server started with the -u (url) option by using this service, giving the same url to resolve. The service provides you an instance from remote.

-

<HostName>
@@ -355,13 +348,12 @@

'idlc' is the UNOIDL compiler. It is a full featured compiler used to check UNODL type definitions and transform valid type definitions into a binary type library format, which is later used by all codemaker - tools. It is also used as a dynamic type library for UNO at runtime.
+ tools. It is also used as a dynamic type library for UNO at runtime.
You can find a syntax description for UNOIDL here.

Usage:

idlc [-options] file_1 ... file_n | @<filename>
-

idlc - - + +
@@ -374,9 +366,7 @@ file.
file_1 ... file_n
-

Options:

-

@@ -404,32 +394,31 @@
-O<path>print this help message and exit.
-

cppumaker - - + +

The 'cppumaker' generates a C++ representation for idl types. The cppumaker works on a typelibrary, which is generated by the UNOIDL - compiler ( + compiler ( idlc). It generates the output for all specified types and for all types the specified types depend on.

Usage:

@@ -437,7 +426,6 @@ cppumaker [-options] file_1 ... file_n

Options:

-

@@ -446,7 +434,7 @@ directory. -
-O<path>
-T<name>
+ 		-T<name>
|-T<t1>;<t2>...		 name specifies a type or a list of types. The output for this type and all dependent types are generated. If no '-T' @@ -494,32 +482,31 @@ for generation.
-

javamaker - - + +

The 'javamaker' generates the appropriate Java class file for each idl type. The javamaker works on a typelibrary which is generated by the - UNOIDL compiler ( + UNOIDL compiler ( idlc). It generates the output for all specified types and for all types the specified types depend on.

Usage:

@@ -527,7 +514,6 @@ types the specified types depend on.

javamaker [-options] file_1 ... file_n -Xfile_n+1 -Xfile_n+2

Options:

-

@@ -572,32 +558,31 @@ types the specified types depend on.

for generation.
-O<path>
-

climaker - - + +

The 'climaker' (windows only) generates the appropriate CLI assemblies file for each idl type. The climaker works on a typelibrary which is generated by the - UNOIDL compiler ( + UNOIDL compiler ( idlc). It generates the output for all specified types and for all types the specified types depend on.

Usage:

@@ -605,11 +590,10 @@ types the specified types depend on.

climaker <switches> [registry-file-1 registry-file-2 ...]

Options:

-

- @@ -665,26 +649,25 @@ types the specified types depend on.

-O, --out <output_file>output assembly file;
+ 		output assembly file;
defaults to cli_unotypes.dll if more than one registry-file is given, else <registry-file>.dll
-

Example: climaker --out cli_mytypes.dll --reference cli_uretypes.dll --extra types.rdb mytypes.rdb
@@ -693,16 +676,15 @@ types the specified types depend on.

Usage:

- uno-skeletonmaker (-env:INIFILENAME=<url> | -env:UNO_TYPES=<url>) dump [<options>] -t <type> ...
- uno-skeletonmaker (-env:INIFILENAME=<url> | -env:UNO_TYPES=<url>) component [<options>] -n <name> -t <type> ...
- uno-skeletonmaker (-env:INIFILENAME=<url> | -env:UNO_TYPES=<url>) calc-add-in [<options>] -n <name> -t <add-in_service>
+ uno-skeletonmaker (-env:INIFILENAME=<url> | -env:UNO_TYPES=<url>) dump [<options>] -t <type> ...
+ uno-skeletonmaker (-env:INIFILENAME=<url> | -env:UNO_TYPES=<url>) component [<options>] -n <name> -t <type> ...
+ uno-skeletonmaker (-env:INIFILENAME=<url> | -env:UNO_TYPES=<url>) calc-add-in [<options>] -n <name> -t <add-in_service>
uno-skeletonmaker (-env:INIFILENAME=<url> | -env:UNO_TYPES=<url>) add-on [<options>] -n <name> -p <protocol_name:command,...> - uno-skeletonmaker -V, --version
- uno-skeletonmaker -h, --help
+ uno-skeletonmaker -V, --version
+ uno-skeletonmaker -h, --help

Sub-commands:

-

uno-skeletonmaker - - + +
@@ -721,9 +703,7 @@ types the specified types depend on.

dump generates a language specific code skeleton for an add-on compnent using the implementation name as the file and class name. The protocol name(s) and the corresponding command(s) have to be specified with the '-p' option.
-

Options:

-

@@ -739,9 +719,9 @@ types the specified types depend on.

- @@ -757,7 +737,7 @@ types the specified types depend on.

- + @@ -793,25 +773,24 @@ types the specified types depend on.

-env:INIFILENAME=<url>
--(java4|java5|cpp)select the target language
- --java4 generate output for Java 1.4 or earlier
- --java5 generate output for Java 1.5 or later (is currently the default)
+ 		select the target language
+ --java4 generate output for Java 1.4 or earlier
+ --java5 generate output for Java 1.5 or later (is currently the default)
--cpp generate output for C++
generates a default LibreOffice MPLv2 license header at the beginning of a component source file. This option is taken into account in 'component' mode only and if -o is unequal 'stdout'.
-bc
--backward-compatible		-bc
--backward-compatible		 specifies that the generated calc add-in is backward compatible to older office versions and implement the former required add-in interfaces where the implementation is mapped on the new add-in configuration. In this case the config schema needs to be bundled with the extension add-in as well. Default is a minimal add-in component skeleton based on the add-in configuration coming with the office since OO.org 2.0.4.
print this help and exit.
-

@@ -825,7 +804,6 @@ types the specified types depend on.

regmerge [-v|--verbose] <mergefile> <mergeKeyName> <regfile_1> ... <regfile_n>

Options:

-

regmerge - - + +
@@ -847,25 +825,24 @@ types the specified types depend on.

merged.
-v|--verbose
-

@@ -878,10 +855,9 @@ types the specified types depend on.

regview <registryfile> [<keyName>]

Options:

-

regview - - + +
- + @@ -894,25 +870,24 @@ types the specified types depend on.

content of the registry file.
-br<registryfile>-br<registryfile> the name of the registry whose contents should be viewed.
-

@@ -928,7 +903,7 @@ types the specified types depend on.

autodoc - - + +
@@ -936,11 +911,11 @@ types the specified types depend on.

Copyright © 2000, 2013 LibreOffice contributors and/or their affiliates. All rights reserved. -
+
LibreOffice was created by The Document Foundation, based on Apache OpenOffice, which is Copyright 2011 The Apache Software Foundation. -
+
The Document Foundation acknowledges all community members, please find more info at our website.

@@ -954,6 +929,7 @@ types the specified types depend on.

+ -- cgit