#1 2010-07-12 13:00:54

ab
Administrator
From: France
Registered: 2010-06-21
Posts: 5,323
Website

Documentation of the Synopse SQLite3 / mORMot Framework

As a tutorial about SynProject, the documentation for the SQLite3 framework itself has been generated for the first time.

You asked for documentation about our Synopse SQLite3 framework, we'll generate it automatically, thanks to SynProject!

The resulting documentation of our SQLite3 framework (in draft status) can be downloaded from sampledoc.zip.

If you want to know how this documentation was created in a few click using SynProject, follow this link:
http://synopse.info/fossil/wiki?name=Sy … t+Tutorial...

This documentation will progress, and the associated .pro file will be available in our source code repository.

Offline

#2 2010-07-12 18:46:59

ab
Administrator
From: France
Registered: 2010-06-21
Posts: 5,323
Website

Re: Documentation of the Synopse SQLite3 / mORMot Framework

This documentation has been updated, and the associated .pro file is now available in our source code repository, in the SQLite3\Documentation sub-folder.

Offline

#3 2010-07-15 16:58:48

ab
Administrator
From: France
Registered: 2010-06-21
Posts: 5,323
Website

Re: Documentation of the Synopse SQLite3 / mORMot Framework

Documentation updated today.

http://synopse.info/files/synproject/sampledoc.zip now contains DI, SAD, SWRS, Risk and SDD documents.

Still in draft status, but you'd be able to guess more about SynProject...

The associated .pro file has also been updated in our repository.

Offline

#4 2011-02-13 19:52:07

ab
Administrator
From: France
Registered: 2010-06-21
Posts: 5,323
Website

Re: Documentation of the Synopse SQLite3 / mORMot Framework

The documentation has been updated to refresh the status of the 1.12 release.

From the same link:
http://synopse.info/files/synproject/sampledoc.zip

Offline

#5 2011-02-16 20:22:27

ab
Administrator
From: France
Registered: 2010-06-21
Posts: 5,323
Website

Re: Documentation of the Synopse SQLite3 / mORMot Framework

The SAD document has been enhanced - same download link above.

It now contains the UI-related units interfaces.

And a lot of general presentation have been added:
- MVC and Multi-Tier architecture;
- Why a Client/Server ORM;
- Writting RESTful Services;
- FTS3/FTS4;
- fixes and enhancements (to the SQLite3 related paragraphs e.g.).

More to come!

I'll try to comment the Main Demo - at least the business logic used in it...
And there is also this demo code which could be used also as reference for the documentation.

Offline

#6 2011-05-14 09:11:31

ab
Administrator
From: France
Registered: 2010-06-21
Posts: 5,323
Website

Re: Documentation of the Synopse SQLite3 / mORMot Framework

The SAD document has been enhanced a lot:
- An Index has been added;
- The Main Demo has been commented within;
- New 1.13 related features (Virtual Tables, TDynArray, logging, new fields...) have been introduced;
- A lot of improvements, especially for the integrated diagrams (now vectorial).

Enjoy!

Offline

#7 2011-08-07 07:41:25

ab
Administrator
From: France
Registered: 2010-06-21
Posts: 5,323
Website

Re: Documentation of the Synopse SQLite3 / mORMot Framework

The documentation is now in the 1.15 version.

It has been updated, and contains now a description about the main feature of this 1.15 version, i.e. "database agnosticism".

See http://blog.synopse.info/post/2011/08/0 … e3-limited and http://synopse.info/forum/viewtopic.php?pid=2432

Offline

#8 2013-01-01 12:56:01

wai-kit
Member
From: Amsterdam, the Netherlands
Registered: 2012-11-27
Posts: 62

Re: Documentation of the Synopse SQLite3 / mORMot Framework

Hi Arnaud,

My compliments for the excellent mORMot Framework and the documentation.

Going through the SAD pdf document, what I missed the most in the functionality of the documentation is
the lack of hyperlinks in the documentation. I find it helpful to go deeper into a subject that I was reading and
be able to jump back.
Is there any chance some kind of a Wiki Doc being setup in the future?

Just my two cents ...

Thanks,
Wai

Offline

#9 2013-01-01 17:33:00

ab
Administrator
From: France
Registered: 2010-06-21
Posts: 5,323
Website

Re: Documentation of the Synopse SQLite3 / mORMot Framework

We already reached somewhat a limit of Word generation, with the corresponding links.
Up to now, do not forget there is a "keyword index" at the beginning of the document.
I may easily add a reference back from each keyword appearance from the text to this index, if you find it useful.

Did you expect also a link to the class/units/function definitions (as extracted from source comments)?
A simple Ctrl+F in Adobe Reader to find it is also worth trying.

SynProject tool used to create the documentation only creates RTF/Word documents by now.
A HTML generator is started, but not finished yet.
I do not like very much wikis, since it tends to have a non homogeneous content quality, and fragmentation in small pages.
The SAD document was refactored several times, and if you take a look at the upcoming 1.18 version, you will find out that it has been a lot changed.
See http://synopse.info/files/pdf/Synopse%2 … 201.18.pdf
Having one source file for the whole content (the .pro file) is IMHO a plus. Such a deep refactoring should have been more difficult to do with a wiki.

Any help is welcome to maintain the .pro file!
See http://synopse.info/fossil/wiki?name=Downloads

Offline

#10 2013-01-22 13:34:30

esmondb
Member
From: London
Registered: 2010-07-20
Posts: 171

Re: Documentation of the Synopse SQLite3 / mORMot Framework

The Documentation is great but there's one small English grammar mistake which keeps cropping up and can be confusing: "Either this either that" should be written in English as "Either this OR that". I guess it's because in French it's "ou...ou" see: http://www.wordreference.com/enfr/either%20or

Could the most current documentation be given a static link without the version number one gets with:
http://synopse.info/files/pdf/Synopse%2 … 201.18.pdf
Then I could create a bookmark in my web browser which is always up to date.

Thanks

Offline

#11 2013-01-22 13:43:01

ab
Administrator
From: France
Registered: 2010-06-21
Posts: 5,323
Website

Re: Documentation of the Synopse SQLite3 / mORMot Framework

Thanks for the report.

I've created a ticket http://synopse.info/fossil/info/54af269043 and will fix it.

And this is "neither... nor", isn't it?

About the link, I'll do it.

Offline

#12 2013-01-22 13:54:19

esmondb
Member
From: London
Registered: 2010-07-20
Posts: 171

Re: Documentation of the Synopse SQLite3 / mORMot Framework

"neither... nor" is different to "either.. or"

"neither Peter nor Jane will go to the party" means none of them will go to the party. neither is a bit like "not... either... or..."

"either Peter or Jane will go to the party" means only one of them will go to the party.

Last edited by esmondb (2013-01-22 13:54:52)

Offline

#13 2013-01-22 15:45:48

ab
Administrator
From: France
Registered: 2010-06-21
Posts: 5,323
Website

Re: Documentation of the Synopse SQLite3 / mORMot Framework

OK - that was what I had in mind.
smile

Thanks for the feedback.

Offline

Board footer

Powered by FluxBB