Feed The Beast Wiki:Huggle/Config.yaml

---
 * 1) https://www.mediawiki.org/wiki/Manual:Huggle/Deploying/DefaultConfig.yaml
 * 2) This is a default project configuration for Huggle for use in new Huggle installations.
 * 3) Please keep every option documented if possible. Optional config options are commented out so that current Huggle defaults are always used. Feel free to uncomment to override the defaults.
 * 4) Options that are deprecated should not be a part of this document, if you find any, remove them


 * 1) IMPORTANT: Options that should be translated in case of different language wiki are marked with LOCALIZE ME, options that were overtaken from English Wikipedia and therefore should be updated to match target wiki are marked with UPDATE ME


 * 1) Access control
 * 2) Defines requirements needed to use Huggle in read + write mode on the wiki
 * 3) If user is not eligible, Huggle will allow usage in read-only mode
 * 1) If user is not eligible, Huggle will allow usage in read-only mode

enable-all: true min-version: 3.1.0 approval: false require-admin: false require-autoconfirmed: true require-config: false require-time: 30 require-edits: 0 require-rollback: false read-only: false
 * 1) If this is set to false, nobody will be allowed to use Huggle on the project,
 * 2) this is useful if you need to temporarily or permanently disable it
 * 1) Minimum required version, users with older Huggle will not be allowed to login
 * 1) If this is set to true, your username must be listed on Approval Page which is defined
 * 2) with option "userlist" in section "Other"
 * 1) User must be admin in order to use huggle (member of sysop group)
 * 1) User must be autoconfirmed in order to use huggle (member of autoconfirmed group)
 * 1) User must have a valid configuration file (Special:MyPage/huggle3.yaml.css) that contains enable: true
 * 1) How many days user account needs to exist so that they can use Huggle
 * 1) How many edits user account needs to have in order to use Huggle
 * 1) User must have rollback permission in order to use Huggle
 * 1) If this is set to true, nobody will be allowed to use Huggle in write mode
 * 2) This should be true for new installations until you verify that everything
 * 3) works as expected.


 * 1) Reporting
 * 2) Definition of AIV and similar pages that vandals get reported to
 * 1) Definition of AIV and similar pages that vandals get reported to

protection-requests: false rfpp-template: > ==== ====\n$protection: $reason --  SizableShrimp🦐  (talk ·&#32;contribs) 21:15, 28 February 2021 (UTC)
 * 1) Requests for page protection, set protection-requests to true if you want this feature to work on this wiki
 * 1) Template to use when requesting a page protection, $title is substed to page name, $protection to requested protection level and $reason is the reason for protection

rfpp-verify: > .*\{\{\s*l[au]\s*\|\s*$title\s*\}\}.*
 * 1) This is a regex used to check if the page is already in a list

rfpp-section: 1
 * 1) Page section to append template to

rfpp-permanent: "Permanent protection" rfpp-temporary: "Temporary protection"
 * 1) Used to define types of protection (since Huggle 3.4.5)

protection-request-page: "Project:Requests for page protection"
 * 1) RFPP page
 * 1) Default reason
 * 2) protection-request-reason: "Persistent vandalism."
 * 3) Summary RFPP
 * 4) protection-request-summary: 'Requesting $1 of $2'


 * 1) User reporting

report: DefaultAuto
 * 1) Type of reports (case insensitive)
 * 2) DefaultAuto - Huggle will follow user preferences, and will default to auto reports
 * 3) DefaultManual - Huggle will follow user preferences, and will default to manual reports
 * 4) StrictAuto - Huggle will enforce automatic reports
 * 5) StrictManual - Huggle will enforce manual reports


 * 1) Regex that is used to verify if user is already present on report page
 * 2) report-user-check-pattern: '.*$username.*'


 * 1) Edit summary for revert page # LOCALIZE ME #
 * 2) report-summary: 'Reporting $1'

