From 24e0220721ea692b9bbb5e96658e934eab2077f2 Mon Sep 17 00:00:00 2001 From: Marc Delisle Date: Tue, 13 Apr 2004 12:51:45 +0000 Subject: [PATCH] update --- Documentation.html | 143 +++++++++++++++++++++++---------------------- 1 file changed, 74 insertions(+), 69 deletions(-) diff --git a/Documentation.html b/Documentation.html index 9419b8d18..fc77ce3b5 100755 --- a/Documentation.html +++ b/Documentation.html @@ -105,8 +105,8 @@
  • search globally in a database or a subset of it
  • transform stored data into any format using a set of predefined functions, like displaying BLOB-data as image or download-link or ...
    • -
  • support InnoDB tables and foreign keys (see FAQ 3.6)
    • -
  • support mysqli, the improved MySQL extension (see FAQ 1.17)
    • +
  • support InnoDB tables and foreign keys (see FAQ 3.6)
    • +
  • support mysqli, the improved MySQL extension (see FAQ 1.17)
  • communicate in 47 different languages @@ -159,7 +159,7 @@ use HTTP or cookie authentication), for example with HTTP-AUTH (in a .htaccess file). See the multi-user sub-section of the FAQ - for additional information, especially FAQ 4.4.
    • + for additional information, especially FAQ 4.4.
  • Open the file <www.your-host.com>/<your-install-dir>/index.php in your browser. phpMyAdmin should now display a welcome screen @@ -168,18 +168,18 @@
  • For a whole set of new features (bookmarks, comments, SQL-history, PDF-generation, field contents transformation, etc.) you need to create a set of tables in your database. Please look at your scripts/ directory, where you should find a file called create_tables.sql. - (If you are using a Windows server, pay special attention to FAQ 1.23). + (If you are using a Windows server, pay special attention to FAQ 1.23). You can already use your phpMyAdmin to create the tables for you. Please be aware that you may have to have special (administrator) privileges to create the database and tables. After having imported the create_tables.sql file, - you should specify the table names in your config.inc.php file. The directives + you should specify the table names in your config.inc.php file. The directives used for that can be found in the Configuration section.

    • Upgrading from an older version:

    @@ -298,21 +298,21 @@ GRANT SELECT, INSERT, UPDATE, DELETE ON <pma_db>.* TO 'pma'@'localhost';
  • With this mode, the user can truly logout of phpMyAdmin and login back with the same username.
  • If you want to login to arbitrary server see - $cfg['AllowArbitraryServer'] directive.
    • + $cfg['AllowArbitraryServer'] directive.

    'config' authentication mode:

    @@ -527,7 +527,7 @@ $cfg['PmaAbsoluteUri'] = (!empty($_SERVER['HTTPS']) ? 'https' : 'http') . '://' help of cookies. Log name and password are stored in cookies during the session and password is deleted when it ends. This can also allow you to login in arbitrary server if - $cfg['AllowArbitraryServer'] enabled. + $cfg['AllowArbitraryServer'] enabled.
  • 'http' authentication (was called 'advanced' in older versions) @@ -536,12 +536,12 @@ $cfg['PmaAbsoluteUri'] = (!empty($_SERVER['HTTPS']) ? 'https' : 'http') . '://'

    • - Please see the install section on "Using authentication modes" + Please see the install section on "Using authentication modes" for more information.

    -
    +
    $cfg['Servers'][$i]['user'] string
    $cfg['Servers'][$i]['password'] string
    @@ -550,10 +550,11 @@ $cfg['PmaAbsoluteUri'] = (!empty($_SERVER['HTTPS']) ? 'https' : 'http') . '://' MySQL-server. This user/password pair is not needed when HTTP or cookie authentication is used, and should be empty.

    - -
    $cfg['Servers'][$i]['only_db'] string or array
    +
    +
    +$cfg['Servers'][$i]['only_db'] string or array
    - If set to a(an array of) database name(s), only this(these) database(s) + If set to a (an array of) database name(s), only this (these) database(s) will be shown to the user. Since phpMyAdmin 2.2.1, this/these database(s) name(s) may contain MySQL wildcards characters ("_" and "%"): if you want to use literal instances @@ -597,9 +598,9 @@ $cfg['PmaAbsoluteUri'] = (!empty($_SERVER['HTTPS']) ? 'https' : 'http') . '://' the bookmark feature you need special tables with a predefined structure, which we explain below.

    - See the Quick Install section in this document for a quick way + See the Quick Install section in this document for a quick way of creating those tables. Also, if you are using a Windows server, - read FAQ 1.23. + read FAQ 1.23.

    If you are the only user of this phpMyAdmin installation, you can use your current database to store those special tables; in this @@ -677,20 +678,20 @@ $cfg['PmaAbsoluteUri'] = (!empty($_SERVER['HTTPS']) ? 'https' : 'http') . '://' display in an optional tool-tip the "display field" when browsing the master table, if you move the mouse to a column containing a foreign key (use also the 'table_info' table);
    - (see FAQ 6.7) + (see FAQ 6.7)
  • in edit/insert mode, display a drop-down list of possible foreign keys (key value and "display field" are shown)
    - (see FAQ 6.21) + (see FAQ 6.21)
  • display links on the table properties page, to check referential integrity (display missing foreign keys) for each described key;
  • - in query-by-example, create automatic joins (see FAQ 6.6) + in query-by-example, create automatic joins (see FAQ 6.6)
  • enable you to get a PDF schema of your database (also uses the @@ -774,7 +775,6 @@ $cfg['PmaAbsoluteUri'] = (!empty($_SERVER['HTTPS']) ? 'https' : 'http') . '://' Usage tip: Display field.

    • -

    $cfg['Servers'][$i]['table_coords'] string
    @@ -788,7 +788,7 @@ $cfg['PmaAbsoluteUri'] = (!empty($_SERVER['HTTPS']) ? 'https' : 'http') . '://' table will be placed on a PDF schema output).

    You must be using the "relation" feature and have a table of - PDF pages (see $cfg['Servers'][$i]['pdf_pages']) to create PDF + PDF pages (see $cfg['Servers'][$i]['pdf_pages']) to create PDF output.

    To allow the usage of this functionality the superuser has to: @@ -883,8 +883,8 @@ $cfg['PmaAbsoluteUri'] = (!empty($_SERVER['HTTPS']) ? 'https' : 'http') . '://'        ADD `transformation` VARCHAR( 255 ) NOT NULL ,
           ADD `transformation_options` VARCHAR( 255 ) NOT NULL ;
    - and remember that the Variable in config.inc.php has been renamed - from
    $cfg['Servers'][$i]['column_comments'] to $cfg['Servers'][$i]['column_info'] + and remember that the Variable in config.inc.php has been renamed + from
    $cfg['Servers'][$i]['column_comments'] to $cfg['Servers'][$i]['column_info']
    @@ -948,8 +948,8 @@ $cfg['PmaAbsoluteUri'] = (!empty($_SERVER['HTTPS']) ? 'https' : 'http') . '://' Recommended to set to FALSE, when you are sure, your table structure is up to date.

    -
    +
    $cfg['Servers'][$i]['AllowDeny']['order'] string
    @@ -975,8 +975,8 @@ $cfg['PmaAbsoluteUri'] = (!empty($_SERVER['HTTPS']) ? 'https' : 'http') . '://' setting any order.

    -
    +
    $cfg['Servers'][$i]['AllowDeny']['rules'] array of strings
    @@ -1076,8 +1076,8 @@ $cfg['PmaAbsoluteUri'] = (!empty($_SERVER['HTTPS']) ? 'https' : 'http') . '://'
    $cfg['Confirm'] boolean
    - Whether a warning ("Are your really sure..") should be - displayed when you're about to loose data. + Whether a warning ("Are your really sure...") should be + displayed when you're about to lose data.

    @@ -1108,8 +1108,9 @@ $cfg['PmaAbsoluteUri'] = (!empty($_SERVER['HTTPS']) ? 'https' : 'http') . '://' Defaults to TRUE.

    - -
    $cfg['AllowArbitraryServer'] boolean
    +
    +
    +$cfg['AllowArbitraryServer'] boolean
    If enabled allows you to login to arbitrary server using cookie auth.

    @@ -1193,7 +1194,7 @@ $cfg['PmaAbsoluteUri'] = (!empty($_SERVER['HTTPS']) ? 'https' : 'http') . '://'

    Please note that to block the usage of phpinfo() in scripts, you - have to put this in your php.ini:
    + have to put this in your php.ini:
        disable_functions = phpinfo()

    @@ -1300,11 +1301,11 @@ $cfg['PmaAbsoluteUri'] = (!empty($_SERVER['HTTPS']) ? 'https' : 'http') . '://' $cfg['CompressOnFly'] boolean
    - Defines whether to allow ont the fly compression for GZip/BZip2 + Defines whether to allow on the fly compression for GZip/BZip2 compressed exports. This doesn't affect smaller dumps and allows to create larger dumps, that won't fit otherwise in memory due to php memory limit. Produced files contain more GZip/BZip2 headers, but all - normal programs handles this correctly. + normal programs handle this correctly.

    @@ -1377,7 +1378,7 @@ $cfg['PmaAbsoluteUri'] = (!empty($_SERVER['HTTPS']) ? 'https' : 'http') . '://'
    Type of MySQL documentation:
    -
    +
    $cfg['CtrlArrowsMoving'] boolean
    @@ -1619,8 +1620,10 @@ $cfg['PmaAbsoluteUri'] = (!empty($_SERVER['HTTPS']) ? 'https' : 'http') . '://' does not look as good as CSS.

    +
    -
    $cfg['DefaultPropDisplay'] string
    +
    +$cfg['DefaultPropDisplay'] string
    When editing/creating new columns in a table all fields normally get lined up one field a line. (default: 'horizontal'). If you set this to @@ -1686,7 +1689,7 @@ $cfg['PmaAbsoluteUri'] = (!empty($_SERVER['HTTPS']) ? 'https' : 'http') . '://'
    $cfg['Export'] array
    In this array are defined default parameters for export, names of - items are simmilar to texts seen on export page, so you can easily + items are similar to texts seen on export page, so you can easily identify what they mean.

    @@ -1780,7 +1783,7 @@ $cfg['PmaAbsoluteUri'] = (!empty($_SERVER['HTTPS']) ? 'https' : 'http') . '://' element, you can move them around in the pre-defined area and the x/y coordinates will get updated dynamically. Likewise, when entering a new position directly into the input field, the new position in the - scratchboard changes after your cursors leaves the input field. + scratchboard changes after your cursor leaves the input field.
    You have to click on the 'OK'-button below the tables to save the new positions. If you want to place a new element, first add it to the @@ -1891,7 +1894,7 @@ $cfg['PmaAbsoluteUri'] = (!empty($_SERVER['HTTPS']) ? 'https' : 'http') . '://' $cfg['SQLValidator']['password'] string
    The SOAP service allows you to login with anonymous - and any password, so we use those by default.. Instead, if + and any password, so we use those by default. Instead, if you have an account with them, you can put your login details here, and it will be used in place of the anonymous login.

    @@ -1913,7 +1916,7 @@ $cfg['PmaAbsoluteUri'] = (!empty($_SERVER['HTTPS']) ? 'https' : 'http') . '://' Enable profiling support for phpMyAdmin. This will append a chunk of data to the end of every page displayed in the main window with profiling statistics for that page.
    - You may need need to increase the maximum execution time for this to + You may need to increase the maximum execution time for this to complete successfully.
    @@ -1950,14 +1953,14 @@ $cfg['PmaAbsoluteUri'] = (!empty($_SERVER['HTTPS']) ? 'https' : 'http') . '://'
    $cfg['RestrictColumnTypes'] array
    - Mapping of column types to meta types used for prefering displayed + Mapping of column types to meta types used for preferring displayed functions. In most cases you don't need to edit this.

    $cfg['RestrictFunctions'] array
    - Functions prefered for column meta types as defined in + Functions preferred for column meta types as defined in $cfg['RestrictColumnTypes']. In most cases you don't need to edit this.

    @@ -2012,7 +2015,7 @@ installation.


    [2. Usage]

    -

    Go to your tbl_properties.inc.php page (i.e. reached through clicking on the +

    Go to your tbl_properties.inc.php page (i.e. reached through clicking on the 'properties' link for a table). There click on "Change" (or change icon) and there you will see three new fields at the end of the line. They are called 'MIME-type', 'Browser transformation' and 'Transformation options'.

    @@ -2074,7 +2077,7 @@ for many mimetypes. You can also use transforms on a different mimetype they whe for, but pay attention to option usage as well as what the transformation does to your field.


    -

    There is a basic file called 'global.inc.php'. This function can be included by +

    There is a basic file called 'global.inc.php'. This function can be included by any other transform function and provides some basic functions.


    There are 5 possible file names:

    @@ -2311,7 +2314,7 @@ To create a new, empty mimetype please see libraries/transformations/template_ge
  • give ownership to the Apache server's user.group: chown apache.apache /tmp/php
  • give proper permission: chmod 600 /tmp/php
    • -
  • put upload_tmp_dir = /tmp/php in php.ini
    • +
  • put upload_tmp_dir = /tmp/php in php.ini
  • restart Apache
    • @@ -2511,7 +2514,7 @@ To create a new, empty mimetype please see libraries/transformations/template_ge This is most likely because in php.ini, your file_uploads parameter is not set to "on".

    - +

    [1.23] I'm running MySQL on a Win32 machine. Each time I create a new table the table and field names are changed to lowercase! @@ -2568,8 +2571,8 @@ To create a new, empty mimetype please see libraries/transformations/template_ge

    This is a PHP bug that occur when - GZIP output buffering enabled. If you turn off it (by $cfg['OBGzip'] - = FALSE in config.inc.php), it should work. This bug will be fixed + GZIP output buffering is enabled. If you turn off it (by $cfg['OBGzip'] + = FALSE in config.inc.php), it should work. This bug will be fixed in PHP 5.0.0.

    @@ -2658,7 +2661,7 @@ To create a new, empty mimetype please see libraries/transformations/template_ge For RedHat users, Harald Legner suggests this on the mailing list:

    On my RedHat-Box the socket of MySQL is /var/lib/mysql/mysql.sock. - In your php.ini you will find a line + In your php.ini you will find a line
        mysql.default_socket = /tmp/mysql.sock
    @@ -2684,7 +2687,7 @@ To create a new, empty mimetype please see libraries/transformations/template_ge Then, you need to tell PHP to use this socket.
    Assuming you are using PHP 3.0.10 or better, you can specify the socket to use when you open the connection. To do this in phpMyAdmin, you need to complete the - socket information in the config.inc.php.
    + socket information in the config.inc.php.
    For example: $cfg['Servers'][$i]['socket'] = '/tmp/mysql.sock';

    Please also make sure that the permissions of this file allow to be readable @@ -2790,7 +2793,7 @@ To create a new, empty mimetype please see libraries/transformations/template_ge The invalid part of the code is the horizontal line made of dashes that appears once in every dump created with mysqldump. If you want to run your dump you have to turn it into valid MySQL. This means, you have to add a - whitespace after the first to dashes of the line or add a # before it: + whitespace after the first two dashes of the line or add a # before it:
    -- -------------------------------------------------------
    @@ -2806,12 +2809,12 @@ To create a new, empty mimetype please see libraries/transformations/template_ge are some multiple hierarchies displayed in a wrong manner?!

    - Please note that you should not use the seperating string multiple times + Please note that you should not use the separating string multiple times without any characters between them, or at the beginning/end of your table name. If you have to, think about using another TableSeparator or disabling that feature

    - +

    [3.6] What is currently not supported in phpMyAdmin about InnoDB?

    @@ -2920,6 +2923,7 @@ To create a new, empty mimetype please see libraries/transformations/template_ge open_basedir, if used, must contain "." and "./lang" to allow normal operation of phpMyAdmin.

    +

    [4.4] phpMyAdmin always gives "Access denied" when using HTTP authentication. @@ -3211,7 +3215,7 @@ To create a new, empty mimetype please see libraries/transformations/template_ge For additional help on this subject, look for the word "upload" in this document.

    - +

    [6.6] How can I use the relation table in Query-by-example?

    @@ -3289,7 +3293,7 @@ To create a new, empty mimetype please see libraries/transformations/template_ge in the configuration section, then browse your persons table, and move the mouse over a town code or country code.

    - See also FAQ 6.21 for an additionnal feature that "display field" + See also FAQ 6.21 for an additionnal feature that "display field" enables: drop-down list of possible values.

    @@ -3433,9 +3437,9 @@ To create a new, empty mimetype please see libraries/transformations/template_ge

    You can use Ctrl+arrows for moving on most pages with plenty editing - fields (table structure changes, row editing, etc.) (must be anabled in - configuration - see. $cfg['CtrlArrowsMoving']). You can also have a look - at the directive $cfg['DefaultPropDisplay'] ('vertical') and see if this + fields (table structure changes, row editing, etc.) (must be enabled in + configuration - see. $cfg['CtrlArrowsMoving']). You can also have a look + at the directive $cfg['DefaultPropDisplay'] ('vertical') and see if this eases up editing for you.

    @@ -3525,14 +3529,15 @@ To create a new, empty mimetype please see libraries/transformations/template_ge So if your users do not need those privileges, you can remove them and their databases list will shorten.

    +

    [6.21] In edit/insert mode, how can I see a list of possible values for a field, based on some foreign table?

    You have to setup appropriate links between the tables, and also - setup the "display field" in the foreign table. See FAQ - 6.6 for an example. Then, if there are 200 values or less in the + setup the "display field" in the foreign table. See FAQ + 6.6 for an example. Then, if there are 200 values or less in the foreign table, a drop-down list of values will be available. You will see two lists of values, the first list containing the key and the display field, the second list containing the display field @@ -3779,7 +3784,7 @@ CREDITS, in chronological order * many bugfixes and improvements - Robin Johnson <robbat2_at_users.sourceforge.net> - * database maintence controls + * database maintenance controls * table type code * Host authentication IP Allow/Deny * DB-based configuration (Not completed) @@ -3845,7 +3850,7 @@ CREDITS, in chronological order * PDF-scratchboard for WYSIWYG-distribution of PDF relations * new icon sets * vertical display of column properties page - * some bugfixes, features, support, german language additions + * some bugfixes, features, support, German language additions - Yukihiro Kawada <kawada_at_den.fujifilm.co.jp> * japanese kanji encoding conversion feature