How we came to such a life

Here we wanted to insert a beautiful and short presentation from Slideshare , but it did not seem to like the UFO =)

What can

Mysql Documentor reads the data schema, comments to the tables and fields, and then uses a simple Smarty template to generate an html description.

Today, MyDoc can:

• build a list of tables with comments;
• build a list of fields in each table with comments;
• for each table to build a list of keys;
• in the presence of foreign keys to make links from the fields to related tables;
• work on all platforms on which php works with the mysqli extension;
• smarty-syntax of templates allows you to build documentation of any design and format (including non-html);
• conveniently configured directly in the launch script.

What can not, but will soon

• no statistics on tables and fields;
• The documentation on triggers and stored procedures is not processed in any way and is not built.

What else in the near future?

• grouping tables based on tags from comments;
• database schema output in Graphwiz format.

How to get

Just download it from our site (there is also an example of built documentation).
')

How to make it work

Actually, you won't have to force anyone. It is enough to glance in the README.TXT file (it is now in English) and follow some simple instructions. You will need only a couple of minutes.

And what, for free?

Yes. Mysql Documentor is distributed in source code under the terms of the GPL license . By the way, at info@softuniq.com you can (and should!) Send your contributions. Svn-repository will be soon.

What's next?

Utility development is in full swing. It is convenient to follow the news by subscribing to the RSS feed of our cozy placements. =)