From 529e28b1532d26f928b9c316a8048493f654eed3 Mon Sep 17 00:00:00 2001 From: "Alexander M. Turek" Date: Thu, 27 Feb 2003 23:07:43 +0000 Subject: [PATCH] typos --- ChangeLog | 6 +- Documentation.html | 190 +++++++++++++++++++------------------- scripts/create_tables.sql | 5 +- 3 files changed, 101 insertions(+), 100 deletions(-) diff --git a/ChangeLog b/ChangeLog index da6d32c77..43af43ccc 100755 --- a/ChangeLog +++ b/ChangeLog @@ -5,17 +5,19 @@ phpMyAdmin - Changelog $Id$ $Source$ -2003-02-17 Michal Cihar +2003-02-27 Michal Cihar * lang/czech: Updated. * lang/english: Resorted. -2003-02-25 Alexander M. Turek +2003-02-27 Alexander M. Turek * libraries/common.lib.php3, libraries/config_import.lib.php3: - Backwards compatibility; - Removed some unnecessary code; - Added a small HOWTO. * config.inc.php3: The tab settings don't fit into the 'left frame' part. * lang/german-*.inc.php3: Grammar. + * Documentation.html: Fixed some dead links. + * scripts/create_tables.sql: Adjusted table comments. 2003-02-27 Garvin Hicking * libraries/common.lib.php3, tbl_properties_links.php3, db_details_links.php3, diff --git a/Documentation.html b/Documentation.html index 331fc1dec..77d76392d 100755 --- a/Documentation.html +++ b/Documentation.html @@ -110,7 +110,7 @@
  • using Query-by-example (QBE), create complex queries automatically connecting required tables
  • create PDF graphics of your Database layout
  • search globally in a database or a subset of it
    • -
  • transform stored data into any format using a set of predefined functions, +
  • transform stored data into any format using a set of predefined functions, like displaying BLOB-data as image or download-link or ...
  • communicate in @@ -179,13 +179,13 @@ in your browser. phpMyAdmin should now display a welcome screen and your databases, or a login dialog if using http or cookie authentication mode.
    • -
  • For a whole set of new features (bookmarks, comments, sql-history, pdf-generation) +
  • For a whole set of new features (bookmarks, comments, sql-history, pdf-generation) 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. You can already use your phpMyAdmin to create the tables for you. Please be aware that you may have to have special (adminstrator) 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.php3 file. The directives + you should specify the table names in your config.inc.php3 file. The directives used for that can be found in the Configuration section.
    • @@ -772,13 +772,13 @@ $cfg['PmaAbsoluteUri'] = (!empty($_SERVER['HTTPS']) ? 'https' : 'http') . '://' Since release 2.3.0 you can store comments to describe each column for each table. These will then be shown on the "printview".

    - Starting with release 2.5.0, comments are consequently used on the table property + Starting with release 2.5.0, comments are consequently used on the table property pages and table browse view, showing up as tooltips above the column name (properties page) or embedded withing the header of table in browse view. They can also be shown in a table dump. Please see the relevant configuration directives later on.

    Also new in release 2.5.0 is a mime-transformation system which is also based on - the following table structure. See Transformations + the following table structure. See Transformations for further information. To use the mime-transformation system, your column_info table has to have the three new fields 'mimetype', 'transformation', 'transformation_options'.

    @@ -819,15 +819,15 @@ $cfg['PmaAbsoluteUri'] = (!empty($_SERVER['HTTPS']) ? 'https' : 'http') . '://' entered manually into the phpMyAdmin interface. If you don't want to use a table- based history, you can use the JavaScript-based history. Using that, all your history items are deleted when closing the window.

    - + Using $cfg['QueryHistoryMax'] you can specify an amount of history items you want to have on hold. On every login, this list gets cut to the maximum amount.

    - + The query history is only available if you use the JavaScript-based query window, see $cfg['QueryFrame'].

    - + To allow the usage of this functionality the superuser has to:
    • set up "pmadb" as described above
      • @@ -863,14 +863,14 @@ $cfg['PmaAbsoluteUri'] = (!empty($_SERVER['HTTPS']) ? 'https' : 'http') . '://' column_info table got enhanced with thre new fields. If the above variable is set to TRUE (default) phpMyAdmin will check if you have the latest table structure available. If not, it will emit a warning to the superuser.

      - + You can disable this checking behavior by setting the variable to false, which should offer a performance increase.

      - + Recommended to set to FALSE, when you are sure, your table structure is up to date.

      - +
      $cfg['Servers'][$i]['AllowDeny']['order'] string
      @@ -1183,7 +1183,7 @@ $cfg['PmaAbsoluteUri'] = (!empty($_SERVER['HTTPS']) ? 'https' : 'http') . '://' "server_processlist.php3".

      - +
      $cfg['DefaultTabDatabase'] string
      Defines the tab displayed by default on database view. Possible @@ -1403,7 +1403,7 @@ $cfg['PmaAbsoluteUri'] = (!empty($_SERVER['HTTPS']) ? 'https' : 'http') . '://' $cfg['HeaderFlipType'] string
      - There are 3 display modes: horizontal, horizontalflipped and vertical. Define + There are 3 display modes: horizontal, horizontalflipped and vertical. Define which one is displayed by default. The first mode displays each row on a horiztonal line, the second rotates the headers by 90 degrees, so you can use descriptive headers even though fields only contain small values and still @@ -1424,7 +1424,7 @@ $cfg['PmaAbsoluteUri'] = (!empty($_SERVER['HTTPS']) ? 'https' : 'http') . '://'
      $cfg['ShowBrowseComments'] boolean
      - $cfg['ShowPropertyComments'] boolean
      + $cfg['ShowPropertyComments'] boolean
      By setting the corresponding variable to TRUE you can enable the display of @@ -1492,14 +1492,14 @@ $cfg['PmaAbsoluteUri'] = (!empty($_SERVER['HTTPS']) ? 'https' : 'http') . '://' variable $cfg['QueryWindowDefTab'] you can specify the default tab to be used when opening the query window. It can be set to either 'sql', 'files', 'history' or 'full'.

      - The variable $cfg['QueryFrameDebug'] can be used by developers for easier future + The variable $cfg['QueryFrameDebug'] can be used by developers for easier future feature integration.

      $cfg['BrowseMIME'] boolean
      - Enable MIME-transformations. + Enable MIME-transformations.

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

      [1. Introduction]

      -

      To enable transformations, you have to setup the column_info table and the proper +

      To enable transformations, you have to setup the column_info table and the proper directives. Please see the Configuration section on how to do so.


      -

      You can apply different transformations to the contents of each field. The -transformation will take the content of each field and transform it with +

      You can apply different transformations to the contents of each field. The +transformation will take the content of each field and transform it with certain rules defined in the selected transformation.


      -

      Say you have a field 'filename' which contains a filename. Normale you would see -in phpMyAdmin only this filename. Using transformations you can transform that filename -into a html link, so you can click inside of the phpMyAdmin structure on the field's +

      Say you have a field 'filename' which contains a filename. Normale you would see +in phpMyAdmin only this filename. Using transformations you can transform that filename +into a html link, so you can click inside of the phpMyAdmin structure on the field's link and will see the file displayed in a new browser window. Using transformation -options you can also specify strings to append/prepend to a string or the format you +options you can also specify strings to append/prepend to a string or the format you want the output stored in.


      -

      For a general overview of all available transformations and their options, you can +

      For a general overview of all available transformations and their options, you can consult your <www.your-host.com>/<your-install-dir>/libraries/transformations/overview.php3 installation.



      @@ -1683,161 +1683,161 @@ installation.



      [2. Usage]

      -

      Go to your tbl_properties.inc.php3 page (i.e. reached through clicking on the -'properties' link for a table). There you will see three new fields at the end of the +

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


        -
      • The field 'MIME-type' is a dropdown field. You have the options to leave that field -empty or to use 'auto' [this feature is not yet available]. Please note that +
      • The field 'MIME-type' is a dropdown field. You have the options to leave that field +empty or to use 'auto' [this feature is not yet available]. Please note that transformations are inactive as long as no mimetype is selected.


        • -
      • The field 'Browser transformation' is a dropdown field. You can choose from a -hopefully growing amount of pre-defined transformations. See below for information on +
      • The field 'Browser transformation' is a dropdown field. You can choose from a +hopefully growing amount of pre-defined transformations. See below for information on how to build your own transformation.

        -There are global transformations and mimetype-bound transformations. Global transformations -can be used for any mimetype. They will take the mimetype, if neccessary, into regard. -Mimetype-bound transformations usually only operate on a certain mimetype. There are -transformations which operate on the main mimetype (like 'image'), which will most likely -take the subtype into regard, and those who only operate on a +There are global transformations and mimetype-bound transformations. Global transformations +can be used for any mimetype. They will take the mimetype, if neccessary, into regard. +Mimetype-bound transformations usually only operate on a certain mimetype. There are +transformations which operate on the main mimetype (like 'image'), which will most likely +take the subtype into regard, and those who only operate on a specific subtype (like 'image/jpeg').

        -You can use transformations on mimetypes for which the function was not defined for. There -is no security check for you selected the right transformation, so take care of what the +You can use transformations on mimetypes for which the function was not defined for. There +is no security check for you selected the right transformation, so take care of what the output will be like.


        • -
      • The field 'Transformation options' is a free-type textfield. You have to enter -transform-function specific options here. Usually the transforms can operate with default -options, but it is generally a good idea to look up the overview to see which options are +
      • The field 'Transformation options' is a free-type textfield. You have to enter +transform-function specific options here. Usually the transforms can operate with default +options, but it is generally a good idea to look up the overview to see which options are neccessary.

        -Much like the ENUM/SET-Fields, you have to split up several options using the format -'a','b','c',...(NOTE THE MISSING BLANKS). This is because internally the options will be +Much like the ENUM/SET-Fields, you have to split up several options using the format +'a','b','c',...(NOTE THE MISSING BLANKS). This is because internally the options will be parsed as an array, leaving the first value the first element in the array, and so forth.

        -If you want to specify a MIME charset you can define it in the transformation_options. -You have to put that outside of the pre-defined options of the specific mime-transform, -as the last value of the set. Use the format "'; charset=XXX'". If you use a transform, -for which you can specify 2 options and you want to append a charset, enter "'first -parameter','second parameter','charset=us-ascii'". You can, however use the defaults for +If you want to specify a MIME charset you can define it in the transformation_options. +You have to put that outside of the pre-defined options of the specific mime-transform, +as the last value of the set. Use the format "'; charset=XXX'". If you use a transform, +for which you can specify 2 options and you want to append a charset, enter "'first +parameter','second parameter','charset=us-ascii'". You can, however use the defaults for the parameters: "'','','charset=us-ascii'".



      [3. File structure]

      -

      All mimetypes and their transformations are defined through single files in +

      All mimetypes and their transformations are defined through single files in the directory 'libraries/transformations/'.


      -

      They are stored in files to ease up customization and easy adding of new +

      They are stored in files to ease up customization and easy adding of new transformations.


      -

      Because the user cannot enter own mimetypes, it is kept sure that transformations -always work. It makes no sense to apply a transformation to a mimetype, the +

      Because the user cannot enter own mimetypes, it is kept sure that transformations +always work. It makes no sense to apply a transformation to a mimetype, the transform-function doesn't know to handle.


      -

      One can, however, use empty mime-types and global transformations which should work -for many mimetypes. You can also use transforms on a different mimetype they where built -for, but pay attention to option usage as well as what the transformation does to your +

      One can, however, use empty mime-types and global transformations which should work +for many mimetypes. You can also use transforms on a different mimetype they where built +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.php3'. This function can be included by +

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


      There are 5 possible file names:

      1. A mimetype+subtype transform:

        - + [mimetype]_[subtype]__[transform].inc.php3

        - - Please not that mimetype and subtype are seperated via '_', which shall not be - contained in their names. The transform function/filename may contain only - characters which cause no problems in the file system as well as the PHP function + + Please not that mimetype and subtype are seperated via '_', which shall not be + contained in their names. The transform function/filename may contain only + characters which cause no problems in the file system as well as the PHP function naming convention.

        - + The transform function will the be called 'PMA_transform_[mimetype]_[subtype]__[transform]()'.

        - + Example:

        - + text_html__formatted.inc.php3
        PMA_transform_text_html__formatted()


      2. A mimetype (w/o subtype) transform:

        - + [mimetype]__[transform].inc.php3

        - + Please note that there are no single '_' characters. - The transform function/filename may contain only characters which cause no problems + The transform function/filename may contain only characters which cause no problems in the file system as well as the PHP function naming convention.

        The transform function will the be called 'PMA_transform_[mimetype]__[transform]()'.

        - + Example:

        - + text__formatted.inc.php3
        PMA_transform_text__formatted()


      3. A mimetype+subtype without specific transform function

        - + [mimetype]_[subtype].inc.php3

        - - Please note that there are no '__' characters in the filename. Do not use special + + Please note that there are no '__' characters in the filename. Do not use special characters in the filename causing problems with the file system.

        - + No transformation function is defined in the file itself.

        - + Example:

        - + text_plain.inc.php3
        (No function)


      4. A mimetype (w/o subtype) without specific transform function

        - + [mimetype].inc.php3

        - - Please note that there are no '_' characters in the filename. Do not use special + + Please note that there are no '_' characters in the filename. Do not use special characters in the filename causing problems with the file system.

        - + No transformation function is defined in the file itself.

        - + Example:

        - + text.inc.php3
        (No function)


        5. - +
      5. A global transform function with no specific mimetype

        - + global__[transform].inc.php3

        - + The transform function will the be called 'PMA_transform_global__[transform]()'.

        - + Example:

        - + global__formatted
        PMA_transform_global__formatted()

      -

      So generally use '_' to split up mimetype and subtype, and '__' to provide a +

      So generally use '_' to split up mimetype and subtype, and '__' to provide a transform function.


      -

      All filenames containing no '__' in themselves are not shown as valid transform +

      All filenames containing no '__' in themselves are not shown as valid transform functions in the dropdown.


      -

      Please see the libraries/transformations/TEMPLATE file for adding your own transform -function. See the libraries/transformations/TEMPLATE_MIMETYPE for adding a mimetype -without a transform function. Also note the introduction of a function description in -the language files. For each function a $strTransformation_[filename without .inc.php3] +

      Please see the libraries/transformations/TEMPLATE file for adding your own transform +function. See the libraries/transformations/TEMPLATE_MIMETYPE for adding a mimetype +without a transform function. Also note the introduction of a function description in +the language files. For each function a $strTransformation_[filename without .inc.php3] has to exist.


      -

      You can use the template generator to generate new functions and entries in the +

      You can use the template generator to generate new functions and entries in the language file.


      -

      To create a new transform function please see libraries/transformations/template_generator.sh. +

      To create a new transform function please see libraries/transformations/template_generator.sh. To create a new, empty mimetype please see libraries/transformations/template_generator_mimetype.sh.


      @@ -2910,7 +2910,7 @@ To create a new, empty mimetype please see libraries/transformations/template_ge

      - [6.17] Transformations: I can't enter my own mimetype! WTF is this feature + [6.17] Transformations: I can't enter my own mimetype! WTF is this feature then useful for?

      @@ -2918,7 +2918,7 @@ To create a new, empty mimetype please see libraries/transformations/template_ge Otherwise you could just put a comment on the field. Because entering your own mimetype will cause serious syntax checking issues and validation, this introduces a high-risk false-user-input situation. Instead you have to initialize mimetypes using functions or empty mimetype definitions. -
      +
      Plus, you have a whole overview of available mimetypes. Who knows all those mimetypes by heart so he/she can enter it at will?
      diff --git a/scripts/create_tables.sql b/scripts/create_tables.sql index da6efb43a..d897e5428 100644 --- a/scripts/create_tables.sql +++ b/scripts/create_tables.sql @@ -45,7 +45,7 @@ CREATE TABLE `PMA_table_info` ( `table_name` varchar(64) NOT NULL default '', `display_field` varchar(64) NOT NULL default '', PRIMARY KEY (`db_name`, `table_name`) - ) TYPE=MyISAM COMMENT='Table information for phpMyAdmin'; + ) TYPE=MyISAM COMMENT='Table information for phpMyAdmin'; CREATE TABLE `PMA_table_coords` ( `db_name` varchar(64) NOT NULL default '', @@ -73,10 +73,9 @@ CREATE TABLE `PMA_column_info` ( mimetype varchar(255) NOT NULL default '', transformation varchar(255) NOT NULL default '', transformation_options varchar(255) NOT NULL default '', - PRIMARY KEY (id), UNIQUE KEY db_name (db_name, table_name, column_name) - ) TYPE=MyISAM COMMENT='Comments for Columns'; + ) TYPE=MyISAM COMMENT='Column Information for phpMyAdmin'; CREATE TABLE `PMA_history` ( `id` BIGINT UNSIGNED NOT NULL AUTO_INCREMENT,