aiv-reports: false vandal-report-reason: vandalism uaa: "Project:Usernames for administrator attention"
 * 1) Enable AIV reports (user reports)
 * 1) Name of page that is used for reports
 * aiv: "Wikipedia:Administrator intervention against vandalism"
 * 1) Name of AIV page used by bots (this page is only used to check if user wasn't already reported there)
 * 2) aivbot: "Wikipedia:Administrator intervention against vandalism/TB2"
 * 3) Template used to report IP user
 * 4) aiv-ip: '* $2$3 --  SizableShrimp🦐  (talk ·&#32;contribs) 21:15, 28 February 2021 (UTC)'
 * 5) Template used to report regular user
 * 6) aiv-user: '* $2$3 --  SizableShrimp🦐  (talk ·&#32;contribs) 21:15, 28 February 2021 (UTC)'
 * 7) Section of AIV page to add reports to
 * 8) aiv-section: 2
 * 9) Text appended to automatic AIV reports
 * 10) report-auto-summary: 'This user was automatically reported by Huggle due to reverted vandalism after a final warning. Please verify their contributions carefully, it may be a false positive'

speedy: true speedy-delete-summary: "Speedy deleted, $1." speedy-message-summary: "Notification: Speedy deletion of $1" speedy-message-title: "Your page was deleted" speedy-summary: "Tagging page for speedy deletion, $1"
 * 1) Deletion requests
 * 2) Configuration of ability to delete or request for deletion of pages
 * 3) Whether speedy deletions are enabled, right now Huggle3 supports only speedy deletions
 * 1) Whether speedy deletions are enabled, right now Huggle3 supports only speedy deletions
 * 1) Whether speedy deletions are enabled, right now Huggle3 supports only speedy deletions
 * 1) Enable warning templates for speedy deletions
 * 2) speedy-enable-warnings: true
 * 3) Send warnings by default
 * 4) speedy-warning-on-by-default: true
 * 5) Delete summary # LOCALIZE ME #
 * 1) Summary used when delivering a notification to user who authored the page # LOCALIZE ME #
 * 1) Title of message that is delivered to user # LOCALIZE ME #
 * 1) Summary used when a template informing user about speedy deletion request is delivered to user talk # LOCALIZE ME #

speedy-options: G1: ["patent nonsense", db-g1, '$1', notify] P1: ["portal that would be deleted as an article", db-p1, '$1', notify] P2: ["underpopulated portal", db-p2, '$1', notify]
 * 1) Available speedy deletion options, these are arrays that consist of description, template (put to top of the page), template used to inform user about deletion, and optional information if user should be notified about the deletion # UPDATE ME #


 * 1) Prediction
 * 2) This section contains clues that help Huggle predict quality of edit
 * 1) This section contains clues that help Huggle predict quality of edit

score-ip: 20 score-bot: -20000 score-flag: -200 score-user: -250 score-foreign-user: 100 score-talk: -200 score-wl: -2000 ores-enabled: false ores-supported: false ores-url: https://ores.wikimedia.org/scores/
 * 1) ip addresses are more likely to be vandals
 * 1) flagged bots are likely not vandals, even if they add swear words
 * 1) people with high amount of flags are trusted even if not whitelisted
 * 1) userpages are frequently used to test stuff
 * 1) userpages edited by other user than owner are typically vandalism
 * 1) talk pages are often false positives, let's put them low
 * 1) users with score lower than this are inserted to wl
 * 1) ORES see meta.wikimedia.org/wiki/Objective_Revision_Evaluation_Service
 * 2) If this is set to true ORES will be enabled
 * 1) This is used to indicate whether ORES is supported by a project, if yes, it should be set to true even if ORES is not enabled
 * 1) URL of ORES


 * 1) This constant is used to amplify the converted score. Native ORES scores have range from 0 to 1 (floating point)
 * 2) huggle is using different scoring mechanism and its scores are signed long integers. Tune this variable to
 * 3) change weight of ORES within Huggle scores.

ores-amplifier: 600
 * 1) With value of 600, ORES's score "1" (100%) would result in Huggle score 600 and ORES's score "0" would result in -600, score "0.5" would result in 0.


 * 1) The list below is called "score words" it contains words presence of increase the score of edit by value in brackets,
 * 2) you can define as many score words as you want, these words must be lowercase, otherwise ignored (they are compared with diff text which
 * 3) is lowercase so that it's case insensitive)

score-parts: 200: [haha, fuuuu, '!!!!!!', '??????', '--', Special:Contributions] # suck and fuck are not contained in any normal words at least not according English dictionary: http://www.morewords.com/contains/fuck/ 600: [faggot, hihi, hahaha, suck, fuck, fag, retard, shemale]
 * 1) score-parts are parts of a word, they can be even in a middle of a word, so be careful here or you create too many false positives
 * 1)  Score     List of words


 * 1) score-words are separate words, they don't even actually need to be words, they can be short phrases as well, but must not contain
 * 2) comma (fuck off - is valid word)

