DITA Best Practices : DITAVAL Naming Conventions

After creating your ditaval file, you should name it logically as it pertains to your product.

For example, if you create a ditaval that is intended to include the Requirements Editor Tool, but exclude other products, you might choose to name it:

exp_RE3.ditaval

Where:

  • exp_ - is the product "Expere"
  • RE3 - is the chosen abbreviation for Requirements Editor 3
  • .ditaval - is the extension of the ditaval file. 

    Note

    While no extension is required at all for xml files, giving the file an extension assists in identifying it as a ditaval.

 

To take the above example a step further; if you wanted to use the same ditaval actions as in exp_RE3.ditval above, but needed to specifically exclude content for DocGenServices, you might name the file as follows:

exp_RE3-DGS.ditval

Where:

  • exp_ - is the product "Expere"
  • RE3 - is the chosen abbreviation for Requirements Editor 3
  • -DGS - indicates the ditval has an exclusion for DocGenServices
  • .ditaval - is the extension of the ditaval file.