View source for Manual:Huggle/Configuration

<languages/>
{{Huggle/Header}}
<translate>
<!--T:1-->
Configuration settings for Huggle are stored in one of four locations depending on their scope:
</translate>

{| class="wikitable" style="height: 8em; width: 32em"
!
! <translate><!--T:81--> Single project</translate>
! <translate><!--T:82--> All projects</translate>
|-
! <translate><!--T:83--> Single user</translate>
| [[Special:Mypage/huggle3.css|<translate><!--T:84--> User subpage</translate>]]
| <translate><!--T:85--> Local file</translate>
|-
! <translate><!--T:86--> All users</translate>
| <translate><!--T:87--> [[w:Wikipedia:Huggle/Config|Project config page]]</translate>
| [[meta:Huggle/Config|<translate><!--T:88--> Global config page on Meta</translate>]]
|}

<translate>
<!--T:2-->
All configuration files consist of a series of lines of the form <code>option:value</code>, where <code>option</code> is one of the values listed below. Option names are not case-sensitive. Blank lines, lines starting with <code>//</code> and unrecognized options are ignored. Values can break across lines provided these extra lines begin with one or more spaces.

<!--T:3-->
Most user and local configuration settings may be changed through the Options window within Huggle.
<span style="color:blue">Preset</span> value

== User configuration == <!--T:4-->

<!--T:89-->
Settings on user configuration subpages apply only to that user, and only on that project.
</translate>
* <code>enable</code> – true/false.  <translate><!--T:5--> Huggle will not work unless this is present and set to true.</translate>
* <code>anonymous</code> - string. <translate><!--T:6--> Whether to show the contributions of anonymous users. Available values: "yes", "no", "only". Default: <span style="color:blue">yes</span>.</translate>
* <code>auto-advance</code> – true/false. <translate><!--T:7--> After reverting a revision, automatically advance to the next diff. Default: <span style="color:blue">false</span>.</translate>
* <code>auto-whitelist</code> - true/false. <translate><!--T:8--> Whether to automatically whitelist users. Default: <span style="color:blue">false</span>.</translate>
* <code>confirm-multiple</code> – true/false. <translate><!--T:9--> Ask for confirmation if reverting multiple edits by the same user. (Does not ask for confirmation when explicitly reverting to an older revision in the page history, as it is obvious in such cases that multiple edits are to be reverted). Default: <span style="color:blue">false</span>.</translate>
* <code>confirm-same</code> - true/false. <translate><!--T:10--> Ask for confirmation if the revision being reverted to was made by the same user that is being reverted. Default: <span style="color:blue">true</span>.</translate>
* <code>extend-reports</code> - true/false. <translate><!--T:11--> Whether to extend vandalism reports in the event of further vandalism. Default: <span style="color:blue">true</span>.</translate>
* <code>irc-port</code> – integer. <translate><!--T:12--> Port to use when connecting to IRC. Use any integer from 6664&ndash;6669, inclusive. Default: '''6667'''.</translate>
* <code>minor</code> – comma-separated list. <translate><!--T:13--> Types of edit to mark as minor. Available values: "reverts", "warnings", "tags", "reports", "notifications" and "other". Use "none" for none. Default: 'reverts'. Note that reverts will always be marked as minor edits.</translate>
* <code>namespaces</code> – comma-separated list. <translate><!--T:14--> Namespaces to check for vandalism. Use "article" for main namespace, "all" for all namespaces, "alltalk" for all talk namespaces. Prefix by "-" to exclude. Default: <span style="color:blue">all</span>.</translate>
* <code>new-pages</code> - true/false. <translate><!--T:15--> Whether to include new pages in the queue. Default: <span style="color:blue">false</span>.</translate>
* <code>preload</code> – integer. <translate><!--T:16--> How many diffs to preload in advance. Preloading reduces wait time for diff loads but slows other requests slightly. Set to 0 to disable preloading. Do not set to more than about 5. Default: <span style="color:blue">2</span>. Disabling this is recommended if you have a slow connection.</translate>
* <code>report</code> - string. <translate><!--T:17--> What to do when asked to warn a user with a final warning. Use "none" to do nothing, "prompt" to prompt for a user report, and "auto" to issue the report automatically. Default: <span style="color:blue">auto</span></translate>
* <code>revert-summaries</code> - comma-separated list. <translate><!--T:18--> Summaries available in the revert drop-down menu. Use <code>\,</code> to include a literal comma.</translate>
* <code>rollback</code> – true/false. <translate><!--T:19--> Use rollback if available. Default: <span style="color:blue">true</span>.</translate>
* <code>show-new-edits</code> – true/false. <translate><!--T:20--> If the page currently being viewed is edited, jump to a diff of that edit. Default: <span style="color:blue">true</span>.</translate>
* <code>show-queue</code> - true/false. <translate><!--T:21--> Whether to show the revision queue. Default: <span style="color:blue">true</span>.</translate>
* <code>templates</code> - comma-separated list. <translate><!--T:22--> Templates to show in the templates drop-down menu. Each item of the list is a pair of values separated by a semicolon; the first is the text displayed in the menu, and the second is the name of the template to be used. Use <code>\,</code> to include a literal comma, <code>\;</code> to include a literal semicolon.</translate>
* <code>tray-icon</code> - true/false. <translate><!--T:23--> Display an icon in the notification area, allows application to be minimized to the tray. Default: <span style="color:blue">false</span>.</translate>
* <code>update-whitelist</code> – true/false. <translate><!--T:24--> Whether to update the shared [[w:Huggle/Whitelist|whitelist]] on exit. Default: <span style="color:blue">true</span>.</translate>
* <code>watchlist</code> – comma-separated list. <translate><!--T:25--> Types of edit which should add the page to your watchlist. Available values: "reverts", "warnings", "tags", "reports", "notifications" and "other". Use "none" for none. Default: <span style="color:blue">none</span>.</translate>

