[Phpmyadmin-devel] Configuration directives for the navigation

[Rouslan Placella]

On 07/14/2012 03:23 PM, Marc Delisle wrote:
> Le 2012-07-14 10:07, Dieter Adriaenssens a écrit :
>> 2012/7/14 Marc Delisle <marc at infomarc.info>:
>>> Le 2012-07-14 09:49, Dieter Adriaenssens a écrit :
>>>> 2012/7/14 Rouslan Placella <rouslan at placella.com>:
>>>>> Hi all,
>>>>>
>>>>> As I am currently reviewing the configuration directives that are
>>>>> related to the navigation system, I'd like to share what I've done so
>>>>> far and also seek some advice.
>>>>>
>>>>> So far, I've dropped the following 3 directives, as they won't really
>>>>> make any sense in pma 4:
>>>>>       * AllowThirdPartyFraming
>>>>>       * LeftFrameLight
>>>>>       * DisplayDatabasesList
>>>>
>>>> Makes sense.
>>>>
>>>>> However I have a dilemma about some other directives. For example, the
>>>>> old navigation system used the MaxDbList and MaxTableList directives to
>>>>> decide how many items to render on a page. These directives are also
>>>>> used by other code to display lists of dbs and tables in the main frame.
>>>>> Anyway, I'd like to lower the default values for these directives from
>>>>> 100 and 250 respectively to 25. This is because the new navigation
>>>>> system has excellent pagination and filtering capabilities, and
>>>>> therefore I think that it would be better to save some vertical space.
>>>>> That said, I think that it would be better to introduce a new directive
>>>>> that will be only used in the navigation without affecting the display
>>>>> of items in the main frame. For example: $cfg['NavigationItemsPerPage'].
>>>>
>>>> Not sure about this one. I think 'NavigationItemsPerPage' can be
>>>> useful, but if you have that one, why would you still need to lower
>>>> the defaults of MaxDbList and MaxTableList? I suppose the smallest
>>>> config value would get priority.
>>>> 'MaxNavigationItems' would be a better name for
>>>> 'NavigationItemsPerPage', it would be more similar to the two other
>>>> 'Max***List' directives.

I think I got it wrong above, I meant that I would like to leave the 
existing directives unaffected and set the default value of the new 
directive MaxNavigationItems to 25.

>>>>> I also found the following two directives: ShowTooltipAliasDB and
>>>>> ShowTooltipAliasTB. These are currently unused in my branch as I'm not
>>>>> even sure what they do. Could someone please enlighten me on their purpose?
>>>>>
>>>>> And as a last question: Many configuration directives that relate to the
>>>>> navigation start with "LeftFrame*", but as frames are being dropped is
>>>>> it better to rename them to "Navigation*"?
>>>>
>>>> There are also some config parameters that just start with "Left".
>>>> That said, I think it makes sense to rename them. Also because the
>>>> left frame is on the right for 'rtl' languages, so 'Navigation' prefix
>>>> is more generic.

Agreed

>>>> But we have to decide how this transition will go :
>>>> 1) the 'Left' or 'LeftFrame' prefixes in the config options get
>>>> renamed to 'Navigation', the old config options names are dropped, and
>>>> a list is made to be added to the release notes, telling users which
>>>> options are renamed.
>>>> 2) the same as 1), but we also add a script to convert the renamed
>>>> config option names.
>>>> 3) the same as 1), but we mark the renamed config options as
>>>> deprecated and allow both config options until the next major release.
>>>>
>>>> I'm in favor of 2)
>>>
>>> Dieter,
>>> do you mean a script that would run at the setup level, or manually, or
>>> at the user execution level?
>>
>> I mean a script that is manually run once when upgrading from 3.5.* to
>> 4.*. The script would replace all renamed config options in the
>> config.inc.php file, using a sed command. (but this will not work on
>> windows, so a different script would be needed for Windows)
>> Or we could include this converter in the 'setup' script, that would
>> work for all host systems. But I don't think most people run the setup
>> when upgrading phpMyAdmin to a newer version.
>
> We also have to take into account the same directives, saved in User
> preferences.
>
> I'm not sure it's worth the job for all this, so I'm in favor of your
> suggestion #1.
>

I also vote for #1