Apache OpenOffice Wiki - User contributions [en]

https://wiki.openoffice.org/w/api.php?action=feedcontributions&feedformat=atom&user=Od Apache OpenOffice Wiki - User contributions [en] 2026-05-25T09:50:14Z User contributions MediaWiki 1.35.14 https://wiki.openoffice.org/w/index.php?title=Update_Service&diff=235527 Update Service 2014-08-19T12:57:50Z

<p>Od: /* Available Update Feeds */</p> <hr /> <div>== Introduction ==<br /> The Update Service for AOO/OOo is a service which provides via HTTP or HTTPS an Update Feed (or an Update Document) for installed AOO/OOo instances. This allows a requesting AOO/OOo instance to check, if a new AOO version is available and to provide the result of this check to the user.<br /> <br /> Currently, the Update Service is implemented via static HTTP/HTTPS resources. No dynamic component is involved which processes the information given in the HTTP/HTTPS request of the AOO/OOo instance in order to generate a response.<br /> <br /> = Available Update Feeds =<br /> <br /> For the following AOO/OOo versions an Update Feed is made available.<br /> The table contains the UpdateURL which an AOO/OOo instance of the specified version is requesting via HTTP/HTTPS and the resource in our svn repository which serves the HTTP/HTTPS resource behind the UpdateURL.<br /> <br /> {| class="wikitable" border="1"<br /> |-<br /> ! AOO/OOo version<br /> ! UpdateURL<br /> ! Resource in svn repository<br /> |-<br /> | OOo 3.2<br /> | http://www.openoffice.org/projects/update34/ProductUpdateService/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/ooo-site/trunk/content/projects/update34/ProductUpdateService/check.Update ooo-site/update34]<br /> |-<br /> | OOo 3.2.1<br /> | http://www.openoffice.org/projects/update35/ProductUpdateService/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/ooo-site/trunk/content/projects/update35/ProductUpdateService/check.Update ooo-site/update35]<br /> |-<br /> | OOo 3.3<br /> | http://www.openoffice.org/projects/update36/ProductUpdateService/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/ooo-site/trunk/content/projects/update36/ProductUpdateService/check.Update ooo-site/update36]<br /> |-<br /> | AOO 3.4.0<br /> | http://www.openoffice.org/projects/update38/ProductUpdateService/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/ooo-site/trunk/content/projects/update38/ProductUpdateService/check.Update ooo-site/update38]<br /> |-<br /> | AOO 3.4.1<br /> | http://www.openoffice.org/projects/update/aoo341/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/ooo-site/trunk/content/projects/update/aoo341/check.Update ooo-site/update/aoo341]<br /> |-<br /> | AOO 4.0.0<br /> | https://ooo-updates.apache.org/aoo40/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/updates-site/trunk/aoo40/check.Update updates-site/aoo40]<br /> |-<br /> | AOO 4.0.1<br /> | https://ooo-updates.apache.org/aoo401/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/updates-site/trunk/aoo401/check.Update updates-site/aoo401]<br /> |-<br /> | AOO 4.1.0<br /> | https://ooo-updates.apache.org/aoo410/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/updates-site/trunk/aoo401/check.Update updates-site/aoo410]<br /> |-<br /> | AOO 4.1.1<br /> currently empty<br /> | https://ooo-updates.apache.org/aoo411/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/updates-site/trunk/aoo410/check.Update updates-site/aoo411]<br /> |}<br /> <br /> The Update Feeds for versions 3.2 to 3.4.1 are part of the user website content. Thus, a changed Update Feed needs to be published - as it is needed for changed usual user website content.<br /> The Update Feeds for versions 4.0.0 to 4.1.1 only need to be changed as its publication is done automatically by certain services provided by ASF Infra.<br /> <br /> Update Feeds can be generated by using the bash script and corresponding meta data which is available at [http://svn.apache.org/repos/asf/openoffice/devtools/genUpdateFeed/ genUpdateFeed].<br /> <br /> = Update Notification Protocol =<br /> <br /> == Introduction ==<br /> <br /> Since version 2.0.3 OpenOffice.org users of builds providing an UpdateURL can manually check for available updates by invoking "Help -> Check for Updates .." . Starting with version 2.0.4 OpenOffice.org can perform this check automatically in a user configurable interval. <br /> <br /> This is an attempt to define a second version of the update notification protocol, which is better extendable, can also be used for [[Extensions | extensions]] and no longer uses http post requests.<br /> <br /> {{Documentation/Note|Note: Even though this document is a draft, it seems to be the actually implemented version as of OpenOffice.org 3.3. See http://s.apache.org/e2u for more information.}}<br /> <br /> == Request ==<br /> <br /> The update notification request is a http get request to an URL, which may contain the operating system and processor type the OpenOffice.org instance is compiled for either as part of the URL or as URL parameter.<br /> <br /> === Examples ===<br /> <br /> <pre><br /> UpdateURL=http://update.services.openoffice.org/ProductUpdateService/check.Update2?_OS=Solaris&_ARCH=SPARC<br /> </pre><br /> <br /> <pre><br /> UpdateURL=http://www.example.org/MyProduct/MyOS/MyArch<br /> </pre><br /> <br /> == User-Agent field ==<br /> <br /> To reduce the amount of transfered data when asking for OpenOffice.org updates, the user agent field contains all information required to identify a specific build: <br /> <br /> <pre><br /> User-Agent: OpenOffice.org/2.2 (680m212 (Build:9263); Solaris; SPARC; BundledLanguages=en-US_fr)<br /> </pre><br /> <br /> == Accept-Language field ==<br /> <br /> To be able to return language specific feeds, OpenOffice.org sets the Accept-Language http request header field to the UI language currently in use:<br /> <br /> <pre><br /> Accept-Language: en-GB<br /> </pre><br /> <br /> == Update documents and feeds ==<br /> <br /> The simplest possible reply is of the following form:<br /> <br /> <source lang="xml"><br /> <?xml version="1.0" encoding="utf-8"?><br /> <inst:description xmlns:inst="http://installation.openoffice.org/description"><br /> <inst:id>OpenOffice.org_2_en-US_fr</inst:id><br /> <inst:version>2.2.0-5</inst:version><br /> <inst:buildid>9095</inst:buildid><br /> <inst:os>Solaris</inst:os><br /> <inst:arch>SPARC</inst:arch><br /> <inst:update type="text/html" src="http://update.services.openoffice.org/ooo/snapshot.html" /><br /> </inst:description><br /> </source><br /> <br /> As the type attribute of the update tag is "text/html", OOo will pass the URL specified in the src attribute to a browser. If you specify a different type, e.g.<br /> <br /> <source lang="xml"><br /> <inst:update type="application/octet-stream" src="http://openoffice.bouncer.osuosl.org/?product=OpenOffice.org&os=solarissparcwjre&lang=en-US&version=2.4" /><br /> </source><br /> <br /> OOo will download the referenced file itself.<br /> <br /> <br /> The other supported reply format, which also allows to include several components or several versions of a single component, is to embed the update document in an [http://tools.ietf.org/wg/atompub/draft-ietf-atompub-format/rfc4287.txt atom feed].<br /> <br /> <source lang="xml"><br /> <?xml version="1.0" encoding="utf-8"?><br /> <feed xmlns="http://www.w3.org/2005/Atom" xml:lang”en-US”><br /> <br /> <title>OpenOffice.org Update Feed</title><br /> <link rel="alternate" type="text/html" href="http://update.services.openoffice.org/ooo/snapshot.html"/><br /> <updated>2006-11-06T18:30:02Z</updated><br /> <author><br /> <name>The OpenOffice.org Project</name><br /> <uri>http://openoffice.org</uri><br /> <email>updatefeed@openoffice.org</email><br /> </author><br /> <id>urn:uuid:a4ccd383-1dd1-11b2-a95c-0003ba566e9d</id><br /> <entry><br /> <title>OpenOffice.org 2.2 available</title><br /> <link rel="alternate" type="text/html"<br /> href="http://update.services.openoffice.org/ooo/snapshot.html"/><br /> <id>urn:uuid:a4ccd383-1dd1-11b2-a95c-0003ba566e9e</id><br /> <updated>2006-11-06T18:30:02Z</updated><br /> <summary>Click here to go to the download page.</summary><br /> <category term="OpenOffice.org_2_en-US_fr" label="OpenOffice.org 2.2 US english/french" /><br /> <content type="application/xml"><br /> <inst:description xmlns:inst="http://installation.openoffice.org/description"><br /> <inst:id>OpenOffice.org_2_en-US_fr</inst:id><br /> <inst:version>2.2.0-5</inst:version><br /> <inst:buildid>9095</inst:buildid><br /> <inst:os>Solaris</inst:os><br /> <inst:arch>SPARC</inst:arch><br /> <inst:update type="text/html" src="http://update.services.openoffice.org/ooo/snapshot.html" /><br /> </inst:description><br /> </content><br /> </entry><br /> </feed><br /> </source><br /> <br /> ''description.xml'' OpenOffice.org 3.x update information example<br /> <br /> The following content of a ''description.xml'' directly references update information for a German Windows OpenOffice.org 3.3.0:<br /> <source lang="xml"><br /> <?xml version="1.0" encoding="utf-8"?><br /> <feed xmlns="http://www.w3.org/2005/Atom" xml:lang="en-US"><br /> <title>Product Update Feed</title><br /> <link rel="alternate" type="text/html" href="http://update.services.openoffice.org/ooo/snapshot.html"/><br /> <updated>2011-01-01T08:00:02Z</updated><br /> <author><br /> <name>The OpenOffice Project</name><br /> <uri>http://openoffice.org</uri><br /> <email>updatefeed@openoffice.org</email><br /> </author><br /> <id>urn:uuid:76676544</id><br /> <entry><br /> <title>Update available</title><br /> <link rel="alternate" type="text/html" href="http://update.services.openoffice.org/ooo/snapshot.html"/><br /> <id>urn:uuid:76676544</id><br /> <br /> <category term="OpenOffice.org_3_de" label="OpenOffice.org update"/><br /> <updated>2011-01-01T08:00:02Z</updated><br /> <summary>Text below download information (should be localized)</summary><br /> <content type="application/xml"><br /> <inst:description xmlns:inst="http://installation.openoffice.org/description"><br /> <inst:id>OpenOffice.org_3_de</inst:id><br /> <inst:version>'new version information'</inst:version><br /> <br /> <inst:buildid>9580</inst:buildid><br /> <inst:os>Windows</inst:os><br /> <inst:arch>x86</inst:arch><br /> <br /> <br /> <br /> <inst:update type="text/html" src="http://download.openoffice.org"/><br /> </inst:description><br /> </content><br /> </entry><br /> </feed><br /> </source><br /> <br /> '''Note''': to allow proper filtering, the <tt>term</tt> tag of the <category> node of the <atom:entry> element must contain the <inst:id> string of the component to be updated.<br /> <br /> <br /> Extension developers might prefer to link to the update description file instead of embedding it:<br /> <br /> <source lang="xml"><br /> <?xml version="1.0" encoding="utf-8"?><br /> <feed xmlns="http://www.w3.org/2005/Atom" xml:lang”en-US”><br /> <br /> <title>My Extention Update Feed</title><br /> <link rel="alternate" type="text/html" href="http://update.services.openoffice.org/ooo/snapshot.html"/><br /> <updated>2006-11-06T18:30:02Z</updated><br /> <author><br /> <name>Extension Developer</name><br /> <uri>http://example.org</uri><br /> <email>update@example.org</email><br /> </author><br /> <id>urn:uuid:a4ccd383-1dd1-11b2-a95c-0003ba566e9d</id><br /> <entry><br /> <title>Version 2 available</title><br /> <link rel="alternate" type="text/html"<br /> href="http://example.org/myextension/latest.html"/><br /> <id>MyExtension+version</id><br /> <updated>2006-11-06T18:30:02Z</updated><br /> <category term="MyExtension" label="My Extension" /><br /> <content type="application/xml" src="http://example.org/myextension/latest/myextension.update.xml" /><br /> </entry><br /> </feed><br /> </source><br /> <br /> '''Note''': to allow proper filtering, the <tt>term</tt> tag of the <category> node of the <atom:entry> element must contain the <identifier> value of the extension to be updated.<br /> <br /> = A glance on the code for the Apache OpenOffice 3.4 release =<br /> <br /> The following describes some deeper insight of the "Check for Updates..." code in the office. It should help us to re-activate a corresponding web service when Apache OpenOffice 3.4 has been released. (Do we need a real web service? Something to be discussed.)<br /> <br /> The information given here is based on the work of Regina (regina at apache dot org), Ariel (arielch at apache dot org) and Kay (kschenk at apache dot org) found in the corresponding mailing list thread on ooo-dev - see http://s.apache.org/e2u.<br /> Having this information gave me (orw at apache dot org) the right pointers for deeper investigations.<br /> <br /> == summary information about request to <UpdateURL> ==<br /> <br /> The <UpdateURL>, found in file <version.ini> resp. <versionrc> of the office installation is typically an HTTP URL.<br /> The office sends a GET request to this URL. Two header fields are included in this request which are already mentioned above.<br /> These are "Accept-Language" and "User-Agent".<br /> * "Accept-Language" contains the language of current locale - found in configuration item "org.openoffice.Setup/L10N", attribute "ooLocale"<br /> * "User-Agent" contains needed information to identify the installed office version - see above. The information matches the following pattern which is found in file <version.ini> resp. <versionrc>:<br /> <blockquote><br /> <pre><br /> <PRODUCT> (${buildid}; ${_OS}; ${_ARCH}; BundledLanguages=${AllLanguages}) <br /> </pre><br /> </blockquote><br /> On platforms other than Windows the <UpdateURL> contains (at least since OOo 3.3) a query part. It is ''?pkgfmt=<pkgformat>'' which especially for Linux platforms identifies the package format of the office installation.<br /> <br /> It reveals that this information can be used to create the corresponding information for the request response.<br /> <br /> == information about processing the request response ==<br /> <br /> The response is expected to be a corresponding XML snippet.<br /> As shown in the above examples, two types of XML snippets as responses are possible:<br /> a ''feed'' response and a ''simple'' response. The distinction between the two is made by its first element. If it is <feed> it is treated as a ''feed'' response, otherwise as a ''simple'' response.<br /> <br /> ==== ''simple'' response ====<br /> <br /> The ''simple'' response is an XML snippet which is expected to have the format as the XML snippet in file [http://svn.apache.org/repos/asf/incubator/ooo/trunk/main/instsetoo_native/util/update.xml update.xml], found in our source repository.<br /> <br /> The following conditions must hold to perform further evaluation of the response:<br /> # value of <inst:os> matches the one of the installed office - ''${_ARCH}''.<br /> # value of <inst:arch> matches the one of the installed office - ''${_OS}''.<br /> # value of <inst:buildid> is greater than the one of the installed office - ''${buildid}''.<br /> If these conditions hold, the following information is retrieved:<br /> # values of attributes <src> and <type> of <inst:update><br /> #* if value of <type> equals "text/html", the value of <src> is taken as an website from which the new version can be downloaded manually. Otherwise (also in case that attribute <type> is missing) the value of <src> is interpreted as a download link to the new version.<br /> #* all <inst:update> elements are evaluated. The information of the first one is used - provide download of version or provide link to download website. The purpose of the other is not known.<br /> # value of <inst:version> - will be shown in the corresponding dialog.<br /> # value of <inst:buildid> - currently its purpose is not known.<br /> If the first information - download website or download link - can be found in the XML snippet, the corresponding dialog will state that a new version is available. The user can then download it manually or can trigger an automatic download.<br /> <br /> If no download website/link is found, the dialog will state that the installed office is up to date.<br /> <br /> ==== ''feed'' response ====<br /> <br /> The ''feed'' response is expected to conform to [http://tools.ietf.org/wg/atompub/draft-ietf-atompub-format/rfc4287.txt atom feed] - as stated above in the example area.<br /> Each content of the <content> element of an atom entry (<entry> element) whose <category> element has an attribute <term> whose value matches the <UpdateId> value found in file <version.ini> resp. <versionrc> of the installed office is treated as ''simple'' response. <br /> <br /> The first of these ''simple'' responses from which a download website or a download link could be retrieved that matches the above given conditions is taken - the following ones are not processed. It will be shown to the user that a new version is available, and the user can trigger the download manually or automatically. One further information is taken from this atom entry - the content of the <summary> element. It is shown in the corresponding dialog.<br /> <br /> If no download website/link is found, the dialog will state that the installed office is up to date.<br /> <br /> [[Category:Spec]]</div>

Od https://wiki.openoffice.org/w/index.php?title=Update_Service&diff=235382 Update Service 2014-07-10T10:32:07Z

<p>Od: /* Available Update Feeds */</p> <hr /> <div>== Introduction ==<br /> The Update Service for AOO/OOo is a service which provides via HTTP or HTTPS an Update Feed (or an Update Document) for installed AOO/OOo instances. This allows a requesting AOO/OOo instance to check, if a new AOO version is available and to provide the result of this check to the user.<br /> <br /> Currently, the Update Service is implemented via static HTTP/HTTPS resources. No dynamic component is involved which processes the information given in the HTTP/HTTPS request of the AOO/OOo instance in order to generate a response.<br /> <br /> = Available Update Feeds =<br /> <br /> For the following AOO/OOo versions an Update Feed is made available.<br /> The table contains the UpdateURL which an AOO/OOo instance of the specified version is requesting via HTTP/HTTPS and the resource in our svn repository which serves the HTTP/HTTPS resource behind the UpdateURL.<br /> <br /> {| class="wikitable" border="1"<br /> |-<br /> ! AOO/OOo version<br /> ! UpdateURL<br /> ! Resource in svn repository<br /> |-<br /> | OOo 3.2<br /> | http://www.openoffice.org/projects/update34/ProductUpdateService/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/ooo-site/trunk/content/projects/update34/ProductUpdateService/check.Update ooo-site/update34]<br /> |-<br /> | OOo 3.2.1<br /> | http://www.openoffice.org/projects/update35/ProductUpdateService/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/ooo-site/trunk/content/projects/update35/ProductUpdateService/check.Update ooo-site/update35]<br /> |-<br /> | OOo 3.3<br /> | http://www.openoffice.org/projects/update36/ProductUpdateService/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/ooo-site/trunk/content/projects/update36/ProductUpdateService/check.Update ooo-site/update36]<br /> |-<br /> | AOO 3.4.0<br /> | http://www.openoffice.org/projects/update38/ProductUpdateService/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/ooo-site/trunk/content/projects/update38/ProductUpdateService/check.Update ooo-site/update38]<br /> |-<br /> | AOO 3.4.1<br /> | http://www.openoffice.org/projects/update/aoo341/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/ooo-site/trunk/content/projects/update/aoo341/check.Update ooo-site/update/aoo341]<br /> |-<br /> | AOO 4.0.0<br /> | https://ooo-updates.apache.org/aoo40/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/update-site/trunk/aoo40/check.Update update-site/aoo40]<br /> |-<br /> | AOO 4.0.1<br /> | https://ooo-updates.apache.org/aoo401/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/update-site/trunk/aoo401/check.Update update-site/aoo401]<br /> |-<br /> | AOO 4.1.0<br /> | https://ooo-updates.apache.org/aoo410/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/update-site/trunk/aoo401/check.Update update-site/aoo410]<br /> |-<br /> | AOO 4.1.1<br /> [currently not active]<br /> | https://ooo-updates.apache.org/aoo411/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/update-site/trunk/aoo410/check.Update update-site/aoo411]<br /> |}<br /> <br /> Update Feeds can be generated by using the bash script and corresponding meta data which is available at [http://svn.apache.org/repos/asf/openoffice/devtools/genUpdateFeed/ genUpdateFeed].<br /> <br /> = Update Notification Protocol =<br /> <br /> == Introduction ==<br /> <br /> Since version 2.0.3 OpenOffice.org users of builds providing an UpdateURL can manually check for available updates by invoking "Help -> Check for Updates .." . Starting with version 2.0.4 OpenOffice.org can perform this check automatically in a user configurable interval. <br /> <br /> This is an attempt to define a second version of the update notification protocol, which is better extendable, can also be used for [[Extensions | extensions]] and no longer uses http post requests.<br /> <br /> {{Documentation/Note|Note: Even though this document is a draft, it seems to be the actually implemented version as of OpenOffice.org 3.3. See http://s.apache.org/e2u for more information.}}<br /> <br /> == Request ==<br /> <br /> The update notification request is a http get request to an URL, which may contain the operating system and processor type the OpenOffice.org instance is compiled for either as part of the URL or as URL parameter.<br /> <br /> === Examples ===<br /> <br /> <pre><br /> UpdateURL=http://update.services.openoffice.org/ProductUpdateService/check.Update2?_OS=Solaris&_ARCH=SPARC<br /> </pre><br /> <br /> <pre><br /> UpdateURL=http://www.example.org/MyProduct/MyOS/MyArch<br /> </pre><br /> <br /> == User-Agent field ==<br /> <br /> To reduce the amount of transfered data when asking for OpenOffice.org updates, the user agent field contains all information required to identify a specific build: <br /> <br /> <pre><br /> User-Agent: OpenOffice.org/2.2 (680m212 (Build:9263); Solaris; SPARC; BundledLanguages=en-US_fr)<br /> </pre><br /> <br /> == Accept-Language field ==<br /> <br /> To be able to return language specific feeds, OpenOffice.org sets the Accept-Language http request header field to the UI language currently in use:<br /> <br /> <pre><br /> Accept-Language: en-GB<br /> </pre><br /> <br /> == Update documents and feeds ==<br /> <br /> The simplest possible reply is of the following form:<br /> <br /> <source lang="xml"><br /> <?xml version="1.0" encoding="utf-8"?><br /> <inst:description xmlns:inst="http://installation.openoffice.org/description"><br /> <inst:id>OpenOffice.org_2_en-US_fr</inst:id><br /> <inst:version>2.2.0-5</inst:version><br /> <inst:buildid>9095</inst:buildid><br /> <inst:os>Solaris</inst:os><br /> <inst:arch>SPARC</inst:arch><br /> <inst:update type="text/html" src="http://update.services.openoffice.org/ooo/snapshot.html" /><br /> </inst:description><br /> </source><br /> <br /> As the type attribute of the update tag is "text/html", OOo will pass the URL specified in the src attribute to a browser. If you specify a different type, e.g.<br /> <br /> <source lang="xml"><br /> <inst:update type="application/octet-stream" src="http://openoffice.bouncer.osuosl.org/?product=OpenOffice.org&os=solarissparcwjre&lang=en-US&version=2.4" /><br /> </source><br /> <br /> OOo will download the referenced file itself.<br /> <br /> <br /> The other supported reply format, which also allows to include several components or several versions of a single component, is to embed the update document in an [http://tools.ietf.org/wg/atompub/draft-ietf-atompub-format/rfc4287.txt atom feed].<br /> <br /> <source lang="xml"><br /> <?xml version="1.0" encoding="utf-8"?><br /> <feed xmlns="http://www.w3.org/2005/Atom" xml:lang”en-US”><br /> <br /> <title>OpenOffice.org Update Feed</title><br /> <link rel="alternate" type="text/html" href="http://update.services.openoffice.org/ooo/snapshot.html"/><br /> <updated>2006-11-06T18:30:02Z</updated><br /> <author><br /> <name>The OpenOffice.org Project</name><br /> <uri>http://openoffice.org</uri><br /> <email>updatefeed@openoffice.org</email><br /> </author><br /> <id>urn:uuid:a4ccd383-1dd1-11b2-a95c-0003ba566e9d</id><br /> <entry><br /> <title>OpenOffice.org 2.2 available</title><br /> <link rel="alternate" type="text/html"<br /> href="http://update.services.openoffice.org/ooo/snapshot.html"/><br /> <id>urn:uuid:a4ccd383-1dd1-11b2-a95c-0003ba566e9e</id><br /> <updated>2006-11-06T18:30:02Z</updated><br /> <summary>Click here to go to the download page.</summary><br /> <category term="OpenOffice.org_2_en-US_fr" label="OpenOffice.org 2.2 US english/french" /><br /> <content type="application/xml"><br /> <inst:description xmlns:inst="http://installation.openoffice.org/description"><br /> <inst:id>OpenOffice.org_2_en-US_fr</inst:id><br /> <inst:version>2.2.0-5</inst:version><br /> <inst:buildid>9095</inst:buildid><br /> <inst:os>Solaris</inst:os><br /> <inst:arch>SPARC</inst:arch><br /> <inst:update type="text/html" src="http://update.services.openoffice.org/ooo/snapshot.html" /><br /> </inst:description><br /> </content><br /> </entry><br /> </feed><br /> </source><br /> <br /> ''description.xml'' OpenOffice.org 3.x update information example<br /> <br /> The following content of a ''description.xml'' directly references update information for a German Windows OpenOffice.org 3.3.0:<br /> <source lang="xml"><br /> <?xml version="1.0" encoding="utf-8"?><br /> <feed xmlns="http://www.w3.org/2005/Atom" xml:lang="en-US"><br /> <title>Product Update Feed</title><br /> <link rel="alternate" type="text/html" href="http://update.services.openoffice.org/ooo/snapshot.html"/><br /> <updated>2011-01-01T08:00:02Z</updated><br /> <author><br /> <name>The OpenOffice Project</name><br /> <uri>http://openoffice.org</uri><br /> <email>updatefeed@openoffice.org</email><br /> </author><br /> <id>urn:uuid:76676544</id><br /> <entry><br /> <title>Update available</title><br /> <link rel="alternate" type="text/html" href="http://update.services.openoffice.org/ooo/snapshot.html"/><br /> <id>urn:uuid:76676544</id><br /> <br /> <category term="OpenOffice.org_3_de" label="OpenOffice.org update"/><br /> <updated>2011-01-01T08:00:02Z</updated><br /> <summary>Text below download information (should be localized)</summary><br /> <content type="application/xml"><br /> <inst:description xmlns:inst="http://installation.openoffice.org/description"><br /> <inst:id>OpenOffice.org_3_de</inst:id><br /> <inst:version>'new version information'</inst:version><br /> <br /> <inst:buildid>9580</inst:buildid><br /> <inst:os>Windows</inst:os><br /> <inst:arch>x86</inst:arch><br /> <br /> <br /> <br /> <inst:update type="text/html" src="http://download.openoffice.org"/><br /> </inst:description><br /> </content><br /> </entry><br /> </feed><br /> </source><br /> <br /> '''Note''': to allow proper filtering, the <tt>term</tt> tag of the <category> node of the <atom:entry> element must contain the <inst:id> string of the component to be updated.<br /> <br /> <br /> Extension developers might prefer to link to the update description file instead of embedding it:<br /> <br /> <source lang="xml"><br /> <?xml version="1.0" encoding="utf-8"?><br /> <feed xmlns="http://www.w3.org/2005/Atom" xml:lang”en-US”><br /> <br /> <title>My Extention Update Feed</title><br /> <link rel="alternate" type="text/html" href="http://update.services.openoffice.org/ooo/snapshot.html"/><br /> <updated>2006-11-06T18:30:02Z</updated><br /> <author><br /> <name>Extension Developer</name><br /> <uri>http://example.org</uri><br /> <email>update@example.org</email><br /> </author><br /> <id>urn:uuid:a4ccd383-1dd1-11b2-a95c-0003ba566e9d</id><br /> <entry><br /> <title>Version 2 available</title><br /> <link rel="alternate" type="text/html"<br /> href="http://example.org/myextension/latest.html"/><br /> <id>MyExtension+version</id><br /> <updated>2006-11-06T18:30:02Z</updated><br /> <category term="MyExtension" label="My Extension" /><br /> <content type="application/xml" src="http://example.org/myextension/latest/myextension.update.xml" /><br /> </entry><br /> </feed><br /> </source><br /> <br /> '''Note''': to allow proper filtering, the <tt>term</tt> tag of the <category> node of the <atom:entry> element must contain the <identifier> value of the extension to be updated.<br /> <br /> = A glance on the code for the Apache OpenOffice 3.4 release =<br /> <br /> The following describes some deeper insight of the "Check for Updates..." code in the office. It should help us to re-activate a corresponding web service when Apache OpenOffice 3.4 has been released. (Do we need a real web service? Something to be discussed.)<br /> <br /> The information given here is based on the work of Regina (regina at apache dot org), Ariel (arielch at apache dot org) and Kay (kschenk at apache dot org) found in the corresponding mailing list thread on ooo-dev - see http://s.apache.org/e2u.<br /> Having this information gave me (orw at apache dot org) the right pointers for deeper investigations.<br /> <br /> == summary information about request to <UpdateURL> ==<br /> <br /> The <UpdateURL>, found in file <version.ini> resp. <versionrc> of the office installation is typically an HTTP URL.<br /> The office sends a GET request to this URL. Two header fields are included in this request which are already mentioned above.<br /> These are "Accept-Language" and "User-Agent".<br /> * "Accept-Language" contains the language of current locale - found in configuration item "org.openoffice.Setup/L10N", attribute "ooLocale"<br /> * "User-Agent" contains needed information to identify the installed office version - see above. The information matches the following pattern which is found in file <version.ini> resp. <versionrc>:<br /> <blockquote><br /> <pre><br /> <PRODUCT> (${buildid}; ${_OS}; ${_ARCH}; BundledLanguages=${AllLanguages}) <br /> </pre><br /> </blockquote><br /> On platforms other than Windows the <UpdateURL> contains (at least since OOo 3.3) a query part. It is ''?pkgfmt=<pkgformat>'' which especially for Linux platforms identifies the package format of the office installation.<br /> <br /> It reveals that this information can be used to create the corresponding information for the request response.<br /> <br /> == information about processing the request response ==<br /> <br /> The response is expected to be a corresponding XML snippet.<br /> As shown in the above examples, two types of XML snippets as responses are possible:<br /> a ''feed'' response and a ''simple'' response. The distinction between the two is made by its first element. If it is <feed> it is treated as a ''feed'' response, otherwise as a ''simple'' response.<br /> <br /> ==== ''simple'' response ====<br /> <br /> The ''simple'' response is an XML snippet which is expected to have the format as the XML snippet in file [http://svn.apache.org/repos/asf/incubator/ooo/trunk/main/instsetoo_native/util/update.xml update.xml], found in our source repository.<br /> <br /> The following conditions must hold to perform further evaluation of the response:<br /> # value of <inst:os> matches the one of the installed office - ''${_ARCH}''.<br /> # value of <inst:arch> matches the one of the installed office - ''${_OS}''.<br /> # value of <inst:buildid> is greater than the one of the installed office - ''${buildid}''.<br /> If these conditions hold, the following information is retrieved:<br /> # values of attributes <src> and <type> of <inst:update><br /> #* if value of <type> equals "text/html", the value of <src> is taken as an website from which the new version can be downloaded manually. Otherwise (also in case that attribute <type> is missing) the value of <src> is interpreted as a download link to the new version.<br /> #* all <inst:update> elements are evaluated. The information of the first one is used - provide download of version or provide link to download website. The purpose of the other is not known.<br /> # value of <inst:version> - will be shown in the corresponding dialog.<br /> # value of <inst:buildid> - currently its purpose is not known.<br /> If the first information - download website or download link - can be found in the XML snippet, the corresponding dialog will state that a new version is available. The user can then download it manually or can trigger an automatic download.<br /> <br /> If no download website/link is found, the dialog will state that the installed office is up to date.<br /> <br /> ==== ''feed'' response ====<br /> <br /> The ''feed'' response is expected to conform to [http://tools.ietf.org/wg/atompub/draft-ietf-atompub-format/rfc4287.txt atom feed] - as stated above in the example area.<br /> Each content of the <content> element of an atom entry (<entry> element) whose <category> element has an attribute <term> whose value matches the <UpdateId> value found in file <version.ini> resp. <versionrc> of the installed office is treated as ''simple'' response. <br /> <br /> The first of these ''simple'' responses from which a download website or a download link could be retrieved that matches the above given conditions is taken - the following ones are not processed. It will be shown to the user that a new version is available, and the user can trigger the download manually or automatically. One further information is taken from this atom entry - the content of the <summary> element. It is shown in the corresponding dialog.<br /> <br /> If no download website/link is found, the dialog will state that the installed office is up to date.<br /> <br /> [[Category:Spec]]</div>

Od https://wiki.openoffice.org/w/index.php?title=Update_Service&diff=235381 Update Service 2014-07-10T10:31:33Z

<p>Od: /* Available Update Feeds */</p> <hr /> <div>== Introduction ==<br /> The Update Service for AOO/OOo is a service which provides via HTTP or HTTPS an Update Feed (or an Update Document) for installed AOO/OOo instances. This allows a requesting AOO/OOo instance to check, if a new AOO version is available and to provide the result of this check to the user.<br /> <br /> Currently, the Update Service is implemented via static HTTP/HTTPS resources. No dynamic component is involved which processes the information given in the HTTP/HTTPS request of the AOO/OOo instance in order to generate a response.<br /> <br /> = Available Update Feeds =<br /> <br /> For the following AOO/OOo versions an Update Feed is made available.<br /> The table contains the UpdateURL which an AOO/OOo instance of the specified version is requesting via HTTP/HTTPS and the resource in our svn repository which serves the HTTP/HTTPS resource behind the UpdateURL.<br /> <br /> {| class="wikitable" border="1"<br /> |-<br /> ! AOO/OOo version<br /> ! UpdateURL<br /> ! Resource in svn repository<br /> |-<br /> | OOo 3.2<br /> | http://www.openoffice.org/projects/update34/ProductUpdateService/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/ooo-site/trunk/content/projects/update34/ProductUpdateService/check.Update ooo-site/update34]<br /> |-<br /> | OOo 3.2.1<br /> | http://www.openoffice.org/projects/update35/ProductUpdateService/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/ooo-site/trunk/content/projects/update35/ProductUpdateService/check.Update ooo-site/update35]<br /> |-<br /> | OOo 3.3<br /> | http://www.openoffice.org/projects/update36/ProductUpdateService/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/ooo-site/trunk/content/projects/update36/ProductUpdateService/check.Update ooo-site/update36]<br /> |-<br /> | AOO 3.4.0<br /> | http://www.openoffice.org/projects/update38/ProductUpdateService/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/ooo-site/trunk/content/projects/update38/ProductUpdateService/check.Update ooo-site/update38]<br /> |-<br /> | AOO 3.4.1<br /> | http://www.openoffice.org/projects/update/aoo341/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/ooo-site/trunk/content/projects/update/aoo341/check.Update ooo-site/update/aoo341]<br /> |-<br /> | AOO 4.0.0<br /> | https://ooo-updates.apache.org/aoo40/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/update-site/trunk/aoo40/check.Update update-site/aoo40]<br /> |-<br /> | AOO 4.0.1<br /> | https://ooo-updates.apache.org/aoo401/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/update-site/trunk/aoo401/check.Update update-site/aoo401]<br /> |-<br /> | AOO 4.1.0<br /> | https://ooo-updates.apache.org/aoo401/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/update-site/trunk/aoo401/check.Update update-site/aoo410]<br /> |-<br /> | AOO 4.1.1<br /> [currently not active]<br /> | https://ooo-updates.apache.org/aoo410/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/update-site/trunk/aoo410/check.Update update-site/aoo411]<br /> |}<br /> <br /> Update Feeds can be generated by using the bash script and corresponding meta data which is available at [http://svn.apache.org/repos/asf/openoffice/devtools/genUpdateFeed/ genUpdateFeed].<br /> <br /> = Update Notification Protocol =<br /> <br /> == Introduction ==<br /> <br /> Since version 2.0.3 OpenOffice.org users of builds providing an UpdateURL can manually check for available updates by invoking "Help -> Check for Updates .." . Starting with version 2.0.4 OpenOffice.org can perform this check automatically in a user configurable interval. <br /> <br /> This is an attempt to define a second version of the update notification protocol, which is better extendable, can also be used for [[Extensions | extensions]] and no longer uses http post requests.<br /> <br /> {{Documentation/Note|Note: Even though this document is a draft, it seems to be the actually implemented version as of OpenOffice.org 3.3. See http://s.apache.org/e2u for more information.}}<br /> <br /> == Request ==<br /> <br /> The update notification request is a http get request to an URL, which may contain the operating system and processor type the OpenOffice.org instance is compiled for either as part of the URL or as URL parameter.<br /> <br /> === Examples ===<br /> <br /> <pre><br /> UpdateURL=http://update.services.openoffice.org/ProductUpdateService/check.Update2?_OS=Solaris&_ARCH=SPARC<br /> </pre><br /> <br /> <pre><br /> UpdateURL=http://www.example.org/MyProduct/MyOS/MyArch<br /> </pre><br /> <br /> == User-Agent field ==<br /> <br /> To reduce the amount of transfered data when asking for OpenOffice.org updates, the user agent field contains all information required to identify a specific build: <br /> <br /> <pre><br /> User-Agent: OpenOffice.org/2.2 (680m212 (Build:9263); Solaris; SPARC; BundledLanguages=en-US_fr)<br /> </pre><br /> <br /> == Accept-Language field ==<br /> <br /> To be able to return language specific feeds, OpenOffice.org sets the Accept-Language http request header field to the UI language currently in use:<br /> <br /> <pre><br /> Accept-Language: en-GB<br /> </pre><br /> <br /> == Update documents and feeds ==<br /> <br /> The simplest possible reply is of the following form:<br /> <br /> <source lang="xml"><br /> <?xml version="1.0" encoding="utf-8"?><br /> <inst:description xmlns:inst="http://installation.openoffice.org/description"><br /> <inst:id>OpenOffice.org_2_en-US_fr</inst:id><br /> <inst:version>2.2.0-5</inst:version><br /> <inst:buildid>9095</inst:buildid><br /> <inst:os>Solaris</inst:os><br /> <inst:arch>SPARC</inst:arch><br /> <inst:update type="text/html" src="http://update.services.openoffice.org/ooo/snapshot.html" /><br /> </inst:description><br /> </source><br /> <br /> As the type attribute of the update tag is "text/html", OOo will pass the URL specified in the src attribute to a browser. If you specify a different type, e.g.<br /> <br /> <source lang="xml"><br /> <inst:update type="application/octet-stream" src="http://openoffice.bouncer.osuosl.org/?product=OpenOffice.org&os=solarissparcwjre&lang=en-US&version=2.4" /><br /> </source><br /> <br /> OOo will download the referenced file itself.<br /> <br /> <br /> The other supported reply format, which also allows to include several components or several versions of a single component, is to embed the update document in an [http://tools.ietf.org/wg/atompub/draft-ietf-atompub-format/rfc4287.txt atom feed].<br /> <br /> <source lang="xml"><br /> <?xml version="1.0" encoding="utf-8"?><br /> <feed xmlns="http://www.w3.org/2005/Atom" xml:lang”en-US”><br /> <br /> <title>OpenOffice.org Update Feed</title><br /> <link rel="alternate" type="text/html" href="http://update.services.openoffice.org/ooo/snapshot.html"/><br /> <updated>2006-11-06T18:30:02Z</updated><br /> <author><br /> <name>The OpenOffice.org Project</name><br /> <uri>http://openoffice.org</uri><br /> <email>updatefeed@openoffice.org</email><br /> </author><br /> <id>urn:uuid:a4ccd383-1dd1-11b2-a95c-0003ba566e9d</id><br /> <entry><br /> <title>OpenOffice.org 2.2 available</title><br /> <link rel="alternate" type="text/html"<br /> href="http://update.services.openoffice.org/ooo/snapshot.html"/><br /> <id>urn:uuid:a4ccd383-1dd1-11b2-a95c-0003ba566e9e</id><br /> <updated>2006-11-06T18:30:02Z</updated><br /> <summary>Click here to go to the download page.</summary><br /> <category term="OpenOffice.org_2_en-US_fr" label="OpenOffice.org 2.2 US english/french" /><br /> <content type="application/xml"><br /> <inst:description xmlns:inst="http://installation.openoffice.org/description"><br /> <inst:id>OpenOffice.org_2_en-US_fr</inst:id><br /> <inst:version>2.2.0-5</inst:version><br /> <inst:buildid>9095</inst:buildid><br /> <inst:os>Solaris</inst:os><br /> <inst:arch>SPARC</inst:arch><br /> <inst:update type="text/html" src="http://update.services.openoffice.org/ooo/snapshot.html" /><br /> </inst:description><br /> </content><br /> </entry><br /> </feed><br /> </source><br /> <br /> ''description.xml'' OpenOffice.org 3.x update information example<br /> <br /> The following content of a ''description.xml'' directly references update information for a German Windows OpenOffice.org 3.3.0:<br /> <source lang="xml"><br /> <?xml version="1.0" encoding="utf-8"?><br /> <feed xmlns="http://www.w3.org/2005/Atom" xml:lang="en-US"><br /> <title>Product Update Feed</title><br /> <link rel="alternate" type="text/html" href="http://update.services.openoffice.org/ooo/snapshot.html"/><br /> <updated>2011-01-01T08:00:02Z</updated><br /> <author><br /> <name>The OpenOffice Project</name><br /> <uri>http://openoffice.org</uri><br /> <email>updatefeed@openoffice.org</email><br /> </author><br /> <id>urn:uuid:76676544</id><br /> <entry><br /> <title>Update available</title><br /> <link rel="alternate" type="text/html" href="http://update.services.openoffice.org/ooo/snapshot.html"/><br /> <id>urn:uuid:76676544</id><br /> <br /> <category term="OpenOffice.org_3_de" label="OpenOffice.org update"/><br /> <updated>2011-01-01T08:00:02Z</updated><br /> <summary>Text below download information (should be localized)</summary><br /> <content type="application/xml"><br /> <inst:description xmlns:inst="http://installation.openoffice.org/description"><br /> <inst:id>OpenOffice.org_3_de</inst:id><br /> <inst:version>'new version information'</inst:version><br /> <br /> <inst:buildid>9580</inst:buildid><br /> <inst:os>Windows</inst:os><br /> <inst:arch>x86</inst:arch><br /> <br /> <br /> <br /> <inst:update type="text/html" src="http://download.openoffice.org"/><br /> </inst:description><br /> </content><br /> </entry><br /> </feed><br /> </source><br /> <br /> '''Note''': to allow proper filtering, the <tt>term</tt> tag of the <category> node of the <atom:entry> element must contain the <inst:id> string of the component to be updated.<br /> <br /> <br /> Extension developers might prefer to link to the update description file instead of embedding it:<br /> <br /> <source lang="xml"><br /> <?xml version="1.0" encoding="utf-8"?><br /> <feed xmlns="http://www.w3.org/2005/Atom" xml:lang”en-US”><br /> <br /> <title>My Extention Update Feed</title><br /> <link rel="alternate" type="text/html" href="http://update.services.openoffice.org/ooo/snapshot.html"/><br /> <updated>2006-11-06T18:30:02Z</updated><br /> <author><br /> <name>Extension Developer</name><br /> <uri>http://example.org</uri><br /> <email>update@example.org</email><br /> </author><br /> <id>urn:uuid:a4ccd383-1dd1-11b2-a95c-0003ba566e9d</id><br /> <entry><br /> <title>Version 2 available</title><br /> <link rel="alternate" type="text/html"<br /> href="http://example.org/myextension/latest.html"/><br /> <id>MyExtension+version</id><br /> <updated>2006-11-06T18:30:02Z</updated><br /> <category term="MyExtension" label="My Extension" /><br /> <content type="application/xml" src="http://example.org/myextension/latest/myextension.update.xml" /><br /> </entry><br /> </feed><br /> </source><br /> <br /> '''Note''': to allow proper filtering, the <tt>term</tt> tag of the <category> node of the <atom:entry> element must contain the <identifier> value of the extension to be updated.<br /> <br /> = A glance on the code for the Apache OpenOffice 3.4 release =<br /> <br /> The following describes some deeper insight of the "Check for Updates..." code in the office. It should help us to re-activate a corresponding web service when Apache OpenOffice 3.4 has been released. (Do we need a real web service? Something to be discussed.)<br /> <br /> The information given here is based on the work of Regina (regina at apache dot org), Ariel (arielch at apache dot org) and Kay (kschenk at apache dot org) found in the corresponding mailing list thread on ooo-dev - see http://s.apache.org/e2u.<br /> Having this information gave me (orw at apache dot org) the right pointers for deeper investigations.<br /> <br /> == summary information about request to <UpdateURL> ==<br /> <br /> The <UpdateURL>, found in file <version.ini> resp. <versionrc> of the office installation is typically an HTTP URL.<br /> The office sends a GET request to this URL. Two header fields are included in this request which are already mentioned above.<br /> These are "Accept-Language" and "User-Agent".<br /> * "Accept-Language" contains the language of current locale - found in configuration item "org.openoffice.Setup/L10N", attribute "ooLocale"<br /> * "User-Agent" contains needed information to identify the installed office version - see above. The information matches the following pattern which is found in file <version.ini> resp. <versionrc>:<br /> <blockquote><br /> <pre><br /> <PRODUCT> (${buildid}; ${_OS}; ${_ARCH}; BundledLanguages=${AllLanguages}) <br /> </pre><br /> </blockquote><br /> On platforms other than Windows the <UpdateURL> contains (at least since OOo 3.3) a query part. It is ''?pkgfmt=<pkgformat>'' which especially for Linux platforms identifies the package format of the office installation.<br /> <br /> It reveals that this information can be used to create the corresponding information for the request response.<br /> <br /> == information about processing the request response ==<br /> <br /> The response is expected to be a corresponding XML snippet.<br /> As shown in the above examples, two types of XML snippets as responses are possible:<br /> a ''feed'' response and a ''simple'' response. The distinction between the two is made by its first element. If it is <feed> it is treated as a ''feed'' response, otherwise as a ''simple'' response.<br /> <br /> ==== ''simple'' response ====<br /> <br /> The ''simple'' response is an XML snippet which is expected to have the format as the XML snippet in file [http://svn.apache.org/repos/asf/incubator/ooo/trunk/main/instsetoo_native/util/update.xml update.xml], found in our source repository.<br /> <br /> The following conditions must hold to perform further evaluation of the response:<br /> # value of <inst:os> matches the one of the installed office - ''${_ARCH}''.<br /> # value of <inst:arch> matches the one of the installed office - ''${_OS}''.<br /> # value of <inst:buildid> is greater than the one of the installed office - ''${buildid}''.<br /> If these conditions hold, the following information is retrieved:<br /> # values of attributes <src> and <type> of <inst:update><br /> #* if value of <type> equals "text/html", the value of <src> is taken as an website from which the new version can be downloaded manually. Otherwise (also in case that attribute <type> is missing) the value of <src> is interpreted as a download link to the new version.<br /> #* all <inst:update> elements are evaluated. The information of the first one is used - provide download of version or provide link to download website. The purpose of the other is not known.<br /> # value of <inst:version> - will be shown in the corresponding dialog.<br /> # value of <inst:buildid> - currently its purpose is not known.<br /> If the first information - download website or download link - can be found in the XML snippet, the corresponding dialog will state that a new version is available. The user can then download it manually or can trigger an automatic download.<br /> <br /> If no download website/link is found, the dialog will state that the installed office is up to date.<br /> <br /> ==== ''feed'' response ====<br /> <br /> The ''feed'' response is expected to conform to [http://tools.ietf.org/wg/atompub/draft-ietf-atompub-format/rfc4287.txt atom feed] - as stated above in the example area.<br /> Each content of the <content> element of an atom entry (<entry> element) whose <category> element has an attribute <term> whose value matches the <UpdateId> value found in file <version.ini> resp. <versionrc> of the installed office is treated as ''simple'' response. <br /> <br /> The first of these ''simple'' responses from which a download website or a download link could be retrieved that matches the above given conditions is taken - the following ones are not processed. It will be shown to the user that a new version is available, and the user can trigger the download manually or automatically. One further information is taken from this atom entry - the content of the <summary> element. It is shown in the corresponding dialog.<br /> <br /> If no download website/link is found, the dialog will state that the installed office is up to date.<br /> <br /> [[Category:Spec]]</div>

Od https://wiki.openoffice.org/w/index.php?title=Update_Service&diff=235380 Update Service 2014-07-10T10:28:46Z

<p>Od: /* Introduction */</p> <hr /> <div>== Introduction ==<br /> The Update Service for AOO/OOo is a service which provides via HTTP or HTTPS an Update Feed (or an Update Document) for installed AOO/OOo instances. This allows a requesting AOO/OOo instance to check, if a new AOO version is available and to provide the result of this check to the user.<br /> <br /> Currently, the Update Service is implemented via static HTTP/HTTPS resources. No dynamic component is involved which processes the information given in the HTTP/HTTPS request of the AOO/OOo instance in order to generate a response.<br /> <br /> = Available Update Feeds =<br /> <br /> For the following AOO/OOo versions an Update Feed is made available.<br /> The table contains the UpdateURL which an AOO/OOo instance of the specified version is requesting via HTTP/HTTPS and the resource in our svn repository which serves the HTTP/HTTPS resource behind the UpdateURL.<br /> <br /> {| class="wikitable" border="1"<br /> |-<br /> ! AOO/OOo version<br /> ! UpdateURL<br /> ! Resource in svn repository<br /> |-<br /> | OOo 3.2<br /> | http://www.openoffice.org/projects/update34/ProductUpdateService/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/ooo-site/trunk/content/projects/update34/ProductUpdateService/check.Update ooo-site/update34]<br /> |-<br /> | OOo 3.2.1<br /> | http://www.openoffice.org/projects/update35/ProductUpdateService/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/ooo-site/trunk/content/projects/update35/ProductUpdateService/check.Update ooo-site/update35]<br /> |-<br /> | OOo 3.3<br /> | http://www.openoffice.org/projects/update36/ProductUpdateService/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/ooo-site/trunk/content/projects/update36/ProductUpdateService/check.Update ooo-site/update36]<br /> |-<br /> | AOO 3.4.0<br /> | http://www.openoffice.org/projects/update38/ProductUpdateService/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/ooo-site/trunk/content/projects/update38/ProductUpdateService/check.Update ooo-site/update38]<br /> |-<br /> | AOO 3.4.1<br /> | http://www.openoffice.org/projects/update/aoo341/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/ooo-site/trunk/content/projects/update/aoo341/check.Update ooo-site/update/aoo341]<br /> |-<br /> | AOO 4.0.0<br /> | https://ooo-updates.apache.org/aoo40/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/update-site/trunk/aoo40/check.Update update-site/aoo40]<br /> |-<br /> | AOO 4.0.1<br /> | https://ooo-updates.apache.org/aoo401/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/update-site/trunk/aoo401/check.Update update-site/aoo401]<br /> |-<br /> | AOO 4.1.0<br /> | https://ooo-updates.apache.org/aoo401/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/update-site/trunk/aoo401/check.Update update-site/aoo410]<br /> |-<br /> | AOO 4.1.1<br /> [currently not active]<br /> | https://ooo-updates.apache.org/aoo410/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/update-site/trunk/aoo410/check.Update update-site/aoo411]<br /> |}<br /> <br /> = Update Notification Protocol =<br /> <br /> == Introduction ==<br /> <br /> Since version 2.0.3 OpenOffice.org users of builds providing an UpdateURL can manually check for available updates by invoking "Help -> Check for Updates .." . Starting with version 2.0.4 OpenOffice.org can perform this check automatically in a user configurable interval. <br /> <br /> This is an attempt to define a second version of the update notification protocol, which is better extendable, can also be used for [[Extensions | extensions]] and no longer uses http post requests.<br /> <br /> {{Documentation/Note|Note: Even though this document is a draft, it seems to be the actually implemented version as of OpenOffice.org 3.3. See http://s.apache.org/e2u for more information.}}<br /> <br /> == Request ==<br /> <br /> The update notification request is a http get request to an URL, which may contain the operating system and processor type the OpenOffice.org instance is compiled for either as part of the URL or as URL parameter.<br /> <br /> === Examples ===<br /> <br /> <pre><br /> UpdateURL=http://update.services.openoffice.org/ProductUpdateService/check.Update2?_OS=Solaris&_ARCH=SPARC<br /> </pre><br /> <br /> <pre><br /> UpdateURL=http://www.example.org/MyProduct/MyOS/MyArch<br /> </pre><br /> <br /> == User-Agent field ==<br /> <br /> To reduce the amount of transfered data when asking for OpenOffice.org updates, the user agent field contains all information required to identify a specific build: <br /> <br /> <pre><br /> User-Agent: OpenOffice.org/2.2 (680m212 (Build:9263); Solaris; SPARC; BundledLanguages=en-US_fr)<br /> </pre><br /> <br /> == Accept-Language field ==<br /> <br /> To be able to return language specific feeds, OpenOffice.org sets the Accept-Language http request header field to the UI language currently in use:<br /> <br /> <pre><br /> Accept-Language: en-GB<br /> </pre><br /> <br /> == Update documents and feeds ==<br /> <br /> The simplest possible reply is of the following form:<br /> <br /> <source lang="xml"><br /> <?xml version="1.0" encoding="utf-8"?><br /> <inst:description xmlns:inst="http://installation.openoffice.org/description"><br /> <inst:id>OpenOffice.org_2_en-US_fr</inst:id><br /> <inst:version>2.2.0-5</inst:version><br /> <inst:buildid>9095</inst:buildid><br /> <inst:os>Solaris</inst:os><br /> <inst:arch>SPARC</inst:arch><br /> <inst:update type="text/html" src="http://update.services.openoffice.org/ooo/snapshot.html" /><br /> </inst:description><br /> </source><br /> <br /> As the type attribute of the update tag is "text/html", OOo will pass the URL specified in the src attribute to a browser. If you specify a different type, e.g.<br /> <br /> <source lang="xml"><br /> <inst:update type="application/octet-stream" src="http://openoffice.bouncer.osuosl.org/?product=OpenOffice.org&os=solarissparcwjre&lang=en-US&version=2.4" /><br /> </source><br /> <br /> OOo will download the referenced file itself.<br /> <br /> <br /> The other supported reply format, which also allows to include several components or several versions of a single component, is to embed the update document in an [http://tools.ietf.org/wg/atompub/draft-ietf-atompub-format/rfc4287.txt atom feed].<br /> <br /> <source lang="xml"><br /> <?xml version="1.0" encoding="utf-8"?><br /> <feed xmlns="http://www.w3.org/2005/Atom" xml:lang”en-US”><br /> <br /> <title>OpenOffice.org Update Feed</title><br /> <link rel="alternate" type="text/html" href="http://update.services.openoffice.org/ooo/snapshot.html"/><br /> <updated>2006-11-06T18:30:02Z</updated><br /> <author><br /> <name>The OpenOffice.org Project</name><br /> <uri>http://openoffice.org</uri><br /> <email>updatefeed@openoffice.org</email><br /> </author><br /> <id>urn:uuid:a4ccd383-1dd1-11b2-a95c-0003ba566e9d</id><br /> <entry><br /> <title>OpenOffice.org 2.2 available</title><br /> <link rel="alternate" type="text/html"<br /> href="http://update.services.openoffice.org/ooo/snapshot.html"/><br /> <id>urn:uuid:a4ccd383-1dd1-11b2-a95c-0003ba566e9e</id><br /> <updated>2006-11-06T18:30:02Z</updated><br /> <summary>Click here to go to the download page.</summary><br /> <category term="OpenOffice.org_2_en-US_fr" label="OpenOffice.org 2.2 US english/french" /><br /> <content type="application/xml"><br /> <inst:description xmlns:inst="http://installation.openoffice.org/description"><br /> <inst:id>OpenOffice.org_2_en-US_fr</inst:id><br /> <inst:version>2.2.0-5</inst:version><br /> <inst:buildid>9095</inst:buildid><br /> <inst:os>Solaris</inst:os><br /> <inst:arch>SPARC</inst:arch><br /> <inst:update type="text/html" src="http://update.services.openoffice.org/ooo/snapshot.html" /><br /> </inst:description><br /> </content><br /> </entry><br /> </feed><br /> </source><br /> <br /> ''description.xml'' OpenOffice.org 3.x update information example<br /> <br /> The following content of a ''description.xml'' directly references update information for a German Windows OpenOffice.org 3.3.0:<br /> <source lang="xml"><br /> <?xml version="1.0" encoding="utf-8"?><br /> <feed xmlns="http://www.w3.org/2005/Atom" xml:lang="en-US"><br /> <title>Product Update Feed</title><br /> <link rel="alternate" type="text/html" href="http://update.services.openoffice.org/ooo/snapshot.html"/><br /> <updated>2011-01-01T08:00:02Z</updated><br /> <author><br /> <name>The OpenOffice Project</name><br /> <uri>http://openoffice.org</uri><br /> <email>updatefeed@openoffice.org</email><br /> </author><br /> <id>urn:uuid:76676544</id><br /> <entry><br /> <title>Update available</title><br /> <link rel="alternate" type="text/html" href="http://update.services.openoffice.org/ooo/snapshot.html"/><br /> <id>urn:uuid:76676544</id><br /> <br /> <category term="OpenOffice.org_3_de" label="OpenOffice.org update"/><br /> <updated>2011-01-01T08:00:02Z</updated><br /> <summary>Text below download information (should be localized)</summary><br /> <content type="application/xml"><br /> <inst:description xmlns:inst="http://installation.openoffice.org/description"><br /> <inst:id>OpenOffice.org_3_de</inst:id><br /> <inst:version>'new version information'</inst:version><br /> <br /> <inst:buildid>9580</inst:buildid><br /> <inst:os>Windows</inst:os><br /> <inst:arch>x86</inst:arch><br /> <br /> <br /> <br /> <inst:update type="text/html" src="http://download.openoffice.org"/><br /> </inst:description><br /> </content><br /> </entry><br /> </feed><br /> </source><br /> <br /> '''Note''': to allow proper filtering, the <tt>term</tt> tag of the <category> node of the <atom:entry> element must contain the <inst:id> string of the component to be updated.<br /> <br /> <br /> Extension developers might prefer to link to the update description file instead of embedding it:<br /> <br /> <source lang="xml"><br /> <?xml version="1.0" encoding="utf-8"?><br /> <feed xmlns="http://www.w3.org/2005/Atom" xml:lang”en-US”><br /> <br /> <title>My Extention Update Feed</title><br /> <link rel="alternate" type="text/html" href="http://update.services.openoffice.org/ooo/snapshot.html"/><br /> <updated>2006-11-06T18:30:02Z</updated><br /> <author><br /> <name>Extension Developer</name><br /> <uri>http://example.org</uri><br /> <email>update@example.org</email><br /> </author><br /> <id>urn:uuid:a4ccd383-1dd1-11b2-a95c-0003ba566e9d</id><br /> <entry><br /> <title>Version 2 available</title><br /> <link rel="alternate" type="text/html"<br /> href="http://example.org/myextension/latest.html"/><br /> <id>MyExtension+version</id><br /> <updated>2006-11-06T18:30:02Z</updated><br /> <category term="MyExtension" label="My Extension" /><br /> <content type="application/xml" src="http://example.org/myextension/latest/myextension.update.xml" /><br /> </entry><br /> </feed><br /> </source><br /> <br /> '''Note''': to allow proper filtering, the <tt>term</tt> tag of the <category> node of the <atom:entry> element must contain the <identifier> value of the extension to be updated.<br /> <br /> = A glance on the code for the Apache OpenOffice 3.4 release =<br /> <br /> The following describes some deeper insight of the "Check for Updates..." code in the office. It should help us to re-activate a corresponding web service when Apache OpenOffice 3.4 has been released. (Do we need a real web service? Something to be discussed.)<br /> <br /> The information given here is based on the work of Regina (regina at apache dot org), Ariel (arielch at apache dot org) and Kay (kschenk at apache dot org) found in the corresponding mailing list thread on ooo-dev - see http://s.apache.org/e2u.<br /> Having this information gave me (orw at apache dot org) the right pointers for deeper investigations.<br /> <br /> == summary information about request to <UpdateURL> ==<br /> <br /> The <UpdateURL>, found in file <version.ini> resp. <versionrc> of the office installation is typically an HTTP URL.<br /> The office sends a GET request to this URL. Two header fields are included in this request which are already mentioned above.<br /> These are "Accept-Language" and "User-Agent".<br /> * "Accept-Language" contains the language of current locale - found in configuration item "org.openoffice.Setup/L10N", attribute "ooLocale"<br /> * "User-Agent" contains needed information to identify the installed office version - see above. The information matches the following pattern which is found in file <version.ini> resp. <versionrc>:<br /> <blockquote><br /> <pre><br /> <PRODUCT> (${buildid}; ${_OS}; ${_ARCH}; BundledLanguages=${AllLanguages}) <br /> </pre><br /> </blockquote><br /> On platforms other than Windows the <UpdateURL> contains (at least since OOo 3.3) a query part. It is ''?pkgfmt=<pkgformat>'' which especially for Linux platforms identifies the package format of the office installation.<br /> <br /> It reveals that this information can be used to create the corresponding information for the request response.<br /> <br /> == information about processing the request response ==<br /> <br /> The response is expected to be a corresponding XML snippet.<br /> As shown in the above examples, two types of XML snippets as responses are possible:<br /> a ''feed'' response and a ''simple'' response. The distinction between the two is made by its first element. If it is <feed> it is treated as a ''feed'' response, otherwise as a ''simple'' response.<br /> <br /> ==== ''simple'' response ====<br /> <br /> The ''simple'' response is an XML snippet which is expected to have the format as the XML snippet in file [http://svn.apache.org/repos/asf/incubator/ooo/trunk/main/instsetoo_native/util/update.xml update.xml], found in our source repository.<br /> <br /> The following conditions must hold to perform further evaluation of the response:<br /> # value of <inst:os> matches the one of the installed office - ''${_ARCH}''.<br /> # value of <inst:arch> matches the one of the installed office - ''${_OS}''.<br /> # value of <inst:buildid> is greater than the one of the installed office - ''${buildid}''.<br /> If these conditions hold, the following information is retrieved:<br /> # values of attributes <src> and <type> of <inst:update><br /> #* if value of <type> equals "text/html", the value of <src> is taken as an website from which the new version can be downloaded manually. Otherwise (also in case that attribute <type> is missing) the value of <src> is interpreted as a download link to the new version.<br /> #* all <inst:update> elements are evaluated. The information of the first one is used - provide download of version or provide link to download website. The purpose of the other is not known.<br /> # value of <inst:version> - will be shown in the corresponding dialog.<br /> # value of <inst:buildid> - currently its purpose is not known.<br /> If the first information - download website or download link - can be found in the XML snippet, the corresponding dialog will state that a new version is available. The user can then download it manually or can trigger an automatic download.<br /> <br /> If no download website/link is found, the dialog will state that the installed office is up to date.<br /> <br /> ==== ''feed'' response ====<br /> <br /> The ''feed'' response is expected to conform to [http://tools.ietf.org/wg/atompub/draft-ietf-atompub-format/rfc4287.txt atom feed] - as stated above in the example area.<br /> Each content of the <content> element of an atom entry (<entry> element) whose <category> element has an attribute <term> whose value matches the <UpdateId> value found in file <version.ini> resp. <versionrc> of the installed office is treated as ''simple'' response. <br /> <br /> The first of these ''simple'' responses from which a download website or a download link could be retrieved that matches the above given conditions is taken - the following ones are not processed. It will be shown to the user that a new version is available, and the user can trigger the download manually or automatically. One further information is taken from this atom entry - the content of the <summary> element. It is shown in the corresponding dialog.<br /> <br /> If no download website/link is found, the dialog will state that the installed office is up to date.<br /> <br /> [[Category:Spec]]</div>

Od https://wiki.openoffice.org/w/index.php?title=Update_Service&diff=235379 Update Service 2014-07-10T10:12:33Z

<p>Od: </p> <hr /> <div>== Introduction ==<br /> The Update Service for AOO/OOo is a service which provides via HTTP or HTTPS an Update Feed (or Update Document) for installed AOO/OOo instance. This allows the requesting AOO/OOo instance to check, if a new AOO version is available and to provide the result of this check to the user.<br /> <br /> Currently, the Update Service is implemented via static HTTP/HTTPS resources. Currently, no dynamic component is involved which processes the information given in the HTTP/HTTPS request of the AOO/OOo instance in order to generate a response.<br /> <br /> <br /> = Available Update Feeds =<br /> <br /> For the following AOO/OOo versions an Update Feed is made available.<br /> The table contains the UpdateURL which an AOO/OOo instance of the specified version is requesting via HTTP/HTTPS and the resource in our svn repository which serves the HTTP/HTTPS resource behind the UpdateURL.<br /> <br /> {| class="wikitable" border="1"<br /> |-<br /> ! AOO/OOo version<br /> ! UpdateURL<br /> ! Resource in svn repository<br /> |-<br /> | OOo 3.2<br /> | http://www.openoffice.org/projects/update34/ProductUpdateService/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/ooo-site/trunk/content/projects/update34/ProductUpdateService/check.Update ooo-site/update34]<br /> |-<br /> | OOo 3.2.1<br /> | http://www.openoffice.org/projects/update35/ProductUpdateService/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/ooo-site/trunk/content/projects/update35/ProductUpdateService/check.Update ooo-site/update35]<br /> |-<br /> | OOo 3.3<br /> | http://www.openoffice.org/projects/update36/ProductUpdateService/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/ooo-site/trunk/content/projects/update36/ProductUpdateService/check.Update ooo-site/update36]<br /> |-<br /> | AOO 3.4.0<br /> | http://www.openoffice.org/projects/update38/ProductUpdateService/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/ooo-site/trunk/content/projects/update38/ProductUpdateService/check.Update ooo-site/update38]<br /> |-<br /> | AOO 3.4.1<br /> | http://www.openoffice.org/projects/update/aoo341/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/ooo-site/trunk/content/projects/update/aoo341/check.Update ooo-site/update/aoo341]<br /> |-<br /> | AOO 4.0.0<br /> | https://ooo-updates.apache.org/aoo40/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/update-site/trunk/aoo40/check.Update update-site/aoo40]<br /> |-<br /> | AOO 4.0.1<br /> | https://ooo-updates.apache.org/aoo401/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/update-site/trunk/aoo401/check.Update update-site/aoo401]<br /> |-<br /> | AOO 4.1.0<br /> | https://ooo-updates.apache.org/aoo401/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/update-site/trunk/aoo401/check.Update update-site/aoo410]<br /> |-<br /> | AOO 4.1.1<br /> [currently not active]<br /> | https://ooo-updates.apache.org/aoo410/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/update-site/trunk/aoo410/check.Update update-site/aoo411]<br /> |}<br /> <br /> = Update Notification Protocol =<br /> <br /> == Introduction ==<br /> <br /> Since version 2.0.3 OpenOffice.org users of builds providing an UpdateURL can manually check for available updates by invoking "Help -> Check for Updates .." . Starting with version 2.0.4 OpenOffice.org can perform this check automatically in a user configurable interval. <br /> <br /> This is an attempt to define a second version of the update notification protocol, which is better extendable, can also be used for [[Extensions | extensions]] and no longer uses http post requests.<br /> <br /> {{Documentation/Note|Note: Even though this document is a draft, it seems to be the actually implemented version as of OpenOffice.org 3.3. See http://s.apache.org/e2u for more information.}}<br /> <br /> == Request ==<br /> <br /> The update notification request is a http get request to an URL, which may contain the operating system and processor type the OpenOffice.org instance is compiled for either as part of the URL or as URL parameter.<br /> <br /> === Examples ===<br /> <br /> <pre><br /> UpdateURL=http://update.services.openoffice.org/ProductUpdateService/check.Update2?_OS=Solaris&_ARCH=SPARC<br /> </pre><br /> <br /> <pre><br /> UpdateURL=http://www.example.org/MyProduct/MyOS/MyArch<br /> </pre><br /> <br /> == User-Agent field ==<br /> <br /> To reduce the amount of transfered data when asking for OpenOffice.org updates, the user agent field contains all information required to identify a specific build: <br /> <br /> <pre><br /> User-Agent: OpenOffice.org/2.2 (680m212 (Build:9263); Solaris; SPARC; BundledLanguages=en-US_fr)<br /> </pre><br /> <br /> == Accept-Language field ==<br /> <br /> To be able to return language specific feeds, OpenOffice.org sets the Accept-Language http request header field to the UI language currently in use:<br /> <br /> <pre><br /> Accept-Language: en-GB<br /> </pre><br /> <br /> == Update documents and feeds ==<br /> <br /> The simplest possible reply is of the following form:<br /> <br /> <source lang="xml"><br /> <?xml version="1.0" encoding="utf-8"?><br /> <inst:description xmlns:inst="http://installation.openoffice.org/description"><br /> <inst:id>OpenOffice.org_2_en-US_fr</inst:id><br /> <inst:version>2.2.0-5</inst:version><br /> <inst:buildid>9095</inst:buildid><br /> <inst:os>Solaris</inst:os><br /> <inst:arch>SPARC</inst:arch><br /> <inst:update type="text/html" src="http://update.services.openoffice.org/ooo/snapshot.html" /><br /> </inst:description><br /> </source><br /> <br /> As the type attribute of the update tag is "text/html", OOo will pass the URL specified in the src attribute to a browser. If you specify a different type, e.g.<br /> <br /> <source lang="xml"><br /> <inst:update type="application/octet-stream" src="http://openoffice.bouncer.osuosl.org/?product=OpenOffice.org&os=solarissparcwjre&lang=en-US&version=2.4" /><br /> </source><br /> <br /> OOo will download the referenced file itself.<br /> <br /> <br /> The other supported reply format, which also allows to include several components or several versions of a single component, is to embed the update document in an [http://tools.ietf.org/wg/atompub/draft-ietf-atompub-format/rfc4287.txt atom feed].<br /> <br /> <source lang="xml"><br /> <?xml version="1.0" encoding="utf-8"?><br /> <feed xmlns="http://www.w3.org/2005/Atom" xml:lang”en-US”><br /> <br /> <title>OpenOffice.org Update Feed</title><br /> <link rel="alternate" type="text/html" href="http://update.services.openoffice.org/ooo/snapshot.html"/><br /> <updated>2006-11-06T18:30:02Z</updated><br /> <author><br /> <name>The OpenOffice.org Project</name><br /> <uri>http://openoffice.org</uri><br /> <email>updatefeed@openoffice.org</email><br /> </author><br /> <id>urn:uuid:a4ccd383-1dd1-11b2-a95c-0003ba566e9d</id><br /> <entry><br /> <title>OpenOffice.org 2.2 available</title><br /> <link rel="alternate" type="text/html"<br /> href="http://update.services.openoffice.org/ooo/snapshot.html"/><br /> <id>urn:uuid:a4ccd383-1dd1-11b2-a95c-0003ba566e9e</id><br /> <updated>2006-11-06T18:30:02Z</updated><br /> <summary>Click here to go to the download page.</summary><br /> <category term="OpenOffice.org_2_en-US_fr" label="OpenOffice.org 2.2 US english/french" /><br /> <content type="application/xml"><br /> <inst:description xmlns:inst="http://installation.openoffice.org/description"><br /> <inst:id>OpenOffice.org_2_en-US_fr</inst:id><br /> <inst:version>2.2.0-5</inst:version><br /> <inst:buildid>9095</inst:buildid><br /> <inst:os>Solaris</inst:os><br /> <inst:arch>SPARC</inst:arch><br /> <inst:update type="text/html" src="http://update.services.openoffice.org/ooo/snapshot.html" /><br /> </inst:description><br /> </content><br /> </entry><br /> </feed><br /> </source><br /> <br /> ''description.xml'' OpenOffice.org 3.x update information example<br /> <br /> The following content of a ''description.xml'' directly references update information for a German Windows OpenOffice.org 3.3.0:<br /> <source lang="xml"><br /> <?xml version="1.0" encoding="utf-8"?><br /> <feed xmlns="http://www.w3.org/2005/Atom" xml:lang="en-US"><br /> <title>Product Update Feed</title><br /> <link rel="alternate" type="text/html" href="http://update.services.openoffice.org/ooo/snapshot.html"/><br /> <updated>2011-01-01T08:00:02Z</updated><br /> <author><br /> <name>The OpenOffice Project</name><br /> <uri>http://openoffice.org</uri><br /> <email>updatefeed@openoffice.org</email><br /> </author><br /> <id>urn:uuid:76676544</id><br /> <entry><br /> <title>Update available</title><br /> <link rel="alternate" type="text/html" href="http://update.services.openoffice.org/ooo/snapshot.html"/><br /> <id>urn:uuid:76676544</id><br /> <br /> <category term="OpenOffice.org_3_de" label="OpenOffice.org update"/><br /> <updated>2011-01-01T08:00:02Z</updated><br /> <summary>Text below download information (should be localized)</summary><br /> <content type="application/xml"><br /> <inst:description xmlns:inst="http://installation.openoffice.org/description"><br /> <inst:id>OpenOffice.org_3_de</inst:id><br /> <inst:version>'new version information'</inst:version><br /> <br /> <inst:buildid>9580</inst:buildid><br /> <inst:os>Windows</inst:os><br /> <inst:arch>x86</inst:arch><br /> <br /> <br /> <br /> <inst:update type="text/html" src="http://download.openoffice.org"/><br /> </inst:description><br /> </content><br /> </entry><br /> </feed><br /> </source><br /> <br /> '''Note''': to allow proper filtering, the <tt>term</tt> tag of the <category> node of the <atom:entry> element must contain the <inst:id> string of the component to be updated.<br /> <br /> <br /> Extension developers might prefer to link to the update description file instead of embedding it:<br /> <br /> <source lang="xml"><br /> <?xml version="1.0" encoding="utf-8"?><br /> <feed xmlns="http://www.w3.org/2005/Atom" xml:lang”en-US”><br /> <br /> <title>My Extention Update Feed</title><br /> <link rel="alternate" type="text/html" href="http://update.services.openoffice.org/ooo/snapshot.html"/><br /> <updated>2006-11-06T18:30:02Z</updated><br /> <author><br /> <name>Extension Developer</name><br /> <uri>http://example.org</uri><br /> <email>update@example.org</email><br /> </author><br /> <id>urn:uuid:a4ccd383-1dd1-11b2-a95c-0003ba566e9d</id><br /> <entry><br /> <title>Version 2 available</title><br /> <link rel="alternate" type="text/html"<br /> href="http://example.org/myextension/latest.html"/><br /> <id>MyExtension+version</id><br /> <updated>2006-11-06T18:30:02Z</updated><br /> <category term="MyExtension" label="My Extension" /><br /> <content type="application/xml" src="http://example.org/myextension/latest/myextension.update.xml" /><br /> </entry><br /> </feed><br /> </source><br /> <br /> '''Note''': to allow proper filtering, the <tt>term</tt> tag of the <category> node of the <atom:entry> element must contain the <identifier> value of the extension to be updated.<br /> <br /> = A glance on the code for the Apache OpenOffice 3.4 release =<br /> <br /> The following describes some deeper insight of the "Check for Updates..." code in the office. It should help us to re-activate a corresponding web service when Apache OpenOffice 3.4 has been released. (Do we need a real web service? Something to be discussed.)<br /> <br /> The information given here is based on the work of Regina (regina at apache dot org), Ariel (arielch at apache dot org) and Kay (kschenk at apache dot org) found in the corresponding mailing list thread on ooo-dev - see http://s.apache.org/e2u.<br /> Having this information gave me (orw at apache dot org) the right pointers for deeper investigations.<br /> <br /> == summary information about request to <UpdateURL> ==<br /> <br /> The <UpdateURL>, found in file <version.ini> resp. <versionrc> of the office installation is typically an HTTP URL.<br /> The office sends a GET request to this URL. Two header fields are included in this request which are already mentioned above.<br /> These are "Accept-Language" and "User-Agent".<br /> * "Accept-Language" contains the language of current locale - found in configuration item "org.openoffice.Setup/L10N", attribute "ooLocale"<br /> * "User-Agent" contains needed information to identify the installed office version - see above. The information matches the following pattern which is found in file <version.ini> resp. <versionrc>:<br /> <blockquote><br /> <pre><br /> <PRODUCT> (${buildid}; ${_OS}; ${_ARCH}; BundledLanguages=${AllLanguages}) <br /> </pre><br /> </blockquote><br /> On platforms other than Windows the <UpdateURL> contains (at least since OOo 3.3) a query part. It is ''?pkgfmt=<pkgformat>'' which especially for Linux platforms identifies the package format of the office installation.<br /> <br /> It reveals that this information can be used to create the corresponding information for the request response.<br /> <br /> == information about processing the request response ==<br /> <br /> The response is expected to be a corresponding XML snippet.<br /> As shown in the above examples, two types of XML snippets as responses are possible:<br /> a ''feed'' response and a ''simple'' response. The distinction between the two is made by its first element. If it is <feed> it is treated as a ''feed'' response, otherwise as a ''simple'' response.<br /> <br /> ==== ''simple'' response ====<br /> <br /> The ''simple'' response is an XML snippet which is expected to have the format as the XML snippet in file [http://svn.apache.org/repos/asf/incubator/ooo/trunk/main/instsetoo_native/util/update.xml update.xml], found in our source repository.<br /> <br /> The following conditions must hold to perform further evaluation of the response:<br /> # value of <inst:os> matches the one of the installed office - ''${_ARCH}''.<br /> # value of <inst:arch> matches the one of the installed office - ''${_OS}''.<br /> # value of <inst:buildid> is greater than the one of the installed office - ''${buildid}''.<br /> If these conditions hold, the following information is retrieved:<br /> # values of attributes <src> and <type> of <inst:update><br /> #* if value of <type> equals "text/html", the value of <src> is taken as an website from which the new version can be downloaded manually. Otherwise (also in case that attribute <type> is missing) the value of <src> is interpreted as a download link to the new version.<br /> #* all <inst:update> elements are evaluated. The information of the first one is used - provide download of version or provide link to download website. The purpose of the other is not known.<br /> # value of <inst:version> - will be shown in the corresponding dialog.<br /> # value of <inst:buildid> - currently its purpose is not known.<br /> If the first information - download website or download link - can be found in the XML snippet, the corresponding dialog will state that a new version is available. The user can then download it manually or can trigger an automatic download.<br /> <br /> If no download website/link is found, the dialog will state that the installed office is up to date.<br /> <br /> ==== ''feed'' response ====<br /> <br /> The ''feed'' response is expected to conform to [http://tools.ietf.org/wg/atompub/draft-ietf-atompub-format/rfc4287.txt atom feed] - as stated above in the example area.<br /> Each content of the <content> element of an atom entry (<entry> element) whose <category> element has an attribute <term> whose value matches the <UpdateId> value found in file <version.ini> resp. <versionrc> of the installed office is treated as ''simple'' response. <br /> <br /> The first of these ''simple'' responses from which a download website or a download link could be retrieved that matches the above given conditions is taken - the following ones are not processed. It will be shown to the user that a new version is available, and the user can trigger the download manually or automatically. One further information is taken from this atom entry - the content of the <summary> element. It is shown in the corresponding dialog.<br /> <br /> If no download website/link is found, the dialog will state that the installed office is up to date.<br /> <br /> [[Category:Spec]]</div>

Od https://wiki.openoffice.org/w/index.php?title=Update_Service&diff=235378 Update Service 2014-07-10T10:11:45Z

<p>Od: </p> <hr /> <div><br /> The Update Service for AOO/OOo is a service which provides via HTTP or HTTPS an Update Feed (or Update Document) for installed AOO/OOo instance. This allows the requesting AOO/OOo instance to check, if a new AOO version is available and to provide the result of this check to the user.<br /> <br /> Currently, the Update Service is implemented via static HTTP/HTTPS resources. Currently, no dynamic component is involved which processes the information given in the HTTP/HTTPS request of the AOO/OOo instance in order to generate a response.<br /> <br /> = Available Update Feeds =<br /> <br /> For the following AOO/OOo versions an Update Feed is made available.<br /> The table contains the UpdateURL which an AOO/OOo instance of the specified version is requesting via HTTP/HTTPS and the resource in our svn repository which serves the HTTP/HTTPS resource behind the UpdateURL.<br /> <br /> {| class="wikitable" border="1"<br /> |-<br /> ! AOO/OOo version<br /> ! UpdateURL<br /> ! Resource in svn repository<br /> |-<br /> | OOo 3.2<br /> | http://www.openoffice.org/projects/update34/ProductUpdateService/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/ooo-site/trunk/content/projects/update34/ProductUpdateService/check.Update ooo-site/update34]<br /> |-<br /> | OOo 3.2.1<br /> | http://www.openoffice.org/projects/update35/ProductUpdateService/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/ooo-site/trunk/content/projects/update35/ProductUpdateService/check.Update ooo-site/update35]<br /> |-<br /> | OOo 3.3<br /> | http://www.openoffice.org/projects/update36/ProductUpdateService/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/ooo-site/trunk/content/projects/update36/ProductUpdateService/check.Update ooo-site/update36]<br /> |-<br /> | AOO 3.4.0<br /> | http://www.openoffice.org/projects/update38/ProductUpdateService/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/ooo-site/trunk/content/projects/update38/ProductUpdateService/check.Update ooo-site/update38]<br /> |-<br /> | AOO 3.4.1<br /> | http://www.openoffice.org/projects/update/aoo341/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/ooo-site/trunk/content/projects/update/aoo341/check.Update ooo-site/update/aoo341]<br /> |-<br /> | AOO 4.0.0<br /> | https://ooo-updates.apache.org/aoo40/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/update-site/trunk/aoo40/check.Update update-site/aoo40]<br /> |-<br /> | AOO 4.0.1<br /> | https://ooo-updates.apache.org/aoo401/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/update-site/trunk/aoo401/check.Update update-site/aoo401]<br /> |-<br /> | AOO 4.1.0<br /> | https://ooo-updates.apache.org/aoo401/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/update-site/trunk/aoo401/check.Update update-site/aoo410]<br /> |-<br /> | AOO 4.1.1<br /> [currently not active]<br /> | https://ooo-updates.apache.org/aoo410/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/update-site/trunk/aoo410/check.Update update-site/aoo411]<br /> |}<br /> <br /> = Update Notification Protocol =<br /> <br /> == Introduction ==<br /> <br /> Since version 2.0.3 OpenOffice.org users of builds providing an UpdateURL can manually check for available updates by invoking "Help -> Check for Updates .." . Starting with version 2.0.4 OpenOffice.org can perform this check automatically in a user configurable interval. <br /> <br /> This is an attempt to define a second version of the update notification protocol, which is better extendable, can also be used for [[Extensions | extensions]] and no longer uses http post requests.<br /> <br /> {{Documentation/Note|Note: Even though this document is a draft, it seems to be the actually implemented version as of OpenOffice.org 3.3. See http://s.apache.org/e2u for more information.}}<br /> <br /> == Request ==<br /> <br /> The update notification request is a http get request to an URL, which may contain the operating system and processor type the OpenOffice.org instance is compiled for either as part of the URL or as URL parameter.<br /> <br /> === Examples ===<br /> <br /> <pre><br /> UpdateURL=http://update.services.openoffice.org/ProductUpdateService/check.Update2?_OS=Solaris&_ARCH=SPARC<br /> </pre><br /> <br /> <pre><br /> UpdateURL=http://www.example.org/MyProduct/MyOS/MyArch<br /> </pre><br /> <br /> == User-Agent field ==<br /> <br /> To reduce the amount of transfered data when asking for OpenOffice.org updates, the user agent field contains all information required to identify a specific build: <br /> <br /> <pre><br /> User-Agent: OpenOffice.org/2.2 (680m212 (Build:9263); Solaris; SPARC; BundledLanguages=en-US_fr)<br /> </pre><br /> <br /> == Accept-Language field ==<br /> <br /> To be able to return language specific feeds, OpenOffice.org sets the Accept-Language http request header field to the UI language currently in use:<br /> <br /> <pre><br /> Accept-Language: en-GB<br /> </pre><br /> <br /> == Update documents and feeds ==<br /> <br /> The simplest possible reply is of the following form:<br /> <br /> <source lang="xml"><br /> <?xml version="1.0" encoding="utf-8"?><br /> <inst:description xmlns:inst="http://installation.openoffice.org/description"><br /> <inst:id>OpenOffice.org_2_en-US_fr</inst:id><br /> <inst:version>2.2.0-5</inst:version><br /> <inst:buildid>9095</inst:buildid><br /> <inst:os>Solaris</inst:os><br /> <inst:arch>SPARC</inst:arch><br /> <inst:update type="text/html" src="http://update.services.openoffice.org/ooo/snapshot.html" /><br /> </inst:description><br /> </source><br /> <br /> As the type attribute of the update tag is "text/html", OOo will pass the URL specified in the src attribute to a browser. If you specify a different type, e.g.<br /> <br /> <source lang="xml"><br /> <inst:update type="application/octet-stream" src="http://openoffice.bouncer.osuosl.org/?product=OpenOffice.org&os=solarissparcwjre&lang=en-US&version=2.4" /><br /> </source><br /> <br /> OOo will download the referenced file itself.<br /> <br /> <br /> The other supported reply format, which also allows to include several components or several versions of a single component, is to embed the update document in an [http://tools.ietf.org/wg/atompub/draft-ietf-atompub-format/rfc4287.txt atom feed].<br /> <br /> <source lang="xml"><br /> <?xml version="1.0" encoding="utf-8"?><br /> <feed xmlns="http://www.w3.org/2005/Atom" xml:lang”en-US”><br /> <br /> <title>OpenOffice.org Update Feed</title><br /> <link rel="alternate" type="text/html" href="http://update.services.openoffice.org/ooo/snapshot.html"/><br /> <updated>2006-11-06T18:30:02Z</updated><br /> <author><br /> <name>The OpenOffice.org Project</name><br /> <uri>http://openoffice.org</uri><br /> <email>updatefeed@openoffice.org</email><br /> </author><br /> <id>urn:uuid:a4ccd383-1dd1-11b2-a95c-0003ba566e9d</id><br /> <entry><br /> <title>OpenOffice.org 2.2 available</title><br /> <link rel="alternate" type="text/html"<br /> href="http://update.services.openoffice.org/ooo/snapshot.html"/><br /> <id>urn:uuid:a4ccd383-1dd1-11b2-a95c-0003ba566e9e</id><br /> <updated>2006-11-06T18:30:02Z</updated><br /> <summary>Click here to go to the download page.</summary><br /> <category term="OpenOffice.org_2_en-US_fr" label="OpenOffice.org 2.2 US english/french" /><br /> <content type="application/xml"><br /> <inst:description xmlns:inst="http://installation.openoffice.org/description"><br /> <inst:id>OpenOffice.org_2_en-US_fr</inst:id><br /> <inst:version>2.2.0-5</inst:version><br /> <inst:buildid>9095</inst:buildid><br /> <inst:os>Solaris</inst:os><br /> <inst:arch>SPARC</inst:arch><br /> <inst:update type="text/html" src="http://update.services.openoffice.org/ooo/snapshot.html" /><br /> </inst:description><br /> </content><br /> </entry><br /> </feed><br /> </source><br /> <br /> ''description.xml'' OpenOffice.org 3.x update information example<br /> <br /> The following content of a ''description.xml'' directly references update information for a German Windows OpenOffice.org 3.3.0:<br /> <source lang="xml"><br /> <?xml version="1.0" encoding="utf-8"?><br /> <feed xmlns="http://www.w3.org/2005/Atom" xml:lang="en-US"><br /> <title>Product Update Feed</title><br /> <link rel="alternate" type="text/html" href="http://update.services.openoffice.org/ooo/snapshot.html"/><br /> <updated>2011-01-01T08:00:02Z</updated><br /> <author><br /> <name>The OpenOffice Project</name><br /> <uri>http://openoffice.org</uri><br /> <email>updatefeed@openoffice.org</email><br /> </author><br /> <id>urn:uuid:76676544</id><br /> <entry><br /> <title>Update available</title><br /> <link rel="alternate" type="text/html" href="http://update.services.openoffice.org/ooo/snapshot.html"/><br /> <id>urn:uuid:76676544</id><br /> <br /> <category term="OpenOffice.org_3_de" label="OpenOffice.org update"/><br /> <updated>2011-01-01T08:00:02Z</updated><br /> <summary>Text below download information (should be localized)</summary><br /> <content type="application/xml"><br /> <inst:description xmlns:inst="http://installation.openoffice.org/description"><br /> <inst:id>OpenOffice.org_3_de</inst:id><br /> <inst:version>'new version information'</inst:version><br /> <br /> <inst:buildid>9580</inst:buildid><br /> <inst:os>Windows</inst:os><br /> <inst:arch>x86</inst:arch><br /> <br /> <br /> <br /> <inst:update type="text/html" src="http://download.openoffice.org"/><br /> </inst:description><br /> </content><br /> </entry><br /> </feed><br /> </source><br /> <br /> '''Note''': to allow proper filtering, the <tt>term</tt> tag of the <category> node of the <atom:entry> element must contain the <inst:id> string of the component to be updated.<br /> <br /> <br /> Extension developers might prefer to link to the update description file instead of embedding it:<br /> <br /> <source lang="xml"><br /> <?xml version="1.0" encoding="utf-8"?><br /> <feed xmlns="http://www.w3.org/2005/Atom" xml:lang”en-US”><br /> <br /> <title>My Extention Update Feed</title><br /> <link rel="alternate" type="text/html" href="http://update.services.openoffice.org/ooo/snapshot.html"/><br /> <updated>2006-11-06T18:30:02Z</updated><br /> <author><br /> <name>Extension Developer</name><br /> <uri>http://example.org</uri><br /> <email>update@example.org</email><br /> </author><br /> <id>urn:uuid:a4ccd383-1dd1-11b2-a95c-0003ba566e9d</id><br /> <entry><br /> <title>Version 2 available</title><br /> <link rel="alternate" type="text/html"<br /> href="http://example.org/myextension/latest.html"/><br /> <id>MyExtension+version</id><br /> <updated>2006-11-06T18:30:02Z</updated><br /> <category term="MyExtension" label="My Extension" /><br /> <content type="application/xml" src="http://example.org/myextension/latest/myextension.update.xml" /><br /> </entry><br /> </feed><br /> </source><br /> <br /> '''Note''': to allow proper filtering, the <tt>term</tt> tag of the <category> node of the <atom:entry> element must contain the <identifier> value of the extension to be updated.<br /> <br /> = A glance on the code for the Apache OpenOffice 3.4 release =<br /> <br /> The following describes some deeper insight of the "Check for Updates..." code in the office. It should help us to re-activate a corresponding web service when Apache OpenOffice 3.4 has been released. (Do we need a real web service? Something to be discussed.)<br /> <br /> The information given here is based on the work of Regina (regina at apache dot org), Ariel (arielch at apache dot org) and Kay (kschenk at apache dot org) found in the corresponding mailing list thread on ooo-dev - see http://s.apache.org/e2u.<br /> Having this information gave me (orw at apache dot org) the right pointers for deeper investigations.<br /> <br /> == summary information about request to <UpdateURL> ==<br /> <br /> The <UpdateURL>, found in file <version.ini> resp. <versionrc> of the office installation is typically an HTTP URL.<br /> The office sends a GET request to this URL. Two header fields are included in this request which are already mentioned above.<br /> These are "Accept-Language" and "User-Agent".<br /> * "Accept-Language" contains the language of current locale - found in configuration item "org.openoffice.Setup/L10N", attribute "ooLocale"<br /> * "User-Agent" contains needed information to identify the installed office version - see above. The information matches the following pattern which is found in file <version.ini> resp. <versionrc>:<br /> <blockquote><br /> <pre><br /> <PRODUCT> (${buildid}; ${_OS}; ${_ARCH}; BundledLanguages=${AllLanguages}) <br /> </pre><br /> </blockquote><br /> On platforms other than Windows the <UpdateURL> contains (at least since OOo 3.3) a query part. It is ''?pkgfmt=<pkgformat>'' which especially for Linux platforms identifies the package format of the office installation.<br /> <br /> It reveals that this information can be used to create the corresponding information for the request response.<br /> <br /> == information about processing the request response ==<br /> <br /> The response is expected to be a corresponding XML snippet.<br /> As shown in the above examples, two types of XML snippets as responses are possible:<br /> a ''feed'' response and a ''simple'' response. The distinction between the two is made by its first element. If it is <feed> it is treated as a ''feed'' response, otherwise as a ''simple'' response.<br /> <br /> ==== ''simple'' response ====<br /> <br /> The ''simple'' response is an XML snippet which is expected to have the format as the XML snippet in file [http://svn.apache.org/repos/asf/incubator/ooo/trunk/main/instsetoo_native/util/update.xml update.xml], found in our source repository.<br /> <br /> The following conditions must hold to perform further evaluation of the response:<br /> # value of <inst:os> matches the one of the installed office - ''${_ARCH}''.<br /> # value of <inst:arch> matches the one of the installed office - ''${_OS}''.<br /> # value of <inst:buildid> is greater than the one of the installed office - ''${buildid}''.<br /> If these conditions hold, the following information is retrieved:<br /> # values of attributes <src> and <type> of <inst:update><br /> #* if value of <type> equals "text/html", the value of <src> is taken as an website from which the new version can be downloaded manually. Otherwise (also in case that attribute <type> is missing) the value of <src> is interpreted as a download link to the new version.<br /> #* all <inst:update> elements are evaluated. The information of the first one is used - provide download of version or provide link to download website. The purpose of the other is not known.<br /> # value of <inst:version> - will be shown in the corresponding dialog.<br /> # value of <inst:buildid> - currently its purpose is not known.<br /> If the first information - download website or download link - can be found in the XML snippet, the corresponding dialog will state that a new version is available. The user can then download it manually or can trigger an automatic download.<br /> <br /> If no download website/link is found, the dialog will state that the installed office is up to date.<br /> <br /> ==== ''feed'' response ====<br /> <br /> The ''feed'' response is expected to conform to [http://tools.ietf.org/wg/atompub/draft-ietf-atompub-format/rfc4287.txt atom feed] - as stated above in the example area.<br /> Each content of the <content> element of an atom entry (<entry> element) whose <category> element has an attribute <term> whose value matches the <UpdateId> value found in file <version.ini> resp. <versionrc> of the installed office is treated as ''simple'' response. <br /> <br /> The first of these ''simple'' responses from which a download website or a download link could be retrieved that matches the above given conditions is taken - the following ones are not processed. It will be shown to the user that a new version is available, and the user can trigger the download manually or automatically. One further information is taken from this atom entry - the content of the <summary> element. It is shown in the corresponding dialog.<br /> <br /> If no download website/link is found, the dialog will state that the installed office is up to date.<br /> <br /> [[Category:Spec]]</div>

Od https://wiki.openoffice.org/w/index.php?title=Update_Service&diff=235377 Update Service 2014-07-10T10:04:07Z

<p>Od: /* Available Update Feeds */</p> <hr /> <div>= Available Update Feeds =<br /> <br /> For the following AOO/OOo versions an Update Feed is made available.<br /> The table contains the UpdateURL which an AOO/OOo instance of the specified version is requesting via HTTP/HTTPS and the resource in our svn repository which serves the HTTP/HTTPS resource behind the UpdateURL.<br /> <br /> {| class="wikitable" border="1"<br /> |-<br /> ! AOO/OOo version<br /> ! UpdateURL<br /> ! Resource in svn repository<br /> |-<br /> | OOo 3.2<br /> | http://www.openoffice.org/projects/update34/ProductUpdateService/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/ooo-site/trunk/content/projects/update34/ProductUpdateService/check.Update ooo-site/update34]<br /> |-<br /> | OOo 3.2.1<br /> | http://www.openoffice.org/projects/update35/ProductUpdateService/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/ooo-site/trunk/content/projects/update35/ProductUpdateService/check.Update ooo-site/update35]<br /> |-<br /> | OOo 3.3<br /> | http://www.openoffice.org/projects/update36/ProductUpdateService/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/ooo-site/trunk/content/projects/update36/ProductUpdateService/check.Update ooo-site/update36]<br /> |-<br /> | AOO 3.4.0<br /> | http://www.openoffice.org/projects/update38/ProductUpdateService/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/ooo-site/trunk/content/projects/update38/ProductUpdateService/check.Update ooo-site/update38]<br /> |-<br /> | AOO 3.4.1<br /> | http://www.openoffice.org/projects/update/aoo341/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/ooo-site/trunk/content/projects/update/aoo341/check.Update ooo-site/update/aoo341]<br /> |-<br /> | AOO 4.0.0<br /> | https://ooo-updates.apache.org/aoo40/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/update-site/trunk/aoo40/check.Update update-site/aoo40]<br /> |-<br /> | AOO 4.0.1<br /> | https://ooo-updates.apache.org/aoo401/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/update-site/trunk/aoo401/check.Update update-site/aoo401]<br /> |-<br /> | AOO 4.1.0<br /> | https://ooo-updates.apache.org/aoo401/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/update-site/trunk/aoo401/check.Update update-site/aoo410]<br /> |-<br /> | AOO 4.1.1<br /> [currently not active]<br /> | https://ooo-updates.apache.org/aoo410/check.Update<br /> | [http://svn.apache.org/repos/asf/openoffice/update-site/trunk/aoo410/check.Update update-site/aoo411]<br /> |}<br /> <br /> = Update Notification Protocol =<br /> <br /> == Introduction ==<br /> <br /> Since version 2.0.3 OpenOffice.org users of builds providing an UpdateURL can manually check for available updates by invoking "Help -> Check for Updates .." . Starting with version 2.0.4 OpenOffice.org can perform this check automatically in a user configurable interval. <br /> <br /> This is an attempt to define a second version of the update notification protocol, which is better extendable, can also be used for [[Extensions | extensions]] and no longer uses http post requests.<br /> <br /> {{Documentation/Note|Note: Even though this document is a draft, it seems to be the actually implemented version as of OpenOffice.org 3.3. See http://s.apache.org/e2u for more information.}}<br /> <br /> == Request ==<br /> <br /> The update notification request is a http get request to an URL, which may contain the operating system and processor type the OpenOffice.org instance is compiled for either as part of the URL or as URL parameter.<br /> <br /> === Examples ===<br /> <br /> <pre><br /> UpdateURL=http://update.services.openoffice.org/ProductUpdateService/check.Update2?_OS=Solaris&_ARCH=SPARC<br /> </pre><br /> <br /> <pre><br /> UpdateURL=http://www.example.org/MyProduct/MyOS/MyArch<br /> </pre><br /> <br /> == User-Agent field ==<br /> <br /> To reduce the amount of transfered data when asking for OpenOffice.org updates, the user agent field contains all information required to identify a specific build: <br /> <br /> <pre><br /> User-Agent: OpenOffice.org/2.2 (680m212 (Build:9263); Solaris; SPARC; BundledLanguages=en-US_fr)<br /> </pre><br /> <br /> == Accept-Language field ==<br /> <br /> To be able to return language specific feeds, OpenOffice.org sets the Accept-Language http request header field to the UI language currently in use:<br /> <br /> <pre><br /> Accept-Language: en-GB<br /> </pre><br /> <br /> == Update documents and feeds ==<br /> <br /> The simplest possible reply is of the following form:<br /> <br /> <source lang="xml"><br /> <?xml version="1.0" encoding="utf-8"?><br /> <inst:description xmlns:inst="http://installation.openoffice.org/description"><br /> <inst:id>OpenOffice.org_2_en-US_fr</inst:id><br /> <inst:version>2.2.0-5</inst:version><br /> <inst:buildid>9095</inst:buildid><br /> <inst:os>Solaris</inst:os><br /> <inst:arch>SPARC</inst:arch><br /> <inst:update type="text/html" src="http://update.services.openoffice.org/ooo/snapshot.html" /><br /> </inst:description><br /> </source><br /> <br /> As the type attribute of the update tag is "text/html", OOo will pass the URL specified in the src attribute to a browser. If you specify a different type, e.g.<br /> <br /> <source lang="xml"><br /> <inst:update type="application/octet-stream" src="http://openoffice.bouncer.osuosl.org/?product=OpenOffice.org&os=solarissparcwjre&lang=en-US&version=2.4" /><br /> </source><br /> <br /> OOo will download the referenced file itself.<br /> <br /> <br /> The other supported reply format, which also allows to include several components or several versions of a single component, is to embed the update document in an [http://tools.ietf.org/wg/atompub/draft-ietf-atompub-format/rfc4287.txt atom feed].<br /> <br /> <source lang="xml"><br /> <?xml version="1.0" encoding="utf-8"?><br /> <feed xmlns="http://www.w3.org/2005/Atom" xml:lang”en-US”><br /> <br /> <title>OpenOffice.org Update Feed</title><br /> <link rel="alternate" type="text/html" href="http://update.services.openoffice.org/ooo/snapshot.html"/><br /> <updated>2006-11-06T18:30:02Z</updated><br /> <author><br /> <name>The OpenOffice.org Project</name><br /> <uri>http://openoffice.org</uri><br /> <email>updatefeed@openoffice.org</email><br /> </author><br /> <id>urn:uuid:a4ccd383-1dd1-11b2-a95c-0003ba566e9d</id><br /> <entry><br /> <title>OpenOffice.org 2.2 available</title><br /> <link rel="alternate" type="text/html"<br /> href="http://update.services.openoffice.org/ooo/snapshot.html"/><br /> <id>urn:uuid:a4ccd383-1dd1-11b2-a95c-0003ba566e9e</id><br /> <updated>2006-11-06T18:30:02Z</updated><br /> <summary>Click here to go to the download page.</summary><br /> <category term="OpenOffice.org_2_en-US_fr" label="OpenOffice.org 2.2 US english/french" /><br /> <content type="application/xml"><br /> <inst:description xmlns:inst="http://installation.openoffice.org/description"><br /> <inst:id>OpenOffice.org_2_en-US_fr</inst:id><br /> <inst:version>2.2.0-5</inst:version><br /> <inst:buildid>9095</inst:buildid><br /> <inst:os>Solaris</inst:os><br /> <inst:arch>SPARC</inst:arch><br /> <inst:update type="text/html" src="http://update.services.openoffice.org/ooo/snapshot.html" /><br /> </inst:description><br /> </content><br /> </entry><br /> </feed><br /> </source><br /> <br /> ''description.xml'' OpenOffice.org 3.x update information example<br /> <br /> The following content of a ''description.xml'' directly references update information for a German Windows OpenOffice.org 3.3.0:<br /> <source lang="xml"><br /> <?xml version="1.0" encoding="utf-8"?><br /> <feed xmlns="http://www.w3.org/2005/Atom" xml:lang="en-US"><br /> <title>Product Update Feed</title><br /> <link rel="alternate" type="text/html" href="http://update.services.openoffice.org/ooo/snapshot.html"/><br /> <updated>2011-01-01T08:00:02Z</updated><br /> <author><br /> <name>The OpenOffice Project</name><br /> <uri>http://openoffice.org</uri><br /> <email>updatefeed@openoffice.org</email><br /> </author><br /> <id>urn:uuid:76676544</id><br /> <entry><br /> <title>Update available</title><br /> <link rel="alternate" type="text/html" href="http://update.services.openoffice.org/ooo/snapshot.html"/><br /> <id>urn:uuid:76676544</id><br /> <br /> <category term="OpenOffice.org_3_de" label="OpenOffice.org update"/><br /> <updated>2011-01-01T08:00:02Z</updated><br /> <summary>Text below download information (should be localized)</summary><br /> <content type="application/xml"><br /> <inst:description xmlns:inst="http://installation.openoffice.org/description"><br /> <inst:id>OpenOffice.org_3_de</inst:id><br /> <inst:version>'new version information'</inst:version><br /> <br /> <inst:buildid>9580</inst:buildid><br /> <inst:os>Windows</inst:os><br /> <inst:arch>x86</inst:arch><br /> <br /> <br /> <br /> <inst:update type="text/html" src="http://download.openoffice.org"/><br /> </inst:description><br /> </content><br /> </entry><br /> </feed><br /> </source><br /> <br /> '''Note''': to allow proper filtering, the <tt>term</tt> tag of the <category> node of the <atom:entry> element must contain the <inst:id> string of the component to be updated.<br /> <br /> <br /> Extension developers might prefer to link to the update description file instead of embedding it:<br /> <br /> <source lang="xml"><br /> <?xml version="1.0" encoding="utf-8"?><br /> <feed xmlns="http://www.w3.org/2005/Atom" xml:lang”en-US”><br /> <br /> <title>My Extention Update Feed</title><br /> <link rel="alternate" type="text/html" href="http://update.services.openoffice.org/ooo/snapshot.html"/><br /> <updated>2006-11-06T18:30:02Z</updated><br /> <author><br /> <name>Extension Developer</name><br /> <uri>http://example.org</uri><br /> <email>update@example.org</email><br /> </author><br /> <id>urn:uuid:a4ccd383-1dd1-11b2-a95c-0003ba566e9d</id><br /> <entry><br /> <title>Version 2 available</title><br /> <link rel="alternate" type="text/html"<br /> href="http://example.org/myextension/latest.html"/><br /> <id>MyExtension+version</id><br /> <updated>2006-11-06T18:30:02Z</updated><br /> <category term="MyExtension" label="My Extension" /><br /> <content type="application/xml" src="http://example.org/myextension/latest/myextension.update.xml" /><br /> </entry><br /> </feed><br /> </source><br /> <br /> '''Note''': to allow proper filtering, the <tt>term</tt> tag of the <category> node of the <atom:entry> element must contain the <identifier> value of the extension to be updated.<br /> <br /> = A glance on the code for the Apache OpenOffice 3.4 release =<br /> <br /> The following describes some deeper insight of the "Check for Updates..." code in the office. It should help us to re-activate a corresponding web service when Apache OpenOffice 3.4 has been released. (Do we need a real web service? Something to be discussed.)<br /> <br /> The information given here is based on the work of Regina (regina at apache dot org), Ariel (arielch at apache dot org) and Kay (kschenk at apache dot org) found in the corresponding mailing list thread on ooo-dev - see http://s.apache.org/e2u.<br /> Having this information gave me (orw at apache dot org) the right pointers for deeper investigations.<br /> <br /> == summary information about request to <UpdateURL> ==<br /> <br /> The <UpdateURL>, found in file <version.ini> resp. <versionrc> of the office installation is typically an HTTP URL.<br /> The office sends a GET request to this URL. Two header fields are included in this request which are already mentioned above.<br /> These are "Accept-Language" and "User-Agent".<br /> * "Accept-Language" contains the language of current locale - found in configuration item "org.openoffice.Setup/L10N", attribute "ooLocale"<br /> * "User-Agent" contains needed information to identify the installed office version - see above. The information matches the following pattern which is found in file <version.ini> resp. <versionrc>:<br /> <blockquote><br /> <pre><br /> <PRODUCT> (${buildid}; ${_OS}; ${_ARCH}; BundledLanguages=${AllLanguages}) <br /> </pre><br /> </blockquote><br /> On platforms other than Windows the <UpdateURL> contains (at least since OOo 3.3) a query part. It is ''?pkgfmt=<pkgformat>'' which especially for Linux platforms identifies the package format of the office installation.<br /> <br /> It reveals that this information can be used to create the corresponding information for the request response.<br /> <br /> == information about processing the request response ==<br /> <br /> The response is expected to be a corresponding XML snippet.<br /> As shown in the above examples, two types of XML snippets as responses are possible:<br /> a ''feed'' response and a ''simple'' response. The distinction between the two is made by its first element. If it is <feed> it is treated as a ''feed'' response, otherwise as a ''simple'' response.<br /> <br /> ==== ''simple'' response ====<br /> <br /> The ''simple'' response is an XML snippet which is expected to have the format as the XML snippet in file [http://svn.apache.org/repos/asf/incubator/ooo/trunk/main/instsetoo_native/util/update.xml update.xml], found in our source repository.<br /> <br /> The following conditions must hold to perform further evaluation of the response:<br /> # value of <inst:os> matches the one of the installed office - ''${_ARCH}''.<br /> # value of <inst:arch> matches the one of the installed office - ''${_OS}''.<br /> # value of <inst:buildid> is greater than the one of the installed office - ''${buildid}''.<br /> If these conditions hold, the following information is retrieved:<br /> # values of attributes <src> and <type> of <inst:update><br /> #* if value of <type> equals "text/html", the value of <src> is taken as an website from which the new version can be downloaded manually. Otherwise (also in case that attribute <type> is missing) the value of <src> is interpreted as a download link to the new version.<br /> #* all <inst:update> elements are evaluated. The information of the first one is used - provide download of version or provide link to download website. The purpose of the other is not known.<br /> # value of <inst:version> - will be shown in the corresponding dialog.<br /> # value of <inst:buildid> - currently its purpose is not known.<br /> If the first information - download website or download link - can be found in the XML snippet, the corresponding dialog will state that a new version is available. The user can then download it manually or can trigger an automatic download.<br /> <br /> If no download website/link is found, the dialog will state that the installed office is up to date.<br /> <br /> ==== ''feed'' response ====<br /> <br /> The ''feed'' response is expected to conform to [http://tools.ietf.org/wg/atompub/draft-ietf-atompub-format/rfc4287.txt atom feed] - as stated above in the example area.<br /> Each content of the <content> element of an atom entry (<entry> element) whose <category> element has an attribute <term> whose value matches the <UpdateId> value found in file <version.ini> resp. <versionrc> of the installed office is treated as ''simple'' response. <br /> <br /> The first of these ''simple'' responses from which a download website or a download link could be retrieved that matches the above given conditions is taken - the following ones are not processed. It will be shown to the user that a new version is available, and the user can trigger the download manually or automatically. One further information is taken from this atom entry - the content of the <summary> element. It is shown in the corresponding dialog.<br /> <br /> If no download website/link is found, the dialog will state that the installed office is up to date.<br /> <br /> [[Category:Spec]]</div>

Od https://wiki.openoffice.org/w/index.php?title=Update_Notification_Protocol&diff=235376 Update Notification Protocol 2014-07-10T09:42:20Z

<p>Od: Redirected page to Update Service</p> <hr /> <div> #REDIRECT [[Update Service]]</div>

Od https://wiki.openoffice.org/w/index.php?title=Update_Service&diff=235375 Update Service 2014-07-10T09:41:33Z

<p>Od: Created page with "= Available Update Feeds = = Update Notification Protocol = == Introduction == Since version 2.0.3 OpenOffice.org users of builds providing an UpdateURL can manually check ..."</p> <hr /> <div>= Available Update Feeds =<br /> <br /> = Update Notification Protocol =<br /> <br /> == Introduction ==<br /> <br /> Since version 2.0.3 OpenOffice.org users of builds providing an UpdateURL can manually check for available updates by invoking "Help -> Check for Updates .." . Starting with version 2.0.4 OpenOffice.org can perform this check automatically in a user configurable interval. <br /> <br /> This is an attempt to define a second version of the update notification protocol, which is better extendable, can also be used for [[Extensions | extensions]] and no longer uses http post requests.<br /> <br /> {{Documentation/Note|Note: Even though this document is a draft, it seems to be the actually implemented version as of OpenOffice.org 3.3. See http://s.apache.org/e2u for more information.}}<br /> <br /> == Request ==<br /> <br /> The update notification request is a http get request to an URL, which may contain the operating system and processor type the OpenOffice.org instance is compiled for either as part of the URL or as URL parameter.<br /> <br /> === Examples ===<br /> <br /> <pre><br /> UpdateURL=http://update.services.openoffice.org/ProductUpdateService/check.Update2?_OS=Solaris&_ARCH=SPARC<br /> </pre><br /> <br /> <pre><br /> UpdateURL=http://www.example.org/MyProduct/MyOS/MyArch<br /> </pre><br /> <br /> == User-Agent field ==<br /> <br /> To reduce the amount of transfered data when asking for OpenOffice.org updates, the user agent field contains all information required to identify a specific build: <br /> <br /> <pre><br /> User-Agent: OpenOffice.org/2.2 (680m212 (Build:9263); Solaris; SPARC; BundledLanguages=en-US_fr)<br /> </pre><br /> <br /> == Accept-Language field ==<br /> <br /> To be able to return language specific feeds, OpenOffice.org sets the Accept-Language http request header field to the UI language currently in use:<br /> <br /> <pre><br /> Accept-Language: en-GB<br /> </pre><br /> <br /> == Update documents and feeds ==<br /> <br /> The simplest possible reply is of the following form:<br /> <br /> <source lang="xml"><br /> <?xml version="1.0" encoding="utf-8"?><br /> <inst:description xmlns:inst="http://installation.openoffice.org/description"><br /> <inst:id>OpenOffice.org_2_en-US_fr</inst:id><br /> <inst:version>2.2.0-5</inst:version><br /> <inst:buildid>9095</inst:buildid><br /> <inst:os>Solaris</inst:os><br /> <inst:arch>SPARC</inst:arch><br /> <inst:update type="text/html" src="http://update.services.openoffice.org/ooo/snapshot.html" /><br /> </inst:description><br /> </source><br /> <br /> As the type attribute of the update tag is "text/html", OOo will pass the URL specified in the src attribute to a browser. If you specify a different type, e.g.<br /> <br /> <source lang="xml"><br /> <inst:update type="application/octet-stream" src="http://openoffice.bouncer.osuosl.org/?product=OpenOffice.org&os=solarissparcwjre&lang=en-US&version=2.4" /><br /> </source><br /> <br /> OOo will download the referenced file itself.<br /> <br /> <br /> The other supported reply format, which also allows to include several components or several versions of a single component, is to embed the update document in an [http://tools.ietf.org/wg/atompub/draft-ietf-atompub-format/rfc4287.txt atom feed].<br /> <br /> <source lang="xml"><br /> <?xml version="1.0" encoding="utf-8"?><br /> <feed xmlns="http://www.w3.org/2005/Atom" xml:lang”en-US”><br /> <br /> <title>OpenOffice.org Update Feed</title><br /> <link rel="alternate" type="text/html" href="http://update.services.openoffice.org/ooo/snapshot.html"/><br /> <updated>2006-11-06T18:30:02Z</updated><br /> <author><br /> <name>The OpenOffice.org Project</name><br /> <uri>http://openoffice.org</uri><br /> <email>updatefeed@openoffice.org</email><br /> </author><br /> <id>urn:uuid:a4ccd383-1dd1-11b2-a95c-0003ba566e9d</id><br /> <entry><br /> <title>OpenOffice.org 2.2 available</title><br /> <link rel="alternate" type="text/html"<br /> href="http://update.services.openoffice.org/ooo/snapshot.html"/><br /> <id>urn:uuid:a4ccd383-1dd1-11b2-a95c-0003ba566e9e</id><br /> <updated>2006-11-06T18:30:02Z</updated><br /> <summary>Click here to go to the download page.</summary><br /> <category term="OpenOffice.org_2_en-US_fr" label="OpenOffice.org 2.2 US english/french" /><br /> <content type="application/xml"><br /> <inst:description xmlns:inst="http://installation.openoffice.org/description"><br /> <inst:id>OpenOffice.org_2_en-US_fr</inst:id><br /> <inst:version>2.2.0-5</inst:version><br /> <inst:buildid>9095</inst:buildid><br /> <inst:os>Solaris</inst:os><br /> <inst:arch>SPARC</inst:arch><br /> <inst:update type="text/html" src="http://update.services.openoffice.org/ooo/snapshot.html" /><br /> </inst:description><br /> </content><br /> </entry><br /> </feed><br /> </source><br /> <br /> ''description.xml'' OpenOffice.org 3.x update information example<br /> <br /> The following content of a ''description.xml'' directly references update information for a German Windows OpenOffice.org 3.3.0:<br /> <source lang="xml"><br /> <?xml version="1.0" encoding="utf-8"?><br /> <feed xmlns="http://www.w3.org/2005/Atom" xml:lang="en-US"><br /> <title>Product Update Feed</title><br /> <link rel="alternate" type="text/html" href="http://update.services.openoffice.org/ooo/snapshot.html"/><br /> <updated>2011-01-01T08:00:02Z</updated><br /> <author><br /> <name>The OpenOffice Project</name><br /> <uri>http://openoffice.org</uri><br /> <email>updatefeed@openoffice.org</email><br /> </author><br /> <id>urn:uuid:76676544</id><br /> <entry><br /> <title>Update available</title><br /> <link rel="alternate" type="text/html" href="http://update.services.openoffice.org/ooo/snapshot.html"/><br /> <id>urn:uuid:76676544</id><br /> <br /> <category term="OpenOffice.org_3_de" label="OpenOffice.org update"/><br /> <updated>2011-01-01T08:00:02Z</updated><br /> <summary>Text below download information (should be localized)</summary><br /> <content type="application/xml"><br /> <inst:description xmlns:inst="http://installation.openoffice.org/description"><br /> <inst:id>OpenOffice.org_3_de</inst:id><br /> <inst:version>'new version information'</inst:version><br /> <br /> <inst:buildid>9580</inst:buildid><br /> <inst:os>Windows</inst:os><br /> <inst:arch>x86</inst:arch><br /> <br /> <br /> <br /> <inst:update type="text/html" src="http://download.openoffice.org"/><br /> </inst:description><br /> </content><br /> </entry><br /> </feed><br /> </source><br /> <br /> '''Note''': to allow proper filtering, the <tt>term</tt> tag of the <category> node of the <atom:entry> element must contain the <inst:id> string of the component to be updated.<br /> <br /> <br /> Extension developers might prefer to link to the update description file instead of embedding it:<br /> <br /> <source lang="xml"><br /> <?xml version="1.0" encoding="utf-8"?><br /> <feed xmlns="http://www.w3.org/2005/Atom" xml:lang”en-US”><br /> <br /> <title>My Extention Update Feed</title><br /> <link rel="alternate" type="text/html" href="http://update.services.openoffice.org/ooo/snapshot.html"/><br /> <updated>2006-11-06T18:30:02Z</updated><br /> <author><br /> <name>Extension Developer</name><br /> <uri>http://example.org</uri><br /> <email>update@example.org</email><br /> </author><br /> <id>urn:uuid:a4ccd383-1dd1-11b2-a95c-0003ba566e9d</id><br /> <entry><br /> <title>Version 2 available</title><br /> <link rel="alternate" type="text/html"<br /> href="http://example.org/myextension/latest.html"/><br /> <id>MyExtension+version</id><br /> <updated>2006-11-06T18:30:02Z</updated><br /> <category term="MyExtension" label="My Extension" /><br /> <content type="application/xml" src="http://example.org/myextension/latest/myextension.update.xml" /><br /> </entry><br /> </feed><br /> </source><br /> <br /> '''Note''': to allow proper filtering, the <tt>term</tt> tag of the <category> node of the <atom:entry> element must contain the <identifier> value of the extension to be updated.<br /> <br /> = A glance on the code for the Apache OpenOffice 3.4 release =<br /> <br /> The following describes some deeper insight of the "Check for Updates..." code in the office. It should help us to re-activate a corresponding web service when Apache OpenOffice 3.4 has been released. (Do we need a real web service? Something to be discussed.)<br /> <br /> The information given here is based on the work of Regina (regina at apache dot org), Ariel (arielch at apache dot org) and Kay (kschenk at apache dot org) found in the corresponding mailing list thread on ooo-dev - see http://s.apache.org/e2u.<br /> Having this information gave me (orw at apache dot org) the right pointers for deeper investigations.<br /> <br /> == summary information about request to <UpdateURL> ==<br /> <br /> The <UpdateURL>, found in file <version.ini> resp. <versionrc> of the office installation is typically an HTTP URL.<br /> The office sends a GET request to this URL. Two header fields are included in this request which are already mentioned above.<br /> These are "Accept-Language" and "User-Agent".<br /> * "Accept-Language" contains the language of current locale - found in configuration item "org.openoffice.Setup/L10N", attribute "ooLocale"<br /> * "User-Agent" contains needed information to identify the installed office version - see above. The information matches the following pattern which is found in file <version.ini> resp. <versionrc>:<br /> <blockquote><br /> <pre><br /> <PRODUCT> (${buildid}; ${_OS}; ${_ARCH}; BundledLanguages=${AllLanguages}) <br /> </pre><br /> </blockquote><br /> On platforms other than Windows the <UpdateURL> contains (at least since OOo 3.3) a query part. It is ''?pkgfmt=<pkgformat>'' which especially for Linux platforms identifies the package format of the office installation.<br /> <br /> It reveals that this information can be used to create the corresponding information for the request response.<br /> <br /> == information about processing the request response ==<br /> <br /> The response is expected to be a corresponding XML snippet.<br /> As shown in the above examples, two types of XML snippets as responses are possible:<br /> a ''feed'' response and a ''simple'' response. The distinction between the two is made by its first element. If it is <feed> it is treated as a ''feed'' response, otherwise as a ''simple'' response.<br /> <br /> ==== ''simple'' response ====<br /> <br /> The ''simple'' response is an XML snippet which is expected to have the format as the XML snippet in file [http://svn.apache.org/repos/asf/incubator/ooo/trunk/main/instsetoo_native/util/update.xml update.xml], found in our source repository.<br /> <br /> The following conditions must hold to perform further evaluation of the response:<br /> # value of <inst:os> matches the one of the installed office - ''${_ARCH}''.<br /> # value of <inst:arch> matches the one of the installed office - ''${_OS}''.<br /> # value of <inst:buildid> is greater than the one of the installed office - ''${buildid}''.<br /> If these conditions hold, the following information is retrieved:<br /> # values of attributes <src> and <type> of <inst:update><br /> #* if value of <type> equals "text/html", the value of <src> is taken as an website from which the new version can be downloaded manually. Otherwise (also in case that attribute <type> is missing) the value of <src> is interpreted as a download link to the new version.<br /> #* all <inst:update> elements are evaluated. The information of the first one is used - provide download of version or provide link to download website. The purpose of the other is not known.<br /> # value of <inst:version> - will be shown in the corresponding dialog.<br /> # value of <inst:buildid> - currently its purpose is not known.<br /> If the first information - download website or download link - can be found in the XML snippet, the corresponding dialog will state that a new version is available. The user can then download it manually or can trigger an automatic download.<br /> <br /> If no download website/link is found, the dialog will state that the installed office is up to date.<br /> <br /> ==== ''feed'' response ====<br /> <br /> The ''feed'' response is expected to conform to [http://tools.ietf.org/wg/atompub/draft-ietf-atompub-format/rfc4287.txt atom feed] - as stated above in the example area.<br /> Each content of the <content> element of an atom entry (<entry> element) whose <category> element has an attribute <term> whose value matches the <UpdateId> value found in file <version.ini> resp. <versionrc> of the installed office is treated as ''simple'' response. <br /> <br /> The first of these ''simple'' responses from which a download website or a download link could be retrieved that matches the above given conditions is taken - the following ones are not processed. It will be shown to the user that a new version is available, and the user can trigger the download manually or automatically. One further information is taken from this atom entry - the content of the <summary> element. It is shown in the corresponding dialog.<br /> <br /> If no download website/link is found, the dialog will state that the installed office is up to date.<br /> <br /> [[Category:Spec]]</div>

Od https://wiki.openoffice.org/w/index.php?title=User:Od&diff=235374 User:Od 2014-07-10T09:38:43Z

<p>Od: /* TESTING */</p> <hr /> <div>{{Writer Project|Category=Writer/People}}<br /> I am Oliver-Rainer Wittmann, working since July 2002 on OpenOffice.org and now Apache OpenOffice.<br /> My userId at former OpenOffice.org was od@openoffice.org.<br /> My userId at Apache OpenOffice is orw@apache.org.<br /> Until August 2011 I was employed by Sun/Oracle as an software engineer.<br /> Since September 2011 I am employed by IBM as an advisory software engineer.<br /> <br /> I am also a member of the OASIS ODF TC since December 2006. Thus, I am working on ODF standardization and ODF interoperability.<br /> <br /> [[User:Od/TextAlignment]]<br /> <br /> <br /> == misc notes ==<br /> *External hunspell component contains certain path definitions into former OpenOffice.org installation/user directories. See hunspell-1.3.2/src/tools/hunspell.cxx<br /> *External mythes component contains patch file with former Sun copyright and license header<br /> *main/ooo_custom_images/industrial/README contains former Oracle/Sun copyright and license header<br /> *CHECK REMOVAL<br /> **gid_Brand_Profileitem_Bootstrap_Errorreport_Server<br /> **STR_REG_VAL_APPCAPABILITY_DESCRIPTION_OOO<br /> *CHECK ADJUSTMENT of ''OpenOffice.org''<br /> **main/sfx2/source/doc/doc.src<br /> **main/xmlsecurity/source/dialogs/digitalsignaturesdialog.src<br /> *correct <get_downloadname_productname> in main/solenv/bin/modules/installer/download.pm<br /> *REMOVAL of ''usage tracking'' stuff<br /> <br /> == TESTING ==<br /> [[wikipublishertest]]<br /> [[Update Service]]</div>

Od https://wiki.openoffice.org/w/index.php?title=Product_Release&diff=235354 Product Release 2014-06-30T09:16:53Z

<p>Od: /* Apache OpenOffice 4.x */</p> <hr /> <div>== Apache OpenOffice ==<br /> <br /> OpenOffice.org was [http://incubator.apache.org/projects/openofficeorg.html transferred] to the [http://www.apache.org/foundation/ Apache Software Foundation] on June 1st, 2011 and it [https://blogs.apache.org/OOo/entry/openoffice_graduates_from_the_apache became an Apache Top-Level Project] on October 17, 2012.<br /> <br /> The development model of the popular productivity suite changed to benefit from the huge experience the Foundation has with managing open source projects.<br /> <br /> New releases of the product are accordingly named '''Apache OpenOffice'''.<br /> <br /> === Apache OpenOffice 4.x ===<br /> <br /> * [https://blogs.apache.org/OOo/entry/the_apache_openoffice_project_announce Apache OpenOffice 4.1.0] (Apr. 29th, 2014)<br /> * [https://blogs.apache.org/OOo/entry/announcing_apache_openoffice_4_0 Apache OpenOffice 4.0.1] (Oct. 1st, 2013)<br /> * [https://blogs.apache.org/OOo/entry/a_short_celebration_and_then Apache OpenOffice 4.0.0] (Juli 23rd, 2013)<br /> <br /> === Apache OpenOffice 3.4 ===<br /> <br /> * [http://blogs.apache.org/OOo/entry/announcing_apache_openoffice_3_41 Apache OpenOffice 3.4.1] (August 23rd, 2012)<br /> ** additional languages Danish, Norwegian, Swedish, Korean, Polish, Basque, Asturian and Scottish Gaelic (January 30th, 2013)<br /> * [http://ooo-site.staging.apache.org/news/aoo34.html Apache OpenOffice 3.4.0] (May 8th 2012)<br /> <br /> == Older Product Releases of OpenOffice.org ==<br /> <br /> For release information please see the technical [http://development.openoffice.org/releases/index.html Release Notes] and a detailed [http://www.openoffice.org/dev_docs/features/index.html feature overview].<br /> <br /> For a list of uploaded Developer Snapshots and Release Candidates/Releases see the [[Product_Release/builds_uploaded | table of uploaded builds]]. The most recent builds can be downloaded on the [http://download.openoffice.org download webpage].<br /> <br /> For guidance on announcing new releases see [[PolicyMirrorLinking]].<br /> <br><br /> <br /> === Released OpenOffice.org 3.x.x ===<br /> <br /> * [[OOoRelease33|OpenOffice.org 3.3.0]] (January 26th, 2011)<br /> * [[OOoRelease321|OpenOffice.org 3.2.1]] (June 4th, 2010)<br /> * [[OOoRelease32|OpenOffice.org 3.2.0]] (February 11th, 2010)<br /> * [[OOoRelease311|OpenOffice.org 3.1.1]] (August 31st, 2009)<br /> * [[OOoRelease31|OpenOffice.org 3.1.0]] (May 7th, 2009)<br /> * [[OOoRelease301|OpenOffice.org 3.0.1]] (January 27th, 2009)<br /> * [[OOoRelease30|OpenOffice.org 3.0.0]] (October 13th, 2008)<br /> <br /> === Released OpenOffice.org 2.x.x ===<br /> <br /> * [[OOoRelease243|OpenOffice.org 2.4.3]] (September 04th, 2009)<br /> * [[OOoRelease242|OpenOffice.org 2.4.2]] (October 28th, 2008)<br /> * [[OOoRelease241|OpenOffice.org 2.4.1]] (June 10th, 2008)<br /> * [[OOoRelease24|OpenOffice.org 2.4]] (March 27th, 2008)<br /> * [[OOoRelease231|OpenOffice.org 2.3.1]] (December 4th, 2007)<br /> * [[OOoRelease23|OpenOffice.org 2.3]] (September 17th, 2007)<br /> * [[OOoRelease221|OpenOffice.org 2.2.1]] (June 12th, 2007)<br /> * [[OOoRelease22|OpenOffice.org 2.2]] (March 29th, 2007)<br /> * [[OOoRelease205|OpenOffice.org 2.1]] (December 12th, 2006)<br /> * [[OOoRelease204|OpenOffice.org 2.0.4]] (October 13th, 2006)<br /> * [[OOoRelease203|OpenOffice.org 2.0.3]] (June 29th, 2006)<br /> * [[OOoRelease202|OpenOffice.org 2.0.2]] (March 8th, 2006)<br /> * [[OOoRelease201|OpenOffice.org 2.0.1]] (December 21st, 2005)<br /> * OpenOffice.org 2.0.0 (October 21st, 2005)<br /> <br /> === OpenOffice.org 1.1 ===<br /> <br /> * OpenOffice.org 1.1.5 (September 9th, 2005)<br /> * OpenOffice.org 1.1.4 (December 22th, 2004)<br /> * OpenOffice.org 1.1.3 (October 4th, 2004)<br /> * OpenOffice.org 1.1.2 (June 18th, 2004)<br /> * OpenOffice.org 1.1.1 <br /> * OpenOffice.org 1.1.0 (October 1st, 2003)<br /> <br /> === OpenOffice.org 1.0 ===<br /> <br /> * OpenOffice.org 1.0.3 (April 10th, 2003)<br /> * OpenOffice.org 1.0.2 (January 20th, 2003) (tag "OpenOffice_1_0_2")<br /> * OpenOffice.org 1.0.1 (July 17th, 2002) (tag "OpenOffice_1_0_1")<br /> <br /> <br><br /> <br /> Older releases can be retrieved via the [ftp://archive.services.openoffice.org/pub/openoffice-archive/stable Archive Server].<br /> <br /> [[Category:Releases]]<br /> [[Category:Quality Assurance]]</div>

Od https://wiki.openoffice.org/w/index.php?title=OOXML_Framework&diff=235263 OOXML Framework 2014-06-10T11:11:53Z

<p>Od: /* Implementation */</p> <hr /> <div>The OOXML framework targets the import of OfficeOpen XML documents and tries to do as much of this work automatically.<br /> By reading the OOXML schema files and producing a parser skeleton it removes the necessity of managing XML contexts manually.<br /> <br /> =Design=<br /> The design of the new OOXML import framework adds a layer of abstraction on top of a push parser. The events for start tags, end tags or text are handled by the new import framework. Rules for this are derived directly from the specifications. These introduce the concept of complex types and simple types. Very simplified a complex type describes parent-child relationships between elements while simple types describe the types of attribute values. It is the task of the framework to do the translation from elements to complex types and preprocess attribute values according to their simple types. This has several advantages over a classical bare-bones push parser:<br /> * There are a few cases where the same element is mapped to different complex types. This disambiguation is now done automatically by the framework.<br /> * The callbacks are more readable because they are directly tied to a complex type which can be looked up in the spec.<br /> * Much of the low level processing is now done automatically and therefore <br /> ** does not obfuscate the import code<br /> ** is less error prone<br /> ** requires the developer to write less code<br /> ** is potentially faster<br /> <br /> The connection between OOXML parser and importer callbacks is done via a domain specific language (DSL). This, together with the automatic preprocessing of the specifications, allows the development of automatic analysis and processing programs. These allow us to<br /> * analyze how much of the specification is handled by import callbacks and thus<br /> * tell us which complex types and attributes still need more work<br /> * compile documentation contained in the document code<br /> * track progress of the development<br /> * improve the development process by providing means to e.g. search for the implementation of a certain element or complex type<br /> * add logging and debugging functionality on demand<br /> <br /> =Implementation=<br /> The OOXML framework has its home in the main/ooxml module. <br /> The implementation work is tracked by [https://issues.apache.org/ooo/show_bug.cgi?id=125035 issue 125035].<br /> <br /> In source/framework you can find these framework components:<br /> ;SchemaParser: (under development) A parser for schema files and a parser generator for the actual OOXML parsers (yet to come).<br /> ;JavaOOXMLParser: (under development) A demonstration parser of OOXML documents that is based on parser tables created by the SchemaParser. Its main purpose is to test the output of the SchemaParser. It is not intended as a runtime component of OpenOffice.<br /> <br /> [[Category:Office Open XML]]</div>

Od https://wiki.openoffice.org/w/index.php?title=OOXML_Framework&diff=235262 OOXML Framework 2014-06-10T11:10:43Z

<p>Od: </p> <hr /> <div>The OOXML framework targets the import of OfficeOpen XML documents and tries to do as much of this work automatically.<br /> By reading the OOXML schema files and producing a parser skeleton it removes the necessity of managing XML contexts manually.<br /> <br /> =Design=<br /> The design of the new OOXML import framework adds a layer of abstraction on top of a push parser. The events for start tags, end tags or text are handled by the new import framework. Rules for this are derived directly from the specifications. These introduce the concept of complex types and simple types. Very simplified a complex type describes parent-child relationships between elements while simple types describe the types of attribute values. It is the task of the framework to do the translation from elements to complex types and preprocess attribute values according to their simple types. This has several advantages over a classical bare-bones push parser:<br /> * There are a few cases where the same element is mapped to different complex types. This disambiguation is now done automatically by the framework.<br /> * The callbacks are more readable because they are directly tied to a complex type which can be looked up in the spec.<br /> * Much of the low level processing is now done automatically and therefore <br /> ** does not obfuscate the import code<br /> ** is less error prone<br /> ** requires the developer to write less code<br /> ** is potentially faster<br /> <br /> The connection between OOXML parser and importer callbacks is done via a domain specific language (DSL). This, together with the automatic preprocessing of the specifications, allows the development of automatic analysis and processing programs. These allow us to<br /> * analyze how much of the specification is handled by import callbacks and thus<br /> * tell us which complex types and attributes still need more work<br /> * compile documentation contained in the document code<br /> * track progress of the development<br /> * improve the development process by providing means to e.g. search for the implementation of a certain element or complex type<br /> * add logging and debugging functionality on demand<br /> <br /> =Implementation=<br /> The OOXML framework has its home in the main/ooxml module. <br /> The implementation work is tracked by [https://issues.apache.org/ooo/show_bug.cgi?id=125035 issue 125035].<br /> <br /> In source/framework you can find these framework components:<br /> ;SchemaParser: (under development) A parser for schema files and a parser generator for the actual OOXML parsers (yet to come).<br /> ;JavaOOXMLParser: (under development) A demonstration parser of OOXML documents that is based on parser tables created by the SchemaParser. Its main purpose is to test the ouput of the SchemaParser. It is not inteded as a runtime component of OpenOffice.<br /> <br /> [[Category:Office Open XML]]</div>

Od https://wiki.openoffice.org/w/index.php?title=IRC_Communication&diff=234683 IRC Communication 2014-04-24T12:02:17Z

<p>Od: </p> <hr /> <div>[[OpenOffice.org]] project uses [[wikipedia:Internet Relay Chat|IRC]] for direct and immediate online communication. Please see [http://www.google.com/calendar/embed?src=k4bgtc8bil9cs2a77lhh1r998g%40group.calendar.google.com google calendar] for schedules.<br /> <br /> == IRC Network: Freenode (irc.freenode.net) ==<br /> <br /> {| <br /> | [irc://irc.freenode.net/Openoffice.org #Openoffice.org] || Users and generic channel, please use this for questions related to OOo usage<br /> |-<br /> | [irc://irc.freenode.net/dev.openoffice.org #dev.openoffice.org] || Channel for developers discussing building and extending OpenOffice.org<br /> |-<br /> | [irc://irc.freenode.net/specs.openoffice.org #specs.openoffice.org] || Specifications and development processes<br /> |-<br /> | [irc://irc.freenode.net/qa.openoffice.org #qa.openoffice.org] || [[:Category:Quality Assurance|QA]] channel<br /> |-<br /> | [irc://irc.freenode.net/ooo-api #ooo-api] || [[API]] channel related to API programming, SDK, developer documentation (formerly api.openoffice.org).<br /> |-<br /> | [irc://irc.freenode.net/chart2.openoffice.org #chart2.openoffice.org] || [[Chart2]] channel<br /> |-<br /> | [irc://irc.freenode.net/ooonlc #ooonlc] || [[NLC|Native Language]] Talk Room<br /> |-<br /> | [irc://irc.freenode.net/debian-oo #debian-oo] || Debian OO.o packaging channel (This is now on irc.oftc.net)<br /> |-<br /> | [irc://irc.freenode.net/openoffice.org-de #openoffice.org-de] || Germanophone channel<br /> |-<br /> | [irc://irc.freenode.net/openoffice.org-it #openoffice.org-it] || Italian channel<br /> |-<br /> | [irc://irc.freenode.net/openoffice.org-pl #openoffice.org-pl] || Polish channel<br /> |-<br /> | [irc://irc.freenode.net/openoffice.org-zh #openoffice.org-zh] || Chinese channel<br /> |-<br /> | [irc://irc.freenode.net/cs.openoffice.org #cs.openoffice.org] || Czech channel (serves also Slovak users)<br /> |-<br /> | [irc://irc.freenode.net/openoffice.et #openoffice.et] || Estonian channel<br /> |-<br /> | [irc://irc.freenode.net/fr.openoffice.org #fr.openoffice.org] || Francophone channel<br /> |-<br /> | [irc://irc.freenode.net/nl.openoffice.org #nl.openoffice.org] || Dutch channel<br /> |-<br /> | [irc://irc.freenode.net/ru.openoffice.org #ru.openoffice.org] || Russian channel<br /> |-<br /> | [irc://irc.freenode.net/OOoES #OOoES] || Spanish Channel<br /> |-<br /> | [irc://irc.freenode.net/broffice.org #broffice.org] || Brazilian Channel<br /> |-<br /> | [irc://irc.freenode.net/dba.openoffice.org-de #dba.openoffice.org-de] || Germanophone channel to help with the Base-Modul of OpenOffice.org<br /> |-<br /> | [irc://irc.freenode.net/ooo_macport #ooo_macport] || Native [[Mac OS X]] (Aqua) port of OpenOffice.org developer channel<br /> |-<br /> | [irc://irc.freenode.net/ooo-ext #ooo-ext] || [[Extensions]] channel<br /> |-<br /> | [irc://irc.freenode.net/ux.openoffice.org #ux.openoffice.org] || [[User Experience]] channel<br /> |-<br /> | [irc://irc.freenode.net/odftoolkit #odftoolkit] || [[ODF_Toolkit|ODF Toolkit]] channel (discussing strategies, next steps, ...)<br /> |-<br /> | [irc://irc.freenode.net/education.openoffice.org #education.openoffice.org] || [[Education_Project|Education Project]] channel (everything about Education project, ...)<br /> |-<br /> | [irc://irc.freenode.net/openoffice.org-docs #openoffice.org-docs] || [[Documentation|Documentation Project]] channel<br /> |}<br /> <br /> == IRC Network: HanIRC (irc.hanirc.org) ==<br /> <br /> {| <br /> | [irc://irc.hanirc.org/openoffice #openoffice] || Korean channel<br /> |}<br /> <br /> == IRC info ==<br /> <br /> * [http://irchelp.org/irchelp/new2irc.html New to IRC info]<br /> * Make sure you register your nick with [[wikipedia:freenode|freenode]], just follow the [http://freenode.net/faq.shtml#nicksetup instructions]<br /> * If you like [[wikipedia:X-Chat|X-Chat]] but have to use windows sometimes, here is a free win32 [http://www.silverex.org/download/ version ]<br /> * A client for Mac OS X is [http://colloquy.info/ Colloquy]<br /> * An extension for Firefox is [https://addons.mozilla.org/en-US/firefox/addon/16 ChatZilla]<br /> * To create a new channel:<br /> <pre><br /> /join #new-channel-oo<br /> /msg chanserv register #new-channel-oo [password]<br /> /msg chanserv access #new-channel-oo add [who_should_autoop_there_1] [level]<br /> /msg chanserv access #new-channel-oo add [who_should_autoop_there_2_and_more] [level]<br /> /msg chanserv set #new-channel-oo guard on<br /> /msg chanserv level #new-channel set autoop [level-for-autoop]<br /> </pre><br /> <br /> == Who is Who? ==<br /> <br /> A list of people &amp; accounts is available: [[DomainDeveloper]]<br /> [[Category:Website]]</div>

Od https://wiki.openoffice.org/w/index.php?title=Communication&diff=234682 Communication 2014-04-24T11:56:32Z

<p>Od: </p> <hr /> <div>{{DISPLAYTITLE:Communication within the OpenOffice.org project}}<br /> {| align=right style="margin-left: 15px; border:1px solid #aaaaaa; background-color:#f9f9f9; padding:5px; font-size: 95%;" class=box<br /> |--- <br /> !align=center |<br /> <br /> [[Image:ooo-main-logo-2col_200px.gif]]<br /> <br /> [[Main Page|OpenOffice.org Wiki]]<br /> <br /> |-<br /> |<br /> {{ListofProjects}}<br /> <br /> |}<br /> <br /> <div style="font-size:1.1em"><br /> The most important ways of communication in the OpenOffice.org project are:<br /> * Users of OpenOffice.org will find help, tips and advice on the [http://forum.openoffice.org/ User Community Forums].<br /> <br /> <br /> * OpenOffice.org uses [http://openoffice.apache.org/mailing-lists.html mailing lists/newsgroups for detailed discussions].<ref>Those can also be used via other services, for example: [http://old.nabble.com/OpenOffice-f12770.html nabble], [http://dir.gmane.org/index.php?prefix=gmane.comp.openoffice gmane], [http://markmail.org/search/?q=openoffice markmail], [http://www.mail-archive.com/find.php?domains=www.mail-archive.com&q=openoffice&sa=Search&sitesearch=www.mail-archive.com&client=pub-7266757337600734&forid=1&lists=all mail-archive] and [http://marc.info/ MARC].</ref><br /> <br /> <br /> * OpenOffice.org project uses [[IRC_Communication |IRC for direct and immediate online communication]].<ref>Wikipedia has some general informations about [[wikipedia:Internet Relay Chat|Internet Relay Chat (IRC)]].</ref><br /> <br /> <br /> * The [[Main Page|OpenOffice.org Wiki]] (where you are right now) is also an important way of communication, especially for specifications and development documentation.<ref>See also the [[:Category:MainIndex|Main Index of the OpenOffice.org Wiki]].</ref><br /> <br /> * An alternative [https://cwiki.apache.org/confluence/display/OOOUSERS/Wiki+Home planning wiki] for the migration and project oriented initiatives is located on the following site.<br /> <br /> <br /> </div><br /> <br /> == See Also ==<br /> *[[IRC Communication]]<br /> <br /> <br /> ----<br /> <references/><br /> <br /> [[Category:Website]]</div>

Od https://wiki.openoffice.org/w/index.php?title=Communication&diff=234681 Communication 2014-04-24T11:55:33Z

<p>Od: </p> <hr /> <div>{{DISPLAYTITLE:Communication within the OpenOffice.org project}}<br /> {| align=right style="margin-left: 15px; border:1px solid #aaaaaa; background-color:#f9f9f9; padding:5px; font-size: 95%;" class=box<br /> |--- <br /> !align=center |<br /> <br /> [[Image:ooo-main-logo-2col_200px.gif]]<br /> <br /> [[Main Page|OpenOffice.org Wiki]]<br /> <br /> |-<br /> |<br /> {{ListofProjects}}<br /> <br /> |}<br /> <br /> <div style="font-size:1.1em"><br /> The most important ways of communication in the OpenOffice.org project are:<br /> * Users of OpenOffice.org will find help, tips and advice on the [http://forum.openoffice.org/ User Community Forums].<br /> <br /> <br /> * OpenOffice.org uses [http://incubator.apache.org/openofficeorg/mailing-lists.html mailing lists/newsgroups for detailed discussions].<ref>Those can also be used via other services, for example: [http://old.nabble.com/OpenOffice-f12770.html nabble], [http://dir.gmane.org/index.php?prefix=gmane.comp.openoffice gmane], [http://markmail.org/search/?q=openoffice markmail], [http://www.mail-archive.com/find.php?domains=www.mail-archive.com&q=openoffice&sa=Search&sitesearch=www.mail-archive.com&client=pub-7266757337600734&forid=1&lists=all mail-archive] and [http://marc.info/ MARC].</ref><br /> <br /> <br /> * OpenOffice.org project uses [[IRC_Communication |IRC for direct and immediate online communication]].<ref>Wikipedia has some general informations about [[wikipedia:Internet Relay Chat|Internet Relay Chat (IRC)]].</ref><br /> <br /> <br /> * The [[Main Page|OpenOffice.org Wiki]] (where you are right now) is also an important way of communication, especially for specifications and development documentation.<ref>See also the [[:Category:MainIndex|Main Index of the OpenOffice.org Wiki]].</ref><br /> <br /> * An alternative [https://cwiki.apache.org/confluence/display/OOOUSERS/Wiki+Home planning wiki] for the migration and project oriented initiatives is located on the following site.<br /> <br /> <br /> </div><br /> <br /> == See Also ==<br /> *[[IRC Communication]]<br /> <br /> <br /> ----<br /> <references/><br /> <br /> [[Category:Website]]</div>

Od https://wiki.openoffice.org/w/index.php?title=XML_Signature_support_without_Mozilla&diff=234668 XML Signature support without Mozilla 2014-04-17T05:55:04Z

<p>Od: </p> <hr /> <div>This page contains random notes to provide XML DSig support without Mozilla.<br /> <br /> We need to use:<br /> * System XmlSec instead of <code>external/libxmlsec</code>. This is now a [http://bonsai.go-oo.org/cvslog.cgi?file=external/libxmlsec/xmlsec1-1.2.6.patch patched] version of [http://www.aleksey.com/xmlsec/download/xmlsec1-1.2.6.tar.gz XmlSec 1.2.6]<br /> * System NSS and NSPR instead of the bundled Mozilla libraries. We need to be careful about shared libraries conflict. <br /> <br /> Mozilla (<code>MOZ:moz</code>) is also needed in the <code>dba/connectivity</code> module for addressbook integration.<br /> <br /> Do we have with problem sharing databases with Mozilla ([https://bugzilla.mozilla.org/show_bug.cgi?id=217538 Mozilla bug 217538: softoken databases cannot be shared between multiple processes])?<br /> <br /> Steps to do:<br /> *Update XmlSec to<br /> ** provide <code>xmlSecNssAppliedKeysMngrCreate, xmlSecNssAppliedKeysMngrSymKeyLoad, xmlSecNssAppliedKeysMngrPubKeyLoad xmlSecNssAppliedKeysMngrPriKeyLoad</code><br /> ** Check X.509 certificate verification semantics in (possible API breakage here)<br /> ** Verify rest of the patch<br /> ** Make sure internal XmlSec tests pass<br /> * Verify that XmlSec is built with NSS support. <br /> * Provide <code>SYSTEM_NSPR, SYSTEM_NSS, SYSTEM_XMLSEC</code> environment variables.<br /> * Modify <code>xml/xmlsecurity</code> module to use system NSS, NSPR and XmlSec library. Preliminary patch:<br /> <br /> <source lang="diff"><br /> --- xmlsecurity/util/makefile.mk.orig 2008-04-10 01:46:36.053917594 +0200<br /> +++ xmlsecurity/util/makefile.mk 2008-04-10 01:46:44.443729469 +0200<br /> @@ -47,11 +47,6 @@<br /> .INCLUDE : settings.mk<br /> .INCLUDE : $(PRJ)$/util$/target.pmk<br /> <br /> -.IF "$(WITH_MOZILLA)" == "NO"<br /> -@all:<br /> - @echo "No mozilla -> no nss -> no libxmlsec -> no xmlsecurity..."<br /> -.ENDIF<br /> -<br /> # --- Files --------------------------------------------------------<br /> <br /> BMP_IN=$(PRJ)$/res<br /> --- xmlsecurity/source/xmlsec/nss/makefile.mk.orig 2008-04-10 01:46:58.976404741 +0200<br /> +++ xmlsecurity/source/xmlsec/nss/makefile.mk 2008-04-10 02:20:30.562702818 +0200<br /> @@ -55,11 +55,6 @@<br /> <br /> .IF "$(CRYPTO_ENGINE)" == "nss"<br /> <br /> -.IF "$(WITH_MOZILLA)" == "NO"<br /> -@all:<br /> - @echo "No mozilla -> no nss -> no libxmlsec -> no xmlsecurity/nss"<br /> -.ENDIF<br /> -<br /> .IF "$(SYSTEM_MOZILLA)" != "YES"<br /> MOZ_INC = $(SOLARVERSION)$/$(INPATH)$/inc$(UPDMINOREXT)$/mozilla<br /> NSS_INC = $(MOZ_INC)$/nss<br /> @@ -70,6 +65,20 @@<br /> NSPR_INC = $(MOZ_INC)$/nspr<br /> .ENDIF<br /> <br /> +.IF "$(SYSTEM_NSS)" == "YES"<br /> +XMLSEC_INC = /usr/local/include/xmlsec1<br /> +.ELSE<br /> +XMLSEC_INC = $(PRJ)$/source$/xmlsec<br /> +.ENDIF<br /> +<br /> +.IF "$(SYSTEM_NSS)" == "YES"<br /> +NSS_INC = /usr/local/include/nss/nss<br /> +.ENDIF<br /> +<br /> +.IF "$(SYSTEM_NSPR)" == "YES"<br /> +NSPR_INC = /usr/local/include/nspr<br /> +.ENDIF<br /> +<br /> .IF "$(GUI)"=="UNX"<br /> .IF "$(COMNAME)"=="sunpro5"<br /> CFLAGS += -features=tmplife<br /> @@ -121,12 +130,11 @@<br /> SOLARINC += \<br /> -I$(MOZ_INC) \<br /> -I$(NSPR_INC) \<br /> --I$(PRJ)$/source$/xmlsec<br /> +-I$(NSS_INC) \<br /> +-I$(XMLSEC_INC)<br /> <br /> .IF "$(SYSTEM_MOZILLA)" == "YES"<br /> -SOLARINC += -DSYSTEM_MOZILLA $(NSS_INC)<br /> -.ELSE<br /> -SOLARINC += -I$(NSS_INC)<br /> +SOLARINC += -DSYSTEM_MOZILLA <br /> .ENDIF<br /> <br /> SLOFILES = \<br /> --- xmlsecurity/source/xmlsec/makefile.mk.orig 2008-04-10 01:45:40.800153175 +0200<br /> +++ xmlsecurity/source/xmlsec/makefile.mk 2008-04-10 01:46:02.219673838 +0200<br /> @@ -53,10 +53,6 @@<br /> CDEFS += -DXMLSEC_CRYPTO_MSCRYPTO -DXMLSEC_NO_XSLT<br /> .ELSE<br /> CDEFS += -DXMLSEC_CRYPTO_NSS -DXMLSEC_NO_XSLT<br /> -.IF "$(WITH_MOZILLA)" == "NO"<br /> -@all:<br /> - @echo "No mozilla -> no nss -> no libxmlsec -> no xmlsecurity.."<br /> -.ENDIF<br /> .ENDIF<br /> <br /> # --- Files --------------------------------------------------------<br /> --- xmlsecurity/prj/build.lst.orig 2008-04-10 01:40:35.017991731 +0200<br /> +++ xmlsecurity/prj/build.lst 2008-04-10 01:40:57.763482421 +0200<br /> @@ -1,4 +1,4 @@<br /> -xs xmlsecurity : xmloff unotools offapi unoil svx MOZ:moz SO:moz_prebuilt LIBXMLSEC:libxmlsec NULL<br /> +xs xmlsecurity : xmloff unotools offapi unoil svx LIBXMLSEC:libxmlsec NULL<br /> xs xmlsecurity usr1 - all xs_mkout NULL<br /> xs xmlsecurity\inc nmake - all xs_inc NULL<br /> xs xmlsecurity\source\framework nmake - all xs_fw xs_inc NULL<br /> </source><br /> <br /> Related:<br /> * {{CWS|systemmozilla|SRC680}}<br /> * [http://qa.openoffice.org/issues/buglist.cgi?issue_type=DEFECT&issue_type=ENHANCEMENT&issue_type=FEATURE&issue_type=PATCH&issue_status=UNCONFIRMED&issue_status=NEW&issue_status=STARTED&issue_status=REOPENED&issue_status=RESOLVED&email1=&emailtype1=exact&emailassigned_to1=1&email2=&emailtype2=exact&emailreporter2=1&issueidtype=include&issue_id=&changedin=&votes=&chfieldfrom=&chfieldto=&chfieldvalue=&short_desc=mozilla&short_desc_type=allwords&long_desc=&long_desc_type=allwords&issue_file_loc=&issue_file_loc_type=fulltext&status_whiteboard=&status_whiteboard_type=fulltext&keywords=&keywords_type=anytokens&field0-0-0=noop&type0-0-0=noop&value0-0-0=&cmdtype=doit&order=%27%27&Submit+query=Submit+query all isues with mozilla in subject]<br /> * {{Bug|6391|Mozilla 1.0 does not support concurrent multiple versions using same profile (FIXED)}}<br /> * {{Bug|8864|Accessing LDAP or Outlook/Express should not activate Mozilla prefs}}<br /> * {{Bug|65775|update mozilla bootstrap stuff for a recent mozilla API}}<br /> * {{Bug|81295|Adopt Mac OS X crypto API instead of using Mozilla's}}<br /> * [http://go-oo.org/developers/ooo-build/patches/src680/system-xmlsec.diff Patch to use system XmlSec from 2005]<br /> <br /> References:<br /> * [http://www.aleksey.com/xmlsec/news.html XmlSec library]<br /> * [http://thread.gmane.org/gmane.text.xml.xmlsec/1572 XmlSec 1.2.8 Release Notes - partial NSS support]<br /> [[Category:Security]][[Category:Digital Signature]]</div>

Od https://wiki.openoffice.org/w/index.php?title=Writer/Input_Fields&diff=234571 Writer/Input Fields 2014-03-21T10:31:10Z

<p>Od: /* Changes in detail */</p> <hr /> <div>{{Writer Project|Category=Writer/Effort/Completed}}<br /> __NOTOC__<br /> <br /> = In-place editing of Input Fields =<br /> <br /> Purpose of this page is provide information on the solution for {{Bug|33737}}. This information should serve the corresponding quality assurance efforts. It can be also used as the source to document the corresponding changes for the users.<br /> <br /> <br /> <br /> == Input Fields - three of a kind ==<br /> We have three fields which are all named 'Input Field' in the user interface, but each has a different purpose.<br /><br /> These are '''Text Input Fields''', '''User Variable Input Fields''' and '''Simple Variable Input Fields'''.<br /><br /> Currently no changes are made for '''Simple Variable Input Fields''' for solving {{Bug|33737}}.<br /> <br /> <br /> ==== Text Input Field ====<br /> This is a field to prompt the user for an input. The field has a description and its content holds the user's input.<br /> <br /> In the OpenDocument file format (ODF) such a field is represented by ODF element <text:text-input>.<br /> <br /> When importing Microsoft Word documents (binary file format, *.doc) Microsoft Word fields FILLIN and FORMTEXT are imported as Text Input Fields.<br /> <br /> The user interface to create such a field is found in the Fields dialog (Menu - Insert - Fields - Others) on pane Functions. Here the user has to choose Type 'Input Field'.<br /> [[Image:Dialog-text-input.png|500px|center|dialog to create Text Input Field]]<br /> <br /> <br /> ==== User Variable Input Field ====<br /> This is a field to prompt the user to set the value of a user variable. The value of a user variable is the same throughout the complete document.<br /> <br /> In ODF such a field is represented by ODF element <text:user-field-input>.<br /> <br /> Microsoft Word has support for so-called Document Variables. The value of such variables can be shown in a Microsoft Word document, but are created/deleted/set via Microsoft Word macro (aka Visual Basic). These Document Variables seem to be comparable with ODF's User Variables, but currently there is no mapping between these in OpenOffice.<br /> A User Variable Input Field is treated as Text Input Field when exporting an OpenOffice text document to the Microsoft Word binary format.<br /> <br /> The user interface to create such a field is found in the Fields dialog on pane Variables. In advance the user has to create a user field (left part of the below screen shot). Then the user has to choose Type 'Input Field' and has to select the corresponding created user variable.<br /> [[Image:Dialog-user-field-input.png|1000px|center|dialog to create User Variable and a corresponding User Variable Text Input Field]]<br /> A '''User Field''' inserted visible in the document is not an Input Field and is not in the scope of the in-place editing.<br /> <br /> ==== Simple Variable Input Field ====<br /> This is a field to prompt the user to set the value of a simple variable. The value of a simple variable at a certain document position equals the value of the last set value - that is the difference to a user variable.<br /> <br /> In ODF such a field is represented by ODF element <text:variable-input>.<br /> <br /> For the Microsoft Word binary file format import/export filter these Simple Variable Input Fields are mapped to Microsoft Word ASK fields.<br /> <br /> The user interface to create such a field is found in the Fields dialog on pane Variables. In advance the user has to create a simple variable (left part of the below screen shot). Then the user has to choose Type 'Input Field' and has to select the corresponding created simple variable.<br /> [[Image:Dialog-variable-input.png|1000px|center|dialog to create Simple Variable and a corresponding Simple Variable Text Input Field]]<br /> A '''Simple Variable''' inserted visible in the document is not an Input Field and as the '''Simple Variable Input Field''' is not in the scope of the in-place editing.<br /> <br /> <br /> == Changes in detail ==<br /> In the following the changes to solve {{Bug|33737}} are given in detail. The changes only affect '''Text Input Fields''' and '''User Variable Input Fields'''. Thus, the following use of term <nowiki>Input Field</nowiki> '''only''' denotes these two types of Input Fields.<br /> <br /> ==== Edit content of Input Fields ====<br /> To modify/provide the content of an Input Field it is possible to directly perform the corresponding edit operations inside the document's text area. No additional popup dialog is needed.<br /><br /> As an Input Field can only contain text content most insertion operations are not allowed while the cursor is inside an Input Field. Also pasting operations and drop operations are not allowed. Pasting unformatted text (e.g. on Windows via SHIFT-CTRL-ALT-V) shall be possible.<br /> <br /> ==== Enter/Leaving Input Fields ====<br /> To enable the user to enter respectively leave an Input Field special hidden characters are inserted for the cursor traveling. Thus, the cursor can be positioned before an Input Field and text can be inserted before the Input Field. After a cursor move to the right the Input Field is entered and text at the beginning of the Input Field can be inserted. Similar cursor traveling is possible at the end of the Input Field. The cursor can be placed right behind an Input Field and text can be inserted behind the Input Field. After a cursor move to the left the Input Field is entered and text at the end of the Input Field can be inserted.<br /> <br /> Entering and Leaving an Input Field will be indicated to the user by drawing a bounding rectangle around the Input Field when the cursor is inside the Input Field.<br /><br /> [[Image:InputField-cursor-inside-and-outside.png|1000px|center|screen shots showing cursor right before an Input Field and inside an Input Field]]<br /> <br /> Clicking with the mouse pointer into an Input Field will in general select its text content in order to enable the user to directly replace the Input Field's content.<br /> <br /> ==== Traveling between Input Fields ====<br /> Traveling from one Input Field to the next respectively previous one with the keyboard is possible via TAB-Key respectively via SHIFT-TAB-Key. When traveling the complete content of the Input Field is selected.<br /><br /> <br /> To insert a TAB character inside an Input Field using the keyboard the CTRL-TAB-Key have to be used.<br /> <br /> ==== Selection of Input Fields ====<br /> Any text selection inside an Input Fields is possible. When text outside an Input Field is part of a text selection only the complete Input Field can be added to the text selection. Thus, it is not possible to select a part of an Input Field's text content and other text content in one selection.<br /> <br /> ==== No Field Names for Input Fields ====<br /> Field Names are no longer shown for Input Fields. Via Menu - View - Field Names the Field Names of all fields could be displayed instead of the fields content. This will no longer work for Input Fields due to the in-place editing.<br /> <br /> ==== Microsoft Word binary filter (WW8 filter) ====<br /> In general Input Fields will be exported as Microsoft Word FORMTEXT fields.<br /><br /> Exceptions are imported Microsoft Word FILLIN fields - these will be exported as Microsoft Word FILLIN fields unless the Input Field's help text or tooltip text is filled.<br /> <br /> ==== Documents in read-only mode ====<br /> In-place editing of Input Fields is allowed when the document is in read-only mode. This is the same behavior as for text frames or sections for whose option to be editable in read-only mode has been set.<br /><br /> Also the field shadings for Input Fields are visible when the document is in read-only mode.<br /> <br /> == Areas which need high attention during testing ==<br /> * Only text content shall be inserted into Input Fields.<br /> * No formatting shall be possible inside Input Fields.<br /> * Applying a formatting while the cursor is inside an Input Field shall be applied to the complete Input Field.<br /> * No other attributes, like a hyperlink, a ruby, a page break or a column break, shall be possible inside Input Fields.<br /> * Default Formatting while the cursor is inside an Input Field.<br /> * The insertion of a 'New Paragraph' character or the key input of the ENTER-Key shall result into an insertion of a line break inside an Input Field.<br /> * Undo/Redo actions regarding Input Fields.<br /> * Functionality of other fields shall not be affected.<br /> * Applying formatting or other attributes to text content.<br /> * All of the above areas when having a multi-selection.<br /> * Save and Load of documents containing Input Fields.<br /> * Exchange of documents containing Input Fields in ODF with previous OpenOffice versions.<br /> * Exchange of documents containing Input Fields in Microsoft Word binary file format with Microsoft Word.<br /> * HTML export and import of text documents containing Input Fields - assure no change to previous versions.</div>

Od https://wiki.openoffice.org/w/index.php?title=API/Incompatible_API_changes&diff=234559 API/Incompatible API changes 2014-03-18T10:25:36Z

<p>Od: /* OpenOffice 4.0 */</p> <hr /> <div>{{DISPLAYTITLE:Incompatible API changes}}<br /> <br /> This page gives an overview about incompatible changes of API's as well configuration data or other relevant data that can have influence on existing macros and/or extensions. The goal is that besides the pure documentation of the change a possible migration path for developers should be documented and should help during the migration to adapt the change in own macros or own extensions. A collaboration of core developers together with macro/extension developers is important for the eco-system around OpenOffice.<br /> <br /> == OpenOffice 4.0 ==<br /> <br /> [[Category:API]]<br /> <br /> see also [[Extensions/Extensions_and_Apache_OpenOffice_4.0]]</div>

Od https://wiki.openoffice.org/w/index.php?title=Product_Release&diff=234544 Product Release 2014-02-26T13:41:20Z

<p>Od: /* Apache OpenOffice 3.4 */</p> <hr /> <div>== Apache OpenOffice ==<br /> <br /> OpenOffice.org was [http://incubator.apache.org/projects/openofficeorg.html transferred] to the [http://www.apache.org/foundation/ Apache Software Foundation] on June 1st, 2011 and it [https://blogs.apache.org/OOo/entry/openoffice_graduates_from_the_apache became an Apache Top-Level Project] on October 17, 2012.<br /> <br /> The development model of the popular productivity suite changed to benefit from the huge experience the Foundation has with managing open source projects.<br /> <br /> New releases of the product are accordingly named '''Apache OpenOffice'''.<br /> <br /> === Apache OpenOffice 4.x ===<br /> <br /> * [https://blogs.apache.org/OOo/entry/announcing_apache_openoffice_4_0 Apache OpenOffice 4.0.1] (Oct. 1st, 2013)<br /> * [https://blogs.apache.org/OOo/entry/a_short_celebration_and_then Apache OpenOffice 4.0.0] (Juli 23rd, 2013)<br /> <br /> === Apache OpenOffice 3.4 ===<br /> <br /> * [http://blogs.apache.org/OOo/entry/announcing_apache_openoffice_3_41 Apache OpenOffice 3.4.1] (August 23rd, 2012)<br /> ** additional languages Danish, Norwegian, Swedish, Korean, Polish, Basque, Asturian and Scottish Gaelic (January 30th, 2013)<br /> * [http://ooo-site.staging.apache.org/news/aoo34.html Apache OpenOffice 3.4.0] (May 8th 2012)<br /> <br /> == Older Product Releases of OpenOffice.org ==<br /> <br /> For release information please see the technical [http://development.openoffice.org/releases/index.html Release Notes] and a detailed [http://www.openoffice.org/dev_docs/features/index.html feature overview].<br /> <br /> For a list of uploaded Developer Snapshots and Release Candidates/Releases see the [[Product_Release/builds_uploaded | table of uploaded builds]]. The most recent builds can be downloaded on the [http://download.openoffice.org download webpage].<br /> <br /> For guidance on announcing new releases see [[PolicyMirrorLinking]].<br /> <br><br /> <br /> === Released OpenOffice.org 3.x.x ===<br /> <br /> * [[OOoRelease33|OpenOffice.org 3.3.0]] (January 26th, 2011)<br /> * [[OOoRelease321|OpenOffice.org 3.2.1]] (June 4th, 2010)<br /> * [[OOoRelease32|OpenOffice.org 3.2.0]] (February 11th, 2010)<br /> * [[OOoRelease311|OpenOffice.org 3.1.1]] (August 31st, 2009)<br /> * [[OOoRelease31|OpenOffice.org 3.1.0]] (May 7th, 2009)<br /> * [[OOoRelease301|OpenOffice.org 3.0.1]] (January 27th, 2009)<br /> * [[OOoRelease30|OpenOffice.org 3.0.0]] (October 13th, 2008)<br /> <br /> === Released OpenOffice.org 2.x.x ===<br /> <br /> * [[OOoRelease243|OpenOffice.org 2.4.3]] (September 04th, 2009)<br /> * [[OOoRelease242|OpenOffice.org 2.4.2]] (October 28th, 2008)<br /> * [[OOoRelease241|OpenOffice.org 2.4.1]] (June 10th, 2008)<br /> * [[OOoRelease24|OpenOffice.org 2.4]] (March 27th, 2008)<br /> * [[OOoRelease231|OpenOffice.org 2.3.1]] (December 4th, 2007)<br /> * [[OOoRelease23|OpenOffice.org 2.3]] (September 17th, 2007)<br /> * [[OOoRelease221|OpenOffice.org 2.2.1]] (June 12th, 2007)<br /> * [[OOoRelease22|OpenOffice.org 2.2]] (March 29th, 2007)<br /> * [[OOoRelease205|OpenOffice.org 2.1]] (December 12th, 2006)<br /> * [[OOoRelease204|OpenOffice.org 2.0.4]] (October 13th, 2006)<br /> * [[OOoRelease203|OpenOffice.org 2.0.3]] (June 29th, 2006)<br /> * [[OOoRelease202|OpenOffice.org 2.0.2]] (March 8th, 2006)<br /> * [[OOoRelease201|OpenOffice.org 2.0.1]] (December 21st, 2005)<br /> * OpenOffice.org 2.0.0 (October 21st, 2005)<br /> <br /> === OpenOffice.org 1.1 ===<br /> <br /> * OpenOffice.org 1.1.5 (September 9th, 2005)<br /> * OpenOffice.org 1.1.4 (December 22th, 2004)<br /> * OpenOffice.org 1.1.3 (October 4th, 2004)<br /> * OpenOffice.org 1.1.2 (June 18th, 2004)<br /> * OpenOffice.org 1.1.1 <br /> * OpenOffice.org 1.1.0 (October 1st, 2003)<br /> <br /> === OpenOffice.org 1.0 ===<br /> <br /> * OpenOffice.org 1.0.3 (April 10th, 2003)<br /> * OpenOffice.org 1.0.2 (January 20th, 2003) (tag "OpenOffice_1_0_2")<br /> * OpenOffice.org 1.0.1 (July 17th, 2002) (tag "OpenOffice_1_0_1")<br /> <br /> <br><br /> <br /> Older releases can be retrieved via the [ftp://archive.services.openoffice.org/pub/openoffice-archive/stable Archive Server].<br /> <br /> [[Category:Releases]]<br /> [[Category:Quality Assurance]]</div>

Od https://wiki.openoffice.org/w/index.php?title=Documentation/Building_Guide_AOO/Building_on_Windows&diff=232877 Documentation/Building Guide AOO/Building on Windows 2014-01-21T08:14:11Z

<p>Od: /* Overview */</p> <hr /> <div>{{Documentation/Building Guide AOO TOC<br /> |ShowNextPage=none<br /> |ShowPrevPage=none<br /> }}<br /> <br /> {{DISPLAYTITLE:Building on Windows}}<br /> [[Category:Windows]]<br /> <br /> __TOC__<br /> <br /> = Overview =<br /> <br /> For general information on how to build Apache OpenOffice from source code, see the [[Documentation/Building_Guide_AOO|platform independent page]].<br /> <br /> {{Template:Documentation/Windows|This document explains the platform specific details.}}<br /> For building Apache OpenOffice the [http://www.cygwin.com Cygwin environment] is required. Cygwin is a set of programs that run on Windows but emulate a complete Unix command line environment. <br /> <br /> As compiler we use Microsoft's Visual C++ 2008, not the gcc from Cygwin. Therefore Visual Studio Express/Professional (version 2008 or later) can be used for debugging.<br /> <br /> To use this document you should be familiar with a bourne command line interpreter (sh or bash), but you need not be a UNIX shell wizard.<br /> {{Template:Documentation/Tip|If you have never used a Unix shell, you might want to take a look at the [http://tldp.org/LDP/GNU-Linux-Tools-Summary/html/index.html shell introduction at TLDP].}}<br /> <br /> =Build requirements=<br /> <br /> Additionally to the [[Documentation/Building Guide AOO#General_Build_Requirements|general build requirements]] you need<br /> {| class="prettytable" border="1" width="100%"<br /> |-<br /> !style="width: 25%"|What<br /> ! Where to get<br /> !style="width: 20%"|How to install<br /> |-<br /> | Windows 7 (recommended), Windows Vista, Windows XP<br /> | <br /> |<br /> |-<br /> | Cygwin<br /> | http://www.cygwin.com, '''32bit version''', minimum version: 1.5.10, preferred: current version]<br /> <br /> See [[#Setting up Cywin|below]] for setting up cygwin and the required packages.<br /> | (default)<br /> |-<br /> | Microsoft Windows SDK for Windows 7 and .NET Framework 3.5 SP1<br /> | http://www.microsoft.com/en-us/download/details.aspx?id=3138<br /> <br /> It brings the Visual Studio 2008 C++ compiler with it.<br /> <br /> This is either a DVD image or a net installer. You can either mount the DVD with a suitable tool, burn it do a DVD or use tools like winrar or 7zip to extract files from the ISO file directly. You don't need to install samples or documentation (saves a lot of disk space). It will also install the .NET Framework 3.5 SDK. It might be best to install the Windows SDK into the default directory, and if not that into one without capital letters in the path.<br /> | <br /> |-<br /> | Microsoft Visual C++ 2008 SP1 Redistributable Package (x86)<br /> | vcredist_x86.exe, download found [http://www.microsoft.com/en-us/download/search.aspx?q=Microsoft%20Visual%20C%2b%2b%202008%20Redistributable%20Package&p=0&r=10&t=&s=availabledate~Descending here]<br /> It is just packed as it is into the installation package.<br /> <br /> The exact download URL may have changed. In that case you have to search Microsoft's website.<br /> | main/external/vcredist<br /> |-<br /> | Microsoft Visual C++ 2008 SP1 Redistributable Package (x64)<br /> | vcredist_x64.exe, download found [http://www.microsoft.com/en-us/download/search.aspx?q=Microsoft%20Visual%20C%2b%2b%202008%20Redistributable%20Package&p=0&r=10&t=&s=availabledate~Descending here]<br /> It is just packed as it is into the installation package.<br /> <br /> The exact download URL may have changed. In that case you have to search Microsoft's website.<br /> | main/external/vcredist<br /> |-<br /> | GDI+ Redistributable<br /> | http://www.microsoft.com/downloads/details.aspx?familyid=6A63AB9C-DF12-4D41-933C-BE590FEAA05A&displaylang=en. Genuine Windows Validation required.<br /> | main/external/gdiplus<br /> |-<br /> | Runtime libraries 10.0<br /> | msvcp100.dll and msvcr100.dll for Java 7 support - see issue [https://issues.apache.org/ooo/show_bug.cgi?id=120979 120979].<br /> Get them from the Microsoft Visual C++ 2010 Redistributable Package (x86) from the Microsoft site - http://www.microsoft.com/en-us/download/search.aspx?q=Microsoft+Visual+C%2b%2b+2010+Redistributable<br /> | main/external/msvcp100<br /> |<br /> |-<br /> | dbghelp.dll<br /> | http://msdn.microsoft.com/en-us/library/windows/desktop/ms679309%28v=vs.85%29.aspx<br /> <br /> The exact download URL may have changed. In that case you have to search Microsoft's website.<br /> <br /> Search for it on your PC or on the web. E.g., it is part of the Windows Driver Kit.<br /> | main/external/dbghelp<br /> |-<br /> | Windows Driver Kit Version 7.1.0<br /> | http://www.microsoft.com/downloads/details.aspx?id=11800<br /> <br /> To enable ATL and ActiveX in the build - it is optional<br /> <br /> related configure options are:<br /> --with-atl-include, --with-atl-lib-dir, --with-mfc-include-dir, --with-mfc-lib-dir<br /> | <br /> |-<br /> | Microsoft DirectX SDK<br /> | http://www.microsoft.com/download/en/details.aspx?displaylang=en&id=6812<br /> <br /> To enable DirectX in the build - it is optional<br /> <br /> related configure option is:<br /> --with-directx-home<br /> | <br /> |-<br /> | Unicode NSIS, version 2.46.5<br /> | http://code.google.com/p/unsis/downloads/detail?name=nsis-2.46.5-Unicode-setup.exe&can=2&q= <br /> <br /> If Unicode NSIS is available, a self contained Windows installer is created in addition to the MSI installer files - it is optional<br /> | <br /> |}<br /> <br /> When building Apache OpenOffice 3.4.x or 4.0.x you need to provide some additional binaries:<br /> {| class="prettytable" border="1" width="100%"<br /> |-<br /> | Runtime libraries 7.1<br /> | msvcr71.dll for Mozilla libraries. Search for them on the web or on your PC. These files should be named as all lower case. Sometimes when downloaded they are upper case and this will cause 'file not found' errors towards the end of the build))<br /> | main/external/msvcp71 <br /> |-<br /> | Runtime libraries 8.0<br /> | msvcp80.dll and msvcr80.dll for Mozilla libraries. Search for them on the web or on your PC.<br /> | main/external/msvcp80<br /> |}<br /> <br /> =Remarks=<br /> <br /> {{Template:Documentation/Note|OOo uses some Mozilla libraries. Building the corresponding sources is only possible with the VC2003 compiler so you have to use precompiled libraries that require the msvx71 libraries mentioned above. On Windows the Mozilla libraries are needed only for Mozilla address book support. Unfortunately a bug in the module dependencies makes it necessary that the Mozilla libaries are used anyway as otherwise building the module <tt>xmlsecurity</tt> fails.}}<br /> <br /> = Setting up Cygwin =<br /> <br /> Go to http://www.cygwin.com/ and download and install the current 32bit version.<br /> {{Template:Documentation/Caution|Make sure that you keep the filetype set to “Unix/binary”.}}<br /> {{Template:Documentation/Caution|Make sure that the PATH variable in your cygwin shell does not contain any unquoted blanks and quotes, otherwise configure will not work}}<br /> <br /> <br /> === Additional packages for Cygwin to serve the AOO build ===<br /> <br /> Cygwin consists of some basic and a lot of optional packages. As building AOO needs some of these optional packages you have to select them in the installer.<br /> Here's a complete list of the required packages:<br /> * Category Archive:<br /> ** unzip<br /> ** zip<br /> * Category Devel :<br /> ** autoconf<br /> ** bison<br /> ** flex<br /> ** gcc-g++<br /> ** gperf<br /> ** make<br /> ** patch<br /> ** readline<br /> ** subversion (if you want to use svn inside the cygwin shell to checkout and update your working copy of AOO)<br /> * Category Net<br /> ** openssh<br /> ** openssl<br /> * Category Perl<br /> ** perl - see [http://wiki.openoffice.org/wiki/Documentation/Building_Guide_AOO#General_Build_Requirements General Build Requirements] for additional Perl modules<br /> * Category Shells<br /> ** mintty<br /> * Category Utils<br /> ** gnupg<br /> * Category Web<br /> ** wget<br /> <br /> {{Template:Documentation/Note|The installer will automatically check and download some more packages needed by whose listed here. The whole process takes roughly 20 minutes.}}<br /> <br /> === Breaking links to executable ===<br /> <br /> Within the Cygwin Toolkit, some executables might be symlinks: awk.exe and gunzip.exe, tar.exe (in older releases only). This can lead to a break of the build later, and the symlinks should be replaced by copies of the command they link to. <br /> <br /> To check this, execute:<br /> <br /> ls -l /bin/awk.exe<br /> <br /> whether e.g. awk.exe is a symlink. In version 1.5.24-2 awk.exe is a link to gawk.exe. The shell will show this by putting out “awk.exe -> gawk.exe”. In this case gawk.exe must be copied to awk.exe by executing: <br /> <br /> cd /bin<br /> rm awk.exe<br /> cp gawk.exe awk.exe<br /> <br /> In case you overlook something here or you have a newer Cygwin version with additional symlinks not mentioned here it's not a problem. You will get a helpful error message about an existing link in the configuration step (configure) later. The message will tell you which link you have to remove and you can do it following the advice given above for the awk.exe/gawk.exe pair.<br /> <br /> <br /> === Installing additional perl modules in cygwin ===<br /> <br /> As explained some perl modules must be installed with CPAN. The necessary command in the cygwin shell is<br /> <br /> perl -MCPAN -e shell<br /> <br /> If this command is executed the first time CPAN will ask for configuration. Choose autoconfiguration. <br /> <br /> {{Template:Documentation/Caution|Please note that CPAN is not able to deal with usernames containing spaces. To work around this fact, when CPAN asks you to specify the ''CPAN build and cache directory'', change the default suggestion to <tt>/cpan</tt>.}}<br /> <br /> At the end the CPAN shell appeared and is ready to accept commands for installations. Each module is installed by typing <code>install $MODULENAME</code>. The modules that must be installed are:<br /> <br /> * Archive::Zip<br /> * LWP::UserAgent<br /> * XML::Parser (though it seems that this is already installed; doesn't hurt to do it)<br /> <br /> CPAN will detect if a selected module depends on other modules and it will offer to download them also. As explained please just confirm this.<br /> <br /> {{Template:Documentation/Caution|I got an error message from CPAN somewhat like the following:<br /> <pre>C:\cygwin\bin\perl.exe: *** unable to remap C:\cygwin\bin\cygiconv-2.dll to same<br /> address as parent(0x7C0000) != 0x7D0000</pre><br /> To fix this, I had to exit the Cygwin shell, run cmd.exe, then type "c:\cygwin\bin\ash.exe" to start the minimal shell, then type <code>/bin/rebaseall</code>. Then CPAN worked when I ran it again.}}<br /> <br /> = Configure switches (Windows specific) =<br /> <br /> Additionally to the general [[Documentation/Building_Guide_AOO#Configuration_and_bootstrapping|configure switches]] there are several that only have to be used on Windows or have Windows specific values.<br /> <br /> Typical values for the compiler and SDK. If default installation paths are used these configure switches are not needed:<br /> --with-frame-home="/cygdrive/c/Program Files/Microsoft SDKs/Windows/v7.0"<br /> --with-psdk-home="/cygdrive/c/Program Files/Microsoft SDKs/Windows/v7.0"<br /> --with-midl-path="/cygdrive/c/Program Files/Microsoft SDKs/Windows/v7.0/Bin"<br /> For DirectX:<br /> --with-directx-home="C:/Program Files (x86)/Microsoft DirectX SDK (June 2010)"<br /> For ATL and ActiveX:<br /> --with-atl-include-dir=/cygdrive/c/WinDDK/7600.16385.1/inc/atl71<br /> --with-atl-lib-dir=/cygdrive/c/WinDDK/7600.16385.1/lib/ATL/i386<br /> --with-mfc-include-dir=/cygdrive/c/WinDDK/7600.16385.1/inc/mfc42<br /> --with-mfc-lib-dir=/cygdrive/c/WinDDK/7600.16385.1/lib/Mfc/i386<br /> <br /> And some more:<br /> --enable-pch<br /> --enable-dbgutil</div>

Od https://wiki.openoffice.org/w/index.php?title=Writer/Input_Fields&diff=232851 Writer/Input Fields 2014-01-16T11:36:51Z

<p>Od: </p> <hr /> <div>{{Writer Project|Category=Writer/Effort/Completed}}<br /> __NOTOC__<br /> <br /> = In-place editing of Input Fields =<br /> <br /> Purpose of this page is provide information on the solution for {{Bug|33737}}. This information should serve the corresponding quality assurance efforts. It can be also used as the source to document the corresponding changes for the users.<br /> <br /> <br /> <br /> == Input Fields - three of a kind ==<br /> We have three fields which are all named 'Input Field' in the user interface, but each has a different purpose.<br /><br /> These are '''Text Input Fields''', '''User Variable Input Fields''' and '''Simple Variable Input Fields'''.<br /><br /> Currently no changes are made for '''Simple Variable Input Fields''' for solving {{Bug|33737}}.<br /> <br /> <br /> ==== Text Input Field ====<br /> This is a field to prompt the user for an input. The field has a description and its content holds the user's input.<br /> <br /> In the OpenDocument file format (ODF) such a field is represented by ODF element <text:text-input>.<br /> <br /> When importing Microsoft Word documents (binary file format, *.doc) Microsoft Word fields FILLIN and FORMTEXT are imported as Text Input Fields.<br /> <br /> The user interface to create such a field is found in the Fields dialog (Menu - Insert - Fields - Others) on pane Functions. Here the user has to choose Type 'Input Field'.<br /> [[Image:Dialog-text-input.png|500px|center|dialog to create Text Input Field]]<br /> <br /> <br /> ==== User Variable Input Field ====<br /> This is a field to prompt the user to set the value of a user variable. The value of a user variable is the same throughout the complete document.<br /> <br /> In ODF such a field is represented by ODF element <text:user-field-input>.<br /> <br /> Microsoft Word has support for so-called Document Variables. The value of such variables can be shown in a Microsoft Word document, but are created/deleted/set via Microsoft Word macro (aka Visual Basic). These Document Variables seem to be comparable with ODF's User Variables, but currently there is no mapping between these in OpenOffice.<br /> A User Variable Input Field is treated as Text Input Field when exporting an OpenOffice text document to the Microsoft Word binary format.<br /> <br /> The user interface to create such a field is found in the Fields dialog on pane Variables. In advance the user has to create a user field (left part of the below screen shot). Then the user has to choose Type 'Input Field' and has to select the corresponding created user variable.<br /> [[Image:Dialog-user-field-input.png|1000px|center|dialog to create User Variable and a corresponding User Variable Text Input Field]]<br /> A '''User Field''' inserted visible in the document is not an Input Field and is not in the scope of the in-place editing.<br /> <br /> ==== Simple Variable Input Field ====<br /> This is a field to prompt the user to set the value of a simple variable. The value of a simple variable at a certain document position equals the value of the last set value - that is the difference to a user variable.<br /> <br /> In ODF such a field is represented by ODF element <text:variable-input>.<br /> <br /> For the Microsoft Word binary file format import/export filter these Simple Variable Input Fields are mapped to Microsoft Word ASK fields.<br /> <br /> The user interface to create such a field is found in the Fields dialog on pane Variables. In advance the user has to create a simple variable (left part of the below screen shot). Then the user has to choose Type 'Input Field' and has to select the corresponding created simple variable.<br /> [[Image:Dialog-variable-input.png|1000px|center|dialog to create Simple Variable and a corresponding Simple Variable Text Input Field]]<br /> A '''Simple Variable''' inserted visible in the document is not an Input Field and as the '''Simple Variable Input Field''' is not in the scope of the in-place editing.<br /> <br /> <br /> == Changes in detail ==<br /> In the following the changes being in progress to solve {{Bug|33737}} are given in detail. Currently the changes will only affect '''Text Input Fields''' and '''User Variable Input Fields'''. Thus, the following use of term <nowiki>Input Field</nowiki> denotes these two types of Input Fields.<br /> <br /> ==== Edit content of Input Fields ====<br /> To modify/provide the content of an Input Field it is possible to directly perform the corresponding edit operations inside the document's text area. No additional popup dialog is needed.<br /><br /> As an Input Field can only contain text content most insertion operations are not allowed while the cursor is inside an Input Field. Also pasting operations and drop operations are not allowed. Pasting unformatted text (e.g. on Windows via SHIFT-CTRL-ALT-V) shall be possible.<br /> <br /> ==== Enter/Leaving Input Fields ====<br /> To enable the user to enter respectively leave an Input Field special hidden characters are inserted for the cursor traveling. Thus, the cursor can be positioned before an Input Field and text can be inserted before the Input Field. After a cursor move to the right the Input Field is entered and text at the beginning of the Input Field can be inserted. Similar cursor traveling is possible at the end of the Input Field. The cursor can be placed right behind an Input Field and text can be inserted behind the Input Field. After a cursor move to the left the Input Field is entered and text at the end of the Input Field can be inserted.<br /> <br /> Entering and Leaving an Input Field will be indicated to the user by drawing a bounding rectangle around the Input Field when the cursor is inside the Input Field.<br /><br /> [[Image:InputField-cursor-inside-and-outside.png|1000px|center|screen shots showing cursor right before an Input Field and inside an Input Field]]<br /> <br /> Clicking with the mouse pointer into an Input Field will in general select its text content in order to enable the user to directly replace the Input Field's content.<br /> <br /> ==== Traveling between Input Fields ====<br /> Traveling from one Input Field to the next respectively previous one with the keyboard is possible via TAB-Key respectively via SHIFT-TAB-Key. When traveling the complete content of the Input Field is selected.<br /><br /> <br /> To insert a TAB character inside an Input Field using the keyboard the CTRL-TAB-Key have to be used.<br /> <br /> ==== Selection of Input Fields ====<br /> Any text selection inside an Input Fields is possible. When text outside an Input Field is part of a text selection only the complete Input Field can be added to the text selection. Thus, it is not possible to select a part of an Input Field's text content and other text content in one selection.<br /> <br /> ==== No Field Names for Input Fields ====<br /> Field Names are no longer shown for Input Fields. Via Menu - View - Field Names the Field Names of all fields could be displayed instead of the fields content. This will no longer work for Input Fields due to the in-place editing.<br /> <br /> ==== Microsoft Word binary filter (WW8 filter) ====<br /> In general Input Fields will be exported as Microsoft Word FORMTEXT fields.<br /><br /> Exceptions are imported Microsoft Word FILLIN fields - these will be exported as Microsoft Word FILLIN fields unless the Input Field's help text or tooltip text is filled.<br /> <br /> ==== Documents in read-only mode ====<br /> In-place editing of Input Fields is allowed when the document is in read-only mode. This is the same behavior as for text frames or sections for whose option to be editable in read-only mode has been set.<br /><br /> Also the field shadings for Input Fields are visible when the document is in read-only mode.<br /> <br /> <br /> == Areas which need high attention during testing ==<br /> * Only text content shall be inserted into Input Fields.<br /> * No formatting shall be possible inside Input Fields.<br /> * Applying a formatting while the cursor is inside an Input Field shall be applied to the complete Input Field.<br /> * No other attributes, like a hyperlink, a ruby, a page break or a column break, shall be possible inside Input Fields.<br /> * Default Formatting while the cursor is inside an Input Field.<br /> * The insertion of a 'New Paragraph' character or the key input of the ENTER-Key shall result into an insertion of a line break inside an Input Field.<br /> * Undo/Redo actions regarding Input Fields.<br /> * Functionality of other fields shall not be affected.<br /> * Applying formatting or other attributes to text content.<br /> * All of the above areas when having a multi-selection.<br /> * Save and Load of documents containing Input Fields.<br /> * Exchange of documents containing Input Fields in ODF with previous OpenOffice versions.<br /> * Exchange of documents containing Input Fields in Microsoft Word binary file format with Microsoft Word.<br /> * HTML export and import of text documents containing Input Fields - assure no change to previous versions.</div>

Od https://wiki.openoffice.org/w/index.php?title=Writer/Input_Fields&diff=232850 Writer/Input Fields 2014-01-16T11:31:08Z

<p>Od: </p> <hr /> <div>{{Writer Project|Category=Writer/Effort/Completed}}<br /> __NOTOC__<br /> <br /> = In-place editing of Input Fields =<br /> <br /> Purpose of this page is provide information on the solution for {{Bug|33737}}. This information should serve the corresponding quality assurance efforts. It can be also used as the source to document the corresponding changes for the users.<br /> <br /> <br /> <br /> == Input Fields - three of a kind ==<br /> We have three fields which are all named 'Input Field' in the user interface, but each has a different purpose.<br /><br /> These are '''Text Input Fields''', '''User Variable Input Fields''' and '''Simple Variable Input Fields'''.<br /><br /> Currently no changes are made for '''Simple Variable Input Fields''' for solving {{Bug|33737}}.<br /> <br /> <br /> ==== Text Input Field ====<br /> This is a field to prompt the user for an input. The field has a description and its content holds the user's input.<br /> <br /> In the OpenDocument file format (ODF) such a field is represented by ODF element <text:text-input>.<br /> <br /> When importing Microsoft Word documents (binary file format, *.doc) Microsoft Word fields FILLIN and FORMTEXT are imported as Text Input Fields.<br /> <br /> The user interface to create such a field is found in the Fields dialog (Menu - Insert - Fields - Others) on pane Functions. Here the user has to choose Type 'Input Field'.<br /> [[Image:Dialog-text-input.png|500px|center|dialog to create Text Input Field]]<br /> <br /> <br /> ==== User Variable Input Field ====<br /> This is a field to prompt the user to set the value of a user variable. The value of a user variable is the same throughout the complete document.<br /> <br /> In ODF such a field is represented by ODF element <text:user-field-input>.<br /> <br /> Microsoft Word has support for so-called Document Variables. The value of such variables can be shown in a Microsoft Word document, but are created/deleted/set via Microsoft Word macro (aka Visual Basic). These Document Variables seem to be comparable with ODF's User Variables, but currently there is no mapping between these in OpenOffice.<br /> A User Variable Input Field is treated as Text Input Field when exporting an OpenOffice text document to the Microsoft Word binary format.<br /> <br /> The user interface to create such a field is found in the Fields dialog on pane Variables. In advance the user has to create a user field (left part of the below screen shot). Then the user has to choose Type 'Input Field' and has to select the corresponding created user variable.<br /> [[Image:Dialog-user-field-input.png|1000px|center|dialog to create User Variable and a corresponding User Variable Text Input Field]]<br /> A '''User Field''' inserted visible in the document is not an Input Field and is not in the scope of the in-place editing.<br /> <br /> ==== Simple Variable Input Field ====<br /> This is a field to prompt the user to set the value of a simple variable. The value of a simple variable at a certain document position equals the value of the last set value - that is the difference to a user variable.<br /> <br /> In ODF such a field is represented by ODF element <text:variable-input>.<br /> <br /> For the Microsoft Word binary file format import/export filter these Simple Variable Input Fields are mapped to Microsoft Word ASK fields.<br /> <br /> The user interface to create such a field is found in the Fields dialog on pane Variables. In advance the user has to create a simple variable. Then the user has to choose Type 'Input Field' and has to select the corresponding created simple variable.<br /> [[Image:Dialog-variable-input.png|1000px|center|dialog to create Simple Variable and a corresponding Simple Variable Text Input Field]]<br /> <br /> <br /> <br /> == Changes in detail ==<br /> In the following the changes being in progress to solve {{Bug|33737}} are given in detail. Currently the changes will only affect '''Text Input Fields''' and '''User Variable Input Fields'''. Thus, the following use of term <nowiki>Input Field</nowiki> denotes these two types of Input Fields.<br /> <br /> ==== Edit content of Input Fields ====<br /> To modify/provide the content of an Input Field it is possible to directly perform the corresponding edit operations inside the document's text area. No additional popup dialog is needed.<br /><br /> As an Input Field can only contain text content most insertion operations are not allowed while the cursor is inside an Input Field. Also pasting operations and drop operations are not allowed. Pasting unformatted text (e.g. on Windows via SHIFT-CTRL-ALT-V) shall be possible.<br /> <br /> ==== Enter/Leaving Input Fields ====<br /> To enable the user to enter respectively leave an Input Field special hidden characters are inserted for the cursor traveling. Thus, the cursor can be positioned before an Input Field and text can be inserted before the Input Field. After a cursor move to the right the Input Field is entered and text at the beginning of the Input Field can be inserted. Similar cursor traveling is possible at the end of the Input Field. The cursor can be placed right behind an Input Field and text can be inserted behind the Input Field. After a cursor move to the left the Input Field is entered and text at the end of the Input Field can be inserted.<br /> <br /> Entering and Leaving an Input Field will be indicated to the user by drawing a bounding rectangle around the Input Field when the cursor is inside the Input Field.<br /><br /> [[Image:InputField-cursor-inside-and-outside.png|1000px|center|screen shots showing cursor right before an Input Field and inside an Input Field]]<br /> <br /> Clicking with the mouse pointer into an Input Field will in general select its text content in order to enable the user to directly replace the Input Field's content.<br /> <br /> ==== Traveling between Input Fields ====<br /> Traveling from one Input Field to the next respectively previous one with the keyboard is possible via TAB-Key respectively via SHIFT-TAB-Key. When traveling the complete content of the Input Field is selected.<br /><br /> <br /> To insert a TAB character inside an Input Field using the keyboard the CTRL-TAB-Key have to be used.<br /> <br /> ==== Selection of Input Fields ====<br /> Any text selection inside an Input Fields is possible. When text outside an Input Field is part of a text selection only the complete Input Field can be added to the text selection. Thus, it is not possible to select a part of an Input Field's text content and other text content in one selection.<br /> <br /> ==== No Field Names for Input Fields ====<br /> Field Names are no longer shown for Input Fields. Via Menu - View - Field Names the Field Names of all fields could be displayed instead of the fields content. This will no longer work for Input Fields due to the in-place editing.<br /> <br /> ==== Microsoft Word binary filter (WW8 filter) ====<br /> In general Input Fields will be exported as Microsoft Word FORMTEXT fields.<br /><br /> Exceptions are imported Microsoft Word FILLIN fields - these will be exported as Microsoft Word FILLIN fields unless the Input Field's help text or tooltip text is filled.<br /> <br /> ==== Documents in read-only mode ====<br /> In-place editing of Input Fields is allowed when the document is in read-only mode. This is the same behavior as for text frames or sections for whose option to be editable in read-only mode has been set.<br /><br /> Also the field shadings for Input Fields are visible when the document is in read-only mode.<br /> <br /> <br /> == Areas which need high attention during testing ==<br /> * Only text content shall be inserted into Input Fields.<br /> * No formatting shall be possible inside Input Fields.<br /> * Applying a formatting while the cursor is inside an Input Field shall be applied to the complete Input Field.<br /> * No other attributes, like a hyperlink, a ruby, a page break or a column break, shall be possible inside Input Fields.<br /> * Default Formatting while the cursor is inside an Input Field.<br /> * The insertion of a 'New Paragraph' character or the key input of the ENTER-Key shall result into an insertion of a line break inside an Input Field.<br /> * Undo/Redo actions regarding Input Fields.<br /> * Functionality of other fields shall not be affected.<br /> * Applying formatting or other attributes to text content.<br /> * All of the above areas when having a multi-selection.<br /> * Save and Load of documents containing Input Fields.<br /> * Exchange of documents containing Input Fields in ODF with previous OpenOffice versions.<br /> * Exchange of documents containing Input Fields in Microsoft Word binary file format with Microsoft Word.<br /> * HTML export and import of text documents containing Input Fields - assure no change to previous versions.</div>

Od https://wiki.openoffice.org/w/index.php?title=Writer/TOC&diff=232687 Writer/TOC 2014-01-08T16:16:53Z

<p>Od: </p> <hr /> <div>=<center>Table of Contents Improvements</center>=<br /> <br /> <center>'''On Path to Vision'''</center><br /> <br /> <br /> <center>Author: chengjh/zhengfan(@apache.org)</center><br /> <br /> ==Overall Description== <br /> TOC (Table of Contents) is a significant feature in AOO Writer. Although, it has provided powerful capabilities to benefit end users for productivity, the following areas, especially the fidelity with MS Word, still need improvements. I propose them and put them as the candidates of the next release.<br /> <br /> ==Descriptions of Main Problems==<br /> <br /> == Loading of MS Word TOC ==<br /> <br /> <br /> ===Binary Format===<br /> * The TOC data of a MS Word document is not parsed completely. And the actual TOC data is from silently updating once a MS Word Document loaded. Thus, the fidelity can not be ensured especially when the document contents that impact TOC have been changed after creating TOC in MS Word. <br /> * After TOC has been created in MS Word, and then the paragraphs applied with Heading styles are deleted or applied Heading styles un-applied to the paragraphs that have been collected into TOC. Once such MS Word binary document launched into Apache OpenOffice.org Writer, the TOC will disappear.<br /> * After TOC has been created in MS Word, and then new paragraphs are applied with Heading styles. Once such MS Word binary document launched into Apache OpenOffice.org Writer,new entries will be added to TOC.<br /> * The tab between chapter number and TOC entry lost when loading a MS Word document, which leads to different gap between chapter number and TOC entry. That looks different from MS Word.<br /> ====Status====<br /> <br /> Ongoing<br /> <br /> ====Function Specification====<br /> <br /> '''Abstract'''<br /> <br /> Give a solution for preserving the TOC contents in DOC files, via interpreting corresponding TOC entries data inside the MS Office Word 2003 .DOC binary format file, instead of the current implementation, in which generating the TOC contents via collected heading line information of the main contents inside the DOC files.<br /> <br /> '''Motivation'''<br /> <br /> The current Apache OpenOffice.org do not preserve the exact TOC entries contents via interpreting the TOC entries contents caches stored inside MS Office Word 2003 DOC format files, but generating TOC entries contents depend on collected heading paragraphs contents after loading whole document main contents. <br /> <br /> Such TOC loading strategy inside Apache OpenOffice.org leads 3 main issues show as below:<br /> <br /> # Bad fidelity on representing specified type of MS Word DOC. Considering a MS Word DOC in which contains several heading paragraphs and a TOC. If we delete all the main contents except the TOC and save the document, then reopen the file inside MS Word, the TOC would be the exactly the same as before. But if we open it inside the Apache OpenOffice.org, the TOC will be totally empty;<br /> # The manually created/removed TOC entries contents will be lost; Some users of Word would like to add or remove TOC entries manually after generating TOC inside MS Word. Such manual modifications happens on TOC contents will be representing perfectly inside MS word when reopen the DOC files. But, such manual modifications will be lost when loading the DOC files inside Apache OpenOffice.org;<br /> # The paragraph/text/field attributes assigned in TOC block will be lost; In some specified TOC generating mode, the paragraph/text/field attributes assigned on a heading paragraph may finally affect the TOC corresponding content entry representing. But in current Apache OpenOffice.org, such type of TOC inside MS Word Document, will be generated follow the standard TOC entries paragraph/text/field formatting;<br /> <br /> '''Detailed Specification'''<br /> <br /> '''The original TOC loading process introduction and the improvement of this feature'''<br /> <br /> In the current Word DOC TOC loading process, there are generally steps of work:<br /> <br /> # Verifying the exact position of TOC block in the document;<br /> # Parsing the TOC field expression and creating the internal TOC model with TOC entries pattern and TOC collecting rules accordingly;<br /> # Jump over the TOC field representation cache part;<br /> # Jump over the TOC field representation cache range corresponding paragraph/text/field attributes;<br /> # Collecting the heading paragraphs while loading the main contents of the document depend on said collecting rules;<br /> # Generating the TOC entries depend on said TOC entries pattern;<br /> <br /> In this MS Word DOC filter improvement focus on TOC contents cache, we will give following strategy changes:<br /> <br /> * <s>Heading paragraphs collecting step removal, indicate the step 5 above;</s><br /> * TOC generating/updating step removal, indicate the step 6 above;<br /> * TOC contents cache parsing step addition, expand the step 3 above;<br /> * TOC contents cache range corresponding paragraph/text/field attributes parsing, expend the step 4 above;<br /> <br /> '''The behavioral difference leads by this improvement'''<br /> <br /> This section is described by a user scenarios table.<br /> {| class="prettytable"<br /> ! <center>#</center><br /> ! <center>Scenario Description</center><br /> ! <center>Comment</center><br /> <br /> |-<br /> | <center>1</center><br /> | In Apache OpenOffice.org with this improvement, open MS Word DOC document that:<br /> <br /> * Has had several heading paragraphs and corresponding generated TOC inside;<br /> * All the main contents except the TOC are deleted;<br /> <br /> Result:<br /> <br /> The TOC contents cache preserved;<br /> | In further specified cases, some modifications may happens to the main contents, but the TOC was not updated before saving. In the current Apache OpenOffice.org, loaded TOC will always keep accordance exactly with the main contents/heading paragraphs. With this feature, we just preserve the TOC contents cache recorded in the DOC document anyway.<br /> <br /> |-<br /> | <center>2</center><br /> | In Apache OpenOffice.org with this improvement, open MS Word DOC document that:<br /> <br /> * Has a generated TOC inside;<br /> * The TOC block was modified manually by user, such as inserted new paragraphs, or(and) deleted paragraphs; <br /> <br /> Result:<br /> <br /> The user manually modifications happened on TOC are preserved;<br /> | In some special manually modified TOC cases, the TOC formatting result may be not as good as the generated one. <br /> <br /> |-<br /> | <center>3</center><br /> | In Apache OpenOffice.org with this improvement, open MS Word DOC document that:<br /> <br /> * Has several heading paragraphs and special text attributes such as strikethrough line and outline font and font color applied on whole or part of current paragraph;<br /> * Has a corresponding generated TOC inside;<br/> Result:<br/> The text attributes applied onto TOC entries accordingly;<br /> <br /> <br /> | <br /> <br /> |}<br /> <br /> '''Impact on Import/Export filters'''<br /> <br /> Support of the new paragraph style's List Level attribute in import/export filter for the following file formats:<br /> <br /> * Microsoft Word binary format (WW8)<br /> <br /> ====Design Description====<br /> <br /> '''The brief introduction of TOC in DOC files'''<br /> <br /> '''The TOC record in main content stream'''<br /> <br /> In MS Word 2003 Binary format, TOC was described as nested field, which field expression is “TOC” with external parameters. Same as all the types of field defined in MS Word 2003 binary format, TOC field start with key control word '0x13', followed with the field expression; After the field expression, if the field has the representing content inside (Toggled the field code off, in MS Word), then there will be an optional key control word '0x14' to separate the field expression and field representation contents. Finally, there will be another key control word '0x15' indicate the termination of the field.<br /> <br /> As we described above, the TOC in said format is defined as a nested field, which actually means that each TOC entry inside the representation content of TOC, is composed by some other types of field, such as HYPERLINK field and Page Reference field. In MS Word, if create a TOC with default settings, the created TOC will contain several TOC entries indicate several outline paragraphs inside current document. Each of said entry is actually a hyperlink field append a paragraph break key word '0x0D'. Further more, there will be a PAGEREF type field at the last of HPERLINK field representation content, for representing the page number. Referring to the following tables:<br /> <br /> '''composition of page reference field inside TOC'''<br /> <br /> {| class="prettytable"<br /> | <center>'''Start'''</center><br /> | colspan="2" | <center>'''Field expression'''</center><br /> | <center>'''Separator '''</center><br /> | <center>'''Field Representation'''</center><br /> | <center>'''End'''</center><br /> <br /> |-<br /> | '0x13'<br /> | “PAGEREF”<br /> | External parameter<br /> | '0x14'<br /> | Page Numbering<br /> | '0x15'<br /> <br /> |}<br /> '''External Parameter of page reference field would include:'''<br /> <br /> {| class="prettytable"<br /> | \h<br /> | Creates a hyperlink to the bookmarked paragraph.<br /> <br /> |-<br /> | \p<br /> | Causes the field to display its position relative to the source<br /> <br /> bookmark. If the PAGEREF field is on the same page as the<br /> <br /> bookmark, it omits "on page #" and returns "above" or "below"<br /> <br /> only. If the PAGEREF field is not on the same page as the<br /> <br /> bookmark, the string "on page #" is used.<br /> <br /> |}<br /> '''Composition of hyperlink field inside TOC'''<br /> <br /> {| class="prettytable"<br /> | <center>'''Start'''</center><br /> | colspan="2" | <center>'''Field expression'''</center><br /> | <center>'''Separator '''</center><br /> | colspan="2" | <center>'''Field Representation'''</center><br /> | <center>'''End'''</center><br /> <br /> |-<br /> | '0x13'<br /> | “HYPERLINK”<br /> | External parameter<br /> | '0x14'<br /> | Common text<br /> | Page reference field<br /> | '0x15'<br /> <br /> |}<br /> '''External Parameter of hyperlink field would include:'''<br /> <br /> {| class="prettytable"<br /> | \l ''field-argument''<br /> | ''text ''in this switch's ''field-argument ''specifies a location in the file, such as a bookmark, where this hyperlink will jump.<br /> <br /> |-<br /> | \m<br /> | Appends coordinates to a hyperlink for a server-side image map.<br /> <br /> |-<br /> | \n<br /> | Causes the destination site to be opened in a new window.<br /> <br /> |-<br /> | \o ''field-argument''<br /> | ''text ''in this switch's ''field-argument ''specifies the Screen-Tip text for the hyperlink.<br /> <br /> |-<br /> | \t ''field-argument''<br /> | ''text ''in this switch's ''field-argument ''specifies the target to which the link should be redirected. Use this switch to link from a frames page to a page that you want to appear outside of the frames page.<br /> <br /> The permitted values for ''text ''are:<br /> <br /> * _top, whole page (the default)<br /> * _self, same frame<br /> * _blank, new window<br /> * _parent, parent frame<br /> <br /> <br /> <br /> |}<br /> '''Composition of TOC field'''<br /> <br /> {| class="prettytable"<br /> | <center>'''Start'''</center><br /> | colspan="2" | <center>'''Field expression'''</center><br /> | <center>'''Separator '''</center><br /> | <center>'''Field Representation'''</center><br /> | <center>'''End'''</center><br /> <br /> |-<br /> | '0x13'<br /> | “TOC”<br /> | External parameter<br /> | '0x14'<br /> | TOC entries<br /> | '0x15'<br /> <br /> |}<br /> '''Composition of TOC entries:'''<br /> <br /> {| class="prettytable"<br /> | TOC Entry<br /> | TOC Entry<br /> | TOC Entry<br /> | TOC Entry<br /> | …...<br /> <br /> |}<br /> '''Composition of TOC entry:'''<br /> <br /> {| class="prettytable"<br /> | Hyperlink Field<br /> | '0x0D'<br /> <br /> |}<br /> '''External Parameter of TOC field would include:'''<br /> <br /> {| class="prettytable"<br /> | \a'' field-argument''<br /> | Includes captioned items, but omits caption labels and numbers. The identifier designated by ''text ''in this switch's ''field-argument ''corresponds to the caption label.<br /> <br /> Use \c to build a table of captions with labels and numbers.<br /> <br /> |-<br /> | \b ''field-argument ''<br /> | Includes entries only from the portion of the document marked by the bookmark named by ''text ''in this switch's ''field-argument''.<br /> <br /> |-<br /> | \c ''field-argument''<br /> | Includes figures, tables, charts, and other items that are numbered<br /> <br /> by a SEQ field. The sequence identifier designated by<br /> <br /> ''text ''in this switch's ''field-argument'', which corresponds to the<br /> <br /> caption label, shall match the identifier in the corresponding SEQ<br /> <br /> field.<br /> <br /> |-<br /> | \d'' field-argument''<br /> | When used with \s, the ''text ''in this switch's ''field-argument ''defines<br /> <br /> the separator between sequence and page numbers. The default<br /> <br /> separator is a hyphen (-).<br /> <br /> |-<br /> | \f'' field-argument ''<br /> | Includes only those TC fields whose identifier exactly matches the<br /> <br /> ''text ''in this switch's ''field-argument ''(which is typically a letter).<br /> <br /> |-<br /> | \h<br /> | Makes the table of contents entries hyperlinks.<br /> <br /> |-<br /> | \l ''field-argument ''<br /> | Includes TC fields that assign entries to one of the levels specified<br /> <br /> by ''text ''in this switch's ''field-argument ''as a range having the form<br /> <br /> ''startLevel''-''endLevel'', where ''startLevel ''and ''endLevel ''are integers,<br /> <br /> and ''startLevel ''has a value equal-to or less-than ''endLevel''. TC fields<br /> <br /> that assign entries to lower levels are skipped.<br /> <br /> |-<br /> | \n ''field-argument''<br /> | Without ''field-argument'', omits page numbers from the table of<br /> <br /> contents. Page numbers are omitted from all levels unless a range<br /> <br /> of entry levels is specified by ''text ''in this switch's ''field-argument''. A<br /> <br /> range is specified as for \l.<br /> <br /> |-<br /> | \o ''field-argument''<br /> | Uses paragraphs formatted with all or the specified range of builtin<br /> <br /> heading styles. Headings in a style range are specified by ''text ''in<br /> <br /> this switch's ''field-argument ''using the notation specified as for \l,<br /> <br /> where each integer corresponds to the style with a style ID of<br /> <br /> HeadingX (e.g. 1 corresponds to Heading1). If no heading range is<br /> <br /> specified, all heading levels used in the document are listed.<br /> <br /> |-<br /> | \p ''field-argument ''<br /> | ''text ''in this switch's ''field-argument ''specifies a sequence of<br /> <br /> characters that separate an entry and its page number. The default<br /> <br /> is a tab with leader dots.<br /> <br /> |-<br /> | \s ''field-argument''<br /> | For entries numbered with a SEQ field, adds a prefix to<br /> <br /> the page number. The prefix depends on the type of entry. ''text ''in<br /> <br /> this switch's ''field-argument ''shall match the identifier in the SEQ<br /> <br /> field.<br /> <br /> |-<br /> | \t ''field-argument''<br /> | Uses paragraphs formatted with styles other than the built-in<br /> <br /> heading styles. ''text ''in this switch's ''field-argument ''specifies those<br /> <br /> styles as a set of comma-separated doublets, with each doublet<br /> <br /> being a comma-separated set of style name and table of content<br /> <br /> level. \t can be combined with \o.<br /> <br /> |-<br /> | \u<br /> | Uses the applied paragraph outline level.<br /> <br /> |-<br /> | \w<br /> | Preserves tab entries within table entries.<br /> <br /> |-<br /> | \x<br /> | Preserves newline characters within table entries.<br /> <br /> |-<br /> | \z<br /> | Hides tab leader and page numbers in Web layout view.<br /> <br /> |}<br /> <br /> '''The TOC record in PLC stream'''<br /> <br /> As we know, MS Word 2003 binary format record SPRMs with corresponding CPs in PLC streams for specified types of properties. All the fields also applying the same data structure, and all the field corresponding field SPRMs are recorded in PLC stream named PLCFLD.<br /> <br /> '''The AOO current design of TOC loading'''<br /> <br /> The current design of loading TOC in MS Word 2003 binary format in AOO, is not a real “LOADING” way, but actually a “GENERATING” way, for the current design of AOO not trying to parse the cached representation contents of TOC field. <br /> <br /> After catching the TOC field start key word in main content stream, the current loading design will remark the TOC block position in the document and just parse the TOC field expression and parameters for creating the TOC entry token patterns, and jump over all the cached TOC field representation contents at all. The current loading process will collect all the outline paragraphs with heading paragraph styles or corresponding outline level settings, when performing load of rest part of document, and generate TOC entries depend on the TOC entry tokens patterns one by one. And this mechanism of TOC loading leads the several issues as we already known.<br /> <br /> '''Detailed Design of TOC loading Enhancement'''<br /> <br /> '''TOC Cached representation content loading'''<br /> <br /> For the TOC type field recorded in the main content stream, do no jump the cached representation contents any more. <br /> <br /> # In the TOC loading function ''SwWW8ImplReader::Read_F_TOX()'', return field status as FLD_TEXT, which indicate the rest part of field: representation content should be parsed, instead of FLD_OK, which indicate the rest part of field: representation content should be ignored;<br /> # In the page reference field loading function ''SwWW8ImplReader::Read_F_PgRef()'', return field status as FLD_TEXT, which indicate the rest part of field: representation content should be parsed, instead of FLD_OK, which indicate the rest part of field: representation content should be ignored, if current loading page reference field is inside a TOC field;<br /> # Mark the TOC field and hyperlink field as nestable field types, in the external function ''AcceptableNestedField()''<nowiki>;</nowiki><br /> # When parsing a page reference field inside a TOC field cached representation contents, convert the page reference field representation content as the common text string, for specified interoperability issue of ODF.<br /> # If there is no hyperlink field inside, convert the page reference field as a hyperlink;<br /> # In the finial step of field loading process: ''SwWW8ImplReader:: End_Field()'', give corresponding branch for dealing with TOC field, hyperlink field and page reference field.<br /> <br /> '''TOC entries generating'''<br /> <br /> For rest part of document loading, do not collecting and generating TOC entries anymore:<br /> <br /> # in the TOC loading function ''SwWW8ImplReader::Read_F_TOX(), ''disable the TOC updating flag after parsing the TOC expression; <br /> <br /> '''TOC block and rest part of document positing'''<br /> <br /> For the TOC field start step and end step, move the CURRENT insertion position of document;<br /> <br /> # in the TOC loading function ''SwWW8ImplReader::Read_F_TOX(), ''move the CURRENT insertion position into the TOC section;<br /> # in the finial step of field loading process: ''SwWW8ImplReader:: End_Field()'', move the CURRENT insertion position of document back to the next position of TOC section;<br /> <br /> ===OOXML Format===<br /> <br /> Same with binary file format.<br /> <br /> ====Status====<br /> <br /> Not Started...<br /> <br /> ==Customized Formats of TOC Entry==<br /> <br /> ===Binary Format===<br /> <br /> The customized character attributes will be lost when loading MS Word TOC created by un-checking "Use hyperlinks instead of page numbers". To this kind of TOC,the customized character attributes of the target paragraphs can be collected into TOC in MS Word.<br /> <br /> ====Status====<br /> <br /> Not Started<br /> <br /> ===OOXML Format===<br /> <br /> Same with binary file format.<br /> <br /> ====Status====<br /> <br /> Not Started<br /> <br /> ==Export TOC to MS Word==<br /> <br /> ===Binary Format===<br /> <br /> * Saving MS Word Binary Format Back<br /> The width of tab between chapter numbering and TOC entry will be changed.<br /> <br /> * Saving ODT to MS Word Binary<br /> The jumping hyperlink info will be lost when exporting odt TOC to MS Word binary TOC.<br /> <br /> ====Status====<br /> <br /> Not Started<br /> <br /> ===OOXML Format===<br /> <br /> ====Status====<br /> <br /> Not Started<br /> <br /> ==TOC Jumping with Page Numbers Only==<br /> <br /> Jump info will be lost when loading MS Word TOC created by un-checking "Use hyperlinks instead of page numbers". To this kind of TOC,end users can only press ctrl+mouse to click the page number of the TOC entry for jumping in MS Word.<br /> <br /> ===Status===<br /> <br /> Not Started<br /> <br /> <br /> ==Accessibility==<br /> <br /> The current TOC dialog can not meet the accessibility requirements.<br /> <br /> ===Status===<br /> <br /> Not Started<br /> <br /> ==Usability==<br /> <br /> The current TOC dialog is difficult for end users to understand and use..Most end users can just only create a TOC by default, confusing to customize the attributes and styles.<br /> <br /> ===Status===<br /> <br /> Not Started,need UX designer..<br /> <br /> ==Comments==<br /> <br /> <br /> <br /> [[Category:Writer/Effort/Completed]]</div>

Od https://wiki.openoffice.org/w/index.php?title=Writer/Input_Fields&diff=232686 Writer/Input Fields 2014-01-08T16:16:02Z

<p>Od: </p> <hr /> <div>{{Writer Project|Category=Writer/Effort/Completed}}<br /> __NOTOC__<br /> <br /> = In-place editing of Input Fields =<br /> <br /> Purpose of this page is provide information on the solution for {{Bug|33737}}. This information should serve the corresponding quality assurance efforts. It can be also used as the source to document the corresponding changes for the users.<br /> <br /> <br /> <br /> == Input Fields - three of a kind ==<br /> We have three fields which are all named 'Input Field' in the user interface, but each has a different purpose.<br /><br /> These are '''Text Input Fields''', '''User Variable Input Fields''' and '''Simple Variable Input Fields'''.<br /><br /> Currently no changes are made for '''Simple Variable Input Fields''' for solving {{Bug|33737}}.<br /> <br /> <br /> ==== Text Input Field ====<br /> This is a field to prompt the user for an input. The field has a description and its content holds the user's input.<br /> <br /> In the OpenDocument file format (ODF) such a field is represented by ODF element <text:text-input>.<br /> <br /> When importing Microsoft Word documents (binary file format, *.doc) Microsoft Word fields FILLIN and FORMTEXT are imported as Text Input Fields.<br /> <br /> The user interface to create such a field is found in the Fields dialog (Menu - Insert - Fields - Others) on pane Functions. Here the user has to choose Type 'Input Field'.<br /> [[Image:Dialog-text-input.png|500px|center|dialog to create Text Input Field]]<br /> <br /> <br /> ==== User Variable Input Field ====<br /> This is a field to prompt the user to set the value of a user variable. The value of a user variable is the same throughout the complete document.<br /> <br /> In ODF such a field is represented by ODF element <text:user-field-input>.<br /> <br /> Microsoft Word has support for so-called Document Variables. The value of such variables can be shown in a Microsoft Word document, but are created/deleted/set via Microsoft Word macro (aka Visual Basic). These Document Variables seem to be comparable with ODF's User Variables, but currently there is no mapping between these in OpenOffice.<br /> A User Variable Input Field is treated as Text Input Field when exporting an OpenOffice text document to the Microsoft Word binary format.<br /> <br /> The user interface to create such a field is found in the Fields dialog on pane Variables. In advance the user has to create a user field. Then the user has to choose Type 'Input Field' and has to select the corresponding created user variable.<br /> [[Image:Dialog-user-field-input.png|1000px|center|dialog to create User Variable and a corresponding User Variable Text Input Field]]<br /> <br /> <br /> ==== Simple Variable Input Field ====<br /> This is a field to prompt the user to set the value of a simple variable. The value of a simple variable at a certain document position equals the value of the last set value - that is the difference to a user variable.<br /> <br /> In ODF such a field is represented by ODF element <text:variable-input>.<br /> <br /> For the Microsoft Word binary file format import/export filter these Simple Variable Input Fields are mapped to Microsoft Word ASK fields.<br /> <br /> The user interface to create such a field is found in the Fields dialog on pane Variables. In advance the user has to create a simple variable. Then the user has to choose Type 'Input Field' and has to select the corresponding created simple variable.<br /> [[Image:Dialog-variable-input.png|1000px|center|dialog to create Simple Variable and a corresponding Simple Variable Text Input Field]]<br /> <br /> <br /> <br /> == Changes in detail ==<br /> In the following the changes being in progress to solve {{Bug|33737}} are given in detail. Currently the changes will only affect '''Text Input Fields''' and '''User Variable Input Fields'''. Thus, the following use of term <nowiki>Input Field</nowiki> denotes these two types of Input Fields.<br /> <br /> ==== Edit content of Input Fields ====<br /> To modify/provide the content of an Input Field it is possible to directly perform the corresponding edit operations inside the document's text area. No additional popup dialog is needed.<br /><br /> As an Input Field can only contain text content most insertion operations are not allowed while the cursor is inside an Input Field. Also pasting operations and drop operations are not allowed. Pasting unformatted text (e.g. on Windows via SHIFT-CTRL-ALT-V) shall be possible.<br /> <br /> ==== Enter/Leaving Input Fields ====<br /> To enable the user to enter respectively leave an Input Field special hidden characters are inserted for the cursor traveling. Thus, the cursor can be positioned before an Input Field and text can be inserted before the Input Field. After a cursor move to the right the Input Field is entered and text at the beginning of the Input Field can be inserted. Similar cursor traveling is possible at the end of the Input Field. The cursor can be placed right behind an Input Field and text can be inserted behind the Input Field. After a cursor move to the left the Input Field is entered and text at the end of the Input Field can be inserted.<br /> <br /> Entering and Leaving an Input Field will be indicated to the user by drawing a bounding rectangle around the Input Field when the cursor is inside the Input Field.<br /><br /> [[Image:InputField-cursor-inside-and-outside.png|1000px|center|screen shots showing cursor right before an Input Field and inside an Input Field]]<br /> <br /> Clicking with the mouse pointer into an Input Field will in general select its text content in order to enable the user to directly replace the Input Field's content.<br /> <br /> ==== Traveling between Input Fields ====<br /> Traveling from one Input Field to the next respectively previous one with the keyboard is possible via TAB-Key respectively via SHIFT-TAB-Key. When traveling the complete content of the Input Field is selected.<br /><br /> <br /> To insert a TAB character inside an Input Field using the keyboard the CTRL-TAB-Key have to be used.<br /> <br /> ==== Selection of Input Fields ====<br /> Any text selection inside an Input Fields is possible. When text outside an Input Field is part of a text selection only the complete Input Field can be added to the text selection. Thus, it is not possible to select a part of an Input Field's text content and other text content in one selection.<br /> <br /> ==== No Field Names for Input Fields ====<br /> Field Names are no longer shown for Input Fields. Via Menu - View - Field Names the Field Names of all fields could be displayed instead of the fields content. This will no longer work for Input Fields due to the in-place editing.<br /> <br /> ==== Microsoft Word binary filter (WW8 filter) ====<br /> In general Input Fields will be exported as Microsoft Word FORMTEXT fields.<br /><br /> Exceptions are imported Microsoft Word FILLIN fields - these will be exported as Microsoft Word FILLIN fields unless the Input Field's help text or tooltip text is filled.<br /> <br /> ==== Documents in read-only mode ====<br /> In-place editing of Input Fields is allowed when the document is in read-only mode. This is the same behavior as for text frames or sections for whose option to be editable in read-only mode has been set.<br /><br /> Also the field shadings for Input Fields are visible when the document is in read-only mode.<br /> <br /> <br /> == Areas which need high attention during testing ==<br /> * Only text content shall be inserted into Input Fields.<br /> * No formatting shall be possible inside Input Fields.<br /> * Applying a formatting while the cursor is inside an Input Field shall be applied to the complete Input Field.<br /> * No other attributes, like a hyperlink, a ruby, a page break or a column break, shall be possible inside Input Fields.<br /> * Default Formatting while the cursor is inside an Input Field.<br /> * The insertion of a 'New Paragraph' character or the key input of the ENTER-Key shall result into an insertion of a line break inside an Input Field.<br /> * Undo/Redo actions regarding Input Fields.<br /> * Functionality of other fields shall not be affected.<br /> * Applying formatting or other attributes to text content.<br /> * All of the above areas when having a multi-selection.<br /> * Save and Load of documents containing Input Fields.<br /> * Exchange of documents containing Input Fields in ODF with previous OpenOffice versions.<br /> * Exchange of documents containing Input Fields in Microsoft Word binary file format with Microsoft Word.<br /> * HTML export and import of text documents containing Input Fields - assure no change to previous versions.</div>

Od https://wiki.openoffice.org/w/index.php?title=Sidebar_for_Developers&diff=232199 Sidebar for Developers 2013-11-11T13:03:27Z

<p>Od: /* Context Specification */</p> <hr /> <div>This page will teach you how to write panels for the sidebar,<br /> either as extensions or in the core (core means C++ code<br /> in the OpenOffice source repository). <br /> <br /> For a general description of concepts and names please see the main [[sidebar]] page.<br /> <br /> ==Status==<br /> The sidebar development is finished and part of the 4.0 release. Here is how it looks:<br><br /> [[File:sidebar-2013-04-15.png|400px]]<br /> <br /> ==General Information==<br /> <br /> Some bugzilla meta issues regarding the sidebar:<br /> <br /> Original implementation of the sidebar for OpenOffice 4.0: [https://issues.apache.org/ooo/show_bug.cgi?id=121420 121420]<br /> <br /> Open bugs for post 4.0: [https://issues.apache.org/ooo/show_bug.cgi?id=122364 122364]<br /> <br /> Enhancement ideas and requests: [https://issues.apache.org/ooo/show_bug.cgi?id=122257 122257]<br /> <br /> Much of what has to be done to write a new sidebar panel is the same<br /> for extensions and core.<br /> <br /> First you have to decide where and when to show the new panel.<br /> <br /> ;Where: Panels can be shown in any of the existing decks or in a new deck. Inside a deck the new panel can be displayed above, below, or in between existing panels.<br /> ;When: The set of visible panels in the property deck changes with the current configuration. Other decks usually show always the same panel, regardless of the context. But these are not hardwired rules. New panels can behave differently, when there is a good reason.<br /> <br /> The implementation of a panel has only to implement two interfaces:<br /> <code>css::ui::XUIElement</code> and <code>css::ui::XToolPanel</code>. <code>The css::ui::XSidebarPanel</code> interface<br /> is optional.<br /> <br /> Panels are created by factories via the <code>css::ui::XUIElementFactory</code> interface.<br /> If you add a panel to the core then you will probably use one of the<br /> existing panel factories in SVX, SW, SC, or SD. An extension will<br /> usually bring its own factory.<br /> <br /> There is a description of each deck and each panel in the Sidebar.xcu<br /> file. Decks don't have any implementation per-deck. They are only<br /> described by their properties in the XCU file. Panels have both<br /> implementation and a XCU description.<br /> <br /> <br /> ==Contexts==<br /> <br /> The following table shows the association between panels and dialogs for all supported contexts. It also lists whether panels are initially displayed expanded or collapsed and the uno command to use to open a more detailed dialog. Applications are abreviated:<br /> * SC - Calc<br /> * SD - Draw and Impress<br /> * SW - Writer<br /> <br /> {| class="prettytable sortable"<br /> !Panel<br /> !Application<br /> !Context<br /> !Initially visible<br /> !Detail dialog command<br /> |-<br /> |Alignment ||SC|| Auditing ||yes|| .uno:Hyphenate<br /> |-<br /> |Alignment ||SC|| Cell ||yes|| .uno:Hyphenate<br /> |-<br /> |Alignment ||SC|| EditCell ||yes|| .uno:Hyphenate<br /> |-<br /> |Alignment ||SC|| Pivot ||yes|| .uno:Hyphenate<br /> |-<br /> |Area ||SC|| Draw ||yes|| .uno:FormatArea<br /> |-<br /> |Area ||SD|| 3DObject ||yes|| .uno:FormatArea<br /> |-<br /> |Area ||SD|| Draw ||yes|| .uno:FormatArea<br /> |-<br /> |Area ||SD|| TextObject ||no || .uno:FormatArea<br /> |-<br /> |Area ||SW|| Draw ||yes|| .uno:FormatArea<br /> |-<br /> |Cell Appearance ||SC|| Auditing ||yes|| .uno:FormatCellDialog<br /> |-<br /> |Cell Appearance ||SC|| Cell ||yes|| .uno:FormatCellDialog<br /> |-<br /> |Cell Appearance ||SC|| Pivot ||yes|| .uno:FormatCellDialog<br /> |-<br /> |Graphic ||SC|| Graphic ||yes|| -none-<br /> |-<br /> |Graphic ||SD|| Graphic ||yes|| -none-<br /> |-<br /> |Graphic ||SW|| Graphic ||yes|| -none-<br /> |-<br /> |Line ||SC|| Draw ||yes|| .uno:FormatLine<br /> |-<br /> |Line ||SC|| Graphic ||yes|| .uno:FormatLine<br /> |-<br /> |Line ||SD|| 3DObject ||yes|| .uno:FormatLine<br /> |-<br /> |Line ||SD|| Draw ||yes|| .uno:FormatLine<br /> |-<br /> |Line ||SD|| Graphic ||yes|| .uno:FormatLine<br /> |-<br /> |Line ||SD|| TextObject ||no || .uno:FormatLine<br /> |-<br /> |Line ||SW|| Draw ||yes|| .uno:FormatLine<br /> |-<br /> |Number Format ||SC|| Auditing ||no || .uno:FormatCellDialog<br /> |-<br /> |Number Format ||SC|| Cell ||no || .uno:FormatCellDialog<br /> |-<br /> |Number Format ||SC|| Pivot ||no || .uno:FormatCellDialog<br /> |-<br /> |Wrap ||SW|| Graphic ||yes|| .uno:ObjectWrapDialog<br /> |-<br /> |Wrap ||SW|| OLE ||yes|| .uno:ObjectWrapDialog<br /> |-<br /> |Wrap ||SW|| Frame ||yes|| .uno:ObjectWrapDialog<br /> |-<br /> |Layouts ||SD|| DrawPage ||yes|| -none-<br /> |-<br /> |Layouts ||SD|| HandoutPage ||yes|| -none-<br /> |-<br /> |Layouts ||SD|| NotesPage ||yes|| -none-<br /> |-<br /> |Layouts ||SD|| SlidesorterPage ||yes|| -none-<br /> |-<br /> |Page ||SW|| Table ||no || .uno:PageDialog<br /> |-<br /> |Page ||SW|| Text ||no || .uno:PageDialog<br /> |-<br /> |Paragraph ||SC|| DrawText ||yes|| .uno:ParagraphDialog<br /> |-<br /> |Paragraph ||SD|| 3DObject ||yes|| .uno:ParagraphDialog<br /> |-<br /> |Paragraph ||SD|| Draw ||no || .uno:ParagraphDialog<br /> |-<br /> |Paragraph ||SD|| DrawText ||yes|| .uno:ParagraphDialog<br /> |-<br /> |Paragraph ||SD|| Graphic ||no || .uno:ParagraphDialog<br /> |-<br /> |Paragraph ||SD|| Table ||yes|| .uno:ParagraphDialog<br /> |-<br /> |Paragraph ||SD|| TextObject ||yes|| .uno:ParagraphDialog<br /> |-<br /> |Paragraph ||SW|| Annotation ||yes|| .uno:ParagraphDialog<br /> |-<br /> |Paragraph ||SW|| DrawText ||yes|| .uno:ParagraphDialog<br /> |-<br /> |Paragraph ||SW|| Table ||yes|| .uno:ParagraphDialog<br /> |-<br /> |Paragraph ||SW|| Text ||yes|| .uno:ParagraphDialog<br /> |-<br /> |Position and Size ||SC|| Draw ||no || .uno:TransformDialog<br /> |-<br /> |Position and Size ||SC|| Form ||yes|| .uno:TransformDialog<br /> |-<br /> |Position and Size ||SC|| Graphic ||no || .uno:TransformDialog<br /> |-<br /> |Position and Size ||SC|| Media ||yes|| .uno:TransformDialog<br /> |-<br /> |Position and Size ||SC|| MultiObject ||yes|| .uno:TransformDialog<br /> |-<br /> |Position and Size ||SC|| OLE ||yes|| .uno:TransformDialog<br /> |-<br /> |Position and Size ||SD|| 3DObject ||yes|| .uno:TransformDialog<br /> |-<br /> |Position and Size ||SD|| Draw ||no || .uno:TransformDialog<br /> |-<br /> |Position and Size ||SD|| Form ||yes|| .uno:TransformDialog<br /> |-<br /> |Position and Size ||SD|| Graphic ||no || .uno:TransformDialog<br /> |-<br /> |Position and Size ||SD|| Media ||yes|| .uno:TransformDialog<br /> |-<br /> |Position and Size ||SD|| MultiObject ||yes|| .uno:TransformDialog<br /> |-<br /> |Position and Size ||SD|| OLE ||yes|| .uno:TransformDialog<br /> |-<br /> |Position and Size ||SD|| TextObject ||no || .uno:TransformDialog<br /> |-<br /> |Position and Size ||SW|| Draw ||no || .uno:TransformDialog<br /> |-<br /> |Position and Size ||SW|| Form ||yes|| .uno:TransformDialog<br /> |-<br /> |Position and Size ||SW|| Graphic ||yes|| .uno:GraphicDialog<br /> |-<br /> |Position and Size ||SW|| Media ||yes|| .uno:TransformDialog<br /> |-<br /> |Position and Size ||SW|| OLE ||yes|| .uno:FrameDialog<br /> |-<br /> |Table Design ||SD|| Table ||yes|| -none-<br /> |-<br /> |Text ||SC|| Auditing ||yes|| .uno:CellTextDlg<br /> |-<br /> |Text ||SC|| Cell ||yes|| .uno:CellTextDlg<br /> |-<br /> |Text ||SC|| DrawText ||yes|| .uno:FontDialog<br /> |-<br /> |Text ||SC|| EditCell ||yes|| .uno:FontDialog<br /> |-<br /> |Text ||SC|| Pivot ||yes|| .uno:CellTextDlg<br /> |-<br /> |Text ||SD|| 3DObject ||yes|| .uno:FontDialog<br /> |-<br /> |Text ||SD|| Draw ||no || .uno:FontDialog<br /> |-<br /> |Text ||SD|| DrawText ||yes|| .uno:FontDialog<br /> |-<br /> |Text ||SD|| Graphic ||no || .uno:FontDialog<br /> |-<br /> |Text ||SD|| OutlineTExt ||yes|| .uno:FontDialog<br /> |-<br /> |Text ||SD|| Table ||yes|| .uno:FontDialog<br /> |-<br /> |Text ||SD|| Textobj ||yes|| .uno:FontDialog<br /> |-<br /> |Text ||SW|| Annotation ||yes|| .uno:FontDialog<br /> |-<br /> |Text ||SW|| DrawText ||yes|| .uno:FontDialog<br /> |-<br /> |Text ||SW|| Table ||yes|| .uno:FontDialog<br /> |-<br /> |Text ||SW|| Text ||yes|| .uno:FontDialog<br /> |-<br /> |}<br /> <br /> There are some simple documents for Writer, Calc and Impress illustrate how switch to any of the contexts:<br /> *Writer: [[File:Contexts-Writer.odt]]<br /> *Calc: [http://people.apache.org/~af/sidebar/qa/Contexts-Calc.ods Contexts-Calc.ods]<br /> *Impress: [http://people.apache.org/~af/sidebar/qa/Contexts-Impress.odp Contexts-Impress.odp]<br /> <br /> ==Implemenation design==<br /> <br /> The UI of the sidebar consists of two major components:<br /> <br /> *The buttons in the vertical tab bar on the right switch manually between sidebar decks.<br /> *The content area contains a two-tier hierarchy of deck and content panels. There is one deck visible at any one time. It contains one or more content panels. A content panel can be displayed expanded or collapsed. <br /> <br /> The visible deck and content panels depend on the current context. Each context change may result in replacing one set of visible panels with another or changing the whole deck. A context consists of two strings:<br /> *The id of the current application (like <code>com.sun.star.text.TextDocument</code> for Writer).<br /> *The name of the actual context (like <code>Text</code> for text editing, <code>Table</code> for editing table content, or <code>default</code> for the default context)<br /> <br /> ===Context===<br /> What makes up a context depends on the application. For example <code>Text</code> is the default context for Writer but in Impress you have to select a text object to enter that context.<br /> <br /> ====Context change notification====<br /> Context changes are broadcast office wide via the <code>com::sun::star::ui::ContextChangeEventMultiplexer</code> singleton service and <code>com::sun::star::ui::XContextChangeEventMultiplexer</code> interface. In order to restrict the communication to one application window there exists the concept of the event focus. When you register as context change event listener or broadcast a change notification then you pass a event focus object. Only when listener and broadcaster use the same event focus object then the notification will pass from broadcaster to listener. Typically the event focus object is the controller of the application.<br /> <br /> To make life easier for developers there exists the <code>svx::sidebar::ContextChangeEventMultiplexer</code> frontend that<br /> - figures out the application name and event focus from either a given <code>frame::XController</code> or <code>SfxViewShell</code> object.<br /> - accepts only enum values from <code>sfx2::sidebar::EnumContext::Context</code> to prevent typos in context names to not correctly deliver context change events.<br /> <br /> On the receiving side of context change events there is the <code>sfx2::sidebar::SidebarPanelBase</code> base class for panel implementations. Let your panel implement the <code>sfx2::sidebar::IContextChangeReceiver</code> interface, use SidebarPanelBase (which probably needs a better name) as glue code between the sidebar framework and your panel and context change events will be delivered to you via the <code>IContextChangeReceiver::HandleContextChange()</code> method. Not all panels need to be informed about context changes. For many it is enough that they are activated for some contexts and deactivated for others.<br /> <br /> ====Forced context changes====<br /> By default the property deck is displayed. The user can switch between decks by clicking on buttons in the tab bar. This will result in the forced notification of a context change.<br /> <br /> ===Defining the set of decks and panels===<br /> Apart from the actual implementation the sidebar framework needs to know which decks and panels exists, which panels are to be displayed in each deck and for what configuration to display each deck and panel.<br /> <br /> The configuration files <code>Sidebar.xcs</code> (schema) and <code>Sidebar.xcu</code> (data) can be found in the <code>main/officecfg</code> module. They describe a list of decks and a list of panels.<br /> <br /> ====Decks====<br /> Each deck has<br /> *a unique id ("Id") which is referenced by panels that are to be displayed in the deck<br /> *a localized title ("Title") for display in the deck title bar<br /> *two URLs for the icon in the tab bar, one ("IconURL") is the default icon, the other ("HighContrastIconURL") is used when high contrast mode is active<br /> *an integer number ("OrderIndex") that describes the order in which deck icons are displayed in the tab bar; higher values result in locations farther down.<br /> *a string list of context descriptions ("ContextList") that specify for which contexts to display the deck; see more details about this in one of the next sections.<br /> <br /> ====Panels====<br /> <br /> Each panel has<br /> *a unique id ("DeckId") which references a deck by its "Id" field; the panel will only be displayed in the referenced deck<br /> *a localized title ("Title") for display in the deck title bar<br /> *a flag ("TitleBarIsOptional") that indicates whether the title bar can be omitted when the panel is the only one in the deck<br /> *a command name ("DefaultMenuCommand") for opening a dialog with more detailed options (eg. ".uno:FormatArea"); when no command is given then no menu icon will be displayed in the panel title bar<br /> *an integer number ("OrderIndex") that describes the order in which panels are placed in their deck; higher values result in locations farther down.<br /> *a string list of context descriptions ("ContextList") that specify for which contexts to display the deck. See more details about this in the the next section.<br /> *a URL for specifying the implementation ("ImplementationURL") like <code>private:resource/toolpanel/SvxPanelFactory/AreaPropertyPanel</code>.<br /> <br /> ====Context Specification====<br /> The "ContextList" properties of both decks and panels have basically a table form that is evaluated after each context change. If one of its rows matches the new context then deck or panel is displayed.<br /> <br /> Rows are really separated by semicolons (or whatever you specify in the opening <code>value</code> tag). Formatting them into rows just makes reading their content easier. Each row contains three or four values which are separated by commas. Leading and trailing spaces are ignored.<br /> <br /> Columns are:<br /> ;Application name:<br /> This can be the full application name as returned by <code>frame.ModuleManager</code> but to increase readability shorter names can also be used. There is a special name, <code>DrawImpress</code> for the common case that decks and panels are handled exactly the same in Draw and Impress. Similarily <code>WriterVariants</code> covers the applications Writer, Writer Globaldocument, Writer/Web, Writer Form Document, Writer Form Design Document and Writer Report Design Document.<br /> Recognized values are:<br /> com.sun.star.text.TextDocument<br /> com.sun.star.text.GlobalDocument<br /> com.sun.star.text.WebDocument<br /> com.sun.star.xforms.XMLFormDocument<br /> com.sun.star.sdb.FormDesign<br /> com.sun.star.sdb.TextReportDesign<br /> com.sun.star.sheet.SpreadsheetDocument<br /> com.sun.star.presentation.PresentationDocument<br /> com.sun.star.drawing.DrawingDocument<br /> <br /> Writer<br /> WriterGlobal<br /> WriterWeb<br /> WriterXML<br /> WriterForm<br /> WriterReport<br /> Calc<br /> Impress<br /> Draw<br /> <br /> DrawImpress<br /> WriterVariants<br /> any<br /> none<br /> Most of these are self explanatory. <code>DrawImpress</code> and <code>WriterAndWeb</code> have been explained above. <code>any</code> matches any application while <code>none</code> matches no application. Use <code>none</code> to disable deck or panel temporarily during development.<br /> ;Context name:<br /> Recognized values are <code>3DObject</code>, <code>Annotation</code>, <code>Auditing</code>, <code>Cell</code>, <code>Chart</code>, <code>Draw</code>, <code>DrawPage</code>, <code>DrawText</code>, <code>EditCell</code>, <code>Form</code>, <code>Frame</code>, <code>Graphic</code>, <code>HandoutPage</code>, <code>MasterPage</code>, <code>Media</code>, <code>Multiobj</code>, <code>OLE</code>, <code>OutlineText</code>, <code>Pivot</code>, <code>SlidesorterPage</code>, <code>Table</code>, <code>Text</code>, <code>TextObject</code>.<br /> It is, however, possible to invent your own context names.<br /> The special value <code>any</code> matches any context name.<br /> ;Initial state:<br /> Can be either <code>visible</code> or <code>hidden</code>.<br /> For decks this state decides whether the deck is initially enabled or disabled. You can change this state at runtime via the top button in the sidebar tab bar.<br /> For panels this state controls whether the panel is initially expanded or collapsed. Click on the panel title bar to toggle this state.<br /> ;Menu command override:<br /> This optional value is only used for panels. It overrides the "DefaultMenuCommand" for the panel.<br /> <br /> Here is an example for the "Area" property panel:<br /> <prop oor:name="ContextList"><br /> <value oor:separator=";"><br /> Calc, Draw, visible ;<br /> DrawImpress, 3DObject, visible ;<br /> DrawImpress, Draw, visible ;<br /> DrawImpress, TextObject, hidden ;<br /> Writer, Draw, visible ;<br /> </value><br /> </prop><br /> The panel will be displayed for the "Draw" context for all applications. For Draw and Impress it will also be shown for contexts "3DObject" and "TextObject". The panel will be initially expanded except for the "TextObject" context for Draw and Impress. For this context it will be initially collapsed.<br /> <br /> ===Legacy addons===<br /> Legacy addons are find in the application specific WindowState configuration files and instaniated via the existing ui::UIElementFactoryManager infrastructure is used.<br /> 5.3 Sidebar<br /> <br /> ==Panel via extension==<br /> <br /> Here are detailed information about what to do to write an extension<br /> that provides new decks and panels. Writing the actual extension is<br /> described elsewhere and not described in detail here.<br /> <br /> Here is a checklist of what an extension has to bring:<br /> <br /> *A Sidebar.xcu snippet that will be merged in the global Sidebar.xcu file on extension registration . It describes the decks and panels that are provided by the extension.<br /> * A Factories.xcu snippet that will be merged into the global Factories.xcu file on extension registration. It describes the factory that creates the new panels.<br /> * Implementation of the new panels.<br /> * Implementation of the new panel factory.<br /> * Optional: if your extension brings its own UNO commands then you have to supply your own protocol handler. This requires a ProtocolHandler.xcu snippet and an implementation of the XDispatchProvider interface.<br /> * Implementation of the __writeRegistryServiceInfo() and __getServiceFactory() methods for registering and creation of the panel factory and protocol handler.<br /> * A manifest.xml file that lists the files that the extension provides and that have to be deployed when the extension is installed.<br /> * A description.xml file that provides general properties about the extension such as name, version, supported platforms, minimal OpenOffice version, and about you, the author/publisher.<br /> <br /> That may sound like more than it really is. The demo extension that is described below has a total of 15 source files (10 Java files, 3 XCU files, 2 XML files).<br /> <br /> ===Example: Analog Clock Extension===<br /> Let's see how this looks in a real (but simple) demo extension. The extension provides a new "Tools" deck and one panel. The panel is shown in the new deck and displays the current time as analog clock. It does that by using a canvas, that is provided by the sidebar framework.<br /><br /> [[File:analog-clock-screenshot.png]]<br /> <br /> You can find the source code as Eclipse project [http://people.apache.org/~af/clock/AnalogClock.zip here] and the extension [http://people.apache.org/~af/clock/AnalogClock.oxt here].<br /> <br /> ====Files====<br /> This section only shows the important or interesting parts of source code files. The full source and the extension can be found elsewhere.<br /> <br /> =====Sidebar.xcu=====<br /> <br /> The Sidebar.xcu file has two entries. The one for the new "Tools"<br /> deck looks like this:<br /> <syntaxhighlight lang="XML"><br /> <node oor:name="ToolsDeck" oor:op="replace"><br /> <prop oor:name="Title" oor:type="xs:string"><br /> <value xml:lang="en-US">Tools</value><br /> </prop><br /> <prop oor:name="Id" oor:type="xs:string"><br /> <value>ToolsDeck</value><br /> </prop><br /> <prop oor:name="IconURL" oor:type="xs:string"><br /> <value>vnd.sun.star.extension://org.apache.openoffice.sidebar.AnalogClock/icons/tools-large.png</value><br /> </prop><br /> <prop oor:name="ContextList"><br /> <value oor:separator=";"><br /> any, any, visible ;<br /> </value><br /> </prop><br /> </node><br /> </syntaxhighlight><br /> The name of the outer node, "ToolsDeck" in this case, can be any string. The only constraint is, that it has to be unique among the<br /> deck nodes.<br /> <br /> The "Id" property is referenced by the panel below. It could also be referenced by panels from other extensions. This tools<br /> deck could be the deck for a whole family of panels that come from more than one extensions.<br /> <br /> The "IconURL" property defines the icon to use in the tab bar for the button that switches to the "Tools" deck. The value has three parts. The firs part is the protocol for files that are provided by an extension: "vnd.sun.star.extension://". The second part is the name of the extension as defined in the description.xml file. The third part is the relative path of where the icon can be found. That means that the OXT extension file has an entry "icons/tools-large.png". When the extension is registered, this file is copied to somewhere inside the user part of the OpenOffice file system.<br /> <br /> The "ContextList" property will be explained below. The panel description has the exact same property.<br /> <br /> The second entry in the Sidebar.xcu file describes the new panel:<br /> <syntaxhighlight lang="XML"><br /> <node oor:name="AnalogClockPanel" oor:op="replace"><br /> <prop oor:name="Title" oor:type="xs:string"><br /> <value xml:lang="en-US">Analog Clock</value><br /> </prop><br /> <prop oor:name="Id" oor:type="xs:string"><br /> <value>AnalogClockPanel</value><br /> </prop><br /> <prop oor:name="DeckId" oor:type="xs:string"><br /> <value>ToolsDeck</value><br /> </prop><br /> <prop oor:name="ContextList"><br /> <value oor:separator=";"><br /> any, any, visible ;<br /> </value><br /> </prop><br /> <prop oor:name="ImplementationURL" oor:type="xs:string"><br /> <value>private:resource/toolpanel/AnalogClockPanelFactory/AnalogClockPanel</value><br /> </prop><br /> <prop oor:name="OrderIndex" oor:type="xs:int"><br /> <value>100</value><br /> </prop><br /> <prop oor:name="WantsCanvas" oor:type="xs:boolean"><br /> <value>true</value><br /> </prop><br /> <prop oor:name="DefaultMenuCommand"><br /> <value>org.apache.openoffice.sidebar:ShowAnalogClockOptionsDialog</value><br /> </prop><br /> </node><br /> </syntaxhighlight><br /> Again, the node name "AnalogClockPanel" is an arbitrary string that only has to be unique, this time among the node names for all panels, not just the ones provided by the extension.<br /> <br /> The "Id" property is a unique name that is used internally in the sidebar framework. It is not referenced from any XCU file.<br /> <br /> The "DeckId" property references the "Id" property of the deck that was defined above. Therefore it has the same value: "ToolsDeck".<br /> <br /> The value of the "ContextList" property defines when to show the panel. Its value consists of one or more lines separated by semicolons. The choice of separator string and the notation of using separate lines are conventions that increase readability. Each line can have three or four, comma separated values. This separator is hard-coded and not a convention. The values are: application name, context name, whether or not the panel is expanded by default. More on this and the optional fourth value can be found [[http://wiki.openoffice.org/wiki/Sidebar#Panels_and_Decks|here]].<br /> <br /> The "ImplementationURL" property tells the sidebar framework where to find the service that implements the panel. It has three parts: The prefix "private:resource/toolpanel" is required by the XUIElementFactory and the framework that manages these factories. The second part "AnalogClockPanelFactory" is the name of the ui element factory as defined by the "Name" property in the Factories.xcu file. The third part "AnalogClockPanel" is interpreted by the factory itself and can be freely chosen.<br /> <br /> The "OrderIndex" property defines an index that is used to sort panels that are displayed in a deck. Smaller values lead to positions higher up, larger values lead to positions further down. The standard sidebar panels start with a value of 100 and increase in steps of 100. This allows other panels to go before or in between.<br /> <br /> The value of the "WantsCanvas" property defaults to "false" and all standard panels use this default. In our case, however, we set it to "true" because we want to paint into our panel with a canvas. This property is interpreted by the sidebar framework and causes a canvas object being setup and passed to the panel factory when the panel is created. This feature is experimental but only uses standard techniques.<br /> <br /> With the "DefaultMenuCommand" property we define the command that is dispatched when the user clicks on the "More Options" button in the panel title bar. We can not define a command in the usual ".uno:<command-name>" syntax and have to resort to commands provided by a new protocol handler. Therefore the syntax of the command looks a bit unfamiliar: "org.apache.openoffice.sidebar:ShowAnalogClockOptionsDialog".<br /> <br /> =====Factories.xcu=====<br /> <br /> The panel factory is registered with this XCU snippet:<br /> <syntaxhighlight lang="XML"><br /> <node oor:name="WorkbenchPanelFactory" oor:op="replace"><br /> <prop oor:name="Type"><br /> <value>toolpanel</value><br /> </prop><br /> <prop oor:name="Name"><br /> <value>AnalogClockPanelFactory</value><br /> </prop><br /> <prop oor:name="Module"><br /> <value/><br /> </prop><br /> <prop oor:name="FactoryImplementation"><br /> <value>org.apache.openoffice.sidebar.AnalogClockPanelFactory</value><br /> </prop><br /> </node><br /> </syntaxhighlight><br /> The "Type" property has to have the "toolpanel" value.<br /> <br /> We can chose the "Name" property as we like. It just has to be identical to the middle part in the "ImplementationURL" value for the new panel.<br /> <br /> The "Module" property remains empty.<br /> <br /> The "FactoryImplementation" property defines the service name of the implementation of the panel factory. It can be chosen freely but has to be identical to what the panel factory says its service name is. This service name does not have to be an 'official' service name with a service description in offapi or, in our case, a service description provided by the extension. But an explicit service description is a good thing for a real-life extension.<br /> <br /> <br /> =====ProtocolHandler.xcu=====<br /> <br /> To define the command that opens the options dialog we have these lines:<br /> <syntaxhighlight lang="XML"><br /> <node oor:name="org.apache.openoffice.sidebar.ProtocolHandler" oor:op="replace"><br /> <prop oor:name="Protocols" oor:type="oor:string-list"><br /> <value>org.apache.openoffice.sidebar*</value><br /> </prop><br /> </node><br /> </syntaxhighlight><br /> In contrast to node names used in Sidebar.xcu this node name is used to find the protocol handler. It is the service name of our new protocol handler class.<br /> <br /> The "Protocols" property defines the command prefix that all our commands have to have.<br /> <br /> <br /> =====manifest.xml=====<br /> <br /> The manifest of the extension (the java archive has its own manifest, more on this later) looks like this:<br /> <syntaxhighlight lang="XML"><br /> <?xml version="1.0" encoding="UTF-8"?><br /> <manifest:manifest xmlns:manifest="http://openoffice.org/2001/manifest"><br /> <manifest:file-entry<br /> manifest:media-type="application/vnd.sun.star.uno-component;type=Java"<br /> manifest:full-path="AnalogClock.jar"/><br /> <manifest:file-entry<br /> manifest:media-type="application/vnd.sun.star.configuration-data"<br /> manifest:full-path="registry/data/org/openoffice/Office/UI/Factories.xcu"/><br /> <manifest:file-entry<br /> manifest:media-type="application/vnd.sun.star.configuration-data"<br /> manifest:full-path="registry/data/org/openoffice/Office/UI/Sidebar.xcu"/><br /> <manifest:file-entry<br /> manifest:media-type="application/vnd.sun.star.configuration-data"<br /> manifest:full-path="registry/ProtocolHandler.xcu" /> <br /> </manifest:manifest><br /> </syntaxhighlight><br /> It tells the extension manager that the three XCU files that we have seen above have to be merged into their global counterparts. Additionally our extension brings one JAR file that contains the actual implementation: "AnalogClock.jar".<br /> <br /> <br /> =====description.xml=====<br /> <br /> This is the description of the extension:<br /> <syntaxhighlight lang="XML"><br /> <identifier value="org.apache.openoffice.sidebar.AnalogClock" /><br /> <version value="1.0" /> <dependencies><br /> <OpenOffice.org-minimal-version value="4.0" d:name="Apache OpenOffice"/><br /> </dependencies><br /> <publisher><br /> <name xlink:href="http://www.openoffice.org" lang="en">Apache Software Foundation</name><br /> </publisher><br /> <display-name><br /> <name lang="en">Analog Clock for Sidebar</name><br /> </display-name><br /> </syntaxhighlight><br /> The "identifier" property is referenced by the "IconURL" property of our panel description in Sidebar.xcu. It is an arbitrary name that is chosen by the extension author.<br /> <br /> The "version" property tells you that this is the first version of the extension.<br /> <br /> The "OpenOffice.org-minimal-version" property in the "dependencies" section makes sure that the extension can not be installed in older versions of OpenOffice. Version 4.0 is the first one with support for the sidebar.<br /> <br /> Both the "publisher" property and the "display-name" property are used in the extension manager dialog to represent the extension.<br /> <br /> <br /> ====Classes====<br /> <br /> The largest part of the implementation is about generic extension functionality. Here is an overview of the classes in the extension:<br /> <br /> =====Component=====<br /> <br /> The Component class implements two methods that tell the extension manager what services are supported by the extension and how to create instances of them. The two services supported by this extension are the panel factory which is named, well, PanelFactory, and the protocol handler, ProtocolHandler.<br /> <br /> =====PanelFactory=====<br /> <br /> The PanelFactory class implements two interfaces.<br /> <br /> XServiceInfo: The XServiceInfo interface with its methods getImplementationname(), supportsService() and getSupportedServiceName() is a generic interface implemented by every class that implements a UNO service. Note that we use a service name without explicit service description. This may not be good form but it helps to keep the amount of generic extension code down.<br /> <br /> XUIElementFactory: This interface has only one method. The "createUIElement()" method is called indirectly by the sidebar framework to create a new panel object. This happens when the sidebar is initialized or whenever a panel becomes visible but not when it is expanded. The first of the two arguments is the resource URL that specifies which panel to create. This is more useful for factories that can create more than one type of panel. In our factory we only check that the given resource URL is really the one that it supports. The major part of the factory code is processing the second argument, a list of PropertyValues. These values are meant to be passed on to the new panel. Not every factory and not every panel need all properties. Our factory only uses two, the "ParentWindow" property and the "Canvas" property. The later one is the only property that is provided on demand. This demand is flagged by setting the "WantsCanvas" property to "true" in the panel description in Sidebar.xcu. It is the responsibility of the new panel to create a child window in the given parent window. Position and size of that window are controller by the sidebar framework. The panel only has to react to size changes.<br /> <br /> constructor: The constructor of the panel factory is called with an XComponentContext object because of the FactoryHelper that we use in Component. This context is later passed to the panel and used there to get access to a service factory.<br /> <br /> <br /> =====PanelBase=====<br /> <br /> The implementation of the actual panel is split into two classes. The base class PanelBase contains everything that other panels might also need. The other, AnalogClockPanel, is a derived class and provides the actual content of the panel.<br /> <br /> Most of the work in PanelBase takes place in its Initialize() method that is called from the AnalogClockPanel constructor. It creates a child window in the parent window that was given as "ParentWindow" property to the the panel factory.<br /> <br /> The PanelBase class implements four interfaces.<br /> <br /> XToolPanel with its Window attribute (and the getWindow() method) gives access to the panel child window. It is used by the layouter in the sidebar framework to position and size the panel. Its second method createAccessible() is the entry point for supporting the UNO accessibility API. It is really implemented in this demo, it just returns the generic accessibility implementation of VCL windows. But if the panel where a regular dialog this might already be enough.<br /> <br /> XWindowListener is implemented in order to be informed when the size of the panel window changes or when the panel is shown or hidden. In our extension all these methods result in a call to the abstract Layout() method which is implemented in AnalogClockPanel.<br /> <br /> XSidebarPanel has one method, getHeightForWidth(). In PanelBase there is a default implementation that tells the sidebar panel layouter to use the current window size and not to change it.<br /> <br /> XComponent is supported to give the owner of the panel, the sidebar framework, the opportunity to dispose the panel. In Java this is especially useful because of the missing destructors.<br /> <br /> <br /> =====AnalogClockPanel=====<br /> <br /> This is the center of the whole extension. It implements a simple analog clock that is displayed via an XCanvas object. It extends the PanelBase base class and does not implement any additional interfaces.<br /> <br /> In its constructor it sets up some frequently used variables. For the canvas these are instances of ViewState and RenderState. Additionally a timer is started that calls back two times per second. Calling back more than once per second prevents temporal aliasing where irregularities in the time can lead to one call being made very shortly after the beginning of a second and the following call is made very shortly before the end of the second. As both calls will report the same time, the clock would not be updated until the third call and therefore show the same time for almost two seconds. Two seconds don't sound like much but this would be a visible stuttering.<br /> <br /> The Layout() method that is called every time the window is resized or shown just stores the new size. The little layouting that is done for the clock face is done on every repaint.<br /> <br /> The clock is painted in the PaintCurrentTime() method. A circle represents the clock face. Three hands for hours, minutes and seconds show the current time. All very simple. The clock face and the hands are created as Java Shape objects, one Ellipse2D and three Line2D objects. These are painted in DrawShape() onto the XCanvas. Java allows us to iterate over the individual parts of the shape paths, each part being a moveto, lineto, curveto (quadratic or cubic) or closing. These are converted in appropriate canvas draw commands. Here is the snippet that process the cubic bezier parts of each curve:<br /> <syntaxhighlight lang="java"><br /> final PathIterator aPathIterator = aShape.getPathIterator(null);<br /> final double[] aCoordinates = new double[6];<br /> double nX = 0;<br /> double nY = 0;<br /> while ( ! aPathIterator.isDone())<br /> {<br /> switch (aPathIterator.currentSegment(aCoordinates))<br /> {<br /> ...<br /> case PathIterator.SEG_CUBICTO:<br /> // It looks like the canvas bezier curve definition is broken.<br /> // We have to swap the second control point and the end point of the curve.<br /> mxCanvas.drawBezier(<br /> new RealBezierSegment2D(<br /> nX,nY,<br /> aCoordinates[0], aCoordinates[1],<br /> aCoordinates[4], aCoordinates[5]),<br /> new RealPoint2D(aCoordinates[2], aCoordinates[3]),<br /> maViewState,<br /> maRenderState);<br /> nX = aCoordinates[4];<br /> nY = aCoordinates[5];<br /> break;<br /> ...<br /> }<br /> apathIterator.next();<br /> }<br /> </syntaxhighlight><br /> Note that in the constructor of RealBezierSegment2D the second bezier control point and the and point of the curve have changed places. This is a workaround for a bug in the canvas implementation.<br /> <br /> The dispose() method stops the time, to avoid callbacks to a dead.<br /> <br /> The two methods GetColor() and SetColor() allow the options dialog to change the colors of clock face and hands. More on that in the description of class AnalogClockOptionsDialog.<br /> <br /> <br /> =====UIElement=====<br /> <br /> This class implements the XUIElement interface and is just a wrapper around the panel implementation. It could be integrated into the PanelBase class but the separation hopefully makes the separate responsibilities more clear. The XUIElement interface mostly provides access to some objects like XFrame, resource URL (that is the URL given to the panel factory to create the panel) and the element type (for sidebar panels always css.ui.UIElementType.TOOLPANEL). The only interesting method is getRealInterface() which probably should better be named getRealObject() or getRealImplementation(). It allows separation of generic UIElement code and specialized panel implementation.<br /> <br /> <br /> =====AnalogClockOptionsDialog=====<br /> <br /> This dialog lets the user change the colors of clock face and all three hands at run time. It demonstrates how to provide a "MoreOptions" dialog in an extension.<br /> <br /> Because it is a new dialog there is no UNO command for it. Therefore we have to create a new command as well. But the extension framework does not allow extensions to create commands in the ".uno:<command>" syntax so we have to provide a new protocol with the ProtocolHandler. How this is done has already been explained.<br /> <br /> The dispatch() method of the ProtocolHandler calls the static AnalogClockOptionsDialog.Show() method. When the dialog is already visible it does nothing. Otherwise it creates a new dialog and shows it.<br /> <br /> The first thing the dialog does is to activate the system look and feel:<br /> <syntaxhighlight lang="java"><br /> try <br /> {<br /> UIManager.setLookAndFeel(UIManager.getSystemLookAndFeelClassName());<br /> }<br /> catch (Exception e)<br /> {<br /> e.printStackTrace();<br /> }<br /> </syntaxhighlight><br /> This makes the dialog look less 'Javaish' and more like any other dialog on the platform the extension runs on.<br /> <br /> The dialog consists of four radio buttons, a 'Close' button, and a color chooser. The radio buttons connect the color chooser with either the clock face or one of the three hands. Selecting a color in the color chooser directly changes the respective color in the running clock panel. The close button closes the dialog, as does the closer in the dialog title bar.<br /> <br /> ====Building the extension====<br /> <br /> The easiest part of the extension is the hardest part to describe. How the extension is built---compiled, creation of the jar file, creation of the oxt file---depends on the development environment you use.<br /> <br /> =====Eclipse=====<br /> <br /> The AnalogClock extension has been developed with Eclipse. It was created as standard Java project with separate directories for source and compiled files. Open the properties dialog for the new project and under Java Build Path->Libraries add references to external JARs java_uno.jar, juh.jar, jurt.jar and unoil.jar. All of them can be found in the program/classes directory of an OpenOffice installation. Alternatively search for them in an OpenOffice SDK. Under the src directory add directories icons, registry, META-INF for the non-Java files that are part of the extension.<br /> <br /> Export the project as Ant buildfile. Just click through the export dialog. This creates a file build.xml toplevel in the project. Add a second buildfile beside it, eg build2.xml:<br /> <syntaxhighlight lang="XML"><br /> <?eclipse.ant.import?><br /> <project basedir="." default="otx"><br /> <target name="jar"><br /> <jar destfile="dist/AnalogClock.jar"><br /> <fileset dir="bin" includes="**/*.class"><br /> </fileset><br /> <manifest><br /> <attribute<br /> name="RegistrationClassName"<br /> value="org.apache.openoffice.sidebar.Component"/><br /> </manifest><br /> </jar><br /> </target><br /> <target name="otx" depends="jar"><br /> <zip destfile="dist/AnalogClock.oxt"><br /> <zipfileset dir="src" includes="META-INF/manifest.xml"/><br /> <zipfileset dir="dist" includes="AnalogClock.jar"/><br /> <zipfileset dir="src" includes="description.xml"/><br /> <zipfileset dir="src" includes="registry/**"/><br /> <zipfileset dir="src" includes="icons/tools-large.png"/><br /> </zip><br /> </target><br /> </project><br /> </syntaxhighlight><br /> It has two targets. The "jar" target creates the jar file that creates all the compiled .class files under bin/. It also create a manifest file that registers the Component class as "RegistrationClassName". This is how the extension manager knows which class implements the __writeRegistryServiceInfo() and __getServiceFactory() functions.<br /> <br /> The "otx" target depends on the "jar" target. It creates the AnalogClock.oxt file in another top level directory dist/ and adds the various files that make up the extension: the manifest.xml, the jar archive, the description.xml, all xcu files under registry/ and the icon in icons/ that is used in the tab bar of the sidebar for the new deck.<br /> <br /> Export the Ant buildfile a second time, again just click through the dialog. This will automatically add a reference of the second ant file to the first.<br /> <br /> To save a few clicks you can make the Ant view always visible (menu Window->Show View, select Ant). In the view click on the "Add Buildfiles". In the dialog that pops up, expand the entry for your project file and select build.xml. Click OK and the Ant view will show an entry for the otx target. Double click it and the jar and oxt files are built. Remember that on Eclipse you don't have to compile Java code. That is done automatically in the background when you save a Java file.<br /> <br /> The extension is added to OpenOffice like any other extension. Tools->Extension Manager opens the extension manager dialog. Click the add button, regardless of wether the extension is already registered or not. Navigate to the dist/ directory under the project path of the extension project. Click on Open and finish the installation of the extension. Restart OpenOffice. You should see a new button for the new deck. Click on that button and the analog clock should appear.<br /> <br /> Errors during the installation of the extension are hard to find because the extension manager seldomly presents meaningful error messages and debugging at this stage is not possible. Therefore the full source code still contains a simple Log class that is used to write some diagnostic messages and stack traces to file. This may help to pinpoint errors at this stage. If you want to use it, just set its static msLogFilename variable to a valid file name.<br /> <br /> ==Resources==<br /> <br /> * UX<br /> **[[AOO_UX_Design_Exploration_-_Task_Pane_Content_-_Information_Design|UX design exploration]]<br /> **[[AOO_UX_Design_Exploration_-_Docked_Task_Pane_Container_-_Pane_Header_User_Interface_Design|Pane Header UI Design]]<br /> **[[AOO_UX_Design_Exploration_-_Task_Pane_Content_Panel_-_User_Interface_Design_Proposals|UX Design propoals]]<br /> * Symphony<br /> ** Assessment of the [[AOO_Symphony_UX_Migration/Merge_Analysis_-_Task_Pane|migrating the Symphony sidebar]].<br /> ** Older proposal to use the [[Sidebar_Proposal_by_IBM|Symphony sidebar]].<br /> * AOO<br /> ** Overview of an existing but unfinished attempt of implementing [[Framework/Article/Tool_Panels_Internals|tool panels]].<br /> ** Introduction to [[Framework/Article/Tool Panels|writing tool panels]].<br /> ** Description of the [[Drawing framework|drawing framework]], that is used by the Impress tool panel.<br /> <br /> [[Category:Development]]</div>

Od https://wiki.openoffice.org/w/index.php?title=Writer/Input_Fields&diff=232198 Writer/Input Fields 2013-11-11T10:11:38Z

<p>Od: </p> <hr /> <div>{{Writer Project|Category=Writer/Effort}}<br /> __NOTOC__<br /> <br /> = In-place editing of Input Fields =<br /> <br /> Purpose of this page is provide information on the solution for {{Bug|33737}}. This information should serve the corresponding quality assurance efforts. It can be also used as the source to document the corresponding changes for the users.<br /> <br /> <br /> <br /> == Input Fields - three of a kind ==<br /> We have three fields which are all named 'Input Field' in the user interface, but each has a different purpose.<br /><br /> These are '''Text Input Fields''', '''User Variable Input Fields''' and '''Simple Variable Input Fields'''.<br /><br /> Currently no changes are made for '''Simple Variable Input Fields''' for solving {{Bug|33737}}.<br /> <br /> <br /> ==== Text Input Field ====<br /> This is a field to prompt the user for an input. The field has a description and its content holds the user's input.<br /> <br /> In the OpenDocument file format (ODF) such a field is represented by ODF element <text:text-input>.<br /> <br /> When importing Microsoft Word documents (binary file format, *.doc) Microsoft Word fields FILLIN and FORMTEXT are imported as Text Input Fields.<br /> <br /> The user interface to create such a field is found in the Fields dialog (Menu - Insert - Fields - Others) on pane Functions. Here the user has to choose Type 'Input Field'.<br /> [[Image:Dialog-text-input.png|500px|center|dialog to create Text Input Field]]<br /> <br /> <br /> ==== User Variable Input Field ====<br /> This is a field to prompt the user to set the value of a user variable. The value of a user variable is the same throughout the complete document.<br /> <br /> In ODF such a field is represented by ODF element <text:user-field-input>.<br /> <br /> Microsoft Word has support for so-called Document Variables. The value of such variables can be shown in a Microsoft Word document, but are created/deleted/set via Microsoft Word macro (aka Visual Basic). These Document Variables seem to be comparable with ODF's User Variables, but currently there is no mapping between these in OpenOffice.<br /> A User Variable Input Field is treated as Text Input Field when exporting an OpenOffice text document to the Microsoft Word binary format.<br /> <br /> The user interface to create such a field is found in the Fields dialog on pane Variables. In advance the user has to create a user field. Then the user has to choose Type 'Input Field' and has to select the corresponding created user variable.<br /> [[Image:Dialog-user-field-input.png|1000px|center|dialog to create User Variable and a corresponding User Variable Text Input Field]]<br /> <br /> <br /> ==== Simple Variable Input Field ====<br /> This is a field to prompt the user to set the value of a simple variable. The value of a simple variable at a certain document position equals the value of the last set value - that is the difference to a user variable.<br /> <br /> In ODF such a field is represented by ODF element <text:variable-input>.<br /> <br /> For the Microsoft Word binary file format import/export filter these Simple Variable Input Fields are mapped to Microsoft Word ASK fields.<br /> <br /> The user interface to create such a field is found in the Fields dialog on pane Variables. In advance the user has to create a simple variable. Then the user has to choose Type 'Input Field' and has to select the corresponding created simple variable.<br /> [[Image:Dialog-variable-input.png|1000px|center|dialog to create Simple Variable and a corresponding Simple Variable Text Input Field]]<br /> <br /> <br /> <br /> == Changes in detail ==<br /> In the following the changes being in progress to solve {{Bug|33737}} are given in detail. Currently the changes will only affect '''Text Input Fields''' and '''User Variable Input Fields'''. Thus, the following use of term <nowiki>Input Field</nowiki> denotes these two types of Input Fields.<br /> <br /> ==== Edit content of Input Fields ====<br /> To modify/provide the content of an Input Field it is possible to directly perform the corresponding edit operations inside the document's text area. No additional popup dialog is needed.<br /><br /> As an Input Field can only contain text content most insertion operations are not allowed while the cursor is inside an Input Field. Also pasting operations and drop operations are not allowed. Pasting unformatted text (e.g. on Windows via SHIFT-CTRL-ALT-V) shall be possible.<br /> <br /> ==== Enter/Leaving Input Fields ====<br /> To enable the user to enter respectively leave an Input Field special hidden characters are inserted for the cursor traveling. Thus, the cursor can be positioned before an Input Field and text can be inserted before the Input Field. After a cursor move to the right the Input Field is entered and text at the beginning of the Input Field can be inserted. Similar cursor traveling is possible at the end of the Input Field. The cursor can be placed right behind an Input Field and text can be inserted behind the Input Field. After a cursor move to the left the Input Field is entered and text at the end of the Input Field can be inserted.<br /> <br /> Entering and Leaving an Input Field will be indicated to the user by drawing a bounding rectangle around the Input Field when the cursor is inside the Input Field.<br /><br /> [[Image:InputField-cursor-inside-and-outside.png|1000px|center|screen shots showing cursor right before an Input Field and inside an Input Field]]<br /> <br /> Clicking with the mouse pointer into an Input Field will in general select its text content in order to enable the user to directly replace the Input Field's content.<br /> <br /> ==== Traveling between Input Fields ====<br /> Traveling from one Input Field to the next respectively previous one with the keyboard is possible via TAB-Key respectively via SHIFT-TAB-Key. When traveling the complete content of the Input Field is selected.<br /><br /> <br /> To insert a TAB character inside an Input Field using the keyboard the CTRL-TAB-Key have to be used.<br /> <br /> ==== Selection of Input Fields ====<br /> Any text selection inside an Input Fields is possible. When text outside an Input Field is part of a text selection only the complete Input Field can be added to the text selection. Thus, it is not possible to select a part of an Input Field's text content and other text content in one selection.<br /> <br /> ==== No Field Names for Input Fields ====<br /> Field Names are no longer shown for Input Fields. Via Menu - View - Field Names the Field Names of all fields could be displayed instead of the fields content. This will no longer work for Input Fields due to the in-place editing.<br /> <br /> ==== Microsoft Word binary filter (WW8 filter) ====<br /> In general Input Fields will be exported as Microsoft Word FORMTEXT fields.<br /><br /> Exceptions are imported Microsoft Word FILLIN fields - these will be exported as Microsoft Word FILLIN fields unless the Input Field's help text or tooltip text is filled.<br /> <br /> ==== Documents in read-only mode ====<br /> In-place editing of Input Fields is allowed when the document is in read-only mode. This is the same behavior as for text frames or sections for whose option to be editable in read-only mode has been set.<br /><br /> Also the field shadings for Input Fields are visible when the document is in read-only mode.<br /> <br /> <br /> == Areas which need high attention during testing ==<br /> * Only text content shall be inserted into Input Fields.<br /> * No formatting shall be possible inside Input Fields.<br /> * Applying a formatting while the cursor is inside an Input Field shall be applied to the complete Input Field.<br /> * No other attributes, like a hyperlink, a ruby, a page break or a column break, shall be possible inside Input Fields.<br /> * Default Formatting while the cursor is inside an Input Field.<br /> * The insertion of a 'New Paragraph' character or the key input of the ENTER-Key shall result into an insertion of a line break inside an Input Field.<br /> * Undo/Redo actions regarding Input Fields.<br /> * Functionality of other fields shall not be affected.<br /> * Applying formatting or other attributes to text content.<br /> * All of the above areas when having a multi-selection.<br /> * Save and Load of documents containing Input Fields.<br /> * Exchange of documents containing Input Fields in ODF with previous OpenOffice versions.<br /> * Exchange of documents containing Input Fields in Microsoft Word binary file format with Microsoft Word.<br /> * HTML export and import of text documents containing Input Fields - assure no change to previous versions.</div>

Od https://wiki.openoffice.org/w/index.php?title=File:InputField-cursor-inside-and-outside.png&diff=232197 File:InputField-cursor-inside-and-outside.png 2013-11-11T10:08:43Z

<p>Od: Screen shots showing the cursor right before an Input Field and inside an Input Field</p> <hr /> <div>Screen shots showing the cursor right before an Input Field and inside an Input Field</div>

Od https://wiki.openoffice.org/w/index.php?title=Writer/Input_Fields&diff=232188 Writer/Input Fields 2013-11-08T11:00:52Z

<p>Od: /* Documents in read-only mode */</p> <hr /> <div>{{Writer Project|Category=Writer/Effort}}<br /> __NOTOC__<br /> <br /> = In-place editing of Input Fields =<br /> <br /> Purpose of this page is provide information on the solution for {{Bug|33737}}. This information should serve the corresponding quality assurance efforts. It can be also used as the source to document the corresponding changes for the users.<br /> <br /> <br /> <br /> == Input Fields - three of a kind ==<br /> We have three fields which are all named 'Input Field' in the user interface, but each has a different purpose.<br /><br /> These are '''Text Input Fields''', '''User Variable Input Fields''' and '''Simple Variable Input Fields'''.<br /><br /> Currently no changes are made for '''Simple Variable Input Fields''' for solving {{Bug|33737}}.<br /> <br /> <br /> ==== Text Input Field ====<br /> This is a field to prompt the user for an input. The field has a description and its content holds the user's input.<br /> <br /> In the OpenDocument file format (ODF) such a field is represented by ODF element <text:text-input>.<br /> <br /> When importing Microsoft Word documents (binary file format, *.doc) Microsoft Word fields FILLIN and FORMTEXT are imported as Text Input Fields.<br /> <br /> The user interface to create such a field is found in the Fields dialog (Menu - Insert - Fields - Others) on pane Functions. Here the user has to choose Type 'Input Field'.<br /> [[Image:Dialog-text-input.png|500px|center|dialog to create Text Input Field]]<br /> <br /> <br /> ==== User Variable Input Field ====<br /> This is a field to prompt the user to set the value of a user variable. The value of a user variable is the same throughout the complete document.<br /> <br /> In ODF such a field is represented by ODF element <text:user-field-input>.<br /> <br /> Microsoft Word has support for so-called Document Variables. The value of such variables can be shown in a Microsoft Word document, but are created/deleted/set via Microsoft Word macro (aka Visual Basic). These Document Variables seem to be comparable with ODF's User Variables, but currently there is no mapping between these in OpenOffice.<br /> A User Variable Input Field is treated as Text Input Field when exporting an OpenOffice text document to the Microsoft Word binary format.<br /> <br /> The user interface to create such a field is found in the Fields dialog on pane Variables. In advance the user has to create a user field. Then the user has to choose Type 'Input Field' and has to select the corresponding created user variable.<br /> [[Image:Dialog-user-field-input.png|1000px|center|dialog to create User Variable and a corresponding User Variable Text Input Field]]<br /> <br /> <br /> ==== Simple Variable Input Field ====<br /> This is a field to prompt the user to set the value of a simple variable. The value of a simple variable at a certain document position equals the value of the last set value - that is the difference to a user variable.<br /> <br /> In ODF such a field is represented by ODF element <text:variable-input>.<br /> <br /> For the Microsoft Word binary file format import/export filter these Simple Variable Input Fields are mapped to Microsoft Word ASK fields.<br /> <br /> The user interface to create such a field is found in the Fields dialog on pane Variables. In advance the user has to create a simple variable. Then the user has to choose Type 'Input Field' and has to select the corresponding created simple variable.<br /> [[Image:Dialog-variable-input.png|1000px|center|dialog to create Simple Variable and a corresponding Simple Variable Text Input Field]]<br /> <br /> <br /> <br /> == Changes in detail ==<br /> In the following the changes being in progress to solve {{Bug|33737}} are given in detail. Currently the changes will only affect '''Text Input Fields''' and '''User Variable Input Fields'''. Thus, the following use of term <nowiki>Input Field</nowiki> denotes these two types of Input Fields.<br /> <br /> ==== Edit content of Input Fields ====<br /> To modify/provide the content of an Input Field it is possible to directly perform the corresponding edit operations inside the document's text area. No additional popup dialog is needed.<br /><br /> As an Input Field can only contain text content most insertion operations are not allowed while the cursor is inside an Input Field. Also pasting operations and drop operations are not allowed. Pasting unformatted text (e.g. on Windows via SHIFT-CTRL-ALT-V) shall be possible.<br /> <br /> ==== Enter/Leaving Input Fields ====<br /> To enable the user to enter respectively leave an Input Field special hidden characters are inserted for the cursor traveling. Thus, the cursor can be positioned before an Input Field and text can be inserted before the Input Field. After a cursor move to the right the Input Field is entered and text at the beginning of the Input Field can be inserted. Similar cursor traveling is possible at the end of the Input Field. The cursor can be placed right behind an Input Field and text can be inserted behind the Input Field. After a cursor move to the left the Input Field is entered and text at the end of the Input Field can be inserted.<br /><br /> TODO: provide screen shots<br /> <br /> Entering and Leaving an Input Field will be indicated to the user by drawing a bounding rectangle around the Input Field when the cursor is inside the Input Field.<br /><br /> TODO: provide screen shots<br /> <br /> Clicking with the mouse pointer into an Input Field will in general select its text content in order to enable the user to directly replace the Input Field's content.<br /> <br /> ==== Traveling between Input Fields ====<br /> Traveling from one Input Field to the next respectively previous one with the keyboard is possible via TAB-Key respectively via SHIFT-TAB-Key. When traveling the complete content of the Input Field is selected.<br /><br /> <br /> To insert a TAB character inside an Input Field using the keyboard the CTRL-TAB-Key have to be used.<br /> <br /> ==== Selection of Input Fields ====<br /> Any text selection inside an Input Fields is possible. When text outside an Input Field is part of a text selection only the complete Input Field can be added to the text selection. Thus, it is not possible to select a part of an Input Field's text content and other text content in one selection.<br /> <br /> ==== No Field Names for Input Fields ====<br /> Field Names are no longer shown for Input Fields. Via Menu - View - Field Names the Field Names of all fields could be displayed instead of the fields content. This will no longer work for Input Fields due to the in-place editing.<br /> <br /> ==== Microsoft Word binary filter (WW8 filter) ====<br /> In general Input Fields will be exported as Microsoft Word FORMTEXT fields.<br /><br /> Exceptions are imported Microsoft Word FILLIN fields - these will be exported as Microsoft Word FILLIN fields unless the Input Field's help text or tooltip text is filled.<br /> <br /> ==== Documents in read-only mode ====<br /> In-place editing of Input Fields is allowed when the document is in read-only mode. This is the same behavior as for text frames or sections for whose option to be editable in read-only mode has been set.<br /><br /> Also the field shadings for Input Fields are visible when the document is in read-only mode.<br /> <br /> ==== [more changes ?] ====<br /> <br /> == Areas which need high attention during testing ==<br /> * Only text content shall be inserted into Input Fields.<br /> * No formatting shall be possible inside Input Fields.<br /> * Applying a formatting while the cursor is inside an Input Field shall be applied to the complete Input Field.<br /> * No other attributes, like a hyperlink, a ruby, a page break or a column break, shall be possible inside Input Fields.<br /> * Default Formatting while the cursor is inside an Input Field.<br /> * The insertion of a 'New Paragraph' character or the key input of the ENTER-Key shall result into an insertion of a line break inside an Input Field.<br /> * Undo/Redo actions regarding Input Fields.<br /> * Functionality of other fields shall not be affected.<br /> * Applying formatting or other attributes to text content.<br /> * All of the above areas when having a multi-selection.<br /> * Save and Load of documents containing Input Fields.<br /> * Exchange of documents containing Input Fields in ODF with previous OpenOffice versions.<br /> * Exchange of documents containing Input Fields in Microsoft Word binary file format with Microsoft Word.<br /> * HTML export and import of text documents containing Input Fields - assure no change to previous versions.<br /> * [more areas?]</div>

Od https://wiki.openoffice.org/w/index.php?title=Writer/Input_Fields&diff=232182 Writer/Input Fields 2013-11-07T17:17:28Z

<p>Od: /* Areas which need high attention during testing */</p> <hr /> <div>{{Writer Project|Category=Writer/Effort}}<br /> __NOTOC__<br /> <br /> = In-place editing of Input Fields =<br /> <br /> Purpose of this page is provide information on the solution for {{Bug|33737}}. This information should serve the corresponding quality assurance efforts. It can be also used as the source to document the corresponding changes for the users.<br /> <br /> <br /> <br /> == Input Fields - three of a kind ==<br /> We have three fields which are all named 'Input Field' in the user interface, but each has a different purpose.<br /><br /> These are '''Text Input Fields''', '''User Variable Input Fields''' and '''Simple Variable Input Fields'''.<br /><br /> Currently no changes are made for '''Simple Variable Input Fields''' for solving {{Bug|33737}}.<br /> <br /> <br /> ==== Text Input Field ====<br /> This is a field to prompt the user for an input. The field has a description and its content holds the user's input.<br /> <br /> In the OpenDocument file format (ODF) such a field is represented by ODF element <text:text-input>.<br /> <br /> When importing Microsoft Word documents (binary file format, *.doc) Microsoft Word fields FILLIN and FORMTEXT are imported as Text Input Fields.<br /> <br /> The user interface to create such a field is found in the Fields dialog (Menu - Insert - Fields - Others) on pane Functions. Here the user has to choose Type 'Input Field'.<br /> [[Image:Dialog-text-input.png|500px|center|dialog to create Text Input Field]]<br /> <br /> <br /> ==== User Variable Input Field ====<br /> This is a field to prompt the user to set the value of a user variable. The value of a user variable is the same throughout the complete document.<br /> <br /> In ODF such a field is represented by ODF element <text:user-field-input>.<br /> <br /> Microsoft Word has support for so-called Document Variables. The value of such variables can be shown in a Microsoft Word document, but are created/deleted/set via Microsoft Word macro (aka Visual Basic). These Document Variables seem to be comparable with ODF's User Variables, but currently there is no mapping between these in OpenOffice.<br /> A User Variable Input Field is treated as Text Input Field when exporting an OpenOffice text document to the Microsoft Word binary format.<br /> <br /> The user interface to create such a field is found in the Fields dialog on pane Variables. In advance the user has to create a user field. Then the user has to choose Type 'Input Field' and has to select the corresponding created user variable.<br /> [[Image:Dialog-user-field-input.png|1000px|center|dialog to create User Variable and a corresponding User Variable Text Input Field]]<br /> <br /> <br /> ==== Simple Variable Input Field ====<br /> This is a field to prompt the user to set the value of a simple variable. The value of a simple variable at a certain document position equals the value of the last set value - that is the difference to a user variable.<br /> <br /> In ODF such a field is represented by ODF element <text:variable-input>.<br /> <br /> For the Microsoft Word binary file format import/export filter these Simple Variable Input Fields are mapped to Microsoft Word ASK fields.<br /> <br /> The user interface to create such a field is found in the Fields dialog on pane Variables. In advance the user has to create a simple variable. Then the user has to choose Type 'Input Field' and has to select the corresponding created simple variable.<br /> [[Image:Dialog-variable-input.png|1000px|center|dialog to create Simple Variable and a corresponding Simple Variable Text Input Field]]<br /> <br /> <br /> <br /> == Changes in detail ==<br /> In the following the changes being in progress to solve {{Bug|33737}} are given in detail. Currently the changes will only affect '''Text Input Fields''' and '''User Variable Input Fields'''. Thus, the following use of term <nowiki>Input Field</nowiki> denotes these two types of Input Fields.<br /> <br /> ==== Edit content of Input Fields ====<br /> To modify/provide the content of an Input Field it is possible to directly perform the corresponding edit operations inside the document's text area. No additional popup dialog is needed.<br /><br /> As an Input Field can only contain text content most insertion operations are not allowed while the cursor is inside an Input Field. Also pasting operations and drop operations are not allowed. Pasting unformatted text (e.g. on Windows via SHIFT-CTRL-ALT-V) shall be possible.<br /> <br /> ==== Enter/Leaving Input Fields ====<br /> To enable the user to enter respectively leave an Input Field special hidden characters are inserted for the cursor traveling. Thus, the cursor can be positioned before an Input Field and text can be inserted before the Input Field. After a cursor move to the right the Input Field is entered and text at the beginning of the Input Field can be inserted. Similar cursor traveling is possible at the end of the Input Field. The cursor can be placed right behind an Input Field and text can be inserted behind the Input Field. After a cursor move to the left the Input Field is entered and text at the end of the Input Field can be inserted.<br /><br /> TODO: provide screen shots<br /> <br /> Entering and Leaving an Input Field will be indicated to the user by drawing a bounding rectangle around the Input Field when the cursor is inside the Input Field.<br /><br /> TODO: provide screen shots<br /> <br /> Clicking with the mouse pointer into an Input Field will in general select its text content in order to enable the user to directly replace the Input Field's content.<br /> <br /> ==== Traveling between Input Fields ====<br /> Traveling from one Input Field to the next respectively previous one with the keyboard is possible via TAB-Key respectively via SHIFT-TAB-Key. When traveling the complete content of the Input Field is selected.<br /><br /> <br /> To insert a TAB character inside an Input Field using the keyboard the CTRL-TAB-Key have to be used.<br /> <br /> ==== Selection of Input Fields ====<br /> Any text selection inside an Input Fields is possible. When text outside an Input Field is part of a text selection only the complete Input Field can be added to the text selection. Thus, it is not possible to select a part of an Input Field's text content and other text content in one selection.<br /> <br /> ==== No Field Names for Input Fields ====<br /> Field Names are no longer shown for Input Fields. Via Menu - View - Field Names the Field Names of all fields could be displayed instead of the fields content. This will no longer work for Input Fields due to the in-place editing.<br /> <br /> ==== Microsoft Word binary filter (WW8 filter) ====<br /> In general Input Fields will be exported as Microsoft Word FORMTEXT fields.<br /><br /> Exceptions are imported Microsoft Word FILLIN fields - these will be exported as Microsoft Word FILLIN fields unless the Input Field's help text or tooltip text is filled.<br /> <br /> ==== Documents in read-only mode ====<br /> Allow in-place editing of Input Fields when the document is in read-only mode. This is the same behavior as for text frames or sections for whose option to be editable in read-only mode has been set.<br /> <br /> ==== [more changes ?] ====<br /> <br /> == Areas which need high attention during testing ==<br /> * Only text content shall be inserted into Input Fields.<br /> * No formatting shall be possible inside Input Fields.<br /> * Applying a formatting while the cursor is inside an Input Field shall be applied to the complete Input Field.<br /> * No other attributes, like a hyperlink, a ruby, a page break or a column break, shall be possible inside Input Fields.<br /> * Default Formatting while the cursor is inside an Input Field.<br /> * The insertion of a 'New Paragraph' character or the key input of the ENTER-Key shall result into an insertion of a line break inside an Input Field.<br /> * Undo/Redo actions regarding Input Fields.<br /> * Functionality of other fields shall not be affected.<br /> * Applying formatting or other attributes to text content.<br /> * All of the above areas when having a multi-selection.<br /> * Save and Load of documents containing Input Fields.<br /> * Exchange of documents containing Input Fields in ODF with previous OpenOffice versions.<br /> * Exchange of documents containing Input Fields in Microsoft Word binary file format with Microsoft Word.<br /> * HTML export and import of text documents containing Input Fields - assure no change to previous versions.<br /> * [more areas?]</div>

Od https://wiki.openoffice.org/w/index.php?title=BUGZILLA/FAQ&diff=232181 BUGZILLA/FAQ 2013-11-07T12:18:58Z

<p>Od: /* Meaning of bracketed pseudo key words in the summary */</p> <hr /> <div>This page lists several FAQ how to use the [https://issues.apache.org/ooo/ AOO-BUGZILLA]<br /> <br /> == Attachments and Sample Documents ==<br /> <br /> === What are good Sample Documents? ===<br /> Providing a sample document usually helps to reproduce a problem and to test the fix.<br /> Sample documents should be minimal, e.g. if you notice a bug in the upper left corner on page 345 of a 1000 page document then it is advisable to check whether the bug can still be replicated if the other pages are removed. Removing as much content that does not impact the reproducibility of the bug helps everyone who wants to work on that bug report.<br /> <br /> === How to use attached sample documents for multiple Bug Reports ===<br /> If an appropriate document to reproduce the problem or to show the problem (screenshot) already does exist in Bugzilla, please [https://wiki.documentfoundation.org/QA/Bugzilla/FAQ#How_to_use_attached_sample_documents_for_multiple_Bug_Reports cite the document instead of attaching it again]. That saves time, because other users, who might know the existing attachment, do not need to check whether the new attachment contains new information (and only looks similar) or simply is a clone.<br /> <br /> == Bug Summary ==<br /> Be as concise as possible in the bug Summary. The more specific a bug summary is the more useful it is for others such as when you report a new bug you will notice that bugzilla tries to find similar bugs that might be of interest. So instead of having a summary "Bug in Writer!!!" please be more specific and write e.g. "Writer prints green text underlines as blue on a Windows GDI printer".<br /> <br /> === Meaning of bracketed branch names in the summary ===<br /> Development often happens in [https://en.wikipedia.org/wiki/Branching_%28revision_control%29 code branches]. Development branches are usually very interesting because they contain important new features or major cleanups. But code in branches is mostly not yet ready for general consumptions and needs to be extensively tested before it can be integrated. When such branches are tested the bugs found are very valuable for everyone working on that branch but of little value for the general public. So if a problem occurs only on a development branch then please use the bracketed branch name in the bug summary to make things as clear as possible. Examples of such tags used were e.g. [sidebar], [ia2], [aw080], etc. If the integration of a code branch into the mainline has introduced problems then adding the branch tag also makes very much sense.<br /> <br /> === Meaning of bracketed pseudo key words in the summary ===<br /> In order to make bug summaries as concise as possible experienced bug reporters used pseudo tags directly in the summary. They are often obsolete nowadays because some bugzilla fields are better suited for marking the kind of bug.<br /> <br /> Examples for pseudo tags that were used are:<br /> * '''[Regression]''' Deprecated tag for AOO regression issues. The "regression" keyword should be added to the '''Keywords''' field instead.<br /> * '''[RFE]''' deprecated for ''Request For Enhancement''. Set the '''Issue Type''' selector to ENHANCEMENT instead.<br /> * '''[WW8]''' Bug related to WW8 import filter (WW8 denotes the Microsoft Word binary file format - [http://msdn.microsoft.com/en-us/library/cc313153%28v=office.12%29.aspx specification found here])<br /> <br /> == Bug STATUS ==<br /> <br /> === CONFIRMED ===<br /> ==== Should I report new bugs with initial Status CONFIRMED? ====<br /> The CONFIRMED status means that the bug report is clear enough and has sufficient details for another person to replicate the bug on another system.<br /> So the answer is generally '''no'''! Even if you are pretty sure that you found a real bug and added lots of relevant information, generally following the [http://en.wikipedia.org/wiki/Two-man_rule#Other_uses Two Men Rule] results in better reports, what leads to faster bug fixing costing less developer resources. But of course, if you are an experienced bug tester (relevant contribution in more than 100 bugs or similar qualification), you might find good reasons to ignore the Two Men Rule and to select initial Status CONFIRMED<br /> <br /> ==== When should I change Status from UNCONFIRMED to CONFIRMED? ==== <br /> Please do not change to CONFIRMED only because you were able to reproduce reporter's observations. The right moment for CONFIRMED is when [http://www.openoffice.org/qa/issue_handling/basic_rules.html#complete all relevant information] has been gained. <br /> # Report is a [[QA/HowToFileIssue#Principles|Good Bug Report]]<br /> ## Check for duplicates has been proceeded?<br /> ## Summary is clear and specific enough to distinguish the reported bug from other similar ones<br /> ## Sample Document available? Even if it seems to be simple for QA staff to create own sample documents, it saves a lot of time if a sample is attached. and Additionally the sample document can contribute additional relevant information (Localization, Language, Formatting caused by repoerter's very special ''New Document Templates'', ...<br /> # Other selectors with correct contents?<br /> ## Relation to Operating System checked?<br /> ## Most early OO Version with what the bug has been observed selected (if possible, do your own tests with older versions)<br /> ## Appropriate Importance?<br /> ## Keywords appropriate?<br /> # All or at least most relevant aspects of the bug are listed in the report<br /> <br /> If these conditions are fulfilled you should select CONFIRMED. But of course, it's a matter of consideration, an important CRASH-Regression should be taken by developers as soon as possible, here it would be inappropriate to leave Status UNCONFIRMED because some minor questions are without answer.<br /> <br /> == Mixed ==<br /> === From where can I download latest test versions? ===<br /> You can test latest bug fixes with unstable test builds from [http://ci.apache.org/projects/openoffice/index.html here].<br /> <br /> === How To Crash AOO ===<br /> For some investigations it is necessary to provoke a crash. You can find possibilities how to crash AOO with this [https://issues.apache.org/ooo/buglist.cgi?bug_status=CONFIRMED&bug_status=ACCEPTED&bug_status=REOPENED&f1=days_elapsed&list_id=79579&longdesc=crash&longdesc_type=allwordssubstr&o1=lessthan&query_format=advanced&resolution=---&short_desc=crash&short_desc_type=allwordssubstr&v1=100 Bugzilla query], what shows current crash-bugs.<br /> <br /> === What is the appropriate ''Version'' in Bugzilla Version selector? ===<br /> The most early AOO or OOo version with what the problem has been observed. For ''Regression'' bugs ''Version'' information will help developers to find the code change what causes the problem.<br /> <br /> In August 2013 the syntax for '''AOO''' versions in the selector has been changed, the ''AOO'' prefix has been dropped for most AOO versions. For historical reasons (?)[https://issues.apache.org/ooo/report.cgi?x_axis_field=product&y_axis_field=component&z_axis_field=&no_redirect=1&query_format=report-table&short_desc_type=allwordssubstr&short_desc=&longdesc_type=allwordssubstr&longdesc=&bug_file_loc_type=allwordssubstr&bug_file_loc=&keywords_type=allwords&keywords=&bug_id=&bug_id_type=anyexact&votes=&votes_type=greaterthaneq&version=AOO340-dev&version=AOO400-dev&version=AOO410-dev&version=AOO+3.4.0&version=AOO+3.4.1&version=AOO+4.0&version=AOO+4.0.0&emailtype1=substring&email1=&emailtype2=substring&email2=&emailtype3=substring&email3=&chfieldvalue=&chfieldfrom=&chfieldto=Now&j_top=AND&f1=noop&o1=noop&v1=&format=table&action=wrap some Versions] with AOO prefix remained. If you work on such a bug report please always think about switching to a "modern" version.<br /> <br /> === How to connect a Bug report to a Tracking Bug ===<br /> If you want to add a Bug report (like [https://issues.apache.org/ooo/show_bug.cgi?id=122762 Bug 122762]) to a TASK Tracking Bug (like [https://issues.apache.org/ooo/show_bug.cgi?id=122364 Tracking Bug 122364]), the best way is <br /> # Add Bug number to ''Depends on'' field in TASK Tracking Bug<br /> # [https://issues.apache.org/ooo/show_bug.cgi?id=122364#c3 Cite] complete Heading line of "Depends-On-Bug" in a ''Comment'' in the TASK Tracking Bug. <br /> :: So all interested users listed in CC of TASK Tracking Bug will get a summary of the new bug with mail from bugzilla@apache.org and can see immediately what the reported problem is - no need for a detour to the tracking Bug (and several clicks).<br /> <br /> === How to attach screenshots with additional graphic contents ===<br /> If you want to add some graphic contents to a screenshot to make it more comprehensible, you should copy the clipboard contents with the screenshot to a new DRAW document and add emphasis, text ideas, callouts, pointer arrows or whatever in the Draw document. If you save it with 'File -> Properties -> Security - open File Readonly' before aou attach it in the Bug, the document is protected against unintended edits, but can be edited if appropriate by other users.<br /> <br /> === What is the best file type for screenshots? ===<br /> Graphic formats with lossless compression like "PNG" are much more suitable than JPG, because no compression artifacts compound recognition of details.<br /> <br /> <br /> [[Category:Quality Assurance]]</div>

Od https://wiki.openoffice.org/w/index.php?title=Writer/Input_Fields&diff=232179 Writer/Input Fields 2013-11-07T12:02:13Z

<p>Od: /* Areas which need high attention during testing */</p> <hr /> <div>{{Writer Project|Category=Writer/Effort}}<br /> __NOTOC__<br /> <br /> = In-place editing of Input Fields =<br /> <br /> Purpose of this page is provide information on the solution for {{Bug|33737}}. This information should serve the corresponding quality assurance efforts. It can be also used as the source to document the corresponding changes for the users.<br /> <br /> <br /> <br /> == Input Fields - three of a kind ==<br /> We have three fields which are all named 'Input Field' in the user interface, but each has a different purpose.<br /><br /> These are '''Text Input Fields''', '''User Variable Input Fields''' and '''Simple Variable Input Fields'''.<br /><br /> Currently no changes are made for '''Simple Variable Input Fields''' for solving {{Bug|33737}}.<br /> <br /> <br /> ==== Text Input Field ====<br /> This is a field to prompt the user for an input. The field has a description and its content holds the user's input.<br /> <br /> In the OpenDocument file format (ODF) such a field is represented by ODF element <text:text-input>.<br /> <br /> When importing Microsoft Word documents (binary file format, *.doc) Microsoft Word fields FILLIN and FORMTEXT are imported as Text Input Fields.<br /> <br /> The user interface to create such a field is found in the Fields dialog (Menu - Insert - Fields - Others) on pane Functions. Here the user has to choose Type 'Input Field'.<br /> [[Image:Dialog-text-input.png|500px|center|dialog to create Text Input Field]]<br /> <br /> <br /> ==== User Variable Input Field ====<br /> This is a field to prompt the user to set the value of a user variable. The value of a user variable is the same throughout the complete document.<br /> <br /> In ODF such a field is represented by ODF element <text:user-field-input>.<br /> <br /> Microsoft Word has support for so-called Document Variables. The value of such variables can be shown in a Microsoft Word document, but are created/deleted/set via Microsoft Word macro (aka Visual Basic). These Document Variables seem to be comparable with ODF's User Variables, but currently there is no mapping between these in OpenOffice.<br /> A User Variable Input Field is treated as Text Input Field when exporting an OpenOffice text document to the Microsoft Word binary format.<br /> <br /> The user interface to create such a field is found in the Fields dialog on pane Variables. In advance the user has to create a user field. Then the user has to choose Type 'Input Field' and has to select the corresponding created user variable.<br /> [[Image:Dialog-user-field-input.png|1000px|center|dialog to create User Variable and a corresponding User Variable Text Input Field]]<br /> <br /> <br /> ==== Simple Variable Input Field ====<br /> This is a field to prompt the user to set the value of a simple variable. The value of a simple variable at a certain document position equals the value of the last set value - that is the difference to a user variable.<br /> <br /> In ODF such a field is represented by ODF element <text:variable-input>.<br /> <br /> For the Microsoft Word binary file format import/export filter these Simple Variable Input Fields are mapped to Microsoft Word ASK fields.<br /> <br /> The user interface to create such a field is found in the Fields dialog on pane Variables. In advance the user has to create a simple variable. Then the user has to choose Type 'Input Field' and has to select the corresponding created simple variable.<br /> [[Image:Dialog-variable-input.png|1000px|center|dialog to create Simple Variable and a corresponding Simple Variable Text Input Field]]<br /> <br /> <br /> <br /> == Changes in detail ==<br /> In the following the changes being in progress to solve {{Bug|33737}} are given in detail. Currently the changes will only affect '''Text Input Fields''' and '''User Variable Input Fields'''. Thus, the following use of term <nowiki>Input Field</nowiki> denotes these two types of Input Fields.<br /> <br /> ==== Edit content of Input Fields ====<br /> To modify/provide the content of an Input Field it is possible to directly perform the corresponding edit operations inside the document's text area. No additional popup dialog is needed.<br /><br /> As an Input Field can only contain text content most insertion operations are not allowed while the cursor is inside an Input Field. Also pasting operations and drop operations are not allowed. Pasting unformatted text (e.g. on Windows via SHIFT-CTRL-ALT-V) shall be possible.<br /> <br /> ==== Enter/Leaving Input Fields ====<br /> To enable the user to enter respectively leave an Input Field special hidden characters are inserted for the cursor traveling. Thus, the cursor can be positioned before an Input Field and text can be inserted before the Input Field. After a cursor move to the right the Input Field is entered and text at the beginning of the Input Field can be inserted. Similar cursor traveling is possible at the end of the Input Field. The cursor can be placed right behind an Input Field and text can be inserted behind the Input Field. After a cursor move to the left the Input Field is entered and text at the end of the Input Field can be inserted.<br /><br /> TODO: provide screen shots<br /> <br /> Entering and Leaving an Input Field will be indicated to the user by drawing a bounding rectangle around the Input Field when the cursor is inside the Input Field.<br /><br /> TODO: provide screen shots<br /> <br /> Clicking with the mouse pointer into an Input Field will in general select its text content in order to enable the user to directly replace the Input Field's content.<br /> <br /> ==== Traveling between Input Fields ====<br /> Traveling from one Input Field to the next respectively previous one with the keyboard is possible via TAB-Key respectively via SHIFT-TAB-Key. When traveling the complete content of the Input Field is selected.<br /><br /> <br /> To insert a TAB character inside an Input Field using the keyboard the CTRL-TAB-Key have to be used.<br /> <br /> ==== Selection of Input Fields ====<br /> Any text selection inside an Input Fields is possible. When text outside an Input Field is part of a text selection only the complete Input Field can be added to the text selection. Thus, it is not possible to select a part of an Input Field's text content and other text content in one selection.<br /> <br /> ==== No Field Names for Input Fields ====<br /> Field Names are no longer shown for Input Fields. Via Menu - View - Field Names the Field Names of all fields could be displayed instead of the fields content. This will no longer work for Input Fields due to the in-place editing.<br /> <br /> ==== Microsoft Word binary filter (WW8 filter) ====<br /> In general Input Fields will be exported as Microsoft Word FORMTEXT fields.<br /><br /> Exceptions are imported Microsoft Word FILLIN fields - these will be exported as Microsoft Word FILLIN fields unless the Input Field's help text or tooltip text is filled.<br /> <br /> ==== Documents in read-only mode ====<br /> Allow in-place editing of Input Fields when the document is in read-only mode. This is the same behavior as for text frames or sections for whose option to be editable in read-only mode has been set.<br /> <br /> ==== [more changes ?] ====<br /> <br /> == Areas which need high attention during testing ==<br /> * Only text content shall be inserted into Input Fields.<br /> * No formatting shall be possible inside Input Fields.<br /> * Applying a formatting while the cursor is inside an Input Field shall be applied to the complete Input Field.<br /> * No other attributes, like a hyperlink, a ruby, a page break or a column break, shall be possible inside Input Fields.<br /> * The insertion of a 'New Paragraph' character or the key input of the ENTER-Key shall result into an insertion of a line break inside an Input Field.<br /> * Undo/Redo actions regarding Input Fields.<br /> * Functionality of other fields shall not be affected.<br /> * Applying formatting or other attributes to text content.<br /> * All of the above areas when having a multi-selection.<br /> * Save and Load of documents containing Input Fields.<br /> * Exchange of documents containing Input Fields in ODF with previous OpenOffice versions.<br /> * Exchange of documents containing Input Fields in Microsoft Word binary file format with Microsoft Word.<br /> * HTML export and import of text documents containing Input Fields - assure no change to previous versions.<br /> * [more areas?]</div>

Od https://wiki.openoffice.org/w/index.php?title=Writer/Input_Fields&diff=232178 Writer/Input Fields 2013-11-07T12:00:19Z

<p>Od: /* Areas which need high attention during testing */</p> <hr /> <div>{{Writer Project|Category=Writer/Effort}}<br /> __NOTOC__<br /> <br /> = In-place editing of Input Fields =<br /> <br /> Purpose of this page is provide information on the solution for {{Bug|33737}}. This information should serve the corresponding quality assurance efforts. It can be also used as the source to document the corresponding changes for the users.<br /> <br /> <br /> <br /> == Input Fields - three of a kind ==<br /> We have three fields which are all named 'Input Field' in the user interface, but each has a different purpose.<br /><br /> These are '''Text Input Fields''', '''User Variable Input Fields''' and '''Simple Variable Input Fields'''.<br /><br /> Currently no changes are made for '''Simple Variable Input Fields''' for solving {{Bug|33737}}.<br /> <br /> <br /> ==== Text Input Field ====<br /> This is a field to prompt the user for an input. The field has a description and its content holds the user's input.<br /> <br /> In the OpenDocument file format (ODF) such a field is represented by ODF element <text:text-input>.<br /> <br /> When importing Microsoft Word documents (binary file format, *.doc) Microsoft Word fields FILLIN and FORMTEXT are imported as Text Input Fields.<br /> <br /> The user interface to create such a field is found in the Fields dialog (Menu - Insert - Fields - Others) on pane Functions. Here the user has to choose Type 'Input Field'.<br /> [[Image:Dialog-text-input.png|500px|center|dialog to create Text Input Field]]<br /> <br /> <br /> ==== User Variable Input Field ====<br /> This is a field to prompt the user to set the value of a user variable. The value of a user variable is the same throughout the complete document.<br /> <br /> In ODF such a field is represented by ODF element <text:user-field-input>.<br /> <br /> Microsoft Word has support for so-called Document Variables. The value of such variables can be shown in a Microsoft Word document, but are created/deleted/set via Microsoft Word macro (aka Visual Basic). These Document Variables seem to be comparable with ODF's User Variables, but currently there is no mapping between these in OpenOffice.<br /> A User Variable Input Field is treated as Text Input Field when exporting an OpenOffice text document to the Microsoft Word binary format.<br /> <br /> The user interface to create such a field is found in the Fields dialog on pane Variables. In advance the user has to create a user field. Then the user has to choose Type 'Input Field' and has to select the corresponding created user variable.<br /> [[Image:Dialog-user-field-input.png|1000px|center|dialog to create User Variable and a corresponding User Variable Text Input Field]]<br /> <br /> <br /> ==== Simple Variable Input Field ====<br /> This is a field to prompt the user to set the value of a simple variable. The value of a simple variable at a certain document position equals the value of the last set value - that is the difference to a user variable.<br /> <br /> In ODF such a field is represented by ODF element <text:variable-input>.<br /> <br /> For the Microsoft Word binary file format import/export filter these Simple Variable Input Fields are mapped to Microsoft Word ASK fields.<br /> <br /> The user interface to create such a field is found in the Fields dialog on pane Variables. In advance the user has to create a simple variable. Then the user has to choose Type 'Input Field' and has to select the corresponding created simple variable.<br /> [[Image:Dialog-variable-input.png|1000px|center|dialog to create Simple Variable and a corresponding Simple Variable Text Input Field]]<br /> <br /> <br /> <br /> == Changes in detail ==<br /> In the following the changes being in progress to solve {{Bug|33737}} are given in detail. Currently the changes will only affect '''Text Input Fields''' and '''User Variable Input Fields'''. Thus, the following use of term <nowiki>Input Field</nowiki> denotes these two types of Input Fields.<br /> <br /> ==== Edit content of Input Fields ====<br /> To modify/provide the content of an Input Field it is possible to directly perform the corresponding edit operations inside the document's text area. No additional popup dialog is needed.<br /><br /> As an Input Field can only contain text content most insertion operations are not allowed while the cursor is inside an Input Field. Also pasting operations and drop operations are not allowed. Pasting unformatted text (e.g. on Windows via SHIFT-CTRL-ALT-V) shall be possible.<br /> <br /> ==== Enter/Leaving Input Fields ====<br /> To enable the user to enter respectively leave an Input Field special hidden characters are inserted for the cursor traveling. Thus, the cursor can be positioned before an Input Field and text can be inserted before the Input Field. After a cursor move to the right the Input Field is entered and text at the beginning of the Input Field can be inserted. Similar cursor traveling is possible at the end of the Input Field. The cursor can be placed right behind an Input Field and text can be inserted behind the Input Field. After a cursor move to the left the Input Field is entered and text at the end of the Input Field can be inserted.<br /><br /> TODO: provide screen shots<br /> <br /> Entering and Leaving an Input Field will be indicated to the user by drawing a bounding rectangle around the Input Field when the cursor is inside the Input Field.<br /><br /> TODO: provide screen shots<br /> <br /> Clicking with the mouse pointer into an Input Field will in general select its text content in order to enable the user to directly replace the Input Field's content.<br /> <br /> ==== Traveling between Input Fields ====<br /> Traveling from one Input Field to the next respectively previous one with the keyboard is possible via TAB-Key respectively via SHIFT-TAB-Key. When traveling the complete content of the Input Field is selected.<br /><br /> <br /> To insert a TAB character inside an Input Field using the keyboard the CTRL-TAB-Key have to be used.<br /> <br /> ==== Selection of Input Fields ====<br /> Any text selection inside an Input Fields is possible. When text outside an Input Field is part of a text selection only the complete Input Field can be added to the text selection. Thus, it is not possible to select a part of an Input Field's text content and other text content in one selection.<br /> <br /> ==== No Field Names for Input Fields ====<br /> Field Names are no longer shown for Input Fields. Via Menu - View - Field Names the Field Names of all fields could be displayed instead of the fields content. This will no longer work for Input Fields due to the in-place editing.<br /> <br /> ==== Microsoft Word binary filter (WW8 filter) ====<br /> In general Input Fields will be exported as Microsoft Word FORMTEXT fields.<br /><br /> Exceptions are imported Microsoft Word FILLIN fields - these will be exported as Microsoft Word FILLIN fields unless the Input Field's help text or tooltip text is filled.<br /> <br /> ==== Documents in read-only mode ====<br /> Allow in-place editing of Input Fields when the document is in read-only mode. This is the same behavior as for text frames or sections for whose option to be editable in read-only mode has been set.<br /> <br /> ==== [more changes ?] ====<br /> <br /> == Areas which need high attention during testing ==<br /> * Only text content shall be inserted into Input Fields.<br /> * No formatting shall be possible inside Input Fields.<br /> * Applying a formatting while the cursor is inside an Input Field shall be applied to the complete Input Field.<br /> * No other attributes, like a hyperlink, a ruby, a page break or a column break, shall be possible inside Input Fields.<br /> * The insertion of a 'New Paragraph' character or the key input of the ENTER-Key shall result into an insertion of a line break inside an Input Field.<br /> * Undo/Redo actions regarding Input Fields.<br /> * Functionality of other fields shall not be affected.<br /> * Applying formatting or other attributes to text content.<br /> * Save and Load of documents containing Input Fields.<br /> * Exchange of documents containing Input Fields in ODF with previous OpenOffice versions.<br /> * Exchange of documents containing Input Fields in Microsoft Word binary file format with Microsoft Word.<br /> * HTML export and import of text documents containing Input Fields - assure no change to previous versions.<br /> * [more areas?]</div>

Od https://wiki.openoffice.org/w/index.php?title=Writer/Input_Fields&diff=232176 Writer/Input Fields 2013-11-07T11:59:43Z

<p>Od: /* Documents in read-only mode */</p> <hr /> <div>{{Writer Project|Category=Writer/Effort}}<br /> __NOTOC__<br /> <br /> = In-place editing of Input Fields =<br /> <br /> Purpose of this page is provide information on the solution for {{Bug|33737}}. This information should serve the corresponding quality assurance efforts. It can be also used as the source to document the corresponding changes for the users.<br /> <br /> <br /> <br /> == Input Fields - three of a kind ==<br /> We have three fields which are all named 'Input Field' in the user interface, but each has a different purpose.<br /><br /> These are '''Text Input Fields''', '''User Variable Input Fields''' and '''Simple Variable Input Fields'''.<br /><br /> Currently no changes are made for '''Simple Variable Input Fields''' for solving {{Bug|33737}}.<br /> <br /> <br /> ==== Text Input Field ====<br /> This is a field to prompt the user for an input. The field has a description and its content holds the user's input.<br /> <br /> In the OpenDocument file format (ODF) such a field is represented by ODF element <text:text-input>.<br /> <br /> When importing Microsoft Word documents (binary file format, *.doc) Microsoft Word fields FILLIN and FORMTEXT are imported as Text Input Fields.<br /> <br /> The user interface to create such a field is found in the Fields dialog (Menu - Insert - Fields - Others) on pane Functions. Here the user has to choose Type 'Input Field'.<br /> [[Image:Dialog-text-input.png|500px|center|dialog to create Text Input Field]]<br /> <br /> <br /> ==== User Variable Input Field ====<br /> This is a field to prompt the user to set the value of a user variable. The value of a user variable is the same throughout the complete document.<br /> <br /> In ODF such a field is represented by ODF element <text:user-field-input>.<br /> <br /> Microsoft Word has support for so-called Document Variables. The value of such variables can be shown in a Microsoft Word document, but are created/deleted/set via Microsoft Word macro (aka Visual Basic). These Document Variables seem to be comparable with ODF's User Variables, but currently there is no mapping between these in OpenOffice.<br /> A User Variable Input Field is treated as Text Input Field when exporting an OpenOffice text document to the Microsoft Word binary format.<br /> <br /> The user interface to create such a field is found in the Fields dialog on pane Variables. In advance the user has to create a user field. Then the user has to choose Type 'Input Field' and has to select the corresponding created user variable.<br /> [[Image:Dialog-user-field-input.png|1000px|center|dialog to create User Variable and a corresponding User Variable Text Input Field]]<br /> <br /> <br /> ==== Simple Variable Input Field ====<br /> This is a field to prompt the user to set the value of a simple variable. The value of a simple variable at a certain document position equals the value of the last set value - that is the difference to a user variable.<br /> <br /> In ODF such a field is represented by ODF element <text:variable-input>.<br /> <br /> For the Microsoft Word binary file format import/export filter these Simple Variable Input Fields are mapped to Microsoft Word ASK fields.<br /> <br /> The user interface to create such a field is found in the Fields dialog on pane Variables. In advance the user has to create a simple variable. Then the user has to choose Type 'Input Field' and has to select the corresponding created simple variable.<br /> [[Image:Dialog-variable-input.png|1000px|center|dialog to create Simple Variable and a corresponding Simple Variable Text Input Field]]<br /> <br /> <br /> <br /> == Changes in detail ==<br /> In the following the changes being in progress to solve {{Bug|33737}} are given in detail. Currently the changes will only affect '''Text Input Fields''' and '''User Variable Input Fields'''. Thus, the following use of term <nowiki>Input Field</nowiki> denotes these two types of Input Fields.<br /> <br /> ==== Edit content of Input Fields ====<br /> To modify/provide the content of an Input Field it is possible to directly perform the corresponding edit operations inside the document's text area. No additional popup dialog is needed.<br /><br /> As an Input Field can only contain text content most insertion operations are not allowed while the cursor is inside an Input Field. Also pasting operations and drop operations are not allowed. Pasting unformatted text (e.g. on Windows via SHIFT-CTRL-ALT-V) shall be possible.<br /> <br /> ==== Enter/Leaving Input Fields ====<br /> To enable the user to enter respectively leave an Input Field special hidden characters are inserted for the cursor traveling. Thus, the cursor can be positioned before an Input Field and text can be inserted before the Input Field. After a cursor move to the right the Input Field is entered and text at the beginning of the Input Field can be inserted. Similar cursor traveling is possible at the end of the Input Field. The cursor can be placed right behind an Input Field and text can be inserted behind the Input Field. After a cursor move to the left the Input Field is entered and text at the end of the Input Field can be inserted.<br /><br /> TODO: provide screen shots<br /> <br /> Entering and Leaving an Input Field will be indicated to the user by drawing a bounding rectangle around the Input Field when the cursor is inside the Input Field.<br /><br /> TODO: provide screen shots<br /> <br /> Clicking with the mouse pointer into an Input Field will in general select its text content in order to enable the user to directly replace the Input Field's content.<br /> <br /> ==== Traveling between Input Fields ====<br /> Traveling from one Input Field to the next respectively previous one with the keyboard is possible via TAB-Key respectively via SHIFT-TAB-Key. When traveling the complete content of the Input Field is selected.<br /><br /> <br /> To insert a TAB character inside an Input Field using the keyboard the CTRL-TAB-Key have to be used.<br /> <br /> ==== Selection of Input Fields ====<br /> Any text selection inside an Input Fields is possible. When text outside an Input Field is part of a text selection only the complete Input Field can be added to the text selection. Thus, it is not possible to select a part of an Input Field's text content and other text content in one selection.<br /> <br /> ==== No Field Names for Input Fields ====<br /> Field Names are no longer shown for Input Fields. Via Menu - View - Field Names the Field Names of all fields could be displayed instead of the fields content. This will no longer work for Input Fields due to the in-place editing.<br /> <br /> ==== Microsoft Word binary filter (WW8 filter) ====<br /> In general Input Fields will be exported as Microsoft Word FORMTEXT fields.<br /><br /> Exceptions are imported Microsoft Word FILLIN fields - these will be exported as Microsoft Word FILLIN fields unless the Input Field's help text or tooltip text is filled.<br /> <br /> ==== Documents in read-only mode ====<br /> Allow in-place editing of Input Fields when the document is in read-only mode. This is the same behavior as for text frames or sections for whose option to be editable in read-only mode has been set.<br /> <br /> ==== [more changes ?] ====<br /> <br /> == Areas which need high attention during testing ==<br /> * Only text content shall be inserted into Input Fields.<br /> * No formatting shall be possible inside Input Fields.<br /> * Applying a formatting while the cursor is inside an Input Field shall be applied to the complete Input Field.<br /> * No other attributes, like a hyperlink, a ruby, a page break or a column break, shall be possible inside Input Fields.<br /> * The insertion of a 'New Paragraph' character or the key input of the ENTER-Key shall result into an insertion of a line break inside an Input Field.<br /> * Undo/Redo actions regarding Input Fields.<br /> * Functionality of other fields shall not be affected.<br /> * Applying formatting or other attributes to text content.<br /> * Save and Load of documents containing Input Fields.<br /> * Exchange of documents containing Input Fields in ODF with previous OpenOffice versions.<br /> * Exchange of documents containing Input Fields in Microsoft Word binary file format with Microsoft Word.<br /> * HTML export and import of text documents containing Input Fields - assure no change to previous versions.<br /> * <big><big>NOT COMPLETE - MORE ITEMS WILL FOLLOW.</big></big></div>

Od https://wiki.openoffice.org/w/index.php?title=Writer/Input_Fields&diff=232175 Writer/Input Fields 2013-11-07T11:57:41Z

<p>Od: /* Changes in detail */</p> <hr /> <div>{{Writer Project|Category=Writer/Effort}}<br /> __NOTOC__<br /> <br /> = In-place editing of Input Fields =<br /> <br /> Purpose of this page is provide information on the solution for {{Bug|33737}}. This information should serve the corresponding quality assurance efforts. It can be also used as the source to document the corresponding changes for the users.<br /> <br /> <br /> <br /> == Input Fields - three of a kind ==<br /> We have three fields which are all named 'Input Field' in the user interface, but each has a different purpose.<br /><br /> These are '''Text Input Fields''', '''User Variable Input Fields''' and '''Simple Variable Input Fields'''.<br /><br /> Currently no changes are made for '''Simple Variable Input Fields''' for solving {{Bug|33737}}.<br /> <br /> <br /> ==== Text Input Field ====<br /> This is a field to prompt the user for an input. The field has a description and its content holds the user's input.<br /> <br /> In the OpenDocument file format (ODF) such a field is represented by ODF element <text:text-input>.<br /> <br /> When importing Microsoft Word documents (binary file format, *.doc) Microsoft Word fields FILLIN and FORMTEXT are imported as Text Input Fields.<br /> <br /> The user interface to create such a field is found in the Fields dialog (Menu - Insert - Fields - Others) on pane Functions. Here the user has to choose Type 'Input Field'.<br /> [[Image:Dialog-text-input.png|500px|center|dialog to create Text Input Field]]<br /> <br /> <br /> ==== User Variable Input Field ====<br /> This is a field to prompt the user to set the value of a user variable. The value of a user variable is the same throughout the complete document.<br /> <br /> In ODF such a field is represented by ODF element <text:user-field-input>.<br /> <br /> Microsoft Word has support for so-called Document Variables. The value of such variables can be shown in a Microsoft Word document, but are created/deleted/set via Microsoft Word macro (aka Visual Basic). These Document Variables seem to be comparable with ODF's User Variables, but currently there is no mapping between these in OpenOffice.<br /> A User Variable Input Field is treated as Text Input Field when exporting an OpenOffice text document to the Microsoft Word binary format.<br /> <br /> The user interface to create such a field is found in the Fields dialog on pane Variables. In advance the user has to create a user field. Then the user has to choose Type 'Input Field' and has to select the corresponding created user variable.<br /> [[Image:Dialog-user-field-input.png|1000px|center|dialog to create User Variable and a corresponding User Variable Text Input Field]]<br /> <br /> <br /> ==== Simple Variable Input Field ====<br /> This is a field to prompt the user to set the value of a simple variable. The value of a simple variable at a certain document position equals the value of the last set value - that is the difference to a user variable.<br /> <br /> In ODF such a field is represented by ODF element <text:variable-input>.<br /> <br /> For the Microsoft Word binary file format import/export filter these Simple Variable Input Fields are mapped to Microsoft Word ASK fields.<br /> <br /> The user interface to create such a field is found in the Fields dialog on pane Variables. In advance the user has to create a simple variable. Then the user has to choose Type 'Input Field' and has to select the corresponding created simple variable.<br /> [[Image:Dialog-variable-input.png|1000px|center|dialog to create Simple Variable and a corresponding Simple Variable Text Input Field]]<br /> <br /> <br /> <br /> == Changes in detail ==<br /> In the following the changes being in progress to solve {{Bug|33737}} are given in detail. Currently the changes will only affect '''Text Input Fields''' and '''User Variable Input Fields'''. Thus, the following use of term <nowiki>Input Field</nowiki> denotes these two types of Input Fields.<br /> <br /> ==== Edit content of Input Fields ====<br /> To modify/provide the content of an Input Field it is possible to directly perform the corresponding edit operations inside the document's text area. No additional popup dialog is needed.<br /><br /> As an Input Field can only contain text content most insertion operations are not allowed while the cursor is inside an Input Field. Also pasting operations and drop operations are not allowed. Pasting unformatted text (e.g. on Windows via SHIFT-CTRL-ALT-V) shall be possible.<br /> <br /> ==== Enter/Leaving Input Fields ====<br /> To enable the user to enter respectively leave an Input Field special hidden characters are inserted for the cursor traveling. Thus, the cursor can be positioned before an Input Field and text can be inserted before the Input Field. After a cursor move to the right the Input Field is entered and text at the beginning of the Input Field can be inserted. Similar cursor traveling is possible at the end of the Input Field. The cursor can be placed right behind an Input Field and text can be inserted behind the Input Field. After a cursor move to the left the Input Field is entered and text at the end of the Input Field can be inserted.<br /><br /> TODO: provide screen shots<br /> <br /> Entering and Leaving an Input Field will be indicated to the user by drawing a bounding rectangle around the Input Field when the cursor is inside the Input Field.<br /><br /> TODO: provide screen shots<br /> <br /> Clicking with the mouse pointer into an Input Field will in general select its text content in order to enable the user to directly replace the Input Field's content.<br /> <br /> ==== Traveling between Input Fields ====<br /> Traveling from one Input Field to the next respectively previous one with the keyboard is possible via TAB-Key respectively via SHIFT-TAB-Key. When traveling the complete content of the Input Field is selected.<br /><br /> <br /> To insert a TAB character inside an Input Field using the keyboard the CTRL-TAB-Key have to be used.<br /> <br /> ==== Selection of Input Fields ====<br /> Any text selection inside an Input Fields is possible. When text outside an Input Field is part of a text selection only the complete Input Field can be added to the text selection. Thus, it is not possible to select a part of an Input Field's text content and other text content in one selection.<br /> <br /> ==== No Field Names for Input Fields ====<br /> Field Names are no longer shown for Input Fields. Via Menu - View - Field Names the Field Names of all fields could be displayed instead of the fields content. This will no longer work for Input Fields due to the in-place editing.<br /> <br /> ==== Microsoft Word binary filter (WW8 filter) ====<br /> In general Input Fields will be exported as Microsoft Word FORMTEXT fields.<br /><br /> Exceptions are imported Microsoft Word FILLIN fields - these will be exported as Microsoft Word FILLIN fields unless the Input Field's help text or tooltip text is filled.<br /> <br /> ==== Documents in read-only mode ====<br /> Allow in-place editing of Input Fields when the document is in read-only mode. This is the same behavior as for text frames or sections for whose option to be editable in read-only mode has been set.<br /> <br /> <big><big>NOT COMPLETE - DOCUMENTATION OF MORE CHANGES WILL FOLLOW.</big></big><br /> <br /> == Areas which need high attention during testing ==<br /> * Only text content shall be inserted into Input Fields.<br /> * No formatting shall be possible inside Input Fields.<br /> * Applying a formatting while the cursor is inside an Input Field shall be applied to the complete Input Field.<br /> * No other attributes, like a hyperlink, a ruby, a page break or a column break, shall be possible inside Input Fields.<br /> * The insertion of a 'New Paragraph' character or the key input of the ENTER-Key shall result into an insertion of a line break inside an Input Field.<br /> * Undo/Redo actions regarding Input Fields.<br /> * Functionality of other fields shall not be affected.<br /> * Applying formatting or other attributes to text content.<br /> * Save and Load of documents containing Input Fields.<br /> * Exchange of documents containing Input Fields in ODF with previous OpenOffice versions.<br /> * Exchange of documents containing Input Fields in Microsoft Word binary file format with Microsoft Word.<br /> * HTML export and import of text documents containing Input Fields - assure no change to previous versions.<br /> * <big><big>NOT COMPLETE - MORE ITEMS WILL FOLLOW.</big></big></div>

Od https://wiki.openoffice.org/w/index.php?title=Writer/Input_Fields&diff=232169 Writer/Input Fields 2013-11-07T08:42:19Z

<p>Od: </p> <hr /> <div>{{Writer Project|Category=Writer/Effort}}<br /> __NOTOC__<br /> <br /> = In-place editing of Input Fields =<br /> <br /> Purpose of this page is provide information on the solution for {{Bug|33737}}. This information should serve the corresponding quality assurance efforts. It can be also used as the source to document the corresponding changes for the users.<br /> <br /> <br /> <br /> == Input Fields - three of a kind ==<br /> We have three fields which are all named 'Input Field' in the user interface, but each has a different purpose.<br /><br /> These are '''Text Input Fields''', '''User Variable Input Fields''' and '''Simple Variable Input Fields'''.<br /><br /> Currently no changes are made for '''Simple Variable Input Fields''' for solving {{Bug|33737}}.<br /> <br /> <br /> ==== Text Input Field ====<br /> This is a field to prompt the user for an input. The field has a description and its content holds the user's input.<br /> <br /> In the OpenDocument file format (ODF) such a field is represented by ODF element <text:text-input>.<br /> <br /> When importing Microsoft Word documents (binary file format, *.doc) Microsoft Word fields FILLIN and FORMTEXT are imported as Text Input Fields.<br /> <br /> The user interface to create such a field is found in the Fields dialog (Menu - Insert - Fields - Others) on pane Functions. Here the user has to choose Type 'Input Field'.<br /> [[Image:Dialog-text-input.png|500px|center|dialog to create Text Input Field]]<br /> <br /> <br /> ==== User Variable Input Field ====<br /> This is a field to prompt the user to set the value of a user variable. The value of a user variable is the same throughout the complete document.<br /> <br /> In ODF such a field is represented by ODF element <text:user-field-input>.<br /> <br /> Microsoft Word has support for so-called Document Variables. The value of such variables can be shown in a Microsoft Word document, but are created/deleted/set via Microsoft Word macro (aka Visual Basic). These Document Variables seem to be comparable with ODF's User Variables, but currently there is no mapping between these in OpenOffice.<br /> A User Variable Input Field is treated as Text Input Field when exporting an OpenOffice text document to the Microsoft Word binary format.<br /> <br /> The user interface to create such a field is found in the Fields dialog on pane Variables. In advance the user has to create a user field. Then the user has to choose Type 'Input Field' and has to select the corresponding created user variable.<br /> [[Image:Dialog-user-field-input.png|1000px|center|dialog to create User Variable and a corresponding User Variable Text Input Field]]<br /> <br /> <br /> ==== Simple Variable Input Field ====<br /> This is a field to prompt the user to set the value of a simple variable. The value of a simple variable at a certain document position equals the value of the last set value - that is the difference to a user variable.<br /> <br /> In ODF such a field is represented by ODF element <text:variable-input>.<br /> <br /> For the Microsoft Word binary file format import/export filter these Simple Variable Input Fields are mapped to Microsoft Word ASK fields.<br /> <br /> The user interface to create such a field is found in the Fields dialog on pane Variables. In advance the user has to create a simple variable. Then the user has to choose Type 'Input Field' and has to select the corresponding created simple variable.<br /> [[Image:Dialog-variable-input.png|1000px|center|dialog to create Simple Variable and a corresponding Simple Variable Text Input Field]]<br /> <br /> <br /> <br /> == Changes in detail ==<br /> In the following the changes being in progress to solve {{Bug|33737}} are given in detail. Currently the changes will only affect '''Text Input Fields''' and '''User Variable Input Fields'''. Thus, the following use of term <nowiki>Input Field</nowiki> denotes these two types of Input Fields.<br /> <br /> ==== Edit content of Input Fields ====<br /> To modify/provide the content of an Input Field it is possible to directly perform the corresponding edit operations inside the document's text area. No additional popup dialog is needed.<br /><br /> As an Input Field can only contain text content most insertion operations are not allowed while the cursor is inside an Input Field. Also pasting operations and drop operations are not allowed. Pasting unformatted text (e.g. on Windows via SHIFT-CTRL-ALT-V) shall be possible.<br /> <br /> ==== Enter/Leaving Input Fields ====<br /> To enable the user to enter respectively leave an Input Field special hidden characters are inserted for the cursor traveling. Thus, the cursor can be positioned before an Input Field and text can be inserted before the Input Field. After a cursor move to the right the Input Field is entered and text at the beginning of the Input Field can be inserted. Similar cursor traveling is possible at the end of the Input Field. The cursor can be placed right behind an Input Field and text can be inserted behind the Input Field. After a cursor move to the left the Input Field is entered and text at the end of the Input Field can be inserted.<br /><br /> TODO: provide screen shots<br /> <br /> Entering and Leaving an Input Field will be indicated to the user by drawing a bounding rectangle around the Input Field when the cursor is inside the Input Field.<br /><br /> TODO: provide screen shots<br /> <br /> Clicking with the mouse pointer into an Input Field will in general select its text content in order to enable the user to directly replace the Input Field's content.<br /> <br /> ==== Traveling between Input Fields ====<br /> Traveling from one Input Field to the next respectively previous one with the keyboard is possible via TAB-Key respectively via SHIFT-TAB-Key. When traveling the complete content of the Input Field is selected.<br /><br /> <br /> To insert a TAB character inside an Input Field using the keyboard the CTRL-TAB-Key have to be used.<br /> <br /> ==== Selection of Input Fields ====<br /> Any text selection inside an Input Fields is possible. When text outside an Input Field is part of a text selection only the complete Input Field can be added to the text selection. Thus, it is not possible to select a part of an Input Field's text content and other text content in one selection.<br /> <br /> ==== No Field Names for Input Fields ====<br /> Field Names are no longer shown for Input Fields. Via Menu - View - Field Names the Field Names of all fields could be displayed instead of the fields content. This will no longer work for Input Fields due to the in-place editing.<br /> <br /> ==== Microsoft Word binary filter (WW8 filter) ====<br /> In general Input Fields will be exported as Microsoft Word FORMTEXT fields.<br /><br /> Exceptions are imported Microsoft Word FILLIN fields - these will be exported as Microsoft Word FILLIN fields unless the Input Field's help text or tooltip text is filled.<br /> <br /> ==== Editable Input Fields in read-only mode ====<br /> Allow in-place editing of Input Fields in read-only mode<br /> <br /> <big><big>NOT COMPLETE - DOCUMENTATION OF MORE CHANGES WILL FOLLOW.</big></big><br /> <br /> == Areas which need high attention during testing ==<br /> * Only text content shall be inserted into Input Fields.<br /> * No formatting shall be possible inside Input Fields.<br /> * Applying a formatting while the cursor is inside an Input Field shall be applied to the complete Input Field.<br /> * No other attributes, like a hyperlink, a ruby, a page break or a column break, shall be possible inside Input Fields.<br /> * The insertion of a 'New Paragraph' character or the key input of the ENTER-Key shall result into an insertion of a line break inside an Input Field.<br /> * Undo/Redo actions regarding Input Fields.<br /> * Functionality of other fields shall not be affected.<br /> * Applying formatting or other attributes to text content.<br /> * Save and Load of documents containing Input Fields.<br /> * Exchange of documents containing Input Fields in ODF with previous OpenOffice versions.<br /> * Exchange of documents containing Input Fields in Microsoft Word binary file format with Microsoft Word.<br /> * HTML export and import of text documents containing Input Fields - assure no change to previous versions.<br /> * <big><big>NOT COMPLETE - MORE ITEMS WILL FOLLOW.</big></big></div>

Od https://wiki.openoffice.org/w/index.php?title=Writer/Input_Fields&diff=232166 Writer/Input Fields 2013-11-07T08:12:10Z

<p>Od: /* Areas which need high attention during testing */</p> <hr /> <div>{{Writer Project|Category=Writer/Effort}}<br /> __NOTOC__<br /> <br /> = In-place editing of Input Fields =<br /> <br /> Purpose of this page is provide information on the solution for {{Bug|33737}}. This information should serve the corresponding quality assurance efforts. It can be also used as the source to document the corresponding changes for the users.<br /> <br /> <br /> <br /> == Input Fields - three of a kind ==<br /> We have three fields which are all named 'Input Field' in the user interface, but each has a different purpose.<br /><br /> These are '''Text Input Fields''', '''User Variable Input Fields''' and '''Simple Variable Input Fields'''.<br /><br /> Currently no changes are made for '''Simple Variable Input Fields''' for solving {{Bug|33737}}.<br /> <br /> <br /> ==== Text Input Field ====<br /> This is a field to prompt the user for an input. The field has a description and its content holds the user's input.<br /> <br /> In the OpenDocument file format (ODF) such a field is represented by ODF element <text:text-input>.<br /> <br /> When importing Microsoft Word documents (binary file format, *.doc) Microsoft Word fields FILLIN and FORMTEXT are imported as Text Input Fields.<br /> <br /> The user interface to create such a field is found in the Fields dialog (Menu - Insert - Fields - Others) on pane Functions. Here the user has to choose Type 'Input Field'.<br /> [[Image:Dialog-text-input.png|500px|center|dialog to create Text Input Field]]<br /> <br /> <br /> ==== User Variable Input Field ====<br /> This is a field to prompt the user to set the value of a user variable. The value of a user variable is the same throughout the complete document.<br /> <br /> In ODF such a field is represented by ODF element <text:user-field-input>.<br /> <br /> Microsoft Word has support for so-called Document Variables. The value of such variables can be shown in a Microsoft Word document, but are created/deleted/set via Microsoft Word macro (aka Visual Basic). These Document Variables seem to be comparable with ODF's User Variables, but currently there is no mapping between these in OpenOffice.<br /> A User Variable Input Field is treated as Text Input Field when exporting an OpenOffice text document to the Microsoft Word binary format.<br /> <br /> The user interface to create such a field is found in the Fields dialog on pane Variables. In advance the user has to create a user field. Then the user has to choose Type 'Input Field' and has to select the corresponding created user variable.<br /> [[Image:Dialog-user-field-input.png|1000px|center|dialog to create User Variable and a corresponding User Variable Text Input Field]]<br /> <br /> <br /> ==== Simple Variable Input Field ====<br /> This is a field to prompt the user to set the value of a simple variable. The value of a simple variable at a certain document position equals the value of the last set value - that is the difference to a user variable.<br /> <br /> In ODF such a field is represented by ODF element <text:variable-input>.<br /> <br /> For the Microsoft Word binary file format import/export filter these Simple Variable Input Fields are mapped to Microsoft Word ASK fields.<br /> <br /> The user interface to create such a field is found in the Fields dialog on pane Variables. In advance the user has to create a simple variable. Then the user has to choose Type 'Input Field' and has to select the corresponding created simple variable.<br /> [[Image:Dialog-variable-input.png|1000px|center|dialog to create Simple Variable and a corresponding Simple Variable Text Input Field]]<br /> <br /> <br /> <br /> == Changes in detail ==<br /> In the following the changes being in progress to solve {{Bug|33737}} are given in detail. Currently the changes will only affect '''Text Input Fields''' and '''User Variable Input Fields'''. Thus, the following use of term <nowiki>Input Field</nowiki> denotes these two types of Input Fields.<br /> <br /> ==== Edit content of Input Fields ====<br /> To modify/provide the content of an Input Field it is possible to directly perform the corresponding edit operations inside the document's text area. No additional popup dialog is needed.<br /><br /> As an Input Field can only contain text content most insertion operations are not allowed while the cursor is inside an Input Field. Also pasting operations and drop operations are not allowed. Pasting unformatted text (e.g. on Windows via SHIFT-CTRL-ALT-V) shall be possible.<br /> <br /> ==== Enter/Leaving Input Fields ====<br /> To enable the user to enter respectively leave an Input Field special hidden characters are inserted for the cursor traveling. Thus, the cursor can be positioned before an Input Field and text can be inserted before the Input Field. After a cursor move to the right the Input Field is entered and text at the beginning of the Input Field can be inserted. Similar cursor traveling is possible at the end of the Input Field. The cursor can be placed right behind an Input Field and text can be inserted behind the Input Field. After a cursor move to the left the Input Field is entered and text at the end of the Input Field can be inserted.<br /><br /> TODO: provide screen shots<br /> <br /> Entering and Leaving an Input Field will be indicated to the user by drawing a bounding rectangle around the Input Field when the cursor is inside the Input Field.<br /><br /> TODO: provide screen shots<br /> <br /> Clicking with the mouse pointer into an Input Field will in general select its text content in order to enable the user to directly replace the Input Field's content.<br /> <br /> ==== Traveling between Input Fields ====<br /> Traveling from one Input Field to the next respectively previous one with the keyboard is possible via TAB-Key respectively via SHIFT-TAB-Key. When traveling the complete content of the Input Field is selected.<br /><br /> <br /> To insert a TAB character inside an Input Field using the keyboard the CTRL-TAB-Key have to be used.<br /> <br /> ==== Selection of Input Fields ====<br /> Any text selection inside an Input Fields is possible. When text outside an Input Field is part of a text selection only the complete Input Field can be added to the text selection. Thus, it is not possible to select a part of an Input Field's text content and other text content in one selection.<br /> <br /> ==== No Field Names for Input Fields ====<br /> Field Names are no longer shown for Input Fields. Via Menu - View - Field Names the Field Names of all fields could be displayed instead of the fields content. This will no longer work for Input Fields due to the in-place editing.<br /> <br /> ==== Microsoft Word binary filter (WW8 filter) ====<br /> In OpenOffice created Input Fields will be exported as Microsoft Word FORMTEXT fields.<br /> <br /> Imported Microsoft Word FORMTEXT fields will be exported as Microsoft Word FORMTEXT fields.<br /> <br /> No change for import and export for Microsoft Word FILLIN fields. In general these fields will be exported as Microsoft Word FILLIN fields unless the Input Field's help text or tooltip text is filled.<br /> <br /> <big><big>NOT COMPLETE - DOCUMENTATION OF MORE CHANGES WILL FOLLOW.</big></big><br /> <br /> == Areas which need high attention during testing ==<br /> * Only text content shall be inserted into Input Fields.<br /> * No formatting shall be possible inside Input Fields.<br /> * Applying a formatting while the cursor is inside an Input Field shall be applied to the complete Input Field.<br /> * No other attributes, like a hyperlink, a ruby, a page break or a column break, shall be possible inside Input Fields.<br /> * The insertion of a 'New Paragraph' character or the key input of the ENTER-Key shall result into an insertion of a line break inside an Input Field.<br /> * Undo/Redo actions regarding Input Fields.<br /> * Functionality of other fields shall not be affected.<br /> * Applying formatting or other attributes to text content.<br /> * Save and Load of documents containing Input Fields.<br /> * Exchange of documents containing Input Fields in ODF with previous OpenOffice versions.<br /> * Exchange of documents containing Input Fields in Microsoft Word binary file format with Microsoft Word.<br /> * HTML export and import of text documents containing Input Fields - assure no change to previous versions.<br /> * <big><big>NOT COMPLETE - MORE ITEMS WILL FOLLOW.</big></big></div>

Od https://wiki.openoffice.org/w/index.php?title=Writer/Input_Fields&diff=232165 Writer/Input Fields 2013-11-07T08:11:42Z

<p>Od: /* Changes in detail */</p> <hr /> <div>{{Writer Project|Category=Writer/Effort}}<br /> __NOTOC__<br /> <br /> = In-place editing of Input Fields =<br /> <br /> Purpose of this page is provide information on the solution for {{Bug|33737}}. This information should serve the corresponding quality assurance efforts. It can be also used as the source to document the corresponding changes for the users.<br /> <br /> <br /> <br /> == Input Fields - three of a kind ==<br /> We have three fields which are all named 'Input Field' in the user interface, but each has a different purpose.<br /><br /> These are '''Text Input Fields''', '''User Variable Input Fields''' and '''Simple Variable Input Fields'''.<br /><br /> Currently no changes are made for '''Simple Variable Input Fields''' for solving {{Bug|33737}}.<br /> <br /> <br /> ==== Text Input Field ====<br /> This is a field to prompt the user for an input. The field has a description and its content holds the user's input.<br /> <br /> In the OpenDocument file format (ODF) such a field is represented by ODF element <text:text-input>.<br /> <br /> When importing Microsoft Word documents (binary file format, *.doc) Microsoft Word fields FILLIN and FORMTEXT are imported as Text Input Fields.<br /> <br /> The user interface to create such a field is found in the Fields dialog (Menu - Insert - Fields - Others) on pane Functions. Here the user has to choose Type 'Input Field'.<br /> [[Image:Dialog-text-input.png|500px|center|dialog to create Text Input Field]]<br /> <br /> <br /> ==== User Variable Input Field ====<br /> This is a field to prompt the user to set the value of a user variable. The value of a user variable is the same throughout the complete document.<br /> <br /> In ODF such a field is represented by ODF element <text:user-field-input>.<br /> <br /> Microsoft Word has support for so-called Document Variables. The value of such variables can be shown in a Microsoft Word document, but are created/deleted/set via Microsoft Word macro (aka Visual Basic). These Document Variables seem to be comparable with ODF's User Variables, but currently there is no mapping between these in OpenOffice.<br /> A User Variable Input Field is treated as Text Input Field when exporting an OpenOffice text document to the Microsoft Word binary format.<br /> <br /> The user interface to create such a field is found in the Fields dialog on pane Variables. In advance the user has to create a user field. Then the user has to choose Type 'Input Field' and has to select the corresponding created user variable.<br /> [[Image:Dialog-user-field-input.png|1000px|center|dialog to create User Variable and a corresponding User Variable Text Input Field]]<br /> <br /> <br /> ==== Simple Variable Input Field ====<br /> This is a field to prompt the user to set the value of a simple variable. The value of a simple variable at a certain document position equals the value of the last set value - that is the difference to a user variable.<br /> <br /> In ODF such a field is represented by ODF element <text:variable-input>.<br /> <br /> For the Microsoft Word binary file format import/export filter these Simple Variable Input Fields are mapped to Microsoft Word ASK fields.<br /> <br /> The user interface to create such a field is found in the Fields dialog on pane Variables. In advance the user has to create a simple variable. Then the user has to choose Type 'Input Field' and has to select the corresponding created simple variable.<br /> [[Image:Dialog-variable-input.png|1000px|center|dialog to create Simple Variable and a corresponding Simple Variable Text Input Field]]<br /> <br /> <br /> <br /> == Changes in detail ==<br /> In the following the changes being in progress to solve {{Bug|33737}} are given in detail. Currently the changes will only affect '''Text Input Fields''' and '''User Variable Input Fields'''. Thus, the following use of term <nowiki>Input Field</nowiki> denotes these two types of Input Fields.<br /> <br /> ==== Edit content of Input Fields ====<br /> To modify/provide the content of an Input Field it is possible to directly perform the corresponding edit operations inside the document's text area. No additional popup dialog is needed.<br /><br /> As an Input Field can only contain text content most insertion operations are not allowed while the cursor is inside an Input Field. Also pasting operations and drop operations are not allowed. Pasting unformatted text (e.g. on Windows via SHIFT-CTRL-ALT-V) shall be possible.<br /> <br /> ==== Enter/Leaving Input Fields ====<br /> To enable the user to enter respectively leave an Input Field special hidden characters are inserted for the cursor traveling. Thus, the cursor can be positioned before an Input Field and text can be inserted before the Input Field. After a cursor move to the right the Input Field is entered and text at the beginning of the Input Field can be inserted. Similar cursor traveling is possible at the end of the Input Field. The cursor can be placed right behind an Input Field and text can be inserted behind the Input Field. After a cursor move to the left the Input Field is entered and text at the end of the Input Field can be inserted.<br /><br /> TODO: provide screen shots<br /> <br /> Entering and Leaving an Input Field will be indicated to the user by drawing a bounding rectangle around the Input Field when the cursor is inside the Input Field.<br /><br /> TODO: provide screen shots<br /> <br /> Clicking with the mouse pointer into an Input Field will in general select its text content in order to enable the user to directly replace the Input Field's content.<br /> <br /> ==== Traveling between Input Fields ====<br /> Traveling from one Input Field to the next respectively previous one with the keyboard is possible via TAB-Key respectively via SHIFT-TAB-Key. When traveling the complete content of the Input Field is selected.<br /><br /> <br /> To insert a TAB character inside an Input Field using the keyboard the CTRL-TAB-Key have to be used.<br /> <br /> ==== Selection of Input Fields ====<br /> Any text selection inside an Input Fields is possible. When text outside an Input Field is part of a text selection only the complete Input Field can be added to the text selection. Thus, it is not possible to select a part of an Input Field's text content and other text content in one selection.<br /> <br /> ==== No Field Names for Input Fields ====<br /> Field Names are no longer shown for Input Fields. Via Menu - View - Field Names the Field Names of all fields could be displayed instead of the fields content. This will no longer work for Input Fields due to the in-place editing.<br /> <br /> ==== Microsoft Word binary filter (WW8 filter) ====<br /> In OpenOffice created Input Fields will be exported as Microsoft Word FORMTEXT fields.<br /> <br /> Imported Microsoft Word FORMTEXT fields will be exported as Microsoft Word FORMTEXT fields.<br /> <br /> No change for import and export for Microsoft Word FILLIN fields. In general these fields will be exported as Microsoft Word FILLIN fields unless the Input Field's help text or tooltip text is filled.<br /> <br /> <big><big>NOT COMPLETE - DOCUMENTATION OF MORE CHANGES WILL FOLLOW.</big></big><br /> <br /> == Areas which need high attention during testing ==<br /> * Only text content shall be inserted into Input Fields.<br /> * No formatting shall be possible inside Input Fields.<br /> * Applying a formatting while the cursor is inside an Input Field shall be applied to the complete Input Field.<br /> * No other attributes, like a hyperlink, a ruby, a page break or a column break, shall be possible inside Input Fields.<br /> * The insertion of a 'New Paragraph' character or the key input of the ENTER-Key shall result into an insertion of a line break inside an Input Field.<br /> * Undo/Redo actions regarding Input Fields.<br /> * Functionality of other fields shall not be affected.<br /> * Applying formatting or other attributes to text content.<br /> * Save and Load of documents containing Input Fields.<br /> * Exchange of documents with/from previous OpenOffice versions.<br /> * <big><big>NOT COMPLETE - MORE ITEMS WILL FOLLOW.</big></big></div>

Od https://wiki.openoffice.org/w/index.php?title=Writer/Input_Fields&diff=232164 Writer/Input Fields 2013-11-07T08:06:05Z

<p>Od: /* Changes in detail */</p> <hr /> <div>{{Writer Project|Category=Writer/Effort}}<br /> __NOTOC__<br /> <br /> = In-place editing of Input Fields =<br /> <br /> Purpose of this page is provide information on the solution for {{Bug|33737}}. This information should serve the corresponding quality assurance efforts. It can be also used as the source to document the corresponding changes for the users.<br /> <br /> <br /> <br /> == Input Fields - three of a kind ==<br /> We have three fields which are all named 'Input Field' in the user interface, but each has a different purpose.<br /><br /> These are '''Text Input Fields''', '''User Variable Input Fields''' and '''Simple Variable Input Fields'''.<br /><br /> Currently no changes are made for '''Simple Variable Input Fields''' for solving {{Bug|33737}}.<br /> <br /> <br /> ==== Text Input Field ====<br /> This is a field to prompt the user for an input. The field has a description and its content holds the user's input.<br /> <br /> In the OpenDocument file format (ODF) such a field is represented by ODF element <text:text-input>.<br /> <br /> When importing Microsoft Word documents (binary file format, *.doc) Microsoft Word fields FILLIN and FORMTEXT are imported as Text Input Fields.<br /> <br /> The user interface to create such a field is found in the Fields dialog (Menu - Insert - Fields - Others) on pane Functions. Here the user has to choose Type 'Input Field'.<br /> [[Image:Dialog-text-input.png|500px|center|dialog to create Text Input Field]]<br /> <br /> <br /> ==== User Variable Input Field ====<br /> This is a field to prompt the user to set the value of a user variable. The value of a user variable is the same throughout the complete document.<br /> <br /> In ODF such a field is represented by ODF element <text:user-field-input>.<br /> <br /> Microsoft Word has support for so-called Document Variables. The value of such variables can be shown in a Microsoft Word document, but are created/deleted/set via Microsoft Word macro (aka Visual Basic). These Document Variables seem to be comparable with ODF's User Variables, but currently there is no mapping between these in OpenOffice.<br /> A User Variable Input Field is treated as Text Input Field when exporting an OpenOffice text document to the Microsoft Word binary format.<br /> <br /> The user interface to create such a field is found in the Fields dialog on pane Variables. In advance the user has to create a user field. Then the user has to choose Type 'Input Field' and has to select the corresponding created user variable.<br /> [[Image:Dialog-user-field-input.png|1000px|center|dialog to create User Variable and a corresponding User Variable Text Input Field]]<br /> <br /> <br /> ==== Simple Variable Input Field ====<br /> This is a field to prompt the user to set the value of a simple variable. The value of a simple variable at a certain document position equals the value of the last set value - that is the difference to a user variable.<br /> <br /> In ODF such a field is represented by ODF element <text:variable-input>.<br /> <br /> For the Microsoft Word binary file format import/export filter these Simple Variable Input Fields are mapped to Microsoft Word ASK fields.<br /> <br /> The user interface to create such a field is found in the Fields dialog on pane Variables. In advance the user has to create a simple variable. Then the user has to choose Type 'Input Field' and has to select the corresponding created simple variable.<br /> [[Image:Dialog-variable-input.png|1000px|center|dialog to create Simple Variable and a corresponding Simple Variable Text Input Field]]<br /> <br /> <br /> <br /> == Changes in detail ==<br /> In the following the changes being in progress to solve {{Bug|33737}} are given in detail. Currently the changes will only affect '''Text Input Fields''' and '''User Variable Input Fields'''. Thus, the following use of term <nowiki>Input Field</nowiki> denotes these two types of Input Fields.<br /> <br /> ==== Edit content of Input Fields ====<br /> To modify/provide the content of an Input Field it is possible to directly perform the corresponding edit operations inside the document's text area. No additional popup dialog is needed.<br /><br /> As an Input Field can only contain text content most insertion operations are not allowed while the cursor is inside an Input Field. Also pasting operations and drop operations are not allowed. Pasting unformatted text (e.g. on Windows via SHIFT-CTRL-ALT-V) shall be possible.<br /> <br /> ==== Enter/Leaving Input Fields ====<br /> To enable the user to enter respectively leave an Input Field special hidden characters are inserted for the cursor traveling. Thus, the cursor can be positioned before an Input Field and text can be inserted before the Input Field. After a cursor move to the right the Input Field is entered and text at the beginning of the Input Field can be inserted. Similar cursor traveling is possible at the end of the Input Field. The cursor can be placed right behind an Input Field and text can be inserted behind the Input Field. After a cursor move to the left the Input Field is entered and text at the end of the Input Field can be inserted.<br /><br /> TODO: provide screen shots<br /> <br /> Entering and Leaving an Input Field will be indicated to the user by drawing a bounding rectangle around the Input Field when the cursor is inside the Input Field.<br /><br /> TODO: provide screen shots<br /> <br /> Clicking with the mouse pointer into an Input Field will in general select its text content in order to enable the user to directly replace the Input Field's content.<br /> <br /> ==== Traveling between Input Fields ====<br /> Traveling from one Input Field to the next respectively previous one with the keyboard is possible via TAB-Key respectively via SHIFT-TAB-Key. When traveling the complete content of the Input Field is selected.<br /><br /> <br /> To insert a TAB character inside an Input Field using the keyboard the CTRL-TAB-Key have to be used.<br /> <br /> ==== Selection of Input Fields ====<br /> Any text selection inside an Input Fields is possible. When text outside an Input Field is part of a text selection only the complete Input Field can be added to the text selection. Thus, it is not possible to select a part of an Input Field's text content and other text content in one selection.<br /> <br /> ==== No Field Names for Input Fields ====<br /> Field Names are no longer shown for Input Fields. Via Menu - View - Field Names the Field Names of all fields could be displayed instead of the fields content. This will no longer work for Input Fields due to the in-place editing.<br /> <br /> <br /> ==== Microsoft Word binary filter (WW8 filter) ====<br /> In OpenOffice created Input Fields will be exported as Microsoft Word FORMTEXT fields.<br /> <br /> Imported Microsoft Word FORMTEXT fields will be exported as Microsoft Word FORMTEXT fields.<br /> <br /> No change for import and export for Microsoft Word FILLIN fields. In general these fields will be exported as Microsoft Word FILLIN fields unless the Input Field's help text or tooltip text is filled.<br /> <br /> <big><big>NOT COMPLETE - DOCUMENTATION OF MORE CHANGES WILL FOLLOW.</big></big><br /> <br /> == Areas which need high attention during testing ==<br /> * Only text content shall be inserted into Input Fields.<br /> * No formatting shall be possible inside Input Fields.<br /> * Applying a formatting while the cursor is inside an Input Field shall be applied to the complete Input Field.<br /> * No other attributes, like a hyperlink, a ruby, a page break or a column break, shall be possible inside Input Fields.<br /> * The insertion of a 'New Paragraph' character or the key input of the ENTER-Key shall result into an insertion of a line break inside an Input Field.<br /> * Undo/Redo actions regarding Input Fields.<br /> * Functionality of other fields shall not be affected.<br /> * Applying formatting or other attributes to text content.<br /> * Save and Load of documents containing Input Fields.<br /> * Exchange of documents with/from previous OpenOffice versions.<br /> * <big><big>NOT COMPLETE - MORE ITEMS WILL FOLLOW.</big></big></div>

Od https://wiki.openoffice.org/w/index.php?title=Writer/Input_Fields&diff=232163 Writer/Input Fields 2013-11-07T07:42:28Z

<p>Od: </p> <hr /> <div>{{Writer Project|Category=Writer/Effort}}<br /> __NOTOC__<br /> <br /> = In-place editing of Input Fields =<br /> <br /> Purpose of this page is provide information on the solution for {{Bug|33737}}. This information should serve the corresponding quality assurance efforts. It can be also used as the source to document the corresponding changes for the users.<br /> <br /> <br /> <br /> == Input Fields - three of a kind ==<br /> We have three fields which are all named 'Input Field' in the user interface, but each has a different purpose.<br /><br /> These are '''Text Input Fields''', '''User Variable Input Fields''' and '''Simple Variable Input Fields'''.<br /><br /> Currently no changes are made for '''Simple Variable Input Fields''' for solving {{Bug|33737}}.<br /> <br /> <br /> ==== Text Input Field ====<br /> This is a field to prompt the user for an input. The field has a description and its content holds the user's input.<br /> <br /> In the OpenDocument file format (ODF) such a field is represented by ODF element <text:text-input>.<br /> <br /> When importing Microsoft Word documents (binary file format, *.doc) Microsoft Word fields FILLIN and FORMTEXT are imported as Text Input Fields.<br /> <br /> The user interface to create such a field is found in the Fields dialog (Menu - Insert - Fields - Others) on pane Functions. Here the user has to choose Type 'Input Field'.<br /> [[Image:Dialog-text-input.png|500px|center|dialog to create Text Input Field]]<br /> <br /> <br /> ==== User Variable Input Field ====<br /> This is a field to prompt the user to set the value of a user variable. The value of a user variable is the same throughout the complete document.<br /> <br /> In ODF such a field is represented by ODF element <text:user-field-input>.<br /> <br /> Microsoft Word has support for so-called Document Variables. The value of such variables can be shown in a Microsoft Word document, but are created/deleted/set via Microsoft Word macro (aka Visual Basic). These Document Variables seem to be comparable with ODF's User Variables, but currently there is no mapping between these in OpenOffice.<br /> A User Variable Input Field is treated as Text Input Field when exporting an OpenOffice text document to the Microsoft Word binary format.<br /> <br /> The user interface to create such a field is found in the Fields dialog on pane Variables. In advance the user has to create a user field. Then the user has to choose Type 'Input Field' and has to select the corresponding created user variable.<br /> [[Image:Dialog-user-field-input.png|1000px|center|dialog to create User Variable and a corresponding User Variable Text Input Field]]<br /> <br /> <br /> ==== Simple Variable Input Field ====<br /> This is a field to prompt the user to set the value of a simple variable. The value of a simple variable at a certain document position equals the value of the last set value - that is the difference to a user variable.<br /> <br /> In ODF such a field is represented by ODF element <text:variable-input>.<br /> <br /> For the Microsoft Word binary file format import/export filter these Simple Variable Input Fields are mapped to Microsoft Word ASK fields.<br /> <br /> The user interface to create such a field is found in the Fields dialog on pane Variables. In advance the user has to create a simple variable. Then the user has to choose Type 'Input Field' and has to select the corresponding created simple variable.<br /> [[Image:Dialog-variable-input.png|1000px|center|dialog to create Simple Variable and a corresponding Simple Variable Text Input Field]]<br /> <br /> <br /> <br /> == Changes in detail ==<br /> In the following the changes being in progress to solve {{Bug|33737}} are given in detail. Currently the changes will only affect '''Text Input Fields''' and '''User Variable Input Fields'''. Thus, the following use of term <nowiki>Input Field</nowiki> denotes these two types of Input Fields.<br /> <br /> ==== Edit content of Input Fields ====<br /> To modify/provide the content of an Input Field it is possible to directly perform the corresponding edit operations inside the document's text area. No additional popup dialog is needed.<br /><br /> As an Input Field can only contain text content most insertion operations are not allowed while the cursor is inside an Input Field. Also pasting operations and drop operations are not allowed. Pasting unformatted text (e.g. on Windows via SHIFT-CTRL-ALT-V) shall be possible.<br /> <br /> ==== Enter/Leaving Input Fields ====<br /> To enable the user to enter respectively leave an Input Field special hidden characters are inserted for the cursor traveling. Thus, the cursor can be positioned before an Input Field and text can be inserted before the Input Field. After a cursor move to the right the Input Field is entered and text at the beginning of the Input Field can be inserted. Similar cursor traveling is possible at the end of the Input Field. The cursor can be placed right behind an Input Field and text can be inserted behind the Input Field. After a cursor move to the left the Input Field is entered and text at the end of the Input Field can be inserted.<br /><br /> TODO: provide screen shots<br /> <br /> Entering and Leaving an Input Field will be indicated to the user by drawing a bounding rectangle around the Input Field when the cursor is inside the Input Field.<br /><br /> TODO: provide screen shots<br /> <br /> Clicking with the mouse pointer into an Input Field will in general select its text content in order to enable the user to directly replace the Input Field's content.<br /> <br /> ==== Traveling between Input Fields ====<br /> Traveling from one Input Field to the next respectively previous one with the keyboard is possible via TAB-Key respectively via SHIFT-TAB-Key. When traveling the complete content of the Input Field is selected.<br /><br /> <br /> To insert a TAB character inside an Input Field using the keyboard the CTRL-TAB-Key have to be used.<br /> <br /> ==== Selection of Input Fields ====<br /> Any text selection inside an Input Fields is possible. When text outside an Input Field is part of a text selection only the complete Input Field can be added to the text selection. Thus, it is not possible to select a part of an Input Field's text content and other text content in one selection.<br /> <br /> ==== No Field Names for Input Fields ====<br /> Field Names are no longer shown for Input Fields. Via Menu - View - Field Names the Field Names of all fields could be displayed instead of the fields content. This will no longer work for Input Fields due to the in-place editing.<br /> <br /> <br /> ==== Microsoft Word binary filter ====<br /> <br /> <br /> <big><big>NOT COMPLETE - DOCUMENTATION OF MORE CHANGES WILL FOLLOW.</big></big><br /> <br /> <br /> <br /> == Areas which need high attention during testing ==<br /> * Only text content shall be inserted into Input Fields.<br /> * No formatting shall be possible inside Input Fields.<br /> * Applying a formatting while the cursor is inside an Input Field shall be applied to the complete Input Field.<br /> * No other attributes, like a hyperlink, a ruby, a page break or a column break, shall be possible inside Input Fields.<br /> * The insertion of a 'New Paragraph' character or the key input of the ENTER-Key shall result into an insertion of a line break inside an Input Field.<br /> * Undo/Redo actions regarding Input Fields.<br /> * Functionality of other fields shall not be affected.<br /> * Applying formatting or other attributes to text content.<br /> * Save and Load of documents containing Input Fields.<br /> * Exchange of documents with/from previous OpenOffice versions.<br /> * <big><big>NOT COMPLETE - MORE ITEMS WILL FOLLOW.</big></big></div>

Od https://wiki.openoffice.org/w/index.php?title=Writer/Input_Fields&diff=232162 Writer/Input Fields 2013-11-07T07:00:38Z

<p>Od: </p> <hr /> <div>{{Writer Project|Category=Writer/Effort}}<br /> __NOTOC__<br /> <br /> = In-place editing of Input Fields =<br /> <br /> Purpose of this page is provide information on the solution for {{Bug|33737}}. This information should serve the corresponding quality assurance efforts. It can be also used as the source to document the corresponding changes for the users.<br /> <br /> <br /> <br /> == Input Fields - three of a kind ==<br /> We have three fields which are all named 'Input Field' in the user interface, but each has a different purpose.<br /><br /> These are '''Text Input Fields''', '''User Variable Input Fields''' and '''Simple Variable Input Fields'''.<br /><br /> Currently no changes are made for '''Simple Variable Input Fields''' for solving {{Bug|33737}}.<br /> <br /> <br /> ==== Text Input Field ====<br /> This is a field to prompt the user for an input. The field has a description and its content holds the user's input.<br /> <br /> In the OpenDocument file format (ODF) such a field is represented by ODF element <text:text-input>.<br /> <br /> When importing Microsoft Word documents (binary file format, *.doc) Microsoft Word fields FILLIN and FORMTEXT are imported as Text Input Fields.<br /> <br /> The user interface to create such a field is found in the Fields dialog (Menu - Insert - Fields - Others) on pane Functions. Here the user has to choose Type 'Input Field'.<br /> [[Image:Dialog-text-input.png|500px|center|dialog to create Text Input Field]]<br /> <br /> <br /> ==== User Variable Input Field ====<br /> This is a field to prompt the user to set the value of a user variable. The value of a user variable is the same throughout the complete document.<br /> <br /> In ODF such a field is represented by ODF element <text:user-field-input>.<br /> <br /> Microsoft Word has support for so-called Document Variables. The value of such variables can be shown in a Microsoft Word document, but are created/deleted/set via Microsoft Word macro (aka Visual Basic). These Document Variables seem to be comparable with ODF's User Variables, but currently there is no mapping between these in OpenOffice.<br /> A User Variable Input Field is treated as Text Input Field when exporting an OpenOffice text document to the Microsoft Word binary format.<br /> <br /> The user interface to create such a field is found in the Fields dialog on pane Variables. In advance the user has to create a user field. Then the user has to choose Type 'Input Field' and has to select the corresponding created user variable.<br /> [[Image:Dialog-user-field-input.png|1000px|center|dialog to create User Variable and a corresponding User Variable Text Input Field]]<br /> <br /> <br /> ==== Simple Variable Input Field ====<br /> This is a field to prompt the user to set the value of a simple variable. The value of a simple variable at a certain document position equals the value of the last set value - that is the difference to a user variable.<br /> <br /> In ODF such a field is represented by ODF element <text:variable-input>.<br /> <br /> For the Microsoft Word binary file format import/export filter these Simple Variable Input Fields are mapped to Microsoft Word ASK fields.<br /> <br /> The user interface to create such a field is found in the Fields dialog on pane Variables. In advance the user has to create a simple variable. Then the user has to choose Type 'Input Field' and has to select the corresponding created simple variable.<br /> [[Image:Dialog-variable-input.png|1000px|center|dialog to create Simple Variable and a corresponding Simple Variable Text Input Field]]<br /> <br /> <br /> <br /> == Changes in detail ==<br /> In the following the changes being in progress to solve {{Bug|33737}} are given in detail. Currently the changes will only affect '''Text Input Fields''' and '''User Variable Input Fields'''.<br /> <br /> ==== Edit content of Input Fields ====<br /> To modify/provide the content of an Input Field it is possible to directly perform the corresponding edit operations inside the document's text area. No additional popup dialog is needed.<br /><br /> As an Input Field can only contain text content most insertion operations are not allowed while the cursor is inside an Input Field. Also pasting operations and drop operations are not allowed. Pasting unformatted text (e.g. on Windows via SHIFT-CTRL-ALT-V) shall be possible.<br /> <br /> ==== Enter/Leaving Input Fields ====<br /> To enable the user to enter respectively leave an Input Field special hidden characters are inserted for the cursor traveling. Thus, the cursor can be positioned before an Input Field and text can be inserted before the Input Field. After a cursor move to the right the Input Field is entered and text at the beginning of the Input Field can be inserted. Similar cursor traveling is possible at the end of the Input Field. The cursor can be placed right behind an Input Field and text can be inserted behind the Input Field. After a cursor move to the left the Input Field is entered and text at the end of the Input Field can be inserted.<br /><br /> TODO: provide screen shots<br /> <br /> Entering and Leaving an Input Field will be indicated to the user by drawing a bounding rectangle around the Input Field when the cursor is inside the Input Field.<br /><br /> TODO: provide screen shots<br /> <br /> Clicking with the mouse pointer into an Input Field will in general select its text content in order to enable the user to directly replace the Input Field's content.<br /> <br /> ==== Traveling between Input Fields ====<br /> Traveling from one Input Field to the next respectively previous one with the keyboard is possible via TAB-Key respectively via SHIFT-TAB-Key. When traveling the complete content of the Input Field is selected.<br /><br /> <br /> To insert a TAB character inside an Input Field using the keyboard the CTRL-TAB-Key have to be used.<br /> <br /> ==== Selection of Input Fields ====<br /> Any text selection inside an Input Fields is possible. When text outside an Input Field is part of a text selection only the complete Input Field can be added to the text selection. Thus, it is not possible to select a part of an Input Field's text content and other text content in one selection.<br /> <br /> ==== No Field Names for Input Fields ====<br /> Field Names are no longer shown for Input Fields. Via Menu - View - Field Names the Field Names of all fields could be displayed instead of the fields content. This will no longer work for Input Fields due to the possible in-place editing.<br /> <br /> <big><big>NOT COMPLETE - DOCUMENTATION OF MORE CHANGES WILL FOLLOW.</big></big><br /> <br /> <br /> <br /> == Areas which need high attention during testing ==<br /> * Only text content shall be inserted into Input Fields.<br /> * No formatting shall be possible inside Input Fields.<br /> * Applying a formatting while the cursor is inside an Input Field shall be applied to the complete Input Field.<br /> * No other attributes, like a hyperlink, a ruby, a page break or a column break, shall be possible inside Input Fields.<br /> * The insertion of a 'New Paragraph' character or the key input of the ENTER-Key shall result into an insertion of a line break inside an Input Field.<br /> * Undo/Redo actions regarding Input Fields.<br /> * Functionality of other fields shall not be affected.<br /> * Applying formatting or other attributes to text content.<br /> * <big><big>NOT COMPLETE - MORE ITEMS WILL FOLLOW.</big></big></div>

Od https://wiki.openoffice.org/w/index.php?title=Writer/Input_Fields&diff=232159 Writer/Input Fields 2013-11-06T14:26:01Z

<p>Od: </p> <hr /> <div>{{Writer Project|Category=Writer/Effort}}<br /> <br /> = In-place editing of Input Fields =<br /> <br /> Purpose of this page is provide information on the solution for {{Bug|33737}}. This information should serve the corresponding quality assurance efforts. It can be also used as the source to document the corresponding changes for the users.<br /> <br /> <br /> <br /> == Input Fields - three of a kind ==<br /> We have three fields which are all named 'Input Field' in the user interface, but each has a different purpose.<br /><br /> These are '''Text Input Fields''', '''User Variable Input Fields''' and '''Simple Variable Input Fields'''.<br /><br /> Currently no changes are made for '''Simple Variable Input Fields''' for solving {{Bug|33737}}.<br /> <br /> <br /> ==== Text Input Field ====<br /> This is a field to prompt the user for an input. The field has a description and its content holds the user's input.<br /> <br /> In the OpenDocument file format (ODF) such a field is represented by ODF element <text:text-input>.<br /> <br /> When importing Microsoft Word documents (binary file format, *.doc) Microsoft Word fields FILLIN and FORMTEXT are imported as Text Input Fields.<br /> <br /> The user interface to create such a field is found in the Fields dialog (Menu - Insert - Fields - Others) on pane Functions. Here the user has to choose Type 'Input Field'.<br /> [[Image:Dialog-text-input.png|500px|center|dialog to create Text Input Field]]<br /> <br /> <br /> ==== User Variable Input Field ====<br /> This is a field to prompt the user to set the value of a user variable. The value of a user variable is the same throughout the complete document.<br /> <br /> In ODF such a field is represented by ODF element <text:user-field-input>.<br /> <br /> Microsoft Word has support for so-called Document Variables. The value of such variables can be shown in a Microsoft Word document, but are created/deleted/set via Microsoft Word macro (aka Visual Basic). These Document Variables seem to be comparable with ODF's User Variables, but currently there is no mapping between these in OpenOffice.<br /> A User Variable Input Field is treated as Text Input Field when exporting an OpenOffice text document to the Microsoft Word binary format.<br /> <br /> The user interface to create such a field is found in the Fields dialog on pane Variables. In advance the user has to create a user field. Then the user has to choose Type 'Input Field' and has to select the corresponding created user variable.<br /> [[Image:Dialog-user-field-input.png|1000px|center|dialog to create User Variable and a corresponding User Variable Text Input Field]]<br /> <br /> <br /> ==== Simple Variable Input Field ====<br /> This is a field to prompt the user to set the value of a simple variable. The value of a simple variable at a certain document position equals the value of the last set value - that is the difference to a user variable.<br /> <br /> In ODF such a field is represented by ODF element <text:variable-input>.<br /> <br /> For the Microsoft Word binary file format import/export filter these Simple Variable Input Fields are mapped to Microsoft Word ASK fields.<br /> <br /> The user interface to create such a field is found in the Fields dialog on pane Variables. In advance the user has to create a simple variable. Then the user has to choose Type 'Input Field' and has to select the corresponding created simple variable.<br /> [[Image:Dialog-variable-input.png|1000px|center|dialog to create Simple Variable and a corresponding Simple Variable Text Input Field]]<br /> <br /> <br /> <br /> == Changes in detail ==<br /> In the following the changes being in progress to solve {{Bug|33737}} are given in detail. Currently the changes will only affect '''Text Input Fields''' and '''User Variable Input Fields'''.<br /> <br /> ==== Edit content of Input Fields ====<br /> To modify/provide the content of an Input Field it is possible to directly perform the corresponding edit operations inside the document's text area. No additional popup dialog is needed.<br /><br /> As an Input Field can only contain text content most insertion operations are not allowed while the cursor is inside an Input Field. Also pasting operations and drop operations are not allowed. Pasting unformatted text (e.g. on Windows via SHIFT-CTRL-ALT-V) shall be possible.<br /> <br /> ==== Enter/Leaving Input Fields ====<br /> To enable the user to enter respectively leave an Input Field special hidden characters are inserted for the cursor traveling. Thus, the cursor can be positioned before an Input Field and text can be inserted before the Input Field. After a cursor move to the right the Input Field is entered and text at the beginning of the Input Field can be inserted. Similar cursor traveling is possible at the end of the Input Field. The cursor can be placed right behind an Input Field and text can be inserted behind the Input Field. After a cursor move to the left the Input Field is entered and text at the end of the Input Field can be inserted.<br /><br /> TODO: provide screen shots<br /> <br /> Entering and Leaving an Input Field will be indicated to the user by drawing a bounding rectangle around the Input Field when the cursor is inside the Input Field.<br /><br /> TODO: provide screen shots<br /> <br /> Clicking with the mouse pointer into an Input Field will in general select its text content in order to enable the user to directly replace the Input Field's content.<br /> <br /> ==== Traveling between Input Fields ====<br /> Traveling from one Input Field to the next respectively previous one with the keyboard is possible via TAB-Key respectively via SHIFT-TAB-Key. When traveling the complete content of the Input Field is selected.<br /><br /> <br /> To insert a TAB character inside an Input Field using the keyboard the CTRL-TAB-Key have to be used.<br /> <br /> ==== Selection of Input Fields ====<br /> Any text selection inside an Input Fields is possible. When text outside an Input Field is part of a text selection only the complete Input Field can be added to the text selection. Thus, it is not possible to select a part of an Input Field's text content and other text content in one selection.<br /> <br /> ==== No Field Names for Input Fields ====<br /> Field Names are no longer shown for Input Fields. Via Menu - View - Field Names the Field Names of all fields could be displayed instead of the fields content. This will no longer work for Input Fields due to the possible in-place editing.<br /> <br /> <big><big>NOT COMPLETE - DOCUMENTATION OF MORE CHANGES WILL FOLLOW.</big></big><br /> <br /> <br /> <br /> == Areas which need high attention during testing ==<br /> * Only text content shall be inserted into Input Fields.<br /> * No formatting shall be possible inside Input Fields.<br /> * Applying a formatting while the cursor is inside an Input Field shall be applied to the complete Input Field.<br /> * No other attributes, like a hyperlink, a ruby, a page break or a column break, shall be possible inside Input Fields.<br /> * The insertion of a 'New Paragraph' character or the key input of the ENTER-Key shall result into an insertion of a line break inside an Input Field.<br /> * Undo/Redo actions regarding Input Fields.<br /> * Functionality of other fields shall not be affected.<br /> * Applying formatting or other attributes to text content.<br /> * <big><big>NOT COMPLETE - MORE ITEMS WILL FOLLOW.</big></big></div>

Od https://wiki.openoffice.org/w/index.php?title=Writer/Input_Fields&diff=232155 Writer/Input Fields 2013-11-06T14:14:41Z

<p>Od: (checkpoint save)</p> <hr /> <div>{{Writer Project|Category=Writer/Effort}}<br /> <br /> = In-place editing of Input Fields =<br /> <br /> Purpose of this page is provide information on the solution for {{Bug|33737}}. This information should serve the corresponding quality assurance efforts. It can be also used as the source to document the corresponding changes for the users.<br /> <br /> <br /> <br /> == Input Fields - three of a kind ==<br /> We have three fields which are all named 'Input Field' in the user interface, but each has a different purpose.<br /><br /> These are '''Text Input Fields''', '''User Variable Input Fields''' and '''Simple Variable Input Fields'''.<br /><br /> Currently no changes are made for '''Simple Variable Input Fields''' for solving {{Bug|33737}}.<br /> <br /> <br /> ==== Text Input Field ====<br /> This is a field to prompt the user for an input. The field has a description and its content holds the user's input.<br /> <br /> In the OpenDocument file format (ODF) such a field is represented by ODF element <text:text-input>.<br /> <br /> When importing Microsoft Word documents (binary file format, *.doc) Microsoft Word fields FILLIN and FORMTEXT are imported as Text Input Fields.<br /> <br /> The user interface to create such a field is found in the Fields dialog (Menu - Insert - Fields - Others) on pane Functions. Here the user has to choose Type 'Input Field'.<br /> [[Image:Dialog-text-input.png|500px|center|dialog to create Text Input Field]]<br /> <br /> <br /> ==== User Variable Input Field ====<br /> This is a field to prompt the user to set the value of a user variable. The value of a user variable is the same throughout the complete document.<br /> <br /> In ODF such a field is represented by ODF element <text:user-field-input>.<br /> <br /> Microsoft Word has support for so-called Document Variables. The value of such variables can be shown in a Microsoft Word document, but are created/deleted/set via Microsoft Word macro (aka Visual Basic). These Document Variables seem to be comparable with ODF's User Variables, but currently there is no mapping between these in OpenOffice.<br /> A User Variable Input Field is treated as Text Input Field when exporting an OpenOffice text document to the Microsoft Word binary format.<br /> <br /> The user interface to create such a field is found in the Fields dialog on pane Variables. In advance the user has to create a user field. Then the user has to choose Type 'Input Field' and has to select the corresponding created user variable.<br /> [[Image:Dialog-user-field-input.png|1000px|center|dialog to create User Variable and a corresponding User Variable Text Input Field]]<br /> <br /> <br /> ==== Simple Variable Input Field ====<br /> This is a field to prompt the user to set the value of a simple variable. The value of a simple variable at a certain document position equals the value of the last set value - that is the difference to a user variable.<br /> <br /> In ODF such a field is represented by ODF element <text:variable-input>.<br /> <br /> For the Microsoft Word binary file format import/export filter these Simple Variable Input Fields are mapped to Microsoft Word ASK fields.<br /> <br /> The user interface to create such a field is found in the Fields dialog on pane Variables. In advance the user has to create a simple variable. Then the user has to choose Type 'Input Field' and has to select the corresponding created simple variable.<br /> [[Image:Dialog-variable-input.png|1000px|center|dialog to create Simple Variable and a corresponding Simple Variable Text Input Field]]<br /> <br /> <br /> <br /> == Changes in detail ==<br /> In the following the changes being in progress to solve {{Bug|33737}} are given in detail. Currently the changes will only affect '''Text Input Fields''' and '''User Variable Input Fields'''.<br /> <br /> ==== Edit content of Input Fields ====<br /> To modify/provide the content of an Input Field it is possible to directly perform the corresponding edit operations inside the document's text area. No additional popup dialog is needed.<br /><br /> As an Input Field can only contain text content most insertion operations are not allowed while the cursor is inside an Input Field. Also pasting operations and drop operations are not allowed. Pasting unformatted text (e.g. on Windows via SHIFT-CTRL-ALT-V) shall be possible.<br /> <br /> ==== Enter/Leaving Input Fields ====<br /> To enable the user to enter respectively leave an Input Field special hidden characters are inserted for the cursor traveling. Thus, the cursor can be positioned before an Input Field and text can be inserted before the Input Field. After a cursor move to the right the Input Field is entered and text at the beginning of the Input Field can be inserted. Similar cursor traveling is possible at the end of the Input Field. The cursor can be placed right behind an Input Field and text can be inserted behind the Input Field. After a cursor move to the left the Input Field is entered and text at the end of the Input Field can be inserted.<br /><br /> TODO: provide screen shots<br /> <br /> Entering and Leaving an Input Field will be indicated to the user by drawing a bounding rectangle around the Input Field when the cursor is inside the Input Field.<br /><br /> TODO: provide screen shots<br /> <br /> Clicking with the mouse pointer into an Input Field will in general select its text content in order to enable the user to directly replace the Input Field's content.<br /> <br /> ==== Traveling between Input Fields ====<br /> Traveling from one Input Field to the next respectively previous one with the keyboard is possible via TAB-Key respectively via SHIFT-TAB-Key. When traveling the complete content of the Input Field is selected.<br /><br /> <br /> To insert a TAB character inside an Input Field using the keyboard the CTRL-TAB-Key have to be used.<br /> <br /> ==== Selection of Input Fields ====<br /> Any text selection inside an Input Fields is possible. When text outside an Input Field is part of a text selection only the complete Input Field can be added to the text selection. Thus, it is not possible to select a part of an Input Field's text content and other text content in one selection.<br /> <br /> ==== No Field Names for Input Fields ====<br /> Field Names are no longer shown for Input Fields. Via Menu - View - Field Names the Field Names of all fields could be displayed instead of the fields content. This will no longer work for Input Fields due to the possible in-place editing.<br /> <br /> <br /> <br /> <br /> <br /> == Areas which need high attention during testing ==<br /> * Only text content shall be inserted into Input Fields.<br /> * No formatting shall be possible inside Input Fields.<br /> * Applying a formatting while the cursor is inside an Input Field shall be applied to the complete Input Field.<br /> * No other attributes, like a hyperlink, a ruby, a page break or a column break, shall be possible inside Input Fields.<br /> * The insertion of a 'New Paragraph' character or the key input of the ENTER-Key shall result into an insertion of a line break inside an Input Field.<br /> * Undo/Redo actions regarding Input Fields.<br /> * Functionality of other fields shall not be affected.<br /> * Applying formatting or other attributes to text content.</div>

Od https://wiki.openoffice.org/w/index.php?title=Writer/Input_Fields&diff=232154 Writer/Input Fields 2013-11-06T13:52:48Z

<p>Od: </p> <hr /> <div>{{Writer Project|Category=Writer/Effort}}<br /> <br /> = In-place editing of Input Fields =<br /> <br /> Purpose of this page is provide information on the solution for {{Bug|33737}}. This information should serve the corresponding quality assurance efforts. It can be also used as the source to document the corresponding changes for the users.<br /> <br /> <br /> <br /> == Input Fields - three of a kind ==<br /> We have three fields which are all named 'Input Field' in the user interface, but each has a different purpose.<br /><br /> These are '''Text Input Fields''', '''User Variable Input Fields''' and '''Simple Variable Input Fields'''.<br /><br /> Currently no changes are made for '''Simple Variable Input Fields''' for solving {{Bug|33737}}.<br /> <br /> <br /> ==== Text Input Field ====<br /> This is a field to prompt the user for an input. The field has a description and its content holds the user's input.<br /> <br /> In the OpenDocument file format (ODF) such a field is represented by ODF element <text:text-input>.<br /> <br /> When importing Microsoft Word documents (binary file format, *.doc) Microsoft Word fields FILLIN and FORMTEXT are imported as Text Input Fields.<br /> <br /> The user interface to create such a field is found in the Fields dialog (Menu - Insert - Fields - Others) on pane Functions. Here the user has to choose Type 'Input Field'.<br /> [[Image:Dialog-text-input.png|500px|center|dialog to create Text Input Field]]<br /> <br /> <br /> ==== User Variable Input Field ====<br /> This is a field to prompt the user to set the value of a user variable. The value of a user variable is the same throughout the complete document.<br /> <br /> In ODF such a field is represented by ODF element <text:user-field-input>.<br /> <br /> Microsoft Word has support for so-called Document Variables. The value of such variables can be shown in a Microsoft Word document, but are created/deleted/set via Microsoft Word macro (aka Visual Basic). These Document Variables seem to be comparable with ODF's User Variables, but currently there is no mapping between these in OpenOffice.<br /> A User Variable Input Field is treated as Text Input Field when exporting an OpenOffice text document to the Microsoft Word binary format.<br /> <br /> The user interface to create such a field is found in the Fields dialog on pane Variables. In advance the user has to create a user field. Then the user has to choose Type 'Input Field' and has to select the corresponding created user variable.<br /> [[Image:Dialog-user-field-input.png|1000px|center|dialog to create User Variable and a corresponding User Variable Text Input Field]]<br /> <br /> <br /> ==== Simple Variable Input Field ====<br /> This is a field to prompt the user to set the value of a simple variable. The value of a simple variable at a certain document position equals the value of the last set value - that is the difference to a user variable.<br /> <br /> In ODF such a field is represented by ODF element <text:variable-input>.<br /> <br /> For the Microsoft Word binary file format import/export filter these Simple Variable Input Fields are mapped to Microsoft Word ASK fields.<br /> <br /> The user interface to create such a field is found in the Fields dialog on pane Variables. In advance the user has to create a simple variable. Then the user has to choose Type 'Input Field' and has to select the corresponding created simple variable.<br /> [[Image:Dialog-variable-input.png|1000px|center|dialog to create Simple Variable and a corresponding Simple Variable Text Input Field]]<br /> <br /> <br /> <br /> == Changes in detail ==<br /> In the following the changes being in progress to solve {{Bug|33737}} are given in detail. Currently the changes will only affect '''Text Input Fields''' and '''User Variable Input Fields'''.<br /> <br /> ==== Edit content of Input Fields ====<br /> To modify/provide the content of an Input Field it is possible to directly perform the corresponding edit operations inside the document's text area. No additional popup dialog is needed.<br /><br /> As an Input Field can only contain text content most insertion operations are not allowed while the cursor is inside an Input Field. Also pasting operations and drop operations are not allowed. Pasting unformatted text (e.g. on Windows via SHIFT-CTRL-ALT-V) shall be possible.<br /> <br /> ==== Enter/Leaving Input Fields ====<br /> To enable the user to enter respectively leave an Input Field special hidden characters are inserted for the cursor traveling. Thus, the cursor can be positioned before an Input Field and text can be inserted before the Input Field. After a cursor move to the right the Input Field is entered and text at the beginning of the Input Field can be inserted. Similar cursor traveling is possible at the end of the Input Field. The cursor can be placed right behind an Input Field and text can be inserted behind the Input Field. After a cursor move to the left the Input Field is entered and text at the end of the Input Field can be inserted.<br /><br /> TODO: provide screen shots<br /> <br /> Entering and Leaving an Input Field will be indicated to the user by drawing a bounding rectangle around the Input Field when the cursor is inside the Input Field.<br /><br /> TODO: provide screen shots<br /> <br /> Clicking with the mouse pointer into an Input Field will in general select its text content in order to enable the user to directly replace the Input Field's content.<br /> <br /> ==== Traveling between Input Fields ====<br /> Traveling from one Input Field to the next respectively previous one with the keyboard is possible via TAB-Key respectively via SHIFT-TAB-Key. When traveling the complete content of the Input Field is selected.<br /><br /> <br /> To insert a TAB character inside an Input Field using the keyboard the CTRL-TAB-Key have to be used.<br /> <br /> ==== Selection of Input Fields ====<br /> Any text selection inside an Input Fields is possible. When text outside an Input Field is part of a text selection only the complete Input Field can be added to the text selection. Thus, it is not possible to select a part of an Input Field's text content and other text content in one selection.<br /> <br /> <br /> <br /> == Areas which need high attention during testing ==<br /> * Only text content shall be inserted into Input Fields.<br /> * No formatting shall be possible inside Input Fields.<br /> * Applying a formatting while the cursor is inside an Input Field shall be applied to the complete Input Field.<br /> * No other attributes, like a hyperlink, a ruby, a page break or a column break, shall be possible inside Input Fields.<br /> * The insertion of a 'New Paragraph' character or the key input of the ENTER-Key shall result into an insertion of a line break inside an Input Field.<br /> * Undo/Redo actions regarding Input Fields.<br /> * Functionality of other fields shall not be affected.<br /> * Applying formatting or other attributes to text content.</div>

Od https://wiki.openoffice.org/w/index.php?title=Writer/Input_Fields&diff=232153 Writer/Input Fields 2013-11-06T11:45:32Z

<p>Od: </p> <hr /> <div>{{Writer Project|Category=Writer/Effort}}<br /> <br /> = In-place editing of Input Fields =<br /> <br /> Purpose of this page is provide information on the solution for {{Bug|33737}}. This information should serve the corresponding quality assurance efforts. It can be also used as the source to document the corresponding changes for the users.<br /> <br /> <br /> == Input Fields - three of a kind ==<br /> We have three fields which are all named 'Input Field' in the user interface, but each has a different purpose.<br /><br /> These are '''Text Input Fields''', '''User Variable Input Fields''' and '''Simple Variable Input Fields'''.<br /><br /> Currently no changes are made for '''Simple Variable Input Fields''' for solving {{Bug|33737}}.<br /> <br /> ==== Text Input Field ====<br /> This is a field to prompt the user for an input. The field has a description and its content holds the user's input.<br /> <br /> In the OpenDocument file format (ODF) such a field is represented by ODF element <text:text-input>.<br /> <br /> When importing Microsoft Word documents (binary file format, *.doc) Microsoft Word fields FILLIN and FORMTEXT are imported as Text Input Fields.<br /> <br /> The user interface to create such a field is found in the Fields dialog (Menu - Insert - Fields - Others) on pane Functions. Here the user has to choose Type 'Input Field'.<br /> [[Image:Dialog-text-input.png|500px|center|dialog to create Text Input Field]]<br /> <br /> <br /> ==== User Variable Input Field ====<br /> This is a field to prompt the user to set the value of a user variable. The value of a user variable is the same throughout the complete document.<br /> <br /> In ODF such a field is represented by ODF element <text:user-field-input>.<br /> <br /> Microsoft Word has support for so-called Document Variables. The value of such variables can be shown in a Microsoft Word document, but are created/deleted/set via Microsoft Word macro (aka Visual Basic). These Document Variables seem to be comparable with ODF's User Variables, but currently there is no mapping between these in OpenOffice.<br /> A User Variable Input Field is treated as Text Input Field when exporting an OpenOffice text document to the Microsoft Word binary format.<br /> <br /> The user interface to create such a field is found in the Fields dialog on pane Variables. In advance the user has to create a user field. Then the user has to choose Type 'Input Field' and has to select the corresponding created user variable.<br /> [[Image:Dialog-user-field-input.png|1000px|center|dialog to create User Variable and a corresponding User Variable Text Input Field]]<br /> <br /> <br /> ==== Simple Variable Input Field ====<br /> This is a field to prompt the user to set the value of a simple variable. The value of a simple variable at a certain document position equals the value of the last set value - that is the difference to a user variable.<br /> <br /> In ODF such a field is represented by ODF element <text:variable-input>.<br /> <br /> For the Microsoft Word binary file format import/export filter these Simple Variable Input Fields are mapped to Microsoft Word ASK fields.<br /> <br /> The user interface to create such a field is found in the Fields dialog on pane Variables. In advance the user has to create a simple variable. Then the user has to choose Type 'Input Field' and has to select the corresponding created simple variable.<br /> [[Image:Dialog-variable-input.png|1000px|center|dialog to create Simple Variable and a corresponding Simple Variable Text Input Field]]<br /> <br /> <br /> == Changes in detail ==<br /> <br /> <br /> == Areas affected by the changes ==</div>

Od https://wiki.openoffice.org/w/index.php?title=Writer/Input_Fields&diff=232152 Writer/Input Fields 2013-11-06T11:05:55Z

<p>Od: </p> <hr /> <div>{{Writer Project|Category=Writer/Effort}}<br /> <br /> = In-place editing of Input Fields =<br /> <br /> Purpose of this page is provide information on the solution for {{Bug|33737}}. This information should serve the corresponding quality assurance efforts. It can be also used as the source for the corresponding user interface changes for the users.<br /> <br /> <br /> == Input Fields - three of a kind ==<br /> We have three fields which are all named 'Input Field' in the user interface each for different purpose.<br /> <br /> ==== Text Input Field ====<br /> This is a field to prompt the user for an input. The field has a description and its content holds the user's input.<br /> <br /> In the OpenDocument file format (ODF) such a field is represented by ODF element <text:text-input>.<br /> <br /> When importing Microsoft Word documents (binary file format, *.doc) Microsoft Word fields FILLIN and FORMTEXT are imported as Text Input Fields.<br /> <br /> The user interface to create such a field is found in the Fields dialog (Menu - Insert - Fields - Others) on pane Functions. Here the user has to choose Type 'Input Field'.<br /> [[Image:Dialog-text-input.png|500px|center|dialog to create Text Input Field]]<br /> <br /> <br /> ==== User Variable Input Field ====<br /> This is a field to prompt the user to set the value of a user variable. The value of a user variable is the same throughout the complete document.<br /> <br /> In ODF such a field is represented by ODF element <text:user-field-input>.<br /> <br /> Microsoft Word has support for so-called Document Variables. The value of such variables can be shown in a Microsoft Word document, but are created/deleted/set via Microsoft Word macro (aka Visual Basic). These Document Variables seem to be comparable with ODF's User Variables, but currently there is no mapping between these in OpenOffice.<br /> A User Variable Input Field is treated as Text Input Field when exporting an OpenOffice text document to the Microsoft Word binary format.<br /> <br /> The user interface to create such a field is found in the Fields dialog on pane Variables. In advance the user has to create a user field. Then the user has to choose Type 'Input Field' and has to select the corresponding created user variable.<br /> [[Image:Dialog-user-field-input.png|1000px|center|dialog to create User Variable and a corresponding User Variable Text Input Field]]<br /> <br /> <br /> ==== Simple Variable Input Field ====<br /> This is a field to prompt the user to set the value of a simple variable. The value of a simple variable at a certain document position equals the value of the last set value - that is the difference to a user variable.<br /> <br /> In ODF such a field is represented by ODF element <text:variable-input>.<br /> <br /> The user interface to create such a field is found in the Fields dialog on pane Variables. In advance the user has to create a simple variable. Then the user has to choose Type 'Input Field' and has to select the corresponding created simple variable.<br /> [[Image:Dialog-variable-input.png|1000px|center|dialog to create Simple Variable and a corresponding Simple Variable Text Input Field]]<br /> <br /> <br /> <br /> <br /> == Changes in detail ==<br /> <br /> == Areas affected by the changes ==</div>

Od https://wiki.openoffice.org/w/index.php?title=File:Dialog-variable-input.png&diff=232151 File:Dialog-variable-input.png 2013-11-06T10:43:49Z

<p>Od: OpenOffice dialog to create a Simple Variable and the corresponding Input Field</p> <hr /> <div>OpenOffice dialog to create a Simple Variable and the corresponding Input Field</div>

Od https://wiki.openoffice.org/w/index.php?title=Writer/Input_Fields&diff=232150 Writer/Input Fields 2013-11-06T10:33:49Z

<p>Od: </p> <hr /> <div>{{Writer Project|Category=Writer/Effort}}<br /> <br /> = In-place editing of Input Fields =<br /> <br /> Purpose of this page is provide information on the solution for {{Bug|33737}}. This information should serve the corresponding quality assurance efforts. It can be also used as the source for the corresponding user interface changes for the users.<br /> <br /> <br /> == Input Fields - three of a kind ==<br /> We have three fields which are all named 'Input Field' in the user interface each for different purpose.<br /> <br /> ==== Text Input Field ====<br /> This is a field to prompt the user for an input. The field has a description and its content holds the user's input.<br /> <br /> In the OpenDocument file format (ODF) such a field is represented by ODF element <text:text-input>.<br /> <br /> When importing Microsoft Word documents (binary file format, *.doc) Microsoft Word fields FILLIN and FORMTEXT are imported as Text Input Fields.<br /> <br /> The user interface to create such a field is found in the Fields dialog (Menu - Insert - Fields - Others) on pane Functions. Here the user has to choose Type 'Input Field'.<br /> [[Image:Dialog-text-input.png|500px|center|dialog to create Text Input Field]]<br /> <br /> <br /> ==== User Variable Input Field ====<br /> This is a field to prompt the user to set the value of a user variable. The value of a user variable is the same throughout the complete document.<br /> <br /> In ODF such a field is represented by ODF element <text:user-field-input>.<br /> <br /> The user interface to create such a field is found in the Fields dialog on pane Variables. In advance the user has to create a user field. Then the user has to choose Type 'Input Field' and has to select the corresponding created user field.<br /> [[Image:Dialog-user-field-input.png|1000px|center|dialog to create User Variable and a corresponding User Variable Text Input Field]]<br /> <br /> <br /> ==== Simple Variable Input Field ====<br /> <br /> ODF <text:variable-input><br /> <br /> <br /> == Changes in detail ==<br /> <br /> == Areas affected by the changes ==</div>

Od https://wiki.openoffice.org/w/index.php?title=File:Dialog-user-field-input.png&diff=232149 File:Dialog-user-field-input.png 2013-11-06T10:31:58Z

<p>Od: OpenOffice dialog to create a User Variable Input Field</p> <hr /> <div>OpenOffice dialog to create a User Variable Input Field</div>

Od https://wiki.openoffice.org/w/index.php?title=Writer/Input_Fields&diff=232148 Writer/Input Fields 2013-11-06T10:16:36Z

<p>Od: (checkpoint save)</p> <hr /> <div>{{Writer Project|Category=Writer/Effort}}<br /> <br /> = In-place editing of Input Fields =<br /> <br /> Purpose of this page is provide information on the solution for {{Bug|33737}}. This information should serve the corresponding quality assurance efforts. It can be also used as the source for the corresponding user interface changes for the users.<br /> <br /> == Input Fields - three of a kind ==<br /> <br /> We have three fields which are all named 'Input Field' in the user interface each for different purpose.<br /> <br /> ==== Text Input Field ====<br /> This is a field to prompt the user for an input. The field has a description and its content holds the user's input.<br /> <br /> In the OpenDocument file format (ODF) such a field is represented by ODF element <text:text-input>.<br /> <br /> When importing Microsoft Word documents (binary file format, *.doc) Microsoft Word fields FILLIN and FORMTEXT are imported as Text Input Fields.<br /> <br /> The user interface to create such a field is found in the Fields dialog (Menu - Insert - Fields - Others) on pane Functions. Here the user has to choose Type 'Input Field'.<br /> [[Image:Dialog-text-input.png|500px|center|dialog to create Text Input Field]]<br /> <br /> ==== User Variable Input Field ====<br /> This is a field to the value of a user variable<br /> ODF <text:user-field-input><br /> <br /> ==== Simple Variable Input Field ====<br /> <br /> ODF <text:variable-input><br /> <br /> <br /> == Changes in detail ==<br /> <br /> == Areas affected by the changes ==</div>

Od