Documentation Updates To SilverModel

There have been a number of updates to the documentation creation tools.

  • Formatting
  • Quick Format Settings Bar
  • Pictures
  • Exporting via the Code Generators as HTML, MarkDown, RTF or  Plain Text

The main documentation editor has been updated to allow for the editing of documentation with Rich Formatting.

Also, there is now a “quick format setting bar” that allows you to quickly format the selected text.

The ability to copy and paste images into the documentation has also been added.

Code Generation Documentation updates

On the code generation side, there are a number of extension methods that have been added to UML Elements. These allow the easy conversion of the documentation into different formats. All the new Rich documentation (as above) is stored in the Notes field of an Element in the DocX format.

To export the documentation during code generation the following extension methods are now available.

string element.GetNotesAsHTML()

This returns the notes as HTML with embedded pictures.

string element.GetNotesAsTxt()

This returns the notes as plain text with no formatting or pictures.

string element.GetNotesAsRTF()

This returns the notes in the RTF format.

string element.GetNotesAsMarkDown()

This returns the notes as MarkDown.

byte[] element.GetNotesAsDocX()

This returns the notes in the DocX format. Beware that this is a binary format.

Theme Updates

The app theme has been updated. The selected tabs are now more obvious (“Dark Blue” color). A Dark Theme is also in the works.