dita — archive

[Mary McRae]

The email below contains the list of required changes before a public review can be announced.

Regards,

Mary



On May 27, 2010, at 12:42 AM, Mary McRae wrote:

Hi Kristen,

  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:

<2010-05-27_00.22.32.png>


<2010-05-27_00.23.44.png>



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.


Help file:
The help pages don't display: (and there's no block/unblock in the properties window)


<2010-05-27_00.35.09.png>



And I need a namespace document.

I think that's everything.

Regards,

Mary






On May 26, 2010, at 7:08 AM, Kristen James Eberlein wrote:



Mary, I know that you need an official e-mail from
Don. But might you be able to get started looking at the spec? If there
are things we need to change, please let me know ASAP.


Minutes recording decision:
http://www.oasis-open.org/committees/download.php/37961/DitaTcMeeting-2010-05-25.txt


XHTML: http://www.oasis-open.org/committees/download.php/37933/DITA1.2-spec-xhtml.zip


CHM: http://www.oasis-open.org/committees/download.php/37932/DITA1.2-spec-chm.zip
PDF: http://www.oasis-open.org/committees/download.php/37938/dita1.2-spec.pdf

DITA source: http://www.oasis-open.org/committees/download.php/37937/dita1.2-spec.zip


Best,


Kris


Kristen James Eberlein

Principal consultant, Eberlein Consulting

Secretary, OASIS DITA Technical Committee

Charter member, OASIS DITA Adoption Committee

www.eberleinconsulting.com

+1 919 682-2290; keberlein (skype)