Best,
Kris
Kristen James Eberlein
Chair, OASIS DITA Technical Committee
Principal consultant, Eberlein Consulting
www.eberleinconsulting.com
+1 919 682-2290; kriseberlein (skype)
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: | Re: File names and footer info for CHM and HTML versions |
|---|---|
| Date: | Tue, 28 Apr 2015 17:14:39 -0400 |
| From: | Chet Ensign <chet.ensign@oasis-open.org> |
| To: | Kristen James Eberlein <kris@eberleinconsulting.com> |
| CC: | Paul Knight <paul.knight@oasis-open.org>, Bob Thomas <bob.thomas@tagsmiths.com> |
Hi Kris, hi Bob -
Paul, double check my work here when you get a moment.
Ok. I think this will work out for you. Names and
directories have to align the highest-level content according
to the OASIS Naming Directives at http://docs.oasis-open.org/dita/dita/v1.3/csd01/dita-v1.3-csd01.html,
in particular on the construction of file names (http://docs.oasis-open.org/specGuidelines/ndr/namingDirectives.html#nameConstruction)
and path components (http://docs.oasis-open.org/specGuidelines/ndr/namingDirectives.html#paths).
However, in the case of these complex HTML publications,
I'm not overly concerned with filenames below the stage-level
directory (as explained below). To see an example of a
similarly complex publication have a look at http://docs.oasis-open.org/plcs/plcslib/v1.0/
(and I encourage you to drill down into the directories a bit
to see how the organization works there.)
So - the basic challenge here is to publish, for the first
public review, the Committee Specification Draft 01 and the
Committee Specification Public Review Draft 01.
Working with the filename you've proposed and fitting it to
the naming requirements, we have...
For Committee Specification Draft 01:
The content files would go in one directory below or
multiple directories below this, for example:
For the Committee Specification Public Review Draft 01,
these directories will become...
etc.
Note - the files in these descendant directories will not
require the -csd01 components on the filenames. As long as we
have that on those entry level files, we're covered.
The grammar files - DTDs, schemas, etc. - also go in
directories, named and organized as you like, for example:
http://docs.oasis-open.org/dita/dita-specification-base/v1.3/csd01/grammar/
or http://docs.oasis-open.org/dita/dita-specification-base/v1.3/csd01/dtds/
etc.
Does the -chm.zip file contain the complete package zipped
and ready for downloading to a local copy? If so, then it
should just be dita-specification-base-v1.3-csd01.zip as
that's the way we always package those.
Note also that we create Latest version links that always
take readers to the most recent edition of the publication.
(You see those in the top level PLCS directory I pointed you
to above.) For DITA, these would be:
On the PDF, the footers will have to be done to match the
layout Paul gave you. I'm not as concerned about the HTML, but
the PDF has to match:
<filename without extension>
<approval date>
Standards Track Work Product Copyright © OASIS Open 2015.
All Rights Reserved. Page 1 of 15
Have a discussion about this with the TC and let's then
discuss further if need be. We'll obviously need to have a lot
of conversation with whoever is handling the style sheets
during this process. This though gets the conversation
started.
Best,
/chet
On Thu, Apr 23, 2015 at 10:14 AM,
Kristen James Eberlein <kris@eberleinconsulting.com>
wrote:
Chet and Paul, did you have any feedback for us here?
Best,
Kris
Kristen James Eberlein
Chair, OASIS DITA Technical Committee
Principal consultant, Eberlein Consulting
www.eberleinconsulting.com
+1 919 682-2290; kriseberlein (skype)
On 4/16/2015 7:04 AM, Kristen James Eberlein wrote:
File names:
The names of our output files are generated based on the names of the DITA source. This gives us the following, for example:
- dita-1.3-specification-base-chm.zip
- dita-1.3-specification-base.pdf
- dita-1.3-specification-base.html
We can rename them to match patterns that you want to use, but I would not want to rename them at every new stage in the process, if at all possible. We can easily add "dita-v1.3-csd01" as metadata in the source that is then rendered on the PDF cover or in the footers. Let us know how much flexibility we can have here.
Footers
The footers for our HTML and CHM versions of the 1.2 spec do not match what is in the Word template that Paul provided.
CHM
HTML
What do you want to see in these formats? Obviously, page count is irrelevant.
--
Best,
Kris
Kristen James Eberlein
Chair, OASIS DITA Technical Committee
Principal consultant, Eberlein Consulting
www.eberleinconsulting.com
+1 919 682-2290; kriseberlein (skype)
/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