diff options
author | Michael Stahl <mstahl@redhat.com> | 2013-05-03 00:27:05 +0200 |
---|---|---|
committer | Michael Stahl <mstahl@redhat.com> | 2013-06-04 12:01:09 +0200 |
commit | baa69cccf38c848940061fb2d3fec5034ae31d6b (patch) | |
tree | 18cfdbf39886b98109db86e6e460429e8adb34f9 /offapi | |
parent | bcfcd0eb564e7d5d706f47dab30b074fd6233d97 (diff) |
offapi: fix another mangled comment
Change-Id: I76b531238d86c9f2ed444d230638ffb9a2d62618
Diffstat (limited to 'offapi')
-rw-r--r-- | offapi/com/sun/star/util/PathSubstitution.idl | 58 |
1 files changed, 29 insertions, 29 deletions
diff --git a/offapi/com/sun/star/util/PathSubstitution.idl b/offapi/com/sun/star/util/PathSubstitution.idl index 7a09375e7f81..14d1ce99ec9a 100644 --- a/offapi/com/sun/star/util/PathSubstitution.idl +++ b/offapi/com/sun/star/util/PathSubstitution.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module util { /** A service to support the substitution and resubstitution of path variables. - <p> + <p> A path variable must be specified with the following syntax: "$("<variable-name>")". Path variables are not case sensitive and are always provided as a UCB-compliant URLs (for example: "file:///c:/temp" or "file:///usr/install"). This is mandatory to support an @@ -39,40 +39,40 @@ module com { module sun { module star { module util { configuration file (org/openoffice/Office/Substitution.xml). Please have a look at the schema definition file which configuration structure this file uses.<br> There is also a set of variables that have pre-defined values: - </p> - <dl> - <dt>$(inst)</dt> - <dd>Installation path of the Office.</dd> - <dt>$(prog)</dt> - <dd>Program path of the Office.</dd> - <dt>$(user)</dt> - <dd>The user installation directory.</dd> - <dt>$(work)</dt> - <dd>The work directory of the user. Under Windows this would be the + </p> + <dl> + <dt>\$(inst)</dt> + <dd>Installation path of the Office.</dd> + <dt>\$(prog)</dt> + <dd>Program path of the Office.</dd> + <dt>\$(user)</dt> + <dd>The user installation directory.</dd> + <dt>\$(work)</dt> + <dd>The work directory of the user. Under Windows this would be the "MyDocuments" subdirectory. Under Unix this would be the home-directory</dd> - <dt>$(home)</dt> - <dd>The home directory of the user. Under Unix this would be the home- - directory. Under Windows this would be the "Documents and Settings\<username>" - subdirectory.</dd> - <dt>$(temp)</dt> - <dd>The current temporary directory.</dd> - <dt>$(path)</dt> - <dd>The value of PATH environment variable.</dd> - <dt>$(lang)</dt> - <dd>The country code used by the Office, like 01=English, 49=German.</dd> - <dt>$(langid)</dt> - <dd>The language code used by the Office, like 0x0009=English, 0x0409=English US.</dd> - <dt>$(vlang)</dt> - <dd>The language used by the Office as a string. Like "German" for a German Office.</dd> - </dl> - <p> + <dt>\$(home)</dt> + <dd>The home directory of the user. Under Unix this would be the home- + directory. Under Windows this would be the "Documents and Settings\<username>" + subdirectory.</dd> + <dt>\$(temp)</dt> + <dd>The current temporary directory.</dd> + <dt>\$(path)</dt> + <dd>The value of PATH environment variable.</dd> + <dt>\$(lang)</dt> + <dd>The country code used by the Office, like 01=English, 49=German.</dd> + <dt>\$(langid)</dt> + <dd>The language code used by the Office, like 0x0009=English, 0x0409=English US.</dd> + <dt>\$(vlang)</dt> + <dd>The language used by the Office as a string. Like "German" for a German Office.</dd> + </dl> + <p> Attention: Most predefined variables describe an absolute path. - The only exceptions are: $(lang), $(langid) and $(vlang). + The only exceptions are: \$(lang), \$(langid) and \$(vlang). Therefore the service implementation should only substitute variables which are located at the start of a provided path string or are part of a multi-path. This special service is not designed to be a text substiution but shall provide (a) valid substituted path(s). - </p> + </p> @since OOo 1.1.2 */ |