From edcd09ca1bb260c747e7196244d8057089ca14ad Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Michal=20=C4=8Ciha=C5=99?= Date: Thu, 20 Mar 2014 09:39:07 +0100 Subject: [PATCH] Remove trailing whitespace from the documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Michal Čihař --- CONTRIBUTING.md | 2 +- ChangeLog | 2 +- DCO | 4 +- doc/config.rst | 16 +++---- doc/credits.rst | 80 +++++++++++++++++----------------- doc/developers.rst | 4 +- doc/faq.rst | 104 ++++++++++++++++++++++----------------------- doc/glossary.rst | 44 +++++++++---------- doc/intro.rst | 4 +- doc/privileges.rst | 2 +- doc/require.rst | 6 +-- doc/setup.rst | 66 ++++++++++++++-------------- doc/vendors.rst | 8 ++-- 13 files changed, 171 insertions(+), 171 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fdd200c5dd..ad567efbcd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,7 @@ As an open source project, phpMyAdmin welcomes contributions of many forms. ## Bug reporting -Please report [bugs on SourceForge.net][1]. +Please report [bugs on SourceForge.net][1]. [1]: https://sourceforge.net/p/phpmyadmin/bugs/new/ diff --git a/ChangeLog b/ChangeLog index b44029de0f..346df549c6 100644 --- a/ChangeLog +++ b/ChangeLog @@ -46,7 +46,7 @@ phpMyAdmin - ChangeLog - bug #4324 Datepicker not showing up on insert page - bug #3991 Problem selecting item in select boxes with the ENTER keystroke in some browsers - bug #4323 QueryWindow ignores CodeMirror -- bug None of the live charts shown on "Status -> Monitor" (Chrome) +- bug None of the live charts shown on "Status -> Monitor" (Chrome) 4.1.9.0 (2014-03-06) - bug #4279 CTRL + up or down moves two fields (part one) diff --git a/DCO b/DCO index 26fdfbfe94..ecf3258463 100644 --- a/DCO +++ b/DCO @@ -1,5 +1,5 @@ -If you would like to make a contribution to the phpMyAdmin Project, please -certify to the following: +If you would like to make a contribution to the phpMyAdmin Project, please +certify to the following: *** phpMyAdmin Developer's Certificate of Origin. Version 1.0 diff --git a/doc/config.rst b/doc/config.rst index ef43169400..bdcc9d0191 100644 --- a/doc/config.rst +++ b/doc/config.rst @@ -142,13 +142,13 @@ Basic settings preferences. If the person in charge of a multi-user installation prefers to disable this feature for all users, a value of ``'never'`` should be set, and the :config:option:`$cfg['UserprefsDisallow']` directive should - contain ``'SendErrorReports'`` in one of its array values. + contain ``'SendErrorReports'`` in one of its array values. .. config:option:: $cfg['AllowThirdPartyFraming'] :type: boolean :default: false - + Setting this to ``true`` allows phpMyAdmin to be included inside a frame, and is a potential security hole allowing cross-frame scripting attacks or clickjacking. @@ -1159,7 +1159,7 @@ Generic settings :default: false Whether to force using https while accessing phpMyAdmin. - + .. note:: In some setups (like separate SSL proxy or load balancer) you might @@ -1602,8 +1602,8 @@ Browse mode :type: string :default: ``'icons'`` - Defines whether the table navigation links contain ``'icons'``, ``'text'`` - or ``'both'``. + Defines whether the table navigation links contain ``'icons'``, ``'text'`` + or ``'both'``. .. config:option:: $cfg['ShowAll'] @@ -1791,7 +1791,7 @@ Tabs display settings :type: string :default: ``'both'`` - Defines whether the menu tabs contain ``'icons'``, ``'text'`` or ``'both'``. + Defines whether the menu tabs contain ``'icons'``, ``'text'`` or ``'both'``. .. config:option:: $cfg['ActionLinksMode'] @@ -1800,7 +1800,7 @@ Tabs display settings If set to ``icons``, will display icons instead of text for db and table properties links (like :guilabel:`Browse`, :guilabel:`Select`, - :guilabel:`Insert`, ...). Can be set to ``'both'`` + :guilabel:`Insert`, ...). Can be set to ``'both'`` if you want icons AND text. When set to ``text``, will only show text. .. config:option:: $cfg['PropertiesNumColumns'] @@ -2018,7 +2018,7 @@ Web server settings Limit for length of :term:`URL` in links. When length would be above this limit, it is replaced by form with button. This is required as some web servers (:term:`IIS`) have problems with long :term:`URL` . - + .. config:option:: $cfg['CSPAllow'] :type: string diff --git a/doc/credits.rst b/doc/credits.rst index 42059de6e2..800ce6239e 100644 --- a/doc/credits.rst +++ b/doc/credits.rst @@ -39,7 +39,7 @@ Credits, in chronological order * rewrote and optimized javascript, DHTML and DOM stuff - * rewrote the scripts so they fit the :term:`PEAR` coding standards and + * rewrote the scripts so they fit the :term:`PEAR` coding standards and generate XHTML1.0 and CSS2 compliant codes * improved the language detection system @@ -327,19 +327,19 @@ Credits, in chronological order * New plugins and properties system * Thilina Buddika Abeyrathna (Google Summer of Code 2012) - + * Refactoring * Atul Pratap Singh (Google Summer of Code 2012) - + * Refactoring * Chanaka Indrajith (Google Summer of Code 2012) - + * Refactoring * Yasitha Pandithawatta (Google Summer of Code 2012) - + * Automated testing * Jim Wigginton (phpseclib.sourceforge.net) @@ -368,7 +368,7 @@ Credits, in chronological order * Kasun Chathuranga (Google Summer of Code 2013) - * Interface improvements + * Interface improvements * Hugues Peccatte @@ -396,11 +396,11 @@ Translators Following people have contributed to translation of phpMyAdmin: -* Arabic +* Arabic * Abdullah Al-Saedi -* Bulgarian +* Bulgarian * stoyanster @@ -408,16 +408,16 @@ Following people have contributed to translation of phpMyAdmin: * Xavier Navarro -* Czech +* Czech * Michal Čihař -* Danish +* Danish * opensource * Jørgen Thomsen -* German +* German * mrbendig * torsten.funck @@ -425,7 +425,7 @@ Following people have contributed to translation of phpMyAdmin: * typo3 * Jo Michael -* Greek +* Greek * Panagiotis Papazoglou @@ -437,28 +437,28 @@ Following people have contributed to translation of phpMyAdmin: * Matías Bellone -* French +* French * Marc Delisle -* Hindi +* Hindi * u4663530 * rsedwardian -* Hungarian +* Hungarian * gergo314 -* Italian +* Italian * Rouslan Placella -* Japanese +* Japanese * Yuichiro -* Lithuanian +* Lithuanian * Kęstutis @@ -466,12 +466,12 @@ Following people have contributed to translation of phpMyAdmin: * Sven-Erik Andersen -* Dutch +* Dutch * Dieter Adriaenssens * Herman van Rink -* Polish +* Polish * Stanisław Krukowski * Marcin Kozioł @@ -480,28 +480,28 @@ Following people have contributed to translation of phpMyAdmin: * JoaoTMDias -* Portuguese (Brazil) +* Portuguese (Brazil) * wiltave * emerson4br -* Romanian +* Romanian * alexukf -* Russian +* Russian * Victor Volkov -* Sinhala +* Sinhala * Madhura Jayaratne -* Slovak +* Slovak * Martin Lacina -* Slovenian +* Slovenian * Domen @@ -509,15 +509,15 @@ Following people have contributed to translation of phpMyAdmin: * stefan -* Tamil +* Tamil * ysajeepan -* Telugu +* Telugu * veeven -* Thai +* Thai * kanitchet @@ -525,16 +525,16 @@ Following people have contributed to translation of phpMyAdmin: * Burak Yavuz -* Uighur +* Uighur * gheni -* Ukrainian +* Ukrainian * typim * oleg-ilnytskyi -* Urdu +* Urdu * Mehbooob Khan @@ -551,35 +551,35 @@ Documentation translators Following people have contributed to translation of phpMyAdmin documentation: -* Czech +* Czech * Michal Čihař -* Greek +* Greek * Panagiotis Papazoglou -* English (United Kingdom) +* English (United Kingdom) * Robert Readman -* French +* French * Cédric Corazza -* Japanese +* Japanese * Yuichiro Takahashi -* Polish +* Polish * Stanisław Krukowski -* Portuguese (Brazil) +* Portuguese (Brazil) * mjaning -* Slovenian +* Slovenian * Domen diff --git a/doc/developers.rst b/doc/developers.rst index 557452769f..ba4cfa87a7 100644 --- a/doc/developers.rst +++ b/doc/developers.rst @@ -8,5 +8,5 @@ great features have been written by other people and you too can help to make phpMyAdmin a useful tool. You can check out all the possibilities to contribute in the -`contribute section on our website -`_. \ No newline at end of file +`contribute section on our website +`_. diff --git a/doc/faq.rst b/doc/faq.rst index 133440bfca..2dde65d14b 100644 --- a/doc/faq.rst +++ b/doc/faq.rst @@ -200,7 +200,7 @@ link the MySQL extension of your choice to a MySQL client library of at least the same minor version since the one that is bundled with some PHP distributions is rather old and might cause problems see :ref:`faq1_17a`. `MariaDB `_ is also supported -(versions 5.1 and 5.2 were tested). +(versions 5.1 and 5.2 were tested). .. versionchanged:: 3.5 Since phpMyAdmin 3.5 `Drizzle `_ is supported. @@ -304,7 +304,7 @@ httpd.conf, like this: .. code-block:: apache - + # mod_gzip_item_include file \.php$ # mod_gzip_item_include mime "application/x-httpd-php.*" @@ -356,7 +356,7 @@ directives are used: .. code-block:: apache - + SetOutputFilter PHP SetInputFilter PHP @@ -374,7 +374,7 @@ restart Apache: .. code-block:: apache - + #SetOutputFilter PHP #SetInputFilter PHP @@ -441,7 +441,7 @@ forget to change directory name inside of it): .. code-block:: apache - + RewriteEngine On RewriteBase /path_to_phpMyAdmin RewriteRule ^([a-zA-Z0-9_]+)/([a-zA-Z0-9_]+)/([a-z_]+\.php)$ index.php?db=$1&table=$2&target=$3 [R] @@ -459,7 +459,7 @@ following rewrite rule: .. code-block:: apache - + RewriteEngine On RewriteRule .* - [E=REMOTE_USER:%{HTTP:Authorization},L] @@ -541,7 +541,7 @@ You can also disable the warning using the :config:option:`$cfg['SuhosinDisableW ------------------------------------------------------------------------------------------------------------------------------------ Be sure that you have enabled ``SSLOptions`` and ``StdEnvVars`` in -your Apache configuration. +your Apache configuration. .. seealso:: @@ -555,7 +555,7 @@ the set-cookie headers. Example from the Apache 2.2 documentation: .. code-block:: apache - + ProxyPass /mirror/foo/ http://backend.example.com/ ProxyPassReverse /mirror/foo/ http://backend.example.com/ ProxyPassReverseCookieDomain backend.example.com public.example.com @@ -567,7 +567,7 @@ This is not specific to phpmyadmin, it's just the behavior of Apache. .. code-block:: apache - + ProxyPass /mirror/foo/ http://backend.example.com/~user/phpmyadmin ProxyPassReverse /mirror/foo/ http://backend.example.com/%7Euser/phpmyadmin ProxyPassReverseCookiePath /%7Euser/phpmyadmin /mirror/foo @@ -593,18 +593,18 @@ some robots accessing your installation. .. code-block:: apache - + RewriteEngine on - + # Allow only GET and POST verbs RewriteCond %{REQUEST_METHOD} !^(GET|POST)$ [NC,OR] - + # Ban Typical Vulnerability Scanners and others # Kick out Script Kiddies RewriteCond %{HTTP_USER_AGENT} ^(java|curl|wget).* [NC,OR] RewriteCond %{HTTP_USER_AGENT} ^.*(libwww-perl|curl|wget|python|nikto|wkito|pikto|scan|acunetix).* [NC,OR] RewriteCond %{HTTP_USER_AGENT} ^.*(winhttp|HTTrack|clshttp|archiver|loader|email|harvest|extract|grab|miner).* [NC,OR] - + # Ban Search Engines, Crawlers to your administrative panel # No reasons to access from bots # Ultimately Better than the useless robots.txt @@ -615,7 +615,7 @@ some robots accessing your installation. .. _faq1_43: -1.43 Why can't I display the structure of my table containing hundreds of columns? +1.43 Why can't I display the structure of my table containing hundreds of columns? ---------------------------------------------------------------------------------- Because your PHP's ``memory_limit`` is too low; adjust it in :file:`php.ini`. @@ -727,7 +727,7 @@ doesn't work in this configuration with port forwarding. If you enter ----------------------------- Themes are configured with :config:option:`$cfg['ThemePath']`, -:config:option:`$cfg['ThemeManager']` and :config:option:`$cfg['ThemeDefault']`. +:config:option:`$cfg['ThemeManager']` and :config:option:`$cfg['ThemeDefault']`. Under :config:option:`$cfg['ThemePath']`, you should not delete the directory ``pmahomme`` or its underlying structure, because this is the system theme used by phpMyAdmin. ``pmahomme`` contains all images and @@ -801,7 +801,7 @@ If using APC, you must set ``apc.rfc1867`` to ``on`` in your :file:`php.ini`. If using PHP 5.4.0 or higher, you must set ``session.upload_progress.enabled`` to ``1`` in your :file:`php.ini`. However, starting from phpMyAdmin version 4.0.4, session-based upload progress has -been temporarily deactivated due to its problematic behavior. +been temporarily deactivated due to its problematic behavior. .. seealso:: :rfc:`1867` @@ -848,7 +848,7 @@ comments like this: .. code-block:: mysql - + -- MySQL dump 8.22 -- -- Host: localhost Database: database @@ -1021,7 +1021,7 @@ ISPs, multi-user installations Since version 2.0.3, you can setup a central copy of phpMyAdmin for all your users. The development of this feature was kindly sponsored by NetCologne GmbH. This requires a properly setup MySQL user management and phpMyAdmin -:term:`HTTP` or cookie authentication. +:term:`HTTP` or cookie authentication. .. seealso:: :ref:`authentication_modes` @@ -1034,8 +1034,8 @@ This depends on your system. If you're running a server which cannot be accessed by other people, it's sufficient to use the directory protection bundled with your webserver (with Apache you can use :term:`.htaccess` files, for example). If other people have telnet access to your server, you should use -phpMyAdmin's :term:`HTTP` or cookie authentication features. - +phpMyAdmin's :term:`HTTP` or cookie authentication features. + Suggestions: * Your :file:`config.inc.php` file should be ``chmod 660``. @@ -1096,7 +1096,7 @@ network :term:`IP` blocks. .. code-block:: php - + //block root from logging in except from the private networks $cfg['Servers'][$i]['AllowDeny']['order'] = 'deny,allow'; $cfg['Servers'][$i]['AllowDeny']['rules'] = array( @@ -1389,15 +1389,15 @@ create the example tables: .. code-block:: mysql - + CREATE TABLE REL_countries ( country_code char(1) NOT NULL default '', description varchar(10) NOT NULL default '', PRIMARY KEY (country_code) ) TYPE=MyISAM; - + INSERT INTO REL_countries VALUES ('C', 'Canada'); - + CREATE TABLE REL_persons ( id tinyint(4) NOT NULL auto_increment, person_name varchar(32) NOT NULL default '', @@ -1405,16 +1405,16 @@ create the example tables: country_code char(1) NOT NULL default '', PRIMARY KEY (id) ) TYPE=MyISAM; - + INSERT INTO REL_persons VALUES (11, 'Marc', 'S', ''); INSERT INTO REL_persons VALUES (15, 'Paul', 'S', 'C'); - + CREATE TABLE REL_towns ( town_code varchar(5) NOT NULL default '0', description varchar(30) NOT NULL default '', PRIMARY KEY (town_code) ) TYPE=MyISAM; - + INSERT INTO REL_towns VALUES ('S', 'Sherbrooke'); INSERT INTO REL_towns VALUES ('M', 'Montréal'); @@ -1477,9 +1477,9 @@ schema layout. Which tables will go on which pages? fit the page. When initially placing tables on the page, just pick any coordinates -- say, 50x50. After clicking Save, you can then use the :ref:`wysiwyg` to position the element correctly. -* When you'd like to look at your :term:`PDF`, first be sure to click the Save - button beneath the list of tables and coordinates, to save any changes you - made there. Then scroll all the way down, select the :term:`PDF` options you +* When you'd like to look at your :term:`PDF`, first be sure to click the Save + button beneath the list of tables and coordinates, to save any changes you + made there. Then scroll all the way down, select the :term:`PDF` options you want, and click Go. * Internet Explorer for Windows may suggest an incorrect filename when you try to save a generated :term:`PDF`. @@ -1533,7 +1533,7 @@ It means "average". * "Enclose table and column names with backquotes" ensures that column and table names formed with special characters are protected. * "Add into comments" includes column comments, relations, and MIME - types set in the pmadb in the dump as :term:`SQL` comments + types set in the pmadb in the dump as :term:`SQL` comments (*/\* xxx \*/*). **Data:** @@ -1608,7 +1608,7 @@ transformations on them. Otherwise you could just put a comment on the column. 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. +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? @@ -1626,13 +1626,13 @@ You can now access a bookmark dropdown on each page, the query box appears on for that database. You can also have, inside the query, a placeholder for a variable. -This is done by inserting into the query a SQL comment between ``/*`` and -``*/``. Inside the comment, the special string ``[VARIABLE]`` is used. +This is done by inserting into the query a SQL comment between ``/*`` and +``*/``. Inside the comment, the special string ``[VARIABLE]`` is used. Be aware that the whole query minus the SQL comment must be valid by itself, otherwise you won't be able to store it as a bookmark. -When you execute the bookmark, everything typed into the *value* -input box on the query box page will replace the string ``/*[VARIABLE]*/`` in +When you execute the bookmark, everything typed into the *value* +input box on the query box page will replace the string ``/*[VARIABLE]*/`` in your stored query. Also remember, that everything else inside the ``/*[VARIABLE]*/`` string for @@ -1642,37 +1642,37 @@ chars. So you can use: .. code-block:: mysql /*, [VARIABLE] AS myname */ - -which will be expanded to + +which will be expanded to .. code-block:: mysql , VARIABLE as myname - + in your query, where VARIABLE is the string you entered in the input box. If an -empty string is provided, no replacements are made. +empty string is provided, no replacements are made. A more complex example. Say you have stored -this query: +this query: .. code-block:: mysql SELECT Name, Address FROM addresses WHERE 1 /* AND Name LIKE '%[VARIABLE]%' */ - + Say, you now enter "phpMyAdmin" as the variable for the stored query, the full -query will be: +query will be: .. code-block:: mysql SELECT Name, Address FROM addresses WHERE 1 AND Name LIKE '%phpMyAdmin%' You can use multiple occurrences of ``/*[VARIABLE]*/`` in a single query -(that is, multiple occurrences of the *same* variable). +(that is, multiple occurrences of the *same* variable). **NOTE THE ABSENCE OF SPACES** inside the ``/**/`` construct. Any spaces inserted there will be later also inserted as spaces in your query and may lead to unexpected results especially when using the variable expansion inside of a -"LIKE ''" expression. +"LIKE ''" expression. Your initial query which is going to be stored as a bookmark has to yield at least one result row so you can store the bookmark. You may have that to work @@ -1689,7 +1689,7 @@ have table exported in file :file:`table.tex`): .. code-block:: latex - + \documentclass{article} % or any class you want \usepackage{longtable} % for displaying table \begin{document} % start of document @@ -1739,7 +1739,7 @@ public bookmark, it will be executed. ----------------------------------------------------------------- You can use :term:`CSV` for Microsoft Excel, -which works out of the box. +which works out of the box. .. versionchanged:: 3.4.5 Since phpMyAdmin 3.4.5 support for direct export to Microsoft Excel version @@ -1879,7 +1879,7 @@ The Zoom search feature is an alternative to table search feature. It allows you to explore a table by representing its data in a scatter plot. You can locate this feature by selecting a table and clicking the :guilabel:`Search` tab. One of the sub-tabs in the :guilabel:`Table Search` page is -:guilabel:`Zoom Search`. +:guilabel:`Zoom Search`. Consider the table REL\_persons in :ref:`faq6_6` for an example. To use zoom search, two columns need to be selected, for @@ -1887,7 +1887,7 @@ example, id and town\_code. The id values will be represented on one axis and town\_code values on the other axis. Each row will be represented as a point in a scatter plot based on its id and town\_code. You can include two additional search criteria apart from -the two fields to display. +the two fields to display. You can choose which field should be displayed as label for each point. If a display column has been set @@ -1895,7 +1895,7 @@ for the table (see :ref:`faqdisplay`), it is taken as the label unless you specify otherwise. You can also select the maximum number of rows you want to be displayed in the plot by specifing it in the 'Max rows to plot' field. Once you have decided over your criteria, click 'Go' -to display the plot. +to display the plot. After the plot is generated, you can use the mousewheel to zoom in and out of the plot. In addition, panning @@ -2003,11 +2003,11 @@ Synchronization .. _faq9_1: -9.1 (withdrawn). +9.1 (withdrawn). ---------------- .. _faq9_2: -9.2 (withdrawn). +9.2 (withdrawn). ---------------- diff --git a/doc/glossary.rst b/doc/glossary.rst index d558b44059..bf22a559cb 100644 --- a/doc/glossary.rst +++ b/doc/glossary.rst @@ -20,7 +20,7 @@ From Wikipedia, the free encyclopedia .. seealso:: - Browser + Browser a software application that enables a user to display and interact with text, images, and other information typically located on a web page at a website on the World Wide Web. .. seealso:: @@ -30,7 +30,7 @@ From Wikipedia, the free encyclopedia .. seealso:: - CGI + CGI Common Gateway Interface is an important World Wide Web technology that enables a client web browser to request data from a program executed on the Web server. @@ -62,7 +62,7 @@ From Wikipedia, the free encyclopedia .. seealso:: - DB + DB look at :term:`database` database @@ -70,7 +70,7 @@ From Wikipedia, the free encyclopedia .. seealso:: - Engine + Engine look at :term:`storage engines` extension @@ -78,7 +78,7 @@ From Wikipedia, the free encyclopedia .. seealso:: - FAQ + FAQ Frequently Asked Questions is a list of commonly asked question and there answers. @@ -101,12 +101,12 @@ From Wikipedia, the free encyclopedia .. seealso:: - GD + GD Graphics Library by Thomas Boutell and others for dynamically manipulating images. .. seealso:: - GD2 + GD2 look at :term:`gd` gzip @@ -124,7 +124,7 @@ From Wikipedia, the free encyclopedia .. seealso:: - HTTP + HTTP HyperText Transfer Protocol is the primary method used to transfer or convey information on the World Wide Web. @@ -138,7 +138,7 @@ From Wikipedia, the free encyclopedia IEC International Electrotechnical Commission - IIS + IIS Internet Information Services is a set of Internet-based services for servers using Microsoft Windows. @@ -149,7 +149,7 @@ From Wikipedia, the free encyclopedia .. seealso:: - IP + IP Internet Protocol is a data-oriented protocol used by source and destination hosts for communicating data across a packet-switched internetwork. @@ -161,19 +161,19 @@ From Wikipedia, the free encyclopedia .. seealso:: - IPv6 - IPv6 (Internet Protocol version 6) is the latest revision of the - Internet Protocol (:term:`IP`), designed to deal with the + IPv6 + IPv6 (Internet Protocol version 6) is the latest revision of the + Internet Protocol (:term:`IP`), designed to deal with the long-anticipated problem of its precedessor IPv4 running out of addresses. .. seealso:: - ISAPI + ISAPI Internet Server Application Programming Interface is the API of Internet Information Services (IIS). .. seealso:: - ISP + ISP Internet service provider is a business or organization that offers users access to the Internet and related services. @@ -187,7 +187,7 @@ From Wikipedia, the free encyclopedia .. seealso:: - JPG + JPG look at :term:`jpeg` Key @@ -218,7 +218,7 @@ From Wikipedia, the free encyclopedia .. seealso:: - MIME + MIME Multipurpose Internet Mail Extensions is an Internet Standard for the format of e-mail. @@ -254,7 +254,7 @@ From Wikipedia, the free encyclopedia .. seealso:: - PDF + PDF Portable Document Format is a file format developed by Adobe Systems for representing two dimensional documents in a device independent and resolution independent format. @@ -266,7 +266,7 @@ From Wikipedia, the free encyclopedia .. seealso:: - PCRE + PCRE Perl Compatible Regular Expressions is the perl-compatible regular expression functions for PHP @@ -324,7 +324,7 @@ From Wikipedia, the free encyclopedia .. seealso:: - SSL + SSL Secure Sockets Layer is a cryptographic protocol which provides secure communication on the Internet. @@ -353,7 +353,7 @@ From Wikipedia, the free encyclopedia .. seealso:: - TCP + TCP Transmission Control Protocol is one of the core protocols of the Internet protocol suite. @@ -386,7 +386,7 @@ From Wikipedia, the free encyclopedia .. seealso:: - XML + XML Extensible Markup Language is a W3C-recommended general- purpose markup language for creating special-purpose markup languages, capable of describing many different kinds of data. diff --git a/doc/intro.rst b/doc/intro.rst index 9576814d3c..080598ce83 100644 --- a/doc/intro.rst +++ b/doc/intro.rst @@ -24,8 +24,8 @@ Currently phpMyAdmin can: * execute, edit and bookmark any :term:`SQL`-statement, even batch-queries * load text files into tables * create [#f1]_ and read dumps of tables -* export [#f1]_ data to various formats: :term:`CSV`, :term:`XML`, :term:`PDF`, - :term:`ISO`/:term:`IEC` 26300 - :term:`OpenDocument` Text and Spreadsheet, Microsoft +* export [#f1]_ data to various formats: :term:`CSV`, :term:`XML`, :term:`PDF`, + :term:`ISO`/:term:`IEC` 26300 - :term:`OpenDocument` Text and Spreadsheet, Microsoft Word 2000, and LATEX formats * import data and :term:`MySQL` structures from :term:`OpenDocument` spreadsheets, as well as :term:`XML`, :term:`CSV`, and :term:`SQL` files diff --git a/doc/privileges.rst b/doc/privileges.rst index 0c12932d0b..ba5ce6848f 100644 --- a/doc/privileges.rst +++ b/doc/privileges.rst @@ -10,7 +10,7 @@ control over creating users, viewing and editing privileges for existing users, and removing users. Within phpMyAdmin, user management is controlled via the :guilabel:`Users` link -from the main page. Users can be created, edited, and removed. +from the main page. Users can be created, edited, and removed. Creating a new user ------------------- diff --git a/doc/require.rst b/doc/require.rst index 4582d72869..377128b005 100644 --- a/doc/require.rst +++ b/doc/require.rst @@ -12,7 +12,7 @@ web server (such as Apache, :term:`IIS`) to install phpMyAdmin's files into. PHP --- -* You need PHP 5.3.0 or newer, with ``session`` support, the Standard PHP Library +* You need PHP 5.3.0 or newer, with ``session`` support, the Standard PHP Library (SPL) extension, JSON support, and the ``mbstring`` extension. * To support uploading of ZIP files, you need the PHP ``zip`` extension. @@ -27,7 +27,7 @@ PHP * To support upload progress bars, see :ref:`faq2_9`. -* To support XML and Open Document Spreadsheet importing, you need the +* To support XML and Open Document Spreadsheet importing, you need the `libxml `_ extension. * Performance suggestion: install the ``ctype`` extension. @@ -37,7 +37,7 @@ PHP Database -------- -phpMyAdmin supports MySQL-compatible databases. +phpMyAdmin supports MySQL-compatible databases. * MySQL 5.5 or newer * MariaDB 5.5 or newer diff --git a/doc/setup.rst b/doc/setup.rst index 6161154d48..271c4d2630 100644 --- a/doc/setup.rst +++ b/doc/setup.rst @@ -36,7 +36,7 @@ OpenSUSE OpenSUSE already comes with phpMyAdmin package, just install packages from the `openSUSE Build Service `_. - + Ubuntu ------ @@ -53,9 +53,9 @@ install. Mandriva -------- - + Mandriva ships the phpMyAdmin package in their ``contrib`` branch and can be -installed via the usual Control Center. +installed via the usual Control Center. Fedora ------ @@ -66,9 +66,9 @@ official phpMyAdmin documentation. Red Hat Enterprise Linux ------------------------ - + Red Hat Enterprise Linux itself and thus derivatives like CentOS don't -ship phpMyAdmin, but the Fedora-driven repository +ship phpMyAdmin, but the Fedora-driven repository `Extra Packages for Enterprise Linux (EPEL) `_ is doing so, if it's `enabled `_. @@ -81,7 +81,7 @@ Installing on Windows +++++++++++++++++++++ The easiest way to get phpMyAdmin on Windows is using third party products -which include phpMyAdmin together with a database and web server such as +which include phpMyAdmin together with a database and web server such as `XAMPP `_. You can find more of such options at `Wikipedia `_. @@ -94,7 +94,7 @@ Quick Install #. Choose an appropriate distribution kit from the phpmyadmin.net Downloads page. Some kits contain only the English messages, others - contain all languages. We'll assume you chose a kit whose name + contain all languages. We'll assume you chose a kit whose name looks like ``phpMyAdmin-x.x.x -all-languages.tar.gz``. #. Untar or unzip the distribution (be sure to unzip the subdirectories): ``tar -xzvf phpMyAdmin_x.x.x-all-languages.tar.gz`` in your @@ -129,10 +129,10 @@ simple configuration may look like this: .. code-block:: xml+php - + -For a full explanation of possible configuration values, see the +For a full explanation of possible configuration values, see the :ref:`config` of this document. .. index:: Setup script @@ -169,7 +169,7 @@ Linux/Unix system you can use the following commands: .. code-block:: sh - + cd phpMyAdmin mkdir config # create directory for saving chmod o+rw config # give it world writable permissions @@ -178,7 +178,7 @@ And to edit an existing configuration, copy it over first: .. code-block:: sh - + cp config.inc.php config/ # copy current configuration for editing chmod o+w config/config.inc.php # give it world writable permissions @@ -203,7 +203,7 @@ measure: .. code-block:: sh - + mv config/config.inc.php . # move file to current directory chmod o-rw config.inc.php # remove world read and write permissions rm -rf config # remove not needed directory @@ -235,7 +235,7 @@ options which the setup script does not provide. webserver or limit access by web server configuration, see :ref:`faq1_42`. -.. index:: +.. index:: single: Configuration storage single: phpMyAdmin configuration storage single: pmadb @@ -268,16 +268,16 @@ depending on the database name. After having imported the :file:`examples/create_tables.sql` file, you should specify the table names in your :file:`config.inc.php` file. The -directives used for that can be found in the :ref:`config`. +directives used for that can be found in the :ref:`config`. -You will also need to have a controluser +You will also need to have a controluser (:config:option:`$cfg['Servers'][$i]['controluser']` and :config:option:`$cfg['Servers'][$i]['controlpass']` settings) -with the proper rights to those tables. For example you can create it +with the proper rights to those tables. For example you can create it using following statement: .. code-block:: mysql - + GRANT SELECT, INSERT, UPDATE, DELETE ON .* TO 'pma'@'localhost' IDENTIFIED BY 'pmapass'; .. _upgrading: @@ -318,7 +318,7 @@ configuration file. :term:`HTTP` and cookie authentication modes are more secure: the MySQL login information does not need to be -set in the phpMyAdmin configuration file (except possibly for the +set in the phpMyAdmin configuration file (except possibly for the :config:option:`$cfg['Servers'][$i]['controluser']`). However, keep in mind that the password travels in plain text, unless you are using the HTTPS protocol. In cookie mode, the password is @@ -330,12 +330,12 @@ privileges to an ordinary user, unless you understand the impact of those privileges (for example, you are creating a superuser). For example, to grant the user *real_user* with all privileges on the database *user_base*: - + .. code-block:: mysql - + GRANT ALL PRIVILEGES ON user_base.* TO 'real_user'@localhost IDENTIFIED BY 'real_password'; - - + + What the user may now do is controlled entirely by the MySQL user management system. With HTTP or cookie authentication mode, you don't need to fill the user/password fields inside the :config:option:`$cfg['Servers']`. @@ -347,8 +347,8 @@ HTTP authentication mode * Uses :term:`HTTP` Basic authentication method and allows you to log in as any valid MySQL user. -* Is supported with most PHP configurations. For :term:`IIS` (:term:`ISAPI`) - support using :term:`CGI` PHP see :ref:`faq1_32`, for using with Apache +* Is supported with most PHP configurations. For :term:`IIS` (:term:`ISAPI`) + support using :term:`CGI` PHP see :ref:`faq1_32`, for using with Apache :term:`CGI` see :ref:`faq1_35`. * See also :ref:`faq4_4` about not using the :term:`.htaccess` mechanism along with ':term:`HTTP`' authentication mode. @@ -360,7 +360,7 @@ HTTP authentication mode Cookie authentication mode -------------------------- -* You can use this method as a replacement for the :term:`HTTP` authentication +* You can use this method as a replacement for the :term:`HTTP` authentication (for example, if you're running :term:`IIS`). * Obviously, the user must enable cookies in the browser, but this is now a requirement for all authentication modes. @@ -427,7 +427,7 @@ Authentication is disabled by default. To enable it, add the following line to :file:`config.inc.php`: .. code-block:: php - + $cfg['Servers'][$i]['auth_swekey_config'] = '/etc/swekey.conf'; You then have to create the ``swekey.conf`` file that will associate @@ -448,14 +448,14 @@ Securing your phpMyAdmin installation The phpMyAdmin team tries hard to make the application secure, however there are always ways to make your installation more secure: -* remove ``setup`` directory from phpMyAdmin, you will probably not +* remove ``setup`` directory from phpMyAdmin, you will probably not use it after initial setup * properly choose authentication method - :ref:`cookie` is probably the best choice for shared hosting -* in case you don't want all MySQL users to be able to access +* in case you don't want all MySQL users to be able to access phpMyAdmin, you can use :config:option:`$cfg['Servers'][$i]['AllowDeny']['rules']` to limit them -* consider hiding phpMyAdmin behind authentication proxy, so that +* consider hiding phpMyAdmin behind authentication proxy, so that MySQL credentials are not all users need to login -* if you are afraid of automated attacks, enabling Captcha by +* if you are afraid of automated attacks, enabling Captcha by :config:option:`$cfg['CaptchaLoginPublicKey']` and :config:option:`$cfg['CaptchaLoginPrivateKey']` might be an option. diff --git a/doc/vendors.rst b/doc/vendors.rst index 13d7e550ad..94044f4d79 100644 --- a/doc/vendors.rst +++ b/doc/vendors.rst @@ -24,11 +24,11 @@ one we ship. Currently known list of external libraries: -js/jquery +js/jquery jQuery js framework and various jQuery based libraries. -libraries/php-gettext +libraries/php-gettext php-gettext library -libraries/tcpdf - tcpdf library, stripped down of not needed files +libraries/tcpdf + tcpdf library, stripped down of not needed files