Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/phpmyadmin/phpmyadmin.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorWilliam Desportes <williamdes@wdes.fr>2020-04-05 22:22:34 +0300
committerWilliam Desportes <williamdes@wdes.fr>2020-04-05 22:22:34 +0300
commitefed667497e0448d9fd186841c4fc4fa99bfe324 (patch)
tree962cf51fe79b1fee02a0bac08eaf1f9ae686bc33 /doc/transformations.rst
parentc21a758e5a82b63aeb81335c4d8bdf5869b4d8e4 (diff)
Some documentation improvements
Signed-off-by: William Desportes <williamdes@wdes.fr>
Diffstat (limited to 'doc/transformations.rst')
-rw-r--r--doc/transformations.rst16
1 files changed, 8 insertions, 8 deletions
diff --git a/doc/transformations.rst b/doc/transformations.rst
index 9eeb754080..5020132978 100644
--- a/doc/transformations.rst
+++ b/doc/transformations.rst
@@ -45,12 +45,12 @@ Usage
Go to your *tbl\_structure.php* page (i.e. reached through clicking on
the 'Structure' 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
+They are called ':term:`Media type`', 'Browser transformation' and
'Transformation options'.
-* The field 'MIME-type' is a drop-down field. Select the MIME-type that
+* The field ':term:`Media type`' is a drop-down field. Select the :term:`Media type` that
corresponds to the column's contents. Please note that transformations
- are inactive as long as no MIME-type is selected.
+ are inactive as long as no :term:`Media type` is selected.
* The field 'Browser transformation' is a drop-down field. You can
choose from a hopefully growing amount of pre-defined transformations.
See below for information on how to build your own transformation.
@@ -100,11 +100,11 @@ transformations always work. It makes no sense to apply a
transformation to a mimetype the transform-function doesn't know to
handle.
-There is a file called '*transformations.lib.php*' that provides some
+There is a file called ':file:`libraries/classes/Plugins/Transformations.php`' that provides some
basic functions which can be included by any other transform function.
The file name convention is ``[Mimetype]_[Subtype]_[Transformation
-Name].class.php``, while the abtract class that it extends has the
+Name].php``, while the abtract class that it extends has the
name ``[Transformation Name]TransformationsPlugin``. All of the
methods that have to be implemented by a transformations plug-in are:
@@ -118,8 +118,8 @@ getInfo() returns the transformation's description and possible
options it may receive and applyTransformation() is the method that
does the actual work of the transformation plug-in.
-Please see the libraries/classes/Plugins/Transformations/TEMPLATE and
-libraries/classes/Plugins/Transformations/TEMPLATE\_ABSTRACT files for adding
+Please see the :file:`libraries/classes/Plugins/Transformations/TEMPLATE` and
+:file:`libraries/classes/Plugins/Transformations/TEMPLATE\_ABSTRACT` files for adding
your own transformation plug-in. You can also generate a new
transformation plug-in (with or without the abstract transformation
class), by using
@@ -139,5 +139,5 @@ The applyTransformation() method always gets passed three variables:
<https://www.php.net/mysql_fetch_field>`_ are available in this
variable and can be used to transform a column accordingly to
unsigned/zerofill/not\_null/... properties. The $meta->mimetype
- variable contains the original MIME-type of the column (i.e.
+ variable contains the original :term:`Media type` of the column (i.e.
'text/plain', 'image/jpeg' etc.)