search

DLR-SL / CPACS

CPACS - Common Parametric Aircraft Configuration Schema
http://dlr-sl.github.io/CPACS/
Apache License 2.0
79 stars 38 forks source link

Naming conventions: Requirements, Reqs, Definitions and Defs #714

Closed MarAlder closed 3 years ago

MarAlder commented 3 years ago

Problem

Due to the length of the word Requirements, we have chosen the abbreviation Reqs when revising the performanceRequirements for CPACS 3.3. This may result in long XPath strings. However, it was noted that this is inconsistent with other node names where we write out Definitions and do not abbreviate to Defs.

grafik

Proposals

  1. We also abbreviate Definitions (resp. Definition) as Defs (resp. Def).
  2. We keep the current state as Requirements is a bit longer than Definitions and then sometimes use abbreviations and sometimes not.
  3. We consistently write out everything according to the motto: as expressive as possible. In the XML file the tags are listed underneath anyway and for the XPath strings linebreaks could be used.

I prefer solution 3. What do you all think?

ErwinMoerland commented 3 years ago

I prefer solution 3. The 'delta' in XPath length achieved due to using abbreviations does not seem too large (saving a couple of characters compared to an already relatively long xpath). I do prefer the 'as expressive as possible' motto here.

CarstenChristmann commented 3 years ago

Although I prefer shorter names I vote for the proposal which causes a minimum of necessary changes in the released schema V3.2. This will reduce the impact on already existing tools.

MarAlder commented 3 years ago

closed by #716