View | Details | Raw Unified | Return to issue 78082
Collapse All | Expand All

(-)Extensions.xhtml (-1 / +10 lines)
Lines 255-260 Link Here
255
     <p class="TextInTable">dep:name </p>
255
     <p class="TextInTable">dep:name </p>
256
    </td><td style="text-align:left;width:12.003cm; " class="Table6B2">
256
    </td><td style="text-align:left;width:12.003cm; " class="Table6B2">
257
     <p class="TextInTable">Required. The string “<span class="Codeintext">OpenOffice.org </span><span class="Codeintext"><span class="Variable">value</span></span>” (where <span class="Variable">value</span> is the value of the attribute <span class="Codeintext">value</span>).</p>
257
     <p class="TextInTable">Required. The string “<span class="Codeintext">OpenOffice.org </span><span class="Codeintext"><span class="Variable">value</span></span>” (where <span class="Variable">value</span> is the value of the attribute <span class="Codeintext">value</span>).</p>
258
    </td></tr><tr><td style="text-align: left; width: 3.466cm;" class="Table6A2">
259
     <p class="TextInTable">dep:OpenOffice.org-minimal-version</p>
260
    </td><td style="text-align: left; width: 12.003cm;" class="Table6B2">
261
     <p class="TextInTable">Optional. This attribute should never be used with this element.</p>
258
    </td></tr><tr><td style="text-align:left;width:3.466cm; " class="Table6A2">
262
    </td></tr><tr><td style="text-align:left;width:3.466cm; " class="Table6A2">
259
     <p class="TextInTable">value </p>
263
     <p class="TextInTable">value </p>
260
    </td><td style="text-align:left;width:12.003cm; " class="Table6B2">
264
    </td><td style="text-align:left;width:12.003cm; " class="Table6B2">
Lines 406-412 Link Here
406
  <p class="Paragraph">The only actual dependency currently defined is &lt;OpenOffice.org-minimal-version value=“<span class="Variable">X</span>”&gt;, where <span class="Variable">X</span> is the required underlying OpenOffice.org version (“<span class="Codeintext">2.1</span>”, “<span class="Codeintext">2.2</span>”, etc.), starting with OpenOffice.org 2.1. (Even if an extension is installed in a derived product like StarOffice, this dependency is on the underlying OpenOffice.org version.)</p>
410
  <p class="Paragraph">The only actual dependency currently defined is &lt;OpenOffice.org-minimal-version value=“<span class="Variable">X</span>”&gt;, where <span class="Variable">X</span> is the required underlying OpenOffice.org version (“<span class="Codeintext">2.1</span>”, “<span class="Codeintext">2.2</span>”, etc.), starting with OpenOffice.org 2.1. (Even if an extension is installed in a derived product like StarOffice, this dependency is on the underlying OpenOffice.org version.)</p>
407
  <p class="Paragraph">OOo 2.0.3 and earlier are not prepared to correctly handle extensions with dependencies. In OOo 2.0.3 and earlier, if a <span class="CODE">.uno.pkg</span> (or <span class="CODE">.zip</span>) extension specifies any dependencies, they are effectively ignored and the extension is installed nonetheless. An <span class="CODE">.oxt</span> extension cannot be installed at all in OOo 2.0.3 and earlier. So, if an extension shall run in any OOo version, it should be named <span class="CODE">.uno.pkg</span> and should not specify any dependencies; if an extension shall only run in OOo 2.0.4 and later, it should be named <span class="CODE">.oxt</span> and should not specify any dependencies; and if an extension shall only run in a future OOo version, it should be named <span class="CODE">.oxt</span> and should specify the appropriate dependencies (which will be defined by the time the given OOo version is available).</p>
411
  <p class="Paragraph">OOo 2.0.3 and earlier are not prepared to correctly handle extensions with dependencies. In OOo 2.0.3 and earlier, if a <span class="CODE">.uno.pkg</span> (or <span class="CODE">.zip</span>) extension specifies any dependencies, they are effectively ignored and the extension is installed nonetheless. An <span class="CODE">.oxt</span> extension cannot be installed at all in OOo 2.0.3 and earlier. So, if an extension shall run in any OOo version, it should be named <span class="CODE">.uno.pkg</span> and should not specify any dependencies; if an extension shall only run in OOo 2.0.4 and later, it should be named <span class="CODE">.oxt</span> and should not specify any dependencies; and if an extension shall only run in a future OOo version, it should be named <span class="CODE">.oxt</span> and should specify the appropriate dependencies (which will be defined by the time the given OOo version is available).</p>
408
  <p class="Paragraph">There is a certain dilemma: On the one hand, nothing is yet known about the kinds of dependencies that will be defined in the future. On the other hand, at least some information about the unsatisfied dependencies of a future extension must be displayed in OOo 2.0.4. Therefore, each dependency specified by an extension must contain a human-readable (non-localized, English) <span class="Emphasis">name</span> that can be displayed to the user, conveying at least rudimentary information about the nature of the unsatisfied dependency. Future versions of OOo that already know a certain kind of dependency are expected to display more detailed information.</p>
412
  <p class="Paragraph">There is a certain dilemma: On the one hand, nothing is yet known about the kinds of dependencies that will be defined in the future. On the other hand, at least some information about the unsatisfied dependencies of a future extension must be displayed in OOo 2.0.4. Therefore, each dependency specified by an extension must contain a human-readable (non-localized, English) <span class="Emphasis">name</span> that can be displayed to the user, conveying at least rudimentary information about the nature of the unsatisfied dependency. Future versions of OOo that already know a certain kind of dependency are expected to display more detailed information.</p>
