documentation

docs/databasewindow/index.rst

@@ -60,6 +60,7 @@ the sort order.
 Tables
 ======
 
+Double clicking a table will open a crud tab for that tabel
 
 Note the sizes are retrieved in the background and can take some time to appear
 on large databases.
@@ -76,3 +77,24 @@ When a row is selected SQL for dropping or creating that column and also
 to just fix the default or NULL constraint this is useful when inspecting
 one database to correct another. When multiple rows are selected SQL for all
 those rows is shown.
+
+*********
+Crud tabs
+*********
+
+If the table had no primary key the data will be readonly. Generated always
+columns will ofcourse also be readonly. Use :kbd:`tab` to go from one field to
+the next accept your changes with :kbd:`Enter`. To enter a value for a boolean
+column use :kbd:`t` for true or :kbd:`f` for false.
+
+An empty value will be seen as a NULL to enter an empty string use two single quotes ''.
+
+When data is saved the program will generate INSERT and UPDATE queries that
+return the data that was actually put in the database by the server and update
+the data in the grid to match. This includes data for generated columns.
+
+Shortcuts:
+
+* :kbd:`Ctrl+D` delete selected rows.
+* :kbd:`F5` reload data
+* :kbd:`Ctrl+W` close tab

docs/installation.rst

@@ -11,8 +11,32 @@ Windows
 Downloads can be found `here
 <https://eelkeklein.stackstorage.com/s/E9xkMGQDFjHv5XN3>`_.
 
+
+Installation
+============
+
 Unpack the contents of the 7zip archive to a folder of your choosing for
-instance `C:\\Program files\\pgLab`. You can run the pgLab.exe from there. If
+instance `%ProgramFiles%\\pgLab`. You can run the pgLab.exe from there. If
 it is complaining about missing files this is probably because the required
 Visual C++ Runtime has not yet been installed on your machine you can get it
 from `microsoft <https://aka.ms/vs/17/release/vc_redist.x64.exe>`_.
+
+If you want a shortcut you can make one by copying the exe and then choosing
+:menuselection:`Paste shortcut` from the context menu in the location where you
+want the shortcut.
+
+Upgrade
+=======
+
+Note this section assumes you have not saved any of your own data to
+the folder in which you unpacked pgLab. If you did move it to another location.
+
+Download the new archive, replace the contents of the folder with the contents
+of the new archive. Any shortcuts or pinned taskbar buttons should still work.
+
+Uninstall
+=========
+
+Just remove the folder you unpacked pgLab in. If you also want to remove all user
+data you should also remove `%AppData%\\pglab` for each user that has used the
+program.

docs/internals.rst

@@ -9,3 +9,4 @@ User data
 All connection configuration information is stored in
 `%AppData%\\pglab\\pglab\\pglabuser.db` this is an sqlite database.
 
+

docs/preface.rst

@@ -13,7 +13,8 @@ you can ofcourse execute DDL to create anything you like.
 but it has currently no priority for me.)
 
 The strong point of pgLab are:
-* seperation of different databases into seperate windows.
+
+* separation of different databases into separate windows.
 * inspecting of database with subtabs in a single main tab so the list of toplevel tabs stays short.
 * very fast processing of query results millions of rows are no problem.