Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Update on doc files.

  • Loading branch information...
commit e2db96fe3543663dc0d2ad378b2823e6271689c1 1 parent eb5c298
@rkhaotix rkhaotix authored
Showing with 101 additions and 51 deletions.
  1. +54 −10 CHANGELOG.md
  2. +24 −26 COMPILING.md
  3. +8 −8 PLUGINS.md
  4. +14 −6 README.md
  5. +1 −1  doxygen.conf
View
64 CHANGELOG.md
@@ -1,15 +1,23 @@
Changelog
---------
-[ v0.4.0-beta ]
+v0.4.0-rc
+---------
+
+<em>Release date: February 1st, 2013 </em>
-Attention: The v0.4.0 is in beta stage so the change log can be modified at any moment when new bug fixes is created. New features will not be implemented now, instead, they will be marked to be coded starting from the v0.4.1.
+Attention: The v0.4.0 is in release-candidate stage so the change log can be modified at any moment when new bug fixes is created. New features will not be implemented now, instead, they will be marked to be coded starting from the v0.4.1.
The stable 0.4.0 has no release date yet because all the code is being refactored (almost done!) meaning that the new version will be completely decoupled from previous ones.
+* [New]: tables and view are now graphically separated by colored rectangles representing its schemas.
+* [New]: compiling pgModeler now works perfectly on Mac OSX system.
* [New]: introduced the 'Quick actions' menu that permits: rename, move to another schema, change onwer and edit permissions.
* [New]: the relationship editing form gained an "advanced" tab which shows the objects generated and/or represents the relatioship itself.
* [New]: the user now can add relationships only creating foreign keys on tables (fk relationships).
* [New]: added a french UI translation (provided by [toorpy](https://github.com/toorpy)).
+* [Change]: minor improvements on plugin base class: PgModelerPlugin.
+* [Change]: widget size adjustments to better showing on Mac OSX system.
+* [Change]: crashhandler now shows the compiled and running versions of Qt.
* [Change]: french UI translation reviewed and updated (provided by [babs](https://github.com/babs)).
* [Change]: 'Objects of Model' when used as object picker now expand all the nodes by default.
* [Change]: 'Objects of Model' now memorizes the tree state when update an object and / or opening another model.
@@ -20,6 +28,11 @@ The stable 0.4.0 has no release date yet because all the code is being refactore
* [Change]: relationship validation method now removes fk relationships when the foreign keys that gerenates is no longer exists.
* [Change]: copy/cut/delete commands does not manipulates system objects like schema public and languages C, SQL and plpgsql.
* [Change]: pgModeler startup scripts are now path location free meaning that software can be installed where the user desires.
+* [Fix]: pgModeler no longer crashes when editing objects style.
+* [Fix]: corrected bug that was deleting two sequeces at once.
+* [Fix]: pgModeler no longer crashes when removing (disconnecting) relationship that has special primary keys.
+* [Fix]: minor fixes on the startup scripts on all platforms.
+* [Fix]: corrected an incorrect reference to output stream on Windows system.
* [Fix]: shortcuts and popup menu now works correctly when selection an object on 'Objects of Model' tree.
* [Fix]: the pgsql base types (represented by tables, sequences, user defined types and domains) are now updated correctly when the related schema is renamed.
* [Fix]: corrected some weird SRID value on non spatial types.
@@ -39,7 +52,10 @@ The stable 0.4.0 has no release date yet because all the code is being refactore
* [Fix]: corrected bug on column comment code generation.
* [Fix]: corrected bug that was deleting two tables at once.
-[ v0.3.4 ]
+v0.3.4
+------
+
+<em>Release date: October 17, 2012</em>
* [New]: added chinese UI translation (provided by [gjunming](https://github.com/gjunming)).
* [New]: added basic support for PostGiS 2.0 only data types: box2d, box3d, geometry and geography (suggested by [george-silva](https://github.com/george-silva) on [issue#28](https://github.com/pgmodeler/pgmodeler/issues/28))(EXPERIMENTAL). Note: when using these data types make sure that PostGiS extension is installed on database cluster since pgModeler WILL NOT install it automatically or generate the command to do it!
@@ -58,7 +74,10 @@ The stable 0.4.0 has no release date yet because all the code is being refactore
* [Fix]: corrected a bug that was causing crash where user try to edit protected objects.
* [Fix]: corrected the exhibition of UTF-8 messages on ```throw``` statements.
-[ v0.3.3 ]
+v0.3.3
+------
+
+<em>Release date: October 09, 2012</em>
* [Change]: pgModeler license were update to GPLv3.
* [Change]: Error massages and entire UI were translated to en_US. Now people can contribute more easily with translation files. [(issue#8)](https://github.com/pgmodeler/pgmodeler/issues/8)
@@ -68,7 +87,10 @@ The stable 0.4.0 has no release date yet because all the code is being refactore
* [Fix]: Compilation process and execution is working correctly on Windows system. [(issue#11)](https://github.com/pgmodeler/pgmodeler/issues/11)
* [Fix]: No more crashes when dealing with relationships that have special triggers/indexes/columns. [(issue#8)](https://github.com/pgmodeler/pgmodeler/issues/8) [(issue#24)](https://github.com/pgmodeler/pgmodeler/issues/24)
-[ v0.3.2 ]
+v0.3.2
+------
+
+<em>Release date: September 27, 2012</em>
* [Change]: The default extension for the models now stands for ".dbm" [(issue#9)](https://github.com/pgmodeler/pgmodeler/issues/9)
* [Change]: Tables and sequences now can be used as function return type as well parameter type. This is valid for other objects that make use of base types (except for table columns).
@@ -80,7 +102,10 @@ The stable 0.4.0 has no release date yet because all the code is being refactore
* [Fix]: Corrected the reference to the plugins directory. [(issue#7)](https://github.com/pgmodeler/pgmodeler/issues/7)
* [Fix]: The action "New Object -> Tablespace" now is displayed properly.
-[ v0.3.1 ]
+v0.3.1
+------
+
+<em>Release date: September 18, 2012</em>
* [New]: Relationships generates column suffixes automaticaly. This behavior can be changed on the relationship editing form.
* [New]: Added two samples to pgModeler.
@@ -89,14 +114,20 @@ The stable 0.4.0 has no release date yet because all the code is being refactore
* [Fix]: Class CenaObjetos now doesn't delete objects twice.
* [Fix]: Eliminated bug that caused crashing on pgModeler when closing a model.
-[ v0.3.0 ]
+v0.3.0
+------
+
+<em>Release date: September 12, 2012</em>
* [New]: Added a model overview widget.
* [New]: Added export feature that generates PNG image of the models.
* [Fix]: Corrected the naming of columns generated by many-to-many relationships.
* [Fix]: Corrected generation of XML/SQL code by the model.
-[ v0.2.0 ]
+v0.2.0
+------
+
+<em>Release date: August 31, 2012</em>
* [New]: Added an interface to implement third party plugins. Check [PLUGINS.md] (https://github.com/pgmodeler/pgmodeler/blob/master/PLUGINS.md) for details.
* [New]: Added a short cut to easily control the zoom on the model. Use Crtl + Mouse wheel up (zoom up) or Crtl + Mouse wheel down (zoom down).
@@ -104,7 +135,10 @@ The stable 0.4.0 has no release date yet because all the code is being refactore
* [Fix]: No more crashes when removing an primary-key of a table which has relationship with other tables. [(issue#2)](https://github.com/pgmodeler/pgmodeler/issues/2)
* [Fix]: Adjusted the semantics of one-to-one relationships.
-[ v0.1.2 ]
+v0.1.2
+------
+
+<em>Release date: August 24, 2012</em>
* [New]: Added a functionality to save modified models before closing the software.
* [Change]: Updated the en_US dictionary with the texts of the above functionality.
@@ -117,10 +151,20 @@ The stable 0.4.0 has no release date yet because all the code is being refactore
* [Fix]: Eliminated segmentation fault when editing relationships and/or undoing an operation involving a relationship.
* [Fix]: Identifiers relationships now correctly display the thick line beside the weak entity.
-[ v0.1.1 ]
+v0.1.1
+------
+
+<em>Release date: August 14, 2012</em>
* [Fix]: Correction of the actions for inserting graphic objects (table, text box, vision and relationship) in Windows environment.
* [Fix]: Correction on the display of the maximize button in the window decoration in Windows environment.
* [Fix]: Adjust on the position and spacing of widgets in editing forms.
* [Fix]: The XML parser can now correctly read DTD files in Windows environment.
* [Fix]: The compilation method is no longer in the form of shared libraries + executable and passed to be as standalone executable only.
+
+v0.1.0
+------
+
+<em>Release date: August 9, 2012</em>
+
+* First pgModeler release.
View
50 COMPILING.md
@@ -1,12 +1,13 @@
Compiling
---------
-This document describes a simple way how to compile and run the pgModeler. Please read it carefully so that no step is forgotten and compromising the entire process.
+This document describes a simple way how to compile pgModeler. Please read it carefully so that no step is forgotten and compromising the entire process.
Compiling Requirements
-------------------------
-* GCC Development Tools 4.4 or above
+* GCC Development Tools 4.4 or above (Windows and Linux)
+* Xcode 4.5 or above (Mac OSX only)
* Qt 4.8.x library (qt-project.org)
* libXML2 library (www.xmlsoft.org)
* libpq library (www.postgresql.org)
@@ -15,35 +16,32 @@ Compiling Requirements
The process
-----------
-* Note to Unix: The compilation script make use of 'pkgconfig' tool to find the correct path to PostgreSQL and libXML2 include/libs so make sure that executing the commands below will produce a similar result as follow:
+<strong>Note to Linux</strong> The compilation script make use of 'pkgconfig' tool to find the correct path to PostgreSQL and libXML2 include/libs so make sure that executing the commands below will produce a similar result as follow:
- $ pkg-config libpq --cflags --libs
- > -I/usr/include -L/usr/lib64/libpq.so
+<code>$ pkg-config libpq --cflags --libs
+> -I/usr/include -L/usr/lib64/libpq.so
+</code>
- $ pkg-config libxml-2.0 --cflags --libs
- > -I/usr/include/libxml2 -lxml2
+<code>$ pkg-config libxml-2.0 --cflags --libs
+> -I/usr/include/libxml2 -lxml2
+</code>
-If an error is returned check the installation of PostgreSQL and libXML2. The compilation will fail if these dependencies could not be resolved.
+If some error is returned after run the above commands check the installation of PostgreSQL and libXML2. The compilation will fail if these dependencies could not be resolved.
-* Note to Windows: Before starting the compilation, check in the file 'pgmodeler.pro' if the variables windows:INCLUDEPATH and windows:LIBS points to the correct paths relative to your system.
+<strong>Specific for Ubuntu:</strong> If you are experiencing linkage errors related to libpq even having PostgreSQL correctly installed try to create the file "/usr/lib/pkgconfig/libpq.pc" with the following content:
-* Note to Mac OSX: Unfortunately the build process is broken in this system and cannot be deeply tested because the lack a Mac computer. ** HELP NEEDED! **
+ prefix=/usr
+ libdir=${prefix}/lib/postgresql/[VERSION]/lib
+ includedir=${prefix}/include/postgresql
-* Note to Ubuntu: If you are experiencing linkage errors related to libpq even having PostgreSQL correctly installed try to create the file "/usr/lib/pkgconfig/libpq.pc" with the following content:
+ Name: LibPQ
+ Version: 5.0.0
+ Description: Library PQ
+ Requires:
+ Libs: -L${libdir}/libpq.so -lpq
+ Cflags: -I${includedir}
-```
-prefix=/usr
-libdir=${prefix}/lib/postgresql/[VERSION]/lib
-includedir=${prefix}/include/postgresql
-
-Name: LibPQ
-Version: 5.0.0
-Description: Library PQ
-Requires:
-Libs: -L${libdir}/libpq.so -lpq
-Cflags: -I${includedir}
-
-```
+<strong>Note to Windows/MacOSX:</strong> Before starting the compilation, check in the file 'pgmodeler.pro' if the variables PGSQL_(INC|LIB) and XML_(INC|LIBS) points to the correct paths relative to your system.
To compile the pgModeler type (in the root folder of the source code):
@@ -63,10 +61,10 @@ Four own environment variables are used by pgModeler to access the folders schem
* PGMODELER_LANG_DIR -> stores the full path the directory lang/
* PGMODELER_PLUGINS_DIR -> stores the full path the directory plugins/
-Additionally, the pgModeler need to know where to find the libraries required for the execution (Qt Library, LibXML and libpq) for which you should enter the full path in the variable LD_LIBRARY_PATH (Unix) or PATH (Windows), if not already configured.
+Additionally, pgModeler need to know where to find the libraries required for the execution (Qt Library, LibXML and libpq) for which you should enter the full path in the variable LD_LIBRARY_PATH (Unix) or PATH (Windows), if not already configured.
To provide the interface translation pgModeler checks the variable LANG (Unix). To use a specific translation, change the value of this variable. So far, the pgModeler only supports the U.S. English (en_US) language.
Finally, as a convenience, the script 'start-pgmodeler.(sh | bat)' is provided to assist the initialization of pgModeler so it is not necessary to call the executable directly or change the environment variables on your operating system.
-Note: You may need to edit the parameters of the script depending on configuration of your operating system.
+<strong>Note:</strong> You may need to edit the parameters of the script depending on configuration of your operating system.
View
16 PLUGINS.md
@@ -1,7 +1,7 @@
Plug-ins
--------
-This document describes a simple way to create third party plugins on pgModeler. ATTENTION: Any plugin must be compiled using the most current source and libs of pgModeler.
+This document describes a simple way to create third party plugins on pgModeler. ATTENTION: Any plugin must be compiled using the most recent pgModeler source and libs.
Basic Rules
-----------
@@ -9,7 +9,7 @@ Basic Rules
To be used as a plugin your class must:
* Inherit the class "PgModelerPlugin"
-* Use the macro Q_INTERFACES in its declaration.
+* Use the macro Q_INTERFACES in its declaration and the macro Q_EXPORT_PLUGIN2 on its implementation.
* Overload all pure virtual methods from PgModelerPlugin
Plugin directory structure
@@ -19,9 +19,11 @@ The plugins in pgModeler must be within the "plugins" folder in its own director
[PGMODELER_PLUGINS_DIR]/
- +- pluginA/
- +---(lib)*(pluginA.)(so|dylib|dll) (library)
- +---pluginA.png (icon)
+ |
+ + - pluginA/
+ + - (lib)*(pluginA.)(so|dylib|dll) (library)
+ |
+ + - pluginA.png (icon)
* Library: it is the shared object that represents the plugin. The prefix (lib) and suffix (so|dylib|dll) are plataform dependent.
* Icon: it is a PNG image that represents the plugin on the plugins toolbar.
@@ -34,6 +36,4 @@ To assist in developing a plugin the DummyPlugin project was created. This basic
Advanced plugins
---------------
-To create advanced plugins you need to study the source code of pgModeler (particularly the headers). The code is well documented but in Portuguese. If you want to create a plugin and have questions please contact me via e-mail.
-
-In the near future all the code will be cataloged and online documentation in English will be available to developers (help wanted!).
+To create advanced plugins for particular tasks you need to check the pgModeler API documentation. The documentation is well structured but the UI library is still in Portuguese language but the code refactoring is in progress. If you want to create a plugin and have questions please contact me via e-mail.
View
20 README.md
@@ -44,10 +44,8 @@ Since the beta release the model files has suffered changes on its structure. So
To do it, open the .dbm file on your preferred text editor and add the code below right before the "database" tag.
-```
-<schema name="public" rect-visible="true" fill-color="#f0f0f0">
-</schema>
-```
+ <schema name="public" rect-visible="true" fill-color="#f0f0f0">
+ </schema>
Known bugs
----------
@@ -57,15 +55,20 @@ Known bugs
Change Log
----------
-[ v0.4.0-rc ]
+<em>Release date: February 1st, 2013 </em>
-Attention: The v0.4.0 is in beta stage so the change log can be modified at any moment when new bug fixes is created. New features will not be implemented now, instead, they will be marked to be coded starting from the v0.4.1.
+Attention: The v0.4.0 is in release-candidate stage so the change log can be modified at any moment when new bug fixes is created. New features will not be implemented now, instead, they will be marked to be coded starting from the v0.4.1.
The stable 0.4.0 has no release date yet because all the code is being refactored (almost done!) meaning that the new version will be completely decoupled from previous ones.
+* [New]: tables and view are now graphically separated by colored rectangles representing its schemas.
+* [New]: compiling pgModeler now works perfectly on Mac OSX system.
* [New]: introduced the 'Quick actions' menu that permits: rename, move to another schema, change onwer and edit permissions.
* [New]: the relationship editing form gained an "advanced" tab which shows the objects generated and/or represents the relatioship itself.
* [New]: the user now can add relationships only creating foreign keys on tables (fk relationships).
* [New]: added a french UI translation (provided by [toorpy](https://github.com/toorpy)).
+* [Change]: minor improvements on plugin base class: PgModelerPlugin.
+* [Change]: widget size adjustments to better showing on Mac OSX system.
+* [Change]: crashhandler now shows the compiled and running versions of Qt.
* [Change]: french UI translation reviewed and updated (provided by [babs](https://github.com/babs)).
* [Change]: 'Objects of Model' when used as object picker now expand all the nodes by default.
* [Change]: 'Objects of Model' now memorizes the tree state when update an object and / or opening another model.
@@ -76,6 +79,11 @@ The stable 0.4.0 has no release date yet because all the code is being refactore
* [Change]: relationship validation method now removes fk relationships when the foreign keys that gerenates is no longer exists.
* [Change]: copy/cut/delete commands does not manipulates system objects like schema public and languages C, SQL and plpgsql.
* [Change]: pgModeler startup scripts are now path location free meaning that software can be installed where the user desires.
+* [Fix]: pgModeler no longer crashes when editing objects style.
+* [Fix]: corrected bug that was deleting two sequeces at once.
+* [Fix]: pgModeler no longer crashes when removing (disconnecting) relationship that has special primary keys.
+* [Fix]: minor fixes on the startup scripts on all platforms.
+* [Fix]: corrected an incorrect reference to output stream on Windows system.
* [Fix]: shortcuts and popup menu now works correctly when selection an object on 'Objects of Model' tree.
* [Fix]: the pgsql base types (represented by tables, sequences, user defined types and domains) are now updated correctly when the related schema is renamed.
* [Fix]: corrected some weird SRID value on non spatial types.
View
2  doxygen.conf
@@ -32,7 +32,7 @@ PROJECT_NAME = "PostgreSQL Database Modeler"
# This could be handy for archiving the generated documentation or
# if some version control system is used.
-PROJECT_NUMBER = v0.4.0-beta
+PROJECT_NUMBER = v0.4.0-rc
# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer
Please sign in to comment.
Something went wrong with that request. Please try again.