; <translate><!--T:26--> Administrator options</translate>
<translate><!--T:27--> The following options have effect only when used with an administrator account:</translate>
* <code>admin</code> - true/false. <translate><!--T:28--> Use administrator functions (block/delete) if available. Default: <span style="color:blue">true</span>.</translate>
* <code>block-prompt</code> - true/false. <translate><!--T:29--> Whether to show the block form if asked to warn a user with a final warning. Default: <span style="color:blue">true</span>.</translate>
* <code>block-reason</code> – string. <translate><!--T:30--> Default block reason on block form. Default: <span style="color:blue">'<nowiki>[[Wikipedia:Vandalism|Vandalism]]</nowiki>'</span>.</translate>
* <code>blocktime</code> – string. <translate><!--T:31--> Default block expiry time when blocking logged-in users. Default: '''indefinite'''.</translate>
* <code>blocktime-anon</code> – string. <translate><!--T:32--> Default block expiry time when blocking anonymous users. Default: <span style="color:blue">31 hours</span>.</translate>

<translate>
== Project configuration == <!--T:33-->

<!--T:34-->
Settings on project configuration pages apply to all users of a single project. The user configuration settings listed in the section above also work on project configuration pages, and serve as defaults for those values, but are overridden by the user's configuration settings.
</translate>

; <translate><!--T:35--> Access control</translate>

* <code>approval</code>: true/false. <translate><!--T:36--> If true, user list acts as an approval list, and only users listed there may use Huggle. Default <span style="color:blue">false</span></translate>
* <code>enable-all</code>: true/false. <translate><!--T:37--> If false, Huggle will not work for any user. For use only in exceptional circumstances. Default <span style="color:blue">true</span></translate>
* <code>require-admin</code>: true/false. <translate><!--T:38--> If true, Huggle will only work if the user is an administrator. Default <span style="color:blue">false</span></translate>
* <code>require-autoconfirmed</code>: boolean. <translate><!--T:39--> If true, Huggle will work only if the user is autoconfirmed.</translate>
* <code>require-config</code>: true/false. <translate><!--T:40--> If true, all users must have a configuration page with <code>enable</code> set to 'true'. This allows administrators to prevent use of Huggle by a user account by blanking and protecting its configuration page. Default <span style="color:blue">false</span></translate>
* <code>require-edits</code>: integer. <translate><!--T:41--> Number of edits an account must have made before it is able to use Huggle. (Accounts must be autoconfirmed, regardless of this setting.) Default <span style="color:blue">0</span></translate>
* <code>require-rollback</code>: true/false. <translate><!--T:42--> If true, Huggle will only work if the user has rollback. Default <span style="color:blue">false</span></translate>
* <code>require-time</code>: integer. <translate><!--T:43--> Number of days for which a user account must have been registered before it is able to use Huggle. (Accounts must be autoconfirmed, regardless of this setting.)</translate>
* <code>min-version</code>: version number. <translate><!--T:44--> Versions older than this will not work.</translate>

; <translate><!--T:45--> Other</translate>

