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

 


Help: OASIS Mailing Lists Help | MarkMail Help

dita-adoption message

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


Subject: Re: [dita-adoption] Starter Document for Content Badging in DITA Version 1.0


Hi all,

Yes, this appearance of Version number conflict can arise for titles, especially when a document refers to another specification with its own Version.

I've seen at least three ways to address it:

- Simplest:Â DITA Content Badging Version 1.0
- Use the same version number as the main specification: Content Badging in DITA Version 1.3
- Arrange wording to accommodate both version numbers: DITA v1.3 Content Badging Version 1.0Â (or DITA 1.3 Content Badging Version 1.0)

If the structures used in content badging are not really specific to DITA v1.3, i.e, they would likely be used for DITA 1.4, 2.0, etc), then the first suggestion seems best.

We do not allow the use of commas in the title, so Nancy's initial proposal would not work...

It is possible/easy to change the title a bit when the Working Draft is first submitted for publication. (Not possible after first publication.)

I hope this helps a bit...Â

Best regards,
Paul

On Mon, Apr 29, 2019 at 7:19 PM Magliery Tom <tom.magliery@justsystems.com> wrote:
I'm guessing this title means "Version 1.0" of "Content Badging in DITA", but clearly there is an ambiguity problem to address here.

mag



On Mon, Apr 29, 2019 at 4:15 PM Nancy Harrison <nharrison@infobridge-solutions.com> wrote:
Shouldn't the title be "Content Badging in DITA 1.3, Version 1.0"?

Otherwise it looks like the content refers to DITA 1.0, which it presumably will not.

Nancy Harrison
member, DITA Adoption TC
Sec'y, DITA TC

_____________
Nancy Harrison
Infobridge SolutionsÂ
nharrison@infobridge-solutions.com


On Mon, Apr 29, 2019 at 12:59 PM Paul Knight <paul.knight@oasis-open.org> wrote:
Per the TC's submission request [1], please find the attached starter document for:
Content Badging in DITA Version 1.0
WP-abbrev: content-badging

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 Github or Subversion (SVN) repository, if it 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: https://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 (https://docs.oasis-open.org/) as a Committee Draft, including addition of the requisite cover page metadata and other boilerplate information.

=========== References:
[2] Developing Committee Specifications and Notes
Starting a Working Draft
[3] Github and 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
--
Paul Knight....Document Process Analyst...mobile: +1 781-883-1783
OASIS - Advancing open standards for the information society

---------------------------------------------------------------------
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


--
Paul Knight....Document Process Analyst...mobile: +1 781-883-1783
OASIS - Advancing open standards for the information society


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