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: Re: [dita] Starter Document for DITA 1.3: Why Three editions? Version 1.0


Hi Kris,


On Mon, Aug 24, 2015 at 1:47 PM, Kristen James Eberlein <kris@eberleinconsulting.com> wrote:
Thanks, Paul. I built a DITA-OT plug-in to generate the document last night; it looks as if my assumptions were good. Questions:
  • Can you tell me what the requirements for margins (left, top, right, and bottom are?
Left and right margins are 1.25 inches; top and bottom are 1.0 inches  (This differs from the "Standards Track" margin settings.)
  • The first Word document that you sent us did not have the OASIS logo; the latest Word document does. Should the OASIS logo be on the cover page?
Yes - we leave the OASIS logo off the usual "Working Draft" template, then add it in the "Front Matter" template used during publication. The intent is to make it less likely that a pre-publication working draft will be mistaken for a Committee-approved publication. For DITA's purposes (since you are not working in MS-Word), I really should have sent you this "Front Matter" template, including the OASIS logo and URIs, as a starting point.  Sorry for not realizing that earlier!
  • The first Word document had the "status" of the document in the footer; the second Word document does not. Do you want it there? By status, I mean something like "Working Draft 01".
The footer (as well as the header) is omitted on the front page, but present on all the other pages.  If it is a problem skipping it on the front page, it will be okay to have it there.  Be sure to include the header notice ("This is a Non-Standards Track Work Product. The patent provisions of the OASIS IPR Policy do not apply.") on each page, since it is required by the TC Process.

Thanks again for your help; we really appreciate it.

Best,
Kris
My pleasure! 

Kristen James Eberlein
Chair, OASIS DITA Technical Committee
Principal consultant, Eberlein Consulting
www.eberleinconsulting.com
+1 919 682-2290; kriseberlein (skype)

On 8/24/2015 1:37 PM, Paul Knight wrote:
Hi Kris and all,

First, thanks to Tom for supplying the color codes:
"Purple sidebar: #3B006F
Goldish titles: #A1985A"

To help with the next two questions, I'm attaching a (MS-Word-based) mock-up of the final publication.  I've incorporated the alternative title we discussed, "Why Three Editions of DITA Version 1.3," along with the initial publication URIs appropriate for that structure. It refers to a ZIP file which will contain the DITA source.

And finally, yes, you can omit the "References (non-normative)" section if it is not needed.  I've included links to the individual Editions of DITA v1.3 in the "Related work" section on the front page, and you can refer to that section as (or if) needed.

Please let me know if you have any other questions as you proceed.

Best regards,
Paul

On Sun, Aug 23, 2015 at 10:03 AM, Kristen James Eberlein <kris@eberleinconsulting.com> wrote:
A few questions, Paul.
  • What are the hex color codes for colors used on the front page? In particular, for the side bar and and title and headers. I don't know how to determine this from the Word doc.
  • Since we author in DITA, we'll need to manage the list of "This" and "Latest" version. (No previous version?) Where do you want this information to be located? Inside of front page?
  • I assume that you will want a minimum of HTML, PDF, and DITA source.
  • If our only references are to the DITA spec, do we need the "References (non-normative)" section?
Best,
Kris

Kristen James Eberlein
Chair, OASIS DITA Technical Committee
Principal consultant, Eberlein Consulting
www.eberleinconsulting.com
+1 919 682-2290; kriseberlein (skype)

On 8/4/2015 6:41 PM, Paul Knight wrote:
Per the TC's submission request [1], please find the attached starter document for: 
DITA 1.3: Why Three editions? Version 1.0
WP-abbrev: dita-1.3-why-three-editions

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


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




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


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