Page MenuHomePhabricator

Document all parameters that can be used in LocalSettings.php
Closed, InvalidPublic

Description

While trying out a new version of the UsabilityInitiative extension, I found that some variables that can be set in LocalSettings.php are not documented. They should be added to the README file.

Specifically, at least the following settings are undocumented:
$wgDefaultUserOptions['wikieditor-highlight'] = 1;
$wgDefaultUserOptions['wikieditor-preview'] = 1;
$wgDefaultUserOptions['usebetatoolbar'] = 1;
$wgDefaultUserOptions['usebetatoolbar-cgd'] = 1;
$wgNavigableTOCCollapseEnable = true;
$wgNavigableTOCResizable = true;

There may be more which I didn't find.


Version: unspecified
Severity: minor

Details

Reference
bz21511

Event Timeline

bzimport raised the priority of this task from to Low.Nov 21 2014, 10:55 PM
bzimport set Reference to bz21511.
bzimport added a subscriber: Unknown Object (MLST).

We're aware of this, there's some FIXME comments in the README file. While we do make an effort to make our code usable for other people, it's not our top priority, especially while MediaWiki 1.16 hasn't been released yet. So we'll get to documenting stuff properly eventually, but it could take some more time.

I fully understand that. It's just that I find your work pretty amazing and want to have it on my wiki as soon as possible :) By sometimes testing the current state and reporting the issues I find, I hope to help you and make sure that your work is usable outside wikimedia in the not too distant future.

My hope is that these bugreports serve as friendly reminders and don't annoy you. If they do annoy you, please tell me, so I can be more careful in the future.

Thanks for your wonderful work!

(In reply to comment #2)

I fully understand that. It's just that I find your work pretty amazing and
want to have it on my wiki as soon as possible :)

Yay!

By sometimes testing the
current state and reporting the issues I find, I hope to help you and make sure
that your work is usable outside wikimedia in the not too distant future.

My hope is that these bugreports serve as friendly reminders and don't annoy
you. If they do annoy you, please tell me, so I can be more careful in the
future.

Thanks for your wonderful work!

We're always happy to receive bug reports, don't hold back on any because we'd maybe be annoyed. Of course we have to prioritize, so some bug reports rot longer than others.

sakshi.april5 wrote:

Hello,
I am a beginner and would like to fix this bug. Also where exactly should we add these lines in the README file?

(In reply to comment #5)

Also where exactly should we add these lines in the README file?

Probably https://www.mediawiki.org/wiki/Manual:LocalSettings.php instead.
Which exact README file do you refer to?

sakshi.april5 wrote:

So these variables need to be set in LocalSettings.php and be documented in the http://localhost/mediawiki-1.21.2/README

Is there any specific location in the LocalSettings.php file where these variables need to be added?

Andre, I believe this bug should be closed as invalid. It seems it was opened because configuration options for Ext:UsabilityInitiative weren't documented, but the description somehow expands the scope to the entire configuration of Mediawiki... which is mostly documented in DefaultSettings.php and somewhat documented on-wiki. Of course extensions have their own separate documentation :-)

Andre, I believe this bug should be closed as invalid. It seems it was opened
because configuration options for Ext:UsabilityInitiative weren't documented,
but the description somehow expands the scope to the entire configuration of
Mediawiki... which is mostly documented in DefaultSettings.php and somewhat
documented on-wiki. Of course extensions have their own separate documentation :-)

Yes, I'm closing it as invalid. The bug was opened against the UsabilityInitiative extension, but reassigned about a year ago, presumably when the UsabilityInitiative component was removed from Bugzilla. I think the general documentation in DefaultSettings.php is OK as is.