Refactoring `class` structure

DeepBlueCLtd / Fi3ldMan

Field Service Manual with advanced data exploitation

https://deepbluecltd.github.io/Fi3ldMan/

Apache License 2.0

1 stars 1 forks source link

Refactoring `class` structure #23

Closed IanMayo closed 1 year ago

IanMayo commented 1 year ago

I've had a play with the sample datafile.

I'd like to suggest these improvements, based on usability in OxygenXML please

[ ] rename refBody to body
[ ] rename classProperties to summary - keep it as first (compulsory) child of body
[ ] move signature, propulsion, remarks to children of refBody, following summary. Items are optional, but in this specified order.
[ ] remove XML comments, since they are visible in Oxygen (see below)

brahnavank commented 1 year ago


<!DOCTYPE class SYSTEM "../../../dtd/class.dtd">
<class id="unit_a">
 <title>Unit_a</title>
 <body>
  <!-- compulsary -->
  <summary>
    <!-- compulsary :  6 times -->
    <property>
      <!-- compulsary -->
      <proptype></proptype>
      <!-- compulsary -->
      <propvalue></propvalue>
    </property>
    <property>
     <!-- compulsary -->
     <proptype></proptype>
     <!-- compulsary -->
     <propvalue></propvalue>
    </property>
    <property>
     <!-- compulsary -->
     <proptype></proptype>
     <!-- compulsary -->
     <propvalue></propvalue>
    </property>
    <property>
     <!-- compulsary -->
     <proptype></proptype>
     <!-- compulsary -->
     <propvalue></propvalue>
    </property>
    <property>
     <!-- compulsary -->
     <proptype></proptype>
     <!-- compulsary -->
     <propvalue></propvalue>
    </property>
    <property>
     <!-- compulsary -->
     <proptype></proptype>
     <!-- compulsary -->
     <propvalue></propvalue>
    </property>
  </summary>

  <!-- first element -->
  <!-- optional -->
  <signatures>
   <!-- optional -->
   <table><tgroup cols="1"><tbody><row><entry>dummy</entry></row></tbody></tgroup></table>
  </signatures>

  <!-- second element -->
  <!-- optional -->
  <propulsion>
   <!-- optional -->
   <p> some narrative content, including a table of varying structure. Plus diagrams, links, etc</p>
  </propulsion>

  <!-- third element -->
  <!-- optional -->
  <remarks>
   <!-- optional -->
   <span>

   </span>
  </remarks> 
 </body>
</class>```