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: Recommendation for adding explicit sectionheadings to all DTD/schema files before the 1.0 release


I'm fairly certain that someone on the TC has previously suggested that we add section headers to the various DTD/Schema files as part of our "cleanup" before the 1.0 release.  I'm a bit stretched for time to search the archives for the original comments on the subject, so please forgive me if I'm going over any ground that's been previously covered.

During our DITA pilot project at my company, we've found it essential to have explicit section headings in every .dtd and .mod file (we aren't using schema files in our implementation of DITA just yet).  It's essential because our procedural docs for the specialization coders often make reference to specific parts of a .dtd or .mod file.

So I'd like to throw my vote in for coming up with standard section names for the various parts of each DTD/Schema file, with a highly visible format.

I've uploaded a file to the Documents section of the DITA TC website, called "example_of_sectionalized_doctypes_BMC.zip". This file contains one of our custom doctypes that demonstrates the type and degree of sectionalization I'd recommend to the TC.  The files you should look at are tMsgIntro.dtd and tMsgIntro.mod.  Also, please refer to the file "how_to_code_bmc_specializations.htm" for an example of procedural documentation that would benefit from such heavy sectionalization of the DITA DTD/schema files.


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