Uploaded image for project: 'Technical Committee Administration'
  1. Technical Committee Administration
  2. TCADMIN-171

60-day Review Request for Darwin Information Typing Architecture (DITA) Version 1.2

    Details

    • Type: 60-day Public Review
    • Status: Closed
    • Priority: Major
    • Resolution: Applied
    • Component/s: 60-day Public Review
    • Labels:
      None

      Description

      The following request has been submitted to the OASIS TC Administrator on 16/06/2010:
      >
      >

      Submitter's Name
        Kristen James Eberlein
      TC Name
        Darwin Information Typing Architecture
      TC Email Address
        [1]dita@lists.oasis-open.org
      Specification Title
        Darwin Information Typing Architecture (DITA) Version 1.2
      Resources
        [2]http://www.oasis-open.org/apps/org/workgroup/dita/download.php/38308/DITA1.2-CD02.zip
      Approval Link
        [3]http://lists.oasis-open.org/archives/dita/201006/msg00127.html
      Abstract
        The Darwin Information Typing Architecture (DITA) 1.2 specification defines both a) a set of document types for authoring and organizing topic-oriented information; and b) a set of mechanisms for combining, extending, and constraining document types.
      Notes
        Please note that the minutes do not accurately reflect the TC decision. We have requested the following emendation:
      >
      > 7. ITEM: Vote on acceptance of CD for public review
      > http://lists.oasis-open.org/archives/dita/201006/msg00110.html
      >
      > Voting members on the TC call each were polled and each voted "Aye" to approve the most current version of the DITA 1.2 spec as a committee draft for submission to OASIS for public review. The CD will be named per OASIS naming policies. The document has been uploaded to Kavi in XHTML, CHM, PDF, and DITA source; the authoritative version (XHTML) that was voted on is located at http://www.oasis-open.org/committees/download.php/38289/DITA1.2-spec-xhtml.zip/DITA1.2-spec-html.zip
      >
      > Thank you for your request. We will schedule the QC review shortly. You can follow the progress at:
      > http://tools.oasis-open.org/issues/browse/TCADMIN
      >
      > The Standards Development team.
      ----------------------------------------------------------------------------------------
      [1] dita@lists.oasis-open.org
      [2] http://www.oasis-open.org/apps/org/workgroup/dita/download.php/38308/DITA1.2-CD02.zip
      [3] http://lists.oasis-open.org/archives/dita/201006/msg00127.html

        Attachments

          Activity

          Hide
          kim.goolsby Kim Goolsby (Inactive) added a comment - - edited

          sent 27 May:

          It looks like there's still a lot of white paper formatting happening rather than specification formatting.

          Specification URIs title is missing.
          Under This Version, please move the zips to the end and remove the note at the end of the DITA version. Include a readme.txt in the zip to let people know where to start.

          Under Latest Version, a URI must be provided corresponding to each 'this version' URI.

          In the Notices, please add "DITA" in the last paragraph (along with "OASIS")

          Structurally:
          Section 1 must include Terminology (including RFC 2119 language), Normative References, and Non-Normative References. This includes at least a normative reference to RFC 2119, and I'm guessing XML but maybe others as well. You can quickly view the formatting and citation here: http://docs.oasis-open.org/templates/OASISSpecificationTemplateV4.1.html

          Section 1.2 History should go in the Appendix Revision History

          Appendices must be labeled as such (and not as Section 5):
          Appendix A Acknowledgements
          Appendix B Change History
          Appendix C Migrating ...
          etc.

          PDF Version:

          cover page:
          hypertext links for specification URIs don't look like links (they are, but they should be blue/underlined)
          running footer:
          no rule
          left side:
          spec ID (DITA v1.2 CD01)
          copyright
          right side:
          approval date (dd month yyyy)
          Page # of #

          Notices and TOC starts a new page (same formatting as level 1 head)

          running header:
          no running header

          text in all sections (1 - # and Appendices A - z):
          should be flush left and not indented under section/subsection title

          Note much of the text in the tables is illegible or overset:

          All heads:
          Should match the color used for the title and headings on the cover page.

          Level 1 (Section) heads:
          There should be a rule at the top of the page (OASIS color)
          18pt bold Arial #66616D

          Level 2 heads (#.#)
          no rule
          14pt bold Arial #66616D

          Level 3 heads (#.#.#)
          13pt bold Arial #66616D

          Level 4 heads (#.#.#.#)
          12pt bold Arial #66616D

          Level 5 heads (#.#.#.#.#)
          12pt bold Arial #66616D

          Level 6 heads (#.#.#.#.#.#)
          11pt bold Arial #66616D

          Level 7 heads (#.#.#.#.#.#.#)
          11pt bold Arial #66616D

          Level 8 heads (#.#.#.#.#.#.#.#)
          11pt italic Arial #66616D

          Level 9 heads (#.#.#.#.#.#.#.#.#)
          11pt roman Arial #66616D

          HTML version:
          page footer:
          Please use DITA v1.2 CD01 instead of spec name as currently displayed

          section/subsection numbers:
          are missing

          'parent' pages:
          contain duplicated text

          Navigation Links:
          should also include 'previous' and 'next' rather than just 'parent topic' and 'previous topic'. For instance, if I'm at 2.1.1.1 I need to be able to get to 2.1.1.2 and should not have to go back to 2.1.1. 'next' should get me from beginning to end.

          Show
          kim.goolsby Kim Goolsby (Inactive) added a comment - - edited sent 27 May: It looks like there's still a lot of white paper formatting happening rather than specification formatting. Specification URIs title is missing. Under This Version, please move the zips to the end and remove the note at the end of the DITA version. Include a readme.txt in the zip to let people know where to start. Under Latest Version, a URI must be provided corresponding to each 'this version' URI. In the Notices, please add "DITA" in the last paragraph (along with "OASIS") Structurally: Section 1 must include Terminology (including RFC 2119 language), Normative References, and Non-Normative References. This includes at least a normative reference to RFC 2119, and I'm guessing XML but maybe others as well. You can quickly view the formatting and citation here: http://docs.oasis-open.org/templates/OASISSpecificationTemplateV4.1.html Section 1.2 History should go in the Appendix Revision History Appendices must be labeled as such (and not as Section 5): Appendix A Acknowledgements Appendix B Change History Appendix C Migrating ... etc. PDF Version: cover page: hypertext links for specification URIs don't look like links (they are, but they should be blue/underlined) running footer: no rule left side: spec ID (DITA v1.2 CD01) copyright right side: approval date (dd month yyyy) Page # of # Notices and TOC starts a new page (same formatting as level 1 head) running header: no running header text in all sections (1 - # and Appendices A - z): should be flush left and not indented under section/subsection title Note much of the text in the tables is illegible or overset: All heads: Should match the color used for the title and headings on the cover page. Level 1 (Section) heads: There should be a rule at the top of the page (OASIS color) 18pt bold Arial #66616D Level 2 heads (#.#) no rule 14pt bold Arial #66616D Level 3 heads (#.#.#) 13pt bold Arial #66616D Level 4 heads (#.#.#.#) 12pt bold Arial #66616D Level 5 heads (#.#.#.#.#) 12pt bold Arial #66616D Level 6 heads (#.#.#.#.#.#) 11pt bold Arial #66616D Level 7 heads (#.#.#.#.#.#.#) 11pt bold Arial #66616D Level 8 heads (#.#.#.#.#.#.#.#) 11pt italic Arial #66616D Level 9 heads (#.#.#.#.#.#.#.#.#) 11pt roman Arial #66616D HTML version: page footer: Please use DITA v1.2 CD01 instead of spec name as currently displayed section/subsection numbers: are missing 'parent' pages: contain duplicated text Navigation Links: should also include 'previous' and 'next' rather than just 'parent topic' and 'previous topic'. For instance, if I'm at 2.1.1.1 I need to be able to get to 2.1.1.2 and should not have to go back to 2.1.1. 'next' should get me from beginning to end.
          Hide
          mary-oasis Mary McRae (Inactive) added a comment -

          sent 17 June:

          It looks like some stuff didn't get updated to cd02.

          In the PDF version:

          1. This Version URIs: text on the cover is fine, but the actual hypertext links point to cd01

          2. Latest Version URIs: these are generic URIs that will be used to always access the most recent version of the spec. If you remove the cd02 subdir from the path it will be fine. Again, make sure the actual hypertext links are updated as well; they still point to cd01

          3. Namespace: this must be an actual hypertext link

          4. running footer: please add CD 02 to DITA v1.2

          COMMENT: Section 1.4 is great! Thank you for adding this.

          5. There are some rules showing up that seem to be tied to examples and should be removed; they appear to be tied to the heading below them.

          6. Each Appendix should start a new page; same styling as 1st level headings

          In the XHTML version:
          (in addition to the problems above)

          1. The first page doesn't have any navigation links on the bottom. Should at least have next.

          2. The footer on each of the HTML pages says CD 01

          3. The link back to the main page points to cd01

          In the DITA source version:
          (assume the same problems with hypertext links, URIs as in PDF)
          1. the main html spec file is in this directory; not sure why it's duplicated.

          In the CHM version:
          (same link and URI problems as in PDF)

          1. Same footer problem as XHTML

          I don't think any of these problems require anything other than updates to the front matter URI hypertext links and reprocessing so no additional ballots are required on the part of the TC; just a new distribution set.

          You don't need to do a new submission; just send an email with a link to the new zip.

          Show
          mary-oasis Mary McRae (Inactive) added a comment - sent 17 June: It looks like some stuff didn't get updated to cd02. In the PDF version: 1. This Version URIs: text on the cover is fine, but the actual hypertext links point to cd01 2. Latest Version URIs: these are generic URIs that will be used to always access the most recent version of the spec. If you remove the cd02 subdir from the path it will be fine. Again, make sure the actual hypertext links are updated as well; they still point to cd01 3. Namespace: this must be an actual hypertext link 4. running footer: please add CD 02 to DITA v1.2 COMMENT: Section 1.4 is great! Thank you for adding this. 5. There are some rules showing up that seem to be tied to examples and should be removed; they appear to be tied to the heading below them. 6. Each Appendix should start a new page; same styling as 1st level headings In the XHTML version: (in addition to the problems above) 1. The first page doesn't have any navigation links on the bottom. Should at least have next. 2. The footer on each of the HTML pages says CD 01 3. The link back to the main page points to cd01 In the DITA source version: (assume the same problems with hypertext links, URIs as in PDF) 1. the main html spec file is in this directory; not sure why it's duplicated. In the CHM version: (same link and URI problems as in PDF) 1. Same footer problem as XHTML I don't think any of these problems require anything other than updates to the front matter URI hypertext links and reprocessing so no additional ballots are required on the part of the TC; just a new distribution set. You don't need to do a new submission; just send an email with a link to the new zip.
          Hide
          mary-oasis Mary McRae (Inactive) added a comment -

          new files received 28 June http://www.oasis-open.org/committees/download.php/38474/DITA1.2-CD03.zip

          sent on 29 June:
          It appears that we've lost the links to the schema/dtd packages on the cover page; the previous iteration had underneath the supercedes section the related to section which listed the URIs for DTDs and Schemas (and needs to point to the current ones rather than the 1.1 versions):
          Related Work:
          This specification replaces or supercedes:
          OASIS DITA Version 1.1 Architectural Specification (http://docs.oasis-open.org/dita/v1.1/archspec/archspec.html)
          OASIS DITA Version 1.1 Language Specification (http://docs.oasis-open.org/dita/v1.1/langspec/ditaref-type.html)
          This specification is related to:
          OASIS DITA Version 1.1 DTDs (http://docs.oasis-open.org/dita/v1.1/OS/dtd/ditadtd.zip)
          OASIS DITA Version 1.1 Schemas (http://docs.oasis-open.org/dita/v1.1/OS/schema/ditaschema.zip)--

          In the HTML version, the previous link from Introduction goes to something called 'publication variables' rather than the cover page; although that page still has the DTDs/schemas shown but also the namespace and no TOC. It should link to the previous page in full. (apologies if I didn't catch that before?)

          In the DITA version, the related DTDs/Schemas are the 1.1 versions rather than the 1.2 but the namespace hasn't been removed. It also has the wrong URIs in both the this version and latest version, so I'm thinking that this wasn't the source used for the generation of the PDF and HTML. Is it possible that the wrong set of files were uploaded?

          In the CHM version, the same problem with the URIs for this/latest versions, missing DTD/Schema links and the publication variables page.

          I don't know if it's possible to just regenerate the front matter and replace those bits ...

          Show
          mary-oasis Mary McRae (Inactive) added a comment - new files received 28 June http://www.oasis-open.org/committees/download.php/38474/DITA1.2-CD03.zip sent on 29 June: It appears that we've lost the links to the schema/dtd packages on the cover page; the previous iteration had underneath the supercedes section the related to section which listed the URIs for DTDs and Schemas (and needs to point to the current ones rather than the 1.1 versions): Related Work: This specification replaces or supercedes: OASIS DITA Version 1.1 Architectural Specification ( http://docs.oasis-open.org/dita/v1.1/archspec/archspec.html ) OASIS DITA Version 1.1 Language Specification ( http://docs.oasis-open.org/dita/v1.1/langspec/ditaref-type.html ) This specification is related to: OASIS DITA Version 1.1 DTDs ( http://docs.oasis-open.org/dita/v1.1/OS/dtd/ditadtd.zip ) OASIS DITA Version 1.1 Schemas ( http://docs.oasis-open.org/dita/v1.1/OS/schema/ditaschema.zip)-- In the HTML version, the previous link from Introduction goes to something called 'publication variables' rather than the cover page; although that page still has the DTDs/schemas shown but also the namespace and no TOC. It should link to the previous page in full. (apologies if I didn't catch that before?) In the DITA version, the related DTDs/Schemas are the 1.1 versions rather than the 1.2 but the namespace hasn't been removed. It also has the wrong URIs in both the this version and latest version, so I'm thinking that this wasn't the source used for the generation of the PDF and HTML. Is it possible that the wrong set of files were uploaded? In the CHM version, the same problem with the URIs for this/latest versions, missing DTD/Schema links and the publication variables page. I don't know if it's possible to just regenerate the front matter and replace those bits ...

            People

            • Assignee:
              mary-oasis Mary McRae (Inactive)
              Reporter:
              mary-oasis Mary McRae (Inactive)
            • Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: