Backported basic Wsat documentation

10 files changed, 78 insertions, 7 deletions

diff --git a/demos/quickstart/protected/controls/TopicList.tpl b/demos/quickstart/protected/controls/TopicList.tpl
index dbb744b6..de10398c 100755
--- a/demos/quickstart/protected/controls/TopicList.tpl
+++ b/demos/quickstart/protected/controls/TopicList.tpl
@@ -8,6 +8,8 @@
     <li><a href="?page=GettingStarted.Installation">Installation</a></li>

     <li><a href="?page=GettingStarted.NewFeatures">New Features</a></li>

     <li><a href="?page=GettingStarted.Upgrading">Upgrading from v2.x and v1.x</a></li>

+    <li><a href="?page=GettingStarted.Wsat">Web Site Administration Tool</a></li>

+    <li><a href="?page=GettingStarted.CommandLine">Command Line Tool</a></li>

 </ul>

 </div>

 

@@ -18,7 +20,6 @@
     <li><a href="?page=Fundamentals.Hangman">Sample: Hangman Game</a></li>

     <li><a href="?page=Tutorial.CurrencyConverter">Currency Converter</a></li>

 	<li><a href="?page=Tutorial.AjaxChat">AJAX Chat Client</a></li>

-    <li><a href="?page=GettingStarted.CommandLine">Command Line Tool</a></li>

 </ul>

 </div>

 

diff --git a/demos/quickstart/protected/controls/es/TopicList.tpl b/demos/quickstart/protected/controls/es/TopicList.tpl
index 41359ac2..c7b90a47 100755
--- a/demos/quickstart/protected/controls/es/TopicList.tpl
+++ b/demos/quickstart/protected/controls/es/TopicList.tpl
@@ -8,6 +8,8 @@
     <li><a href="?page=GettingStarted.Installation">Instalación</a></li>

     <li><a href="?page=GettingStarted.NewFeatures">Nuevas Funcionalidades</a></li>

     <li><a href="?page=GettingStarted.Upgrading">Actualizar desde la version v2.x y v1.x</a></li>

+    <li><a href="?page=GettingStarted.Wsat">Web Site Administration Tool</a></li>

+    <li><a href="?page=GettingStarted.CommandLine">Command Line Tool</a></li>

 </ul>

 </div>

 

@@ -19,7 +21,6 @@
     <li><a href="?page=Tutorial.CurrencyConverter">Convertidor de Monedas</a></li>

 	<li><a href="?page=Tutorial.AddressBook">Libreta de direcciones</a></li>

 	<li><a href="?page=Tutorial.AjaxChat">Cliente Chat en AJAX </a></li>

-    <li><a href="?page=GettingStarted.CommandLine">Command Line Tool</a></li>

 </ul>

 </div>

 

diff --git a/demos/quickstart/protected/controls/fr/TopicList.tpl b/demos/quickstart/protected/controls/fr/TopicList.tpl
index c2de4a9a..0e28ff40 100755
--- a/demos/quickstart/protected/controls/fr/TopicList.tpl
+++ b/demos/quickstart/protected/controls/fr/TopicList.tpl
@@ -8,6 +8,8 @@
     <li><a href="?page=GettingStarted.Installation">Installation</a></li>

     <li><a href="?page=GettingStarted.NewFeatures">Nouvelles fonctionnalités</a></li>

     <li><a href="?page=GettingStarted.Upgrading">Mise à jour de v2.x et v1.x</a></li>

+    <li><a href="?page=GettingStarted.Wsat">Web Site Administration Tool</a></li>

+    <li><a href="?page=GettingStarted.CommandLine">Outil en ligne de commande</a></li>

 </ul>

 </div>

 

@@ -18,7 +20,6 @@
     <li><a href="?page=Fundamentals.Hangman">Exemple : Jeu du pendu</a></li>

     <li><a href="?page=Tutorial.CurrencyConverter">Convertisseur monétaire</a></li>

 	<li><a href="?page=Tutorial.AjaxChat">Chat AJAX</a></li>

-    <li><a href="?page=GettingStarted.CommandLine">Outil en ligne de commande</a></li>

 </ul>

 </div>

 

diff --git a/demos/quickstart/protected/controls/id/TopicList.tpl b/demos/quickstart/protected/controls/id/TopicList.tpl
index fa00ee37..d362dc19 100755
--- a/demos/quickstart/protected/controls/id/TopicList.tpl
+++ b/demos/quickstart/protected/controls/id/TopicList.tpl
@@ -8,6 +8,8 @@
     <li><a href="?page=GettingStarted.Installation">Instalasi</a></li>

     <li><a href="?page=GettingStarted.NewFeatures">Fitur Baru</a></li>

     <li><a href="?page=GettingStarted.Upgrading">Meningkatkan dari v2.x dan v1.x</a></li>

