summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorOndrej Zara <ondrej.zara@firma.seznam.cz>2015-04-08 10:41:21 +0200
committerOndrej Zara <ondrej.zara@firma.seznam.cz>2015-04-08 10:41:21 +0200
commit245e696eba72ec46d10a874a35db5142b2347a86 (patch)
treee94833750161ce5ae3d42a55305db0ab660ffeea
parentf5500e7b4bb07ddb9092965a5e11af295c743b51 (diff)
downloadwwwsqldesigner-245e696eba72ec46d10a874a35db5142b2347a86.zip
wwwsqldesigner-245e696eba72ec46d10a874a35db5142b2347a86.tar.gz
wwwsqldesigner-245e696eba72ec46d10a874a35db5142b2347a86.tar.bz2
migrating wiki
-rw-r--r--Changelog.md124
-rw-r--r--Extending.md32
-rw-r--r--Installation.md8
-rw-r--r--Manual.md48
-rw-r--r--ProjectHome.md68
5 files changed, 280 insertions, 0 deletions
diff --git a/Changelog.md b/Changelog.md
new file mode 100644
index 0000000..9e9ba55
--- /dev/null
+++ b/Changelog.md
@@ -0,0 +1,124 @@
+# Changelog
+
+ * **Version 2.5 (18.6.2010)**
+ * hiding of sidebar
+ * css shadows
+ * styled keys
+ * colored lines
+ * new backends: php-pdo
+ * new locales: italian, japanese, chinese
+ * new db definitions: vfp9
+ * multiselection
+ * snapping
+ * MANY bugfixes
+ * **Version 2.4 (5.11.2009)**
+ * greek and hungarian locales
+ * removal of relation
+ * keyword remembering
+ * **Version 2.3.3 (28.7.2009)**
+ * sqlalchemy db format
+ * switched to BSD licence
+ * php/mysql/file backend
+ * php-postgresql backend
+ * eo locale
+ * many tiny fixes and improvements
+ * **Version 2.3.2 (8.1.2009)**
+ * ability to draw connectors without field creation
+ * added Russian translation
+ * perl-file backend
+ * **Version 2.3.1 (29.11.2008)**
+ * unix newlines
+ * fixed FK button disabled state synchronization
+ * fixed Spanish translation (Cristián Pérez)
+ * **Version 2.3 (18.11.2008)**
+ * small typo in sample php-file
+ * comments escaping bugfix (Suzanne Dolberg)
+ * better French translation (Olivier M)
+ * PostgreSQL support (Michael Tesch)
+ * bugfix in MSSQL datatypes
+ * updated to oz.js 1.1
+ * **Version 2.2 (25.9.2008)**
+ * php-sqlite DB backend (Luke Stevenson)
+ * web2py (Boris Manojlovic) and MSSQL (Sean) datatype definitions
+ * Polish (Damian Jaroszewski), Spanish (Rubén Rodríguez Zepeda) and Brazilian (Paulo Marcelo) translation
+ * updated to oz.js 1.04
+ * **Version 2.1.1 (18.7.2008)**
+ * space after DEFAULT statement in MySQL (Patrice Ferlet, Guillaume Paton)
+ * escaping apostrophes in COMMENT statements in MySQL (Patrice Ferlet, Guillaume Paton)
+ * better use of custom event
+ * updated to oz.js 1.03
+ * **Version 2.1 (28.6.2008)**
+ * "note" attribute for datatypes (Sean)
+ * French, German and Czech localization (DerHeiko, Laurent Goussard)
+ * design name in document title (DerHeiko)
+ * updated to oz.js 1.02
+ * **Version 2.0.1 (1.4.2008)**
+ * no AUTOINCREMENT for foreign keys
+ * changed minimap color for selected table
+ * correct layering of minimap tables
+ * **Version 2.0 (28.3.2008)**
+ * rewritten from scratch
+ * smooth connectors
+ * key management
+ * custom locales, backends, dbs
+ * cookies
+ * much much more
+
+**--- OBSOLETE BELOW ---**
+
+ * **Version 1.4.1 (13.1.2008)**
+ * languages: Italian, Dutch, Traditional Chinese (Marc, Tiberti Fabio, Finjon Kiang)
+ * **Version 1.4 (25.11.2007)**
+ * improvements from Travis Kroh: PDO-based io.php, SQLite, Symphony, XSLT for MySQL export, changed order of FK names
+ * **Version 1.3.6 (28.10.2007)**
+ * FK inherits more features from PK (thanks to Cyril Zekser)
+ * Fix for import from MSSQL (thanks to Andrea)
+ * **Version 1.3.5 (5.10.2007)**
+ * FK FK inherits datatype from PK (thanks to Kevin T. Ryan)
+ * **Version 1.3.4 (24.9.2007)**
+ * two bugfixes for IE7
+ * **Version 1.3.3 (27.7.2007)**
+ * foreign Keys have editable names (revert to previous behavior)
+ * **Version 1.3.2 (20.7.2007)**
+ * patches from Tobias Stechbarth
+ * MEDIUMTEXT used for data storage (thanks to Areski)
+ * **Version 1.3.1 (30.5.2007)**
+ * numerous new translations
+ * **Version 1.3 (6.2.2007)**
+ * browser crash fix (thanks to Hiroki Yoshioka)
+ * importing existing DB schema (not in demo)
+ * Brazilian Portugese (Fabio Gomes Ramos)
+ * **Version 1.2.1 (31.1.2007)**
+ * PROPEL xslt update (Dominic Pelletier)
+ * Default language fix (Andrej Kvasnica)
+ * **Version 1.2 (21.1.2007)**
+ * XSLT template to PROPEL xml (Dominic Pelletier)
+ * patched MSSQL template (Romain Fevre)
+ * localisation (Romain Fevre)
+ * Oracle support (Romain Fevre)
+ * CHAR and DECIMAL support (Romain Fevre)
+ * **Version 1.1.8 (27.11.2006)**
+ * patches from Alex Petrescu
+ * **Version 1.1.7 (26.10.2006)**
+ * xml2postgresql template, thanks to Gérard
+ * print view, thanks to Tor Edvardsson
+ * Listing of keywords, thanks to Tor Edvardsson
+ * xml2mssql template for creating Microsoft SQL scripts, thanks to Sean
+ * direct loading of saved schema, see FAQ
+ * php script resistant to magic\_quotes\_gpc
+ * **Version 1.0 (3.10.2005)**
+ * IE hack instead of an old & ugly solution, thanks to Drew Diller
+ * mouse wheel scrolls minimap, thanks to Andreas Attemann
+ * new Settings button, does nothing :)
+ * more straightforward labels in i/o select
+ * ajax based on xmlhttp, not `<script>`
+ * bugfix - bad row order when exporting
+ * bugfix - string lengths not exported
+ * xslt tranformation now DIRECTLY IN BROWSER!
+ * button 'clear tables'
+ * optimized bar for lower resolutions
+ * major webpage changes
+ * all styling now in STYLES subdirectory
+ * changed descriptive texts on bar into `<label>`s
+ * fixed non-selectable user-added rows (thanks to Paul Thrasher)
+ * added GNU GPL licence \ No newline at end of file
diff --git a/Extending.md b/Extending.md
new file mode 100644
index 0000000..0c0c74f
--- /dev/null
+++ b/Extending.md
@@ -0,0 +1,32 @@
+
+
+# Extending
+
+Many aspects of WWW SQL Designer can be customized and enhanced. If you manage to create a new locale / db / backend, feel free to send it to me. I will include your feature in a distribution archive.
+
+## CSS
+Visual properties of the application can be tuned by editing files in `css/` subdirectory.
+
+## Locale
+Locales can be edited and added in `locale/` subdirectory. New locales must be also registered in `js/config.js`.
+
+## Databases
+Supported databases (their datatypes and XSLT template) are stored in `db/` subdirectory. Each database has a datatype definition file (`datatypes.xml`) and a XSL transformation (`output.xsl`). New databases must be also registered in `js/config.js`.
+
+## Backends
+Serverside backends allow you to save, load, list and import DB designs. They are written in a serverside scripting language and communicate via HTTP requests. Backends are stored in backend/ subdirectory. A brief summary of backend API follows:
+
+ * ### Saving
+> <strong>Request:</strong> POST ?action=save&keyword=somename, XML data contained in POST body <br />
+> <strong>Valid responses:</strong> HTTP/201 Created, HTTP/500 Internal Server Error, HTTP/503 Service Unavailable
+ * ### Loading
+> <strong>Request:</strong> GET ?action=load&keyword=somename <br />
+> <strong>Valid responses:</strong> HTTP/200 OK (loaded XML in response body), HTTP/404 Not Found, HTTP/503 Service Unavailable
+ * ### Listing
+> <strong>Request:</strong> GET ?action=list <br />
+> <strong>Valid responses:</strong> HTTP/200 OK (list of available designs separated by newlines in response body), HTTP/503 Service Unavailable
+ * ### Importing
+> <strong>Request:</strong> GET ?action=import <br />
+> <strong>Valid responses:</strong> HTTP/200 OK (imported data in response body), HTTP/503 Service Unavailable
+
+For every action mentioned, the backend may also return HTTP/501 Not Implemented, meaning that this action is not supported by the backend. \ No newline at end of file
diff --git a/Installation.md b/Installation.md
new file mode 100644
index 0000000..534efb4
--- /dev/null
+++ b/Installation.md
@@ -0,0 +1,8 @@
+# Installation
+You will need to install WWW SQL Designer if you want to:
+ * Use custom locale
+ * Use custom CSS file
+ * Use custom DB definition
+ * Use custom server backend
+
+Just [download](http://code.google.com/p/wwwsqldesigner/downloads/list) and unpack latest application archive. There are generally no requirements, but to use server-side storage, one should have a working webserver. \ No newline at end of file
diff --git a/Manual.md b/Manual.md
new file mode 100644
index 0000000..e1cebaf
--- /dev/null
+++ b/Manual.md
@@ -0,0 +1,48 @@
+# WWW SQL Designer
+
+Hello and welcome to WWW SQL Designer documentation. This page will hopefully help you with understanding how WWW SQL Desginer works and how can it be tailored to suit your needs.
+
+## Browsers
+
+WWW SQL Designer was tested in the following browsers:
+ * Firefox 2.x
+ * Firefox 3.x
+ * Internet Explorer 6
+ * Internet Explorer 7
+ * Internet Explorer 8
+ * Safari 3, 4
+ * Opera 9.x
+ * Konqueror 3.5.x
+ * Chrome 3, 4, 5
+
+Konqueror is the only browser (from this list) which lacks support for Smooth connectors and XSLT transformations (generation of SQL scripts).
+
+## Basics
+The application allows you to:
+ 1. Draw E-R designs
+ 1. Edit tables and rows
+ 1. Manage keys
+ 1. Create relations (FK constraints)
+ 1. Save & Load designs
+ 1. Import DB schemas
+
+Most commands are intuitively available from the right sidebar. Some additional tasks are described below:
+
+ * To **drag a table**, press mouse button while pointing at table header. You can then move the table around the canvas.
+
+ * To **edit table properties**, either double-click its heading, or select it and then press 'Edit table' button in sidebar.
+
+ * To **edit field properties**, either double-click it, or select it and then press 'Edit field' button in sidebar.
+
+ * To **manage keys for a table**, select a table and press 'Edit keys' button in sidebar.
+
+ * To **draw a connector (relation)**, first select a field which forms a Primary Key. You then have two options:
+ 1. Either click 'Create foreign key' button in sidebar and click target table's heading. New field and relation will be created;
+ 1. or click 'Connect foreign key' button in sidebar and click target table's field. New relation will be created.
+
+ * To **perform any kind of save/load/export/import task**, press the 'Save/Load' button in sidebar. A dialog window will appear, allowing you to perform clientside or serverside tasks. If you wish to use a server-side backend (for instance, to save your design into a database table), make sure the backend is properly configured.
+ * **Example:** The php-mysql backend stores designs in MySQL table. First, it is necessary to prepare the storage table (its definition is available in `backend/php-mysql/database.sql`); second, connection credentials must be entered into `backend/php-mysql/index.php`.
+
+ * To **automatically load a saved schema** (using default database backend), append "keyword=xyz" to URL, substituting "xyz" with the name of your saved schema.
+
+ * To **start with toolbar minimized (hidden)**, append "toolbar=hidden" to the querystring. \ No newline at end of file
diff --git a/ProjectHome.md b/ProjectHome.md
new file mode 100644
index 0000000..955f971
--- /dev/null
+++ b/ProjectHome.md
@@ -0,0 +1,68 @@
+WWW SQL Designer allows users to create database designs, which can be saved/loaded and exported to SQL scripts. Various databases and languages are supported. Ability to import existing database design.
+
+[[YouTube video](http://www.youtube.com/watch?v=hCQzJx9AKhU)]
+
+# About
+
+Hi and welcome to WWW SQL Designer! This tool allows you to draw and create database schemas (E-R diagrams) directly in browser, without the need for any external programs (flash). You only need JavaScript enabled.
+The Designer works perfectly in Mozillas (Firefox, Seamonkey), Internet Explorers (6, 7, 8), Safari and Operas. Konqueror works, but the experience is limited.
+
+Many database features are supported, such as keys, foreign key constraints, comments and indexes. You can either save your design (for further loading & modifications), print it or export as SQL script. It is possible to retrieve (import) schema from existing database.
+
+WWW SQL Designer was created by [Ondrej Zara](http://ondras.zarovi.cz/) and is built atop the [oz.js](http://code.google.com/p/oz-js/) JavaScript module. It is distributed under New BSD license.
+
+If you wish to support this project, <a href='https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=3340079'><img src='https://www.paypal.com/en_GB/i/btn/btn_donate_LG.gif' alt='Donate at PayPal' title='Donate at PayPal' /></a> at PayPal!
+
+# News
+
+## Experimental real-time collaboration version
+
+Thanks to Bharat Patil: http://bharat.whiteboard.jit.su/
+
+## New release
+
+Version 2.7 was released on 3.8.2012. This is mainly a bugfix release, although several new features (most notable localStorage support) are present.
+
+## Release
+
+Version 2.6 was released on 22.9.2011. Several new translations (pt\_BR, sv, ar) added; VML removed; new visualization options available (show length and datatype); new DBs and backends; support for touch devices...
+
+## Experimental clone with deletion of saved designs
+
+http://code.google.com/r/charlieyouakim-wwwsqldesigner-deleteadd/
+
+## New optional patch
+
+A new patch, which enable optional display of field details, was submitted by Wilson Oliveira. While this code is not ready yet to be commited into repository, everyone can download it from http://ondras.zarovi.cz/sql/wwwsqldesigner-inline_field_details_patch.zip.
+
+
+## Support for CUBRID
+
+WWW SQL Designer now supports the [CUBRID database](http://www.cubrid.org/): both as a backend (using PHP) as well as datatype definition set.
+
+
+## Release
+
+Version 2.5 was released on 18.6.2010. Many new features were added (hiding of sidebar, colored relation, multi-selection and multi-drag, ...), tons of bugs were fixed.
+
+## Release
+
+Version 2.4 was released on 5.11.2009. Several outstanding issues were fixed and new locales added.
+
+## Release
+
+Version 2.3.3 was released on 28.7.2009. This long-awaited release includes numerous fixes, compatibility improvements, new locales, backends and DB datatypes.
+
+## Release
+
+Version 2.3.2 was released on 8.1.2009. Apart from some traditional bugfixes and locales, a new functionality is introduced - the ability to mark foregin keys between existing table fields!
+
+## Google Code
+
+The project was recently moved to Google Code hosting, which (amongst many other things) introduces Subversion hosting. Enjoy! (The old website, http://ondras.zarovi.cz/sql/, will still exist for some time.)
+
+## 2.0 is here
+
+Good news: A new version of WWW SQL Designer, rewritten from scratch, is now available. I has many new features, including bezier connectors, support for various customizations, localization, options and more.
+
+Bad news: This new version is not backwards compatible with 1.x, so all old localizations and XSLT templates won't work with 2.x. Sorry for inconvenience :/ \ No newline at end of file