dita — archive

Implementing a constraint with the RNG expression of the DITA 1.3 standard

From: Graydon Saunders <[email protected]>
To: [email protected]
Date: Wed, 03 Jul 2019 13:27:00 -0000

In what way is "example of a constraining a base element's content model from mixed to element-only" insufficiently general? It's a common thing in a DITA deployment to prefer a content model which insists on li/p or entry/p or that section/text() isn't permitted. It's not obviously improper to want such a constraint. Any such constraint on base elements should be implemented in such a way that any subsequent specializations, whether via pre-existing domains or a domain defined specifically for a particular deployment, can rely on the constraint of the base element to operate throughout the content model without further adjustments. It's possible that the TC consensus position is that base elements should NOT be constrained and that any desired versions with constrained content models relative to the base version should be specialized via a domain, acquiring different names and longer class attribute values in the process. If the TC consensus position is that, yes, a DITA deployment ought to be able to constrain the content models of base elements, it would be useful to have examples of how this is expected to be done. Graydon Saunders Publishing Solutions Developer Precision Content Direct: +1 (647)265-8500 x106 Email: [email protected] www.precisioncontent.com Unlock the Knowledge in Your Enterprise This email and any files transmitted with it are confidential and intended solely for the use of the individual or entity to whom they are addressed. If you are not the intended recipient you are notified that disclosing, copying, distributing or taking any action in reliance on the contents of this information is strictly prohibited. Please notify us by return email if you have received this email in error. 2019, Precision Content Authoring Solutions Inc, Mississauga, Ontario, Canada From: [email protected] <[email protected]> on behalf of Eliot Kimber <[email protected]> Sent: 03 July 2019 08:50 To: [email protected] Subject: Re: [dita] Implementing a constraint with the RNG _expression_ of the DITA 1.3 standard Please ask your how-to question on the DITA Users List. I'm not sure I fully understand your requirement but I suspect you're making it harder than it is. Cheers, E. -- Eliot Kimber http://contrext.com ïOn 7/3/19, 7:38 AM, "Graydon Saunders" <[email protected] on behalf of [email protected]> wrote: Do we want to simply duplicate these examples in RNG? The example I would like to have in RNG is the one from my original question; constrain a mixed-content base element's content model to be element-only so that the constrained element is generally available to domain modules incorporated into a document type without requiring additional work on the constraint if a domain is later added to the document. I don't think there's currently an example of that kind of constraint; experience says that this is a reasonably frequent thing to want. I don't think it would hurt to have a The Approved Way example of doing so with a DTD, as well as the RNG example. Graydon Saunders Publishing Solutions Developer Precision Content Direct: +1 (647)265-8500 x106 Email: [email protected] www.precisioncontent.com < https://www.precisioncontent.com > Unlock the Knowledge in Your Enterprise This email and any files transmitted with it are confidential and intended solely for the use of the individual or entity to whom they are addressed. If you are not the intended recipient you are notified that disclosing, copying, distributing or taking any action in reliance on the contents of this information is strictly prohibited. Please notify us by return email if you have received this email in error. 2019, Precision Content Authoring Solutions Inc, Mississauga, Ontario, Canada ________________________________________ From: [email protected] <[email protected]> on behalf of Kristen James Eberlein <[email protected]> Sent: 02 July 2019 20:04 To: [email protected] Subject: Re: [dita] Implementing a constraint with the RNG _expression_ of the DITA 1.3 standard The current spec contains examples of the following: * Redefine the content model for the <topic> element (DTD) * Constrain attributes for the <section> element (DTD) * Constrain a domain module (DTD) * Replace a base element with the domain extensions (DTD) * Apply multiple constraints to a single document-type (DTD) * Correct the constraint for the machinery task (DTD) Do we want to simply duplicate these examples in RNG? Best, Kris Kristen James Eberlein Chair, OASIS DITA Technical Committee Principal consultant, Eberlein Consulting www.eberleinconsulting.com < http://www.eberleinconsulting.com > +1 919 622-1501; kriseberlein (skype) On 7/2/2019 5:52 PM, Eliot Kimber wrote: We should definitely have examples of RNG constraints. The constraint modules shipped with DITA 1.3 demonstrate the general techniques. But fundamentally it's the same as for DTDs: you override the base declarations of the patterns. Note that the current (unreleased but committed) state of the RNG to DTD generator automatically translates RNG <notAllowed> into the equivalent DTD entity declaration overrides as required for wholesale constraint of things defined in commonElements or topic.mod. This makes defining this type of constraint much easier since it does a whole bunch of cutting and pasting for you and then automatically omits those things that you've marked as not allowed. Should I ever be able to actually get this code a releasable state it will very convenient... Cheers, E. -- Eliot Kimber http://contrext.com ïOn 7/2/19, 12:33 PM, "Kristen James Eberlein" <[email protected] on behalf of [email protected]> < mailto:[email protected]@eberleinconsulting.com > wrote: Yes, constraints can be expressed in RNG; RNG is the normative form of the DITA grammar files. In fact, constraints are easier to develop in in RNG than DTD! The spec only contains examples of constraints in DTD, rather than RNG, because that is what we had available and the information that many people wanted. TC members, should we consider reworking our constraints examples to be in RNG rather than DTD? Or adding parallel examples with RNG code? Best, Kris Kristen James Eberlein Chair, OASIS DITA Technical Committee Principal consultant, Eberlein Consulting www.eberleinconsulting.com < http://www.eberleinconsulting.com > < http://www.eberleinconsulting.com > < http://www.eberleinconsulting.com > +1 919 622-1501; kriseberlein (skype) On 7/2/2019 1:26 PM, Graydon Saunders wrote: In terms of the mechanics, certainly, and I will go post there. In terms of whether it is possible to support constraints -- as distinct from specializations -- in the RNG implementation, it might be of interest to the technical committee. Thanks! Graydon Saunders Publishing Solutions Developer Precision Content Direct: +1 (647)265-8500 x106 Email: [email protected] www.precisioncontent.com < http://www.precisioncontent.com > < https://www.precisioncontent.com > < https://www.precisioncontent.com > Unlock the Knowledge in Your Enterprise This email and any files transmitted with it are confidential and intended solely for the use of the individual or entity to whom they are addressed. If you are not the intended recipient you are notified that disclosing, copying, distributing or taking any action in reliance on the contents of this information is strictly prohibited. Please notify us by return email if you have received this email in error. 2019, Precision Content Authoring Solutions Inc, Mississauga, Ontario, Canada ________________________________________ From: [email protected] <[email protected]> < mailto:[email protected] > < mailto:[email protected] > < mailto:[email protected] > on behalf of Kristen James Eberlein <[email protected]> < mailto:[email protected] > < mailto:[email protected] > < mailto:[email protected] > Sent: 02 July 2019 13:22 To: [email protected] Subject: Re: [dita] Implementing a constraint with the RNG _expression_ of the DITA 1.3 standard Graydon, this is perhaps a better post for the dita-users list. The DITA TC list is for discussing the work of the DITA Technical Committee. Best, Kris Kristen James Eberlein Chair, OASIS DITA Technical Committee Principal consultant, Eberlein Consulting www.eberleinconsulting.com < http://www.eberleinconsulting.com > < http://www.eberleinconsulting.com > < http://www.eberleinconsulting.com > +1 919 622-1501; kriseberlein (skype) On 7/2/2019 12:35 PM, Graydon Saunders wrote: Hello -- Using the RNG implementation of the DITA 1.3 standard, I want to constrain the li element so that its content model permits only a p element. I want to do this in such a way that as domain specializations are added to document definitions, those domain specializations will acquire this constraint without any further changes being required. How should I do this? Thanks! Graydon Saunders Publishing Solutions Developer Precision Content Direct: +1 (647)265-8500 x106 Email: [email protected] www.precisioncontent.com < http://www.precisioncontent.com > < https://www.precisioncontent.com > < https://www.precisioncontent.com > Unlock the Knowledge in Your Enterprise This email and any files transmitted with it are confidential and intended solely for the use of the individual or entity to whom they are addressed. If you are not the intended recipient you are notified that disclosing, copying, distributing or taking any action in reliance on the contents of this information is strictly prohibited. Please notify us by return email if you have received this email in error. 2019, Precision Content Authoring Solutions Inc, Mississauga, Ontario, Canada --------------------------------------------------------------------- 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 --------------------------------------------------------------------- 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 --------------------------------------------------------------------- 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