+    <li><a href="?page=GettingStarted.Wsat">Web Site Administration Tool</a></li>

+    <li><a href="?page=GettingStarted.CommandLine">Piranti Baris Perintah</a></li>

 </ul>

 </div>

 

@@ -19,7 +21,6 @@
     <li><a href="?page=Tutorial.CurrencyConverter">Pengubah Kurs</a></li>

 	<li><a href="?page=Tutorial.AddressBook">Buku Alamat</a></li>

 	<li><a href="?page=Tutorial.AjaxChat">Klient Obrolan AJAX</a></li>

-    <li><a href="?page=GettingStarted.CommandLine">Piranti Baris Perintah</a></li>

 </ul>

 </div>

 

diff --git a/demos/quickstart/protected/controls/ja/TopicList.tpl b/demos/quickstart/protected/controls/ja/TopicList.tpl
index bfdbf129..d9ded44a 100755
--- a/demos/quickstart/protected/controls/ja/TopicList.tpl
+++ b/demos/quickstart/protected/controls/ja/TopicList.tpl
@@ -8,6 +8,8 @@
     <li><a href="?page=GettingStarted.Installation">インストール</a></li>

     <li><a href="?page=GettingStarted.NewFeatures">新機能</a></li>

     <li><a href="?page=GettingStarted.Upgrading">v2.x v1.x からのバージョンアップ</a></li>

+    <li><a href="?page=GettingStarted.Wsat">Web Site Administration Tool</a></li>

+    <li><a href="?page=GettingStarted.CommandLine">コマンドラインツール</a></li>

 </ul>

 </div>

 

@@ -19,7 +21,6 @@
     <li><a href="?page=Tutorial.CurrencyConverter">通貨コンバーター</a></li>

 	<li><a href="?page=Tutorial.AddressBook">アドレス帳</a></li>

 	<li><a href="?page=Tutorial.AjaxChat">Ajax チャット</a></li>

-    <li><a href="?page=GettingStarted.CommandLine">コマンドラインツール</a></li>

 </ul>

 </div>

 

diff --git a/demos/quickstart/protected/controls/pl/TopicList.tpl b/demos/quickstart/protected/controls/pl/TopicList.tpl
index 8d33914e..1e0ff347 100755
--- a/demos/quickstart/protected/controls/pl/TopicList.tpl
+++ b/demos/quickstart/protected/controls/pl/TopicList.tpl
@@ -8,6 +8,8 @@
     <li><a href="?page=GettingStarted.Installation">Instalacja</a></li>

     <li><a href="?page=GettingStarted.NewFeatures">Nowe możliwości</a></li>

     <li><a href="?page=GettingStarted.Upgrading">Aktualizacja z wersji 2.x oraz 1.x</a></li>

+    <li><a href="?page=GettingStarted.Wsat">Web Site Administration Tool</a></li>

+    <li><a href="?page=GettingStarted.CommandLine">Narzędzie linii poleceń</a></li>

 </ul>

 </div>

 

@@ -18,7 +20,6 @@
     <li><a href="?page=Fundamentals.Hangman">Przykład: gra wisielec</a></li>

     <li><a href="?page=Tutorial.CurrencyConverter">Konwenter walut</a></li>

 	  <li><a href="?page=Tutorial.AjaxChat">AJAX-owy klient czat</a></li>

-    <li><a href="?page=GettingStarted.CommandLine">Narzędzie linii poleceń</a></li>

 </ul>

 </div>

 

diff --git a/demos/quickstart/protected/controls/zh/TopicList.tpl b/demos/quickstart/protected/controls/zh/TopicList.tpl
index 6557a992..023eb01a 100755
--- a/demos/quickstart/protected/controls/zh/TopicList.tpl
+++ b/demos/quickstart/protected/controls/zh/TopicList.tpl
@@ -8,6 +8,8 @@
     <li><a href="?page=GettingStarted.Installation">安装</a></li>

     <li><a href="?page=GettingStarted.NewFeatures">版本新功能</a></li>

     <li><a href="?page=GettingStarted.Upgrading">从v2.x和v1.x升级</a></li>

+    <li><a href="?page=GettingStarted.Wsat">Web Site Administration Tool</a></li>

+    <li><a href="?page=GettingStarted.CommandLine">命令行工具</a></li>

 </ul>

 </div>

 