* <code>aiv</code>: string. <translate><!--T:46--> Page to which vandalism reports are made.</translate>
* <code>aivbot</code>: string. <translate><!--T:47--> Page to which vandalism reports are made by bot accounts; Huggle checks this before making a report itself.</translate>
* <code>ignore</code>: comma-separated list. <translate><!--T:48--> Pages to which all edits will be ignored regardless of user. Talk pages of these pages will also be ignored. Use <code>\,</code> to include a literal comma.</translate>
* <code>uaa</code>: string. <translate><!--T:49--> Page to which username reports are made.</translate>
* <code>uaabot</code>: string. <translate><!--T:50--> Page to which username reports are made by bot accounts; Huggle checks this before making a report itself.</translate>
* <code>userlist</code>: string. <translate><!--T:51--> Location of Huggle's [[w:Wikipedia:Huggle/Users|user list]].</translate>
* <code>whitelist</code>: string. <translate><!--T:52--> Location of Huggle's [[w:Wikipedia:Huggle/Whitelist|user whitelist]].</translate>
* <code>whitelist-edit-count</code>: integer. <translate><!--T:53--> Number of edits a user must have before they are added to the [[w:Huggle/Whitelist|user whitelist]].</translate>
* <code>expand-reports</code>: bool, <translate><!--T:54--> use subst: for report templates for AIV, default: <span style="color:blue">false</span></translate>
* <code>months</code>: <translate><!--T:55--> list of months separated by ; and ,</translate>

<translate>
== Local configuration == <!--T:56-->

<!--T:57-->
Settings stored locally apply across all projects and apply only to users of that computer. They will be retained if you log in with a different account, and lost if moving between computers, but for the most part can be thought of as applying to a single user account.

<!--T:58-->
The local configuration file is stored in \huggle\config.txt in the user's Application Data folder. The file is updated automatically when Huggle exits.
</translate>

* <code>irc</code>: boolean. <translate><!--T:59--> Whether to use the IRC recent changes feed. Default <span style="color:blue">false</span></translate>
* <code>log-file</code>: string. <translate><!--T:60--> File path to which Huggle activity will be written.</translate>
* <code>project</code>: string. <translate><!--T:61--> Last project used.</translate>
* <code>proxy-enabled, proxy-port, proxy-server, proxy-userdomain, proxy-username</code>: <translate><!--T:62--> proxy settings. Default <span style="color:blue">false</span></translate>
* <code>username</code>: string. <translate><!--T:63--> Last username used.</translate>
* <code>window-left, window-top, window-width, window-height</code>: integers. <translate><!--T:64--> Location and size of Huggle's main window.</translate>
* <code>window-maximize</code>: boolean. <translate><!--T:65--> Whether the main window is maximized.</translate>
* <code>shortcuts</code>: comma-separated list. <translate><!--T:66--> Keyboard shortcuts.</translate>
* <code>revert-summaries</code>: comma-separated list. <translate><!--T:67--> Summaries that have been entered into the "Revert with summary" dialog.</translate>

<translate>
== Global configuration == <!--T:68-->

<!--T:69-->
Settings on the global configuration page at [[meta:Huggle/Config]] apply to all users and all projects.
</translate>

* <code>enable-all</code>: boolean. <translate><!--T:70--> If false, Huggle will not work on any project. Default <span style="color:blue">false</span></translate>
* <code>config</code>: string. <translate><!--T:71--> Location of project configuration page on each project.</translate>
* <code>documentation</code>: string. <translate><!--T:72--> URL for documentation page.</translate>
* <code>feedback</code>: string. <translate><!--T:73--> URL for feedback page.</translate>
* <code>irc-server</code>: string. <translate><!--T:74--> Location of IRC recent changes server.</translate>
* <code>irc-server-name</code>: string. <translate><!--T:75--> Hostname used on the IRC recent changes server.</translate>
* <code>projects</code>: dictionary. <translate><!--T:76--> Projects on which Huggle can be used. Each item is the project name, followed by its URL.</translate>
* <code>sensitive-addresses</code>: dictionary. <translate><!--T:77--> IP ranges that are considered "sensitive". Each item is a regex matching the IP range, followed by a description.</translate>
* <code>version</code>: version number. <translate><!--T:78--> The current version of Huggle. Users of older versions will be notified of this, but the older versions will continue to work.</translate>
* <code>user-agent</code>: string. <translate><!--T:79--> User agent string that will be used by Huggle. $1 is replaced by the version number.</translate>
* <code>user-config</code>: string. <translate><!--T:80--> Location of user configuration pages on each project.</translate>