score-words-no-talk: 800: [hey, heya, hi, hello] 1000: [':)', ':-)', ':P', ':D', lol, rofl]
 * 1) no-talk score words are ignored on talk pages (huggle 3.1.10+)

score-words:

score-tags: bad external: 100 Huggle: -2000 Twinkle: -2000 Possible vandalism: 800
 * 1) This is a list of all edit tags that affect the score somehow, available since Huggle 3.1.17

headings: standard
 * 1) Reverting and templates
 * 2) Configuration of reverting and various templates
 * 3) Specify type of headings to use when sending a message to user
 * 4) standard will use month and year
 * 5) page will use text in "template-header"
 * 6) none will not use any headers
 * 1) page will use text in "template-header"
 * 2) none will not use any headers


 * 1) Use for "page" headers. Uncomment if you want to change it # LOCALIZE ME #
 * 2) template-header: "Your edits to $1"


 * 1) Define how old templates are considered valid in days, older templates are ignored
 * 2) By default templates older than 30 days are ignored
 * 3) template-age: -30

tags: [advert, autobiography, BLP PROD, cleanup, coi, confusing, context, copyedit, disputed, essay-like, expand, expert, hoax, in-universe, internallinks, introrewrite, nofootnotes, non-free, notability, 'notenglish|INSERT LANGUAGE NAME', npov, original research, orphan, plot, primarysources, prose, refimprove, sections, tone, tooshort, totally-disputed, uncategorized, underconstruction, unencyclopedic, unreferenced, update, wikify]
 * 1) List of tags supported by a wiki, please keep in mind that "tag" is a bit historical term, they are in fact templates # UPDATE ME #

tags-info: advert: info='Looks like advertisement' param=test autobiography: info='Looks like an auto-bio' cleanup: info="Needs cleanup " coi: info='Conflict of interest' context: info='Page is missing context'
 * 1) Optional description of individual tags to show in Huggle's tag form # UPDATE ME #

confirm-ignored: true confirm-multiple: false confirm-page: true confirm-same: true confirm-self-revert: true confirm-warned: false
 * 1) User needs to confirm they want to revert user who is on whitelist
 * 1) User must confirm revert of multiple edits
 * 1) To be implemented (probably revert of page creator?)
 * 1) To be implemented (probably revert that leads to same version of text)
 * 1) User must confirm if they want to revert themselves
 * 1) To be implemented (probably revert of user who is warned? makes no sense :))

manual-revert-summary: 'Reverted edits by $1 to last revision by $2' multiple-revert-summary-parts: "Reverted,edit by,edits by,and,other users,to last revision by,to an older version by"
 * 1) Default summary for software rollback, eg. using manual revert instead of rollback functionality provided my MW # LOCALIZE ME #
 * 1) Not currently in use - might be implemented in future

warning-types: warning: Vandalism spam: Spam delete: Removal of content
 * 1) List of warning types, these will be present in dropdown menus in Huggle, allowing to clarify reasons for revert.
 * 2) Default configuration contains only 1 type of warning, with 3 examples that are commented
 * 1)    test: Editing tests

default-template: warning
 * 1) Default warning template to use, it must be one of these defined in "warning-types".

revert-summaries: warning: 'Reverted edits by $1 (talk): nonconstructive edits' delete: 'Reverted edits by $1 (talk): unexplained content removal' spam: "Reverted edits by $1 (talk): spam"
 * 1) Summaries associated with warning types, each warning type should have one # LOCALIZE ME #
 * 1)    test: "Reverted edits by $1 (talk): editing tests"


 * 1) Not currently in use as there is too many default summaries :) we need to figure out which are really not needed and get rid of them
 * 2) rollback-summary: "Reverted edits by $1 (talk) to last revision by $2"

