diff options
| author | Rüdiger Timm <rt@openoffice.org> | 2008-07-11 13:15:16 +0000 |
|---|---|---|
| committer | Rüdiger Timm <rt@openoffice.org> | 2008-07-11 13:15:16 +0000 |
| commit | 3333569a15682b8b737896c4dac58ec568342444 (patch) | |
| tree | 1a183d35f8a453ea18d119010640bf47737de803 /odk/docs | |
| parent | 93532bf025862184bdcc29e11a187789d60d10fa (diff) | |
INTEGRATION: CWS jsc21 (1.21.2); FILE MERGED
2008/07/03 16:02:02 jsc 1.21.2.1: #88797# rework optional module, make standalone product
Diffstat (limited to 'odk/docs')
| -rw-r--r-- | odk/docs/tools.html | 195 |
1 files changed, 2 insertions, 193 deletions
diff --git a/odk/docs/tools.html b/odk/docs/tools.html index ee92a4d51b7b..3e352f987767 100644 --- a/odk/docs/tools.html +++ b/odk/docs/tools.html @@ -1,6 +1,6 @@ <html> <head> - <title>StarOffice 8 SDK - Development Tools</title> + <title>[TITLE] SDK - Development Tools</title> <link rel="stylesheet" type="text/css" href="sdk_styles.css"> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> <meta name="author" content="Jürgen Schmidt"> @@ -80,12 +80,6 @@ </tr> <tr valign="top"> <td class="content3"><img src="images/arrow-1.gif"></td> - <td><a href="#rdbmaker" title="link to the rdbmaker tool description">rdbmaker</a></td> - <td class="content87">Tool for building type libraries with only a - specified set of types and their dependencies.</td> - </tr> - <tr valign="top"> - <td class="content3"><img src="images/arrow-1.gif"></td> <td><a href="#regcomp" title="link to the regcomp tool description">regcomp</a></td> <td class="content87">A simple UNO component registration tool.</td> </tr> @@ -104,12 +98,6 @@ </tr> <tr valign="top"> <td class="content3"><img src="images/arrow-1.gif"></td> - <td><a href="#xml2cmp" title="link to the xml2cmp tool description">xml2cmp</a></td> - <td class="content87">A small helper tool to extract different - information from xml module description files.</td> - </tr> - <tr valign="top"> - <td class="content3"><img src="images/arrow-1.gif"></td> <td><a href="#autodoc" title="link to the autodoc tool description">autodoc</a></td> <td class="content87">Tool to generate javadoc-like documentation for C/C++ and UNOIDL files.</td> @@ -140,7 +128,7 @@ office installation. UNO packages are UNO components (single libraries or Jar files or more complex zip files that contains one or more libraries| Jar files, type libraries and configuration items), scripts and - StarOffice 8 Basic libraries as zip package. 'unopkg' is not part of the + [PRODUCTNAME] Basic libraries as zip package. 'unopkg' is not part of the SDK but comes with the office directly and is a development tool as well as an end user tool to deploy extension into an office installation.</p> <p>More details concerning deployment and this tool can be find in the @@ -710,95 +698,6 @@ types the specified types depend on.</p> <td> <table class="table2"> <tr> - <td colspan="2" class="head1"><a name="rdbmaker"/>rdbmaker</td> - <td align="right"> - <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"></a> - <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a> - </td> - </tr> - <tr> - <td colspan="3"> - <p>The rdbmaker generates subsets of the typelibrary. It generates a - subset of the typelibrary, which contains all specified types and all - types the specified types depend on. This can be used to provide all - and only necessary types for a component.</p> - <p>The rdbmaker supports 2 modes:<br> - <ol> - <li>using the internal UNO type description manager -> use - -R<regname><br> - where regname specifies the type library used by the UNO type description - manager after UNO is bootstrapped. This option disables the use of any - other type libraries. - <li>using one or more type library files -> use file_1 ... file_n<br> - file_1 .. file_n specifies one or more valid type library files which - are used to find the needed type information. The used type libraries - have to support the same base node (-B option). - </ol> - </p> - <p class="head2">Usage:</p> - <blockquote> - <b><code>rdbmaker [-options] (-R<regname> | file_1 [... file_n])</code></b> - </blockquote> - <p class="head2">Options:</p> - <p> - <table class="table4"> - <tr> - <td class="cell15"><code>-O<fileName></code></td> - <td class="cell85">filename specifies the name of the generated - registry or text file.</td> - </tr> - <tr> - <td class="cell15"><code>-L</code></td> - <td class="cell85">specifies that only a text file is generated - with the names of the specified types and their dependencies. Default - is that a registry file will be created.</td> - </tr> - <tr> - <td class="cell15"><code>-T<name><br> - |-T<t1>;<t2>...</code></td> - <td class="cell85">name specifies a type or a list of types. The - output for this type is generated.Example: 'com.sun.star.uno.XInterface' - is a valid type.</td> - </tr> - <tr> - <td class="cell15"><code>-FT<name><br> - |-T<t1>;<t2>...</code></td> - <td class="cell85">name specifies a type or a list of types. For - this type, nothing will be generated.</td> - </tr> - <tr> - <td class="cell15"><code>-F<file></code></td> - <td class="cell85">file specifies a text file. For the specified - types in this file, nothing will be generated.</td> - </tr> - <tr> - <td class="cell15"><code>-B<name></code></td> - <td class="cell85">name specifies the base node. All types are - searched under this node. Default is the root '/' of the registry - files. This option takes effect using run mode 2 only.</td> - </tr> - <tr> - <td class="cell15"><code>-b<name></code></td> - <td class="cell85">name specifies the base node of the output - registry. All types will be generated under this node. Default is the - root '/' of the registry file.</td> - </tr> - </table> - </p> - </td> - </tr> - </table> - </td> - <td class="content1"><img class="nothing8" src="images/nada.gif"></td> - </tr> - <tr> - <td colspan="3"><img class="line" src="images/sdk_line-2.gif"></td> - </tr> - <tr> - <td class="content1"><img class="nothing8" src="images/nada.gif"></td> - <td> - <table class="table2"> - <tr> <td colspan="2" class="head1"><a name="regcomp"/>regcomp</td> <td align="right"> <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"></a> @@ -963,96 +862,6 @@ types the specified types depend on.</p> <td> <table class="table2"> <tr> - <td colspan="2" class="head1"><a name="xml2cmp"/>xml2cmp</td> - <td align="right"> - <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"></a> - <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a> - </td> - </tr> - <tr> - <td colspan="3"> - <p>The 'xml2cmp' tool parses .xml files, which contain the descriptions - of components that implement UNO services. Each .xml file refers to one - library. The library may contain one or more component descriptions.<br> - There are two ways of using xml2cmp:</p> - <p class="head2">Usage:</p> - <blockquote> - <b><code>xml2cmp [-func <funcFile>] [-html <htmlFile>] [-types <typeFile>] <Xml_FileName></code></b> - </blockquote> - <p>This version parses the file <xml_filename> and produces three - possible types of output, each of which is optional, but there must be at - least one of them.</p> - <p class="head2">Options:</p> - <p> - <table width=100% border=1 cellpadding=4 cellspacing=0> - <tr> - <td class="cell15"><code>-func <funcFile></code></td> - <td class="cell85">produces a file with the name - <code><funcfile></code>. This should be .c|.cxx|.cpp or similar - kind of source code file. This file contains the definition of the - function <code>'const sal_Char * SAL_CALL - component_getDescriptionFunc();'</code> which returns the parsed - file as ASCII text.</td> - </tr> - <tr> - <td class="cell15"><code>-html <htmlFile></code></td> - <td class="cell85">produces a file with the name - <code><htmlfile></code>. It should be a .htm|.html file. That - file contains the contents of the parsed file in HTML-readable - form.</td> - </tr> - <tr> - <td class="cell15"><code>-types <typeFile></code></td> - <td class="cell85">produces a textfile with the name - <code><typefile></code>. This textfile is intended to be - included in a makefile and contains the definition of a variable<br> - <br><code> - <libraryName>_XML2CMPTYPES= \<br> - <type_used_by_LibraryName_1> \<br> - <type_used_by_LibraryName_2> \<br> - ... <br> - </code><br> - The variable <libraryName>_XML2CMPTYPES contains a list of the - types used by that library.</td> - </tr> - </table> - </p> - <p>All output of this first version of xml2cmp is put into the working - directory.</p> - <blockquote> - <b><code>xml2cmp -ix <sourcedirectory> <outputdirectory> [<tagname1> [<tagname2> ...]]</code></b> - </blockquote> - <p>This version parses all .xml files that are found in - <code><sourcedirectory></code> or its subdirectories. It produces - the .html output of all parsed .xml files (as in version 1 above). Also, - it produces a file named xmlindex.html. This is an HTML file which - contains tables alphabetically ordered on the left side, which allows - assigning from one 'XML-tags' content to another (of all original - parsed .xml files). The following tables are produced ("Module - " refers to a library):</p> - <blockquote> - <code>SupportedService -> ModuleName<br> - ModuleName -> SupportedService<br> - <tagname1> -> ComponentName<br> - <tagname2> -> ComponentName<br> - ...</code> - </blockquote> - <p>All output files of the second version of xml2cmp are put to the - <outputDirectory></p> - </td> - </tr> - </table> - </td> - <td class="content1"><img class="nothing8" src="images/nada.gif"></td> - </tr> - <tr> - <td colspan="3"><img class="line" src="images/sdk_line-2.gif"></td> - </tr> - <tr> - <td class="content1"><img class="nothing8" src="images/nada.gif"></td> - <td> - <table class="table2"> - <tr> <td colspan="2" class="head1"><a name="autodoc"/>autodoc</td> <td align="right"> <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"></a> |