diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/contenthandler.txt | 1 | ||||
| -rw-r--r-- | docs/database.txt | 5 | ||||
| -rw-r--r-- | docs/export-0.10.xsd | 294 | ||||
| -rw-r--r-- | docs/export-demo.xml | 20 | ||||
| -rw-r--r-- | docs/extension.schema.json | 637 | ||||
| -rw-r--r-- | docs/hooks.txt | 364 | ||||
| -rw-r--r-- | docs/kss/Makefile | 4 | ||||
| -rw-r--r-- | docs/kss/README.txt | 2 | ||||
| -rw-r--r-- | docs/kss/styleGuideModules.txt | 10 | ||||
| -rw-r--r-- | docs/kss/styleguide-template/public/less.js | 9 | ||||
| -rw-r--r-- | docs/logger.txt | 71 | ||||
| -rw-r--r-- | docs/memcached.txt | 16 | ||||
| -rw-r--r-- | docs/scripts.txt | 2 | ||||
| -rw-r--r-- | docs/sitelist-1.0.xsd | 68 | ||||
| -rw-r--r-- | docs/sitelist.txt | 47 | ||||
| -rw-r--r-- | docs/sitescache.txt | 42 | ||||
| -rw-r--r-- | docs/skin.txt | 48 | ||||
| -rw-r--r-- | docs/uidesign/mediawiki.action.history.diff.html | 106 |
18 files changed, 1584 insertions, 162 deletions
diff --git a/docs/contenthandler.txt b/docs/contenthandler.txt index 3f0fca21..5f9a0b03 100644 --- a/docs/contenthandler.txt +++ b/docs/contenthandler.txt @@ -8,6 +8,7 @@ Built-in content types are: * wikitext - wikitext, as usual * javascript - user provided javascript code +* json - simple implementation for use by extensions, etc. * css - user provided css code * text - plain text diff --git a/docs/database.txt b/docs/database.txt index 735f26bf..ba3045ed 100644 --- a/docs/database.txt +++ b/docs/database.txt @@ -159,10 +159,7 @@ $dbw->commit( __METHOD__ ); Use of locking reads (e.g. the FOR UPDATE clause) is not advised. They are poorly implemented in InnoDB and will cause regular deadlock errors. -It's also surprisingly easy to cripple the wiki with lock contention. If -you must use them, define a new flag for $wgAntiLockFlags which allows -them to be turned off, because we'll almost certainly need to do so on -the Wikimedia cluster. +It's also surprisingly easy to cripple the wiki with lock contention. Instead of locking reads, combine your existence checks into your write queries, by using an appropriate condition in the WHERE clause of an diff --git a/docs/export-0.10.xsd b/docs/export-0.10.xsd new file mode 100644 index 00000000..9d5d49e0 --- /dev/null +++ b/docs/export-0.10.xsd @@ -0,0 +1,294 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<!-- + This is an XML Schema description of the format + output by MediaWiki's Special:Export system. + + Version 0.2 adds optional basic file upload info support, + which is used by our OAI export/import submodule. + + Version 0.3 adds some site configuration information such + as a list of defined namespaces. + + Version 0.4 adds per-revision delete flags, log exports, + discussion threading data, a per-page redirect flag, and + per-namespace capitalization. + + Version 0.5 adds byte count per revision. + + Version 0.6 adds a separate namespace tag, and resolves the + redirect target and adds a separate sha1 tag for each revision. + + Version 0.7 adds a unique identity constraint for both page and + revision identifiers. See also bug 4220. + Fix type for <ns> from "positiveInteger" to "nonNegativeInteger" to allow 0 + Moves <logitem> to its right location. + Add parentid to revision. + Fix type for <id> within <contributor> to "nonNegativeInteger" + + Version 0.8 adds support for a <model> and a <format> tag for + each revision. See contenthandler.txt. + + Version 0.9 adds the database name to the site information. + + Version 0.10 moved the <model> and <format> tags before the <text> tag. + + The canonical URL to the schema document is: + http://www.mediawiki.org/xml/export-0.10.xsd + + Use the namespace: + http://www.mediawiki.org/xml/export-0.10/ +--> +<schema xmlns="http://www.w3.org/2001/XMLSchema" + xmlns:mw="http://www.mediawiki.org/xml/export-0.10/" + targetNamespace="http://www.mediawiki.org/xml/export-0.10/" + elementFormDefault="qualified"> + + <annotation> + <documentation xml:lang="en"> + MediaWiki's page export format + </documentation> + </annotation> + + <!-- Need this to reference xml:lang --> + <import namespace="http://www.w3.org/XML/1998/namespace" + schemaLocation="http://www.w3.org/2001/xml.xsd" /> + + <!-- Our root element --> + <element name="mediawiki" type="mw:MediaWikiType"> + <!-- Page ID contraint, see bug 4220 --> + <unique name="PageIDConstraint"> + <selector xpath="mw:page" /> + <field xpath="mw:id" /> + </unique> + <!-- Revision ID contraint, see bug 4220 --> + <unique name="RevIDConstraint"> + <selector xpath="mw:page/mw:revision" /> + <field xpath="mw:id" /> + </unique> + </element> + + <complexType name="MediaWikiType"> + <sequence> + <element name="siteinfo" type="mw:SiteInfoType" + minOccurs="0" maxOccurs="1" /> + <element name="page" type="mw:PageType" + minOccurs="0" maxOccurs="unbounded" /> + <element name="logitem" type="mw:LogItemType" + minOccurs="0" maxOccurs="unbounded" /> + </sequence> + <attribute name="version" type="string" use="required" /> + <attribute ref="xml:lang" use="required" /> + </complexType> + + <complexType name="SiteInfoType"> + <sequence> + <element name="sitename" type="string" minOccurs="0" /> + <element name="dbname" type="string" minOccurs="0" /> + <element name="base" type="anyURI" minOccurs="0" /> + <element name="generator" type="string" minOccurs="0" /> + <element name="case" type="mw:CaseType" minOccurs="0" /> + <element name="namespaces" type="mw:NamespacesType" minOccurs="0" /> + </sequence> + </complexType> + + <simpleType name="CaseType"> + <restriction base="NMTOKEN"> + <!-- Cannot have two titles differing only by case of first letter. --> + <!-- Default behavior through 1.5, $wgCapitalLinks = true --> + <enumeration value="first-letter" /> + + <!-- Complete title is case-sensitive --> + <!-- Behavior when $wgCapitalLinks = false --> + <enumeration value="case-sensitive" /> + + <!-- Cannot have non-case senstitive titles eg [[FOO]] == [[Foo]] --> + <!-- Not yet implemented as of MediaWiki 1.18 --> + <enumeration value="case-insensitive" /> + </restriction> + </simpleType> + + <simpleType name="DeletedFlagType"> + <restriction base="NMTOKEN"> + <enumeration value="deleted" /> + </restriction> + </simpleType> + + <complexType name="NamespacesType"> + <sequence> + <element name="namespace" type="mw:NamespaceType" + minOccurs="0" maxOccurs="unbounded" /> + </sequence> + </complexType> + + <complexType name="NamespaceType"> + <simpleContent> + <extension base="string"> + <attribute name="key" type="integer" /> + <attribute name="case" type="mw:CaseType" /> + </extension> + </simpleContent> + </complexType> + + <complexType name="RedirectType"> + <simpleContent> + <extension base="string"> + <attribute name="title" type="string" /> + </extension> + </simpleContent> + </complexType> + + <simpleType name="ContentModelType"> + <restriction base="string"> + <pattern value="[a-zA-Z][-+./a-zA-Z0-9]*" /> + </restriction> + </simpleType> + + <simpleType name="ContentFormatType"> + <restriction base="string"> + <pattern value="[a-zA-Z][-+.a-zA-Z0-9]*/[a-zA-Z][-+.a-zA-Z0-9]*" /> + </restriction> + </simpleType> + + <complexType name="PageType"> + <sequence> + <!-- Title in text form. (Using spaces, not underscores; with namespace ) --> + <element name="title" type="string" /> + + <!-- Namespace in canonical form --> + <element name="ns" type="nonNegativeInteger" /> + + <!-- optional page ID number --> + <element name="id" type="positiveInteger" /> + + <!-- flag if the current revision is a redirect --> + <element name="redirect" type="mw:RedirectType" minOccurs="0" maxOccurs="1" /> + + <!-- comma-separated list of string tokens, if present --> + <element name="restrictions" type="string" minOccurs="0" /> + + <!-- Zero or more sets of revision or upload data --> + <choice minOccurs="0" maxOccurs="unbounded"> + <element name="revision" type="mw:RevisionType" /> + <element name="upload" type="mw:UploadType" /> + </choice> + + <!-- Zero or One sets of discussion threading data --> + <element name="discussionthreadinginfo" minOccurs="0" maxOccurs="1" type="mw:DiscussionThreadingInfo" /> + </sequence> + </complexType> + + <complexType name="RevisionType"> + <sequence> + <element name="id" type="positiveInteger" /> + <element name="parentid" type="positiveInteger" minOccurs="0" /> + <element name="timestamp" type="dateTime" /> + <element name="contributor" type="mw:ContributorType" /> + <element name="minor" minOccurs="0" maxOccurs="1" /> + <element name="comment" type="mw:CommentType" minOccurs="0" maxOccurs="1" /> + <element name="model" type="mw:ContentModelType" /> + <element name="format" type="mw:ContentFormatType" /> + <element name="text" type="mw:TextType" /> + <element name="sha1" type="string" /> + </sequence> + </complexType> + + <complexType name="LogItemType"> + <sequence> + <element name="id" type="positiveInteger" /> + <element name="timestamp" type="dateTime" /> + <element name="contributor" type="mw:ContributorType" /> + <element name="comment" type="mw:CommentType" minOccurs="0" /> + <element name="type" type="string" /> + <element name="action" type="string" /> + <element name="text" type="mw:LogTextType" minOccurs="0" maxOccurs="1" /> + <element name="logtitle" type="string" minOccurs="0" maxOccurs="1" /> + <element name="params" type="mw:LogParamsType" minOccurs="0" maxOccurs="1" /> + </sequence> + </complexType> + + <complexType name="CommentType"> + <simpleContent> + <extension base="string"> + <!-- This allows deleted=deleted on non-empty elements, but XSD is not omnipotent --> + <attribute name="deleted" use="optional" type="mw:DeletedFlagType" /> + </extension> + </simpleContent> + </complexType> + + <complexType name="TextType"> + <simpleContent> + <extension base="string"> + <attribute ref="xml:space" use="optional" default="preserve" /> + <!-- This allows deleted=deleted on non-empty elements, but XSD is not omnipotent --> + <attribute name="deleted" use="optional" type="mw:DeletedFlagType" /> + <!-- This isn't a good idea; we should be using "ID" instead of "NMTOKEN" --> + <!-- However, "NMTOKEN" is strictest definition that is both compatible with existing --> + <!-- usage ([0-9]+) and with the "ID" type. --> + <attribute name="id" type="NMTOKEN" /> + <attribute name="bytes" use="optional" type="nonNegativeInteger" /> + </extension> + </simpleContent> + </complexType> + + <complexType name="LogTextType"> + <simpleContent> + <extension base="string"> + <!-- This allows deleted=deleted on non-empty elements, but XSD is not omnipotent --> + <attribute name="deleted" use="optional" type="mw:DeletedFlagType" /> + </extension> + </simpleContent> + </complexType> + + <complexType name="LogParamsType"> + <simpleContent> + <extension base="string"> + <attribute ref="xml:space" use="optional" default="preserve" /> + </extension> + </simpleContent> + </complexType> + + <complexType name="ContributorType"> + <sequence> + <element name="username" type="string" minOccurs="0" /> + <element name="id" type="nonNegativeInteger" minOccurs="0" /> + + <element name="ip" type="string" minOccurs="0" /> + </sequence> + <!-- This allows deleted=deleted on non-empty elements, but XSD is not omnipotent --> + <attribute name="deleted" use="optional" type="mw:DeletedFlagType" /> + </complexType> + + <complexType name="UploadType"> + <sequence> + <!-- Revision-style data... --> + <element name="timestamp" type="dateTime" /> + <element name="contributor" type="mw:ContributorType" /> + <element name="comment" type="string" minOccurs="0" /> + + <!-- Filename. (Using underscores, not spaces. No 'File:' namespace marker.) --> + <element name="filename" type="string" /> + + <!-- URI at which this resource can be obtained --> + <element name="src" type="anyURI" /> + + <element name="size" type="positiveInteger" /> + + <!-- TODO: add other metadata fields --> + </sequence> + </complexType> + + <!-- Discussion threading data for LiquidThreads --> + <complexType name="DiscussionThreadingInfo"> + <sequence> + <element name="ThreadSubject" type="string" /> + <element name="ThreadParent" type="positiveInteger" /> + <element name="ThreadAncestor" type="positiveInteger" /> + <element name="ThreadPage" type="string" /> + <element name="ThreadID" type="positiveInteger" /> + <element name="ThreadAuthor" type="string" /> + <element name="ThreadEditStatus" type="string" /> + <element name="ThreadType" type="string" /> + </sequence> + </complexType> + +</schema> diff --git a/docs/export-demo.xml b/docs/export-demo.xml index fd47d13a..93b237ff 100644 --- a/docs/export-demo.xml +++ b/docs/export-demo.xml @@ -1,4 +1,4 @@ -<mediawiki xmlns="http://www.mediawiki.org/xml/export-0.9/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.mediawiki.org/xml/export-0.9/ http://www.mediawiki.org/xml/export-0.9.xsd" version="0.9" xml:lang="en"> +<mediawiki xmlns="http://www.mediawiki.org/xml/export-0.10/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.mediawiki.org/xml/export-0.10/ http://www.mediawiki.org/xml/export-0.10.xsd" version="0.10" xml:lang="en"> <!-- Optional global configuration info --> <siteinfo> @@ -55,7 +55,7 @@ <!-- if a page is deleted and recreated. --> <id>1</id> - <!-- Tag wether this article is a redirect and its target --> + <!-- Tag whether this article is a redirect and its target --> <!-- This corresponds to the page_is_redirect in the page table --> <redirect title="Target" /> @@ -82,10 +82,10 @@ </contributor> <minor /> <comment>I have just one thing to say!</comment> - <text xml:space="preserve" bytes="25">A bunch of [[text]] here.</text> - <sha1>5x0ux8iwjrbmfzgv6pkketxgkcnpr7h</sha1> <model>wikitext</model> <format>text/x-wiki</format> + <text xml:space="preserve" bytes="25">A bunch of [[text]] here.</text> + <sha1>5x0ux8iwjrbmfzgv6pkketxgkcnpr7h</sha1> </revision> <revision> @@ -95,10 +95,10 @@ <ip>10.0.0.2</ip> </contributor> <comment>new!</comment> - <text xml:space="preserve" bytes="24">An earlier [[revision]].</text> - <sha1>etaxt3shcge6igz1biwy3d4um2pnle4</sha1> <model>wikitext</model> <format>text/x-wiki</format> + <text xml:space="preserve" bytes="24">An earlier [[revision]].</text> + <sha1>etaxt3shcge6igz1biwy3d4um2pnle4</sha1> </revision> </page> @@ -111,10 +111,10 @@ <timestamp>2001-01-15T14:03:00Z</timestamp> <contributor><ip>10.0.0.2</ip></contributor> <comment>hey</comment> - <text xml:space="preserve" bytes="47">WHYD YOU LOCK PAGE??!!! i was editing that jerk</text> - <sha1>ml80vmyjlixdstnywwihx003exfzq9j</sha1> <model>wikitext</model> <format>text/x-wiki</format> + <text xml:space="preserve" bytes="47">WHYD YOU LOCK PAGE??!!! i was editing that jerk</text> + <sha1>ml80vmyjlixdstnywwihx003exfzq9j</sha1> </revision> </page> @@ -127,10 +127,10 @@ <timestamp>2001-01-15T20:34:12Z</timestamp> <contributor><username>Foobar</username><id>42</id></contributor> <comment>My awesomeest image!</comment> - <text xml:space="preserve" bytes="52">This is an awesome little imgae. I lurves it. {{PD}}</text> - <sha1>mehom37npwkpzhaiwu3wyr0egalumki</sha1> <model>wikitext</model> <format>text/x-wiki</format> + <text xml:space="preserve" bytes="52">This is an awesome little imgae. I lurves it. {{PD}}</text> + <sha1>mehom37npwkpzhaiwu3wyr0egalumki</sha1> </revision> <upload> <timestamp>2001-01-15T20:34:12Z</timestamp> diff --git a/docs/extension.schema.json b/docs/extension.schema.json new file mode 100644 index 00000000..d5c17a17 --- /dev/null +++ b/docs/extension.schema.json @@ -0,0 +1,637 @@ +{ + "$schema": "http://json-schema.org/schema#", + "description": "MediaWiki extension.json schema", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The extension's canonical name.", + "required": true + }, + "namemsg": { + "type": "string", + "description": "i18n message key of the extension's name." + }, + "type": { + "type": "string", + "description": "The extension's type, as an index to $wgExtensionCredits.", + "default": "other", + "enum": [ + "api", + "antispam", + "datavalues", + "media", + "parserhook", + "semantic", + "skin", + "specialpage", + "variable", + "other" + ] + }, + "author": { + "type": [ + "string", + "array" + ], + "description": "Extension's authors.", + "items": { + "type": "string" + }, + "additionalItems": false + }, + "version": { + "type": "string", + "description": "The version of this release of the extension." + }, + "url": { + "type": "string", + "description": "URL to the homepage for the extension.", + "format": "uri" + }, + "description": { + "type": "string", + "description": "Raw description of the extension." + }, + "descriptionmsg": { + "type": "string", + "description": "Message key for a i18n message describing the extension." + }, + "license-name": { + "type": "string", + "description": "Short identifier for the license under which the extension is released.", + "enum": [ + "AFL-1.1", + "AFL-1.2", + "AFL-2.0", + "AFL-2.1", + "AFL-3.0", + "APL-1.0", + "Aladdin", + "ANTLR-PD", + "Apache-1.0", + "Apache-1.1", + "Apache-2.0", + "APSL-1.0", + "APSL-1.1", + "APSL-1.2", + "APSL-2.0", + "Artistic-1.0", + "Artistic-1.0-cl8", + "Artistic-1.0-Perl", + "Artistic-2.0", + "AAL", + "BitTorrent-1.0", + "BitTorrent-1.1", + "BSL-1.0", + "BSD-2-Clause", + "BSD-2-Clause-FreeBSD", + "BSD-2-Clause-NetBSD", + "BSD-3-Clause", + "BSD-3-Clause-Clear", + "BSD-4-Clause", + "BSD-4-Clause-UC", + "CECILL-1.0", + "CECILL-1.1", + "CECILL-2.0", + "CECILL-B", + "CECILL-C", + "ClArtistic", + "CNRI-Python", + "CNRI-Python-GPL-Compatible", + "CPOL-1.02", + "CDDL-1.0", + "CDDL-1.1", + "CPAL-1.0", + "CPL-1.0", + "CATOSL-1.1", + "Condor-1.1", + "CC-BY-1.0", + "CC-BY-2.0", + "CC-BY-2.5", + "CC-BY-3.0", + "CC-BY-ND-1.0", + "CC-BY-ND-2.0", + "CC-BY-ND-2.5", + "CC-BY-ND-3.0", + "CC-BY-NC-1.0", + "CC-BY-NC-2.0", + "CC-BY-NC-2.5", + "CC-BY-NC-3.0", + "CC-BY-NC-ND-1.0", + "CC-BY-NC-ND-2.0", + "CC-BY-NC-ND-2.5", + "CC-BY-NC-ND-3.0", + "CC-BY-NC-SA-1.0", + "CC-BY-NC-SA-2.0", + "CC-BY-NC-SA-2.5", + "CC-BY-NC-SA-3.0", + "CC-BY-SA-1.0", + "CC-BY-SA-2.0", + "CC-BY-SA-2.5", + "CC-BY-SA-3.0", + "CC0-1.0", + "CUA-OPL-1.0", + "D-FSL-1.0", + "WTFPL", + "EPL-1.0", + "eCos-2.0", + "ECL-1.0", + "ECL-2.0", + "EFL-1.0", + "EFL-2.0", + "Entessa", + "ErlPL-1.1", + "EUDatagrid", + "EUPL-1.0", + "EUPL-1.1", + "Fair", + "Frameworx-1.0", + "FTL", + "AGPL-1.0", + "AGPL-3.0", + "GFDL-1.1", + "GFDL-1.2", + "GFDL-1.3", + "GPL-1.0", + "GPL-1.0+", + "GPL-2.0", + "GPL-2.0+", + "GPL-2.0-with-autoconf-exception", + "GPL-2.0-with-bison-exception", + "GPL-2.0-with-classpath-exception", + "GPL-2.0-with-font-exception", + "GPL-2.0-with-GCC-exception", + "GPL-3.0", + "GPL-3.0+", + "GPL-3.0-with-autoconf-exception", + "GPL-3.0-with-GCC-exception", + "LGPL-2.1", + "LGPL-2.1+", + "LGPL-3.0", + "LGPL-3.0+", + "LGPL-2.0", + "LGPL-2.0+", + "gSOAP-1.3b", + "HPND", + "IBM-pibs", + "IPL-1.0", + "Imlib2", + "IJG", + "Intel", + "IPA", + "ISC", + "JSON", + "LPPL-1.3a", + "LPPL-1.0", + "LPPL-1.1", + "LPPL-1.2", + "LPPL-1.3c", + "Libpng", + "LPL-1.02", + "LPL-1.0", + "MS-PL", + "MS-RL", + "MirOS", + "MIT", + "Motosoto", + "MPL-1.0", + "MPL-1.1", + "MPL-2.0", + "MPL-2.0-no-copyleft-exception", + "Multics", + "NASA-1.3", + "Naumen", + "NBPL-1.0", + "NGPL", + "NOSL", + "NPL-1.0", + "NPL-1.1", + "Nokia", + "NPOSL-3.0", + "NTP", + "OCLC-2.0", + "ODbL-1.0", + "PDDL-1.0", + "OGTSL", + "OLDAP-2.2.2", + "OLDAP-1.1", + "OLDAP-1.2", + "OLDAP-1.3", + "OLDAP-1.4", + "OLDAP-2.0", + "OLDAP-2.0.1", + "OLDAP-2.1", + "OLDAP-2.2", + "OLDAP-2.2.1", + "OLDAP-2.3", + "OLDAP-2.4", + "OLDAP-2.5", + "OLDAP-2.6", + "OLDAP-2.7", + "OPL-1.0", + "OSL-1.0", + "OSL-2.0", + "OSL-2.1", + "OSL-3.0", + "OLDAP-2.8", + "OpenSSL", + "PHP-3.0", + "PHP-3.01", + "PostgreSQL", + "Python-2.0", + "QPL-1.0", + "RPSL-1.0", + "RPL-1.1", + "RPL-1.5", + "RHeCos-1.1", + "RSCPL", + "Ruby", + "SAX-PD", + "SGI-B-1.0", + "SGI-B-1.1", + "SGI-B-2.0", + "OFL-1.0", + "OFL-1.1", + "SimPL-2.0", + "Sleepycat", + "SMLNJ", + "SugarCRM-1.1.3", + "SISSL", + "SISSL-1.2", + "SPL-1.0", + "Watcom-1.0", + "NCSA", + "VSL-1.0", + "W3C", + "WXwindows", + "Xnet", + "X11", + "XFree86-1.1", + "YPL-1.0", + "YPL-1.1", + "Zimbra-1.3", + "Zlib", + "ZPL-1.1", + "ZPL-2.0", + "ZPL-2.1", + "Unlicense" + ] + }, + "ResourceFileModulePaths": { + "type": "object", + "description": "Default paths to use for all ResourceLoader file modules", + "additionalProperties": false, + "properties": { + "localBasePath": { + "type": "string", + "description": "Base path to prepend to all local paths, relative to current directory" + }, + "remoteExtPath": { + "type": "string", + "description": "Base path to prepend to all remote paths, relative to $wgExtensionAssetsPath" + }, + "remoteSkinPath": { + "type": "string", + "description": "Base path to prepend to all remote paths, relative to $wgStylePath" + } + } + }, + "ResourceModules": { + "type": "object", + "description": "ResourceLoader modules to register", + "additionalProperties": false, + "patternProperties": { + "^[a-zA-Z0-9\\.]+$": { + "type": "object", + "description": "A single ResourceLoader module descriptor", + "properties": { + "localBasePath": { + "type": "string", + "description": "Base path to prepend to all local paths in $options. Defaults to $IP" + }, + "remoteBasePath": { + "type": "string", + "description": "Base path to prepend to all remote paths in $options. Defaults to $wgScriptPath" + }, + "remoteExtPath": { + "type": "string", + "description": "Equivalent of remoteBasePath, but relative to $wgExtensionAssetsPath" + }, + "scripts": { + "type": "array", + "description": "Scripts to always include (array of file paths)", + "items": { + "type": "string" + } + }, + "languageScripts": { + "type": "object", + "description": "Scripts to include in specific language contexts (mapping of language code to file path(s))", + "patternProperties": { + "^[a-zA-Z0-9-]{2,}$": { + "type": [ + "string", + "array" + ], + "items": { + "type": "string" + } + } + } + }, + "skinScripts": { + "type": "object", + "description": "Scripts to include in specific skin contexts (mapping of skin name to script(s)", + "patternProperties": { + ".+": { + "type": [ + "string", + "array" + ], + "items": { + "type": "string" + } + } + } + }, + "debugScripts": { + "type": "array", + "description": "Scripts to include in debug contexts", + "items": { + "type": "string" + } + }, + "loaderScripts": { + "type": "array", + "description": "Scripts to include in the startup module", + "items": { + "type": "string" + } + }, + "dependencies": { + "type": "array", + "description": "Modules which must be loaded before this module", + "items": { + "type": "string" + } + }, + "styles": { + "type": "array", + "description": "Styles to always load", + "items": { + "type": "string" + } + }, + "skinStyles": { + "type": "object", + "description": "Styles to include in specific skin contexts (mapping of skin name to style(s))", + "patternProperties": { + ".+": { + "type": [ + "string", + "array" + ], + "items": { + "type": "string" + } + } + } + }, + "messages": { + "type": "array", + "description": "Messages to always load", + "items": { + "type": "string" + } + }, + "group": { + "type": "string", + "description": "Group which this module should be loaded together with" + }, + "position": { + "type": "string", + "description": "Position on the page to load this module at", + "enum": [ + "bottom", + "top" + ] + } + } + } + } + }, + "ResourceModuleSkinStyles": { + "type": "object", + "description": "ResourceLoader modules for custom skin styles" + }, + "ResourceLoaderSources": { + "type": "object", + "description": "ResourceLoader sources to register" + }, + "ResourceLoaderLESSVars": { + "type": "object", + "description": "ResourceLoader LESS variables" + }, + "ResourceLoaderLESSFunctions": { + "type": "object", + "description": "ResourceLoader LESS functions" + }, + "ResourceLoaderLESSImportPaths": { + "type": "object", + "description": "ResourceLoader import paths" + }, + "ConfigRegistry": { + "type": "object", + "description": "Registry of factory functions to create Config objects" + }, + "namespaces": { + "type": "object", + "description": "Method to add extra namespaces", + "properties": { + "id": { + "type": "integer" + }, + "constant": { + "type": "string" + }, + "name": { + "type": "string" + }, + "gender": { + "type": "object", + "properties": { + "male": { + "type": "string" + }, + "female": { + "type": "string" + } + } + }, + "subpages": { + "type": "boolean", + "default": false + }, + "content": { + "type": "boolean", + "default": false + }, + "defaultcontentmodel": { + "type": "string" + } + } + }, + "TrackingCategories": { + "type": "array", + "description": "Tracking category message keys" + }, + "DefaultUserOptions": { + "type": "object", + "description": "Default values of user options" + }, + "HiddenPrefs": { + "type": "array", + "description": "Preferences users cannot set" + }, + "GroupPermissions": { + "type": "object", + "description": "Default permissions to give to user groups" + }, + "RevokePermissions": { + "type": "object", + "description": "Default permissions to revoke from user groups" + }, + "ImplicitGroups": { + "type": "array", + "description": "Implicit groups" + }, + "GroupsAddToSelf": { + "type": "object", + "description": "Groups a user can add to themselves" + }, + "GroupsRemoveFromSelf": { + "type": "object", + "description": "Groups a user can remove from themselves" + }, + "AddGroups": { + "type": "object", + "description": "Groups a user can add to users" + }, + "RemoveGroups": { + "type": "object", + "description": "Groups a user can remove from users" + }, + "AvailableRights": { + "type": "array", + "description": "User rights added by the extension" + }, + "ContentHandlers": { + "type": "object", + "description": "Mapping of model ID to class name" + }, + "RateLimits": { + "type": "object", + "description": "Rate limits" + }, + "RecentChangesFlags": { + "type": "object", + "description": "Flags (letter symbols) shown on RecentChanges pages" + }, + "MediaHandlers": { + "type": "object", + "description": "Plugins for media file type handling. Each entry in the array maps a MIME type to a PHP class name." + }, + "ExtensionFunctions": { + "type": [ + "array", + "string" + ], + "description": "Function to call after setup has finished" + }, + "ExtensionMessagesFiles": { + "type": "object", + "description": "File paths containing PHP internationalization data" + }, + "MessagesDirs": { + "type": "object", + "description": "Directory paths containing JSON internationalization data" + }, + "ExtensionEntryPointListFiles": { + "type": "object" + }, + "SpecialPages": { + "type": "object", + "description": "SpecialPages implemented in this extension (mapping of page name to class name)" + }, + "AutoloadClasses": { + "type": "object" + }, + "Hooks": { + "type": "object", + "description": "Hooks this extension uses (mapping of hook name to callback)" + }, + "JobClasses": { + "type": "object", + "description": "Job types this extension implements (mapping of job type to class name)" + }, + "LogTypes": { + "type": "array", + "description": "List of new log types this extension uses" + }, + "LogRestrictions": { + "type": "object" + }, + "FilterLogTypes": { + "type": "array" + }, + "LogNames": { + "type": "object" + }, + "LogHeaders": { + "type": "object" + }, + "LogActions": { + "type": "object" + }, + "LogActionsHandlers": { + "type": "object" + }, + "Actions": { + "type": "object" + }, + "APIModules": { + "type": "object" + }, + "APIFormatModules": { + "type": "object" + }, + "APIMetaModules": { + "type": "object" + }, + "APIPropModules": { + "type": "object" + }, + "APIListModules": { + "type": "object" + }, + "ValidSkinNames": { + "type": "object" + }, + "callback": { + "type": [ + "array", + "string" + ], + "description": "A function to be called right after MediaWiki processes this file" + }, + "config": { + "type": "object", + "description": "Configuration options for this extension" + }, + "ParserTestFiles": { + "type": "array", + "description": "Parser test suite files to be run by parserTests.php when no specific filename is passed to it" + } + } +} diff --git a/docs/hooks.txt b/docs/hooks.txt index 910d812e..6f2050cc 100644 --- a/docs/hooks.txt +++ b/docs/hooks.txt @@ -34,15 +34,15 @@ title before displaying the article; the other converts the title to all uppercase letters. Currently, in MediaWiki code, we would handle this as follows (note: not real code, here): - function showAnArticle($article) { + function showAnArticle( $article ) { global $wgReverseTitle, $wgCapitalizeTitle; - if ($wgReverseTitle) { - wfReverseTitle($article); + if ( $wgReverseTitle ) { + wfReverseTitle( $article ); } - if ($wgCapitalizeTitle) { - wfCapitalizeTitle($article); + if ( $wgCapitalizeTitle ) { + wfCapitalizeTitle( $article ); } # code to actually show the article goes here @@ -52,34 +52,34 @@ An extension writer, or a local admin, will often add custom code to the function -- with or without a global variable. For example, someone wanting email notification when an article is shown may add: - function showAnArticle($article) { + function showAnArticle( $article ) { global $wgReverseTitle, $wgCapitalizeTitle, $wgNotifyArticle; - if ($wgReverseTitle) { - wfReverseTitle($article); + if ( $wgReverseTitle ) { + wfReverseTitle( $article ); } - if ($wgCapitalizeTitle) { - wfCapitalizeTitle($article); + if ( $wgCapitalizeTitle ) { + wfCapitalizeTitle( $article ); } # code to actually show the article goes here - if ($wgNotifyArticle) { - wfNotifyArticleShow($article)); + if ( $wgNotifyArticle ) { + wfNotifyArticleShow( $article ); } } Using a hook-running strategy, we can avoid having all this option-specific stuff in our mainline code. Using hooks, the function becomes: - function showAnArticle($article) { + function showAnArticle( $article ) { - if (wfRunHooks('ArticleShow', array(&$article))) { + if ( Hooks::run( 'ArticleShow', array( &$article ) ) ) { # code to actually show the article goes here - wfRunHooks('ArticleShowComplete', array(&$article)); + Hooks::run( 'ArticleShowComplete', array( &$article ) ); } } @@ -93,11 +93,11 @@ title-reversing if-blocks spread all over the codebase in showAnArticle, deleteAnArticle, exportArticle, etc., we can concentrate it all in an extension file: - function reverseArticleTitle($article) { + function reverseArticleTitle( $article ) { # ... } - function reverseForExport($article) { + function reverseForExport( $article ) { # ... } @@ -139,29 +139,29 @@ Hooks are registered by adding them to the global $wgHooks array for a given event. All the following are valid ways to define hooks: $wgHooks['EventName'][] = 'someFunction'; # function, no data - $wgHooks['EventName'][] = array('someFunction', $someData); - $wgHooks['EventName'][] = array('someFunction'); # weird, but OK + $wgHooks['EventName'][] = array( 'someFunction', $someData ); + $wgHooks['EventName'][] = array( 'someFunction' ); # weird, but OK $wgHooks['EventName'][] = $object; # object only - $wgHooks['EventName'][] = array($object, 'someMethod'); - $wgHooks['EventName'][] = array($object, 'someMethod', $someData); - $wgHooks['EventName'][] = array($object); # weird but OK + $wgHooks['EventName'][] = array( $object, 'someMethod' ); + $wgHooks['EventName'][] = array( $object, 'someMethod', $someData ); + $wgHooks['EventName'][] = array( $object ); # weird but OK When an event occurs, the function (or object method) will be called with the optional data provided as well as event-specific parameters. The above examples would result in the following code being executed when 'EventName' happened: # function, no data - someFunction($param1, $param2) + someFunction( $param1, $param2 ) # function with data - someFunction($someData, $param1, $param2) + someFunction( $someData, $param1, $param2 ) # object only - $object->onEventName($param1, $param2) + $object->onEventName( $param1, $param2 ) # object with method - $object->someMethod($param1, $param2) + $object->someMethod( $param1, $param2 ) # object with method and data - $object->someMethod($someData, $param1, $param2) + $object->someMethod( $someData, $param1, $param2 ) Note that when an object is the hook, and there's no specified method, the default method called is 'onEventName'. For different events this would be @@ -170,8 +170,8 @@ different: 'onArticleSave', 'onUserLogin', etc. The extra data is useful if we want to use the same function or object for different purposes. For example: - $wgHooks['ArticleSaveComplete'][] = array('ircNotify', 'TimStarling'); - $wgHooks['ArticleSaveComplete'][] = array('ircNotify', 'brion'); + $wgHooks['ArticleSaveComplete'][] = array( 'ircNotify', 'TimStarling' ); + $wgHooks['ArticleSaveComplete'][] = array( 'ircNotify', 'brion' ); This code would result in ircNotify being run twice when an article is saved: once for 'TimStarling', and once for 'brion'. @@ -188,9 +188,9 @@ The last result would be for cases where the hook function replaces the main functionality. For example, if you wanted to authenticate users to a custom system (LDAP, another PHP program, whatever), you could do: - $wgHooks['UserLogin'][] = array('ldapLogin', $ldapServer); + $wgHooks['UserLogin'][] = array( 'ldapLogin', $ldapServer ); - function ldapLogin($username, $password) { + function ldapLogin( $username, $password ) { # log user into LDAP return false; } @@ -204,25 +204,28 @@ Special:Version), and should be avoided when at all possible. ==Using hooks== -A calling function or method uses the wfRunHooks() function to run the hooks +A calling function or method uses the Hooks::run() function to run the hooks related to a particular event, like so: class Article { # ... function protect() { global $wgUser; - if (wfRunHooks('ArticleProtect', array(&$this, &$wgUser))) { + if ( Hooks::run( 'ArticleProtect', array( &$this, &$wgUser ) ) ) { # protect the article - wfRunHooks('ArticleProtectComplete', array(&$this, &$wgUser)); + Hooks::run( 'ArticleProtectComplete', array( &$this, &$wgUser ) ); } } } -wfRunHooks() returns true if the calling function should continue processing +Hooks::run() returns true if the calling function should continue processing (the hooks ran OK, or there are no hooks to run), or false if it shouldn't (an error occurred, or one of the hooks handled the action already). Checking the return value matters more for "before" hooks than for "complete" hooks. +Hooks::run() was added in MediaWiki 1.18, before that the global function +wfRunHooks must be used, which was deprecated in MediaWiki 1.25. + Note that hook parameters are passed in an array; this is a necessary inconvenience to make it possible to pass reference values (that can be changed) into the hook code. Also note that earlier versions of wfRunHooks took a @@ -260,13 +263,6 @@ $password: the password being submitted, not yet checked for validity a machine API rather than the HTML user interface. &$msg: the message identifier for abort reason (new in 1.18, not available before 1.18) -'AbortMove': Allows to abort moving an article (title). -$old: old title -$nt: new title -$user: user who is doing the move -$err: error message -$reason: the reason for the move (added in 1.13) - 'AbortNewAccount': Return false to cancel explicit account creation. $user: the User object about to be created (read-only, incomplete) &$msg: out parameter: HTML to display on abort @@ -321,7 +317,7 @@ $output: The OutputPage object where output() was called 'AfterImportPage': When a page import is completed. $title: Title under which the revisions were imported -$origTitle: Title provided by the XML file +$foreignTitle: ForeignTitle object based on data provided by the XML file $revCount: Number of revisions in the XML file $sRevCount: Number of successfully imported revisions $pageInfo: associative array of page information @@ -379,20 +375,73 @@ $editPage : the EditPage object $text : the new text of the article (has yet to be saved) &$resultArr : data in this array will be added to the API result +'ApiFeedContributions::feedItem': Called to convert the result of ContribsPager +into a FeedItem instance that ApiFeedContributions can consume. Implementors of +this hook may cancel the hook to signal that the item is not viewable in the +provided context. +$row: A row of data from ContribsPager. The set of data returned by ContribsPager + can be adjusted by handling the ContribsPager::reallyDoQuery hook. +$context: An IContextSource implementation. +&$feedItem: Set this to a FeedItem instance if the callback can handle the provided + row. This is provided to the hook as a null, if it is non null then another callback + has already handled the hook. + +'ApiFormatHighlight': Use to syntax-highlight API pretty-printed output. When +highlighting, add output to $context->getOutput() and return false. +$context: An IContextSource. +$text: Text to be highlighted. +$mime: MIME type of $text. +$format: API format code for $text. + 'APIGetAllowedParams': Use this hook to modify a module's parameters. &$module: ApiBase Module object &$params: Array of parameters $flags: int zero or OR-ed flags like ApiBase::GET_VALUES_FOR_HELP -'APIGetDescription': Use this hook to modify a module's description. +'APIGetDescription': DEPRECATED! Use APIGetDescriptionMessages instead. +Use this hook to modify a module's description. &$module: ApiBase Module object -&$desc: Array of descriptions +&$desc: String description, or array of description strings + +'APIGetDescriptionMessages': Use this hook to modify a module's help message. +$module: ApiBase Module object +&$msg: Array of Message objects -'APIGetParamDescription': Use this hook to modify a module's parameter -descriptions. +'APIGetParamDescription': DEPRECATED! Use APIGetParamDescriptionMessages instead. +Use this hook to modify a module's parameter descriptions. &$module: ApiBase Module object &$desc: Array of parameter descriptions +'APIGetParamDescriptionMessages': Use this hook to modify a module's parameter descriptions. +$module: ApiBase Module object +&$msg: Array of arrays of Message objects + +'APIHelpModifyOutput': Use this hook to modify an API module's help output. +$module: ApiBase Module object +&$help: Array of HTML strings to be joined for the output. +$options: Array Options passed to ApiHelp::getHelp + +'ApiMain::moduleManager': Called when ApiMain has finished initializing its +module manager. Can be used to conditionally register API modules. +$moduleManager: ApiModuleManager Module manager instance + +'ApiOpenSearchSuggest': Called when constructing the OpenSearch results. Hooks +can alter or append to the array. +&$results: array with integer keys to associative arrays. Keys in associative +array: + - title: Title object. + - redirect from: Title or null. + - extract: Description for this result. + - extract trimmed: If truthy, the extract will not be trimmed to + $wgOpenSearchDescriptionLength. + - image: Thumbnail for this result. Value is an array with subkeys 'source' + (url), 'width', 'height', 'alt', 'align'. + - url: Url for the given title. + +'ApiQuery::moduleManager': Called when ApiQuery has finished initializing its +module manager. Can be used to conditionally register API query modules. +$moduleManager: ApiModuleManager Module manager instance + 'APIQueryAfterExecute': After calling the execute() method of an action=query submodule. Use this to extend core API modules. &$module: Module object @@ -514,6 +563,10 @@ $error: if the deletion was prohibited, the (raw HTML) error message to display $status: Status object, modify this to throw an error. Overridden by $error (added in 1.20) +'ArticleDeleteAfterSuccess': Output after an article has been deleted. +$title: Title of the article that has been deleted. +$outputPage: OutputPage that can be used to append the output. + 'ArticleDeleteComplete': After an article is deleted. $wikiPage: the WikiPage that was deleted $user: the user that deleted the article @@ -746,12 +799,10 @@ $out: OutputPage object 'BeforeParserFetchFileAndTitle': Before an image is rendered by Parser. $parser: Parser object $nt: the image title -&$options: array of options to RepoGroup::findFile +&$options: array of options to RepoGroup::findFile. If it contains 'broken' + as a key then the file will appear as a broken thumbnail. &$descQuery: query string to add to thumbnail URL -FIXME: Where does the below sentence fit in? -If 'broken' is a key in $options then the file will appear as a broken thumbnail. - 'BeforeParserFetchTemplateAndtitle': Before a template is fetched by Parser. $parser: Parser object $title: title of the template @@ -830,6 +881,20 @@ $wikiPage: WikiPage that was removed 'CategoryPageView': Before viewing a categorypage in CategoryPage::view. $catpage: CategoryPage instance +'CategoryViewer::doCategoryQuery': After querying for pages to be displayed +in a Category page. Gives extensions the opportunity to batch load any +related data about the pages. +$type: The category type. Either 'page', 'file' or 'subcat' +$res: Query result from DatabaseBase::select() + +'CategoryViewer::generateLink': Before generating an output link allow +extensions opportunity to generate a more specific or relevant link. +$type: The category type. Either 'page', 'img' or 'subcat' +$title: Title object for the categorized page +$html: Requested html content of anchor +&$link: Returned value. When set to a non-null value by a hook subscriber +this value will be used as the anchor instead of Linker::link + 'ChangePasswordForm': For extensions that need to add a field to the ChangePassword form via the Preferences form. &$extraFields: An array of arrays that hold fields like would be passed to the @@ -863,6 +928,38 @@ $name: name of the special page, e.g. 'Watchlist' &$join_conds: join conditions for the tables $opts: FormOptions for this request +'ChangeTagAfterDelete': Called after a change tag has been deleted (that is, +removed from all revisions and log entries to which it was applied). This gives +extensions a chance to take it off their books. +$tag: name of the tag +&$status: Status object. Add warnings to this as required. There is no point + setting errors, as the deletion has already been partly carried out by this + point. + +'ChangeTagCanCreate': Tell whether a change tag should be able to be created +from the UI (Special:Tags) or via the API. You could use this hook if you want +to reserve a specific "namespace" of tags, or something similar. +$tag: name of the tag +$user: user initiating the action +&$status: Status object. Add your errors using `$status->fatal()` or warnings + using `$status->warning()`. Errors and warnings will be relayed to the user. + If you set an error, the user will be unable to create the tag. + +'ChangeTagCanDelete': Tell whether a change tag should be able to be +deleted from the UI (Special:Tags) or via the API. The default is that tags +defined using the ListDefinedTags hook are not allowed to be deleted unless +specifically allowed. If you wish to allow deletion of the tag, set +`$status = Status::newGood()` to allow deletion, and then `return false` from +the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry +out custom deletion actions. +$tag: name of the tag +$user: user initiating the action +&$status: Status object. See above. + +'ChangeTagsListActive': Allows you to nominate which of the tags your extension +uses are in active use. +&$tags: list of all active tags. Append to this array. + 'LoginUserMigrated': Called during login to allow extensions the opportunity to inform a user that their username doesn't exist for a specific reason, instead of letting the login form give the generic error message that the account does @@ -912,6 +1009,15 @@ generation of HTML may be skipped, but other information should still be present ParserOutput object. &$output: ParserOutput, to manipulate or replace +'ContentAlterParserOutput': Modify parser output for a given content object. +Called by Content::getParserOutput after parsing has finished. Can be used +for changes that depend on the result of the parsing but have to be done +before LinksUpdate is called (such as adding tracking categories based on +the rendered HTML). +$content: The Content to render +$title: Title of the page, as context +$parserOutput: ParserOutput to manipulate + 'ConvertContent': Called by AbstractContent::convert when a conversion to another content model is requested. $content: The Content object to be converted. @@ -955,6 +1061,21 @@ etc. 'DatabaseOraclePostInit': Called after initialising an Oracle database &$db: the DatabaseOracle object +'DeletedContribsPager::reallyDoQuery': Called before really executing the query for Special:DeletedContributions +Similar to ContribsPager::reallyDoQuery +&$data: an array of results of all contribs queries +$pager: The DeletedContribsPager object hooked into +$offset: Index offset, inclusive +$limit: Exact query limit +$descending: Query direction, false for ascending, true for descending + +'DeletedContributionsLineEnding': Called before a DeletedContributions HTML line is finished. +Similar to ContributionsLineEnding +$page: SpecialPage object for DeletedContributions +&$ret: the HTML line +$row: the DB row for this line +&$classes: the classes to add to the surrounding <li> + 'NewDifferenceEngine': Called when a new DifferenceEngine object is made $title: the diff page title (nullable) &$oldId: the actual old Id to use in the diff @@ -962,6 +1083,15 @@ $title: the diff page title (nullable) $old: the ?old= param value from the url $new: the ?new= param value from the url +'GetDifferenceEngine': Called when getting a new difference engine interface object +Return false for valid object in $differenceEngine or true for the default difference engine +$context: IContextSource context to be used for diff +$old: Revision ID to show and diff with +$new: Either a revision ID or one of the strings 'cur', 'prev' or 'next' +$refreshCache: If set, refreshes the diff cache +$unhide: If set, allow viewing deleted revs +&$differenceEngine: output parameter, difference engine object to be used for diff + 'DiffRevisionTools': Override or extend the revision tools available from the diff view, i.e. undo, etc. $newRev: Revision object of the "new" revision @@ -979,6 +1109,7 @@ $article: article (object) being viewed $oldid: oldid (int) being viewed 'DoEditSectionLink': Override the HTML generated for section edit links +* Deprecated in favour of SkinEditSectionLinks hook * $skin: Skin object rendering the UI $title: Title object for the title being linked to (may not be the same as the page title, if the section is included from a template) @@ -1009,7 +1140,8 @@ This may be triggered by the EditPage or any other facility that modifies page c Use the $status object to indicate whether the edit should be allowed, and to provide a reason for disallowing it. Return false to abort the edit, and true to continue. Returning true if $status->isOK() returns false means "don't save but continue user -interaction", e.g. show the edit form. +interaction", e.g. show the edit form. $status->apiHookResult can be set to an array +to be returned by api.php action=edit. This is used to deliver captchas. $context: object implementing the IContextSource interface. $content: content of the edit box, as a Content object. $status: Status object to represent errors, etc. @@ -1030,6 +1162,11 @@ $editPage: EditPage object saved, that is before WikiPage::doEditContent() is called $editpage_Obj: the current EditPage object +'EditPage::attemptSave:after': Called after an article save attempt +$editpage_Obj: the current EditPage object +$status: the resulting Status object +$resultDetails: Result details array + 'EditPage::importFormData': allow extensions to read additional data posted in the form $editpage: EditPage instance @@ -1163,6 +1300,12 @@ $editToken: The user's edit token. &$hookErr: Out-param for the error. Passed as the parameters to OutputPage::showErrorPage. +'EnhancedChangesList::getLogText': to alter, remove or add to the links of a +group of changes in EnhancedChangesList. +$changesList: EnhancedChangesList object +&$links: The links that were generated by EnhancedChangesList +$block: The RecentChanges objects in that block + 'ExemptFromAccountCreationThrottle': Exemption from the account creation throttle. $ip: The ip address of the user @@ -1214,15 +1357,15 @@ $reason: reason 'FormatAutocomments': When an autocomment is formatted by the Linker. &$comment: Reference to the accumulated comment. Initially null, when set the default code will be skipped. - $pre: Initial part of the parsed comment before the call to the hook. + $pre: Boolean, true if there is text before this autocomment $auto: The extracted part of the parsed comment before the call to the hook. - $post: The final part of the parsed comment before the call to the hook. + $post: Boolean, true if there is text after this autocomment $title: An optional title object used to links to sections. Can be null. $local: Boolean indicating whether section links should refer to local page. 'GalleryGetModes': Get list of classes that can render different modes of a gallery -$modeArray: An associative array mapping mode names to classes that implement +&$modeArray: An associative array mapping mode names to classes that implement that mode. It is expected all registered classes are a subclass of ImageGalleryBase. @@ -1422,7 +1565,7 @@ $page: ImagePage object 'ImgAuthBeforeStream': executed before file is streamed to user, but only when using img_auth.php. &$title: the Title object of the file as it would appear for the upload page -&$path: the original file and path name when img_auth was invoked by the the web +&$path: the original file and path name when img_auth was invoked by the web server &$name: the name only component of the file &$result: The location to pass back results of the hook routine (only used if @@ -1668,6 +1811,13 @@ optional localisation messages &$ignored Array of ignored message keys &$optional Array of optional message keys +'LogEventsListGetExtraInputs': When getting extra inputs to display on Special:Log +for a specific log type +$type: String of log type being displayed +$logEventsList: LogEventsList object for context and access to the WebRequest +&$input: string HTML of an input element + + 'LogEventsListShowLogExtract': Called before the string is added to OutputPage. Returning false will prevent the string from being added to the OutputPage. &$s: html string to show for the log extract @@ -1805,6 +1955,18 @@ $db: The database object to be queried. &$opts: Options for the query. &$join_conds: Join conditions for the query. +'MovePageCheckPermissions': Specify whether the user is allowed to move the page. +$oldTitle: Title object of the current (old) location +$newTitle: Title object of the new location +$user: User making the move +$reason: string of the reason provided by the user +$status: Status object to pass error messages to + +'MovePageIsValidMove': Specify whether a page can be moved for technical reasons. +$oldTitle: Title object of the current (old) location +$newTitle: Title object of the new location +$status: Status object to pass error messages to + 'BaseTemplateToolbox': Called by BaseTemplate when building the $toolbox array and returning it for the skin to output. You can add items to the toolbox while still letting the skin make final decisions on skin-specific markup conventions @@ -1850,6 +2012,17 @@ return false to omit the line from RecentChanges and Watchlist special pages. can alter or append to the array of URLs for search & suggestion formats. &$urls: array of associative arrays with Url element attributes +'OpportunisticLinksUpdate': Called by WikiPage::triggerOpportunisticLinksUpdate +when a page view triggers a re-rendering of the page. This may happen +particularly if the parser cache is split by user language, and no cached +rendering of the page exists in the user's language. The hook is called +before checking whether page_links_updated indicates that the links are up +to date. Returning false will cause triggerOpportunisticLinksUpdate() to abort +without triggering any updates. +$page: the Page that was rendered. +$title: the Title of the rendered page. +$parserOutput: ParserOutput resulting from rendering the page. + 'OtherBlockLogLink': Get links to the block log from extensions which blocks users and/or IP addresses too. $otherBlockLink: An array with links to other block logs @@ -1945,6 +2118,12 @@ the key. &$confstr: reference to a hash key string which can be modified $user: User (object) requesting the page +'PageViewUpdate': Allow database (or other) changes to be made after a +page view is seen by MediaWiki. Note this does not capture views made +via external caches such as Squid. +$wikipage: WikiPage (object) for the page being viewed. +$user: User (object) for the user who is viewing. + 'ParserAfterParse': Called from Parser::parse() just after the call to Parser::internalParse() returns. $parser: parser object @@ -2108,6 +2287,14 @@ $ns : array of int namespace keys to search in $search : search term (not guaranteed to be conveniently normalized) $limit : maximum number of results to return &$results : out param: array of page names (strings) +$offset : number of results to offset from the beginning + +'PrefixSearchExtractNamespace': Called if core was not able to extract a +namespace from the search string so that extensions can attempt it. +$namespaces : array of int namespace keys to search in (change this if you can +extract namespaces) +$search : search term (replace this with term without the namespace if you can +extract one) 'PrefsEmailAudit': Called when user changes their email address. $user: User (object) changing his email address @@ -2168,6 +2355,10 @@ configuration variables to JavaScript. Things that depend on the current page or request state must be added through MakeGlobalVariablesScript instead. &$vars: array( variable name => value ) +'ResourceLoaderGetLessVars': Called in ResourceLoader::getLessVars after variables +from $wgResourceLoaderLESSVars are added. Can be used to add context-based variables. +&$lessVars: array of variables already added + 'ResourceLoaderRegisterModules': Right before modules information is required, such as when responding to a resource loader request or generating HTML output. @@ -2225,6 +2416,18 @@ $title : Current Title object being displayed in search results. 'SearchableNamespaces': An option to modify which namespaces are searchable. &$arr : Array of namespaces ($nsId => $name) which will be used. +'SecondaryDataUpdates': Allows modification of the list of DataUpdates to +perform when page content is modified. Currently called by +AbstractContent::getSecondaryDataUpdates. +$title: Title of the page that is being edited. +$oldContent: Content object representing the page's content before the edit. +$recursive: bool indicating whether DataUpdates should trigger recursive + updates (relevant mostly for LinksUpdate). +$parserOutput: ParserOutput representing the rendered version of the page + after the edit. +&$updates: a list of DataUpdate objects, to be modified or replaced by + the hook handler. + 'SelfLinkBegin': Called before a link to the current article is displayed to allow the display of the link to be customized. $nt: the Title object @@ -2310,6 +2513,23 @@ $type: 'normal' or 'history' for old/diff views &$forContent: overridable flag if copyright footer is shown in content language. This parameter is deprecated. +'SkinEditSectionLinks': Modify the section edit links +$skin: Skin object rendering the UI +$title: Title object for the title being linked to (may not be the same as + the page title, if the section is included from a template) +$section: The designation of the section being pointed to, to be included in + the link, like "§ion=$section" +$tooltip: The default tooltip. Escape before using. + By default, this is wrapped in the 'editsectionhint' message. +&$result: Array containing all link detail arrays. Each link detail array should contain + the following keys: + * targetTitle - Target Title object + * text - String for the text + * attribs - Array of attributes + * query - Array of query parameters to add to the URL + * options - Array of options for Linker::link +$lang: The language code to use for the link in the wfMessage function + 'SkinGetPoweredBy': TODO &$text: additional 'powered by' icons in HTML. Note: Modern skin does not use the MediaWiki icon but plain text instead. @@ -2358,7 +2578,7 @@ after variants have been added. 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts page output. &$sktemplate: SkinTemplate object -&$tpl: Template engine object +&$tpl: QuickTemplate engine object 'SkinTemplatePreventOtherActiveTabs': Use this to prevent showing active tabs. $sktemplate: SkinTemplate object @@ -2428,6 +2648,11 @@ UsersPager::getQueryInfo() $pager: The UsersPager instance $query: The query array to be returned +'SpecialLogAddLogSearchRelations': Add log relations to the current log +$type: String of the log type +$request: WebRequest object for getting the value provided by the current user +&$qc: Array for query conditions to add + 'SpecialMovepageAfterMove': Called after moving a page. $movePage: MovePageForm object $oldTitle: old title (object) @@ -2449,7 +2674,7 @@ $special: the special page object (message key) and a 'default' value. 'SpecialPage_initList': Called when setting up SpecialPageFactory::$list, use this -hook to remove a core special page. +hook to remove a core special page or conditionally register special pages. $list: list (array) of core special pages 'SpecialPageAfterExecute': Called after SpecialPage::execute. @@ -2549,7 +2774,13 @@ $term: string of search term 'SpecialStatsAddExtra': Add extra statistic at the end of Special:Statistics. &$extraStats: Array to save the new stats - ( $extraStats['<name of statistic>'] => <value>; ) + ( $extraStats['<name of statistic>'] => <value>; + <value> can be an array with the keys "name" and "number": + "name" is the HTML to be displayed in the name column + "number" is the number to be displayed. + or, <value> can be the number to be displayed and <name> is the + message key to use in the name column, +$context: IContextSource object 'SpecialUploadComplete': Called after successfully uploading a file from Special:Upload. @@ -2621,7 +2852,8 @@ that can be applied. $title: The title in question. &$types: The types of protection available. -'TitleIsCssOrJsPage': Called when determining if a page is a CSS or JS page. +'TitleIsCssOrJsPage': DEPRECATED! Use ContentHandlerDefaultModelFor instead. +Called when determining if a page is a CSS or JS page. $title: Title object that is being checked $result: Boolean; whether MediaWiki currently thinks this is a CSS/JS page. Hooks may change this value to override the return value of @@ -2642,7 +2874,8 @@ $result: Boolean; whether MediaWiki currently thinks this page is movable. Hooks may change this value to override the return value of Title::isMovable(). -'TitleIsWikitextPage': Called when determining if a page is a wikitext or should +'TitleIsWikitextPage': DEPRECATED! Use ContentHandlerDefaultModelFor instead. +Called when determining if a page is a wikitext or should be handled by separate handler (via ArticleViewCustom). $title: Title object that is being checked $result: Boolean; whether MediaWiki currently thinks this is a wikitext page. @@ -2824,13 +3057,13 @@ $user: User object &$timestamp: timestamp, change this to override local email authentication timestamp -'UserGetImplicitGroups': Called in User::getImplicitGroups(). +'UserGetImplicitGroups': DEPRECATED, called in User::getImplicitGroups(). &$groups: List of implicit (automatically-assigned) groups 'UserGetLanguageObject': Called when getting user's interface language object. $user: User object &$code: Language code that will be used to create the object -$context: RequestContext object +$context: IContextSource object 'UserGetReservedNames': Allows to modify $wgReservedUsernames at run time. &$reservedUsernames: $wgReservedUsernames @@ -2963,6 +3196,11 @@ when UserMailer sends an email, with a bounce handling extension. $to: Array of MailAddress objects for the recipients &$returnPath: The return address string +'LoginFormValidErrorMessages': Called in LoginForm when a function gets valid error +messages. Allows to add additional error messages (except messages already in +LoginForm::$validErrorMessages). +&$messages Already added messages (inclusive messages from LoginForm::$validErrorMessages) + 'WantedPages::getQueryInfo': Called in WantedPagesPage::getQueryInfo(), can be used to alter the SQL query which gets the list of wanted pages. &$wantedPages: WantedPagesPage object diff --git a/docs/kss/Makefile b/docs/kss/Makefile index a7b0c471..dadfb47c 100644 --- a/docs/kss/Makefile +++ b/docs/kss/Makefile @@ -4,9 +4,9 @@ kss: kssnodecheck # Generates CSS of mediawiki.ui and mediawiki.ui.button using ResourceLoader, then applies it to the # KSS style guide $(eval KSS_RL_TMP := $(shell mktemp /tmp/tmp.XXXXXXXXXX)) -# Keep module names in strict alphabetical order, so CSS loads in the same order as ResourceLoader's addModuleStyles does; this can affect rendering. + $(eval MODULE_STR := $(shell paste -sd "|" styleGuideModules.txt)) # See OutputPage::makeResourceLoaderLink. - @curl -sG "${MEDIAWIKI_LOAD_URL}?modules=mediawiki.legacy.commonPrint|mediawiki.legacy.shared|mediawiki.ui|mediawiki.ui.anchor|mediawiki.ui.button|mediawiki.ui.checkbox|mediawiki.ui.input&only=styles" > $(KSS_RL_TMP) + @curl -sG "${MEDIAWIKI_LOAD_URL}?modules=${MODULE_STR}&only=styles" > $(KSS_RL_TMP) @node_modules/.bin/kss-node ../../resources/src/mediawiki.ui static/ --css $(KSS_RL_TMP) -t styleguide-template @rm $(KSS_RL_TMP) diff --git a/docs/kss/README.txt b/docs/kss/README.txt index c383af9e..76cfb627 100644 --- a/docs/kss/README.txt +++ b/docs/kss/README.txt @@ -17,3 +17,5 @@ If MediaWiki is running on localhost, you can omit MEDIAWIKI_LOAD_URL. To rebuild without opening the web browser, run: MEDIAWIKI_LOAD_URL=mediawiki_hostname/w/load.php make + +When modifying styleGuideModules.txt, keep the list in strict alphabetical order (with no extra formatting), so CSS loads in the same order as ResourceLoader's addModuleStyles does; this can affect rendering. diff --git a/docs/kss/styleGuideModules.txt b/docs/kss/styleGuideModules.txt new file mode 100644 index 00000000..20910105 --- /dev/null +++ b/docs/kss/styleGuideModules.txt @@ -0,0 +1,10 @@ +mediawiki.legacy.commonPrint +mediawiki.legacy.shared +mediawiki.ui +mediawiki.ui.anchor +mediawiki.ui.button +mediawiki.ui.checkbox +mediawiki.ui.icon +mediawiki.ui.input +mediawiki.ui.radio +mediawiki.ui.text diff --git a/docs/kss/styleguide-template/public/less.js b/docs/kss/styleguide-template/public/less.js deleted file mode 100644 index 89b76377..00000000 --- a/docs/kss/styleguide-template/public/less.js +++ /dev/null @@ -1,9 +0,0 @@ -// -// LESS - Leaner CSS v1.2.1 -// http://lesscss.org -// -// Copyright (c) 2009-2011, Alexis Sellier -// Licensed under the Apache 2.0 License. -// -(function(a,b){function c(b){return a.less[b.split("/")[1]]}function m(){var a=document.getElementsByTagName("style");for(var b=0;b<a.length;b++)a[b].type.match(k)&&(new d.Parser).parse(a[b].innerHTML||"",function(c,d){var e=d.toCSS(),f=a[b];f.type="text/css",f.styleSheet?f.styleSheet.cssText=e:f.innerHTML=e})}function n(a,b){for(var c=0;c<d.sheets.length;c++)o(d.sheets[c],a,b,d.sheets.length-(c+1))}function o(b,c,e,f){var g=a.location.href.replace(/[#?].*$/,""),i=b.href.replace(/\?.*$/,""),j=h&&h.getItem(i),k=h&&h.getItem(i+":timestamp"),l={css:j,timestamp:k};/^(https?|file):/.test(i)||(i.charAt(0)=="/"?i=a.location.protocol+"//"+a.location.host+i:i=g.slice(0,g.lastIndexOf("/")+1)+i);var m=i.match(/([^\/]+)$/)[1];s(b.href,b.type,function(a,g){if(!e&&l&&g&&(new Date(g)).valueOf()===(new Date(l.timestamp)).valueOf())r(l.css,b),c(null,b,{local:!0,remaining:f});else try{(new d.Parser({optimization:d.optimization,paths:[i.replace(/[\w\.-]+$/,"")],mime:b.type,filename:m})).parse(a,function(d,e){if(d)return w(d,i);try{c(d,e,a,b,{local:!1,lastModified:g,remaining:f}),u(document.getElementById("less-error-message:"+q(i)))}catch(d){w(d,i)}})}catch(h){w(h,i)}},function(a,b){throw new Error("Couldn't load "+b+" ("+a+")")})}function q(a){return a.replace(/^[a-z]+:\/\/?[^\/]+/,"").replace(/^\//,"").replace(/\?.*$/,"").replace(/\.[^\.\/]+$/,"").replace(/[^\.\w-]+/g,"-").replace(/\./g,":")}function r(a,b,c){var d,e=b.href?b.href.replace(/\?.*$/,""):"",f="less:"+(b.title||q(e));(d=document.getElementById(f))===null&&(d=document.createElement("style"),d.type="text/css",d.media=b.media||"screen",d.id=f,document.getElementsByTagName("head")[0].appendChild(d));if(d.styleSheet)try{d.styleSheet.cssText=a}catch(g){throw new Error("Couldn't reassign styleSheet.cssText.")}else(function(a){d.childNodes.length>0?d.firstChild.nodeValue!==a.nodeValue&&d.replaceChild(a,d.firstChild):d.appendChild(a)})(document.createTextNode(a));c&&h&&(v("saving "+e+" to cache."),h.setItem(e,a),h.setItem(e+":timestamp",c))}function s(a,b,c,e){function i(b,c,d){b.status>=200&&b.status<300?c(b.responseText,b.getResponseHeader("Last-Modified")):typeof d=="function"&&d(b.status,a)}var f=t(),h=g?!1:d.async;typeof f.overrideMimeType=="function"&&f.overrideMimeType("text/css"),f.open("GET",a,h),f.setRequestHeader("Accept",b||"text/x-less, text/css; q=0.9, */*; q=0.5"),f.send(null),g?f.status===0||f.status>=200&&f.status<300?c(f.responseText):e(f.status,a):h?f.onreadystatechange=function(){f.readyState==4&&i(f,c,e)}:i(f,c,e)}function t(){if(a.XMLHttpRequest)return new XMLHttpRequest;try{return new ActiveXObject("MSXML2.XMLHTTP.3.0")}catch(b){return v("browser doesn't support AJAX."),null}}function u(a){return a&&a.parentNode.removeChild(a)}function v(a){d.env=="development"&&typeof console!="undefined"&&console.log("less: "+a)}function w(a,b){var c="less-error-message:"+q(b),e='<li><label>{line}</label><pre class="{class}">{content}</pre></li>',f=document.createElement("div"),g,h,i=[],j=a.filename||b;f.id=c,f.className="less-error-message",h="<h3>"+(a.message||"There is an error in your .less file")+"</h3>"+'<p>in <a href="'+j+'">'+j+"</a> ";var k=function(a,b,c){a.extract[b]&&i.push(e.replace(/\{line\}/,parseInt(a.line)+(b-1)).replace(/\{class\}/,c).replace(/\{content\}/,a.extract[b]))};a.stack?h+="<br/>"+a.stack.split("\n").slice(1).join("<br/>"):a.extract&&(k(a,0,""),k(a,1,"line"),k(a,2,""),h+="on line "+a.line+", column "+(a.column+1)+":</p>"+"<ul>"+i.join("")+"</ul>"),f.innerHTML=h,r([".less-error-message ul, .less-error-message li {","list-style-type: none;","margin-right: 15px;","padding: 4px 0;","margin: 0;","}",".less-error-message label {","font-size: 12px;","margin-right: 15px;","padding: 4px 0;","color: #cc7777;","}",".less-error-message pre {","color: #dd6666;","padding: 4px 0;","margin: 0;","display: inline-block;","}",".less-error-message pre.line {","color: #ff0000;","}",".less-error-message h3 {","font-size: 20px;","font-weight: bold;","padding: 15px 0 5px 0;","margin: 0;","}",".less-error-message a {","color: #10a","}",".less-error-message .error {","color: red;","font-weight: bold;","padding-bottom: 2px;","border-bottom: 1px dashed red;","}"].join("\n"),{title:"error-message"}),f.style.cssText=["font-family: Arial, sans-serif","border: 1px solid #e00","background-color: #eee","border-radius: 5px","-webkit-border-radius: 5px","-moz-border-radius: 5px","color: #e00","padding: 15px","margin-bottom: 15px"].join(";"),d.env=="development"&&(g=setInterval(function(){document.body&&(document.getElementById(c)?document.body.replaceChild(f,document.getElementById(c)):document.body.insertBefore(f,document.body.firstChild),clearInterval(g))},10))}Array.isArray||(Array.isArray=function(a){return Object.prototype.toString.call(a)==="[object Array]"||a instanceof Array}),Array.prototype.forEach||(Array.prototype.forEach=function(a,b){var c=this.length>>>0;for(var d=0;d<c;d++)d in this&&a.call(b,this[d],d,this)}),Array.prototype.map||(Array.prototype.map=function(a){var b=this.length>>>0,c=new Array(b),d=arguments[1];for(var e=0;e<b;e++)e in this&&(c[e]=a.call(d,this[e],e,this));return c}),Array.prototype.filter||(Array.prototype.filter=function(a){var b=[],c=arguments[1];for(var d=0;d<this.length;d++)a.call(c,this[d])&&b.push(this[d]);return b}),Array.prototype.reduce||(Array.prototype.reduce=function(a){var b=this.length>>>0,c=0;if(b===0&&arguments.length===1)throw new TypeError;if(arguments.length>=2)var d=arguments[1];else do{if(c in this){d=this[c++];break}if(++c>=b)throw new TypeError}while(!0);for(;c<b;c++)c in this&&(d=a.call(null,d,this[c],c,this));return d}),Array.prototype.indexOf||(Array.prototype.indexOf=function(a){var b=this.length,c=arguments[1]||0;if(!b)return-1;if(c>=b)return-1;c<0&&(c+=b);for(;c<b;c++){if(!Object.prototype.hasOwnProperty.call(this,c))continue;if(a===this[c])return c}return-1}),Object.keys||(Object.keys=function(a){var b=[];for(var c in a)Object.prototype.hasOwnProperty.call(a,c)&&b.push(c);return b}),String.prototype.trim||(String.prototype.trim=function(){return String(this).replace(/^\s\s*/,"").replace(/\s\s*$/,"")});var d,f;typeof environment=="object"&&{}.toString.call(environment)==="[object Environment]"?(typeof a=="undefined"?d={}:d=a.less={},f=d.tree={},d.mode="rhino"):typeof a=="undefined"?(d=exports,f=c("./tree"),d.mode="node"):(typeof a.less=="undefined"&&(a.less={}),d=a.less,f=a.less.tree={},d.mode="browser"),d.Parser=function(b){function t(){j=m[i],k=h,n=h}function u(){m[i]=j,h=k,n=h}function v(){h>n&&(m[i]=m[i].slice(h-n),n=h)}function w(a){var b,c,d,e,f,j,k,l;if(a instanceof Function)return a.call(o.parsers);if(typeof a=="string")b=g.charAt(h)===a?a:null,d=1,v();else{v();if(!(b=a.exec(m[i])))return null;d=b[0].length}if(b){l=h+=d,j=h+m[i].length-d;while(h<j){e=g.charCodeAt(h);if(e!==32&&e!==10&&e!==9)break;h++}return m[i]=m[i].slice(d+(h-l)),n=h,m[i].length===0&&i<m.length-1&&i++,typeof b=="string"?b:b.length===1?b[0]:b}}function x(a,b){var c=w(a);if(!!c)return c;y(b||(typeof a=="string"?"expected '"+a+"' got '"+g.charAt(h)+"'":"unexpected token"))}function y(a,b){throw{index:h,type:b||"Syntax",message:a}}function z(a){return typeof a=="string"?g.charAt(h)===a:a.test(m[i])?!0:!1}function A(a,b){return a.filename&&b.filename&&a.filename!==b.filename?o.imports.contents[a.filename]:g}function B(a,b){for(var c=a,d=-1;c>=0&&b.charAt(c)!=="\n";c--)d++;return{line:typeof a=="number"?(b.slice(0,a).match(/\n/g)||"").length:null,column:d}}function C(a,b){var c=A(a,b),d=B(a.index,c),e=d.line,f=d.column,g=c.split("\n");this.type=a.type||"Syntax",this.message=a.message,this.filename=a.filename||b.filename,this.index=a.index,this.line=typeof e=="number"?e+1:null,this.callLine=a.call&&B(a.call,c)+1,this.callExtract=g[B(a.call,c)],this.stack=a.stack,this.column=f,this.extract=[g[e-1],g[e],g[e+1]]}var g,h,i,j,k,l,m,n,o,q=this,r=function(){},s=this.imports={paths:b&&b.paths||[],queue:[],files:{},contents:{},mime:b&&b.mime,error:null,push:function(a,c){var e=this;this.queue.push(a),d.Parser.importer(a,this.paths,function(b,d,f){e.queue.splice(e.queue.indexOf(a),1),e.files[a]=d,e.contents[a]=f,b&&!e.error&&(e.error=b),c(b,d),e.queue.length===0&&r()},b)}};return this.env=b=b||{},this.optimization="optimization"in this.env?this.env.optimization:1,this.env.filename=this.env.filename||null,o={imports:s,parse:function(a,e){var j,k,p,q,s,t,u=[],v,x=null;h=i=n=l=0,m=[],g=a.replace(/\r\n/g,"\n"),m=function(a){var c=0,d=/[^"'`\{\}\/\(\)]+/g,e=/\/\*(?:[^*]|\*+[^\/*])*\*+\/|\/\/.*/g,f=0,h,i=a[0],j,k;for(var l=0,m,n;l<g.length;l++){d.lastIndex=l,(h=d.exec(g))&&h.index===l&&(l+=h[0].length,i.push(h[0])),m=g.charAt(l),e.lastIndex=l,!k&&!j&&m==="/"&&(n=g.charAt(l+1),(n==="/"||n==="*")&&(h=e.exec(g))&&h.index===l&&(l+=h[0].length,i.push(h[0]),m=g.charAt(l)));if(m==="{"&&!k&&!j)f++,i.push(m);else if(m==="}"&&!k&&!j)f--,i.push(m),a[++c]=i=[];else if(m==="("&&!k&&!j)i.push(m),j=!0;else if(m===")"&&!k&&j)i.push(m),j=!1;else{if(m==='"'||m==="'"||m==="`")k?k=k===m?!1:k:k=m;i.push(m)}}if(f>0)throw{type:"Syntax",message:"Missing closing `}`",filename:b.filename};return a.map(function(a){return a.join("")})}([[]]);try{j=new f.Ruleset([],w(this.parsers.primary)),j.root=!0}catch(y){return e(new C(y,b))}j.toCSS=function(a){var e,g,h;return function(e,g){var h=[],i;e=e||{},typeof g=="object"&&!Array.isArray(g)&&(g=Object.keys(g).map(function(a){var b=g[a];return b instanceof f.Value||(b instanceof f.Expression||(b=new f.Expression([b])),b=new f.Value([b])),new f.Rule("@"+a,b,!1,0)}),h=[new f.Ruleset(null,g)]);try{var j=a.call(this,{frames:h}).toCSS([],{compress:e.compress||!1})}catch(k){throw new C(k,b)}if(i=o.imports.error)throw i instanceof C?i:new C(i,b);return e.yuicompress&&d.mode==="node"?c("./cssmin").compressor.cssmin(j):e.compress?j.replace(/(\s)+/g,"$1"):j}}(j.eval);if(h<g.length-1){h=l,t=g.split("\n"),s=(g.slice(0,h).match(/\n/g)||"").length+1;for(var z=h,A=-1;z>=0&&g.charAt(z)!=="\n";z--)A++;x={type:"Parse",message:"Syntax Error on line "+s,index:h,filename:b.filename,line:s,column:A,extract:[t[s-2],t[s-1],t[s]]}}this.imports.queue.length>0?r=function(){e(x,j)}:e(x,j)},parsers:{primary:function(){var a,b=[];while((a=w(this.mixin.definition)||w(this.rule)||w(this.ruleset)||w(this.mixin.call)||w(this.comment)||w(this.directive))||w(/^[\s\n]+/))a&&b.push(a);return b},comment:function(){var a;if(g.charAt(h)!=="/")return;if(g.charAt(h+1)==="/")return new f.Comment(w(/^\/\/.*/),!0);if(a=w(/^\/\*(?:[^*]|\*+[^\/*])*\*+\/\n?/))return new f.Comment(a)},entities:{quoted:function(){var a,b=h,c;g.charAt(b)==="~"&&(b++,c=!0);if(g.charAt(b)!=='"'&&g.charAt(b)!=="'")return;c&&w("~");if(a=w(/^"((?:[^"\\\r\n]|\\.)*)"|'((?:[^'\\\r\n]|\\.)*)'/))return new f.Quoted(a[0],a[1]||a[2],c)},keyword:function(){var a;if(a=w(/^[_A-Za-z-][_A-Za-z0-9-]*/))return f.colors.hasOwnProperty(a)?new f.Color(f.colors[a].slice(1)):new f.Keyword(a)},call:function(){var a,c,d=h;if(!(a=/^([\w-]+|%|progid:[\w\.]+)\(/.exec(m[i])))return;a=a[1].toLowerCase();if(a==="url")return null;h+=a.length;if(a==="alpha")return w(this.alpha);w("("),c=w(this.entities.arguments);if(!w(")"))return;if(a)return new f.Call(a,c,d,b.filename)},arguments:function(){var a=[],b;while(b=w(this.entities.assignment)||w(this.expression)){a.push(b);if(!w(","))break}return a},literal:function(){return w(this.entities.dimension)||w(this.entities.color)||w(this.entities.quoted)},assignment:function(){var a,b;if((a=w(/^\w+(?=\s?=)/i))&&w("=")&&(b=w(this.entity)))return new f.Assignment(a,b)},url:function(){var a;if(g.charAt(h)!=="u"||!w(/^url\(/))return;return a=w(this.entities.quoted)||w(this.entities.variable)||w(this.entities.dataURI)||w(/^[-\w%@$\/.&=:;#+?~]+/)||"",x(")"),new f.URL(a.value||a.data||a instanceof f.Variable?a:new f.Anonymous(a),s.paths)},dataURI:function(){var a;if(w(/^data:/)){a={},a.mime=w(/^[^\/]+\/[^,;)]+/)||"",a.charset=w(/^;\s*charset=[^,;)]+/)||"",a.base64=w(/^;\s*base64/)||"",a.data=w(/^,\s*[^)]+/);if(a.data)return a}},variable:function(){var a,c=h;if(g.charAt(h)==="@"&&(a=w(/^@@?[\w-]+/)))return new f.Variable(a,c,b.filename)},color:function(){var a;if(g.charAt(h)==="#"&&(a=w(/^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})/)))return new f.Color(a[1])},dimension:function(){var a,b=g.charCodeAt(h);if(b>57||b<45||b===47)return;if(a=w(/^(-?\d*\.?\d+)(px|%|em|rem|pc|ex|in|deg|s|ms|pt|cm|mm|rad|grad|turn)?/))return new f.Dimension(a[1],a[2])},javascript:function(){var a,b=h,c;g.charAt(b)==="~"&&(b++,c=!0);if(g.charAt(b)!=="`")return;c&&w("~");if(a=w(/^`([^`]*)`/))return new f.JavaScript(a[1],h,c)}},variable:function(){var a;if(g.charAt(h)==="@"&&(a=w(/^(@[\w-]+)\s*:/)))return a[1]},shorthand:function(){var a,b;if(!z(/^[@\w.%-]+\/[@\w.-]+/))return;if((a=w(this.entity))&&w("/")&&(b=w(this.entity)))return new f.Shorthand(a,b)},mixin:{call:function(){var a=[],c,d,e,i=h,j=g.charAt(h),k=!1;if(j!=="."&&j!=="#")return;while(c=w(/^[#.](?:[\w-]|\\(?:[a-fA-F0-9]{1,6} ?|[^a-fA-F0-9]))+/))a.push(new f.Element(d,c,h)),d=w(">");w("(")&&(e=w(this.entities.arguments))&&w(")"),w(this.important)&&(k=!0);if(a.length>0&&(w(";")||z("}")))return new f.mixin.Call(a,e,i,b.filename,k)},definition:function(){var a,b=[],c,d,e,i,j;if(g.charAt(h)!=="."&&g.charAt(h)!=="#"||z(/^[^{]*(;|})/))return;t();if(c=w(/^([#.](?:[\w-]|\\(?:[a-fA-F0-9]{1,6} ?|[^a-fA-F0-9]))+)\s*\(/)){a=c[1];while(e=w(this.entities.variable)||w(this.entities.literal)||w(this.entities.keyword)){e instanceof f.Variable?w(":")?(i=x(this.expression,"expected expression"),b.push({name:e.name,value:i})):b.push({name:e.name}):b.push({value:e});if(!w(","))break}x(")"),w(/^when/)&&(j=x(this.conditions,"expected condition")),d=w(this.block);if(d)return new f.mixin.Definition(a,b,d,j);u()}}},entity:function(){return w(this.entities.literal)||w(this.entities.variable)||w(this.entities.url)||w(this.entities.call)||w(this.entities.keyword)||w(this.entities.javascript)||w(this.comment)},end:function(){return w(";")||z("}")},alpha:function(){var a;if(!w(/^\(opacity=/i))return;if(a=w(/^\d+/)||w(this.entities.variable))return x(")"),new f.Alpha(a)},element:function(){var a,b,c,d;c=w(this.combinator),a=w(/^(?:\d+\.\d+|\d+)%/)||w(/^(?:[.#]?|:*)(?:[\w-]|\\(?:[a-fA-F0-9]{1,6} ?|[^a-fA-F0-9]))+/)||w("*")||w(this.attribute)||w(/^\([^)@]+\)/),a||w("(")&&(d=w(this.entities.variable))&&w(")")&&(a=new f.Paren(d));if(a)return new f.Element(c,a,h);if(c.value&&c.value.charAt(0)==="&")return new f.Element(c,null,h)},combinator:function(){var a,b=g.charAt(h);if(b===">"||b==="+"||b==="~"){h++;while(g.charAt(h)===" ")h++;return new f.Combinator(b)}if(b==="&"){a="&",h++,g.charAt(h)===" "&&(a="& ");while(g.charAt(h)===" ")h++;return new f.Combinator(a)}if(b===":"&&g.charAt(h+1)===":"){h+=2;while(g.charAt(h)===" ")h++;return new f.Combinator("::")}return g.charAt(h-1)===" "?new f.Combinator(" "):new f.Combinator(null)},selector:function(){var a,b,c=[],d,e;while(b=w(this.element)){d=g.charAt(h),c.push(b);if(d==="{"||d==="}"||d===";"||d===",")break}if(c.length>0)return new f.Selector(c)},tag:function(){return w(/^[a-zA-Z][a-zA-Z-]*[0-9]?/)||w("*")},attribute:function(){var a="",b,c,d;if(!w("["))return;if(b=w(/^[a-zA-Z-]+/)||w(this.entities.quoted))(d=w(/^[|~*$^]?=/))&&(c=w(this.entities.quoted)||w(/^[\w-]+/))?a=[b,d,c.toCSS?c.toCSS():c].join(""):a=b;if(!w("]"))return;if(a)return"["+a+"]"},block:function(){var a;if(w("{")&&(a=w(this.primary))&&w("}"))return a},ruleset:function(){var a=[],b,c,d;t();while(b=w(this.selector)){a.push(b),w(this.comment);if(!w(","))break;w(this.comment)}if(a.length>0&&(c=w(this.block)))return new f.Ruleset(a,c);l=h,u()},rule:function(){var a,b,c=g.charAt(h),d,e;t();if(c==="."||c==="#"||c==="&")return;if(a=w(this.variable)||w(this.property)){a.charAt(0)!="@"&&(e=/^([^@+\/'"*`(;{}-]*);/.exec(m[i]))?(h+=e[0].length-1,b=new f.Anonymous(e[1])):a==="font"?b=w(this.font):b=w(this.value),d=w(this.important);if(b&&w(this.end))return new f.Rule(a,b,d,k);l=h,u()}},"import":function(){var a,b,c=h;if(w(/^@import\s+/)&&(a=w(this.entities.quoted)||w(this.entities.url))){b=w(this.mediaFeatures);if(w(";"))return new f.Import(a,s,b,c)}},mediaFeature:function(){var a=[];do if(e=w(this.entities.keyword))a.push(e);else if(w("(")){p=w(this.property),e=w(this.entity);if(!w(")"))return null;if(p&&e)a.push(new f.Paren(new f.Rule(p,e,null,h,!0)));else{if(!e)return null;a.push(new f.Paren(e))}}while(e);if(a.length>0)return new f.Expression(a)},mediaFeatures:function(){var a,b=[];while(a=w(this.mediaFeature)){b.push(a);if(!w(","))break}return b.length>0?b:null},media:function(){var a;if(w(/^@media/)){a=w(this.mediaFeatures);if(rules=w(this.block))return new f.Directive("@media",rules,a)}},directive:function(){var a,b,c,d,e,i;if(g.charAt(h)!=="@")return;if(b=w(this["import"])||w(this.media))return b;if(a=w(/^@page|@keyframes/)||w(/^@(?:-webkit-|-moz-|-o-|-ms-)[a-z0-9-]+/)){d=(w(/^[^{]+/)||"").trim();if(c=w(this.block))return new f.Directive(a+" "+d,c)}else if(a=w(/^@[-a-z]+/))if(a==="@font-face"){if(c=w(this.block))return new f.Directive(a,c)}else if((b=w(this.entity))&&w(";"))return new f.Directive(a,b)},font:function(){var a=[],b=[],c,d,e,g;while(g=w(this.shorthand)||w(this.entity))b.push(g);a.push(new f.Expression(b));if(w(","))while(g=w(this.expression)){a.push(g);if(!w(","))break}return new f.Value(a)},value:function(){var a,b=[],c;while(a=w(this.expression)){b.push(a);if(!w(","))break}if(b.length>0)return new f.Value(b)},important:function(){if(g.charAt(h)==="!")return w(/^! *important/)},sub:function(){var a;if(w("(")&&(a=w(this.expression))&&w(")"))return a},multiplication:function(){var a,b,c,d;if(a=w(this.operand)){while(!z(/^\/\*/)&&(c=w("/")||w("*"))&&(b=w(this.operand)))d=new f.Operation(c,[d||a,b]);return d||a}},addition:function(){var a,b,c,d;if(a=w(this.multiplication)){while((c=w(/^[-+]\s+/)||g.charAt(h-1)!=" "&&(w("+")||w("-")))&&(b=w(this.multiplication)))d=new f.Operation(c,[d||a,b]);return d||a}},conditions:function(){var a,b,c=h,d;if(a=w(this.condition)){while(w(",")&&(b=w(this.condition)))d=new f.Condition("or",d||a,b,c);return d||a}},condition:function(){var a,b,c,d,e=h,g=!1;w(/^not/)&&(g=!0),x("(");if(a=w(this.addition)||w(this.entities.keyword)||w(this.entities.quoted))return(d=w(/^(?:>=|=<|[<=>])/))?(b=w(this.addition)||w(this.entities.keyword)||w(this.entities.quoted))?c=new f.Condition(d,a,b,e,g):y("expected expression"):c=new f.Condition("=",a,new f.Keyword("true"),e,g),x(")"),w(/^and/)?new f.Condition("and",c,w(this.condition)):c},operand:function(){var a,b=g.charAt(h+1);g.charAt(h)==="-"&&(b==="@"||b==="(")&&(a=w("-"));var c=w(this.sub)||w(this.entities.dimension)||w(this.entities.color)||w(this.entities.variable)||w(this.entities.call);return a?new f.Operation("*",[new f.Dimension(-1),c]):c},expression:function(){var a,b,c=[],d;while(a=w(this.addition)||w(this.entity))c.push(a);if(c.length>0)return new f.Expression(c)},property:function(){var a;if(a=w(/^(\*?-?[-a-z_0-9]+)\s*:/))return a[1]}}}};if(d.mode==="browser"||d.mode==="rhino")d.Parser.importer=function(a,b,c,d){a.charAt(0)!=="/"&&b.length>0&&(a=b[0]+a),o({href:a,title:a,type:d.mime},c,!0)};(function(a){function b(b){return a.functions.hsla(b.h,b.s,b.l,b.a)}function c(b){if(b instanceof a.Dimension)return parseFloat(b.unit=="%"?b.value/100:b.value);if(typeof b=="number")return b;throw{error:"RuntimeError",message:"color functions take numbers as parameters"}}function d(a){return Math.min(1,Math.max(0,a))}a.functions={rgb:function(a,b,c){return this.rgba(a,b,c,1)},rgba:function(b,d,e,f){var g=[b,d,e].map(function(a){return c(a)}),f=c(f);return new a.Color(g,f)},hsl:function(a,b,c){return this.hsla(a,b,c,1)},hsla:function(a,b,d,e){function h(a){return a=a<0?a+1:a>1?a-1:a,a*6<1?g+(f-g)*a*6:a*2<1?f:a*3<2?g+(f-g)*(2/3-a)*6:g}a=c(a)%360/360,b=c(b),d=c(d),e=c(e);var f=d<=.5?d*(b+1):d+b-d*b,g=d*2-f;return this.rgba(h(a+1/3)*255,h(a)*255,h(a-1/3)*255,e)},hue:function(b){return new a.Dimension(Math.round(b.toHSL().h))},saturation:function(b){return new a.Dimension(Math.round(b.toHSL().s*100),"%")},lightness:function(b){return new a.Dimension(Math.round(b.toHSL().l*100),"%")},alpha:function(b){return new a.Dimension(b.toHSL().a)},saturate:function(a,c){var e=a.toHSL();return e.s+=c.value/100,e.s=d(e.s),b(e)},desaturate:function(a,c){var e=a.toHSL();return e.s-=c.value/100,e.s=d(e.s),b(e)},lighten:function(a,c){var e=a.toHSL();return e.l+=c.value/100,e.l=d(e.l),b(e)},darken:function(a,c){var e=a.toHSL();return e.l-=c.value/100,e.l=d(e.l),b(e)},fadein:function(a,c){var e=a.toHSL();return e.a+=c.value/100,e.a=d(e.a),b(e)},fadeout:function(a,c){var e=a.toHSL();return e.a-=c.value/100,e.a=d(e.a),b(e)},fade:function(a,c){var e=a.toHSL();return e.a=c.value/100,e.a=d(e.a),b(e)},spin:function(a,c){var d=a.toHSL(),e=(d.h+c.value)%360;return d.h=e<0?360+e:e,b(d)},mix:function(b,c,d){var e=d.value/100,f=e*2-1,g=b.toHSL().a-c.toHSL().a,h=((f*g==-1?f:(f+g)/(1+f*g))+1)/2,i=1-h,j=[b.rgb[0]*h+c.rgb[0]*i,b.rgb[1]*h+c.rgb[1]*i,b.rgb[2]*h+c.rgb[2]*i],k=b.alpha*e+c.alpha*(1-e);return new a.Color(j,k)},greyscale:function(b){return this.desaturate(b,new a.Dimension(100))},e:function(b){return new a.Anonymous(b instanceof a.JavaScript?b.evaluated:b)},escape:function(b){return new a.Anonymous(encodeURI(b.value).replace(/=/g,"%3D").replace(/:/g,"%3A").replace(/#/g,"%23").replace(/;/g,"%3B").replace(/\(/g,"%28").replace(/\)/g,"%29"))},"%":function(b){var c=Array.prototype.slice.call(arguments,1),d=b.value;for(var e=0;e<c.length;e++)d=d.replace(/%[sda]/i,function(a){var b=a.match(/s/i)?c[e].value:c[e].toCSS();return a.match(/[A-Z]$/)?encodeURIComponent(b):b});return d=d.replace(/%%/g,"%"),new a.Quoted('"'+d+'"',d)},round:function(a){return this._math("round",a)},ceil:function(a){return this._math("ceil",a)},floor:function(a){return this._math("floor",a)},_math:function(b,d){if(d instanceof a.Dimension)return new a.Dimension(Math[b](c(d)),d.unit);if(typeof d=="number")return Math[b](d);throw{type:"Argument",message:"argument must be a number"}},argb:function(b){return new a.Anonymous(b.toARGB())},percentage:function(b){return new a.Dimension(b.value*100,"%")},color:function(b){if(b instanceof a.Quoted)return new a.Color(b.value.slice(1));throw{type:"Argument",message:"argument must be a string"}},iscolor:function(b){return this._isa(b,a.Color)},isnumber:function(b){return this._isa(b,a.Dimension)},isstring:function(b){return this._isa(b,a.Quoted)},iskeyword:function(b){return this._isa(b,a.Keyword)},isurl:function(b){return this._isa(b,a.URL)},ispixel:function(b){return b instanceof a.Dimension&&b.unit==="px"?a.True:a.False},ispercentage:function(b){return b instanceof a.Dimension&&b.unit==="%"?a.True:a.False},isem:function(b){return b instanceof a.Dimension&&b.unit==="em"?a.True:a.False},_isa:function(b,c){return b instanceof c?a.True:a.False}}})(c("./tree")),function(a){a.colors={aliceblue:"#f0f8ff",antiquewhite:"#faebd7",aqua:"#00ffff",aquamarine:"#7fffd4",azure:"#f0ffff",beige:"#f5f5dc",bisque:"#ffe4c4",black:"#000000",blanchedalmond:"#ffebcd",blue:"#0000ff",blueviolet:"#8a2be2",brown:"#a52a2a",burlywood:"#deb887",cadetblue:"#5f9ea0",chartreuse:"#7fff00",chocolate:"#d2691e",coral:"#ff7f50",cornflowerblue:"#6495ed",cornsilk:"#fff8dc",crimson:"#dc143c",cyan:"#00ffff",darkblue:"#00008b",darkcyan:"#008b8b",darkgoldenrod:"#b8860b",darkgray:"#a9a9a9",darkgrey:"#a9a9a9",darkgreen:"#006400",darkkhaki:"#bdb76b",darkmagenta:"#8b008b",darkolivegreen:"#556b2f",darkorange:"#ff8c00",darkorchid:"#9932cc",darkred:"#8b0000",darksalmon:"#e9967a",darkseagreen:"#8fbc8f",darkslateblue:"#483d8b",darkslategray:"#2f4f4f",darkslategrey:"#2f4f4f",darkturquoise:"#00ced1",darkviolet:"#9400d3",deeppink:"#ff1493",deepskyblue:"#00bfff",dimgray:"#696969",dimgrey:"#696969",dodgerblue:"#1e90ff",firebrick:"#b22222",floralwhite:"#fffaf0",forestgreen:"#228b22",fuchsia:"#ff00ff",gainsboro:"#dcdcdc",ghostwhite:"#f8f8ff",gold:"#ffd700",goldenrod:"#daa520",gray:"#808080",grey:"#808080",green:"#008000",greenyellow:"#adff2f",honeydew:"#f0fff0",hotpink:"#ff69b4",indianred:"#cd5c5c",indigo:"#4b0082",ivory:"#fffff0",khaki:"#f0e68c",lavender:"#e6e6fa",lavenderblush:"#fff0f5",lawngreen:"#7cfc00",lemonchiffon:"#fffacd",lightblue:"#add8e6",lightcoral:"#f08080",lightcyan:"#e0ffff",lightgoldenrodyellow:"#fafad2",lightgray:"#d3d3d3",lightgrey:"#d3d3d3",lightgreen:"#90ee90",lightpink:"#ffb6c1",lightsalmon:"#ffa07a",lightseagreen:"#20b2aa",lightskyblue:"#87cefa",lightslategray:"#778899",lightslategrey:"#778899",lightsteelblue:"#b0c4de",lightyellow:"#ffffe0",lime:"#00ff00",limegreen:"#32cd32",linen:"#faf0e6",magenta:"#ff00ff",maroon:"#800000",mediumaquamarine:"#66cdaa",mediumblue:"#0000cd",mediumorchid:"#ba55d3",mediumpurple:"#9370d8",mediumseagreen:"#3cb371",mediumslateblue:"#7b68ee",mediumspringgreen:"#00fa9a",mediumturquoise:"#48d1cc",mediumvioletred:"#c71585",midnightblue:"#191970",mintcream:"#f5fffa",mistyrose:"#ffe4e1",moccasin:"#ffe4b5",navajowhite:"#ffdead",navy:"#000080",oldlace:"#fdf5e6",olive:"#808000",olivedrab:"#6b8e23",orange:"#ffa500",orangered:"#ff4500",orchid:"#da70d6",palegoldenrod:"#eee8aa",palegreen:"#98fb98",paleturquoise:"#afeeee",palevioletred:"#d87093",papayawhip:"#ffefd5",peachpuff:"#ffdab9",peru:"#cd853f",pink:"#ffc0cb",plum:"#dda0dd",powderblue:"#b0e0e6",purple:"#800080",red:"#ff0000",rosybrown:"#bc8f8f",royalblue:"#4169e1",saddlebrown:"#8b4513",salmon:"#fa8072",sandybrown:"#f4a460",seagreen:"#2e8b57",seashell:"#fff5ee",sienna:"#a0522d",silver:"#c0c0c0",skyblue:"#87ceeb",slateblue:"#6a5acd",slategray:"#708090",slategrey:"#708090",snow:"#fffafa",springgreen:"#00ff7f",steelblue:"#4682b4",tan:"#d2b48c",teal:"#008080",thistle:"#d8bfd8",tomato:"#ff6347",turquoise:"#40e0d0",violet:"#ee82ee",wheat:"#f5deb3",white:"#ffffff",whitesmoke:"#f5f5f5",yellow:"#ffff00",yellowgreen:"#9acd32"}}(c("./tree")),function(a){a.Alpha=function(a){this.value=a},a.Alpha.prototype={toCSS:function(){return"alpha(opacity="+(this.value.toCSS?this.value.toCSS():this.value)+")"},eval:function(a){return this.value.eval&&(this.value=this.value.eval(a)),this}}}(c("../tree")),function(a){a.Anonymous=function(a){this.value=a.value||a},a.Anonymous.prototype={toCSS:function(){return this.value},eval:function(){return this}}}(c("../tree")),function(a){a.Assignment=function(a,b){this.key=a,this.value=b},a.Assignment.prototype={toCSS:function(){return this.key+"="+(this.value.toCSS?this.value.toCSS():this.value)},eval:function(a){return this.value.eval&&(this.value=this.value.eval(a)),this}}}(c("../tree")),function(a){a.Call=function(a,b,c,d){this.name=a,this.args=b,this.index=c,this.filename=d},a.Call.prototype={eval:function(b){var c=this.args.map(function(a){return a.eval(b)});if(!(this.name in a.functions))return new a.Anonymous(this.name+"("+c.map(function(a){return a.toCSS()}).join(", ")+")");try{return a.functions[this.name].apply(a.functions,c)}catch(d){throw{type:d.type||"Runtime",message:"error evaluating function `"+this.name+"`"+(d.message?": "+d.message:""),index:this.index,filename:this.filename}}},toCSS:function(a){return this.eval(a).toCSS()}}}(c("../tree")),function(a){a.Color=function(a,b){Array.isArray(a)?this.rgb=a:a.length==6?this.rgb=a.match(/.{2}/g).map(function(a){return parseInt(a,16)}):this.rgb=a.split("").map(function(a){return parseInt(a+a,16)}),this.alpha=typeof b=="number"?b:1},a.Color.prototype={eval:function(){return this},toCSS:function(){return this.alpha<1?"rgba("+this.rgb.map(function(a){return Math.round(a)}).concat(this.alpha).join(", ")+")":"#"+this.rgb.map(function(a){return a=Math.round(a),a=(a>255?255:a<0?0:a).toString(16),a.length===1?"0"+a:a}).join("")},operate:function(b,c){var d=[];c instanceof a.Color||(c=c.toColor());for(var e=0;e<3;e++)d[e]=a.operate(b,this.rgb[e],c.rgb[e]);return new a.Color(d,this.alpha+c.alpha)},toHSL:function(){var a=this.rgb[0]/255,b=this.rgb[1]/255,c=this.rgb[2]/255,d=this.alpha,e=Math.max(a,b,c),f=Math.min(a,b,c),g,h,i=(e+f)/2,j=e-f;if(e===f)g=h=0;else{h=i>.5?j/(2-e-f):j/(e+f);switch(e){case a:g=(b-c)/j+(b<c?6:0);break;case b:g=(c-a)/j+2;break;case c:g=(a-b)/j+4}g/=6}return{h:g*360,s:h,l:i,a:d}},toARGB:function(){var a=[Math.round(this.alpha*255)].concat(this.rgb);return"#"+a.map(function(a){return a=Math.round(a),a=(a>255?255:a<0?0:a).toString(16),a.length===1?"0"+a:a}).join("")}}}(c("../tree")),function(a){a.Comment=function(a,b){this.value=a,this.silent=!!b},a.Comment.prototype={toCSS:function(a){return a.compress?"":this.value},eval:function(){return this}}}(c("../tree")),function(a){a.Condition=function(a,b,c,d,e){this.op=a.trim(),this.lvalue=b,this.rvalue=c,this.index=d,this.negate=e},a.Condition.prototype.eval=function(a){var b=this.lvalue.eval(a),c=this.rvalue.eval(a),d=this.index,e,e=function(a){switch(a){case"and":return b&&c;case"or":return b||c;default:if(b.compare)e=b.compare(c);else{if(!c.compare)throw{type:"Type",message:"Unable to perform comparison",index:d};e=c.compare(b)}switch(e){case-1:return a==="<"||a==="=<";case 0:return a==="="||a===">="||a==="=<";case 1:return a===">"||a===">="}}}(this.op);return this.negate?!e:e}}(c("../tree")),function(a){a.Dimension=function(a,b){this.value=parseFloat(a),this.unit=b||null},a.Dimension.prototype={eval:function(){return this},toColor:function(){return new a.Color([this.value,this.value,this.value])},toCSS:function(){var a=this.value+this.unit;return a},operate:function(b,c){return new a.Dimension(a.operate(b,this.value,c.value),this.unit||c.unit)},compare:function(b){return b instanceof a.Dimension?b.value>this.value?-1:b.value<this.value?1:0:-1}}}(c("../tree")),function(a){a.Directive=function(b,c,d){this.name=b,this.features=d&&new a.Value(d),Array.isArray(c)?(this.ruleset=new a.Ruleset([],c),this.ruleset.allowImports=!0):this.value=c},a.Directive.prototype={toCSS:function(a,b){var c=this.features?" "+this.features.toCSS(b):"";return this.ruleset?(this.ruleset.root=!0,this.name+c+(b.compress?"{":" {\n ")+this.ruleset.toCSS(a,b).trim().replace(/\n/g,"\n ")+(b.compress?"}":"\n}\n")):this.name+" "+this.value.toCSS()+";\n"},eval:function(a){return this.features=this.features&&this.features.eval(a),a.frames.unshift(this),this.ruleset=this.ruleset&&this.ruleset.eval(a),a.frames.shift(),this},variable:function(b){return a.Ruleset.prototype.variable.call(this.ruleset,b)},find:function(){return a.Ruleset.prototype.find.apply(this.ruleset,arguments)},rulesets:function(){return a.Ruleset.prototype.rulesets.apply(this.ruleset)}}}(c("../tree")),function(a){a.Element=function(b,c,d){this.combinator=b instanceof a.Combinator?b:new a.Combinator(b),typeof c=="string"?this.value=c.trim():c?this.value=c:this.value="",this.index=d},a.Element.prototype.eval=function(b){return new a.Element(this.combinator,this.value.eval?this.value.eval(b):this.value,this.index)},a.Element.prototype.toCSS=function(a){return this.combinator.toCSS(a||{})+(this.value.toCSS?this.value.toCSS(a):this.value)},a.Combinator=function(a){a===" "?this.value=" ":a==="& "?this.value="& ":this.value=a?a.trim():""},a.Combinator.prototype.toCSS=function(a){return{"":""," ":" ","&":"","& ":" ",":":" :","::":"::","+":a.compress?"+":" + ","~":a.compress?"~":" ~ ",">":a.compress?">":" > "}[this.value]}}(c("../tree")),function(a){a.Expression=function(a){this.value=a},a.Expression.prototype={eval:function(b){return this.value.length>1?new a.Expression(this.value.map(function(a){return a.eval(b)})):this.value.length===1?this.value[0].eval(b):this},toCSS:function(a){return this.value.map(function(b){return b.toCSS?b.toCSS(a):""}).join(" ")}}}(c("../tree")),function(a){a.Import=function(b,c,d,e){var f=this;this.index=e,this._path=b,this.features=d&&new a.Value(d),b instanceof a.Quoted?this.path=/\.(le?|c)ss(\?.*)?$/.test(b.value)?b.value:b.value+".less":this.path=b.value.value||b.value,this.css=/css(\?.*)?$/.test(this.path),this.css||c.push(this.path,function(b,c){b&&(b.index=e),f.root=c||new a.Ruleset([],[])})},a.Import.prototype={toCSS:function(a){var b=this.features?" "+this.features.toCSS(a):"";return this.css?"@import "+this._path.toCSS()+b+";\n":""},eval:function(b){var c,d=this.features&&this.features.eval(b);if(this.css)return this;c=new a.Ruleset([],this.root.rules.slice(0));for(var e=0;e<c.rules.length;e++)c.rules[e]instanceof a.Import&&Array.prototype.splice.apply(c.rules,[e,1].concat(c.rules[e].eval(b)));return this.features?new a.Directive("@media",c.rules,this.features.value):c.rules}}}(c("../tree")),function(a){a.JavaScript=function(a,b,c){this.escaped=c,this.expression=a,this.index=b},a.JavaScript.prototype={eval:function(b){var c,d=this,e={},f=this.expression.replace(/@\{([\w-]+)\}/g,function(c,e){return a.jsify((new a.Variable("@"+e,d.index)).eval(b))});try{f=new Function("return ("+f+")")}catch(g){throw{message:"JavaScript evaluation error: `"+ -f+"`",index:this.index}}for(var h in b.frames[0].variables())e[h.slice(1)]={value:b.frames[0].variables()[h].value,toJS:function(){return this.value.eval(b).toCSS()}};try{c=f.call(e)}catch(g){throw{message:"JavaScript evaluation error: '"+g.name+": "+g.message+"'",index:this.index}}return typeof c=="string"?new a.Quoted('"'+c+'"',c,this.escaped,this.index):Array.isArray(c)?new a.Anonymous(c.join(", ")):new a.Anonymous(c)}}}(c("../tree")),function(a){a.Keyword=function(a){this.value=a},a.Keyword.prototype={eval:function(){return this},toCSS:function(){return this.value},compare:function(b){return b instanceof a.Keyword?b.value===this.value?0:1:-1}},a.True=new a.Keyword("true"),a.False=new a.Keyword("false")}(c("../tree")),function(a){a.mixin={},a.mixin.Call=function(b,c,d,e,f){this.selector=new a.Selector(b),this.arguments=c,this.index=d,this.filename=e,this.important=f},a.mixin.Call.prototype={eval:function(a){var b,c,d=[],e=!1;for(var f=0;f<a.frames.length;f++)if((b=a.frames[f].find(this.selector)).length>0){c=this.arguments&&this.arguments.map(function(b){return b.eval(a)});for(var g=0;g<b.length;g++)if(b[g].match(c,a))try{Array.prototype.push.apply(d,b[g].eval(a,this.arguments,this.important).rules),e=!0}catch(h){throw{message:h.message,index:h.index,filename:this.filename,stack:h.stack,call:this.index}}if(e)return d;throw{type:"Runtime",message:"No matching definition was found for `"+this.selector.toCSS().trim()+"("+this.arguments.map(function(a){return a.toCSS()}).join(", ")+")`",index:this.index,filename:this.filename}}throw{type:"Name",message:this.selector.toCSS().trim()+" is undefined",index:this.index,filename:this.filename}}},a.mixin.Definition=function(b,c,d,e){this.name=b,this.selectors=[new a.Selector([new a.Element(null,b)])],this.params=c,this.condition=e,this.arity=c.length,this.rules=d,this._lookups={},this.required=c.reduce(function(a,b){return!b.name||b.name&&!b.value?a+1:a},0),this.parent=a.Ruleset.prototype,this.frames=[]},a.mixin.Definition.prototype={toCSS:function(){return""},variable:function(a){return this.parent.variable.call(this,a)},variables:function(){return this.parent.variables.call(this)},find:function(){return this.parent.find.apply(this,arguments)},rulesets:function(){return this.parent.rulesets.apply(this)},evalParams:function(b,c){var d=new a.Ruleset(null,[]);for(var e=0,f;e<this.params.length;e++)if(this.params[e].name){if(!(f=c&&c[e]||this.params[e].value))throw{type:"Runtime",message:"wrong number of arguments for "+this.name+" ("+c.length+" for "+this.arity+")"};d.rules.unshift(new a.Rule(this.params[e].name,f.eval(b)))}return d},eval:function(b,c,d){var e=this.evalParams(b,c),f,g=[],h;for(var i=0;i<Math.max(this.params.length,c&&c.length);i++)g.push(c[i]||this.params[i].value);return e.rules.unshift(new a.Rule("@arguments",(new a.Expression(g)).eval(b))),h=d?this.rules.map(function(b){return new a.Rule(b.name,b.value,"!important",b.index)}):this.rules.slice(0),(new a.Ruleset(null,h)).eval({frames:[this,e].concat(this.frames,b.frames)})},match:function(a,b){var c=a&&a.length||0,d,e;if(c<this.required)return!1;if(this.required>0&&c>this.params.length)return!1;if(this.condition&&!this.condition.eval({frames:[this.evalParams(b,a)].concat(b.frames)}))return!1;d=Math.min(c,this.arity);for(var f=0;f<d;f++)if(!this.params[f].name&&a[f].eval(b).toCSS()!=this.params[f].value.eval(b).toCSS())return!1;return!0}}}(c("../tree")),function(a){a.Operation=function(a,b){this.op=a.trim(),this.operands=b},a.Operation.prototype.eval=function(b){var c=this.operands[0].eval(b),d=this.operands[1].eval(b),e;if(c instanceof a.Dimension&&d instanceof a.Color){if(this.op!=="*"&&this.op!=="+")throw{name:"OperationError",message:"Can't substract or divide a color from a number"};e=d,d=c,c=e}return c.operate(this.op,d)},a.operate=function(a,b,c){switch(a){case"+":return b+c;case"-":return b-c;case"*":return b*c;case"/":return b/c}}}(c("../tree")),function(a){a.Paren=function(a){this.value=a},a.Paren.prototype={toCSS:function(a){return"("+this.value.toCSS(a)+")"},eval:function(b){return new a.Paren(this.value.eval(b))}}}(c("../tree")),function(a){a.Quoted=function(a,b,c,d){this.escaped=c,this.value=b||"",this.quote=a.charAt(0),this.index=d},a.Quoted.prototype={toCSS:function(){return this.escaped?this.value:this.quote+this.value+this.quote},eval:function(b){var c=this,d=this.value.replace(/`([^`]+)`/g,function(d,e){return(new a.JavaScript(e,c.index,!0)).eval(b).value}).replace(/@\{([\w-]+)\}/g,function(d,e){var f=(new a.Variable("@"+e,c.index)).eval(b);return"value"in f?f.value:f.toCSS()});return new a.Quoted(this.quote+d+this.quote,d,this.escaped,this.index)}}}(c("../tree")),function(a){a.Rule=function(b,c,d,e,f){this.name=b,this.value=c instanceof a.Value?c:new a.Value([c]),this.important=d?" "+d.trim():"",this.index=e,this.inline=f||!1,b.charAt(0)==="@"?this.variable=!0:this.variable=!1},a.Rule.prototype.toCSS=function(a){return this.variable?"":this.name+(a.compress?":":": ")+this.value.toCSS(a)+this.important+(this.inline?"":";")},a.Rule.prototype.eval=function(b){return new a.Rule(this.name,this.value.eval(b),this.important,this.index,this.inline)},a.Shorthand=function(a,b){this.a=a,this.b=b},a.Shorthand.prototype={toCSS:function(a){return this.a.toCSS(a)+"/"+this.b.toCSS(a)},eval:function(){return this}}}(c("../tree")),function(a){a.Ruleset=function(a,b){this.selectors=a,this.rules=b,this._lookups={}},a.Ruleset.prototype={eval:function(b){var c=this.selectors&&this.selectors.map(function(a){return a.eval(b)}),d=new a.Ruleset(c,this.rules.slice(0));d.root=this.root,d.allowImports=this.allowImports,b.frames.unshift(d);if(d.root||d.allowImports)for(var e=0;e<d.rules.length;e++)d.rules[e]instanceof a.Import&&Array.prototype.splice.apply(d.rules,[e,1].concat(d.rules[e].eval(b)));for(var e=0;e<d.rules.length;e++)d.rules[e]instanceof a.mixin.Definition&&(d.rules[e].frames=b.frames.slice(0));for(var e=0;e<d.rules.length;e++)d.rules[e]instanceof a.mixin.Call&&Array.prototype.splice.apply(d.rules,[e,1].concat(d.rules[e].eval(b)));for(var e=0,f;e<d.rules.length;e++)f=d.rules[e],f instanceof a.mixin.Definition||(d.rules[e]=f.eval?f.eval(b):f);return b.frames.shift(),d},match:function(a){return!a||a.length===0},variables:function(){return this._variables?this._variables:this._variables=this.rules.reduce(function(b,c){return c instanceof a.Rule&&c.variable===!0&&(b[c.name]=c),b},{})},variable:function(a){return this.variables()[a]},rulesets:function(){return this._rulesets?this._rulesets:this._rulesets=this.rules.filter(function(b){return b instanceof a.Ruleset||b instanceof a.mixin.Definition})},find:function(b,c){c=c||this;var d=[],e,f,g=b.toCSS();return g in this._lookups?this._lookups[g]:(this.rulesets().forEach(function(e){if(e!==c)for(var g=0;g<e.selectors.length;g++)if(f=b.match(e.selectors[g])){b.elements.length>e.selectors[g].elements.length?Array.prototype.push.apply(d,e.find(new a.Selector(b.elements.slice(1)),c)):d.push(e);break}}),this._lookups[g]=d)},toCSS:function(b,c){var d=[],e=[],f=[],g=[],h,i;this.root||(b.length===0?g=this.selectors.map(function(a){return[a]}):this.joinSelectors(g,b,this.selectors));for(var j=0;j<this.rules.length;j++)i=this.rules[j],i.rules||i instanceof a.Directive?f.push(i.toCSS(g,c)):i instanceof a.Comment?i.silent||(this.root?f.push(i.toCSS(c)):e.push(i.toCSS(c))):i.toCSS&&!i.variable?e.push(i.toCSS(c)):i.value&&!i.variable&&e.push(i.value.toString());return f=f.join(""),this.root?d.push(e.join(c.compress?"":"\n")):e.length>0&&(h=g.map(function(a){return a.map(function(a){return a.toCSS(c)}).join("").trim()}).join(c.compress?",":g.length>3?",\n":", "),d.push(h,(c.compress?"{":" {\n ")+e.join(c.compress?"":"\n ")+(c.compress?"}":"\n}\n"))),d.push(f),d.join("")+(c.compress?"\n":"")},joinSelectors:function(a,b,c){for(var d=0;d<c.length;d++)this.joinSelector(a,b,c[d])},joinSelector:function(b,c,d){var e=[],f=[],g=[],h=[],i=!1,j;for(var k=0;k<d.elements.length;k++)j=d.elements[k],j.combinator.value.charAt(0)==="&"&&(i=!0),i?h.push(j):g.push(j);i||(h=g,g=[]),g.length>0&&e.push(new a.Selector(g)),h.length>0&&f.push(new a.Selector(h));for(var l=0;l<c.length;l++)b.push(e.concat(c[l]).concat(f))}}}(c("../tree")),function(a){a.Selector=function(a){this.elements=a,this.elements[0].combinator.value===""&&(this.elements[0].combinator.value=" ")},a.Selector.prototype.match=function(a){var b=this.elements.length,c=a.elements.length,d=Math.min(b,c);if(b<c)return!1;for(var e=0;e<d;e++)if(this.elements[e].value!==a.elements[e].value)return!1;return!0},a.Selector.prototype.eval=function(b){return new a.Selector(this.elements.map(function(a){return a.eval(b)}))},a.Selector.prototype.toCSS=function(a){return this._css?this._css:this._css=this.elements.map(function(b){return typeof b=="string"?" "+b.trim():b.toCSS(a)}).join("")}}(c("../tree")),function(b){b.URL=function(b,c){b.data?this.attrs=b:(typeof a!="undefined"&&!/^(?:https?:\/\/|file:\/\/|data:|\/)/.test(b.value)&&c.length>0&&(b.value=c[0]+(b.value.charAt(0)==="/"?b.value.slice(1):b.value)),this.value=b,this.paths=c)},b.URL.prototype={toCSS:function(){return"url("+(this.attrs?"data:"+this.attrs.mime+this.attrs.charset+this.attrs.base64+this.attrs.data:this.value.toCSS())+")"},eval:function(a){return this.attrs?this:new b.URL(this.value.eval(a),this.paths)}}}(c("../tree")),function(a){a.Value=function(a){this.value=a,this.is="value"},a.Value.prototype={eval:function(b){return this.value.length===1?this.value[0].eval(b):new a.Value(this.value.map(function(a){return a.eval(b)}))},toCSS:function(a){return this.value.map(function(b){return b.toCSS(a)}).join(a.compress?",":", ")}}}(c("../tree")),function(a){a.Variable=function(a,b,c){this.name=a,this.index=b,this.file=c},a.Variable.prototype={eval:function(b){var c,d,e=this.name;e.indexOf("@@")==0&&(e="@"+(new a.Variable(e.slice(1))).eval(b).value);if(c=a.find(b.frames,function(a){if(d=a.variable(e))return d.value.eval(b)}))return c;throw{type:"Name",message:"variable "+e+" is undefined",filename:this.file,index:this.index}}}}(c("../tree")),function(a){a.find=function(a,b){for(var c=0,d;c<a.length;c++)if(d=b.call(a,a[c]))return d;return null},a.jsify=function(a){return Array.isArray(a.value)&&a.value.length>1?"["+a.value.map(function(a){return a.toCSS(!1)}).join(", ")+"]":a.toCSS(!1)}}(c("./tree"));var g=location.protocol==="file:"||location.protocol==="chrome:"||location.protocol==="chrome-extension:"||location.protocol==="resource:";d.env=d.env||(location.hostname=="127.0.0.1"||location.hostname=="0.0.0.0"||location.hostname=="localhost"||location.port.length>0||g?"development":"production"),d.async=!1,d.poll=d.poll||(g?1e3:1500),d.watch=function(){return this.watchMode=!0},d.unwatch=function(){return this.watchMode=!1},d.env==="development"?(d.optimization=0,/!watch/.test(location.hash)&&d.watch(),d.watchTimer=setInterval(function(){d.watchMode&&n(function(a,b,c,d,e){b&&r(b.toCSS(),d,e.lastModified)})},d.poll)):d.optimization=3;var h;try{h=typeof a.localStorage=="undefined"?null:a.localStorage}catch(i){h=null}var j=document.getElementsByTagName("link"),k=/^text\/(x-)?less$/;d.sheets=[];for(var l=0;l<j.length;l++)(j[l].rel==="stylesheet/less"||j[l].rel.match(/stylesheet/)&&j[l].type.match(k))&&d.sheets.push(j[l]);d.refresh=function(a){var b,c;b=c=new Date,n(function(a,d,e,f,g){g.local?v("loading "+f.href+" from cache."):(v("parsed "+f.href+" successfully."),r(d.toCSS(),f,g.lastModified)),v("css for "+f.href+" generated in "+(new Date-c)+"ms"),g.remaining===0&&v("css generated in "+(new Date-b)+"ms"),c=new Date},a),m()},d.refreshStyles=m,d.refresh(d.env==="development")})(window);
\ No newline at end of file diff --git a/docs/logger.txt b/docs/logger.txt new file mode 100644 index 00000000..89e620af --- /dev/null +++ b/docs/logger.txt @@ -0,0 +1,71 @@ +MediaWiki\Logger\LoggerFactory implements a PSR-3 [0] compatible message +logging system. + +Named Psr\Log\LoggerInterface instances can be obtained from the +MediaWiki\Logger\LoggerFactory::getInstance() static method. +MediaWiki\Logger\LoggerFactory expects a class implementing the +MediaWiki\Logger\Spi interface to act as a factory for new +Psr\Log\LoggerInterface instances. + +The "Spi" in MediaWiki\Logger\Spi stands for "service provider interface". An +SPI is an API intended to be implemented or extended by a third party. This +software design pattern is intended to enable framework extension and +replaceable components. It is specifically used in the +MediaWiki\Logger\LoggerFactory service to allow alternate PSR-3 logging +implementations to be easily integrated with MediaWiki. + +The service provider interface allows the backend logging library to be +implemented in multiple ways. The $wgMWLoggerDefaultSpi global provides the +classname of the default MediaWiki\Logger\Spi implementation to be loaded at +runtime. This can either be the name of a class implementing the +MediaWiki\Logger\Spi with a zero argument constructor or a callable that will +return an MediaWiki\Logger\Spi instance. Alternately the +MediaWiki\Logger\LoggerFactory::registerProvider() static method can be called +to inject an MediaWiki\Logger\Spi instance into the LoggerFactory and bypass +the use of the default configuration variable. + +The MediaWiki\Logger\LegacySpi class implements a service provider to generate +MediaWiki\Logger\LegacyLogger instances. The MediaWiki\Logger\LegacyLogger +class implements the PSR-3 logger interface and provides output and +configuration equivalent to the historic logging output of wfDebug, +wfDebugLog, wfLogDBError and wfErrorLog. The MediaWiki\Logger\LegacySpi class +is the default service provider configured in DefaultSettings.php. It's usage +should be transparent for users who are not ready or do not wish to switch to +a alternate logging platform. + +The MediaWiki\Logger\MonologSpi class implements a service provider to +generate Psr\Log\LoggerInterface instances that use the Monolog [1] logging +library. See the PHP docs (or source) for MediaWiki\Logger\MonologSpi for +details on the configuration of this provider. The default configuration +installs a null handler that will silently discard all logging events. The +documentation provided by the class describes a more feature rich logging +configuration. + +== Classes == +; MediaWiki\Logger\LoggerFactory +: Factory for Psr\Log\LoggerInterface loggers +; MediaWiki\Logger\Spi +: Service provider interface for MediaWiki\Logger\LoggerFactory +; MediaWiki\Logger\NullSpi +: MediaWiki\Logger\Spi for creating instances that discard all log events +; MediaWiki\Logger\LegacySpi +: Service provider for creating MediaWiki\Logger\LegacyLogger instances +; MediaWiki\Logger\LegacyLogger +: PSR-3 logger that mimics the historical output and configuration of wfDebug, + wfErrorLog and other global logging functions. +; MediaWiki\Logger\MonologSpi +: MediaWiki\Logger\Spi for creating instances backed by the monolog logging library +; MediaWiki\Logger\Monolog\LegacyHandler +: Monolog handler that replicates the udp2log and file logging + functionality of wfErrorLog() +; MediaWiki\Logger\Monolog\WikiProcessor +: Monolog log processer that adds host: wfHostname() and wiki: wfWikiID() + to all records + +== Globals == +; $wgMWLoggerDefaultSpi +: Specification for creating the default service provider interface to use + with MediaWiki\Logger\LoggerFactory + +[0]: https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-3-logger-interface.md +[1]: https://github.com/Seldaek/monolog diff --git a/docs/memcached.txt b/docs/memcached.txt index 16c57602..d18b199e 100644 --- a/docs/memcached.txt +++ b/docs/memcached.txt @@ -1,5 +1,5 @@ -MediaWiki has optional support for memcached, a "high-performance, -distributed memory object caching system". For general information +MediaWiki has optional support for memcached, a "high-performance, +distributed memory object caching system". For general information on it, see: http://www.danga.com/memcached/ Memcached is likely more trouble than a small site will need, but @@ -10,7 +10,7 @@ in memory. == Installation == Packages are available for Fedora, Debian, Ubuntu and probably other -Linux distributions. If you there's no package available for your +Linux distributions. If there's no package available for your distribution, you can compile it from source. == Compilation == @@ -25,7 +25,7 @@ distribution, you can compile it from source. * memcached: http://www.danga.com/memcached/download.bml (as of this writing, 1.1.9 is current) - + Memcached and libevent are under BSD-style licenses. The server should run on Linux and other Unix-like systems... you @@ -40,9 +40,9 @@ memcached servers are not publicly accessible. Otherwise, anyone on the internet can put data into and read data from your cache. An attacker familiar with MediaWiki internals could use this to steal -passwords and email addresses, or to make themselves a sysop and -install malicious javascript on the site. There may be other types -of vulnerability, no audit has been done -- so be safe and keep it +passwords and email addresses, or to make themselves a sysop and +install malicious javascript on the site. There may be other types +of vulnerability, no audit has been done -- so be safe and keep it behind a firewall. ********************* W A R N I N G ! ! ! ! ! *********************** @@ -247,5 +247,5 @@ User: stores: instance of class User set in: User::saveToCache() cleared by: User::saveSettings(), User::clearSharedCache() - + ... more to come ... diff --git a/docs/scripts.txt b/docs/scripts.txt index c6fa674c..178bb157 100644 --- a/docs/scripts.txt +++ b/docs/scripts.txt @@ -34,7 +34,7 @@ Primary scripts: To save the profiling information in the database (required to use this script), you have to modify StartProfiler.php to use the Profiler class and not the stub profiler which is enabled by default. - You will also need to set $wgProfileToDatabase to true in LocalSettings.php + You will also need to set $wgProfiler['output'] to 'db' in LocalSettings.php to force the profiler to save the informations in the database and apply the maintenance/archives/patch-profiling.sql patch to the database. diff --git a/docs/sitelist-1.0.xsd b/docs/sitelist-1.0.xsd new file mode 100644 index 00000000..126cd039 --- /dev/null +++ b/docs/sitelist-1.0.xsd @@ -0,0 +1,68 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<!-- + This is an XML Schema description of the format + used by MediaWiki's exportSites.php and importSites.php + scripts. +--> +<schema xmlns="http://www.w3.org/2001/XMLSchema" + xmlns:mwsl="http://www.mediawiki.org/xml/sitelist-1.0/" + targetNamespace="http://www.mediawiki.org/xml/sitelist-1.0/" + elementFormDefault="qualified"> + + <annotation> + <documentation xml:lang="en"> + MediaWiki's export format for site definitions. + </documentation> + </annotation> + + <!-- Our root element --> + <element name="sites" type="mwsl:MediaWikiSiteListType"> + <unique name="GlobalIDConstraint"> + <selector xpath="mwsl:Site" /> + <field xpath="mwsl:GlobalID" /> + </unique> + </element> + + <simpleType name="EmptyTagType"> + <restriction base="string"> + <length value="0"/> + </restriction> + </simpleType> + + <complexType name="TypedIDType"> + <simpleContent> + <extension base="NCName"> + <attribute name="type" use="required" type="NCName" /> + </extension> + </simpleContent> + </complexType> + + <complexType name="TypedURIType"> + <simpleContent> + <extension base="anyURI"> + <attribute name="type" use="required" type="NCName" /> + </extension> + </simpleContent> + </complexType> + + <complexType name="MediaWikiSiteListType"> + <sequence> + <element name="site" type="mwsl:SiteType" + minOccurs="0" maxOccurs="unbounded" /> + </sequence> + <attribute name="version" type="string" use="optional" /> + </complexType> + + <complexType name="SiteType"> + <choice maxOccurs="unbounded"> + <element name="globalid" type="ID" minOccurs="1" maxOccurs="1" /> + <element name="localid" type="mwsl:TypedIDType" minOccurs="0" /> + <element name="group" type="NCName" minOccurs="0" maxOccurs="1" /> + <element name="source" type="NCName" minOccurs="0" maxOccurs="1" /> + <element name="forward" type="mwsl:EmptyTagType" minOccurs="0" maxOccurs="1" /> + <element name="path" type="mwsl:TypedURIType" minOccurs="0" /> + </choice> + <attribute name="type" use="optional" type="NCName" /> + </complexType> + +</schema> diff --git a/docs/sitelist.txt b/docs/sitelist.txt new file mode 100644 index 00000000..48c7ce52 --- /dev/null +++ b/docs/sitelist.txt @@ -0,0 +1,47 @@ +This document describes the XML format used to represent information about external sites known +to a MediaWiki installation. This information about external sites is used to allow "inter-wiki" +links, cross-language navigation, as well as close integration via direct access to the other +site's web API or even directly to their database. + +Lists of external sites can be imported and exported using the importSites.php and exportSites.php +scripts. In the database, external sites are described by the sites and site_ids tables. + +The formal specification of the format used by importSites.php and exportSites.php can be found in +the sitelist-1.0.xsd file. Below is an example and a brief description of what the individual XML +elements and attributes mean: + + + <sites version="1.0"> + <site> + <globalid>acme.com</globalid> + <localid type="interwiki">acme</localid> + <group>Vendor</group> + <path type="link">http://acme.com/</path> + <source>meta.wikimedia.org</source> + </site> + <site type="mediawiki"> + <globalid>de.wikidik.example</globalid> + <localid type="equivalent">de</localid> + <group>Dictionary</group> + <forward/> + <path type="page_path">http://acme.com/</path> + </site> + </sites> + + +The XML elements are used as follows: + +* sites: The root element, containing a set of site tags. May have a version attribute with the value 1.0. +* site: A site entry, representing an external website. May have a type attribute with one of the following values: +** ''unknown'': (default) any website +** ''mediawiki'': A MediaWiki site +* globalid: A unique identifier for the site. For a given site, the same unique global ID must be used across all wikis in a wiki farm (aka wiki family). +* localid: An identifier for the site, for use on the local wiki. Multiple local IDs may be assigned to a given site. The same local ID can be used to refer to different sites by different wikis on the same farm/family. The localid element may have a type attribute with one of the following values: +** interwiki: Used as an "interwiki" link prefix, for creating cross-wiki links. +** equivalent: Used as a "language" link prefix, for cross-linking equivalent content in different languages. +* group: The site group (e.g. wiki family) the site belongs to. +* path: A URL template for accessing resources on the site. Several paths may be defined for a given site, for accessing different kinds of resources, identified by the type attribute, using one of the following values: +** link: Generic URL template, often the document root. +** page_path: (for mediawiki sites) URL template for wiki pages (corresponds to the target wiki's $wgArticlePath setting) +** file_path: (for mediawiki sites) URL pattern for application entry points and resources (corresponds to the target wiki's $wgScriptPath setting). +* forward: Whether using a prefix defined by a localid tag in the URL will cause the request to be redirected to the corresponding page on the target wiki (currently unused). E.g. whether http://wiki.acme.com/wiki/foo:Buzz should be forwarded to http://wiki.foo.com/read/Buzz. (CAVEAT: not yet implement, can be specified but has no effect)
\ No newline at end of file diff --git a/docs/sitescache.txt b/docs/sitescache.txt new file mode 100644 index 00000000..13bf371d --- /dev/null +++ b/docs/sitescache.txt @@ -0,0 +1,42 @@ +MediaWiki's SiteStore can be cached and stored in a flat file, +in a json format. If the SiteStore is frequently accessed, the +file cache may provide a performance benefit over a database +store, even with memcached in front of it. + +Configuration: + +File-based caching can be enabled by setting $wgSitesCacheFile +to the file path of the cache file. + +The file can then be generated with the rebuildSitesCache.php +maintenance script. + +Format: + +In the sites cache file, sites are listed in a key-value +map, with the key being the site's global id (e.g. "enwiki") +and a key-value map as the value. The site list is wrapped +with in a "sites" key. + +Example: + +"sites": { + "aawiktionary": { + "globalid": "aawiktionary", + "type": "mediawiki", + "group": "wiktionary", + "source": "local", + "language": "aa", + "localids": [], + "config": [], + "data": { + "paths": { + "file_path": "http:\/\/aa.wiktionary.org\/w\/$1", + "page_path": "http:\/\/aa.wiktionary.org\/wiki\/$1" + } + }, + "forward": false, + "internalid": 2666, + "identifiers": [] + } +} diff --git a/docs/skin.txt b/docs/skin.txt index 58f77cf8..a3c8c334 100644 --- a/docs/skin.txt +++ b/docs/skin.txt @@ -7,7 +7,7 @@ MediaWiki includes four core skins: Monobook. * Monobook: Named after the black-and-white photo of a book in the page - background. Introduced in the 2004 release of 1.3, it had been been the + background. Introduced in the 2004 release of 1.3, it had been the default skin since then, before being replaced by Vector. * Modern: An attractive blue/grey theme with sidebar and top bar. Derived from @@ -53,40 +53,30 @@ server-side source files. This is done by editing some pages on the wiki: These can also be customised on a per-user basis, by editing [[User:<name>/vector.css]], [[User:<name>/vector.js]], etc. -This feature has led to a wide variety of "user styles" becoming available: -https://www.mediawiki.org/wiki/Manual:Gallery_of_user_styles +== Custom skins == -If you want a different look for your wiki, that gallery is a good place to start. +Several custom skins are available as of 2014. -== Drop-in custom skins == +https://www.mediawiki.org/wiki/Category:All_skins -If you put a file in MediaWiki's skins directory, ending in .php, the name of -the file will automatically be added as a skin name, and the file will be -expected to contain a class called Skin<name> with the skin class. You can then -make that skin the default by adding to LocalSettings.php: +Installing a skin requires adding its files in a subdirectory under skins/ and +adding an appropriate require_once line to LocalSettings.php, similarly to how +extensions are installed. -$wgDefaultSkin = '<name>'; +You can then make that skin the default by adding: + $wgDefaultSkin = '<name>'; -You can also disable dropped-in or core skins using: +Or disable it entirely by removing the require_once line. (User settings will +not be lost if it's reenabled later.) -$wgSkipSkins[] = '<name>'; +See https://www.mediawiki.org/wiki/Manual:Skinning for more information on +writing new skins. -This technique is used by the more ambitious MediaWiki site operators, to -create complex custom skins for their wikis. It should be preferred over -editing the core Monobook skin directly. - -See https://www.mediawiki.org/wiki/Manual:Skinning for more information. - -== Extension skins == - -It is now possible (since MediaWiki 1.12) to write a skin as a standard -MediaWiki extension, enabled via LocalSettings.php. This is done by adding -it to $wgValidSkinNames, for example: - -$wgValidSkinNames['mycoolskin'] = 'MyCoolSkin'; - -and then registering a class in $wgAutoloadClasses called SkinMycoolSkin, which -derives from Skin. This technique is apparently not yet used (as of 2008) -outside the DumpHTML extension. +Until MediaWiki 1.25 it used to be possible to just put a <name>.php file in +MediaWiki's skins/ directory, which would be loaded and expected to contain the +Skin<name> class. This way has always been discouraged because of its limitations +(inability to add localisation messages, ResourceLoader modules, etc.) and +awkwardness in managing such skins. For information on migrating skins using +this old method, see <https://www.mediawiki.org/wiki/Manual:Skin_autodiscovery>. diff --git a/docs/uidesign/mediawiki.action.history.diff.html b/docs/uidesign/mediawiki.action.history.diff.html index 5edcfb86..615558f2 100644 --- a/docs/uidesign/mediawiki.action.history.diff.html +++ b/docs/uidesign/mediawiki.action.history.diff.html @@ -1,57 +1,91 @@ <!DOCTYPE html> <html lang="en" dir="ltr"> <head> - <link rel="stylesheet" href="../../resources/mediawiki.action/mediawiki.action.history.diff.css"> + <meta charset="utf-8"> + <link rel="stylesheet" href="../../resources/src/mediawiki.action/mediawiki.action.history.diff.css"> + <link rel="stylesheet" media="print" href="../../resources/src/mediawiki.action/mediawiki.action.history.diff.print.css"> </head> -<body style="background-color: #C0C0C0;"> -<p> -This show various styles for our diff action, the background being hardcoded to gray (<code>#C0C0C0</code>) The reference style sheet is:</p> -<p> -<code><a href="../../resources/mediawiki.action/mediawiki.action.history.diff.css">resources/mediawiki.action/mediawiki.action.history.diff.css</a></code>. -</p> -<p> -This file might help us fix our diff colors which have been a recurring issues among the community for a loooong time.</p> - -<p> -First, show the diff mostly like it would be chown on a wiki</p> -<table class="diff"> +<body> + +<p>This show various styles for our diff action. Style sheet: <code><a href="../../resources/src/mediawiki.action/mediawiki.action.history.diff.css">resources/src/mediawiki.action/mediawiki.action.history.diff.css</a></code>.</p> +<p>This file might help us fix our diff colors which have been a recurring issues among the community for a loooong time.</p> +<p>Try it out in print mode, too. Style sheet: <code><a href="../../resources/src/mediawiki.action/mediawiki.action.history.diff.print.css">resources/src/mediawiki.action/mediawiki.action.history.diff.print.css</a></code>.</p> + +<p>Practical example copied from MediaWiki's HTML output:</p> + +<table class="diff diff-contentalign-left"> + <colgroup><col class="diff-marker"> + <col class="diff-content"> + <col class="diff-marker"> + <col class="diff-content"> + </colgroup> +<tbody> <tr> - <td class="diff-marker">-</td> - <td class="diff-deletedline"><div> - Some content <span class="diffchange diffchange-inline">deleted / replaced</span> - </div></td> + <td class="diff-marker">−</td> + <td class="diff-deletedline"><div>Lorem ipsum dolor sit amet<del class="diffchange diffchange-inline">, consectetur adipisicing elit</del>, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</div></td> <td class="diff-marker">+</td> - <td class="diff-addedline"><div> - Some content <span class="diffchange diffchange-inline">added / replacement</span> - </div></td> + <td class="diff-addedline"><div>Lorem ipsum dolor sit amet, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</div></td> </tr> -</table> - +<tr> + <td class="diff-marker">−</td> + <td class="diff-deletedline"></td> + <td colspan="2" class="diff-empty"> </td> +</tr> +<tr> + <td class="diff-marker">−</td> + <td class="diff-deletedline"><div>Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.</div></td> + <td colspan="2" class="diff-empty"> </td> +</tr> +<tr> + <td class="diff-marker"> </td> + <td class="diff-context"></td> + <td class="diff-marker"> </td> + <td class="diff-context"></td> +</tr> +<tr> + <td class="diff-marker"> </td> + <td class="diff-context"><div>Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.</div></td> + <td class="diff-marker"> </td> + <td class="diff-context"><div>Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.</div></td> +</tr> +<tr> + <td class="diff-marker"> </td> + <td class="diff-context"></td> + <td class="diff-marker"> </td> + <td class="diff-context"></td> +</tr> +<tr> + <td class="diff-marker">−</td> + <td class="diff-deletedline"><div>Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim<del class="diffchange diffchange-inline"> id est laborum</del>.</div></td> + <td class="diff-marker">+</td> + <td class="diff-addedline"><div>Excepteur sint occaecat cupidatat non proident, sunt<ins class="diffchange diffchange-inline"> reprehenderit in voluptate</ins> in culpa qui officia deserunt mollit anim.</div></td> +</tr> +<tr> + <td colspan="2" class="diff-empty"> </td> + <td class="diff-marker">+</td> + <td class="diff-addedline"></td> +</tr> +<tr> + <td colspan="2" class="diff-empty"> </td> + <td class="diff-marker">+</td> + <td class="diff-addedline"><div>Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.</div></td> +</tr> +</tbody></table> -<p> -Below are some basic lines being applied one or two classes. Mainly for debugging purposes</p> +<p>Below are some basic lines being applied one or two classes. Mainly for debugging purposes.</p> <table class="diff"> - <tr><th>Diff</th></tr> <tr><td class="diff-addedline"><code>diff-addedline</code>: added line</td></tr> <tr><td class="diff-deletedline"><code>diff-deletedline</code>: deleted line</td></tr> <tr><td class="diff-context"><code>diff-context</code>: context</td></tr> - - <tr><th>Same as above with a <code><span></code> child element having the <code>diffchange</code> class</th></tr> + <tr><th>Same as above with a <code><ins></code> or <code><del></code> child element having the <code>diffchange</code> class:</th></tr> <tr><td class="diffchange">Diffchange</td></tr> - <tr><td class="diff-addedline"> - <span class="diffchange">Added line + diffchange</span> - </td></tr> - <tr><td class="diff-deletedline"> - <span class="diffchange">Deleted line + diffchange</span> - </td></tr> - <tr><td class="diff-context"> - <span class="diffchange">Context + diffchange</span> - </td></tr> + <tr><td class="diff-addedline"><ins class="diffchange">Added line + diffchange</ins></td></tr> + <tr><td class="diff-deletedline"><del class="diffchange">Deleted line + diffchange</del></td></tr> </table> </body> |