search

MichaelKentBurns / BibleModel

Data model / database containing complete text of the Bible, Cross References, Notes and other references
3 stars 0 forks source link

Describe Object Model JavaScript files #3

Open MichaelKentBurns opened 2 months ago

MichaelKentBurns commented 2 months ago

Each of the classes in the basic data model are contained in a JS file and have a JS class definition. I will annotate those and create an overall document, maybe even a UML class diagram.

MichaelKentBurns commented 3 weeks ago

I have added a DataModel.md file to the project that contains the source of a mermaid markdown for the object model.

In VS Code you must add the extension named 'Markdown Preview Mermaid Support'. With that you can open the DataModel.md file in the editor and then right click the tab for that open file. From the drop down menu select 'Open Preview' and you should see the preview window appear in a new tab. If you move that to the right split you can edit the markdown and see instant updates to the UML Class diagram.

I am also using some other programs such as VisualParadigm native app and the cloud version called Visual Paradigm Online.

MichaelKentBurns commented 2 weeks ago

For now, the modeling is being done primarily in Mermaid.
See ObjectModel/ObjectModel.md and StateMachine.md Those contain Mermaid markup, and if you view those in GitHub website you can view those files either in their raw markup form, or open the preview (rendered form) to see the diagram. For situations where that does not work, I'm trying to keep up with saving the diagram into .svg and .png, and sometimes .pdf forms and including them in the same ObjectModel directory.