From Chet and Paul: List of all edits to bring XDI Core 1.0 Working Draf

Subject: From Chet and Paul: List of all edits to bring XDI Core 1.0 Working Draft 06 up to CSD01

See the two messages below. We'll go over this on tomorrow's TC call.

=Drummond

---------- Forwarded message ----------
From: Paul Knight <paul.knight@oasis-open.org>
Date: Wed, Nov 25, 2015 at 2:33 PM
Subject: Re: Edits to bring XDI up to CSD01
To: Chet Ensign <chet.ensign@oasis-open.org>
Cc: joseph.boyle@xdi.org, Drummond Reed <drummond@respectnetwork.com>, Markus Sabadello <markus.sabadello@xdi.org>

Hi all,

Minor fiddles:

in the Citation format, please use :

<bold>[XDI-Core-v1.0]</> (lower case "v")

<ital>XDI Core Version 1.0</>. (use whole word "Version", to match the official title) the rest looks fine....

well, why not fiddle one more time: for the "Acknowledgements section", unless you have a preponderance of British or Canadian English speakers, please use "Acknowledgments" (drop the "e")

Happy Thanksgiving!

Best regards,

Paul

On Wed, Nov 25, 2015 at 4:31 PM, Chet Ensign <chet.ensign@oasis-open.org> wrote:

Hi Joseph,

I started work on the XDI CSD. I've gone over the approved spec. Here are the changes to make please to publish this as a Committee Spec Draft. I've linked to a good example for comparison at the end of the list. Please let me know if you have any questions on any of this.

- Change file names to 'xdi-core-v1.0-csd01'

- Change 'Working Draft 06' to 'Committee Specification Draft 01'

- Change date from '19 October 2015' to '29 October 2015'

- Change urls in This version from 'http://docs.oasis-open.
org/xdi/spec-1.0/xdi-core-1.0-wd06' to 'http://docs.oasis-open.org/xdi/core/v1.0/csd01/xdi-core-v1.0-csd01'

- Replace links under Previous version with 'N/A'

- Change urls in Latest version from 'http://docs.oasis-open.org/xdi/spec/xdi-core' to 'http://docs.oasis-open.org/xdi/core/v1.0/xdi-core-v1.0'

- Under Technical Committee, change 'OASIS XDI TC' to 'OASIS XRI Data Interchange (XDI) TC'. Link it to 'https://www.oasis-open.org/committees/xdi/'

- After Technical Commmittee, add a new section labelled 'Chairs:'. Use the same format as for the other headings. Below that, put:

Drummond Reed (drummond@respectnetwork.net), Respect Network
Markus Sabadello (markus.sabadello@xdi.org), XDI.ORG

For each of these entries, make the email addresses mailto links and link the organization name to its main web site

- Under editors, link the organization names to the main websites.

- Under Additional artifacts, under the sentence that starts with 'This prose specification...' put a bulleted item

* ABNF file: http://docs.oasis-open.org/xdi/core/v1.0/csd01/abnf/xdi-core-abnf-v1.0.txt (We recommend keeping wd#s off machine readable files.

- Remove the empty 'Related work' heading.

- Under 'Abstract' remove the first sentence starting with 'This working draft...'

- Under Citation Format, under the sentence beginning with "When referencing this..." put (formatted as indicated by the <>s)

<bold>[XDI-Core-V1.0]</>
<ital>XDI Core V1.0</>. Edited by Joseph Boyle, Drummond Reed, and Markus Sabadello. 29 October 2015. OASIS Committee Specification Draft 01. <a>http://docs.oasis-open.org/xdi/core/v1.0/csd01/xdi-core-v1.0-csd01.html</>. Latest version: <a>http://docs.oasis-open.org/xdi/core/v1.0/xdi-core-v1.0.html</>.

- Above the table of contents, put 'Table of Contents' in the same font and color as the section label 'Notices' above.

- On the PDF, remove the header. Change the footer to read:

<left side>xdi-core-v1.0-csd01 <right side>29 October 2015
<left side>Standards Track Work Product <center>Copyright © OASIS Open 2015. All Rights Reserved. <right side>Page 1 of ##

- Under 1.5 Normative References, please change the references to documents that don't yet exist: XDI-Messageing, XDI-Binding, XDI-Discovery, XDI-Policy, and XDI-Privacy.

I see why you want to include them - you refer to them elsewhere in the spec. To hold their places in section 1.5, I'd prefer to see them done this way:

[OASIS-XDI-Messaging-V1.0] <ital>OASIS XDI 1.0 Messaging Specification</>. TC work in progress. Not yet published.

That way, the spec doesn't appear to suggest that something has not yet been approved and published by the TC exists while holding your point of reference in the list.

- At the end of the document, add an Acknowledgements section. This can be Appendix A, B, whatever - in that section you should list all the active members of the TC. If there were people who participated earlier but are not now members of the TC, feel free to include them as well.

- At the very end of the document, please add an appendix with the Revision History. This are typically tables with the revision, the date, and the changes made.

For an example of another CSD01 to compare with (this one also published from XML) see Business Document Envelope Version 1.0 at http://docs.oasis-open.org/bdxr/bdx-bde/v1.0/csd01/bdx-bde-v1.0-csd01.html

Best -

/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-883-1783
OASIS - Advancing open standards for the information society - Document Process Analyst
Identity Ecosystem Steering Group - Framework Management Office

xdi message