Page 1 of 1

software elements in machinery task

Posted: Wed Mar 26, 2025 5:37 pm
by kamil
Hello,
How can I use Software elements (cmdname, filepath, etc.) in a machinery task? I tried adding the SW domains in the machineryTask.dtd template, but it doesn't work, please see below and thanks fo answer:

These parts were added into the machineryTask.dtd:

Code: Select all

<!ENTITY % taskreq-d-dec
  PUBLIC "-//OASIS//ENTITIES DITA 1.3 Task Requirements Domain//EN"
         "../../technicalContent/dtd/softwareDomain.ent"
>%taskreq-d-dec;

 DOMAIN EXTENSIONS
<!ENTITY % ph           "ph |
                         %sw-d-ph; |
   <!ENTITY % keyword    "keyword |   
                          %sw-d-keyword; |
                      
DOMAINS ATTRIBUTE OVERRIDE
<!ENTITY included-domains
                                          &sw-d-att;
                        
DOMAIN ELEMENT INTEGRATION
<!ENTITY % taskreq-d-def
  PUBLIC "-//OASIS//ENTITIES DITA 1.3 Task Requirements Domain//EN"
         "../../technicalContent/dtd/softwareDomain.mod"
>%taskreq-d-def;

Re: software elements in machinery task

Posted: Thu Mar 27, 2025 7:36 am
by Radu
Hi,
The machinery task as per the base DITA 1.3 specification does not allow these elements inside it.
So ideally you would need to build a DITA DTD specialization probably to accomplish what you want:
https://www.oxygenxml.com/doc/versions/ ... ation.html
Your specialization DTDs would have their own DOCTYPE public and system IDs to differentiate between the base DTDs and the specialized ones.
About the specifics of building this specialization, I'm not sure, one would need to try and probably as you attempted find some entities from the machinery task DTDs which need to be overwritten and made more lax.
Regards,
Radu

Re: software elements in machinery task

Posted: Thu Jun 19, 2025 6:35 am
by LillianQuinn
Radu wrote: Thu Mar 27, 2025 7:36 am Hi,
The machinery task as per the base DITA 1.3 specification does not allow these elements inside it.
So ideally you would need to build a DITA DTD specialization probably to accomplish what you want:
https://www.oxygenxml.com/doc/versions/ ... or/topics/geometry arrow /dita-integrate-specialization.html
Your specialization DTDs would have their own DOCTYPE public and system IDs to differentiate between the base DTDs and the specialized ones.
About the specifics of building this specialization, I'm not sure, one would need to try and probably as you attempted find some entities from the machinery task DTDs which need to be overwritten and made more lax.
Regards,
Radu
So in case I need to insert a custom element into the machineryTask without losing compatibility with standard DITA processing tools (like Oxygen XML), which is the more optimal way: chh<foreign>? And if I specialize, which module should I start from to change the content structure without breaking the entire inheritance structure?

Re: software elements in machinery task

Posted: Thu Jun 19, 2025 6:53 am
by Radu
Hi,
Ideally for such more general questions you could ask on the DITA Users List where there are lots of tech writers, consultants registered:
https://dita-users.groups.io/g/main
The easiest way to add more semantic meaning to an element might be to use the @outputclass attribute, so for example:

Code: Select all

<p outputclass="long-paragraph">some text </p>
could be styled differently in the published output and you could add actions to Oxygen to insert a "<p outputclass="long-paragraph">" by using the content completion window or toolbar.
Other than that, you would need to specialize.
Regards,
Radu