Hi all,
one minor correction, and maybe an explanatory comment or two.. (in-line below)
On Tue, Jun 23, 2015 at 4:15 PM, Chet Ensign <> wrote:
Hi Kris -
I don't really think a Webex is needed. This looks really good. Paul and I both went over the files and here is a compilation of our notes - but this is all tweaks and a tiny bit of moving around on the cover page. Overall, this package looks like it works just fine.
Here's our notes:
General comment on csprd01. The main things that have to change to produce the csprd copy is...
"Committee Specification Draft 01 /
Public Review Draft 01"
Change "csd01" to "csprd01" - probably applies across the board
In the Citation format, it becomes "OASIS Committee Specification Draft 01 / Public Review Draft 01"
DITA Part 0: Overview
1. Under the This version and Latest version links, remove the links to the .zip links. The place to list those is under the Additional artifacts section. I suggest putting it as the final bullet on that list, something like:
- ZIP file containing complete contents of this Part. http://docs.oasis-open.org/dita/dita/v1.3/csd01/dita-v1.3-csd01-part0-overview-dita.zip
You could also list the CHM ZIP file the same way.
Also, it looks like the filename isn't dita-v1.3-csd01-part0-overview-dita.zip but rather -xhtml.zip. At least in the files I'm looking at right now.
PK: It looks like the -xhtml.zip file is intended as a downloadable instance of the document in HTML format, for user convenience. This is not a problem as far as I can see - seems helpful. I would recommend changing the name of the ZIP file to terminate as html.zip, since it contains no .xhtml files.
This file should also be noted under the "Additional artifacts" section, with an identifying line something like:
- ZIP file containing full version of this document in .html format. http://docs.oasis-open.org/dita/dita/v1.3/csd01/dita-v1.3-csd01-part0-overview-html.zip
(I believe Kris noted that the actual DITA text ZIP files are not included in this review package.)
- one further note - there is no need to list the "Latest version" of the ZIP files
2. The Latest version links should be to
http://docs.oasis-open.org/dita/dita/v1.3/dita-v1.3-part0-overview.html and .pdf
Those will be the symlink files we put at the v1.3/ directory level that will remain constant as the spec advances.
PK: (note these are constructed in each case by removing the "csd01" strings along with the preceding "/" or "-".)
3. Technical "Committee" should use a capital C. Also, we do the link as http://www.oasis-open.org/committees/dita/.
PK: Actually should be: https://www.oasis-open.org/committees/dita/, using secure http.
4. Under Editors, "IBM" should link to the company website
5. Under Status, end of the first paragraph, the link to ...dita#technical/ needs to lose the final "/" - it breaks the link. ...dita#technical - will take the reader directly to the technical work section of your front page.
6. Next paragraph, the words "Send a Comment" should be linked to https://www.oasis-open.org/committees/comments/index.php?wg_abbrev=dita
7. The Latest version link in the Citation format block should change just as the one above changes.
PK: "above" refers to the one listed under "Latest version"
8. The copyright line under Notices - the (r) after OASIS should be removed and the word Open put in its place.
9. The Notices page also uses our old hyperlinks. It should use https://www.oasis-open.org/policies-guidelines/trademark and https://www.oasis-open.org/
10. For the copyright in the footers generally just use '2015' - not multiple years.
11. PDF should have a footer on the first page as well as subsequent pages.
- Part 1: Base Edition
1. Same note above on relocating the ZIP file links and descriptions. The other comments above also look like they apply
2. In the PDF file, the footer filename starts with "WP-" - that shouldn't be there.
PK: this also needs to be changed in the Overview
Part 2 and Part 3 - just the same feedback from above.
Let me know if you want to talk about this at all but basically you are really close.
/chet
On Mon, Jun 22, 2015 at 10:13 AM, Kristen James Eberlein <> wrote:
Thanks, Chet. Let me know if you want me to set up a WebEx session
in which to go over your feedback.
Best,
Kris
Kristen James Eberlein
Chair, OASIS DITA Technical Committee
Principal consultant, Eberlein Consulting
www.eberleinconsulting.com
+1 919 682-2290; kriseberlein (skype)
On 6/22/2015 9:46 AM, Chet Ensign
wrote:
Good morning Kris,
We'll have a look at it today and send you feedback.
/chet
On Sun, Jun 21, 2015 at 9:35 PM,
Kristen James Eberlein <>
wrote:
Hi, Chet.
Below is a link to a ZIP in Kavi which the DITA TC would
like you to look over. We'd like to know if there are
issues with file naming or style sheets that we need to
address swiftly. Again, our plan is to approve csdo1 and
csprd01 on 30 June.
Here are the problems with the master ZIP of which I am
aware:
It lacks the ZIPs for the edition-specific grammar
files and DITA source. We expect to add them to a
revision of the master ZIP tomorrow.
The ZIP files for the CHMs include a readme that is
named "DITA1.2-spec-chm-readme.txt"; it should be
"DITA-spec-chm-readme.txt".
On the cover pages, the entry [DITA-v1.3-part0-overview]
within the "Citation format" section needs to be
aligned with the text that follows it.
Please let us know ASAP if there are other additional
changes that we need to make.
Again, we really, really, really want to approve the
the csdo1 and csprd01 on 30 June ...
As always, thanks for your prompt help and
encouragement.
Best,
Kris
Kristen James Eberlein
Chair, OASIS DITA Technical Committee
Principal consultant, Eberlein Consulting
www.eberleinconsulting.com
+1 919 682-2290;
kriseberlein (skype)
-------- Forwarded Message --------
Subject:
[dita] Groups - csd01 for OASIS inspection
uploaded
Date:
Sun, 21 Jun 2015 18:02:10 -0700 (PDT)
From:
Kristen Eberlein <>
To:
Document Name:
csd01 for OASIS inspection
Description
Contains the four parts with each of the
following output formats (lacks
source and grammar ZIPs):
* XHTML
* CHM (in ZIP file)
* PDF
* XHTML (in ZIP file for ease of download)
Download Latest Revision
Public Download Link
Submitter: Kristen
Eberlein
Group: OASIS Darwin Information
Typing Architecture (DITA) TC
Folder: Drafts
Date submitted: 2015-06-21
18:01:53
--
/chet
----------------
Chet Ensign
Director of Standards Development and TC Administration
OASIS: Advancing open standards for the information
society
http://www.oasis-open.org
Primary: +1 973-996-2298
Mobile: +1 201-341-1393
---------------------------------------------------------------------
To unsubscribe from this mail list, you must leave the OASIS TC that
generates this mail. Follow this link to all your TCs in OASIS at:
https://www.oasis-open.org/apps/org/workgroup/portal/my_workgroups.php
--
/chet
----------------
Chet Ensign
Director of Standards Development and TC Administration
OASIS: Advancing open standards for the information society
http://www.oasis-open.org
Primary: +1 973-996-2298
Mobile: +1 201-341-1393
--
Paul Knight - Tel: +1 781-861-1013
OASIS - Advancing open standards for the information society
Document Process Analyst
