Details

    • Type: New Feature
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: ODF 1.2 Part 1 CD 4
    • Fix Version/s: ODF 1.3
    • Labels:
      None
    • Proposal:
      Hide

      Propose the following changes to ODF 1.2 part 1:

      I.

      <quote>

      2.2.3 OpenDocument Text Document

      An OpenDocument Text document shall meet all requirements of a Conforming OpenDocument Document, as well as the following additional requirements:

      A) The <office:document> element shall have an office:mimetype attribute with one of these values: "application/vnd.oasis.opendocument.text", "application/vnd.oasis.opendocument.text-template" or "application/vnd.oasis.opendocument.text-master".

      B) If the document is an OpenDocument package then it shall contain a file named mimetype containing one of these strings: "application/vnd.oasis.opendocument.text", "application/vnd.oasis.opendocument.text-template" or "application/vnd.oasis.opendocument.text-master".

      </quote>

      For both A) and B) items, replace:

      or "application/vnd.oasis.opendocument.text-master".

      With:

      , "application/vnd.oasis.opendocument.text-master" or "application/vnd.oasis.opendocument.text-master-template".

      II.

      <quote>

      19.806 text:global (deprecated)

      The text:global attribute is deprecated in favor of the application/vnd.oasis.opendocument.text-master MIME type. Using this MIME type for a document has the same effect as the value true for a text:global attribute.

      </quote>

      Propose not to mention the new type here, leave this as it is, since it is deprecated anyway, do not allow to use this attribute on a master document template.

      III.

      <quote>

      Appendix C. MIME Types and File Name Extensions (Non Normative)

      [...]

      Table 25 - Registered MIME types

      [...]

      application/vnd.oasis.opendocument.text-master
      odm
      Global Text document. See section 19.806.

      </quote>

      Following the row quoted above, insert a row with values:

      application/vnd.oasis.opendocument.text-master-template
      otm
      Global Text document used as template

      Show
      Propose the following changes to ODF 1.2 part 1: I. <quote> 2.2.3 OpenDocument Text Document An OpenDocument Text document shall meet all requirements of a Conforming OpenDocument Document, as well as the following additional requirements: A) The <office:document> element shall have an office:mimetype attribute with one of these values: "application/vnd.oasis.opendocument.text", "application/vnd.oasis.opendocument.text-template" or "application/vnd.oasis.opendocument.text-master". B) If the document is an OpenDocument package then it shall contain a file named mimetype containing one of these strings: "application/vnd.oasis.opendocument.text", "application/vnd.oasis.opendocument.text-template" or "application/vnd.oasis.opendocument.text-master". </quote> For both A) and B) items, replace: or "application/vnd.oasis.opendocument.text-master". With: , "application/vnd.oasis.opendocument.text-master" or "application/vnd.oasis.opendocument.text-master-template". II. <quote> 19.806 text:global (deprecated) The text:global attribute is deprecated in favor of the application/vnd.oasis.opendocument.text-master MIME type. Using this MIME type for a document has the same effect as the value true for a text:global attribute. </quote> Propose not to mention the new type here, leave this as it is, since it is deprecated anyway, do not allow to use this attribute on a master document template. III. <quote> Appendix C. MIME Types and File Name Extensions (Non Normative) [...] Table 25 - Registered MIME types [...] application/vnd.oasis.opendocument.text-master odm Global Text document. See section 19.806. </quote> Following the row quoted above, insert a row with values: application/vnd.oasis.opendocument.text-master-template otm Global Text document used as template
    • Resolution:
      Hide

      [see proposal]

      Show
      [see proposal]

      Description

      Copied from office-comment list

      Original author: ronnie thebonnie <ronniethebonnie@gmail.com>
      Original date: 28 Feb 2010 14:38:08 -0000
      Original URL: http://lists.oasis-open.org/archives/office-comment/201002/msg00042.html

        Attachments

          Activity

          Hide
          michael.brauer Michael Brauer (Inactive) added a comment -

          Feature request. Adapted target to ODF-Next (was ODF 1.2 part 1 cd4)

          Show
          michael.brauer Michael Brauer (Inactive) added a comment - Feature request. Adapted target to ODF-Next (was ODF 1.2 part 1 cd4)
          Hide
          mstahl Michael Stahl (Inactive) added a comment -

          For the curious, i'll paste the requirement / motivation that led to the implementation of this feature in LO, written by Máirín Duffy:

          So one of the teams I work with uses LibreOffice extensively for managing and laying out content for our products. There's different types of documents that are common across products; FAQs, data sheets, brochures, technical specifications, etc. Now, if the situation were just that simple, we could make ODT templates (*.ott) and have a template for each type with all of the graphics and layout we want for each type, so when the product marketing person for a given product wants to produce, say, a data sheet for their product, they can grab the *.ott we produced and fill in the filler text with details about their product and be set.

          However. The situation is a bit more complex than that. Within each product, this suite of documents - brochures, datasheets, etc. - have repeated information. For example, both the data sheet and the brochure might have the same long form basic description of the product. The FAQ and technical spec might have the same short form basic product description. The FAQ might have some basic questions that are also in the brochure. The data sheet might have a feature list that is also repeated in the brochure. The product marketing person wants to be able to update these kinds of details as the product evolves, features are added, etc., without having to update the same text across multiple individual documents. So we use master documents (*.odm) for all of these document types - the master document pulls in the shared text assets (e.g., short form product description, long form product description, feature list, etc.) so that when the product marketing person updates the feature list, they can re-export all of the documents that use it and LibreOffice automatically updates the text across all documents that use it to the new version.

          The problem, though, using these master document files is more of a pain because you can't access them via the templates menu in LibreOffice. So all of the nice UI around creating a new document didn't apply to them because they didn't have an official template format. To be able to use them, you had to know where they are on the file system or have to dig around for them. *.odm is also not so common (even though they are useful and they rock ) so some folks might not even recognize them as the document they need to edit.

          So this new feature allows you to create new documents using pre-created *.otm files as a template with all the facilites the LO UI provides to templates. This is a big win because setting up master documents can be a real pain. This will also enable the sharing of master documents template, which would be really nice. You could put together a suite of related assets like we use at Red Hat and make it a downloadable set of templates.

          Show
          mstahl Michael Stahl (Inactive) added a comment - For the curious, i'll paste the requirement / motivation that led to the implementation of this feature in LO, written by Máirín Duffy: So one of the teams I work with uses LibreOffice extensively for managing and laying out content for our products. There's different types of documents that are common across products; FAQs, data sheets, brochures, technical specifications, etc. Now, if the situation were just that simple, we could make ODT templates (*.ott) and have a template for each type with all of the graphics and layout we want for each type, so when the product marketing person for a given product wants to produce, say, a data sheet for their product, they can grab the *.ott we produced and fill in the filler text with details about their product and be set. However. The situation is a bit more complex than that. Within each product, this suite of documents - brochures, datasheets, etc. - have repeated information. For example, both the data sheet and the brochure might have the same long form basic description of the product. The FAQ and technical spec might have the same short form basic product description. The FAQ might have some basic questions that are also in the brochure. The data sheet might have a feature list that is also repeated in the brochure. The product marketing person wants to be able to update these kinds of details as the product evolves, features are added, etc., without having to update the same text across multiple individual documents. So we use master documents (*.odm) for all of these document types - the master document pulls in the shared text assets (e.g., short form product description, long form product description, feature list, etc.) so that when the product marketing person updates the feature list, they can re-export all of the documents that use it and LibreOffice automatically updates the text across all documents that use it to the new version. The problem, though, using these master document files is more of a pain because you can't access them via the templates menu in LibreOffice. So all of the nice UI around creating a new document didn't apply to them because they didn't have an official template format. To be able to use them, you had to know where they are on the file system or have to dig around for them. *.odm is also not so common (even though they are useful and they rock ) so some folks might not even recognize them as the document they need to edit. So this new feature allows you to create new documents using pre-created *.otm files as a template with all the facilites the LO UI provides to templates. This is a big win because setting up master documents can be a real pain. This will also enable the sharing of master documents template, which would be really nice. You could put together a suite of related assets like we use at Red Hat and make it a downloadable set of templates.
          Hide
          mstahl Michael Stahl (Inactive) added a comment -

          As discussed in the TC call today, this requires not just changing the specification,
          also the new MIME Type needs to be registered with IANA.

          Show
          mstahl Michael Stahl (Inactive) added a comment - As discussed in the TC call today, this requires not just changing the specification, also the new MIME Type needs to be registered with IANA.
          Hide
          robincover Robin Cover (Inactive) added a comment -

          Robin Cover (OASIS Staff member who handles IANA/ICANN registrations on behalf of OASIS TCs) was contacted by Rob Weir, to coordinate with principals in the OpenDocument TC on this issue [ https://issues.oasis-open.org/browse/OFFICE-2580 ], originally created in 2010. Possible new media type registration, per Michael Stahl and a TC discussion on 2015-03-02. Email: robin@oasis-open.org

          Show
          robincover Robin Cover (Inactive) added a comment - Robin Cover (OASIS Staff member who handles IANA/ICANN registrations on behalf of OASIS TCs) was contacted by Rob Weir, to coordinate with principals in the OpenDocument TC on this issue [ https://issues.oasis-open.org/browse/OFFICE-2580 ], originally created in 2010. Possible new media type registration, per Michael Stahl and a TC discussion on 2015-03-02. Email: robin@oasis-open.org
          Hide
          mstahl Michael Stahl (Inactive) added a comment -

          as discussed in TC call today:

          • no objections, moving issue to resolved
          • application in drafts should wait until we know status of IANA registration
          Show
          mstahl Michael Stahl (Inactive) added a comment - as discussed in TC call today: no objections, moving issue to resolved application in drafts should wait until we know status of IANA registration
          Hide
          owittmann Oliver-Rainer Wittmann (Inactive) added a comment -

          A corresponding communication between Rob and Robin regarding the MIME type registration took place.
          Patrick and myself are on CC on the final message from Robin.
          Short summary: OASIS staff takes care of the intrinsic registration, while the TC works on the technical details.

          Show
          owittmann Oliver-Rainer Wittmann (Inactive) added a comment - A corresponding communication between Rob and Robin regarding the MIME type registration took place. Patrick and myself are on CC on the final message from Robin. Short summary: OASIS staff takes care of the intrinsic registration, while the TC works on the technical details.
          Hide
          patrick Patrick Durusau added a comment -

          Applied in OpenDocument-v1.3-wd04-part3-documents.

          Notice that "vnd.oasis.opendocument" in Annex C is actually a user defined field? In order to match the display of the others, have to insert it as a field.

          Show
          patrick Patrick Durusau added a comment - Applied in OpenDocument-v1.3-wd04-part3-documents. Notice that "vnd.oasis.opendocument" in Annex C is actually a user defined field? In order to match the display of the others, have to insert it as a field.

            People

            • Assignee:
              michaelst Michael Stahl [X] (Inactive)
              Reporter:
              rcweir Robert Weir (Inactive)
            • Watchers:
              4 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: