diff --git a/config.rst b/config.rst index 4050467347..c6a6657f0c 100644 --- a/config.rst +++ b/config.rst @@ -18,10 +18,10 @@ Configuration Almost all configurable data is placed in :file:`config.inc.php`. If this file does not exist, please refer to the :ref:`setup` section to create one. This file only needs to contain the parameters you want to change from their corresponding - default value in ``libraries/config.default.php``. + default value in :file:`libraries/config.default.php`. The parameters which relate to design (like colors) are placed in - ``themes/themename/layout.inc.php``. You might also want to create + :file:`themes/themename/layout.inc.php`. You might also want to create :file:`config.footer.inc.php` and :file:`config.header.inc.php` files to add your site specific code to be included on start and end of each page. @@ -1942,7 +1942,7 @@ Theme settings :default: Navigation panel width in pixels. See - ``themes/themename/layout.inc.php``. + :file:`themes/themename/layout.inc.php`. .. config:option:: $cfg['NaviBackground'] @@ -1955,7 +1955,7 @@ Theme settings :default: The background styles used for both the frames. See - ``themes/themename/layout.inc.php``. + :file:`themes/themename/layout.inc.php`. .. config:option:: $cfg['NaviPointerBackground'] @@ -1968,14 +1968,14 @@ Theme settings :default: The style used for the pointer in the navi frame. See - ``themes/themename/layout.inc.php``. + :file:`themes/themename/layout.inc.php`. .. config:option:: $cfg['Border'] :type: integer :default: - The size of a table's border. See ``themes/themename/layout.inc.php``. + The size of a table's border. See :file:`themes/themename/layout.inc.php`. .. config:option:: $cfg['ThBackground'] @@ -1988,7 +1988,7 @@ Theme settings :default: The style used for table headers. See - ``themes/themename/layout.inc.php``. + :file:`themes/themename/layout.inc.php`. .. _cfg_BgcolorOne: .. config:option:: $cfg['BgOne'] @@ -1997,7 +1997,7 @@ Theme settings :default: The color (HTML) #1 for table rows. See - ``themes/themename/layout.inc.php``. + :file:`themes/themename/layout.inc.php`. .. _cfg_BgcolorTwo: .. config:option:: $cfg['BgTwo'] @@ -2006,7 +2006,7 @@ Theme settings :default: The color (HTML) #2 for table rows. See - ``themes/themename/layout.inc.php``. + :file:`themes/themename/layout.inc.php`. .. config:option:: $cfg['BrowsePointerBackground'] @@ -2033,7 +2033,7 @@ Theme settings and the latter lets you visually mark/unmark rows by clicking on the corresponding checkbox. Highlighting / marking a column is done by hovering over / clicking the column's header (outside of the text). - See ``themes/themename/layout.inc.php``. + See :file:`themes/themename/layout.inc.php`. .. config:option:: $cfg['FontFamily'] @@ -2041,7 +2041,7 @@ Theme settings :default: You put here a valid CSS font family value, for example ``arial, sans- - serif``. See ``themes/themename/layout.inc.php``. + serif``. See :file:`themes/themename/layout.inc.php`. .. config:option:: $cfg['FontFamilyFixed'] @@ -2049,7 +2049,7 @@ Theme settings :default: You put here a valid CSS font family value, for example ``monospace``. - This one is used in textarea. See ``themes/themename/layout.inc.php``. + This one is used in textarea. See :file:`themes/themename/layout.inc.php`. Design customization -------------------- diff --git a/faq.rst b/faq.rst index c07070e042..9bc64ed648 100644 --- a/faq.rst +++ b/faq.rst @@ -622,7 +622,7 @@ blank lines, no spaces, no characters...) neither before the ```` tag at the end. We also got a report from a user under :abbr:`IIS (Internet Information Services)`, that used a zipped distribution kit: the file -``libraries/Config.class.php`` contained an end-of-line character (hex +:file:`libraries/Config.class.php` contained an end-of-line character (hex 0A) at the end; removing this character cleared his errors. .. _faq2_2: @@ -731,13 +731,13 @@ To create a theme: * copy the files and directories from "pmahomme" to "your\_theme\_name" * edit the css-files in "your\_theme\_name/css" * put your new images in "your\_theme\_name/img" -* edit ``layout.inc.php`` in "your\_theme\_name" -* edit ``info.inc.php`` in "your\_theme\_name" to contain your chosen +* edit :file:`layout.inc.php` in "your\_theme\_name" +* edit :file:`info.inc.php` in "your\_theme\_name" to contain your chosen theme name, that will be visible in user interface * make a new screenshot of your theme and save it under "your\_theme\_name/screen.png" -In theme directory there is file ``info.inc.php`` which contains theme +In theme directory there is file :file:`info.inc.php` which contains theme verbose name, theme generation and theme version. These versions and generations are enumerated from 1 and do not have any direct dependence on phpMyAdmin version. Themes within same generation should diff --git a/setup.rst b/setup.rst index f1f7c913c4..9b62030744 100644 --- a/setup.rst +++ b/setup.rst @@ -51,10 +51,10 @@ Manualy creating file --------------------- To manually create the file, simply use your text editor to create the -file :file:`config.inc.php` (you can copy ``config.sample.inc.php`` to get +file :file:`config.inc.php` (you can copy :file:`config.sample.inc.php` to get minimal configuration file) in the main (top-level) phpMyAdmin -directory (the one that contains ``index.php``). phpMyAdmin first -loads ``libraries/config.default.php`` and then overrides those values +directory (the one that contains :file:`index.php`). phpMyAdmin first +loads :file:`libraries/config.default.php` and then overrides those values with anything found in :file:`config.inc.php`. If the default value is okay for a particular setting, there is no need to include it in :file:`config.inc.php`. You'll need a few directives to get going, a @@ -218,7 +218,7 @@ For compatibility with PHP 6, remove a ``set_magic_quotes_runtime(0);`` statement that you might find near the end of your configuration file. -You should **not** copy ``libraries/config.default.php`` over +You should **not** copy :file:`libraries/config.default.php` over :file:`config.inc.php` because the default configuration file is version- specific.