409
  <p class="Paragraph">Within the description.xml, dependencies are recorded as follows: An XML element whose name consists of the namespace name <span class="CODE">http://openoffice.org/extensions/description/2006</span> and the local part <span class="CODE">dependencies</span> may appear at most once as a child of the root element. This element has as its element content an arbitrary number of child elements that are not further constrained expect for the following: Each such child element should have an attribute whose name consists of the namespace  name <span class="CODE">http://openoffice.org/extensions/description/2006</span> and the local part <span class="CODE">name</span>. Each such child element represents one dependency, and the value of its <span class="CODE">name</span> attribute shall contain the human-readable dependency name (and the value, after normalization, should not be empty).</p>
413
  <p class="Paragraph">Likewise, when new dependencies are defined over time, old versions of OOo will not know about them. Those old OOo versions will thus reject extensions making use of those dependencies, even if the old OOo versions would actually satisfy the dependencies. Therefore, each dependency specified by an extension may optionally contain an <span class="CODE">OpenOffice.org-minimal-version</span> attribute that specifies the minimal version of OOo that would satisfy the dependency. Old versions of OOo that do not know the given dependency will then check for the optional attribute and, if present, nevertheless accept the dependency if the given version is large enough. This feature is only supported since OOo 2.3.</p>
414
  <p class="Paragraph">Within the description.xml, dependencies are recorded as follows: An XML element whose name consists of the namespace name <span class="CODE">http://openoffice.org/extensions/description/2006</span> and the local part <span class="CODE">dependencies</span> may appear at most once as a child of the root element. This element has as its element content an arbitrary number of child elements that are not further constrained expect for the following: Each such child element should have an attribute whose name consists of the namespace name <span class="CODE">http://openoffice.org/extensions/description/2006</span> and the local part <span class="CODE">name</span>, and it may optionally have an attribute whose name consists of the namespace name <span class="CODE">http://openoffice.org/extensions/description/2006</span> and the local part <span class="CODE">OpenOffice.org-minimal-version</span>. Each such child element represents one dependency, and the value of its <span class="CODE">name</span> attribute shall contain the human-readable dependency name (and the value, after normalization, should not be empty).</p>
410
  <p class="Paragraph">If an extensions is either not of type <span class="CODE">.oxt</span>, <span class="CODE">.uno.pkg</span>, or <span class="CODE">.zip</span>, or does not contain a description.xml, or the description.xml does not contain a <span class="CODE">dependencies</span> element, or the <span class="CODE">dependencies</span> element does not contain any child elements, then the extension does not specify any dependencies.</p>
415
  <p class="Paragraph">If an extensions is either not of type <span class="CODE">.oxt</span>, <span class="CODE">.uno.pkg</span>, or <span class="CODE">.zip</span>, or does not contain a description.xml, or the description.xml does not contain a <span class="CODE">dependencies</span> element, or the <span class="CODE">dependencies</span> element does not contain any child elements, then the extension does not specify any dependencies.</p>
411
  <h2 class="Head2"><a name="1_8_System_Integration"/>5.8  System Integration</h2>
416
  <h2 class="Head2"><a name="1_8_System_Integration"/>5.8  System Integration</h2>
412
  <p class="Paragraph">When installing OpenOffice.org, the installation routine  is adding information to the system which can be used by other software products to install extensions.  For example, double-clicking on an extension in a file browser should start the Extension Manager and install the extension. Also mail clients and web browser should offer a way of installing the extension, when it comes as an attachment of an e-mail or is the target of a link.</p>
417
  <p class="Paragraph">When installing OpenOffice.org, the installation routine  is adding information to the system which can be used by other software products to install extensions.  For example, double-clicking on an extension in a file browser should start the Extension Manager and install the extension. Also mail clients and web browser should offer a way of installing the extension, when it comes as an attachment of an e-mail or is the target of a link.</p>
Lines 559-564 Link Here
559
     <p class="TextInTable">dep:name </p>
564
     <p class="TextInTable">dep:name </p>
560
    </td><td style="text-align:left;width:12.003cm; " class="Table12B2">
565
    </td><td style="text-align:left;width:12.003cm; " class="Table12B2">
561
     <p class="TextInTable">Required. The string “<span class="Codeintext">OpenOffice.org </span><span class="Codeintext"><span class="Variable">value</span></span>” (where <span class="Variable">value</span> is the value of the attribute <span class="Codeintext">value</span>).</p>
566
     <p class="TextInTable">Required. The string “<span class="Codeintext">OpenOffice.org </span><span class="Codeintext"><span class="Variable">value</span></span>” (where <span class="Variable">value</span> is the value of the attribute <span class="Codeintext">value</span>).</p>
567
    </td></tr><tr><td style="text-align: left; width: 3.466cm;" class="Table6A2">
568
     <p class="TextInTable">dep:OpenOffice.org-minimal-version</p>
569
    </td><td style="text-align: left; width: 12.003cm;" class="Table6B2">
570
     <p class="TextInTable">Optional. This attribute should never be used with this element.</p>
562
    </td></tr><tr><td style="text-align:left;width:3.466cm; " class="Table12A2">
571
    </td></tr><tr><td style="text-align:left;width:3.466cm; " class="Table12A2">
563
     <p class="TextInTable">value </p>
572
     <p class="TextInTable">value </p>
564
    </td><td style="text-align:left;width:12.003cm; " class="Table12B2">
573
    </td><td style="text-align:left;width:12.003cm; " class="Table12B2">

Return to issue 78082