default-summary: "Reverted edits by $1 (talk) to last revision by $2" rollback-summary-unknown: "Reverted edits by $1 (talk)" single-revert-summary: "Undid edit by $1 (talk)" undo-summary: "Undoing own edit" warn-summary: "Message re. $1" warn-summary-2: "Level 2 warning re. $1" warn-summary-3: "Level 3 warning re. $1" warn-summary-4: "Level 4 warning re. $1"
 * 1) This is actual default summary that is used for rollback in case reason is not specified # LOCALIZE ME #
 * 1) To be implemented - rollback summary used in case that target revision is unknown
 * 1) To be implemented - for revert of current revision only
 * 1) Used for restoring of a revision of edit # LOCALIZE ME #
 * 2) restore-summary: "Restored revision $1 made by $2: $3"
 * 3) Used when undoing own edit # LOCALIZE ME #
 * 1) Edit summary for warning deliveries, $1 is name of page related to warning # LOCALIZE ME #

warning-template-tags: - '1;'   - '2;'    - '3;'    - '4;'
 * 1) Template clues for parser that Huggle is looking for, each warning level needs to have some of these so that
 * 2) it's possible to figure out which warning level the template resembles.
 * 3) It can be any part of the template, on English wikipedia templates have invisible comments in them which clarify
 * 4) the warning level. It can be however any part of the template, such as image, or piece of text.
 * 5) UPDATE ME #

warning-im: false warning-mode: 4
 * 1) Whether this project supports "instant warnings" these are templates that trigger level 4 instantly, used for obvious vandals
 * 1) How many warning levels to use. Currently it's only supported to use 3 or 4, but plans are to make this completely dynamic.


 * 1) Definitions of warning templates - these are messages that are delivered to user who is about to receive a warning.
 * 2) $1 = name of page, $2 = URL to diff


 * 1) warning1: '$1'
 * 2) warning2: '$1'
 * 3) warning3: '$1'
 * 4) warning4: '$1'
 * 5) warning4im: '$1'


 * 1) spam1: '$1'
 * 2) spam2: '$1'
 * 3) spam3: '$1'
 * 4) spam4: '$1'
 * 5) spam4im: '$1'


 * 1) delete1: '$1'
 * 2) delete2: '$1'
 * 3) delete3: '$1'
 * 4) delete4: '$1'
 * 5) delete4im: '$1'


 * 1) test1: '$1'
 * 2) test2: '$1'
 * 3) test3: '$1'
 * 4) test4: '$1'
 * 5) test4im: '$1'


 * 1) Welcoming of users
 * 2) All welcome templates are expected not to contain four tildes, signatures are appended by Huggle

welcome-messages:
 * 1) List of templates for dropdown menu
 * 2) $1 will substitute to name of target user (since Huggle 3.3.3) # UPDATE ME #
 * 1)    "Welcome with menu": ''
 * 2)    "Welcome personal": ''
 * 3)    "Welcome vandal :)": ''

welcome: '' welcome-anon: '' welcome-summary: 'Welcoming user'
 * 1) Default welcome message for registered users # UPDATE ME #
 * 1) Welcome message sent to IP users # UPDATE ME #
 * 1) Edit summary # LOCALIZE ME #


 * 1) Administrator functions
 * 1) Administrator functions

block-expiry-options: [15 minutes,3 hours,12 hours,24 hours,31 hours,48 hours,55 hours,72 hours,1 week,2 weeks,1 month,3 months,6 months,1 year,indefinite] blocktime: indefinite blocktime-anon: "24 hours" block-message: 'Blocked for reason $1 for time $2' block-reason: "Vandalism" block-summary: "Notification: Blocked"
 * 1) Expiry options that will be displayed in block form
 * 1) Default expiry time
 * 1) Default expiry time for anonymous user
 * 1) Default message to deliver to user who is getting a block # UPDATE ME #
 * 1) To be implemented. Default block message for user who is getting indefinite block
 * 2) block-message-indef: '$1'
 * 3) Default reason for block # UPDATE ME #
 * 1) Edit summary used when editing user talk page # LOCALIZE ME #

protection-reason: 'Vandalism'
 * 1) Default reason for page protection # UPDATE ME #

deletion-reasons: - 'Spam' - 'Vandalism' - 'Insufficient information' - 'Nonsense, meaningless, or incomprehensible' - 'Test page'
 * 1) Available reasons in dropdown box for page deletions
 * 2) UPDATE ME #


 * 1) Classification
 * 1) Classification

months: - January - February - March - April - May - June - July - August - September - October - November - December
 * 1) These are localized versions of months that will be used by Huggle when creating a timestamp or for message headers.
 * 2) LOCALIZE ME #