@@ -18,7 +20,6 @@
     <li><a href="?page=Fundamentals.Hangman">Hangman游戏</a></li>

     <li><a href="?page=Tutorial.CurrencyConverter">货币转换程序</a></li>

 	<li><a href="?page=Tutorial.AjaxChat">AJAX聊天程序</a></li>

-    <li><a href="?page=GettingStarted.CommandLine">命令行工具</a></li>

 </ul>

 </div>

 

diff --git a/demos/quickstart/protected/pages/GettingStarted/Wsat.page b/demos/quickstart/protected/pages/GettingStarted/Wsat.page
new file mode 100644
index 00000000..3d07e6f2
--- /dev/null
+++ b/demos/quickstart/protected/pages/GettingStarted/Wsat.page
@@ -0,0 +1,64 @@
+<com:TContent ID="body">
+    <h1>Web Site Administration Tool</h1>
+    <p class="block-content">
+        Web Site Administration Tool (WSAT) is a development tool which allows you to perform several
+        tedious tasks of a PRADO project in a GUI fashion. Its inspired in both Asp.Net - Web Site Administration Tool and Yii's Gii.
+        WSAT will continue gaining new features along the time, at the moment it bring you the followings:
+        
+        <ul>
+            <li>Generate one or all <a href="?page=Database.ActiveRecord">Active Record Classes.</a></li>
+            <li>Optionally generate all relationships in Active Record Classes.</li>
+            <li>Generate the magic __toString() method in all AR Classes.</li>
+        </ul>
+    </p>
+
+    <h2>Requirements</h2>
+    <p class="block-content">
+        To use WSAT, you need to add in your project configuration file: <tt>application.xml</tt>, 
+        in the services section the wsat service like follows:
+
+<com:TTextHighlighter CssClass="source" Language="xml">
+<services> 
+    ...
+    <service id="wsat" class="System.Wsat.TWsatService" Password="my_secret_password" />
+</services>
+</com:TTextHighlighter>
+    </p>
+
+    <h2>Usage</h2>
+    <p class="block-content">
+        Then you are ready to go to: http://localhost/yoursite/index.php?wsat=TWsatLogin and doing so you should see
+        the following page:
+    </p>
+    <img src="<%~wsat_login.png%>" style="width: 700px;" />
+    <p class="block-content">
+        Where in the text field you need to type the password previosly specified in the service inclusion. This 
+        is part of a basic security system to avoid undesirable persons to use this tool.
+    </p>
+    
+    <h2>Active Record classes generation</h2>
+    <p class="block-content">
+        In order to generate AR classes you need to go to: http://localhost/divermania/index.php?wsat=TWsatGenerateAR 
+        by clicking the proper links in the welcome page. Then you should see the following page:        
+    </p>
+    <img src="<%~wsat_generate_ar.png%>" style="width: 700px;" />
+    <p class="block-content">
+        In which you can find a basic usage documentation in a light green panel 
+        and then some proper fields in order to generate active record classes. These fields are:
+    </p>
+    
+    <ul>
+        <li><b>Table Name: </b> refers to the table name in your database for which you want to generate an AR class.
+        Let it as come by default with an * to generate them all.</li>
+        <li><b>Output Folder: </b> refers to the folder where you want to save your generated classes.
+        It only accepts namespace format which means that you need to specify your path separated with points in between.
+        It default value is: "Application.App_Data.AR_Classes" which references the protected/App_Data/AR_Classes
+        file of your project, if you haven't created them yet and you want to, don't bother, WSAT will do it for you.</li>
+        <li><b>Class Prefix: </b> refers to the prefix that you whish to specify in front of every class name. 
+            Clear the field to specify no prefix.</li>
+        <li><b>Class Suffix: </b> refers to the suffix that you whish to specify at the end of every class name.
+            Clear the field to specify no suffix.</li>
+        <li><b>Build Relations: </b> whether or not you want to add relationships to AR classes generation.</li>
+    </ul>
+    
+</com:TContent>
\ No newline at end of file
diff --git a/demos/quickstart/protected/pages/GettingStarted/wsat_generate_ar.png b/demos/quickstart/protected/pages/GettingStarted/wsat_generate_ar.png
new file mode 100644
index 00000000..8f0f59e7
--- /dev/null
+++ b/demos/quickstart/protected/pages/GettingStarted/wsat_generate_ar.png
diff --git a/demos/quickstart/protected/pages/GettingStarted/wsat_login.png b/demos/quickstart/protected/pages/GettingStarted/wsat_login.png
new file mode 100644
index 00000000..dbe1ad8b
--- /dev/null
+++ b/demos/quickstart/protected/pages/GettingStarted/wsat_login.png