Watch, Follow, &
Connect with Us

For forums, blogs and more please visit our
Developer Tools Community.


Welcome, Guest
Guest Settings
Help

Thread: ANN: Open Source mORMot Documentation now available online



Permlink Replies: 1 - Last Post: Nov 20, 2014 8:03 AM Last Post By: Didier Largange
Arnaud BOUCHEZ

Posts: 143
Registered: 2/17/02
ANN: Open Source mORMot Documentation now available online
Click to report abuse...   Click to reply to this thread Reply
  Posted: Nov 9, 2014 4:56 AM
Our little Open Source ORM/ODM/SOA/MVC framework did have a pretty exhaustive documentation, but only in pdf format by now.
Downloading a huge pdf is certainly not the more convenient option.
Unless you want to kill a forest, by printing the 1650 pages of the main Software Architecture Document (SAD) pdf in your own printer!

We enhanced our SynProject tool - see http://synopse.info/fossil/wiki?name=SynProject - to be able to generate the documentation as HTML pages.
You can take a look at http://synopse.info/files/html/Synopse%20mORMot%20Framework%20SAD%201.18.html
It contains the whole SAD 1.18 content.
The pdf is more than 16 MB, whereas this html page is only 2MB, and compresses as gzip to minimize transmission bandwidth.

Note that all diagrams were embedded as SVG within the page content: resulting file will be much faster to browse and download.
But it would require a modern Browser. For instance, older Internet Explorer revisions do not support SVG, but latest IE 11 does (as Chrome, FireFox, Opera or Safari).
We tried to implement some basic responsive design layout, for tablets or phones.

I hope this would help accessing the right information.
Do not forget there is
- the Table of Contents - http://synopse.info/files/html/Synopse%20mORMot%20Framework%20SAD%201.18.html#TITLE_TABLE
- the FAQ - http://synopse.info/files/html/Synopse%20mORMot%20Framework%20SAD%201.18.html#TITL_123
- the full API reference - http://synopse.info/files/html/Synopse%20mORMot%20Framework%20SAD%201.18.html#SIDE_MORMOT_FRAMEWORK
- and an index of KeyWords - http://synopse.info/files/html/Synopse%20mORMot%20Framework%20SAD%201.18.html#INDEX_KEYWORDS

Of course, you can use our SynProject tool to document your own project, for free!
Didier Largange

Posts: 12
Registered: 6/4/00
Re: ANN: Open Source mORMot Documentation now available online
Click to report abuse...   Click to reply to this thread Reply
  Posted: Nov 20, 2014 8:03 AM   in response to: Arnaud BOUCHEZ in response to: Arnaud BOUCHEZ
A very usefull and pleasant reading.
The HTML format is indeed less intimidating!
Thank you Arnaud.
Legend
Helpful Answer (5 pts)
Correct Answer (10 pts)

Server Response from: ETNAJIVE02