OASIS Mailing List ArchivesView the OASIS mailing list archive below
or browse/search using MarkMail.


Help: OASIS Mailing Lists Help | MarkMail Help

dita message

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]

Subject: Model Document for Darwin Information Typing Architecture (DITA) Version 1.3

Per the TC's submission request [1], please find the attached model document for: 
Darwin Information Typing Architecture (DITA) Version 1.3
WP-abbrev: dita

****** begin special DITA information ******
This model document (in .DOC format) demonstrates the expected appearance of the display formats (HTML and PDF) of the "front matter" of the Committee Specification Draft 01 level of DITA v1.3.

IMPORTANT NOTE:  Although this appears similar to the earlier OASIS publication format used in DITA v1.2, there are a number of very significant differences in the "front matter". Please follow this model carefully.  It's probably better to cut/paste paragraphs from this document than to attempt to modify the older front page text.

Some major changes:
- ALL of the DITA components (dtds, etc) will be listed in the "Additional artifacts" section (NOT in "Related work")
- Directory structure: the directory structure will follow the Naming Directives [4], so there is a new "dita" directory below the first "dita" directory; there is no separate "spec" directory under the stage directory (i.e., csd01)
- We would like to capture the "source" DITA material (xml ?) which is used to create the published display documents, and cite it on the front page (probably in Additional artifacts; alternatively as an entry in "This version")
- New "Citation format" section

Some minor changes:
- Section headings in front matter use sentence case (only capitalize first word).
- new text in all of the "Status" paragraphs
- new text in "Notices"
- footer format slightly different
- no "Declared XML Namespace" section, unless needed
- for the PDF version, please set the "title" property to "Darwin Information Typing Architecture (DITA) Version 1.3", if possible

As a working approach for the initial publication, please send the final draft HTML and PDF to us (Chet & Paul) for review before the TC holds an approval ballot, to avoid having to repeat the approval ballot.

Some of the usual "boilerplate" instructions below may not apply...
****** end special DITA information ******

When the TC first votes [6] to publish this Work Product in the OASIS Library, we expect it to be published at:
The permanent "Latest version" URI will be:

Please let me know if anything here fails to meet your expectations.
Further revisions to this Work Product must be maintained in Working Drafts, following procedures detailed in the OASIS TC Administration How-to Guide [2].
Working Drafts should be made available by uploading the document(s) to the TC's Kavi document repository, or (provisionally/temporarily) to the TC's Subversion (SVN) repository, if SVN has been activated for your TC [3].  TCs are encouraged to use ZIP packaging when the WD releases contain multiple files (and directories).

For each WD revision, you will need to:
1) increment the Working Draft revision (number) from 01 to 02, 03, 04 etc., as successive Working Drafts are produced; the revision number needs to be updated at the top of the document in the stage identifier (Working Draft ##) and in the document identifier within the page footer.

2) supply the relevant publication/release/upload date for each successive Working Draft instance, using the  prescribed date format: DD Month YYYY; the date needs to be updated at the top of the document (just below the stage identifier, Working Draft ##) and in the page footer.

3) provide suitable text for a document Abstract, updating this summary with successive revisions to provide an accurate description of the subject matter, goals, scope, etc.

4) keep the Acknowledgments (Appendix A) and Revision History (Appendix C) up-to-date with each WD revision.

5) consult the OASIS Naming Directives document when creating new artifacts that may be part of the Work Product (e.g., image files, XML schemas), observing the rules for name characters in files and proposed directories, and for proposed URIs/namespaces [4].

6) examine the instructions for construction of XML Namespace Identifiers (namespace URIs) and Namespace Documents [5] if your specification declares one or more XML namespaces or other namespace-related identifiers for (e.g.,) link relations, named properties, functions, dialects, faults, actions, or any named message types.  All such identifiers, if HTTP-scheme, must begin with: http://docs.oasis-open.org/[tc-shortname]/ns/xxxx

When the TC votes [6] to approve a Working Draft as a Committee Draft (CSD or CND), the Chair or other designated person must submit a "Committee Specification Draft Creation and Upload Request" accessible on the TC Administration Requests Page [7].  

Upon receipt of this form, the TC Administrator will QC and process the Work Product for official publication in the OASIS Library (http://docs.oasis-open.org/) as a Committee Draft, including addition of the requisite cover page metadata and other boilerplate information.

=========== References:
[1] https://tools.oasis-open.org/issues/browse/TCADMIN-2095
[2] Developing Committee Specifications and Notes
    Starting a Working Draft
[3] SVN Version control, via Tools
[4] OASIS Naming Directives
[5] OASIS Naming Directives - Namespace Identifiers and Namespace Documents
[6] Approval of a WD as a CD (CSD or CND)
[7] TC Administration Requests Page, see Committee Specification Draft Creation / Upload Request

Best wishes,
Paul Knight  - Tel: +1 781-861-1013
OASIS - Advancing open standards for the information society
Document Process Analyst

Attachment: dita-v1.3-csd01.doc
Description: MS-Word document

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]