alternative-months: - [1.,Jan] - [2.,Feb] - [3.,Mar] - [4.,Apr] - [5.,May] - [6.,Jun] - [7.,Jul] - [8.,Aug] - [9.,Sep] - [10.,Oct] - [11.,Nov] - [12.,Dec]
 * 1) These are needed especially for wikis where months in signatures are not same as these in months list (see above) or their localized version
 * 2) every line is a YAML array for 1 month, for example:
 * 3) - ['January','Jan','J.','1.']

assisted-summaries: - 'using AWB' - 'using |STiki' - 'Using Twinkle' - 'using TW' - 'using TW' - '(TW)'
 * 1) Edits with summaries that contain these strings will be considered friend applications by Huggle and ignored (in default filter)
 * 2) UPDATE ME #

page-blanked-pattern: '(\[\[(Wikipedia|WP):(AES|Automatic edit summaries)|(←|Automatic summary)\]\])?(:|←)? ?(Page was blanked|(Blank(ed|ing) the page))\.?' page-created-pattern: '(\[\[(Wikipedia|WP):(AES|Automatic edit summaries)|(←|Automatic summary)\]\])?(:|←)? ?Created page with .*' page-redirected-pattern: '(\[\[(Wikipedia|WP):(AES|Automatic edit summaries)|(←|Automatic summary)\]\])?(:|←)? ?(Created page as redirect|Redirect(ed|ing)) to .*' page-replaced-pattern: '(\[\[(Wikipedia|WP):(AES|Automatic edit summaries)|(←|Automatic summary)\]\])?(:|←)? ?(Page was replaced|Replac(ed|ing) (page|content)) with .*'
 * 1) These are regular expressions used by Huggle to identify whether edit summary means that page was created, blanked, redirected or replaced
 * 2) UPDATE ME #

revert-patterns: - 'automatically reverting .*' - 'bot - (rv|revert) .*' - 'bot--revert.*' - 'js: revert .*' - '^[rR]evert.*' - '.*\[\[Help:Reverting\|Reverted\]\] edits by.*' - '^rv .*' - '^[Uu]ndid .*' - '^[Uu]ndo .*' - '.* [Uu]ndid revision [\d]+ by .*'
 * 1) These are regular expressions used by Huggle to identify whether edit summary means that page was reverted

shared-ip-templates: - sharedip - vandalip
 * 1) UPDATE ME #

tag-summaries: - '^prod$' - 'prod .' - '[\{:]prod' - 'prod[\}\-:2]' - '(nominated|prodding|proposed) for deletion' - '^tag$'
 * 1) These are regular expressions used by Huggle to identify whether edit summary means that page was tagged


 * 1) Queue list
 * 1) Queue list

queues: 'Filtered edits': filter-ignored: exclude filter-notifications: exclude filter-own-userspace: exclude filter-reverts: exclude filter-tags: exclude filter-warnings: exclude

'Filtered new pages': filter-ignored: exclude filter-new-pages: require

'All edits':

'All new pages': filter-new-pages: require

'Assisted edits': filter-assisted: require filter-bot: exclude

'My edits': filter-me: require

default-queue: 'default'

ignore: - 'Project:Sandbox'
 * 1) Everything in this list will be ignored if it fully matches the string
 * 2) UPDATE ME #

ignore-patterns: - '/sandbox' - '/common.js' - '/common.css'
 * 1) Everything in this list will be ignored if it partially matches the name
 * 2) UPDATE ME #


 * 1) Other
 * 1) Other

config-summary: 'Updating configuration' go: "Project:Huggle": "Huggle main page" patrolling-enabled: true summary: '(HG)' startup-message-location: "Project:Huggle/Message" userlist: "Project:Huggle/Users" userlist-update-summary: "Adding $1"
 * 1) Summary used when updating user config page # LOCALIZE ME #
 * 1) These items are visible in "Go" menu in Huggle, first one is name of page on wiki, second is name as seen in Huggle menu
 * 1) Whether patrolling of changes is enabled on the project
 * 1) This suffix is appended to every single edit message made by huggle

whitelist: "Project:Huggle/Whitelist" whitelist-edit-count: 30 auto-whitelist: true
 * 1) whitelist stuff